1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright 2015-2017 Google, Inc
5 * USB Power Delivery protocol stack.
8 #include <linux/completion.h>
9 #include <linux/debugfs.h>
10 #include <linux/device.h>
11 #include <linux/jiffies.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/mutex.h>
15 #include <linux/proc_fs.h>
16 #include <linux/sched/clock.h>
17 #include <linux/seq_file.h>
18 #include <linux/slab.h>
19 #include <linux/spinlock.h>
20 #include <linux/usb/pd.h>
21 #include <linux/usb/pd_bdo.h>
22 #include <linux/usb/pd_vdo.h>
23 #include <linux/usb/tcpm.h>
24 #include <linux/usb/typec.h>
25 #include <linux/workqueue.h>
27 #define FOREACH_STATE(S) \
34 S(SRC_SEND_CAPABILITIES), \
35 S(SRC_NEGOTIATE_CAPABILITIES), \
36 S(SRC_TRANSITION_SUPPLY), \
38 S(SRC_WAIT_NEW_CAPABILITIES), \
46 S(SNK_DISCOVERY_DEBOUNCE), \
47 S(SNK_DISCOVERY_DEBOUNCE_DONE), \
48 S(SNK_WAIT_CAPABILITIES), \
49 S(SNK_NEGOTIATE_CAPABILITIES), \
50 S(SNK_TRANSITION_SINK), \
51 S(SNK_TRANSITION_SINK_VBUS), \
55 S(DEBUG_ACC_ATTACHED), \
56 S(AUDIO_ACC_ATTACHED), \
57 S(AUDIO_ACC_DEBOUNCE), \
60 S(HARD_RESET_START), \
61 S(SRC_HARD_RESET_VBUS_OFF), \
62 S(SRC_HARD_RESET_VBUS_ON), \
63 S(SNK_HARD_RESET_SINK_OFF), \
64 S(SNK_HARD_RESET_WAIT_VBUS), \
65 S(SNK_HARD_RESET_SINK_ON), \
72 S(DR_SWAP_SEND_TIMEOUT), \
74 S(DR_SWAP_CHANGE_DR), \
78 S(PR_SWAP_SEND_TIMEOUT), \
81 S(PR_SWAP_SRC_SNK_TRANSITION_OFF), \
82 S(PR_SWAP_SRC_SNK_SOURCE_OFF), \
83 S(PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED), \
84 S(PR_SWAP_SRC_SNK_SINK_ON), \
85 S(PR_SWAP_SNK_SRC_SINK_OFF), \
86 S(PR_SWAP_SNK_SRC_SOURCE_ON), \
87 S(PR_SWAP_SNK_SRC_SOURCE_ON_VBUS_RAMPED_UP), \
89 S(VCONN_SWAP_ACCEPT), \
91 S(VCONN_SWAP_SEND_TIMEOUT), \
92 S(VCONN_SWAP_CANCEL), \
93 S(VCONN_SWAP_START), \
94 S(VCONN_SWAP_WAIT_FOR_VCONN), \
95 S(VCONN_SWAP_TURN_ON_VCONN), \
96 S(VCONN_SWAP_TURN_OFF_VCONN), \
100 S(SNK_TRY_WAIT_DEBOUNCE), \
101 S(SNK_TRY_WAIT_DEBOUNCE_CHECK_VBUS), \
103 S(SRC_TRYWAIT_DEBOUNCE), \
104 S(SRC_TRYWAIT_UNATTACHED), \
108 S(SRC_TRY_DEBOUNCE), \
110 S(SNK_TRYWAIT_DEBOUNCE), \
111 S(SNK_TRYWAIT_VBUS), \
116 S(PORT_RESET_WAIT_OFF)
118 #define GENERATE_ENUM(e) e
119 #define GENERATE_STRING(s) #s
122 FOREACH_STATE(GENERATE_ENUM)
125 static const char * const tcpm_states[] = {
126 FOREACH_STATE(GENERATE_STRING)
130 VDM_STATE_ERR_BUSY = -3,
131 VDM_STATE_ERR_SEND = -2,
132 VDM_STATE_ERR_TMOUT = -1,
134 /* Anything >0 represents an active state */
137 VDM_STATE_WAIT_RSP_BUSY = 3,
140 enum pd_msg_request {
144 PD_MSG_DATA_SINK_CAP,
145 PD_MSG_DATA_SOURCE_CAP,
148 /* Events from low level driver */
150 #define TCPM_CC_EVENT BIT(0)
151 #define TCPM_VBUS_EVENT BIT(1)
152 #define TCPM_RESET_EVENT BIT(2)
154 #define LOG_BUFFER_ENTRIES 1024
155 #define LOG_BUFFER_ENTRY_SIZE 128
157 /* Alternate mode support */
159 #define SVID_DISCOVERY_MAX 16
161 struct pd_mode_data {
162 int svid_index; /* current SVID index */
164 u16 svids[SVID_DISCOVERY_MAX];
165 int altmodes; /* number of alternate modes */
166 struct typec_altmode_desc altmode_desc[SVID_DISCOVERY_MAX];
172 struct mutex lock; /* tcpm state machine lock */
173 struct workqueue_struct *wq;
175 struct typec_capability typec_caps;
176 struct typec_port *typec_port;
178 struct tcpc_dev *tcpc;
180 enum typec_role vconn_role;
181 enum typec_role pwr_role;
182 enum typec_data_role data_role;
183 enum typec_pwr_opmode pwr_opmode;
185 struct usb_pd_identity partner_ident;
186 struct typec_partner_desc partner_desc;
187 struct typec_partner *partner;
189 enum typec_cc_status cc_req;
191 enum typec_cc_status cc1;
192 enum typec_cc_status cc2;
193 enum typec_cc_polarity polarity;
197 enum typec_port_type port_type;
210 enum pd_msg_request queued_message;
212 enum tcpm_state enter_state;
213 enum tcpm_state prev_state;
214 enum tcpm_state state;
215 enum tcpm_state delayed_state;
216 unsigned long delayed_runtime;
217 unsigned long delay_ms;
219 spinlock_t pd_event_lock;
222 struct work_struct event_work;
223 struct delayed_work state_machine;
224 struct delayed_work vdm_state_machine;
225 bool state_machine_running;
227 struct completion tx_complete;
228 enum tcpm_transmit_status tx_status;
230 struct mutex swap_lock; /* swap command lock */
232 bool non_pd_role_swap;
233 struct completion swap_complete;
236 unsigned int message_id;
237 unsigned int caps_count;
238 unsigned int hard_reset_count;
240 bool explicit_contract;
241 unsigned int rx_msgid;
243 /* Partner capabilities/requests */
245 u32 source_caps[PDO_MAX_OBJECTS];
246 unsigned int nr_source_caps;
247 u32 sink_caps[PDO_MAX_OBJECTS];
248 unsigned int nr_sink_caps;
250 /* Local capabilities */
251 u32 src_pdo[PDO_MAX_OBJECTS];
252 unsigned int nr_src_pdo;
253 u32 snk_pdo[PDO_MAX_OBJECTS];
254 unsigned int nr_snk_pdo;
255 u32 snk_vdo[VDO_MAX_OBJECTS];
256 unsigned int nr_snk_vdo;
258 unsigned int max_snk_mv;
259 unsigned int max_snk_ma;
260 unsigned int max_snk_mw;
261 unsigned int operating_snk_mw;
263 /* Requested current / voltage */
269 /* PD state for Vendor Defined Messages */
270 enum vdm_states vdm_state;
272 /* next Vendor Defined Message to send */
273 u32 vdo_data[VDO_MAX_SIZE];
275 /* VDO to retry if UFP responder replied busy */
278 /* Alternate mode data */
280 struct pd_mode_data mode_data;
281 struct typec_altmode *partner_altmode[SVID_DISCOVERY_MAX];
282 struct typec_altmode *port_altmode[SVID_DISCOVERY_MAX];
284 /* Deadline in jiffies to exit src_try_wait state */
285 unsigned long max_wait;
287 #ifdef CONFIG_DEBUG_FS
288 struct dentry *dentry;
289 struct mutex logbuffer_lock; /* log buffer access lock */
292 u8 *logbuffer[LOG_BUFFER_ENTRIES];
297 struct work_struct work;
298 struct tcpm_port *port;
299 struct pd_message msg;
302 #define tcpm_cc_is_sink(cc) \
303 ((cc) == TYPEC_CC_RP_DEF || (cc) == TYPEC_CC_RP_1_5 || \
304 (cc) == TYPEC_CC_RP_3_0)
306 #define tcpm_port_is_sink(port) \
307 ((tcpm_cc_is_sink((port)->cc1) && !tcpm_cc_is_sink((port)->cc2)) || \
308 (tcpm_cc_is_sink((port)->cc2) && !tcpm_cc_is_sink((port)->cc1)))
310 #define tcpm_cc_is_source(cc) ((cc) == TYPEC_CC_RD)
311 #define tcpm_cc_is_audio(cc) ((cc) == TYPEC_CC_RA)
312 #define tcpm_cc_is_open(cc) ((cc) == TYPEC_CC_OPEN)
314 #define tcpm_port_is_source(port) \
315 ((tcpm_cc_is_source((port)->cc1) && \
316 !tcpm_cc_is_source((port)->cc2)) || \
317 (tcpm_cc_is_source((port)->cc2) && \
318 !tcpm_cc_is_source((port)->cc1)))
320 #define tcpm_port_is_debug(port) \
321 (tcpm_cc_is_source((port)->cc1) && tcpm_cc_is_source((port)->cc2))
323 #define tcpm_port_is_audio(port) \
324 (tcpm_cc_is_audio((port)->cc1) && tcpm_cc_is_audio((port)->cc2))
326 #define tcpm_port_is_audio_detached(port) \
327 ((tcpm_cc_is_audio((port)->cc1) && tcpm_cc_is_open((port)->cc2)) || \
328 (tcpm_cc_is_audio((port)->cc2) && tcpm_cc_is_open((port)->cc1)))
330 #define tcpm_try_snk(port) \
331 ((port)->try_snk_count == 0 && (port)->try_role == TYPEC_SINK && \
332 (port)->port_type == TYPEC_PORT_DRP)
334 #define tcpm_try_src(port) \
335 ((port)->try_src_count == 0 && (port)->try_role == TYPEC_SOURCE && \
336 (port)->port_type == TYPEC_PORT_DRP)
338 static enum tcpm_state tcpm_default_state(struct tcpm_port *port)
340 if (port->port_type == TYPEC_PORT_DRP) {
341 if (port->try_role == TYPEC_SINK)
342 return SNK_UNATTACHED;
343 else if (port->try_role == TYPEC_SOURCE)
344 return SRC_UNATTACHED;
345 else if (port->tcpc->config->default_role == TYPEC_SINK)
346 return SNK_UNATTACHED;
347 /* Fall through to return SRC_UNATTACHED */
348 } else if (port->port_type == TYPEC_PORT_UFP) {
349 return SNK_UNATTACHED;
351 return SRC_UNATTACHED;
355 struct tcpm_port *typec_cap_to_tcpm(const struct typec_capability *cap)
357 return container_of(cap, struct tcpm_port, typec_caps);
360 static bool tcpm_port_is_disconnected(struct tcpm_port *port)
362 return (!port->attached && port->cc1 == TYPEC_CC_OPEN &&
363 port->cc2 == TYPEC_CC_OPEN) ||
364 (port->attached && ((port->polarity == TYPEC_POLARITY_CC1 &&
365 port->cc1 == TYPEC_CC_OPEN) ||
366 (port->polarity == TYPEC_POLARITY_CC2 &&
367 port->cc2 == TYPEC_CC_OPEN)));
374 #ifdef CONFIG_DEBUG_FS
376 static bool tcpm_log_full(struct tcpm_port *port)
378 return port->logbuffer_tail ==
379 (port->logbuffer_head + 1) % LOG_BUFFER_ENTRIES;
383 static void _tcpm_log(struct tcpm_port *port, const char *fmt, va_list args)
385 char tmpbuffer[LOG_BUFFER_ENTRY_SIZE];
386 u64 ts_nsec = local_clock();
387 unsigned long rem_nsec;
389 if (!port->logbuffer[port->logbuffer_head]) {
390 port->logbuffer[port->logbuffer_head] =
391 kzalloc(LOG_BUFFER_ENTRY_SIZE, GFP_KERNEL);
392 if (!port->logbuffer[port->logbuffer_head])
396 vsnprintf(tmpbuffer, sizeof(tmpbuffer), fmt, args);
398 mutex_lock(&port->logbuffer_lock);
400 if (tcpm_log_full(port)) {
401 port->logbuffer_head = max(port->logbuffer_head - 1, 0);
402 strcpy(tmpbuffer, "overflow");
405 if (port->logbuffer_head < 0 ||
406 port->logbuffer_head >= LOG_BUFFER_ENTRIES) {
408 "Bad log buffer index %d\n", port->logbuffer_head);
412 if (!port->logbuffer[port->logbuffer_head]) {
414 "Log buffer index %d is NULL\n", port->logbuffer_head);
418 rem_nsec = do_div(ts_nsec, 1000000000);
419 scnprintf(port->logbuffer[port->logbuffer_head],
420 LOG_BUFFER_ENTRY_SIZE, "[%5lu.%06lu] %s",
421 (unsigned long)ts_nsec, rem_nsec / 1000,
423 port->logbuffer_head = (port->logbuffer_head + 1) % LOG_BUFFER_ENTRIES;
426 mutex_unlock(&port->logbuffer_lock);
430 static void tcpm_log(struct tcpm_port *port, const char *fmt, ...)
434 /* Do not log while disconnected and unattached */
435 if (tcpm_port_is_disconnected(port) &&
436 (port->state == SRC_UNATTACHED || port->state == SNK_UNATTACHED ||
437 port->state == DRP_TOGGLING))
441 _tcpm_log(port, fmt, args);
446 static void tcpm_log_force(struct tcpm_port *port, const char *fmt, ...)
451 _tcpm_log(port, fmt, args);
455 static void tcpm_log_source_caps(struct tcpm_port *port)
459 for (i = 0; i < port->nr_source_caps; i++) {
460 u32 pdo = port->source_caps[i];
461 enum pd_pdo_type type = pdo_type(pdo);
466 scnprintf(msg, sizeof(msg),
467 "%u mV, %u mA [%s%s%s%s%s%s]",
468 pdo_fixed_voltage(pdo),
469 pdo_max_current(pdo),
470 (pdo & PDO_FIXED_DUAL_ROLE) ?
472 (pdo & PDO_FIXED_SUSPEND) ?
474 (pdo & PDO_FIXED_HIGHER_CAP) ?
476 (pdo & PDO_FIXED_USB_COMM) ?
478 (pdo & PDO_FIXED_DATA_SWAP) ?
480 (pdo & PDO_FIXED_EXTPOWER) ?
484 scnprintf(msg, sizeof(msg),
486 pdo_min_voltage(pdo),
487 pdo_max_voltage(pdo),
488 pdo_max_current(pdo));
491 scnprintf(msg, sizeof(msg),
493 pdo_min_voltage(pdo),
494 pdo_max_voltage(pdo),
498 strcpy(msg, "undefined");
501 tcpm_log(port, " PDO %d: type %d, %s",
506 static int tcpm_seq_show(struct seq_file *s, void *v)
508 struct tcpm_port *port = (struct tcpm_port *)s->private;
511 mutex_lock(&port->logbuffer_lock);
512 tail = port->logbuffer_tail;
513 while (tail != port->logbuffer_head) {
514 seq_printf(s, "%s\n", port->logbuffer[tail]);
515 tail = (tail + 1) % LOG_BUFFER_ENTRIES;
517 if (!seq_has_overflowed(s))
518 port->logbuffer_tail = tail;
519 mutex_unlock(&port->logbuffer_lock);
524 static int tcpm_debug_open(struct inode *inode, struct file *file)
526 return single_open(file, tcpm_seq_show, inode->i_private);
529 static const struct file_operations tcpm_debug_operations = {
530 .open = tcpm_debug_open,
533 .release = single_release,
536 static struct dentry *rootdir;
538 static int tcpm_debugfs_init(struct tcpm_port *port)
540 mutex_init(&port->logbuffer_lock);
541 /* /sys/kernel/debug/tcpm/usbcX */
543 rootdir = debugfs_create_dir("tcpm", NULL);
548 port->dentry = debugfs_create_file(dev_name(port->dev),
549 S_IFREG | 0444, rootdir,
550 port, &tcpm_debug_operations);
555 static void tcpm_debugfs_exit(struct tcpm_port *port)
557 debugfs_remove(port->dentry);
563 static void tcpm_log(const struct tcpm_port *port, const char *fmt, ...) { }
565 static void tcpm_log_force(struct tcpm_port *port, const char *fmt, ...) { }
566 static void tcpm_log_source_caps(struct tcpm_port *port) { }
567 static int tcpm_debugfs_init(const struct tcpm_port *port) { return 0; }
568 static void tcpm_debugfs_exit(const struct tcpm_port *port) { }
572 static int tcpm_pd_transmit(struct tcpm_port *port,
573 enum tcpm_transmit_type type,
574 const struct pd_message *msg)
576 unsigned long timeout;
580 tcpm_log(port, "PD TX, header: %#x", le16_to_cpu(msg->header));
582 tcpm_log(port, "PD TX, type: %#x", type);
584 reinit_completion(&port->tx_complete);
585 ret = port->tcpc->pd_transmit(port->tcpc, type, msg);
589 mutex_unlock(&port->lock);
590 timeout = wait_for_completion_timeout(&port->tx_complete,
591 msecs_to_jiffies(PD_T_TCPC_TX_TIMEOUT));
592 mutex_lock(&port->lock);
596 switch (port->tx_status) {
597 case TCPC_TX_SUCCESS:
598 port->message_id = (port->message_id + 1) & PD_HEADER_ID_MASK;
600 case TCPC_TX_DISCARDED:
608 void tcpm_pd_transmit_complete(struct tcpm_port *port,
609 enum tcpm_transmit_status status)
611 tcpm_log(port, "PD TX complete, status: %u", status);
612 port->tx_status = status;
613 complete(&port->tx_complete);
615 EXPORT_SYMBOL_GPL(tcpm_pd_transmit_complete);
617 static int tcpm_mux_set(struct tcpm_port *port, enum tcpc_mux_mode mode,
618 enum tcpc_usb_switch config)
622 tcpm_log(port, "Requesting mux mode %d, config %d, polarity %d",
623 mode, config, port->polarity);
626 ret = port->tcpc->mux->set(port->tcpc->mux, mode, config,
632 static int tcpm_set_polarity(struct tcpm_port *port,
633 enum typec_cc_polarity polarity)
637 tcpm_log(port, "polarity %d", polarity);
639 ret = port->tcpc->set_polarity(port->tcpc, polarity);
643 port->polarity = polarity;
648 static int tcpm_set_vconn(struct tcpm_port *port, bool enable)
652 tcpm_log(port, "vconn:=%d", enable);
654 ret = port->tcpc->set_vconn(port->tcpc, enable);
656 port->vconn_role = enable ? TYPEC_SOURCE : TYPEC_SINK;
657 typec_set_vconn_role(port->typec_port, port->vconn_role);
663 static u32 tcpm_get_current_limit(struct tcpm_port *port)
665 enum typec_cc_status cc;
668 cc = port->polarity ? port->cc2 : port->cc1;
670 case TYPEC_CC_RP_1_5:
673 case TYPEC_CC_RP_3_0:
676 case TYPEC_CC_RP_DEF:
678 if (port->tcpc->get_current_limit)
679 limit = port->tcpc->get_current_limit(port->tcpc);
688 static int tcpm_set_current_limit(struct tcpm_port *port, u32 max_ma, u32 mv)
690 int ret = -EOPNOTSUPP;
692 tcpm_log(port, "Setting voltage/current limit %u mV %u mA", mv, max_ma);
694 if (port->tcpc->set_current_limit)
695 ret = port->tcpc->set_current_limit(port->tcpc, max_ma, mv);
701 * Determine RP value to set based on maximum current supported
702 * by a port if configured as source.
703 * Returns CC value to report to link partner.
705 static enum typec_cc_status tcpm_rp_cc(struct tcpm_port *port)
707 const u32 *src_pdo = port->src_pdo;
708 int nr_pdo = port->nr_src_pdo;
712 * Search for first entry with matching voltage.
713 * It should report the maximum supported current.
715 for (i = 0; i < nr_pdo; i++) {
716 const u32 pdo = src_pdo[i];
718 if (pdo_type(pdo) == PDO_TYPE_FIXED &&
719 pdo_fixed_voltage(pdo) == 5000) {
720 unsigned int curr = pdo_max_current(pdo);
723 return TYPEC_CC_RP_3_0;
724 else if (curr >= 1500)
725 return TYPEC_CC_RP_1_5;
726 return TYPEC_CC_RP_DEF;
730 return TYPEC_CC_RP_DEF;
733 static int tcpm_set_attached_state(struct tcpm_port *port, bool attached)
735 return port->tcpc->set_roles(port->tcpc, attached, port->pwr_role,
739 static int tcpm_set_roles(struct tcpm_port *port, bool attached,
740 enum typec_role role, enum typec_data_role data)
744 if (data == TYPEC_HOST)
745 ret = tcpm_mux_set(port, TYPEC_MUX_USB,
746 TCPC_USB_SWITCH_CONNECT);
748 ret = tcpm_mux_set(port, TYPEC_MUX_NONE,
749 TCPC_USB_SWITCH_DISCONNECT);
753 ret = port->tcpc->set_roles(port->tcpc, attached, role, data);
757 port->pwr_role = role;
758 port->data_role = data;
759 typec_set_data_role(port->typec_port, data);
760 typec_set_pwr_role(port->typec_port, role);
765 static int tcpm_set_pwr_role(struct tcpm_port *port, enum typec_role role)
769 ret = port->tcpc->set_roles(port->tcpc, true, role,
774 port->pwr_role = role;
775 typec_set_pwr_role(port->typec_port, role);
780 static int tcpm_pd_send_source_caps(struct tcpm_port *port)
782 struct pd_message msg;
785 memset(&msg, 0, sizeof(msg));
786 if (!port->nr_src_pdo) {
787 /* No source capabilities defined, sink only */
788 msg.header = PD_HEADER_LE(PD_CTRL_REJECT,
791 port->message_id, 0);
793 msg.header = PD_HEADER_LE(PD_DATA_SOURCE_CAP,
799 for (i = 0; i < port->nr_src_pdo; i++)
800 msg.payload[i] = cpu_to_le32(port->src_pdo[i]);
802 return tcpm_pd_transmit(port, TCPC_TX_SOP, &msg);
805 static int tcpm_pd_send_sink_caps(struct tcpm_port *port)
807 struct pd_message msg;
810 memset(&msg, 0, sizeof(msg));
811 if (!port->nr_snk_pdo) {
812 /* No sink capabilities defined, source only */
813 msg.header = PD_HEADER_LE(PD_CTRL_REJECT,
816 port->message_id, 0);
818 msg.header = PD_HEADER_LE(PD_DATA_SINK_CAP,
824 for (i = 0; i < port->nr_snk_pdo; i++)
825 msg.payload[i] = cpu_to_le32(port->snk_pdo[i]);
827 return tcpm_pd_transmit(port, TCPC_TX_SOP, &msg);
830 static void tcpm_set_state(struct tcpm_port *port, enum tcpm_state state,
831 unsigned int delay_ms)
834 tcpm_log(port, "pending state change %s -> %s @ %u ms",
835 tcpm_states[port->state], tcpm_states[state],
837 port->delayed_state = state;
838 mod_delayed_work(port->wq, &port->state_machine,
839 msecs_to_jiffies(delay_ms));
840 port->delayed_runtime = jiffies + msecs_to_jiffies(delay_ms);
841 port->delay_ms = delay_ms;
843 tcpm_log(port, "state change %s -> %s",
844 tcpm_states[port->state], tcpm_states[state]);
845 port->delayed_state = INVALID_STATE;
846 port->prev_state = port->state;
849 * Don't re-queue the state machine work item if we're currently
850 * in the state machine and we're immediately changing states.
851 * tcpm_state_machine_work() will continue running the state
854 if (!port->state_machine_running)
855 mod_delayed_work(port->wq, &port->state_machine, 0);
859 static void tcpm_set_state_cond(struct tcpm_port *port, enum tcpm_state state,
860 unsigned int delay_ms)
862 if (port->enter_state == port->state)
863 tcpm_set_state(port, state, delay_ms);
866 "skipped %sstate change %s -> %s [%u ms], context state %s",
867 delay_ms ? "delayed " : "",
868 tcpm_states[port->state], tcpm_states[state],
869 delay_ms, tcpm_states[port->enter_state]);
872 static void tcpm_queue_message(struct tcpm_port *port,
873 enum pd_msg_request message)
875 port->queued_message = message;
876 mod_delayed_work(port->wq, &port->state_machine, 0);
880 * VDM/VDO handling functions
882 static void tcpm_queue_vdm(struct tcpm_port *port, const u32 header,
883 const u32 *data, int cnt)
885 port->vdo_count = cnt + 1;
886 port->vdo_data[0] = header;
887 memcpy(&port->vdo_data[1], data, sizeof(u32) * cnt);
888 /* Set ready, vdm state machine will actually send */
889 port->vdm_retries = 0;
890 port->vdm_state = VDM_STATE_READY;
893 static void svdm_consume_identity(struct tcpm_port *port, const __le32 *payload,
896 u32 vdo = le32_to_cpu(payload[VDO_INDEX_IDH]);
897 u32 product = le32_to_cpu(payload[VDO_INDEX_PRODUCT]);
899 memset(&port->mode_data, 0, sizeof(port->mode_data));
901 port->partner_ident.id_header = vdo;
902 port->partner_ident.cert_stat = le32_to_cpu(payload[VDO_INDEX_CSTAT]);
903 port->partner_ident.product = product;
905 typec_partner_set_identity(port->partner);
907 tcpm_log(port, "Identity: %04x:%04x.%04x",
909 PD_PRODUCT_PID(product), product & 0xffff);
912 static bool svdm_consume_svids(struct tcpm_port *port, const __le32 *payload,
915 struct pd_mode_data *pmdata = &port->mode_data;
918 for (i = 1; i < cnt; i++) {
919 u32 p = le32_to_cpu(payload[i]);
922 svid = (p >> 16) & 0xffff;
926 if (pmdata->nsvids >= SVID_DISCOVERY_MAX)
929 pmdata->svids[pmdata->nsvids++] = svid;
930 tcpm_log(port, "SVID %d: 0x%x", pmdata->nsvids, svid);
936 if (pmdata->nsvids >= SVID_DISCOVERY_MAX)
939 pmdata->svids[pmdata->nsvids++] = svid;
940 tcpm_log(port, "SVID %d: 0x%x", pmdata->nsvids, svid);
944 tcpm_log(port, "SVID_DISCOVERY_MAX(%d) too low!", SVID_DISCOVERY_MAX);
948 static void svdm_consume_modes(struct tcpm_port *port, const __le32 *payload,
951 struct pd_mode_data *pmdata = &port->mode_data;
952 struct typec_altmode_desc *paltmode;
953 struct typec_mode_desc *pmode;
956 if (pmdata->altmodes >= ARRAY_SIZE(port->partner_altmode)) {
957 /* Already logged in svdm_consume_svids() */
961 paltmode = &pmdata->altmode_desc[pmdata->altmodes];
962 memset(paltmode, 0, sizeof(*paltmode));
964 paltmode->svid = pmdata->svids[pmdata->svid_index];
966 tcpm_log(port, " Alternate mode %d: SVID 0x%04x",
967 pmdata->altmodes, paltmode->svid);
969 for (i = 1; i < cnt && paltmode->n_modes < ALTMODE_MAX_MODES; i++) {
970 pmode = &paltmode->modes[paltmode->n_modes];
971 memset(pmode, 0, sizeof(*pmode));
972 pmode->vdo = le32_to_cpu(payload[i]);
973 pmode->index = i - 1;
975 tcpm_log(port, " VDO %d: 0x%08x",
976 pmode->index, pmode->vdo);
978 port->partner_altmode[pmdata->altmodes] =
979 typec_partner_register_altmode(port->partner, paltmode);
980 if (!port->partner_altmode[pmdata->altmodes]) {
982 "Failed to register alternate modes for SVID 0x%04x",
989 #define supports_modal(port) PD_IDH_MODAL_SUPP((port)->partner_ident.id_header)
991 static int tcpm_pd_svdm(struct tcpm_port *port, const __le32 *payload, int cnt,
994 u32 p0 = le32_to_cpu(payload[0]);
995 int cmd_type = PD_VDO_CMDT(p0);
996 int cmd = PD_VDO_CMD(p0);
997 struct pd_mode_data *modep;
1002 tcpm_log(port, "Rx VDM cmd 0x%x type %d cmd %d len %d",
1003 p0, cmd_type, cmd, cnt);
1005 modep = &port->mode_data;
1010 case CMD_DISCOVER_IDENT:
1011 /* 6.4.4.3.1: Only respond as UFP (device) */
1012 if (port->data_role == TYPEC_DEVICE &&
1014 for (i = 0; i < port->nr_snk_vdo; i++)
1015 response[i + 1] = port->snk_vdo[i];
1016 rlen = port->nr_snk_vdo + 1;
1019 case CMD_DISCOVER_SVID:
1021 case CMD_DISCOVER_MODES:
1023 case CMD_ENTER_MODE:
1033 response[0] = p0 | VDO_CMDT(CMDT_RSP_ACK);
1034 } else if (rlen == 0) {
1035 response[0] = p0 | VDO_CMDT(CMDT_RSP_NAK);
1038 response[0] = p0 | VDO_CMDT(CMDT_RSP_BUSY);
1043 /* silently drop message if we are not connected */
1048 case CMD_DISCOVER_IDENT:
1050 svdm_consume_identity(port, payload, cnt);
1051 response[0] = VDO(USB_SID_PD, 1, CMD_DISCOVER_SVID);
1054 case CMD_DISCOVER_SVID:
1056 if (svdm_consume_svids(port, payload, cnt)) {
1057 response[0] = VDO(USB_SID_PD, 1,
1060 } else if (modep->nsvids && supports_modal(port)) {
1061 response[0] = VDO(modep->svids[0], 1,
1062 CMD_DISCOVER_MODES);
1066 case CMD_DISCOVER_MODES:
1068 svdm_consume_modes(port, payload, cnt);
1069 modep->svid_index++;
1070 if (modep->svid_index < modep->nsvids) {
1071 svid = modep->svids[modep->svid_index];
1072 response[0] = VDO(svid, 1, CMD_DISCOVER_MODES);
1075 /* enter alternate mode if/when implemented */
1078 case CMD_ENTER_MODE:
1091 static void tcpm_handle_vdm_request(struct tcpm_port *port,
1092 const __le32 *payload, int cnt)
1095 u32 response[8] = { };
1096 u32 p0 = le32_to_cpu(payload[0]);
1098 if (port->vdm_state == VDM_STATE_BUSY) {
1099 /* If UFP responded busy retry after timeout */
1100 if (PD_VDO_CMDT(p0) == CMDT_RSP_BUSY) {
1101 port->vdm_state = VDM_STATE_WAIT_RSP_BUSY;
1102 port->vdo_retry = (p0 & ~VDO_CMDT_MASK) |
1104 mod_delayed_work(port->wq, &port->vdm_state_machine,
1105 msecs_to_jiffies(PD_T_VDM_BUSY));
1108 port->vdm_state = VDM_STATE_DONE;
1111 if (PD_VDO_SVDM(p0))
1112 rlen = tcpm_pd_svdm(port, payload, cnt, response);
1115 tcpm_queue_vdm(port, response[0], &response[1], rlen - 1);
1116 mod_delayed_work(port->wq, &port->vdm_state_machine, 0);
1120 static void tcpm_send_vdm(struct tcpm_port *port, u32 vid, int cmd,
1121 const u32 *data, int count)
1125 if (WARN_ON(count > VDO_MAX_SIZE - 1))
1126 count = VDO_MAX_SIZE - 1;
1128 /* set VDM header with VID & CMD */
1129 header = VDO(vid, ((vid & USB_SID_PD) == USB_SID_PD) ?
1130 1 : (PD_VDO_CMD(cmd) <= CMD_ATTENTION), cmd);
1131 tcpm_queue_vdm(port, header, data, count);
1133 mod_delayed_work(port->wq, &port->vdm_state_machine, 0);
1136 static unsigned int vdm_ready_timeout(u32 vdm_hdr)
1138 unsigned int timeout;
1139 int cmd = PD_VDO_CMD(vdm_hdr);
1141 /* its not a structured VDM command */
1142 if (!PD_VDO_SVDM(vdm_hdr))
1143 return PD_T_VDM_UNSTRUCTURED;
1145 switch (PD_VDO_CMDT(vdm_hdr)) {
1147 if (cmd == CMD_ENTER_MODE || cmd == CMD_EXIT_MODE)
1148 timeout = PD_T_VDM_WAIT_MODE_E;
1150 timeout = PD_T_VDM_SNDR_RSP;
1153 if (cmd == CMD_ENTER_MODE || cmd == CMD_EXIT_MODE)
1154 timeout = PD_T_VDM_E_MODE;
1156 timeout = PD_T_VDM_RCVR_RSP;
1162 static void vdm_run_state_machine(struct tcpm_port *port)
1164 struct pd_message msg;
1167 switch (port->vdm_state) {
1168 case VDM_STATE_READY:
1169 /* Only transmit VDM if attached */
1170 if (!port->attached) {
1171 port->vdm_state = VDM_STATE_ERR_BUSY;
1176 * if there's traffic or we're not in PDO ready state don't send
1179 if (port->state != SRC_READY && port->state != SNK_READY)
1182 /* Prepare and send VDM */
1183 memset(&msg, 0, sizeof(msg));
1184 msg.header = PD_HEADER_LE(PD_DATA_VENDOR_DEF,
1187 port->message_id, port->vdo_count);
1188 for (i = 0; i < port->vdo_count; i++)
1189 msg.payload[i] = cpu_to_le32(port->vdo_data[i]);
1190 res = tcpm_pd_transmit(port, TCPC_TX_SOP, &msg);
1192 port->vdm_state = VDM_STATE_ERR_SEND;
1194 unsigned long timeout;
1196 port->vdm_retries = 0;
1197 port->vdm_state = VDM_STATE_BUSY;
1198 timeout = vdm_ready_timeout(port->vdo_data[0]);
1199 mod_delayed_work(port->wq, &port->vdm_state_machine,
1203 case VDM_STATE_WAIT_RSP_BUSY:
1204 port->vdo_data[0] = port->vdo_retry;
1205 port->vdo_count = 1;
1206 port->vdm_state = VDM_STATE_READY;
1208 case VDM_STATE_BUSY:
1209 port->vdm_state = VDM_STATE_ERR_TMOUT;
1211 case VDM_STATE_ERR_SEND:
1213 * A partner which does not support USB PD will not reply,
1214 * so this is not a fatal error. At the same time, some
1215 * devices may not return GoodCRC under some circumstances,
1216 * so we need to retry.
1218 if (port->vdm_retries < 3) {
1219 tcpm_log(port, "VDM Tx error, retry");
1220 port->vdm_retries++;
1221 port->vdm_state = VDM_STATE_READY;
1229 static void vdm_state_machine_work(struct work_struct *work)
1231 struct tcpm_port *port = container_of(work, struct tcpm_port,
1232 vdm_state_machine.work);
1233 enum vdm_states prev_state;
1235 mutex_lock(&port->lock);
1238 * Continue running as long as the port is not busy and there was
1242 prev_state = port->vdm_state;
1243 vdm_run_state_machine(port);
1244 } while (port->vdm_state != prev_state &&
1245 port->vdm_state != VDM_STATE_BUSY);
1247 mutex_unlock(&port->lock);
1251 * PD (data, control) command handling functions
1253 static void tcpm_pd_data_request(struct tcpm_port *port,
1254 const struct pd_message *msg)
1256 enum pd_data_msg_type type = pd_header_type_le(msg->header);
1257 unsigned int cnt = pd_header_cnt_le(msg->header);
1261 case PD_DATA_SOURCE_CAP:
1262 if (port->pwr_role != TYPEC_SINK)
1265 for (i = 0; i < cnt; i++)
1266 port->source_caps[i] = le32_to_cpu(msg->payload[i]);
1268 port->nr_source_caps = cnt;
1270 tcpm_log_source_caps(port);
1273 * This message may be received even if VBUS is not
1274 * present. This is quite unexpected; see USB PD
1275 * specification, sections 8.3.3.6.3.1 and 8.3.3.6.3.2.
1276 * However, at the same time, we must be ready to
1277 * receive this message and respond to it 15ms after
1278 * receiving PS_RDY during power swap operations, no matter
1279 * if VBUS is available or not (USB PD specification,
1281 * So we need to accept the message either way,
1282 * but be prepared to keep waiting for VBUS after it was
1285 tcpm_set_state(port, SNK_NEGOTIATE_CAPABILITIES, 0);
1287 case PD_DATA_REQUEST:
1288 if (port->pwr_role != TYPEC_SOURCE ||
1290 tcpm_queue_message(port, PD_MSG_CTRL_REJECT);
1293 port->sink_request = le32_to_cpu(msg->payload[0]);
1294 tcpm_set_state(port, SRC_NEGOTIATE_CAPABILITIES, 0);
1296 case PD_DATA_SINK_CAP:
1297 /* We don't do anything with this at the moment... */
1298 for (i = 0; i < cnt; i++)
1299 port->sink_caps[i] = le32_to_cpu(msg->payload[i]);
1300 port->nr_sink_caps = cnt;
1302 case PD_DATA_VENDOR_DEF:
1303 tcpm_handle_vdm_request(port, msg->payload, cnt);
1306 if (port->state == SRC_READY || port->state == SNK_READY) {
1307 port->bist_request = le32_to_cpu(msg->payload[0]);
1308 tcpm_set_state(port, BIST_RX, 0);
1312 tcpm_log(port, "Unhandled data message type %#x", type);
1317 static void tcpm_pd_ctrl_request(struct tcpm_port *port,
1318 const struct pd_message *msg)
1320 enum pd_ctrl_msg_type type = pd_header_type_le(msg->header);
1321 enum tcpm_state next_state;
1324 case PD_CTRL_GOOD_CRC:
1327 case PD_CTRL_GET_SOURCE_CAP:
1328 switch (port->state) {
1331 tcpm_queue_message(port, PD_MSG_DATA_SOURCE_CAP);
1334 tcpm_queue_message(port, PD_MSG_CTRL_REJECT);
1338 case PD_CTRL_GET_SINK_CAP:
1339 switch (port->state) {
1342 tcpm_queue_message(port, PD_MSG_DATA_SINK_CAP);
1345 tcpm_queue_message(port, PD_MSG_CTRL_REJECT);
1349 case PD_CTRL_GOTO_MIN:
1351 case PD_CTRL_PS_RDY:
1352 switch (port->state) {
1353 case SNK_TRANSITION_SINK:
1354 if (port->vbus_present) {
1355 tcpm_set_current_limit(port,
1356 port->current_limit,
1357 port->supply_voltage);
1358 port->explicit_contract = true;
1359 tcpm_set_state(port, SNK_READY, 0);
1362 * Seen after power swap. Keep waiting for VBUS
1363 * in a transitional state.
1365 tcpm_set_state(port,
1366 SNK_TRANSITION_SINK_VBUS, 0);
1369 case PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED:
1370 tcpm_set_state(port, PR_SWAP_SRC_SNK_SINK_ON, 0);
1372 case PR_SWAP_SNK_SRC_SINK_OFF:
1373 tcpm_set_state(port, PR_SWAP_SNK_SRC_SOURCE_ON, 0);
1375 case VCONN_SWAP_WAIT_FOR_VCONN:
1376 tcpm_set_state(port, VCONN_SWAP_TURN_OFF_VCONN, 0);
1382 case PD_CTRL_REJECT:
1384 switch (port->state) {
1385 case SNK_NEGOTIATE_CAPABILITIES:
1386 /* USB PD specification, Figure 8-43 */
1387 if (port->explicit_contract)
1388 next_state = SNK_READY;
1390 next_state = SNK_WAIT_CAPABILITIES;
1391 tcpm_set_state(port, next_state, 0);
1394 port->swap_status = (type == PD_CTRL_WAIT ?
1395 -EAGAIN : -EOPNOTSUPP);
1396 tcpm_set_state(port, DR_SWAP_CANCEL, 0);
1399 port->swap_status = (type == PD_CTRL_WAIT ?
1400 -EAGAIN : -EOPNOTSUPP);
1401 tcpm_set_state(port, PR_SWAP_CANCEL, 0);
1403 case VCONN_SWAP_SEND:
1404 port->swap_status = (type == PD_CTRL_WAIT ?
1405 -EAGAIN : -EOPNOTSUPP);
1406 tcpm_set_state(port, VCONN_SWAP_CANCEL, 0);
1412 case PD_CTRL_ACCEPT:
1413 switch (port->state) {
1414 case SNK_NEGOTIATE_CAPABILITIES:
1415 tcpm_set_state(port, SNK_TRANSITION_SINK, 0);
1417 case SOFT_RESET_SEND:
1418 port->message_id = 0;
1419 port->rx_msgid = -1;
1420 if (port->pwr_role == TYPEC_SOURCE)
1421 next_state = SRC_SEND_CAPABILITIES;
1423 next_state = SNK_WAIT_CAPABILITIES;
1424 tcpm_set_state(port, next_state, 0);
1427 tcpm_set_state(port, DR_SWAP_CHANGE_DR, 0);
1430 tcpm_set_state(port, PR_SWAP_START, 0);
1432 case VCONN_SWAP_SEND:
1433 tcpm_set_state(port, VCONN_SWAP_START, 0);
1439 case PD_CTRL_SOFT_RESET:
1440 tcpm_set_state(port, SOFT_RESET, 0);
1442 case PD_CTRL_DR_SWAP:
1443 if (port->port_type != TYPEC_PORT_DRP) {
1444 tcpm_queue_message(port, PD_MSG_CTRL_REJECT);
1449 * 6.3.9: If an alternate mode is active, a request to swap
1450 * alternate modes shall trigger a port reset.
1452 switch (port->state) {
1455 tcpm_set_state(port, DR_SWAP_ACCEPT, 0);
1458 tcpm_queue_message(port, PD_MSG_CTRL_WAIT);
1462 case PD_CTRL_PR_SWAP:
1463 if (port->port_type != TYPEC_PORT_DRP) {
1464 tcpm_queue_message(port, PD_MSG_CTRL_REJECT);
1467 switch (port->state) {
1470 tcpm_set_state(port, PR_SWAP_ACCEPT, 0);
1473 tcpm_queue_message(port, PD_MSG_CTRL_WAIT);
1477 case PD_CTRL_VCONN_SWAP:
1478 switch (port->state) {
1481 tcpm_set_state(port, VCONN_SWAP_ACCEPT, 0);
1484 tcpm_queue_message(port, PD_MSG_CTRL_WAIT);
1489 tcpm_log(port, "Unhandled ctrl message type %#x", type);
1494 static void tcpm_pd_rx_handler(struct work_struct *work)
1496 struct pd_rx_event *event = container_of(work,
1497 struct pd_rx_event, work);
1498 const struct pd_message *msg = &event->msg;
1499 unsigned int cnt = pd_header_cnt_le(msg->header);
1500 struct tcpm_port *port = event->port;
1502 mutex_lock(&port->lock);
1504 tcpm_log(port, "PD RX, header: %#x [%d]", le16_to_cpu(msg->header),
1507 if (port->attached) {
1508 enum pd_ctrl_msg_type type = pd_header_type_le(msg->header);
1509 unsigned int msgid = pd_header_msgid_le(msg->header);
1512 * USB PD standard, 6.6.1.2:
1513 * "... if MessageID value in a received Message is the
1514 * same as the stored value, the receiver shall return a
1515 * GoodCRC Message with that MessageID value and drop
1516 * the Message (this is a retry of an already received
1517 * Message). Note: this shall not apply to the Soft_Reset
1518 * Message which always has a MessageID value of zero."
1520 if (msgid == port->rx_msgid && type != PD_CTRL_SOFT_RESET)
1522 port->rx_msgid = msgid;
1525 * If both ends believe to be DFP/host, we have a data role
1528 if (!!(le16_to_cpu(msg->header) & PD_HEADER_DATA_ROLE) ==
1529 (port->data_role == TYPEC_HOST)) {
1531 "Data role mismatch, initiating error recovery");
1532 tcpm_set_state(port, ERROR_RECOVERY, 0);
1535 tcpm_pd_data_request(port, msg);
1537 tcpm_pd_ctrl_request(port, msg);
1542 mutex_unlock(&port->lock);
1546 void tcpm_pd_receive(struct tcpm_port *port, const struct pd_message *msg)
1548 struct pd_rx_event *event;
1550 event = kzalloc(sizeof(*event), GFP_ATOMIC);
1554 INIT_WORK(&event->work, tcpm_pd_rx_handler);
1556 memcpy(&event->msg, msg, sizeof(*msg));
1557 queue_work(port->wq, &event->work);
1559 EXPORT_SYMBOL_GPL(tcpm_pd_receive);
1561 static int tcpm_pd_send_control(struct tcpm_port *port,
1562 enum pd_ctrl_msg_type type)
1564 struct pd_message msg;
1566 memset(&msg, 0, sizeof(msg));
1567 msg.header = PD_HEADER_LE(type, port->pwr_role,
1569 port->message_id, 0);
1571 return tcpm_pd_transmit(port, TCPC_TX_SOP, &msg);
1575 * Send queued message without affecting state.
1576 * Return true if state machine should go back to sleep,
1579 static bool tcpm_send_queued_message(struct tcpm_port *port)
1581 enum pd_msg_request queued_message;
1584 queued_message = port->queued_message;
1585 port->queued_message = PD_MSG_NONE;
1587 switch (queued_message) {
1588 case PD_MSG_CTRL_WAIT:
1589 tcpm_pd_send_control(port, PD_CTRL_WAIT);
1591 case PD_MSG_CTRL_REJECT:
1592 tcpm_pd_send_control(port, PD_CTRL_REJECT);
1594 case PD_MSG_DATA_SINK_CAP:
1595 tcpm_pd_send_sink_caps(port);
1597 case PD_MSG_DATA_SOURCE_CAP:
1598 tcpm_pd_send_source_caps(port);
1603 } while (port->queued_message != PD_MSG_NONE);
1605 if (port->delayed_state != INVALID_STATE) {
1606 if (time_is_after_jiffies(port->delayed_runtime)) {
1607 mod_delayed_work(port->wq, &port->state_machine,
1608 port->delayed_runtime - jiffies);
1611 port->delayed_state = INVALID_STATE;
1616 static int tcpm_pd_check_request(struct tcpm_port *port)
1618 u32 pdo, rdo = port->sink_request;
1619 unsigned int max, op, pdo_max, index;
1620 enum pd_pdo_type type;
1622 index = rdo_index(rdo);
1623 if (!index || index > port->nr_src_pdo)
1626 pdo = port->src_pdo[index - 1];
1627 type = pdo_type(pdo);
1629 case PDO_TYPE_FIXED:
1631 max = rdo_max_current(rdo);
1632 op = rdo_op_current(rdo);
1633 pdo_max = pdo_max_current(pdo);
1637 if (max > pdo_max && !(rdo & RDO_CAP_MISMATCH))
1640 if (type == PDO_TYPE_FIXED)
1642 "Requested %u mV, %u mA for %u / %u mA",
1643 pdo_fixed_voltage(pdo), pdo_max, op, max);
1646 "Requested %u -> %u mV, %u mA for %u / %u mA",
1647 pdo_min_voltage(pdo), pdo_max_voltage(pdo),
1651 max = rdo_max_power(rdo);
1652 op = rdo_op_power(rdo);
1653 pdo_max = pdo_max_power(pdo);
1657 if (max > pdo_max && !(rdo & RDO_CAP_MISMATCH))
1660 "Requested %u -> %u mV, %u mW for %u / %u mW",
1661 pdo_min_voltage(pdo), pdo_max_voltage(pdo),
1668 port->op_vsafe5v = index == 1;
1673 static int tcpm_pd_select_pdo(struct tcpm_port *port)
1675 unsigned int i, max_mw = 0, max_mv = 0;
1679 * Select the source PDO providing the most power while staying within
1680 * the board's voltage limits. Prefer PDO providing exp
1682 for (i = 0; i < port->nr_source_caps; i++) {
1683 u32 pdo = port->source_caps[i];
1684 enum pd_pdo_type type = pdo_type(pdo);
1685 unsigned int mv, ma, mw;
1687 if (type == PDO_TYPE_FIXED)
1688 mv = pdo_fixed_voltage(pdo);
1690 mv = pdo_min_voltage(pdo);
1692 if (type == PDO_TYPE_BATT) {
1693 mw = pdo_max_power(pdo);
1695 ma = min(pdo_max_current(pdo),
1697 mw = ma * mv / 1000;
1700 /* Perfer higher voltages if available */
1701 if ((mw > max_mw || (mw == max_mw && mv > max_mv)) &&
1702 mv <= port->max_snk_mv) {
1712 static int tcpm_pd_build_request(struct tcpm_port *port, u32 *rdo)
1714 unsigned int mv, ma, mw, flags;
1715 unsigned int max_ma, max_mw;
1716 enum pd_pdo_type type;
1720 index = tcpm_pd_select_pdo(port);
1723 pdo = port->source_caps[index];
1724 type = pdo_type(pdo);
1726 if (type == PDO_TYPE_FIXED)
1727 mv = pdo_fixed_voltage(pdo);
1729 mv = pdo_min_voltage(pdo);
1731 /* Select maximum available current within the board's power limit */
1732 if (type == PDO_TYPE_BATT) {
1733 mw = pdo_max_power(pdo);
1734 ma = 1000 * min(mw, port->max_snk_mw) / mv;
1736 ma = min(pdo_max_current(pdo),
1737 1000 * port->max_snk_mw / mv);
1739 ma = min(ma, port->max_snk_ma);
1741 flags = RDO_USB_COMM | RDO_NO_SUSPEND;
1743 /* Set mismatch bit if offered power is less than operating power */
1744 mw = ma * mv / 1000;
1747 if (mw < port->operating_snk_mw) {
1748 flags |= RDO_CAP_MISMATCH;
1749 max_mw = port->operating_snk_mw;
1750 max_ma = max_mw * 1000 / mv;
1753 tcpm_log(port, "cc=%d cc1=%d cc2=%d vbus=%d vconn=%s polarity=%d",
1754 port->cc_req, port->cc1, port->cc2, port->vbus_source,
1755 port->vconn_role == TYPEC_SOURCE ? "source" : "sink",
1758 if (type == PDO_TYPE_BATT) {
1759 *rdo = RDO_BATT(index + 1, mw, max_mw, flags);
1761 tcpm_log(port, "Requesting PDO %d: %u mV, %u mW%s",
1763 flags & RDO_CAP_MISMATCH ? " [mismatch]" : "");
1765 *rdo = RDO_FIXED(index + 1, ma, max_ma, flags);
1767 tcpm_log(port, "Requesting PDO %d: %u mV, %u mA%s",
1769 flags & RDO_CAP_MISMATCH ? " [mismatch]" : "");
1772 port->current_limit = ma;
1773 port->supply_voltage = mv;
1778 static int tcpm_pd_send_request(struct tcpm_port *port)
1780 struct pd_message msg;
1784 ret = tcpm_pd_build_request(port, &rdo);
1788 memset(&msg, 0, sizeof(msg));
1789 msg.header = PD_HEADER_LE(PD_DATA_REQUEST,
1792 port->message_id, 1);
1793 msg.payload[0] = cpu_to_le32(rdo);
1795 return tcpm_pd_transmit(port, TCPC_TX_SOP, &msg);
1798 static int tcpm_set_vbus(struct tcpm_port *port, bool enable)
1802 if (enable && port->vbus_charge)
1805 tcpm_log(port, "vbus:=%d charge=%d", enable, port->vbus_charge);
1807 ret = port->tcpc->set_vbus(port->tcpc, enable, port->vbus_charge);
1811 port->vbus_source = enable;
1815 static int tcpm_set_charge(struct tcpm_port *port, bool charge)
1819 if (charge && port->vbus_source)
1822 if (charge != port->vbus_charge) {
1823 tcpm_log(port, "vbus=%d charge:=%d", port->vbus_source, charge);
1824 ret = port->tcpc->set_vbus(port->tcpc, port->vbus_source,
1829 port->vbus_charge = charge;
1833 static bool tcpm_start_drp_toggling(struct tcpm_port *port)
1837 if (port->tcpc->start_drp_toggling &&
1838 port->port_type == TYPEC_PORT_DRP) {
1839 tcpm_log_force(port, "Start DRP toggling");
1840 ret = port->tcpc->start_drp_toggling(port->tcpc,
1849 static void tcpm_set_cc(struct tcpm_port *port, enum typec_cc_status cc)
1851 tcpm_log(port, "cc:=%d", cc);
1853 port->tcpc->set_cc(port->tcpc, cc);
1856 static int tcpm_init_vbus(struct tcpm_port *port)
1860 ret = port->tcpc->set_vbus(port->tcpc, false, false);
1861 port->vbus_source = false;
1862 port->vbus_charge = false;
1866 static int tcpm_init_vconn(struct tcpm_port *port)
1870 ret = port->tcpc->set_vconn(port->tcpc, false);
1871 port->vconn_role = TYPEC_SINK;
1875 static void tcpm_typec_connect(struct tcpm_port *port)
1877 if (!port->connected) {
1878 /* Make sure we don't report stale identity information */
1879 memset(&port->partner_ident, 0, sizeof(port->partner_ident));
1880 port->partner_desc.usb_pd = port->pd_capable;
1881 if (tcpm_port_is_debug(port))
1882 port->partner_desc.accessory = TYPEC_ACCESSORY_DEBUG;
1883 else if (tcpm_port_is_audio(port))
1884 port->partner_desc.accessory = TYPEC_ACCESSORY_AUDIO;
1886 port->partner_desc.accessory = TYPEC_ACCESSORY_NONE;
1887 port->partner = typec_register_partner(port->typec_port,
1888 &port->partner_desc);
1889 port->connected = true;
1893 static int tcpm_src_attach(struct tcpm_port *port)
1895 enum typec_cc_polarity polarity =
1896 port->cc2 == TYPEC_CC_RD ? TYPEC_POLARITY_CC2
1897 : TYPEC_POLARITY_CC1;
1903 ret = tcpm_set_polarity(port, polarity);
1907 ret = tcpm_set_roles(port, true, TYPEC_SOURCE, TYPEC_HOST);
1911 ret = port->tcpc->set_pd_rx(port->tcpc, true);
1913 goto out_disable_mux;
1916 * USB Type-C specification, version 1.2,
1917 * chapter 4.5.2.2.8.1 (Attached.SRC Requirements)
1918 * Enable VCONN only if the non-RD port is set to RA.
1920 if ((polarity == TYPEC_POLARITY_CC1 && port->cc2 == TYPEC_CC_RA) ||
1921 (polarity == TYPEC_POLARITY_CC2 && port->cc1 == TYPEC_CC_RA)) {
1922 ret = tcpm_set_vconn(port, true);
1924 goto out_disable_pd;
1927 ret = tcpm_set_vbus(port, true);
1929 goto out_disable_vconn;
1931 port->pd_capable = false;
1933 port->partner = NULL;
1935 port->attached = true;
1936 port->send_discover = true;
1941 tcpm_set_vconn(port, false);
1943 port->tcpc->set_pd_rx(port->tcpc, false);
1945 tcpm_mux_set(port, TYPEC_MUX_NONE, TCPC_USB_SWITCH_DISCONNECT);
1949 static void tcpm_typec_disconnect(struct tcpm_port *port)
1951 if (port->connected) {
1952 typec_unregister_partner(port->partner);
1953 port->partner = NULL;
1954 port->connected = false;
1958 static void tcpm_unregister_altmodes(struct tcpm_port *port)
1960 struct pd_mode_data *modep = &port->mode_data;
1963 for (i = 0; i < modep->altmodes; i++) {
1964 typec_unregister_altmode(port->partner_altmode[i]);
1965 port->partner_altmode[i] = NULL;
1968 memset(modep, 0, sizeof(*modep));
1971 static void tcpm_reset_port(struct tcpm_port *port)
1973 tcpm_unregister_altmodes(port);
1974 tcpm_typec_disconnect(port);
1975 port->attached = false;
1976 port->pd_capable = false;
1979 * First Rx ID should be 0; set this to a sentinel of -1 so that
1980 * we can check tcpm_pd_rx_handler() if we had seen it before.
1982 port->rx_msgid = -1;
1984 port->tcpc->set_pd_rx(port->tcpc, false);
1985 tcpm_init_vbus(port); /* also disables charging */
1986 tcpm_init_vconn(port);
1987 tcpm_set_current_limit(port, 0, 0);
1988 tcpm_set_polarity(port, TYPEC_POLARITY_CC1);
1989 tcpm_set_attached_state(port, false);
1990 port->try_src_count = 0;
1991 port->try_snk_count = 0;
1994 static void tcpm_detach(struct tcpm_port *port)
1996 if (!port->attached)
1999 if (tcpm_port_is_disconnected(port))
2000 port->hard_reset_count = 0;
2002 tcpm_reset_port(port);
2005 static void tcpm_src_detach(struct tcpm_port *port)
2010 static int tcpm_snk_attach(struct tcpm_port *port)
2017 ret = tcpm_set_polarity(port, port->cc2 != TYPEC_CC_OPEN ?
2018 TYPEC_POLARITY_CC2 : TYPEC_POLARITY_CC1);
2022 ret = tcpm_set_roles(port, true, TYPEC_SINK, TYPEC_DEVICE);
2026 port->pd_capable = false;
2028 port->partner = NULL;
2030 port->attached = true;
2031 port->send_discover = true;
2036 static void tcpm_snk_detach(struct tcpm_port *port)
2040 /* XXX: (Dis)connect SuperSpeed mux? */
2043 static int tcpm_acc_attach(struct tcpm_port *port)
2050 ret = tcpm_set_roles(port, true, TYPEC_SOURCE, TYPEC_HOST);
2054 port->partner = NULL;
2056 tcpm_typec_connect(port);
2058 port->attached = true;
2063 static void tcpm_acc_detach(struct tcpm_port *port)
2068 static inline enum tcpm_state hard_reset_state(struct tcpm_port *port)
2070 if (port->hard_reset_count < PD_N_HARD_RESET_COUNT)
2071 return HARD_RESET_SEND;
2072 if (port->pd_capable)
2073 return ERROR_RECOVERY;
2074 if (port->pwr_role == TYPEC_SOURCE)
2075 return SRC_UNATTACHED;
2076 if (port->state == SNK_WAIT_CAPABILITIES)
2078 return SNK_UNATTACHED;
2081 static inline enum tcpm_state ready_state(struct tcpm_port *port)
2083 if (port->pwr_role == TYPEC_SOURCE)
2089 static inline enum tcpm_state unattached_state(struct tcpm_port *port)
2091 if (port->port_type == TYPEC_PORT_DRP) {
2092 if (port->pwr_role == TYPEC_SOURCE)
2093 return SRC_UNATTACHED;
2095 return SNK_UNATTACHED;
2096 } else if (port->port_type == TYPEC_PORT_DFP) {
2097 return SRC_UNATTACHED;
2100 return SNK_UNATTACHED;
2103 static void tcpm_check_send_discover(struct tcpm_port *port)
2105 if (port->data_role == TYPEC_HOST && port->send_discover &&
2107 tcpm_send_vdm(port, USB_SID_PD, CMD_DISCOVER_IDENT, NULL, 0);
2108 port->send_discover = false;
2112 static void tcpm_swap_complete(struct tcpm_port *port, int result)
2114 if (port->swap_pending) {
2115 port->swap_status = result;
2116 port->swap_pending = false;
2117 port->non_pd_role_swap = false;
2118 complete(&port->swap_complete);
2122 static enum typec_pwr_opmode tcpm_get_pwr_opmode(enum typec_cc_status cc)
2125 case TYPEC_CC_RP_1_5:
2126 return TYPEC_PWR_MODE_1_5A;
2127 case TYPEC_CC_RP_3_0:
2128 return TYPEC_PWR_MODE_3_0A;
2129 case TYPEC_CC_RP_DEF:
2131 return TYPEC_PWR_MODE_USB;
2135 static void run_state_machine(struct tcpm_port *port)
2138 enum typec_pwr_opmode opmode;
2141 port->enter_state = port->state;
2142 switch (port->state) {
2146 case SRC_UNATTACHED:
2147 if (!port->non_pd_role_swap)
2148 tcpm_swap_complete(port, -ENOTCONN);
2149 tcpm_src_detach(port);
2150 if (tcpm_start_drp_toggling(port)) {
2151 tcpm_set_state(port, DRP_TOGGLING, 0);
2154 tcpm_set_cc(port, tcpm_rp_cc(port));
2155 if (port->port_type == TYPEC_PORT_DRP)
2156 tcpm_set_state(port, SNK_UNATTACHED, PD_T_DRP_SNK);
2158 case SRC_ATTACH_WAIT:
2159 if (tcpm_port_is_debug(port))
2160 tcpm_set_state(port, DEBUG_ACC_ATTACHED,
2162 else if (tcpm_port_is_audio(port))
2163 tcpm_set_state(port, AUDIO_ACC_ATTACHED,
2165 else if (tcpm_port_is_source(port))
2166 tcpm_set_state(port,
2167 tcpm_try_snk(port) ? SNK_TRY
2173 port->try_snk_count++;
2176 * - Do not drive vconn or vbus
2177 * - Terminate CC pins (both) to Rd
2179 * - Wait for tDRPTry (PD_T_DRP_TRY).
2180 * Until then, ignore any state changes.
2182 tcpm_set_cc(port, TYPEC_CC_RD);
2183 tcpm_set_state(port, SNK_TRY_WAIT, PD_T_DRP_TRY);
2186 if (tcpm_port_is_sink(port)) {
2187 tcpm_set_state(port, SNK_TRY_WAIT_DEBOUNCE, 0);
2189 tcpm_set_state(port, SRC_TRYWAIT, 0);
2193 case SNK_TRY_WAIT_DEBOUNCE:
2194 tcpm_set_state(port, SNK_TRY_WAIT_DEBOUNCE_CHECK_VBUS,
2197 case SNK_TRY_WAIT_DEBOUNCE_CHECK_VBUS:
2198 if (port->vbus_present && tcpm_port_is_sink(port)) {
2199 tcpm_set_state(port, SNK_ATTACHED, 0);
2201 tcpm_set_state(port, SRC_TRYWAIT, 0);
2206 tcpm_set_cc(port, tcpm_rp_cc(port));
2207 if (port->max_wait == 0) {
2208 port->max_wait = jiffies +
2209 msecs_to_jiffies(PD_T_DRP_TRY);
2210 tcpm_set_state(port, SRC_TRYWAIT_UNATTACHED,
2213 if (time_is_after_jiffies(port->max_wait))
2214 tcpm_set_state(port, SRC_TRYWAIT_UNATTACHED,
2215 jiffies_to_msecs(port->max_wait -
2218 tcpm_set_state(port, SNK_UNATTACHED, 0);
2221 case SRC_TRYWAIT_DEBOUNCE:
2222 tcpm_set_state(port, SRC_ATTACHED, PD_T_CC_DEBOUNCE);
2224 case SRC_TRYWAIT_UNATTACHED:
2225 tcpm_set_state(port, SNK_UNATTACHED, 0);
2229 ret = tcpm_src_attach(port);
2230 tcpm_set_state(port, SRC_UNATTACHED,
2231 ret < 0 ? 0 : PD_T_PS_SOURCE_ON);
2234 opmode = tcpm_get_pwr_opmode(tcpm_rp_cc(port));
2235 typec_set_pwr_opmode(port->typec_port, opmode);
2236 port->pwr_opmode = TYPEC_PWR_MODE_USB;
2237 port->caps_count = 0;
2238 port->message_id = 0;
2239 port->rx_msgid = -1;
2240 port->explicit_contract = false;
2241 tcpm_set_state(port, SRC_SEND_CAPABILITIES, 0);
2243 case SRC_SEND_CAPABILITIES:
2245 if (port->caps_count > PD_N_CAPS_COUNT) {
2246 tcpm_set_state(port, SRC_READY, 0);
2249 ret = tcpm_pd_send_source_caps(port);
2251 tcpm_set_state(port, SRC_SEND_CAPABILITIES,
2252 PD_T_SEND_SOURCE_CAP);
2255 * Per standard, we should clear the reset counter here.
2256 * However, that can result in state machine hang-ups.
2257 * Reset it only in READY state to improve stability.
2259 /* port->hard_reset_count = 0; */
2260 port->caps_count = 0;
2261 port->pd_capable = true;
2262 tcpm_set_state_cond(port, hard_reset_state(port),
2263 PD_T_SEND_SOURCE_CAP);
2266 case SRC_NEGOTIATE_CAPABILITIES:
2267 ret = tcpm_pd_check_request(port);
2269 tcpm_pd_send_control(port, PD_CTRL_REJECT);
2270 if (!port->explicit_contract) {
2271 tcpm_set_state(port,
2272 SRC_WAIT_NEW_CAPABILITIES, 0);
2274 tcpm_set_state(port, SRC_READY, 0);
2277 tcpm_pd_send_control(port, PD_CTRL_ACCEPT);
2278 tcpm_set_state(port, SRC_TRANSITION_SUPPLY,
2279 PD_T_SRC_TRANSITION);
2282 case SRC_TRANSITION_SUPPLY:
2283 /* XXX: regulator_set_voltage(vbus, ...) */
2284 tcpm_pd_send_control(port, PD_CTRL_PS_RDY);
2285 port->explicit_contract = true;
2286 typec_set_pwr_opmode(port->typec_port, TYPEC_PWR_MODE_PD);
2287 port->pwr_opmode = TYPEC_PWR_MODE_PD;
2288 tcpm_set_state_cond(port, SRC_READY, 0);
2292 port->hard_reset_count = 0;
2294 port->try_src_count = 0;
2296 tcpm_swap_complete(port, 0);
2297 tcpm_typec_connect(port);
2298 tcpm_check_send_discover(port);
2301 * Sending ping messages is not necessary if
2302 * - the source operates at vSafe5V
2304 * - The system is not operating in PD mode
2306 * - Both partners are connected using a Type-C connector
2308 * There is no actual need to send PD messages since the local
2309 * port type-c and the spec does not clearly say whether PD is
2310 * possible when type-c is connected to Type-A/B
2313 case SRC_WAIT_NEW_CAPABILITIES:
2314 /* Nothing to do... */
2318 case SNK_UNATTACHED:
2319 if (!port->non_pd_role_swap)
2320 tcpm_swap_complete(port, -ENOTCONN);
2321 tcpm_snk_detach(port);
2322 if (tcpm_start_drp_toggling(port)) {
2323 tcpm_set_state(port, DRP_TOGGLING, 0);
2326 tcpm_set_cc(port, TYPEC_CC_RD);
2327 if (port->port_type == TYPEC_PORT_DRP)
2328 tcpm_set_state(port, SRC_UNATTACHED, PD_T_DRP_SRC);
2330 case SNK_ATTACH_WAIT:
2331 if ((port->cc1 == TYPEC_CC_OPEN &&
2332 port->cc2 != TYPEC_CC_OPEN) ||
2333 (port->cc1 != TYPEC_CC_OPEN &&
2334 port->cc2 == TYPEC_CC_OPEN))
2335 tcpm_set_state(port, SNK_DEBOUNCED,
2337 else if (tcpm_port_is_disconnected(port))
2338 tcpm_set_state(port, SNK_UNATTACHED,
2342 if (tcpm_port_is_disconnected(port))
2343 tcpm_set_state(port, SNK_UNATTACHED,
2345 else if (port->vbus_present)
2346 tcpm_set_state(port,
2347 tcpm_try_src(port) ? SRC_TRY
2351 /* Wait for VBUS, but not forever */
2352 tcpm_set_state(port, PORT_RESET, PD_T_PS_SOURCE_ON);
2356 port->try_src_count++;
2357 tcpm_set_cc(port, tcpm_rp_cc(port));
2359 tcpm_set_state(port, SRC_TRY_WAIT, 0);
2362 if (port->max_wait == 0) {
2363 port->max_wait = jiffies +
2364 msecs_to_jiffies(PD_T_DRP_TRY);
2365 msecs = PD_T_DRP_TRY;
2367 if (time_is_after_jiffies(port->max_wait))
2368 msecs = jiffies_to_msecs(port->max_wait -
2373 tcpm_set_state(port, SNK_TRYWAIT, msecs);
2375 case SRC_TRY_DEBOUNCE:
2376 tcpm_set_state(port, SRC_ATTACHED, PD_T_PD_DEBOUNCE);
2379 tcpm_set_cc(port, TYPEC_CC_RD);
2380 tcpm_set_state(port, SNK_TRYWAIT_VBUS, PD_T_CC_DEBOUNCE);
2382 case SNK_TRYWAIT_VBUS:
2384 * TCPM stays in this state indefinitely until VBUS
2385 * is detected as long as Rp is not detected for
2386 * more than a time period of tPDDebounce.
2388 if (port->vbus_present && tcpm_port_is_sink(port)) {
2389 tcpm_set_state(port, SNK_ATTACHED, 0);
2392 if (!tcpm_port_is_sink(port))
2393 tcpm_set_state(port, SNK_TRYWAIT_DEBOUNCE, 0);
2395 case SNK_TRYWAIT_DEBOUNCE:
2396 tcpm_set_state(port, SNK_UNATTACHED, PD_T_PD_DEBOUNCE);
2399 ret = tcpm_snk_attach(port);
2401 tcpm_set_state(port, SNK_UNATTACHED, 0);
2403 tcpm_set_state(port, SNK_STARTUP, 0);
2406 opmode = tcpm_get_pwr_opmode(port->polarity ?
2407 port->cc2 : port->cc1);
2408 typec_set_pwr_opmode(port->typec_port, opmode);
2409 port->pwr_opmode = TYPEC_PWR_MODE_USB;
2410 port->message_id = 0;
2411 port->rx_msgid = -1;
2412 port->explicit_contract = false;
2413 tcpm_set_state(port, SNK_DISCOVERY, 0);
2416 if (port->vbus_present) {
2417 tcpm_set_current_limit(port,
2418 tcpm_get_current_limit(port),
2420 tcpm_set_charge(port, true);
2421 tcpm_set_state(port, SNK_WAIT_CAPABILITIES, 0);
2425 * For DRP, timeouts differ. Also, handling is supposed to be
2426 * different and much more complex (dead battery detection;
2427 * see USB power delivery specification, section 8.3.3.6.1.5.1).
2429 tcpm_set_state(port, hard_reset_state(port),
2430 port->port_type == TYPEC_PORT_DRP ?
2431 PD_T_DB_DETECT : PD_T_NO_RESPONSE);
2433 case SNK_DISCOVERY_DEBOUNCE:
2434 tcpm_set_state(port, SNK_DISCOVERY_DEBOUNCE_DONE,
2437 case SNK_DISCOVERY_DEBOUNCE_DONE:
2438 if (!tcpm_port_is_disconnected(port) &&
2439 tcpm_port_is_sink(port) &&
2440 time_is_after_jiffies(port->delayed_runtime)) {
2441 tcpm_set_state(port, SNK_DISCOVERY,
2442 port->delayed_runtime - jiffies);
2445 tcpm_set_state(port, unattached_state(port), 0);
2447 case SNK_WAIT_CAPABILITIES:
2448 ret = port->tcpc->set_pd_rx(port->tcpc, true);
2450 tcpm_set_state(port, SNK_READY, 0);
2454 * If VBUS has never been low, and we time out waiting
2455 * for source cap, try a soft reset first, in case we
2456 * were already in a stable contract before this boot.
2457 * Do this only once.
2459 if (port->vbus_never_low) {
2460 port->vbus_never_low = false;
2461 tcpm_set_state(port, SOFT_RESET_SEND,
2462 PD_T_SINK_WAIT_CAP);
2464 tcpm_set_state(port, hard_reset_state(port),
2465 PD_T_SINK_WAIT_CAP);
2468 case SNK_NEGOTIATE_CAPABILITIES:
2469 port->pd_capable = true;
2470 port->hard_reset_count = 0;
2471 ret = tcpm_pd_send_request(port);
2473 /* Let the Source send capabilities again. */
2474 tcpm_set_state(port, SNK_WAIT_CAPABILITIES, 0);
2476 tcpm_set_state_cond(port, hard_reset_state(port),
2477 PD_T_SENDER_RESPONSE);
2480 case SNK_TRANSITION_SINK:
2481 case SNK_TRANSITION_SINK_VBUS:
2482 tcpm_set_state(port, hard_reset_state(port),
2483 PD_T_PS_TRANSITION);
2486 port->try_snk_count = 0;
2487 if (port->explicit_contract) {
2488 typec_set_pwr_opmode(port->typec_port,
2490 port->pwr_opmode = TYPEC_PWR_MODE_PD;
2493 tcpm_swap_complete(port, 0);
2494 tcpm_typec_connect(port);
2495 tcpm_check_send_discover(port);
2498 /* Accessory states */
2499 case ACC_UNATTACHED:
2500 tcpm_acc_detach(port);
2501 tcpm_set_state(port, SRC_UNATTACHED, 0);
2503 case DEBUG_ACC_ATTACHED:
2504 case AUDIO_ACC_ATTACHED:
2505 ret = tcpm_acc_attach(port);
2507 tcpm_set_state(port, ACC_UNATTACHED, 0);
2509 case AUDIO_ACC_DEBOUNCE:
2510 tcpm_set_state(port, ACC_UNATTACHED, PD_T_CC_DEBOUNCE);
2513 /* Hard_Reset states */
2514 case HARD_RESET_SEND:
2515 tcpm_pd_transmit(port, TCPC_TX_HARD_RESET, NULL);
2516 tcpm_set_state(port, HARD_RESET_START, 0);
2518 case HARD_RESET_START:
2519 port->hard_reset_count++;
2520 port->tcpc->set_pd_rx(port->tcpc, false);
2521 tcpm_unregister_altmodes(port);
2522 port->send_discover = true;
2523 if (port->pwr_role == TYPEC_SOURCE)
2524 tcpm_set_state(port, SRC_HARD_RESET_VBUS_OFF,
2525 PD_T_PS_HARD_RESET);
2527 tcpm_set_state(port, SNK_HARD_RESET_SINK_OFF, 0);
2529 case SRC_HARD_RESET_VBUS_OFF:
2530 tcpm_set_vconn(port, true);
2531 tcpm_set_vbus(port, false);
2532 tcpm_set_roles(port, false, TYPEC_SOURCE, TYPEC_HOST);
2533 tcpm_set_state(port, SRC_HARD_RESET_VBUS_ON, PD_T_SRC_RECOVER);
2535 case SRC_HARD_RESET_VBUS_ON:
2536 tcpm_set_vbus(port, true);
2537 port->tcpc->set_pd_rx(port->tcpc, true);
2538 tcpm_set_attached_state(port, true);
2539 tcpm_set_state(port, SRC_UNATTACHED, PD_T_PS_SOURCE_ON);
2541 case SNK_HARD_RESET_SINK_OFF:
2542 tcpm_set_vconn(port, false);
2543 tcpm_set_charge(port, false);
2544 tcpm_set_roles(port, false, TYPEC_SINK, TYPEC_DEVICE);
2546 * VBUS may or may not toggle, depending on the adapter.
2547 * If it doesn't toggle, transition to SNK_HARD_RESET_SINK_ON
2548 * directly after timeout.
2550 tcpm_set_state(port, SNK_HARD_RESET_SINK_ON, PD_T_SAFE_0V);
2552 case SNK_HARD_RESET_WAIT_VBUS:
2553 /* Assume we're disconnected if VBUS doesn't come back. */
2554 tcpm_set_state(port, SNK_UNATTACHED,
2555 PD_T_SRC_RECOVER_MAX + PD_T_SRC_TURN_ON);
2557 case SNK_HARD_RESET_SINK_ON:
2558 /* Note: There is no guarantee that VBUS is on in this state */
2561 * The specification suggests that dual mode ports in sink
2562 * mode should transition to state PE_SRC_Transition_to_default.
2563 * See USB power delivery specification chapter 8.3.3.6.1.3.
2564 * This would mean to to
2565 * - turn off VCONN, reset power supply
2566 * - request hardware reset
2568 * - Transition to state PE_Src_Startup
2569 * SNK only ports shall transition to state Snk_Startup
2570 * (see chapter 8.3.3.3.8).
2571 * Similar, dual-mode ports in source mode should transition
2572 * to PE_SNK_Transition_to_default.
2574 tcpm_set_attached_state(port, true);
2575 tcpm_set_state(port, SNK_STARTUP, 0);
2578 /* Soft_Reset states */
2580 port->message_id = 0;
2581 port->rx_msgid = -1;
2582 tcpm_pd_send_control(port, PD_CTRL_ACCEPT);
2583 if (port->pwr_role == TYPEC_SOURCE)
2584 tcpm_set_state(port, SRC_SEND_CAPABILITIES, 0);
2586 tcpm_set_state(port, SNK_WAIT_CAPABILITIES, 0);
2588 case SOFT_RESET_SEND:
2589 port->message_id = 0;
2590 port->rx_msgid = -1;
2591 if (tcpm_pd_send_control(port, PD_CTRL_SOFT_RESET))
2592 tcpm_set_state_cond(port, hard_reset_state(port), 0);
2594 tcpm_set_state_cond(port, hard_reset_state(port),
2595 PD_T_SENDER_RESPONSE);
2598 /* DR_Swap states */
2600 tcpm_pd_send_control(port, PD_CTRL_DR_SWAP);
2601 tcpm_set_state_cond(port, DR_SWAP_SEND_TIMEOUT,
2602 PD_T_SENDER_RESPONSE);
2604 case DR_SWAP_ACCEPT:
2605 tcpm_pd_send_control(port, PD_CTRL_ACCEPT);
2606 tcpm_set_state_cond(port, DR_SWAP_CHANGE_DR, 0);
2608 case DR_SWAP_SEND_TIMEOUT:
2609 tcpm_swap_complete(port, -ETIMEDOUT);
2610 tcpm_set_state(port, ready_state(port), 0);
2612 case DR_SWAP_CHANGE_DR:
2613 if (port->data_role == TYPEC_HOST) {
2614 tcpm_unregister_altmodes(port);
2615 tcpm_set_roles(port, true, port->pwr_role,
2618 tcpm_set_roles(port, true, port->pwr_role,
2620 port->send_discover = true;
2622 tcpm_set_state(port, ready_state(port), 0);
2625 /* PR_Swap states */
2626 case PR_SWAP_ACCEPT:
2627 tcpm_pd_send_control(port, PD_CTRL_ACCEPT);
2628 tcpm_set_state(port, PR_SWAP_START, 0);
2631 tcpm_pd_send_control(port, PD_CTRL_PR_SWAP);
2632 tcpm_set_state_cond(port, PR_SWAP_SEND_TIMEOUT,
2633 PD_T_SENDER_RESPONSE);
2635 case PR_SWAP_SEND_TIMEOUT:
2636 tcpm_swap_complete(port, -ETIMEDOUT);
2637 tcpm_set_state(port, ready_state(port), 0);
2640 if (port->pwr_role == TYPEC_SOURCE)
2641 tcpm_set_state(port, PR_SWAP_SRC_SNK_TRANSITION_OFF,
2642 PD_T_SRC_TRANSITION);
2644 tcpm_set_state(port, PR_SWAP_SNK_SRC_SINK_OFF, 0);
2646 case PR_SWAP_SRC_SNK_TRANSITION_OFF:
2647 tcpm_set_vbus(port, false);
2648 port->explicit_contract = false;
2649 /* allow time for Vbus discharge, must be < tSrcSwapStdby */
2650 tcpm_set_state(port, PR_SWAP_SRC_SNK_SOURCE_OFF,
2653 case PR_SWAP_SRC_SNK_SOURCE_OFF:
2654 tcpm_set_cc(port, TYPEC_CC_RD);
2655 /* allow CC debounce */
2656 tcpm_set_state(port, PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED,
2659 case PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED:
2661 * USB-PD standard, 6.2.1.4, Port Power Role:
2662 * "During the Power Role Swap Sequence, for the initial Source
2663 * Port, the Port Power Role field shall be set to Sink in the
2664 * PS_RDY Message indicating that the initial Source’s power
2665 * supply is turned off"
2667 tcpm_set_pwr_role(port, TYPEC_SINK);
2668 if (tcpm_pd_send_control(port, PD_CTRL_PS_RDY)) {
2669 tcpm_set_state(port, ERROR_RECOVERY, 0);
2672 tcpm_set_state_cond(port, SNK_UNATTACHED, PD_T_PS_SOURCE_ON);
2674 case PR_SWAP_SRC_SNK_SINK_ON:
2675 tcpm_set_state(port, SNK_STARTUP, 0);
2677 case PR_SWAP_SNK_SRC_SINK_OFF:
2678 tcpm_set_charge(port, false);
2679 tcpm_set_state(port, hard_reset_state(port),
2680 PD_T_PS_SOURCE_OFF);
2682 case PR_SWAP_SNK_SRC_SOURCE_ON:
2683 tcpm_set_cc(port, tcpm_rp_cc(port));
2684 tcpm_set_vbus(port, true);
2686 * allow time VBUS ramp-up, must be < tNewSrc
2687 * Also, this window overlaps with CC debounce as well.
2688 * So, Wait for the max of two which is PD_T_NEWSRC
2690 tcpm_set_state(port, PR_SWAP_SNK_SRC_SOURCE_ON_VBUS_RAMPED_UP,
2693 case PR_SWAP_SNK_SRC_SOURCE_ON_VBUS_RAMPED_UP:
2695 * USB PD standard, 6.2.1.4:
2696 * "Subsequent Messages initiated by the Policy Engine,
2697 * such as the PS_RDY Message sent to indicate that Vbus
2698 * is ready, will have the Port Power Role field set to
2701 tcpm_set_pwr_role(port, TYPEC_SOURCE);
2702 tcpm_pd_send_control(port, PD_CTRL_PS_RDY);
2703 tcpm_set_state(port, SRC_STARTUP, 0);
2706 case VCONN_SWAP_ACCEPT:
2707 tcpm_pd_send_control(port, PD_CTRL_ACCEPT);
2708 tcpm_set_state(port, VCONN_SWAP_START, 0);
2710 case VCONN_SWAP_SEND:
2711 tcpm_pd_send_control(port, PD_CTRL_VCONN_SWAP);
2712 tcpm_set_state(port, VCONN_SWAP_SEND_TIMEOUT,
2713 PD_T_SENDER_RESPONSE);
2715 case VCONN_SWAP_SEND_TIMEOUT:
2716 tcpm_swap_complete(port, -ETIMEDOUT);
2717 tcpm_set_state(port, ready_state(port), 0);
2719 case VCONN_SWAP_START:
2720 if (port->vconn_role == TYPEC_SOURCE)
2721 tcpm_set_state(port, VCONN_SWAP_WAIT_FOR_VCONN, 0);
2723 tcpm_set_state(port, VCONN_SWAP_TURN_ON_VCONN, 0);
2725 case VCONN_SWAP_WAIT_FOR_VCONN:
2726 tcpm_set_state(port, hard_reset_state(port),
2727 PD_T_VCONN_SOURCE_ON);
2729 case VCONN_SWAP_TURN_ON_VCONN:
2730 tcpm_set_vconn(port, true);
2731 tcpm_pd_send_control(port, PD_CTRL_PS_RDY);
2732 tcpm_set_state(port, ready_state(port), 0);
2734 case VCONN_SWAP_TURN_OFF_VCONN:
2735 tcpm_set_vconn(port, false);
2736 tcpm_set_state(port, ready_state(port), 0);
2739 case DR_SWAP_CANCEL:
2740 case PR_SWAP_CANCEL:
2741 case VCONN_SWAP_CANCEL:
2742 tcpm_swap_complete(port, port->swap_status);
2743 if (port->pwr_role == TYPEC_SOURCE)
2744 tcpm_set_state(port, SRC_READY, 0);
2746 tcpm_set_state(port, SNK_READY, 0);
2750 switch (BDO_MODE_MASK(port->bist_request)) {
2751 case BDO_MODE_CARRIER2:
2752 tcpm_pd_transmit(port, TCPC_TX_BIST_MODE_2, NULL);
2757 /* Always switch to unattached state */
2758 tcpm_set_state(port, unattached_state(port), 0);
2760 case ERROR_RECOVERY:
2761 tcpm_swap_complete(port, -EPROTO);
2762 tcpm_set_state(port, PORT_RESET, 0);
2765 tcpm_reset_port(port);
2766 tcpm_set_cc(port, TYPEC_CC_OPEN);
2767 tcpm_set_state(port, PORT_RESET_WAIT_OFF,
2768 PD_T_ERROR_RECOVERY);
2770 case PORT_RESET_WAIT_OFF:
2771 tcpm_set_state(port,
2772 tcpm_default_state(port),
2773 port->vbus_present ? PD_T_PS_SOURCE_OFF : 0);
2776 WARN(1, "Unexpected port state %d\n", port->state);
2781 static void tcpm_state_machine_work(struct work_struct *work)
2783 struct tcpm_port *port = container_of(work, struct tcpm_port,
2784 state_machine.work);
2785 enum tcpm_state prev_state;
2787 mutex_lock(&port->lock);
2788 port->state_machine_running = true;
2790 if (port->queued_message && tcpm_send_queued_message(port))
2793 /* If we were queued due to a delayed state change, update it now */
2794 if (port->delayed_state) {
2795 tcpm_log(port, "state change %s -> %s [delayed %ld ms]",
2796 tcpm_states[port->state],
2797 tcpm_states[port->delayed_state], port->delay_ms);
2798 port->prev_state = port->state;
2799 port->state = port->delayed_state;
2800 port->delayed_state = INVALID_STATE;
2804 * Continue running as long as we have (non-delayed) state changes
2808 prev_state = port->state;
2809 run_state_machine(port);
2810 if (port->queued_message)
2811 tcpm_send_queued_message(port);
2812 } while (port->state != prev_state && !port->delayed_state);
2815 port->state_machine_running = false;
2816 mutex_unlock(&port->lock);
2819 static void _tcpm_cc_change(struct tcpm_port *port, enum typec_cc_status cc1,
2820 enum typec_cc_status cc2)
2822 enum typec_cc_status old_cc1, old_cc2;
2823 enum tcpm_state new_state;
2825 old_cc1 = port->cc1;
2826 old_cc2 = port->cc2;
2830 tcpm_log_force(port,
2831 "CC1: %u -> %u, CC2: %u -> %u [state %s, polarity %d, %s]",
2832 old_cc1, cc1, old_cc2, cc2, tcpm_states[port->state],
2834 tcpm_port_is_disconnected(port) ? "disconnected"
2837 switch (port->state) {
2839 if (tcpm_port_is_debug(port) || tcpm_port_is_audio(port) ||
2840 tcpm_port_is_source(port))
2841 tcpm_set_state(port, SRC_ATTACH_WAIT, 0);
2842 else if (tcpm_port_is_sink(port))
2843 tcpm_set_state(port, SNK_ATTACH_WAIT, 0);
2845 case SRC_UNATTACHED:
2846 case ACC_UNATTACHED:
2847 if (tcpm_port_is_debug(port) || tcpm_port_is_audio(port) ||
2848 tcpm_port_is_source(port))
2849 tcpm_set_state(port, SRC_ATTACH_WAIT, 0);
2851 case SRC_ATTACH_WAIT:
2852 if (tcpm_port_is_disconnected(port) ||
2853 tcpm_port_is_audio_detached(port))
2854 tcpm_set_state(port, SRC_UNATTACHED, 0);
2855 else if (cc1 != old_cc1 || cc2 != old_cc2)
2856 tcpm_set_state(port, SRC_ATTACH_WAIT, 0);
2859 case SRC_SEND_CAPABILITIES:
2861 if (tcpm_port_is_disconnected(port) ||
2862 !tcpm_port_is_source(port))
2863 tcpm_set_state(port, SRC_UNATTACHED, 0);
2865 case SNK_UNATTACHED:
2866 if (tcpm_port_is_sink(port))
2867 tcpm_set_state(port, SNK_ATTACH_WAIT, 0);
2869 case SNK_ATTACH_WAIT:
2870 if ((port->cc1 == TYPEC_CC_OPEN &&
2871 port->cc2 != TYPEC_CC_OPEN) ||
2872 (port->cc1 != TYPEC_CC_OPEN &&
2873 port->cc2 == TYPEC_CC_OPEN))
2874 new_state = SNK_DEBOUNCED;
2875 else if (tcpm_port_is_disconnected(port))
2876 new_state = SNK_UNATTACHED;
2879 if (new_state != port->delayed_state)
2880 tcpm_set_state(port, SNK_ATTACH_WAIT, 0);
2883 if (tcpm_port_is_disconnected(port))
2884 new_state = SNK_UNATTACHED;
2885 else if (port->vbus_present)
2886 new_state = tcpm_try_src(port) ? SRC_TRY : SNK_ATTACHED;
2888 new_state = SNK_UNATTACHED;
2889 if (new_state != port->delayed_state)
2890 tcpm_set_state(port, SNK_DEBOUNCED, 0);
2893 if (tcpm_port_is_disconnected(port))
2894 tcpm_set_state(port, unattached_state(port), 0);
2895 else if (!port->pd_capable &&
2896 (cc1 != old_cc1 || cc2 != old_cc2))
2897 tcpm_set_current_limit(port,
2898 tcpm_get_current_limit(port),
2902 case AUDIO_ACC_ATTACHED:
2903 if (cc1 == TYPEC_CC_OPEN || cc2 == TYPEC_CC_OPEN)
2904 tcpm_set_state(port, AUDIO_ACC_DEBOUNCE, 0);
2906 case AUDIO_ACC_DEBOUNCE:
2907 if (tcpm_port_is_audio(port))
2908 tcpm_set_state(port, AUDIO_ACC_ATTACHED, 0);
2911 case DEBUG_ACC_ATTACHED:
2912 if (cc1 == TYPEC_CC_OPEN || cc2 == TYPEC_CC_OPEN)
2913 tcpm_set_state(port, ACC_UNATTACHED, 0);
2917 /* Do nothing, waiting for timeout */
2921 /* CC line is unstable, wait for debounce */
2922 if (tcpm_port_is_disconnected(port))
2923 tcpm_set_state(port, SNK_DISCOVERY_DEBOUNCE, 0);
2925 case SNK_DISCOVERY_DEBOUNCE:
2929 /* Hand over to state machine if needed */
2930 if (!port->vbus_present && tcpm_port_is_source(port))
2931 tcpm_set_state(port, SRC_TRYWAIT_DEBOUNCE, 0);
2933 case SRC_TRYWAIT_DEBOUNCE:
2934 if (port->vbus_present || !tcpm_port_is_source(port))
2935 tcpm_set_state(port, SRC_TRYWAIT, 0);
2937 case SNK_TRY_WAIT_DEBOUNCE:
2938 if (!tcpm_port_is_sink(port)) {
2940 tcpm_set_state(port, SRC_TRYWAIT, 0);
2944 if (tcpm_port_is_source(port))
2945 tcpm_set_state(port, SRC_TRY_DEBOUNCE, 0);
2947 case SRC_TRY_DEBOUNCE:
2948 tcpm_set_state(port, SRC_TRY_WAIT, 0);
2950 case SNK_TRYWAIT_DEBOUNCE:
2951 if (tcpm_port_is_sink(port))
2952 tcpm_set_state(port, SNK_TRYWAIT_VBUS, 0);
2954 case SNK_TRYWAIT_VBUS:
2955 if (!tcpm_port_is_sink(port))
2956 tcpm_set_state(port, SNK_TRYWAIT_DEBOUNCE, 0);
2959 /* Do nothing, waiting for tCCDebounce */
2961 case PR_SWAP_SNK_SRC_SINK_OFF:
2962 case PR_SWAP_SRC_SNK_TRANSITION_OFF:
2963 case PR_SWAP_SRC_SNK_SOURCE_OFF:
2964 case PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED:
2965 case PR_SWAP_SNK_SRC_SOURCE_ON:
2967 * CC state change is expected in PR_SWAP
2973 if (tcpm_port_is_disconnected(port))
2974 tcpm_set_state(port, unattached_state(port), 0);
2979 static void _tcpm_pd_vbus_on(struct tcpm_port *port)
2981 tcpm_log_force(port, "VBUS on");
2982 port->vbus_present = true;
2983 switch (port->state) {
2984 case SNK_TRANSITION_SINK_VBUS:
2985 port->explicit_contract = true;
2986 tcpm_set_state(port, SNK_READY, 0);
2989 tcpm_set_state(port, SNK_DISCOVERY, 0);
2993 tcpm_set_state(port, tcpm_try_src(port) ? SRC_TRY
2997 case SNK_HARD_RESET_WAIT_VBUS:
2998 tcpm_set_state(port, SNK_HARD_RESET_SINK_ON, 0);
3001 tcpm_set_state(port, SRC_STARTUP, 0);
3003 case SRC_HARD_RESET_VBUS_ON:
3004 tcpm_set_state(port, SRC_STARTUP, 0);
3008 /* Do nothing, waiting for timeout */
3011 /* Do nothing, Waiting for Rd to be detected */
3013 case SRC_TRYWAIT_DEBOUNCE:
3014 tcpm_set_state(port, SRC_TRYWAIT, 0);
3016 case SNK_TRY_WAIT_DEBOUNCE:
3017 /* Do nothing, waiting for PD_DEBOUNCE to do be done */
3020 /* Do nothing, waiting for tCCDebounce */
3022 case SNK_TRYWAIT_VBUS:
3023 if (tcpm_port_is_sink(port))
3024 tcpm_set_state(port, SNK_ATTACHED, 0);
3026 case SNK_TRYWAIT_DEBOUNCE:
3027 /* Do nothing, waiting for Rp */
3030 case SRC_TRY_DEBOUNCE:
3031 /* Do nothing, waiting for sink detection */
3038 static void _tcpm_pd_vbus_off(struct tcpm_port *port)
3040 tcpm_log_force(port, "VBUS off");
3041 port->vbus_present = false;
3042 port->vbus_never_low = false;
3043 switch (port->state) {
3044 case SNK_HARD_RESET_SINK_OFF:
3045 tcpm_set_state(port, SNK_HARD_RESET_WAIT_VBUS, 0);
3047 case SRC_HARD_RESET_VBUS_OFF:
3048 tcpm_set_state(port, SRC_HARD_RESET_VBUS_ON, 0);
3050 case HARD_RESET_SEND:
3054 /* Do nothing, waiting for timeout */
3057 /* Hand over to state machine if needed */
3058 if (tcpm_port_is_source(port))
3059 tcpm_set_state(port, SRC_TRYWAIT_DEBOUNCE, 0);
3061 case SNK_TRY_WAIT_DEBOUNCE:
3062 /* Do nothing, waiting for PD_DEBOUNCE to do be done */
3065 case SNK_TRYWAIT_VBUS:
3066 case SNK_TRYWAIT_DEBOUNCE:
3068 case SNK_ATTACH_WAIT:
3069 tcpm_set_state(port, SNK_UNATTACHED, 0);
3072 case SNK_NEGOTIATE_CAPABILITIES:
3075 case PR_SWAP_SRC_SNK_TRANSITION_OFF:
3076 tcpm_set_state(port, PR_SWAP_SRC_SNK_SOURCE_OFF, 0);
3079 case PR_SWAP_SNK_SRC_SINK_OFF:
3080 /* Do nothing, expected */
3083 case PORT_RESET_WAIT_OFF:
3084 tcpm_set_state(port, tcpm_default_state(port), 0);
3087 case SRC_TRY_DEBOUNCE:
3088 /* Do nothing, waiting for sink detection */
3091 if (port->pwr_role == TYPEC_SINK &&
3093 tcpm_set_state(port, SNK_UNATTACHED, 0);
3098 static void _tcpm_pd_hard_reset(struct tcpm_port *port)
3100 tcpm_log_force(port, "Received hard reset");
3102 * If we keep receiving hard reset requests, executing the hard reset
3103 * must have failed. Revert to error recovery if that happens.
3105 tcpm_set_state(port,
3106 port->hard_reset_count < PD_N_HARD_RESET_COUNT ?
3107 HARD_RESET_START : ERROR_RECOVERY,
3111 static void tcpm_pd_event_handler(struct work_struct *work)
3113 struct tcpm_port *port = container_of(work, struct tcpm_port,
3117 mutex_lock(&port->lock);
3119 spin_lock(&port->pd_event_lock);
3120 while (port->pd_events) {
3121 events = port->pd_events;
3122 port->pd_events = 0;
3123 spin_unlock(&port->pd_event_lock);
3124 if (events & TCPM_RESET_EVENT)
3125 _tcpm_pd_hard_reset(port);
3126 if (events & TCPM_VBUS_EVENT) {
3129 vbus = port->tcpc->get_vbus(port->tcpc);
3131 _tcpm_pd_vbus_on(port);
3133 _tcpm_pd_vbus_off(port);
3135 if (events & TCPM_CC_EVENT) {
3136 enum typec_cc_status cc1, cc2;
3138 if (port->tcpc->get_cc(port->tcpc, &cc1, &cc2) == 0)
3139 _tcpm_cc_change(port, cc1, cc2);
3141 spin_lock(&port->pd_event_lock);
3143 spin_unlock(&port->pd_event_lock);
3144 mutex_unlock(&port->lock);
3147 void tcpm_cc_change(struct tcpm_port *port)
3149 spin_lock(&port->pd_event_lock);
3150 port->pd_events |= TCPM_CC_EVENT;
3151 spin_unlock(&port->pd_event_lock);
3152 queue_work(port->wq, &port->event_work);
3154 EXPORT_SYMBOL_GPL(tcpm_cc_change);
3156 void tcpm_vbus_change(struct tcpm_port *port)
3158 spin_lock(&port->pd_event_lock);
3159 port->pd_events |= TCPM_VBUS_EVENT;
3160 spin_unlock(&port->pd_event_lock);
3161 queue_work(port->wq, &port->event_work);
3163 EXPORT_SYMBOL_GPL(tcpm_vbus_change);
3165 void tcpm_pd_hard_reset(struct tcpm_port *port)
3167 spin_lock(&port->pd_event_lock);
3168 port->pd_events = TCPM_RESET_EVENT;
3169 spin_unlock(&port->pd_event_lock);
3170 queue_work(port->wq, &port->event_work);
3172 EXPORT_SYMBOL_GPL(tcpm_pd_hard_reset);
3174 static int tcpm_dr_set(const struct typec_capability *cap,
3175 enum typec_data_role data)
3177 struct tcpm_port *port = typec_cap_to_tcpm(cap);
3180 mutex_lock(&port->swap_lock);
3181 mutex_lock(&port->lock);
3183 if (port->port_type != TYPEC_PORT_DRP) {
3187 if (port->state != SRC_READY && port->state != SNK_READY) {
3192 if (port->data_role == data) {
3199 * 6.3.9: If an alternate mode is active, a request to swap
3200 * alternate modes shall trigger a port reset.
3201 * Reject data role swap request in this case.
3204 if (!port->pd_capable) {
3206 * If the partner is not PD capable, reset the port to
3207 * trigger a role change. This can only work if a preferred
3208 * role is configured, and if it matches the requested role.
3210 if (port->try_role == TYPEC_NO_PREFERRED_ROLE ||
3211 port->try_role == port->pwr_role) {
3215 port->non_pd_role_swap = true;
3216 tcpm_set_state(port, PORT_RESET, 0);
3218 tcpm_set_state(port, DR_SWAP_SEND, 0);
3221 port->swap_status = 0;
3222 port->swap_pending = true;
3223 reinit_completion(&port->swap_complete);
3224 mutex_unlock(&port->lock);
3226 if (!wait_for_completion_timeout(&port->swap_complete,
3227 msecs_to_jiffies(PD_ROLE_SWAP_TIMEOUT)))
3230 ret = port->swap_status;
3232 port->non_pd_role_swap = false;
3236 mutex_unlock(&port->lock);
3238 mutex_unlock(&port->swap_lock);
3242 static int tcpm_pr_set(const struct typec_capability *cap,
3243 enum typec_role role)
3245 struct tcpm_port *port = typec_cap_to_tcpm(cap);
3248 mutex_lock(&port->swap_lock);
3249 mutex_lock(&port->lock);
3251 if (port->port_type != TYPEC_PORT_DRP) {
3255 if (port->state != SRC_READY && port->state != SNK_READY) {
3260 if (role == port->pwr_role) {
3265 port->swap_status = 0;
3266 port->swap_pending = true;
3267 reinit_completion(&port->swap_complete);
3268 tcpm_set_state(port, PR_SWAP_SEND, 0);
3269 mutex_unlock(&port->lock);
3271 if (!wait_for_completion_timeout(&port->swap_complete,
3272 msecs_to_jiffies(PD_ROLE_SWAP_TIMEOUT)))
3275 ret = port->swap_status;
3280 mutex_unlock(&port->lock);
3282 mutex_unlock(&port->swap_lock);
3286 static int tcpm_vconn_set(const struct typec_capability *cap,
3287 enum typec_role role)
3289 struct tcpm_port *port = typec_cap_to_tcpm(cap);
3292 mutex_lock(&port->swap_lock);
3293 mutex_lock(&port->lock);
3295 if (port->state != SRC_READY && port->state != SNK_READY) {
3300 if (role == port->vconn_role) {
3305 port->swap_status = 0;
3306 port->swap_pending = true;
3307 reinit_completion(&port->swap_complete);
3308 tcpm_set_state(port, VCONN_SWAP_SEND, 0);
3309 mutex_unlock(&port->lock);
3311 if (!wait_for_completion_timeout(&port->swap_complete,
3312 msecs_to_jiffies(PD_ROLE_SWAP_TIMEOUT)))
3315 ret = port->swap_status;
3320 mutex_unlock(&port->lock);
3322 mutex_unlock(&port->swap_lock);
3326 static int tcpm_try_role(const struct typec_capability *cap, int role)
3328 struct tcpm_port *port = typec_cap_to_tcpm(cap);
3329 struct tcpc_dev *tcpc = port->tcpc;
3332 mutex_lock(&port->lock);
3334 ret = tcpc->try_role(tcpc, role);
3335 if (!ret && !tcpc->config->try_role_hw)
3336 port->try_role = role;
3337 port->try_src_count = 0;
3338 port->try_snk_count = 0;
3339 mutex_unlock(&port->lock);
3344 static void tcpm_init(struct tcpm_port *port)
3346 enum typec_cc_status cc1, cc2;
3348 port->tcpc->init(port->tcpc);
3350 tcpm_reset_port(port);
3354 * Should possibly wait for VBUS to settle if it was enabled locally
3355 * since tcpm_reset_port() will disable VBUS.
3357 port->vbus_present = port->tcpc->get_vbus(port->tcpc);
3358 if (port->vbus_present)
3359 port->vbus_never_low = true;
3361 tcpm_set_state(port, tcpm_default_state(port), 0);
3363 if (port->tcpc->get_cc(port->tcpc, &cc1, &cc2) == 0)
3364 _tcpm_cc_change(port, cc1, cc2);
3367 * Some adapters need a clean slate at startup, and won't recover
3368 * otherwise. So do not try to be fancy and force a clean disconnect.
3370 tcpm_set_state(port, PORT_RESET, 0);
3373 static int tcpm_port_type_set(const struct typec_capability *cap,
3374 enum typec_port_type type)
3376 struct tcpm_port *port = typec_cap_to_tcpm(cap);
3378 mutex_lock(&port->lock);
3379 if (type == port->port_type)
3382 port->port_type = type;
3384 if (!port->connected) {
3385 tcpm_set_state(port, PORT_RESET, 0);
3386 } else if (type == TYPEC_PORT_UFP) {
3387 if (!(port->pwr_role == TYPEC_SINK &&
3388 port->data_role == TYPEC_DEVICE))
3389 tcpm_set_state(port, PORT_RESET, 0);
3390 } else if (type == TYPEC_PORT_DFP) {
3391 if (!(port->pwr_role == TYPEC_SOURCE &&
3392 port->data_role == TYPEC_HOST))
3393 tcpm_set_state(port, PORT_RESET, 0);
3397 mutex_unlock(&port->lock);
3401 void tcpm_tcpc_reset(struct tcpm_port *port)
3403 mutex_lock(&port->lock);
3404 /* XXX: Maintain PD connection if possible? */
3406 mutex_unlock(&port->lock);
3408 EXPORT_SYMBOL_GPL(tcpm_tcpc_reset);
3410 static int tcpm_copy_pdos(u32 *dest_pdo, const u32 *src_pdo,
3411 unsigned int nr_pdo)
3415 if (nr_pdo > PDO_MAX_OBJECTS)
3416 nr_pdo = PDO_MAX_OBJECTS;
3418 for (i = 0; i < nr_pdo; i++)
3419 dest_pdo[i] = src_pdo[i];
3424 static int tcpm_copy_vdos(u32 *dest_vdo, const u32 *src_vdo,
3425 unsigned int nr_vdo)
3429 if (nr_vdo > VDO_MAX_OBJECTS)
3430 nr_vdo = VDO_MAX_OBJECTS;
3432 for (i = 0; i < nr_vdo; i++)
3433 dest_vdo[i] = src_vdo[i];
3438 void tcpm_update_source_capabilities(struct tcpm_port *port, const u32 *pdo,
3439 unsigned int nr_pdo)
3441 mutex_lock(&port->lock);
3442 port->nr_src_pdo = tcpm_copy_pdos(port->src_pdo, pdo, nr_pdo);
3443 switch (port->state) {
3444 case SRC_UNATTACHED:
3445 case SRC_ATTACH_WAIT:
3447 tcpm_set_cc(port, tcpm_rp_cc(port));
3449 case SRC_SEND_CAPABILITIES:
3450 case SRC_NEGOTIATE_CAPABILITIES:
3452 case SRC_WAIT_NEW_CAPABILITIES:
3453 tcpm_set_cc(port, tcpm_rp_cc(port));
3454 tcpm_set_state(port, SRC_SEND_CAPABILITIES, 0);
3459 mutex_unlock(&port->lock);
3461 EXPORT_SYMBOL_GPL(tcpm_update_source_capabilities);
3463 void tcpm_update_sink_capabilities(struct tcpm_port *port, const u32 *pdo,
3464 unsigned int nr_pdo,
3465 unsigned int max_snk_mv,
3466 unsigned int max_snk_ma,
3467 unsigned int max_snk_mw,
3468 unsigned int operating_snk_mw)
3470 mutex_lock(&port->lock);
3471 port->nr_snk_pdo = tcpm_copy_pdos(port->snk_pdo, pdo, nr_pdo);
3472 port->max_snk_mv = max_snk_mv;
3473 port->max_snk_ma = max_snk_ma;
3474 port->max_snk_mw = max_snk_mw;
3475 port->operating_snk_mw = operating_snk_mw;
3477 switch (port->state) {
3478 case SNK_NEGOTIATE_CAPABILITIES:
3480 case SNK_TRANSITION_SINK:
3481 case SNK_TRANSITION_SINK_VBUS:
3482 tcpm_set_state(port, SNK_NEGOTIATE_CAPABILITIES, 0);
3487 mutex_unlock(&port->lock);
3489 EXPORT_SYMBOL_GPL(tcpm_update_sink_capabilities);
3491 struct tcpm_port *tcpm_register_port(struct device *dev, struct tcpc_dev *tcpc)
3493 struct tcpm_port *port;
3496 if (!dev || !tcpc || !tcpc->config ||
3497 !tcpc->get_vbus || !tcpc->set_cc || !tcpc->get_cc ||
3498 !tcpc->set_polarity || !tcpc->set_vconn || !tcpc->set_vbus ||
3499 !tcpc->set_pd_rx || !tcpc->set_roles || !tcpc->pd_transmit)
3500 return ERR_PTR(-EINVAL);
3502 port = devm_kzalloc(dev, sizeof(*port), GFP_KERNEL);
3504 return ERR_PTR(-ENOMEM);
3509 mutex_init(&port->lock);
3510 mutex_init(&port->swap_lock);
3512 port->wq = create_singlethread_workqueue(dev_name(dev));
3514 return ERR_PTR(-ENOMEM);
3515 INIT_DELAYED_WORK(&port->state_machine, tcpm_state_machine_work);
3516 INIT_DELAYED_WORK(&port->vdm_state_machine, vdm_state_machine_work);
3517 INIT_WORK(&port->event_work, tcpm_pd_event_handler);
3519 spin_lock_init(&port->pd_event_lock);
3521 init_completion(&port->tx_complete);
3522 init_completion(&port->swap_complete);
3524 port->nr_src_pdo = tcpm_copy_pdos(port->src_pdo, tcpc->config->src_pdo,
3525 tcpc->config->nr_src_pdo);
3526 port->nr_snk_pdo = tcpm_copy_pdos(port->snk_pdo, tcpc->config->snk_pdo,
3527 tcpc->config->nr_snk_pdo);
3528 port->nr_snk_vdo = tcpm_copy_vdos(port->snk_vdo, tcpc->config->snk_vdo,
3529 tcpc->config->nr_snk_vdo);
3531 port->max_snk_mv = tcpc->config->max_snk_mv;
3532 port->max_snk_ma = tcpc->config->max_snk_ma;
3533 port->max_snk_mw = tcpc->config->max_snk_mw;
3534 port->operating_snk_mw = tcpc->config->operating_snk_mw;
3535 if (!tcpc->config->try_role_hw)
3536 port->try_role = tcpc->config->default_role;
3538 port->try_role = TYPEC_NO_PREFERRED_ROLE;
3540 port->typec_caps.prefer_role = tcpc->config->default_role;
3541 port->typec_caps.type = tcpc->config->type;
3542 port->typec_caps.revision = 0x0120; /* Type-C spec release 1.2 */
3543 port->typec_caps.pd_revision = 0x0200; /* USB-PD spec release 2.0 */
3544 port->typec_caps.dr_set = tcpm_dr_set;
3545 port->typec_caps.pr_set = tcpm_pr_set;
3546 port->typec_caps.vconn_set = tcpm_vconn_set;
3547 port->typec_caps.try_role = tcpm_try_role;
3548 port->typec_caps.port_type_set = tcpm_port_type_set;
3550 port->partner_desc.identity = &port->partner_ident;
3551 port->port_type = tcpc->config->type;
3553 port->typec_port = typec_register_port(port->dev, &port->typec_caps);
3554 if (!port->typec_port) {
3556 goto out_destroy_wq;
3559 if (tcpc->config->alt_modes) {
3560 const struct typec_altmode_desc *paltmode = tcpc->config->alt_modes;
3563 while (paltmode->svid && i < ARRAY_SIZE(port->port_altmode)) {
3564 port->port_altmode[i] =
3565 typec_port_register_altmode(port->typec_port,
3567 if (!port->port_altmode[i]) {
3569 "%s: failed to register port alternate mode 0x%x",
3570 dev_name(dev), paltmode->svid);
3578 tcpm_debugfs_init(port);
3579 mutex_lock(&port->lock);
3581 mutex_unlock(&port->lock);
3583 tcpm_log(port, "%s: registered", dev_name(dev));
3587 destroy_workqueue(port->wq);
3588 return ERR_PTR(err);
3590 EXPORT_SYMBOL_GPL(tcpm_register_port);
3592 void tcpm_unregister_port(struct tcpm_port *port)
3596 tcpm_reset_port(port);
3597 for (i = 0; i < ARRAY_SIZE(port->port_altmode); i++)
3598 typec_unregister_altmode(port->port_altmode[i]);
3599 typec_unregister_port(port->typec_port);
3600 tcpm_debugfs_exit(port);
3601 destroy_workqueue(port->wq);
3603 EXPORT_SYMBOL_GPL(tcpm_unregister_port);
3606 MODULE_DESCRIPTION("USB Type-C Port Manager");
3607 MODULE_LICENSE("GPL");