drivers/usb/typec/ucsi/ucsi.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2
   3 #ifndef __DRIVER_USB_TYPEC_UCSI_H
   4 #define __DRIVER_USB_TYPEC_UCSI_H
   5
   6 #include <linux/bitops.h>
   7 #include <linux/bitmap.h>
   8 #include <linux/completion.h>
   9 #include <linux/device.h>
  10 #include <linux/power_supply.h>
  11 #include <linux/types.h>
  12 #include <linux/usb/typec.h>
  13 #include <linux/usb/pd.h>
  14 #include <linux/usb/role.h>
  15 #include <linux/unaligned.h>
  16
  17 /* -------------------------------------------------------------------------- */
  18
  19 struct ucsi;
  20 struct ucsi_altmode;
  21 struct ucsi_connector;
  22 struct dentry;
  23
  24 /* UCSI offsets (Bytes) */
  25 #define UCSI_VERSION                    0
  26 #define UCSI_CCI                        4
  27 #define UCSI_CONTROL                    8
  28 #define UCSI_MESSAGE_IN                 16
  29 #define UCSI_MESSAGE_OUT                32
  30 #define UCSIv2_MESSAGE_OUT              272
  31
  32 /* UCSI versions */
  33 #define UCSI_VERSION_1_1        0x0110
  34 #define UCSI_VERSION_1_2        0x0120
  35 #define UCSI_VERSION_2_0        0x0200
  36 #define UCSI_VERSION_2_1        0x0210
  37 #define UCSI_VERSION_3_0        0x0300
  38
  39 #define UCSI_BCD_GET_MAJOR(_v_)         (((_v_) >> 8) & 0xFF)
  40 #define UCSI_BCD_GET_MINOR(_v_)         (((_v_) >> 4) & 0x0F)
  41 #define UCSI_BCD_GET_SUBMINOR(_v_)      ((_v_) & 0x0F)
  42
  43 /*
  44  * Per USB PD 3.2, Section 6.2.1.1.5, the spec revision is represented by 2 bits
  45  * 0b00 = 1.0, 0b01 = 2.0, 0b10 = 3.0, 0b11 = Reserved, Shall NOT be used.
  46  */
  47 #define UCSI_SPEC_REVISION_TO_BCD(_v_)  (((_v_) + 1) << 8)
  48
  49 /* Command Status and Connector Change Indication (CCI) bits */
  50 #define UCSI_CCI_CONNECTOR(_c_)         (((_c_) & GENMASK(7, 1)) >> 1)
  51 #define UCSI_CCI_LENGTH(_c_)            (((_c_) & GENMASK(15, 8)) >> 8)
  52 #define UCSI_CCI_NOT_SUPPORTED          BIT(25)
  53 #define UCSI_CCI_CANCEL_COMPLETE        BIT(26)
  54 #define UCSI_CCI_RESET_COMPLETE         BIT(27)
  55 #define UCSI_CCI_BUSY                   BIT(28)
  56 #define UCSI_CCI_ACK_COMPLETE           BIT(29)
  57 #define UCSI_CCI_ERROR                  BIT(30)
  58 #define UCSI_CCI_COMMAND_COMPLETE       BIT(31)
  59
  60 /**
  61  * struct ucsi_operations - UCSI I/O operations
  62  * @read_version: Read implemented UCSI version
  63  * @read_cci: Read CCI register
  64  * @read_message_in: Read message data from UCSI
  65  * @sync_control: Blocking control operation
  66  * @async_control: Non-blocking control operation
  67  * @update_altmodes: Squashes duplicate DP altmodes
  68  * @update_connector: Update connector capabilities before registering
  69  * @connector_status: Updates connector status, called holding connector lock
  70  *
  71  * Read and write routines for UCSI interface. @sync_write must wait for the
  72  * Command Completion Event from the PPM before returning, and @async_write must
  73  * return immediately after sending the data to the PPM.
  74  */
  75 struct ucsi_operations {
  76         int (*read_version)(struct ucsi *ucsi, u16 *version);
  77         int (*read_cci)(struct ucsi *ucsi, u32 *cci);
  78         int (*read_message_in)(struct ucsi *ucsi, void *val, size_t val_len);
  79         int (*sync_control)(struct ucsi *ucsi, u64 command);
  80         int (*async_control)(struct ucsi *ucsi, u64 command);
  81         bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig,
  82                                 struct ucsi_altmode *updated);
  83         void (*update_connector)(struct ucsi_connector *con);
  84         void (*connector_status)(struct ucsi_connector *con);
  85 };
  86
  87 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops);
  88 void ucsi_destroy(struct ucsi *ucsi);
  89 int ucsi_register(struct ucsi *ucsi);
  90 void ucsi_unregister(struct ucsi *ucsi);
  91 void *ucsi_get_drvdata(struct ucsi *ucsi);
  92 void ucsi_set_drvdata(struct ucsi *ucsi, void *data);
  93
  94 void ucsi_connector_change(struct ucsi *ucsi, u8 num);
  95
  96 /* -------------------------------------------------------------------------- */
  97
  98 /* Commands */
  99 #define UCSI_PPM_RESET                          0x01
 100 #define UCSI_CANCEL                             0x02
 101 #define UCSI_CONNECTOR_RESET                    0x03
 102 #define UCSI_ACK_CC_CI                          0x04
 103 #define UCSI_SET_NOTIFICATION_ENABLE            0x05
 104 #define UCSI_GET_CAPABILITY                     0x06
 105 #define UCSI_GET_CAPABILITY_SIZE                128
 106 #define UCSI_GET_CONNECTOR_CAPABILITY           0x07
 107 #define UCSI_GET_CONNECTOR_CAPABILITY_SIZE      32
 108 #define UCSI_SET_UOM                            0x08
 109 #define UCSI_SET_UOR                            0x09
 110 #define UCSI_SET_PDM                            0x0a
 111 #define UCSI_SET_PDR                            0x0b
 112 #define UCSI_GET_ALTERNATE_MODES                0x0c
 113 #define UCSI_GET_CAM_SUPPORTED                  0x0d
 114 #define UCSI_GET_CURRENT_CAM                    0x0e
 115 #define UCSI_SET_NEW_CAM                        0x0f
 116 #define UCSI_GET_PDOS                           0x10
 117 #define UCSI_GET_CABLE_PROPERTY                 0x11
 118 #define UCSI_GET_CABLE_PROPERTY_SIZE            64
 119 #define UCSI_GET_CONNECTOR_STATUS               0x12
 120 #define UCSI_GET_CONNECTOR_STATUS_SIZE          152
 121 #define UCSI_GET_ERROR_STATUS                   0x13
 122 #define UCSI_GET_PD_MESSAGE                     0x15
 123 #define UCSI_SET_SINK_PATH                      0x1c
 124
 125 #define UCSI_CONNECTOR_NUMBER(_num_)            ((u64)(_num_) << 16)
 126 #define UCSI_COMMAND(_cmd_)                     ((_cmd_) & 0xff)
 127
 128 #define UCSI_GET_ALTMODE_GET_CONNECTOR_NUMBER(_cmd_)    (((_cmd_) >> 24) & GENMASK(6, 0))
 129 #define UCSI_DEFAULT_GET_CONNECTOR_NUMBER(_cmd_)        (((_cmd_) >> 16) & GENMASK(6, 0))
 130
 131 /* CONNECTOR_RESET command bits */
 132 #define UCSI_CONNECTOR_RESET_HARD_VER_1_0       BIT(23) /* Deprecated in v1.1 */
 133 #define UCSI_CONNECTOR_RESET_DATA_VER_2_0       BIT(23) /* Redefined in v2.0 */
 134
 135 /* ACK_CC_CI bits */
 136 #define UCSI_ACK_CONNECTOR_CHANGE               BIT(16)
 137 #define UCSI_ACK_COMMAND_COMPLETE               BIT(17)
 138
 139 /* SET_NOTIFICATION_ENABLE command bits */
 140 #define UCSI_ENABLE_NTFY_CMD_COMPLETE           BIT_ULL(16)
 141 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE     BIT_ULL(17)
 142 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE      BIT_ULL(18)
 143 #define UCSI_ENABLE_NTFY_ATTENTION              BIT_ULL(19)
 144 #define UCSI_ENABLE_NTFY_LPM_FW_UPDATE_REQ      BIT_ULL(20)
 145 #define UCSI_ENABLE_NTFY_CAP_CHANGE             BIT_ULL(21)
 146 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE       BIT_ULL(22)
 147 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE      BIT_ULL(23)
 148 #define UCSI_ENABLE_NTFY_CAM_CHANGE             BIT_ULL(24)
 149 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE      BIT_ULL(25)
 150 #define UCSI_ENABLE_NTFY_SECURITY_REQ_PARTNER   BIT_ULL(26)
 151 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE         BIT_ULL(27)
 152 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE         BIT_ULL(28)
 153 #define UCSI_ENABLE_NTFY_SET_RETIMER_MODE       BIT_ULL(29)
 154 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE       BIT_ULL(30)
 155 #define UCSI_ENABLE_NTFY_ERROR                  BIT_ULL(31)
 156 #define UCSI_ENABLE_NTFY_SINK_PATH_STS_CHANGE   BIT_ULL(32)
 157 #define UCSI_ENABLE_NTFY_ALL                    0xdbe70000
 158
 159 /* SET_UOR command bits */
 160 #define UCSI_SET_UOR_ROLE(_r_)          (((_r_) == TYPEC_HOST ? 1 : 2) << 23)
 161 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS          BIT(25)
 162
 163 /* SET_PDF command bits */
 164 #define UCSI_SET_PDR_ROLE(_r_)          (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23)
 165 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS          BIT(25)
 166
 167 /* GET_ALTERNATE_MODES command bits */
 168 #define UCSI_ALTMODE_RECIPIENT(_r_)             (((_r_) >> 16) & 0x7)
 169 #define UCSI_GET_ALTMODE_RECIPIENT(_r_)         ((u64)(_r_) << 16)
 170 #define   UCSI_RECIPIENT_CON                    0
 171 #define   UCSI_RECIPIENT_SOP                    1
 172 #define   UCSI_RECIPIENT_SOP_P                  2
 173 #define   UCSI_RECIPIENT_SOP_PP                 3
 174 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_)  ((u64)(_r_) << 24)
 175 #define UCSI_ALTMODE_OFFSET(_r_)                (((_r_) >> 32) & 0xff)
 176 #define UCSI_GET_ALTMODE_OFFSET(_r_)            ((u64)(_r_) << 32)
 177 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_)      ((u64)(_r_) << 40)
 178
 179 /* GET_PDOS command bits */
 180 #define UCSI_GET_PDOS_PARTNER_PDO(_r_)          ((u64)(_r_) << 23)
 181 #define UCSI_GET_PDOS_PDO_OFFSET(_r_)           ((u64)(_r_) << 24)
 182 #define UCSI_GET_PDOS_NUM_PDOS(_r_)             ((u64)(_r_) << 32)
 183 #define UCSI_MAX_PDOS                           (4)
 184 #define UCSI_GET_PDOS_SRC_PDOS                  ((u64)1 << 34)
 185
 186 /* GET_PD_MESSAGE command bits */
 187 #define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_)      ((u64)(_r_) << 23)
 188 #define UCSI_GET_PD_MESSAGE_OFFSET(_r_)         ((u64)(_r_) << 26)
 189 #define UCSI_GET_PD_MESSAGE_BYTES(_r_)          ((u64)(_r_) << 34)
 190 #define UCSI_GET_PD_MESSAGE_TYPE(_r_)           ((u64)(_r_) << 42)
 191 #define   UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT  0
 192 #define   UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT  1
 193 #define   UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP      2
 194 #define   UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT     3
 195 #define   UCSI_GET_PD_MESSAGE_TYPE_IDENTITY     4
 196 #define   UCSI_GET_PD_MESSAGE_TYPE_REVISION     5
 197
 198 /* -------------------------------------------------------------------------- */
 199
 200 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
 201 #define UCSI_ERROR_UNREGONIZED_CMD              BIT(0)
 202 #define UCSI_ERROR_INVALID_CON_NUM              BIT(1)
 203 #define UCSI_ERROR_INVALID_CMD_ARGUMENT         BIT(2)
 204 #define UCSI_ERROR_INCOMPATIBLE_PARTNER         BIT(3)
 205 #define UCSI_ERROR_CC_COMMUNICATION_ERR         BIT(4)
 206 #define UCSI_ERROR_DEAD_BATTERY                 BIT(5)
 207 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL    BIT(6)
 208 #define UCSI_ERROR_OVERCURRENT                  BIT(7)
 209 #define UCSI_ERROR_UNDEFINED                    BIT(8)
 210 #define UCSI_ERROR_PARTNER_REJECTED_SWAP        BIT(9)
 211 #define UCSI_ERROR_HARD_RESET                   BIT(10)
 212 #define UCSI_ERROR_PPM_POLICY_CONFLICT          BIT(11)
 213 #define UCSI_ERROR_SWAP_REJECTED                BIT(12)
 214 #define UCSI_ERROR_REVERSE_CURRENT_PROTECTION   BIT(13)
 215 #define UCSI_ERROR_SET_SINK_PATH_REJECTED       BIT(14)
 216
 217 #define UCSI_SET_NEW_CAM_ENTER(x)               (((x) >> 23) & 0x1)
 218 #define UCSI_SET_NEW_CAM_GET_AM(x)              (((x) >> 24) & 0xff)
 219 #define UCSI_SET_NEW_CAM_AM_MASK                (0xff << 24)
 220 #define UCSI_SET_NEW_CAM_SET_AM(x)              (((x) & 0xff) << 24)
 221 #define UCSI_CMD_CONNECTOR_MASK                 (0x7)
 222
 223 /* Data structure filled by PPM in response to GET_CAPABILITY command. */
 224 struct ucsi_capability {
 225         u32 attributes;
 226 #define UCSI_CAP_ATTR_DISABLE_STATE             BIT(0)
 227 #define UCSI_CAP_ATTR_BATTERY_CHARGING          BIT(1)
 228 #define UCSI_CAP_ATTR_USB_PD                    BIT(2)
 229 #define UCSI_CAP_ATTR_TYPEC_CURRENT             BIT(6)
 230 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY           BIT(8)
 231 #define UCSI_CAP_ATTR_POWER_OTHER               BIT(10)
 232 #define UCSI_CAP_ATTR_POWER_VBUS                BIT(14)
 233         u8 num_connectors;
 234         u16 features;
 235 #define UCSI_CAP_SET_UOM                        BIT(0)
 236 #define UCSI_CAP_SET_PDM                        BIT(1)
 237 #define UCSI_CAP_ALT_MODE_DETAILS               BIT(2)
 238 #define UCSI_CAP_ALT_MODE_OVERRIDE              BIT(3)
 239 #define UCSI_CAP_PDO_DETAILS                    BIT(4)
 240 #define UCSI_CAP_CABLE_DETAILS                  BIT(5)
 241 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS       BIT(6)
 242 #define UCSI_CAP_PD_RESET                       BIT(7)
 243 #define UCSI_CAP_GET_PD_MESSAGE                 BIT(8)
 244 #define UCSI_CAP_GET_ATTENTION_VDO              BIT(9)
 245 #define UCSI_CAP_FW_UPDATE_REQUEST              BIT(10)
 246 #define UCSI_CAP_NEGOTIATED_PWR_LEVEL_CHANGE    BIT(11)
 247 #define UCSI_CAP_SECURITY_REQUEST               BIT(12)
 248 #define UCSI_CAP_SET_RETIMER_MODE               BIT(13)
 249 #define UCSI_CAP_CHUNKING_SUPPORT               BIT(14)
 250         u8 reserved_1;
 251         u8 num_alt_modes;
 252         u8 reserved_2;
 253         u16 bc_version;
 254         u16 pd_version;
 255         u16 typec_version;
 256 } __packed;
 257
 258 struct ucsi_altmode {
 259         u16 svid;
 260         u32 mid;
 261 } __packed;
 262
 263 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */
 264 struct ucsi_cable_property {
 265         u16 speed_supported;
 266         u8 current_capability;
 267         u8 flags;
 268 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE      BIT(0)
 269 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE       BIT(1)
 270 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY     BIT(2)
 271 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_)     (((_f_) & GENMASK(4, 3)) >> 3)
 272 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_A       0
 273 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_B       1
 274 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_C       2
 275 #define   UCSI_CABLE_PROPERTY_PLUG_OTHER        3
 276 #define UCSI_CABLE_PROP_FLAG_MODE_SUPPORT       BIT(5)
 277 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_)  (((_f_) & GENMASK(7, 6)) >> 6)
 278 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(_f_) \
 279         UCSI_SPEC_REVISION_TO_BCD(UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_))
 280         u8 latency;
 281 } __packed;
 282
 283 /* Get Connector Capability Fields. */
 284 #define UCSI_CONCAP_OPMODE                      UCSI_DECLARE_BITFIELD(0, 0, 8)
 285 #define   UCSI_CONCAP_OPMODE_DFP                UCSI_DECLARE_BITFIELD(0, 0, 1)
 286 #define   UCSI_CONCAP_OPMODE_UFP                UCSI_DECLARE_BITFIELD(0, 1, 1)
 287 #define   UCSI_CONCAP_OPMODE_DRP                UCSI_DECLARE_BITFIELD(0, 2, 1)
 288 #define   UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY    UCSI_DECLARE_BITFIELD(0, 3, 1)
 289 #define   UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY    UCSI_DECLARE_BITFIELD(0, 4, 1)
 290 #define   UCSI_CONCAP_OPMODE_USB2               UCSI_DECLARE_BITFIELD(0, 5, 1)
 291 #define   UCSI_CONCAP_OPMODE_USB3               UCSI_DECLARE_BITFIELD(0, 6, 1)
 292 #define   UCSI_CONCAP_OPMODE_ALT_MODE           UCSI_DECLARE_BITFIELD(0, 7, 1)
 293 #define UCSI_CONCAP_PROVIDER                    UCSI_DECLARE_BITFIELD(0, 8, 1)
 294 #define UCSI_CONCAP_CONSUMER                    UCSI_DECLARE_BITFIELD(0, 9, 1)
 295 #define UCSI_CONCAP_SWAP_TO_DFP_V1_1            UCSI_DECLARE_BITFIELD_V1_1(10, 1)
 296 #define UCSI_CONCAP_SWAP_TO_UFP_V1_1            UCSI_DECLARE_BITFIELD_V1_1(11, 1)
 297 #define UCSI_CONCAP_SWAP_TO_SRC_V1_1            UCSI_DECLARE_BITFIELD_V1_1(12, 1)
 298 #define UCSI_CONCAP_SWAP_TO_SNK_V1_1            UCSI_DECLARE_BITFIELD_V1_1(13, 1)
 299 #define UCSI_CONCAP_EXT_OPMODE_V2_0             UCSI_DECLARE_BITFIELD_V2_0(14, 8)
 300 #define   UCSI_CONCAP_EXT_OPMODE_USB4_GEN2_V2_0 UCSI_DECLARE_BITFIELD_V2_0(14, 1)
 301 #define   UCSI_CONCAP_EXT_OPMODE_EPR_SRC_V2_0   UCSI_DECLARE_BITFIELD_V2_0(15, 1)
 302 #define   UCSI_CONCAP_EXT_OPMODE_EPR_SINK_V2_0  UCSI_DECLARE_BITFIELD_V2_0(16, 1)
 303 #define   UCSI_CONCAP_EXT_OPMODE_USB4_GEN3_V2_0 UCSI_DECLARE_BITFIELD_V2_0(17, 1)
 304 #define   UCSI_CONCAP_EXT_OPMODE_USB4_GEN4_V2_0 UCSI_DECLARE_BITFIELD_V2_0(18, 1)
 305 #define UCSI_CONCAP_MISC_V2_0                   UCSI_DECLARE_BITFIELD_V2_0(22, 4)
 306 #define   UCSI_CONCAP_MISC_FW_UPDATE_V2_0       UCSI_DECLARE_BITFIELD_V2_0(22, 1)
 307 #define   UCSI_CONCAP_MISC_SECURITY_V2_0        UCSI_DECLARE_BITFIELD_V2_0(23, 1)
 308 #define UCSI_CONCAP_REV_CURR_PROT_SUPPORT_V2_0  UCSI_DECLARE_BITFIELD_V2_0(26, 1)
 309 #define UCSI_CONCAP_PARTNER_PD_REVISION_V2_1    UCSI_DECLARE_BITFIELD_V2_1(27, 2)
 310
 311 /* Helpers for USB capability checks. */
 312 #define UCSI_CONCAP_USB2_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB2)
 313 #define UCSI_CONCAP_USB3_SUPPORT(_con_) UCSI_CONCAP((_con_), OPMODE_USB3)
 314 #define UCSI_CONCAP_USB4_SUPPORT(_con_)                                 \
 315         ((_con_)->ucsi->version >= UCSI_VERSION_2_0 &&                  \
 316          (UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN2_V2_0) |             \
 317           UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN3_V2_0) |             \
 318           UCSI_CONCAP((_con_), EXT_OPMODE_USB4_GEN4_V2_0)))
 319
 320 /* Get Connector Status Fields. */
 321 #define UCSI_CONSTAT_CHANGE                     UCSI_DECLARE_BITFIELD(0, 0, 16)
 322 #define UCSI_CONSTAT_PWR_OPMODE                 UCSI_DECLARE_BITFIELD(0, 16, 3)
 323 #define   UCSI_CONSTAT_PWR_OPMODE_NONE          0
 324 #define   UCSI_CONSTAT_PWR_OPMODE_DEFAULT       1
 325 #define   UCSI_CONSTAT_PWR_OPMODE_BC            2
 326 #define   UCSI_CONSTAT_PWR_OPMODE_PD            3
 327 #define   UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5      4
 328 #define   UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0      5
 329 #define UCSI_CONSTAT_CONNECTED                  UCSI_DECLARE_BITFIELD(0, 19, 1)
 330 #define UCSI_CONSTAT_PWR_DIR                    UCSI_DECLARE_BITFIELD(0, 20, 1)
 331 #define UCSI_CONSTAT_PARTNER_FLAGS              UCSI_DECLARE_BITFIELD(0, 21, 8)
 332 #define   UCSI_CONSTAT_PARTNER_FLAG_USB         UCSI_DECLARE_BITFIELD(0, 21, 1)
 333 #define   UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE    UCSI_DECLARE_BITFIELD(0, 22, 1)
 334 #define   UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN3   UCSI_DECLARE_BITFIELD(0, 23, 1)
 335 #define   UCSI_CONSTAT_PARTNER_FLAG_USB4_GEN4   UCSI_DECLARE_BITFIELD(0, 24, 1)
 336 #define UCSI_CONSTAT_PARTNER_TYPE               UCSI_DECLARE_BITFIELD(0, 29, 3)
 337 #define   UCSI_CONSTAT_PARTNER_TYPE_DFP         1
 338 #define   UCSI_CONSTAT_PARTNER_TYPE_UFP         2
 339 #define   UCSI_CONSTAT_PARTNER_TYPE_CABLE       3   /* Powered Cable */
 340 #define   UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */
 341 #define   UCSI_CONSTAT_PARTNER_TYPE_DEBUG       5
 342 #define   UCSI_CONSTAT_PARTNER_TYPE_AUDIO       6
 343 #define UCSI_CONSTAT_RDO                        UCSI_DECLARE_BITFIELD(0, 32, 32)
 344 #define UCSI_CONSTAT_BC_STATUS                  UCSI_DECLARE_BITFIELD(0, 64, 2)
 345 #define   UCSI_CONSTAT_BC_NOT_CHARGING          0
 346 #define   UCSI_CONSTAT_BC_NOMINAL_CHARGING      1
 347 #define   UCSI_CONSTAT_BC_SLOW_CHARGING         2
 348 #define   UCSI_CONSTAT_BC_TRICKLE_CHARGING      3
 349 #define UCSI_CONSTAT_PD_VERSION_V1_2            UCSI_DECLARE_BITFIELD_V1_2(70, 16)
 350
 351 /* Connector Status Change Bits.  */
 352 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE          BIT(1)
 353 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE        BIT(2)
 354 #define UCSI_CONSTAT_PDOS_CHANGE                BIT(5)
 355 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE         BIT(6)
 356 #define UCSI_CONSTAT_PD_RESET_COMPLETE          BIT(7)
 357 #define UCSI_CONSTAT_CAM_CHANGE                 BIT(8)
 358 #define UCSI_CONSTAT_BC_CHANGE                  BIT(9)
 359 #define UCSI_CONSTAT_PARTNER_CHANGE             BIT(11)
 360 #define UCSI_CONSTAT_POWER_DIR_CHANGE           BIT(12)
 361 #define UCSI_CONSTAT_CONNECT_CHANGE             BIT(14)
 362 #define UCSI_CONSTAT_ERROR                      BIT(15)
 363
 364 #define UCSI_DECLARE_BITFIELD_V1_1(_offset_, _size_)                    \
 365           UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_1, (_offset_), (_size_))
 366 #define UCSI_DECLARE_BITFIELD_V1_2(_offset_, _size_)                    \
 367           UCSI_DECLARE_BITFIELD(UCSI_VERSION_1_2, (_offset_), (_size_))
 368 #define UCSI_DECLARE_BITFIELD_V2_0(_offset_, _size_)                    \
 369           UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_0, (_offset_), (_size_))
 370 #define UCSI_DECLARE_BITFIELD_V2_1(_offset_, _size_)                    \
 371           UCSI_DECLARE_BITFIELD(UCSI_VERSION_2_1, (_offset_), (_size_))
 372 #define UCSI_DECLARE_BITFIELD_V3_0(_offset_, _size_)                    \
 373           UCSI_DECLARE_BITFIELD(UCSI_VERSION_3_0, (_offset_), (_size_))
 374
 375 #define UCSI_DECLARE_BITFIELD(_ver_, _offset_, _size_)                  \
 376 (struct ucsi_bitfield) {                                                \
 377         .version = _ver_,                                               \
 378         .offset = _offset_,                                             \
 379         .size = _size_,                                                 \
 380 }
 381
 382 struct ucsi_bitfield {
 383         const u16 version;
 384         const u8 offset;
 385         const u8 size;
 386 };
 387
 388 /**
 389  * ucsi_bitfield_read - Read a field from UCSI command response
 390  * @_map_: UCSI command response
 391  * @_field_: The field offset in the response data structure
 392  * @_ver_: UCSI version where the field was introduced
 393  *
 394  * Reads the fields in the command responses by first checking that the field is
 395  * valid with the UCSI interface version that is used in the system.
 396  * @_ver_ is the minimum UCSI version for the @_field_. If the UCSI interface is
 397  * older than @_ver_, a warning is generated.
 398  *
 399  * Caveats:
 400  * - Removed fields are not checked - @_ver_ is just the minimum UCSI version.
 401  *
 402  * Returns the value of @_field_, or 0 when the UCSI interface is older than
 403  * @_ver_.
 404  */
 405 #define ucsi_bitfield_read(_map_, _field_, _ver_)                       \
 406 ({                                                                      \
 407         struct ucsi_bitfield f = (_field_);                             \
 408         WARN((_ver_) < f.version,                                       \
 409         "Access to unsupported field at offset 0x%x (need version %04x)", \
 410              f.offset, f.version) ? 0 :                                 \
 411         bitmap_read((_map_), f.offset, f.size);                         \
 412 })
 413
 414 /* Helpers to access cached command responses. */
 415 #define UCSI_CONCAP(_con_, _field_)                                     \
 416         ucsi_bitfield_read((_con_)->cap, UCSI_CONCAP_##_field_, (_con_)->ucsi->version)
 417
 418 #define UCSI_CONSTAT(_con_, _field_)                                    \
 419         ucsi_bitfield_read((_con_)->status, UCSI_CONSTAT_##_field_, (_con_)->ucsi->version)
 420
 421 /* -------------------------------------------------------------------------- */
 422
 423 struct ucsi_debugfs_entry {
 424         u64 command;
 425         struct ucsi_data {
 426                 u64 low;
 427                 u64 high;
 428         } response;
 429         u32 status;
 430         struct dentry *dentry;
 431 };
 432
 433 struct ucsi {
 434         u16 version;
 435         struct device *dev;
 436         void *driver_data;
 437
 438         const struct ucsi_operations *ops;
 439
 440         struct ucsi_capability cap;
 441         struct ucsi_connector *connector;
 442         struct ucsi_debugfs_entry *debugfs;
 443
 444         struct work_struct resume_work;
 445         struct delayed_work work;
 446         int work_count;
 447 #define UCSI_ROLE_SWITCH_RETRY_PER_HZ   10
 448 #define UCSI_ROLE_SWITCH_INTERVAL       (HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ)
 449 #define UCSI_ROLE_SWITCH_WAIT_COUNT     (10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ)
 450
 451         /* PPM Communication lock */
 452         struct mutex ppm_lock;
 453
 454         /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */
 455         u64 ntfy;
 456
 457         /* PPM communication flags */
 458         unsigned long flags;
 459 #define EVENT_PENDING   0
 460 #define COMMAND_PENDING 1
 461 #define ACK_PENDING     2
 462         struct completion complete;
 463
 464         unsigned long quirks;
 465 #define UCSI_NO_PARTNER_PDOS    BIT(0)  /* Don't read partner's PDOs */
 466 #define UCSI_DELAY_DEVICE_PDOS  BIT(1)  /* Reading PDOs fails until the parter is in PD mode */
 467 };
 468
 469 #define UCSI_MAX_DATA_LENGTH(u) (((u)->version < UCSI_VERSION_2_0) ? 0x10 : 0xff)
 470
 471 #define UCSI_MAX_SVID           5
 472 #define UCSI_MAX_ALTMODES       (UCSI_MAX_SVID * 6)
 473
 474 #define UCSI_TYPEC_VSAFE5V      5000
 475 #define UCSI_TYPEC_1_5_CURRENT  1500
 476 #define UCSI_TYPEC_3_0_CURRENT  3000
 477
 478 struct ucsi_connector {
 479         int num;
 480
 481         struct ucsi *ucsi;
 482         struct mutex lock; /* port lock */
 483         struct work_struct work;
 484         struct completion complete;
 485         struct workqueue_struct *wq;
 486         struct list_head partner_tasks;
 487
 488         struct typec_port *port;
 489         struct typec_partner *partner;
 490         struct typec_cable *cable;
 491         struct typec_plug *plug;
 492
 493         struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES];
 494         struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES];
 495         struct typec_altmode *plug_altmode[UCSI_MAX_ALTMODES];
 496
 497         struct typec_capability typec_cap;
 498
 499         /* Cached command responses. */
 500         DECLARE_BITMAP(cap, UCSI_GET_CONNECTOR_CAPABILITY_SIZE);
 501         DECLARE_BITMAP(status, UCSI_GET_CONNECTOR_STATUS_SIZE);
 502
 503         struct power_supply *psy;
 504         struct power_supply_desc psy_desc;
 505         u32 rdo;
 506         u32 src_pdos[PDO_MAX_OBJECTS];
 507         int num_pdos;
 508
 509         /* USB PD objects */
 510         struct usb_power_delivery *pd;
 511         struct usb_power_delivery_capabilities *port_source_caps;
 512         struct usb_power_delivery_capabilities *port_sink_caps;
 513         struct usb_power_delivery *partner_pd;
 514         struct usb_power_delivery_capabilities *partner_source_caps;
 515         struct usb_power_delivery_capabilities *partner_sink_caps;
 516
 517         struct usb_role_switch *usb_role_sw;
 518
 519         /* USB PD identity */
 520         struct usb_pd_identity partner_identity;
 521         struct usb_pd_identity cable_identity;
 522 };
 523
 524 int ucsi_send_command(struct ucsi *ucsi, u64 command,
 525                       void *retval, size_t size);
 526
 527 void ucsi_altmode_update_active(struct ucsi_connector *con);
 528 int ucsi_resume(struct ucsi *ucsi);
 529
 530 void ucsi_notify_common(struct ucsi *ucsi, u32 cci);
 531 int ucsi_sync_control_common(struct ucsi *ucsi, u64 command);
 532
 533 #if IS_ENABLED(CONFIG_POWER_SUPPLY)
 534 int ucsi_register_port_psy(struct ucsi_connector *con);
 535 void ucsi_unregister_port_psy(struct ucsi_connector *con);
 536 void ucsi_port_psy_changed(struct ucsi_connector *con);
 537 #else
 538 static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; }
 539 static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { }
 540 static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { }
 541 #endif /* CONFIG_POWER_SUPPLY */
 542
 543 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE)
 544 struct typec_altmode *
 545 ucsi_register_displayport(struct ucsi_connector *con,
 546                           bool override, int offset,
 547                           struct typec_altmode_desc *desc);
 548
 549 void ucsi_displayport_remove_partner(struct typec_altmode *adev);
 550
 551 #else
 552 static inline struct typec_altmode *
 553 ucsi_register_displayport(struct ucsi_connector *con,
 554                           bool override, int offset,
 555                           struct typec_altmode_desc *desc)
 556 {
 557         return typec_port_register_altmode(con->port, desc);
 558 }
 559
 560 static inline void
 561 ucsi_displayport_remove_partner(struct typec_altmode *adev) { }
 562 #endif /* CONFIG_TYPEC_DP_ALTMODE */
 563
 564 #ifdef CONFIG_DEBUG_FS
 565 void ucsi_debugfs_init(void);
 566 void ucsi_debugfs_exit(void);
 567 void ucsi_debugfs_register(struct ucsi *ucsi);
 568 void ucsi_debugfs_unregister(struct ucsi *ucsi);
 569 #else
 570 static inline void ucsi_debugfs_init(void) { }
 571 static inline void ucsi_debugfs_exit(void) { }
 572 static inline void ucsi_debugfs_register(struct ucsi *ucsi) { }
 573 static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { }
 574 #endif /* CONFIG_DEBUG_FS */
 575
 576 /*
 577  * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink
 578  * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3
 579  */
 580 #define USB_TYPEC_NVIDIA_VLINK_DP_VDO   0x1
 581 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO  0x3
 582
 583 #endif /* __DRIVER_USB_TYPEC_UCSI_H */