Greg Kroah-Hartman | 41dceed | 2008-01-30 15:21:33 -0800 | [diff] [blame] | 1 | /* USB OTG (On The Go) defines */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 2 | /* |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 3 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 4 | * These APIs may be used between USB controllers. USB device drivers |
| 5 | * (for either host or peripheral roles) don't use these calls; they |
| 6 | * continue to use just usb_device and usb_gadget. |
| 7 | */ |
| 8 | |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 9 | #ifndef __LINUX_USB_OTG_H |
| 10 | #define __LINUX_USB_OTG_H |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | |
Venu Byravarasu | de4217d | 2012-09-04 14:25:58 +0530 | [diff] [blame] | 12 | #include <linux/usb/phy.h> |
Felipe Balbi | e9a2017 | 2009-12-17 13:01:36 +0200 | [diff] [blame] | 13 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | /* OTG defines lots of enumeration states before device reset */ |
| 15 | enum usb_otg_state { |
| 16 | OTG_STATE_UNDEFINED = 0, |
| 17 | |
| 18 | /* single-role peripheral, and dual-role default-b */ |
| 19 | OTG_STATE_B_IDLE, |
| 20 | OTG_STATE_B_SRP_INIT, |
| 21 | OTG_STATE_B_PERIPHERAL, |
| 22 | |
| 23 | /* extra dual-role default-b states */ |
| 24 | OTG_STATE_B_WAIT_ACON, |
| 25 | OTG_STATE_B_HOST, |
| 26 | |
| 27 | /* dual-role default-a */ |
| 28 | OTG_STATE_A_IDLE, |
| 29 | OTG_STATE_A_WAIT_VRISE, |
| 30 | OTG_STATE_A_WAIT_BCON, |
| 31 | OTG_STATE_A_HOST, |
| 32 | OTG_STATE_A_SUSPEND, |
| 33 | OTG_STATE_A_PERIPHERAL, |
| 34 | OTG_STATE_A_WAIT_VFALL, |
| 35 | OTG_STATE_A_VBUS_ERR, |
| 36 | }; |
| 37 | |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 38 | struct usb_otg { |
| 39 | u8 default_a; |
| 40 | |
| 41 | struct usb_phy *phy; |
| 42 | struct usb_bus *host; |
| 43 | struct usb_gadget *gadget; |
| 44 | |
| 45 | /* bind/unbind the host controller */ |
| 46 | int (*set_host)(struct usb_otg *otg, struct usb_bus *host); |
| 47 | |
| 48 | /* bind/unbind the peripheral controller */ |
| 49 | int (*set_peripheral)(struct usb_otg *otg, |
| 50 | struct usb_gadget *gadget); |
| 51 | |
| 52 | /* effective for A-peripheral, ignored for B devices */ |
| 53 | int (*set_vbus)(struct usb_otg *otg, bool enabled); |
| 54 | |
| 55 | /* for B devices only: start session with A-Host */ |
| 56 | int (*start_srp)(struct usb_otg *otg); |
| 57 | |
| 58 | /* start or continue HNP role switch */ |
| 59 | int (*start_hnp)(struct usb_otg *otg); |
| 60 | |
| 61 | }; |
| 62 | |
Grazvydas Ignotas | 748eee0 | 2010-09-27 15:17:18 +0300 | [diff] [blame] | 63 | #ifdef CONFIG_USB_OTG_UTILS |
Anatolij Gustschin | 3df0045 | 2011-05-05 12:11:21 +0200 | [diff] [blame] | 64 | extern const char *otg_state_string(enum usb_otg_state state); |
Grazvydas Ignotas | 748eee0 | 2010-09-27 15:17:18 +0300 | [diff] [blame] | 65 | #else |
Anatolij Gustschin | 3df0045 | 2011-05-05 12:11:21 +0200 | [diff] [blame] | 66 | static inline const char *otg_state_string(enum usb_otg_state state) |
| 67 | { |
| 68 | return NULL; |
| 69 | } |
Grazvydas Ignotas | 748eee0 | 2010-09-27 15:17:18 +0300 | [diff] [blame] | 70 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | |
Robert Jarzmik | c2344f1 | 2009-01-24 23:54:31 -0800 | [diff] [blame] | 72 | /* Context: can sleep */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | static inline int |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 74 | otg_start_hnp(struct usb_otg *otg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 75 | { |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 76 | if (otg && otg->start_hnp) |
| 77 | return otg->start_hnp(otg); |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 78 | |
Heikki Krogerus | 136ced8 | 2012-02-13 13:24:19 +0200 | [diff] [blame] | 79 | return -ENOTSUPP; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | } |
| 81 | |
Daniel Mack | 91c8a5a | 2009-10-15 17:09:34 +0300 | [diff] [blame] | 82 | /* Context: can sleep */ |
| 83 | static inline int |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 84 | otg_set_vbus(struct usb_otg *otg, bool enabled) |
Daniel Mack | 91c8a5a | 2009-10-15 17:09:34 +0300 | [diff] [blame] | 85 | { |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 86 | if (otg && otg->set_vbus) |
| 87 | return otg->set_vbus(otg, enabled); |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 88 | |
Heikki Krogerus | 136ced8 | 2012-02-13 13:24:19 +0200 | [diff] [blame] | 89 | return -ENOTSUPP; |
Daniel Mack | 91c8a5a | 2009-10-15 17:09:34 +0300 | [diff] [blame] | 90 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
| 92 | /* for HCDs */ |
| 93 | static inline int |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 94 | otg_set_host(struct usb_otg *otg, struct usb_bus *host) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 95 | { |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 96 | if (otg && otg->set_host) |
| 97 | return otg->set_host(otg, host); |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 98 | |
Heikki Krogerus | 136ced8 | 2012-02-13 13:24:19 +0200 | [diff] [blame] | 99 | return -ENOTSUPP; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | } |
| 101 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | /* for usb peripheral controller drivers */ |
Robert Jarzmik | c2344f1 | 2009-01-24 23:54:31 -0800 | [diff] [blame] | 103 | |
| 104 | /* Context: can sleep */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | static inline int |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 106 | otg_set_peripheral(struct usb_otg *otg, struct usb_gadget *periph) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | { |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 108 | if (otg && otg->set_peripheral) |
| 109 | return otg->set_peripheral(otg, periph); |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 110 | |
Heikki Krogerus | 136ced8 | 2012-02-13 13:24:19 +0200 | [diff] [blame] | 111 | return -ENOTSUPP; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | static inline int |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 115 | otg_start_srp(struct usb_otg *otg) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | { |
Heikki Krogerus | 6e13c65 | 2012-02-13 13:24:20 +0200 | [diff] [blame] | 117 | if (otg && otg->start_srp) |
| 118 | return otg->start_srp(otg); |
Heikki Krogerus | 7a8a3a9 | 2012-02-13 13:24:04 +0200 | [diff] [blame] | 119 | |
Heikki Krogerus | 136ced8 | 2012-02-13 13:24:19 +0200 | [diff] [blame] | 120 | return -ENOTSUPP; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | } |
| 122 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 123 | /* for OTG controller drivers (and maybe other stuff) */ |
| 124 | extern int usb_bus_start_enum(struct usb_bus *bus, unsigned port_num); |
Robert P. J. Day | dda43a0 | 2008-03-07 13:45:32 -0500 | [diff] [blame] | 125 | |
| 126 | #endif /* __LINUX_USB_OTG_H */ |