include/linux/of_address.h
Source file repositories/reference/linux-study-clean/include/linux/of_address.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/of_address.h- Extension
.h- Size
- 5633 bytes
- Lines
- 203
- 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.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/ioport.hlinux/errno.hlinux/of.hlinux/io.h
Detected Declarations
struct of_busstruct of_pci_range_parserstruct of_pci_rangefunction for_each_of_rangefunction of_translate_addressfunction of_property_read_regfunction of_pci_range_parser_initfunction of_pci_dma_range_parser_initfunction of_pci_address_to_resourcefunction of_pci_range_to_resourcefunction of_range_to_resourcefunction of_dma_is_coherentfunction of_address_to_resourcefunction of_address_count
Annotated Snippet
struct of_pci_range_parser {
struct device_node *node;
const struct of_bus *bus;
const __be32 *range;
const __be32 *end;
int na;
int ns;
int pna;
bool dma;
};
#define of_range_parser of_pci_range_parser
struct of_pci_range {
union {
u64 pci_addr;
u64 bus_addr;
};
u64 cpu_addr;
u64 parent_bus_addr;
u64 size;
u32 flags;
};
#define of_range of_pci_range
#define for_each_of_pci_range(parser, range) \
for (; of_pci_range_parser_one(parser, range);)
#define for_each_of_range for_each_of_pci_range
/*
* of_range_count - Get the number of "ranges" or "dma-ranges" entries
* @parser: Parser state initialized by of_range_parser_init()
*
* Returns the number of entries or 0 if none.
*
* Note that calling this within or after the for_each_of_range() iterator will
* be inaccurate giving the number of entries remaining.
*/
static inline int of_range_count(const struct of_range_parser *parser)
{
if (!parser || !parser->node || !parser->range || parser->range == parser->end)
return 0;
return (parser->end - parser->range) / (parser->na + parser->pna + parser->ns);
}
/* Translate a DMA address from device space to CPU space */
extern u64 of_translate_dma_address(struct device_node *dev,
const __be32 *in_addr);
extern const __be32 *of_translate_dma_region(struct device_node *dev, const __be32 *addr,
phys_addr_t *start, size_t *length);
#ifdef CONFIG_OF_ADDRESS
extern u64 of_translate_address(struct device_node *np, const __be32 *addr);
extern int of_address_to_resource(struct device_node *dev, int index,
struct resource *r);
extern void __iomem *of_iomap(struct device_node *device, int index);
void __iomem *of_io_request_and_map(struct device_node *device,
int index, const char *name);
/* Extract an address from a device, returns the region size and
* the address space flags too. The PCI version uses a BAR number
* instead of an absolute index
*/
extern const __be32 *__of_get_address(struct device_node *dev, int index, int bar_no,
u64 *size, unsigned int *flags);
int of_property_read_reg(struct device_node *np, int idx, u64 *addr, u64 *size);
extern int of_pci_range_parser_init(struct of_pci_range_parser *parser,
struct device_node *node);
extern int of_pci_dma_range_parser_init(struct of_pci_range_parser *parser,
struct device_node *node);
extern struct of_pci_range *of_pci_range_parser_one(
struct of_pci_range_parser *parser,
struct of_pci_range *range);
extern int of_pci_address_to_resource(struct device_node *dev, int bar,
struct resource *r);
extern int of_pci_range_to_resource(const struct of_pci_range *range,
const struct device_node *np,
struct resource *res);
extern int of_range_to_resource(struct device_node *np, int index,
struct resource *res);
extern bool of_dma_is_coherent(struct device_node *np);
#else /* CONFIG_OF_ADDRESS */
static inline void __iomem *of_io_request_and_map(struct device_node *device,
int index, const char *name)
{
return IOMEM_ERR_PTR(-EINVAL);
}
static inline u64 of_translate_address(struct device_node *np,
Annotation
- Immediate include surface: `linux/ioport.h`, `linux/errno.h`, `linux/of.h`, `linux/io.h`.
- Detected declarations: `struct of_bus`, `struct of_pci_range_parser`, `struct of_pci_range`, `function for_each_of_range`, `function of_translate_address`, `function of_property_read_reg`, `function of_pci_range_parser_init`, `function of_pci_dma_range_parser_init`, `function of_pci_address_to_resource`, `function of_pci_range_to_resource`.
- Atlas domain: Core OS / Core Kernel Interface.
- Implementation status: source implementation candidate.
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.