1 /* SPDX-License-Identifier: GPL-2.0 */ 2 3 #ifndef __LINUX_USB_TYPEC_H 4 #define __LINUX_USB_TYPEC_H 5 6 #include <linux/types.h> 7 8 /* USB Type-C Specification releases */ 9 #define USB_TYPEC_REV_1_0 0x100 /* 1.0 */ 10 #define USB_TYPEC_REV_1_1 0x110 /* 1.1 */ 11 #define USB_TYPEC_REV_1_2 0x120 /* 1.2 */ 12 #define USB_TYPEC_REV_1_3 0x130 /* 1.3 */ 13 #define USB_TYPEC_REV_1_4 0x140 /* 1.4 */ 14 #define USB_TYPEC_REV_2_0 0x200 /* 2.0 */ 15 16 struct typec_partner; 17 struct typec_cable; 18 struct typec_plug; 19 struct typec_port; 20 21 struct fwnode_handle; 22 struct device; 23 24 enum typec_port_type { 25 TYPEC_PORT_SRC, 26 TYPEC_PORT_SNK, 27 TYPEC_PORT_DRP, 28 }; 29 30 enum typec_port_data { 31 TYPEC_PORT_DFP, 32 TYPEC_PORT_UFP, 33 TYPEC_PORT_DRD, 34 }; 35 36 enum typec_plug_type { 37 USB_PLUG_NONE, 38 USB_PLUG_TYPE_A, 39 USB_PLUG_TYPE_B, 40 USB_PLUG_TYPE_C, 41 USB_PLUG_CAPTIVE, 42 }; 43 44 enum typec_data_role { 45 TYPEC_DEVICE, 46 TYPEC_HOST, 47 }; 48 49 enum typec_role { 50 TYPEC_SINK, 51 TYPEC_SOURCE, 52 }; 53 54 enum typec_pwr_opmode { 55 TYPEC_PWR_MODE_USB, 56 TYPEC_PWR_MODE_1_5A, 57 TYPEC_PWR_MODE_3_0A, 58 TYPEC_PWR_MODE_PD, 59 }; 60 61 enum typec_accessory { 62 TYPEC_ACCESSORY_NONE, 63 TYPEC_ACCESSORY_AUDIO, 64 TYPEC_ACCESSORY_DEBUG, 65 }; 66 67 #define TYPEC_MAX_ACCESSORY 3 68 69 enum typec_orientation { 70 TYPEC_ORIENTATION_NONE, 71 TYPEC_ORIENTATION_NORMAL, 72 TYPEC_ORIENTATION_REVERSE, 73 }; 74 75 /* 76 * struct enter_usb_data - Enter_USB Message details 77 * @eudo: Enter_USB Data Object 78 * @active_link_training: Active Cable Plug Link Training 79 * 80 * @active_link_training is a flag that should be set with uni-directional SBRX 81 * communication, and left 0 with passive cables and with bi-directional SBRX 82 * communication. 83 */ 84 struct enter_usb_data { 85 u32 eudo; 86 unsigned char active_link_training:1; 87 }; 88 89 /* 90 * struct usb_pd_identity - USB Power Delivery identity data 91 * @id_header: ID Header VDO 92 * @cert_stat: Cert Stat VDO 93 * @product: Product VDO 94 * @vdo: Product Type Specific VDOs 95 * 96 * USB power delivery Discover Identity command response data. 97 * 98 * REVISIT: This is USB Power Delivery specific information, so this structure 99 * probable belongs to USB Power Delivery header file once we have them. 100 */ 101 struct usb_pd_identity { 102 u32 id_header; 103 u32 cert_stat; 104 u32 product; 105 u32 vdo[3]; 106 }; 107 108 int typec_partner_set_identity(struct typec_partner *partner); 109 int typec_cable_set_identity(struct typec_cable *cable); 110 111 /* 112 * struct typec_altmode_desc - USB Type-C Alternate Mode Descriptor 113 * @svid: Standard or Vendor ID 114 * @mode: Index of the Mode 115 * @vdo: VDO returned by Discover Modes USB PD command 116 * @roles: Only for ports. DRP if the mode is available in both roles 117 * 118 * Description of an Alternate Mode which a connector, cable plug or partner 119 * supports. 120 */ 121 struct typec_altmode_desc { 122 u16 svid; 123 u8 mode; 124 u32 vdo; 125 /* Only used with ports */ 126 enum typec_port_data roles; 127 }; 128 129 int typec_partner_set_num_altmodes(struct typec_partner *partner, int num_altmodes); 130 struct typec_altmode 131 *typec_partner_register_altmode(struct typec_partner *partner, 132 const struct typec_altmode_desc *desc); 133 int typec_plug_set_num_altmodes(struct typec_plug *plug, int num_altmodes); 134 struct typec_altmode 135 *typec_plug_register_altmode(struct typec_plug *plug, 136 const struct typec_altmode_desc *desc); 137 struct typec_altmode 138 *typec_port_register_altmode(struct typec_port *port, 139 const struct typec_altmode_desc *desc); 140 void typec_unregister_altmode(struct typec_altmode *altmode); 141 142 struct typec_port *typec_altmode2port(struct typec_altmode *alt); 143 144 void typec_altmode_update_active(struct typec_altmode *alt, bool active); 145 146 enum typec_plug_index { 147 TYPEC_PLUG_SOP_P, 148 TYPEC_PLUG_SOP_PP, 149 }; 150 151 /* 152 * struct typec_plug_desc - USB Type-C Cable Plug Descriptor 153 * @index: SOP Prime for the plug connected to DFP and SOP Double Prime for the 154 * plug connected to UFP 155 * 156 * Represents USB Type-C Cable Plug. 157 */ 158 struct typec_plug_desc { 159 enum typec_plug_index index; 160 }; 161 162 /* 163 * struct typec_cable_desc - USB Type-C Cable Descriptor 164 * @type: The plug type from USB PD Cable VDO 165 * @active: Is the cable active or passive 166 * @identity: Result of Discover Identity command 167 * 168 * Represents USB Type-C Cable attached to USB Type-C port. 169 */ 170 struct typec_cable_desc { 171 enum typec_plug_type type; 172 unsigned int active:1; 173 struct usb_pd_identity *identity; 174 }; 175 176 /* 177 * struct typec_partner_desc - USB Type-C Partner Descriptor 178 * @usb_pd: USB Power Delivery support 179 * @accessory: Audio, Debug or none. 180 * @identity: Discover Identity command data 181 * 182 * Details about a partner that is attached to USB Type-C port. If @identity 183 * member exists when partner is registered, a directory named "identity" is 184 * created to sysfs for the partner device. 185 */ 186 struct typec_partner_desc { 187 unsigned int usb_pd:1; 188 enum typec_accessory accessory; 189 struct usb_pd_identity *identity; 190 }; 191 192 /** 193 * struct typec_operations - USB Type-C Port Operations 194 * @try_role: Set data role preference for DRP port 195 * @dr_set: Set Data Role 196 * @pr_set: Set Power Role 197 * @vconn_set: Source VCONN 198 * @port_type_set: Set port type 199 */ 200 struct typec_operations { 201 int (*try_role)(struct typec_port *port, int role); 202 int (*dr_set)(struct typec_port *port, enum typec_data_role role); 203 int (*pr_set)(struct typec_port *port, enum typec_role role); 204 int (*vconn_set)(struct typec_port *port, enum typec_role role); 205 int (*port_type_set)(struct typec_port *port, 206 enum typec_port_type type); 207 }; 208 209 /* 210 * struct typec_capability - USB Type-C Port Capabilities 211 * @type: Supported power role of the port 212 * @data: Supported data role of the port 213 * @revision: USB Type-C Specification release. Binary coded decimal 214 * @pd_revision: USB Power Delivery Specification revision if supported 215 * @prefer_role: Initial role preference (DRP ports). 216 * @accessory: Supported Accessory Modes 217 * @fwnode: Optional fwnode of the port 218 * @driver_data: Private pointer for driver specific info 219 * @ops: Port operations vector 220 * 221 * Static capabilities of a single USB Type-C port. 222 */ 223 struct typec_capability { 224 enum typec_port_type type; 225 enum typec_port_data data; 226 u16 revision; /* 0120H = "1.2" */ 227 u16 pd_revision; /* 0300H = "3.0" */ 228 int prefer_role; 229 enum typec_accessory accessory[TYPEC_MAX_ACCESSORY]; 230 unsigned int orientation_aware:1; 231 232 struct fwnode_handle *fwnode; 233 void *driver_data; 234 235 const struct typec_operations *ops; 236 }; 237 238 /* Specific to try_role(). Indicates the user want's to clear the preference. */ 239 #define TYPEC_NO_PREFERRED_ROLE (-1) 240 241 struct typec_port *typec_register_port(struct device *parent, 242 const struct typec_capability *cap); 243 void typec_unregister_port(struct typec_port *port); 244 245 struct typec_partner *typec_register_partner(struct typec_port *port, 246 struct typec_partner_desc *desc); 247 void typec_unregister_partner(struct typec_partner *partner); 248 249 struct typec_cable *typec_register_cable(struct typec_port *port, 250 struct typec_cable_desc *desc); 251 void typec_unregister_cable(struct typec_cable *cable); 252 253 struct typec_cable *typec_cable_get(struct typec_port *port); 254 void typec_cable_put(struct typec_cable *cable); 255 int typec_cable_is_active(struct typec_cable *cable); 256 257 struct typec_plug *typec_register_plug(struct typec_cable *cable, 258 struct typec_plug_desc *desc); 259 void typec_unregister_plug(struct typec_plug *plug); 260 261 void typec_set_data_role(struct typec_port *port, enum typec_data_role role); 262 void typec_set_pwr_role(struct typec_port *port, enum typec_role role); 263 void typec_set_vconn_role(struct typec_port *port, enum typec_role role); 264 void typec_set_pwr_opmode(struct typec_port *port, enum typec_pwr_opmode mode); 265 266 int typec_set_orientation(struct typec_port *port, 267 enum typec_orientation orientation); 268 enum typec_orientation typec_get_orientation(struct typec_port *port); 269 int typec_set_mode(struct typec_port *port, int mode); 270 271 void *typec_get_drvdata(struct typec_port *port); 272 273 int typec_find_pwr_opmode(const char *name); 274 int typec_find_orientation(const char *name); 275 int typec_find_port_power_role(const char *name); 276 int typec_find_power_role(const char *name); 277 int typec_find_port_data_role(const char *name); 278 #endif /* __LINUX_USB_TYPEC_H */ 279