linux-stable/include/linux/usb/role.h
Chunfeng Yun 73e33008e8 usb: roles: add helper usb_role_string()
Introduces usb_role_string() function, which returns a
human-readable name of provided usb role, it's useful to
make the log readable.

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: Chunfeng Yun <chunfeng.yun@mediatek.com>
Link: https://lore.kernel.org/r/1621932786-9335-1-git-send-email-chunfeng.yun@mediatek.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-05-27 09:17:18 +02:00

120 lines
3.5 KiB
C

// SPDX-License-Identifier: GPL-2.0
#ifndef __LINUX_USB_ROLE_H
#define __LINUX_USB_ROLE_H
#include <linux/device.h>
struct usb_role_switch;
enum usb_role {
USB_ROLE_NONE,
USB_ROLE_HOST,
USB_ROLE_DEVICE,
};
typedef int (*usb_role_switch_set_t)(struct usb_role_switch *sw,
enum usb_role role);
typedef enum usb_role (*usb_role_switch_get_t)(struct usb_role_switch *sw);
/**
* struct usb_role_switch_desc - USB Role Switch Descriptor
* @fwnode: The device node to be associated with the role switch
* @usb2_port: Optional reference to the host controller port device (USB2)
* @usb3_port: Optional reference to the host controller port device (USB3)
* @udc: Optional reference to the peripheral controller device
* @set: Callback for setting the role
* @get: Callback for getting the role (optional)
* @allow_userspace_control: If true userspace may change the role through sysfs
* @driver_data: Private data pointer
* @name: Name for the switch (optional)
*
* @usb2_port and @usb3_port will point to the USB host port and @udc to the USB
* device controller behind the USB connector with the role switch. If
* @usb2_port, @usb3_port and @udc are included in the description, the
* reference count for them should be incremented by the caller of
* usb_role_switch_register() before registering the switch.
*/
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_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 */