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