include/linux/usb/role.h
Source file repositories/reference/linux-study-clean/include/linux/usb/role.h
File Facts
- System
- Linux kernel
- Corpus path
include/linux/usb/role.h- Extension
.h- Size
- 3663 bytes
- Lines
- 127
- 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/device.h
Detected Declarations
struct usb_role_switchstruct usb_role_switch_descenum usb_rolefunction usb_role_switch_set_rolefunction usb_role_switch_get_rolefunction fwnode_usb_role_switch_getfunction usb_role_switch_putfunction usb_role_switch_registerfunction usb_role_switch_unregister
Annotated Snippet
struct usb_role_switch_desc {
struct fwnode_handle *fwnode;
struct device *usb2_port;
struct device *usb3_port;
struct device *udc;
usb_role_switch_set_t set;
usb_role_switch_get_t get;
bool allow_userspace_control;
void *driver_data;
const char *name;
};
#if IS_ENABLED(CONFIG_USB_ROLE_SWITCH)
int usb_role_switch_set_role(struct usb_role_switch *sw, enum usb_role role);
enum usb_role usb_role_switch_get_role(struct usb_role_switch *sw);
struct usb_role_switch *usb_role_switch_get(struct device *dev);
struct usb_role_switch *fwnode_usb_role_switch_get(struct fwnode_handle *node);
void usb_role_switch_put(struct usb_role_switch *sw);
struct usb_role_switch *
usb_role_switch_find_by_fwnode(const struct fwnode_handle *fwnode);
struct usb_role_switch *
usb_role_switch_register(struct device *parent,
const struct usb_role_switch_desc *desc);
void usb_role_switch_unregister(struct usb_role_switch *sw);
void usb_role_switch_set_drvdata(struct usb_role_switch *sw, void *data);
void *usb_role_switch_get_drvdata(struct usb_role_switch *sw);
const char *usb_role_string(enum usb_role role);
#else
static inline int usb_role_switch_set_role(struct usb_role_switch *sw,
enum usb_role role)
{
return 0;
}
static inline enum usb_role usb_role_switch_get_role(struct usb_role_switch *sw)
{
return USB_ROLE_NONE;
}
static inline struct usb_role_switch *usb_role_switch_get(struct device *dev)
{
return ERR_PTR(-ENODEV);
}
static inline struct usb_role_switch *
fwnode_usb_role_switch_get(struct fwnode_handle *node)
{
return ERR_PTR(-ENODEV);
}
static inline void usb_role_switch_put(struct usb_role_switch *sw) { }
static inline struct usb_role_switch *
usb_role_switch_find_by_fwnode(const struct fwnode_handle *fwnode)
{
return NULL;
}
static inline struct usb_role_switch *
usb_role_switch_register(struct device *parent,
const struct usb_role_switch_desc *desc)
{
return ERR_PTR(-ENODEV);
}
static inline void usb_role_switch_unregister(struct usb_role_switch *sw) { }
static inline void
usb_role_switch_set_drvdata(struct usb_role_switch *sw, void *data)
{
}
static inline void *usb_role_switch_get_drvdata(struct usb_role_switch *sw)
{
return NULL;
}
static inline const char *usb_role_string(enum usb_role role)
{
return "unknown";
}
#endif
#endif /* __LINUX_USB_ROLE_H */
Annotation
- Immediate include surface: `linux/device.h`.
- Detected declarations: `struct usb_role_switch`, `struct usb_role_switch_desc`, `enum usb_role`, `function usb_role_switch_set_role`, `function usb_role_switch_get_role`, `function fwnode_usb_role_switch_get`, `function usb_role_switch_put`, `function usb_role_switch_register`, `function usb_role_switch_unregister`.
- 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.