include/linux/io-mapping.h
Source file repositories/reference/linux-study-clean/include/linux/io-mapping.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/io-mapping.h- Extension
.h- Size
- 4644 bytes
- Lines
- 229
- Domain
- Core OS
- Bucket
- Core Kernel Interface
- Inferred role
- Core OS: implementation source
- Status
- source implementation candidate
Why This File Exists
Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Core operating-system implementation surface: boot, tasks, memory, VFS, syscall-facing interfaces, synchronization, credentials, and isolation.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Allocates kernel memory; connect allocation flags and lifetime to context constraints.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/types.hlinux/slab.hlinux/bug.hlinux/io.hlinux/pgtable.hasm/page.hlinux/pfn.hasm/iomap.hlinux/uaccess.h
Detected Declarations
struct io_mappingfunction io_mapping_init_wcfunction io_mapping_finifunction io_mapping_map_atomic_wcfunction io_mapping_unmap_atomicfunction io_mapping_map_local_wcfunction io_mapping_unmap_localfunction io_mapping_map_wcfunction io_mapping_unmapfunction io_mapping_init_wcfunction io_mapping_finifunction io_mapping_map_wcfunction io_mapping_unmapfunction io_mapping_unmap_atomicfunction io_mapping_map_local_wcfunction io_mapping_unmap_localfunction io_mapping_create_wcfunction io_mapping_free
Annotated Snippet
struct io_mapping {
resource_size_t base;
unsigned long size;
pgprot_t prot;
void __iomem *iomem;
};
#ifdef CONFIG_HAVE_ATOMIC_IOMAP
#include <linux/pfn.h>
#include <asm/iomap.h>
/*
* For small address space machines, mapping large objects
* into the kernel virtual space isn't practical. Where
* available, use fixmap support to dynamically map pages
* of the object at run time.
*/
static inline struct io_mapping *
io_mapping_init_wc(struct io_mapping *iomap,
resource_size_t base,
unsigned long size)
{
pgprot_t prot;
if (iomap_create_wc(base, size, &prot))
return NULL;
iomap->base = base;
iomap->size = size;
iomap->prot = prot;
return iomap;
}
static inline void
io_mapping_fini(struct io_mapping *mapping)
{
iomap_free(mapping->base, mapping->size);
}
/* Atomic map/unmap */
static inline void __iomem *
io_mapping_map_atomic_wc(struct io_mapping *mapping,
unsigned long offset)
{
resource_size_t phys_addr;
BUG_ON(offset >= mapping->size);
phys_addr = mapping->base + offset;
if (!IS_ENABLED(CONFIG_PREEMPT_RT))
preempt_disable();
else
migrate_disable();
pagefault_disable();
return __iomap_local_pfn_prot(PHYS_PFN(phys_addr), mapping->prot);
}
static inline void
io_mapping_unmap_atomic(void __iomem *vaddr)
{
kunmap_local_indexed((void __force *)vaddr);
pagefault_enable();
if (!IS_ENABLED(CONFIG_PREEMPT_RT))
preempt_enable();
else
migrate_enable();
}
static inline void __iomem *
io_mapping_map_local_wc(struct io_mapping *mapping, unsigned long offset)
{
resource_size_t phys_addr;
BUG_ON(offset >= mapping->size);
phys_addr = mapping->base + offset;
return __iomap_local_pfn_prot(PHYS_PFN(phys_addr), mapping->prot);
}
static inline void io_mapping_unmap_local(void __iomem *vaddr)
{
kunmap_local_indexed((void __force *)vaddr);
}
static inline void __iomem *
io_mapping_map_wc(struct io_mapping *mapping,
unsigned long offset,
unsigned long size)
{
resource_size_t phys_addr;
Annotation
- Immediate include surface: `linux/types.h`, `linux/slab.h`, `linux/bug.h`, `linux/io.h`, `linux/pgtable.h`, `asm/page.h`, `linux/pfn.h`, `asm/iomap.h`.
- Detected declarations: `struct io_mapping`, `function io_mapping_init_wc`, `function io_mapping_fini`, `function io_mapping_map_atomic_wc`, `function io_mapping_unmap_atomic`, `function io_mapping_map_local_wc`, `function io_mapping_unmap_local`, `function io_mapping_map_wc`, `function io_mapping_unmap`, `function io_mapping_init_wc`.
- Atlas domain: Core OS / Core Kernel Interface.
- Implementation status: source implementation candidate.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.