include/linux/pruss_driver.h
Source file repositories/reference/linux-study-clean/include/linux/pruss_driver.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/pruss_driver.h- Extension
.h- Size
- 4546 bytes
- Lines
- 178
- 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/mutex.hlinux/remoteproc/pruss.hlinux/types.hlinux/err.h
Detected Declarations
struct pruss_mem_regionstruct prussenum pruss_gp_mux_selenum pruss_gpi_modeenum pru_typeenum pruss_memfunction pruss_putfunction pruss_release_mem_regionfunction pruss_cfg_get_gpmuxfunction pruss_cfg_set_gpmuxfunction pruss_cfg_gpimodefunction pruss_cfg_miirt_enablefunction pruss_cfg_xfr_enable
Annotated Snippet
struct pruss_mem_region {
void __iomem *va;
phys_addr_t pa;
size_t size;
};
/**
* struct pruss - PRUSS parent structure
* @dev: pruss device pointer
* @cfg_base: base iomap for CFG region
* @cfg_regmap: regmap for config region
* @mem_regions: data for each of the PRUSS memory regions
* @mem_in_use: to indicate if memory resource is in use
* @lock: mutex to serialize access to resources
* @core_clk_mux: clk handle for PRUSS CORE_CLK_MUX
* @iep_clk_mux: clk handle for PRUSS IEP_CLK_MUX
*/
struct pruss {
struct device *dev;
void __iomem *cfg_base;
struct regmap *cfg_regmap;
struct pruss_mem_region mem_regions[PRUSS_MEM_MAX];
struct pruss_mem_region *mem_in_use[PRUSS_MEM_MAX];
struct mutex lock; /* PRU resource lock */
struct clk *core_clk_mux;
struct clk *iep_clk_mux;
};
#if IS_ENABLED(CONFIG_TI_PRUSS)
struct pruss *pruss_get(struct rproc *rproc);
void pruss_put(struct pruss *pruss);
int pruss_request_mem_region(struct pruss *pruss, enum pruss_mem mem_id,
struct pruss_mem_region *region);
int pruss_release_mem_region(struct pruss *pruss,
struct pruss_mem_region *region);
int pruss_cfg_get_gpmux(struct pruss *pruss, enum pruss_pru_id pru_id, u8 *mux);
int pruss_cfg_set_gpmux(struct pruss *pruss, enum pruss_pru_id pru_id, u8 mux);
int pruss_cfg_gpimode(struct pruss *pruss, enum pruss_pru_id pru_id,
enum pruss_gpi_mode mode);
int pruss_cfg_miirt_enable(struct pruss *pruss, bool enable);
int pruss_cfg_xfr_enable(struct pruss *pruss, enum pru_type pru_type,
bool enable);
#else
static inline struct pruss *pruss_get(struct rproc *rproc)
{
return ERR_PTR(-EOPNOTSUPP);
}
static inline void pruss_put(struct pruss *pruss) { }
static inline int pruss_request_mem_region(struct pruss *pruss,
enum pruss_mem mem_id,
struct pruss_mem_region *region)
{
return -EOPNOTSUPP;
}
static inline int pruss_release_mem_region(struct pruss *pruss,
struct pruss_mem_region *region)
{
return -EOPNOTSUPP;
}
static inline int pruss_cfg_get_gpmux(struct pruss *pruss,
enum pruss_pru_id pru_id, u8 *mux)
{
return -EOPNOTSUPP;
}
static inline int pruss_cfg_set_gpmux(struct pruss *pruss,
enum pruss_pru_id pru_id, u8 mux)
{
return -EOPNOTSUPP;
}
static inline int pruss_cfg_gpimode(struct pruss *pruss,
enum pruss_pru_id pru_id,
enum pruss_gpi_mode mode)
{
return -EOPNOTSUPP;
}
static inline int pruss_cfg_miirt_enable(struct pruss *pruss, bool enable)
{
return -EOPNOTSUPP;
}
Annotation
- Immediate include surface: `linux/mutex.h`, `linux/remoteproc/pruss.h`, `linux/types.h`, `linux/err.h`.
- Detected declarations: `struct pruss_mem_region`, `struct pruss`, `enum pruss_gp_mux_sel`, `enum pruss_gpi_mode`, `enum pru_type`, `enum pruss_mem`, `function pruss_put`, `function pruss_release_mem_region`, `function pruss_cfg_get_gpmux`, `function pruss_cfg_set_gpmux`.
- 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.