usb: typec: tcpm: Add callbacks to mitigate wakeups due to contaminant
Subsystems (3)
Badhri Jagan Sridharan
maintainerPATCH v5 1/3 usb: typec: tcpm: Add callbacks to mitigate wakeups due to contaminant
On some of the TCPC implementations, when the Type-C port is exposed to contaminants, such as water, TCPC stops toggling while reporting OPEN either by the time TCPM reads CC pin status or during CC debounce window. This causes TCPM to be stuck in TOGGLING state. If TCPM is made to restart toggling, the behavior recurs causing redundant CPU wakeups till the USB-C port is free of contaminant.
[206199.287817] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.640337] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.985789] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected]
...
TCPM invokes is_potential_contaminant callback to allow low level chip drivers to monitor TCPM state machine transitions and notify TCPM when the Type-C port needs to be checked for potential contaminant presence. TCPCs which do have the needed hardware can implement the check_contaminant callback which is invoked by TCPM to evaluate for presence of contaminant. Lower level TCPC driver can restart toggling through TCPM_PORT_CLEAN event when the driver detects that USB-C port is free of contaminant.
---
Changes since v4:
* None
Changes since v3:
* None
Changes since V2:
* Offloaded tcpm from maintaining disconnect_while_debouncing logic
* to lower level maxim tcpc driver based on feedback.
--- drivers/usb/typec/tcpm/tcpm.c | 162 +++++++++------------------------- include/linux/usb/tcpm.h | 133 ++++++++++++++++++++++++++++ 2 files changed, 177 insertions(+), 118 deletions(-)
drivers/usb/typec/tcpm/tcpm.c +44 -118
@@ -33,119 +33,6 @@#include <uapi/linux/sched/types.h> -#define FOREACH_STATE (S ) \ - S(INVALID_STATE), \ - S(TOGGLING), \ - S(SRC_UNATTACHED), \ - S(SRC_ATTACH_WAIT), \ - S(SRC_ATTACHED), \ - S(SRC_STARTUP), \ - S(SRC_SEND_CAPABILITIES), \ - S(SRC_SEND_CAPABILITIES_TIMEOUT), \ - S(SRC_NEGOTIATE_CAPABILITIES), \ - S(SRC_TRANSITION_SUPPLY), \ - S(SRC_READY), \ - S(SRC_WAIT_NEW_CAPABILITIES), \ - \ - S(SNK_UNATTACHED), \ - S(SNK_ATTACH_WAIT), \ - S(SNK_DEBOUNCED), \ - S(SNK_ATTACHED), \ - S(SNK_STARTUP), \ - S(SNK_DISCOVERY), \ - S(SNK_DISCOVERY_DEBOUNCE), \ - S(SNK_DISCOVERY_DEBOUNCE_DONE), \ - S(SNK_WAIT_CAPABILITIES), \ - S(SNK_NEGOTIATE_CAPABILITIES), \ - S(SNK_NEGOTIATE_PPS_CAPABILITIES), \ - S(SNK_TRANSITION_SINK), \ - S(SNK_TRANSITION_SINK_VBUS), \ - S(SNK_READY), \ - \ - S(ACC_UNATTACHED), \ - S(DEBUG_ACC_ATTACHED), \ - S(AUDIO_ACC_ATTACHED), \ - S(AUDIO_ACC_DEBOUNCE), \ - \ - S(HARD_RESET_SEND), \ - S(HARD_RESET_START), \ - S(SRC_HARD_RESET_VBUS_OFF), \ - S(SRC_HARD_RESET_VBUS_ON), \ - S(SNK_HARD_RESET_SINK_OFF), \ - S(SNK_HARD_RESET_WAIT_VBUS), \ - S(SNK_HARD_RESET_SINK_ON), \ - \ - S(SOFT_RESET), \ - S(SRC_SOFT_RESET_WAIT_SNK_TX), \ - S(SNK_SOFT_RESET), \ - S(SOFT_RESET_SEND), \ - \ - S(DR_SWAP_ACCEPT), \ - S(DR_SWAP_SEND), \ - S(DR_SWAP_SEND_TIMEOUT), \ - S(DR_SWAP_CANCEL), \ - S(DR_SWAP_CHANGE_DR), \ - \ - S(PR_SWAP_ACCEPT), \ - S(PR_SWAP_SEND), \ - S(PR_SWAP_SEND_TIMEOUT), \ - S(PR_SWAP_CANCEL), \ - S(PR_SWAP_START), \ - S(PR_SWAP_SRC_SNK_TRANSITION_OFF), \ - S(PR_SWAP_SRC_SNK_SOURCE_OFF), \ - S(PR_SWAP_SRC_SNK_SOURCE_OFF_CC_DEBOUNCED), \ - S(PR_SWAP_SRC_SNK_SINK_ON), \ - S(PR_SWAP_SNK_SRC_SINK_OFF), \ - S(PR_SWAP_SNK_SRC_SOURCE_ON), \ - S(PR_SWAP_SNK_SRC_SOURCE_ON_VBUS_RAMPED_UP), \ - \ - S(VCONN_SWAP_ACCEPT), \ - S(VCONN_SWAP_SEND), \ - S(VCONN_SWAP_SEND_TIMEOUT), \ - S(VCONN_SWAP_CANCEL), \ - S(VCONN_SWAP_START), \ - S(VCONN_SWAP_WAIT_FOR_VCONN), \ - S(VCONN_SWAP_TURN_ON_VCONN), \ - S(VCONN_SWAP_TURN_OFF_VCONN), \ - \ - S(FR_SWAP_SEND), \ - S(FR_SWAP_SEND_TIMEOUT), \ - S(FR_SWAP_SNK_SRC_TRANSITION_TO_OFF), \ - S(FR_SWAP_SNK_SRC_NEW_SINK_READY), \ - S(FR_SWAP_SNK_SRC_SOURCE_VBUS_APPLIED), \ - S(FR_SWAP_CANCEL), \ - \ - S(SNK_TRY), \ - S(SNK_TRY_WAIT), \ - S(SNK_TRY_WAIT_DEBOUNCE), \ - S(SNK_TRY_WAIT_DEBOUNCE_CHECK_VBUS), \ - S(SRC_TRYWAIT), \ - S(SRC_TRYWAIT_DEBOUNCE), \ - S(SRC_TRYWAIT_UNATTACHED), \ - \ - S(SRC_TRY), \ - S(SRC_TRY_WAIT), \ - S(SRC_TRY_DEBOUNCE), \ - S(SNK_TRYWAIT), \ - S(SNK_TRYWAIT_DEBOUNCE), \ - S(SNK_TRYWAIT_VBUS), \ - S(BIST_RX), \ - \ - S(GET_STATUS_SEND), \ - S(GET_STATUS_SEND_TIMEOUT), \ - S(GET_PPS_STATUS_SEND), \ - S(GET_PPS_STATUS_SEND_TIMEOUT), \ - \ - S(GET_SINK_CAP), \ - S(GET_SINK_CAP_TIMEOUT), \ - \ - S(ERROR_RECOVERY), \ - S(PORT_RESET), \ - S(PORT_RESET_WAIT_OFF), \ - \ - S(AMS_START), \ - S(CHUNK_NOT_SUPP) -#define FOREACH_AMS (S ) \ S(NONE_AMS), \ S(POWER_NEGOTIATION), \
@@ -182,13 +69,8 @@S (COUNTRY_INFO ), \ S(COUNTRY_CODES) -#define GENERATE_ENUM (e) e#define GENERATE_STRING (s) #s -enum tcpm_state { - FOREACH_STATE(GENERATE_ENUM) -}; -static const char *const tcpm_states[] = {FOREACH_STATE (GENERATE_STRING ) };
@@ -249,6 +131,7 @@ enum frs_typec_current {#define TCPM_RESET_EVENT BIT(2)#define TCPM_FRS_EVENT BIT(3)#define TCPM_SOURCING_VBUS BIT(4) +#define TCPM_PORT_CLEAN BIT(5)#define LOG_BUFFER_ENTRIES 1024#define LOG_BUFFER_ENTRY_SIZE 128
@@ -483,6 +366,14 @@ struct tcpm_port {* SNK_READY for non-pd link. */ bool slow_charger_loop; + +/* +* When true indicates that the lower level drivers indicate potential presence +* of contaminant in the connector pins based on the tcpm state machine +* transitions. +*/ +bool potential_contaminant; +#ifdef CONFIG_DEBUG_FS struct dentry *dentry;struct mutex logbuffer_lock;/* log buffer access lock */
@@ -3904,15 +3795,26 @@ static void run_state_machine(struct tcpm_port *port)unsigned int msecs;enum tcpm_state upcoming_state; +if (port->tcpc->is_potential_contaminant) + port->potential_contaminant = + port->tcpc->is_potential_contaminant (port->tcpc, port->state); + port->enter_state = port->state;switch (port->state) {case TOGGLING :break ; +case CHECK_CONTAMINANT : + port->tcpc->check_contaminant (port->tcpc); +break ;/* SRC states */ case SRC_UNATTACHED :if (!port->non_pd_role_swap)tcpm_swap_complete (port, -ENOTCONN );tcpm_src_detach (port); +if (port->potential_contaminant && port->tcpc->check_contaminant) { +tcpm_set_state (port,CHECK_CONTAMINANT ,0 ); +break ; + }if (tcpm_start_toggling (port,tcpm_rp_cc (port))) {tcpm_set_state (port,TOGGLING ,0 );break ;
@@ -4150,6 +4052,10 @@ static void run_state_machine(struct tcpm_port *port)tcpm_swap_complete (port, -ENOTCONN );tcpm_pps_complete (port, -ENOTCONN );tcpm_snk_detach (port); +if (port->potential_contaminant && port->tcpc->check_contaminant) { +tcpm_set_state (port,CHECK_CONTAMINANT ,0 ); +break ; + }if (tcpm_start_toggling (port,TYPEC_CC_RD )) {tcpm_set_state (port,TOGGLING ,0 );break ;
@@ -4926,6 +4832,9 @@ static void _tcpm_cc_change(struct tcpm_port *port, enum typec_cc_status cc1,else if (tcpm_port_is_sink (port))tcpm_set_state (port,SNK_ATTACH_WAIT ,0 );break ; +case CHECK_CONTAMINANT : +/* Wait for Toggling to be resumed */ +break ;case SRC_UNATTACHED :case ACC_UNATTACHED : if (tcpm_port_is_debug(port) || tcpm_port_is_audio(port) ||
@@ -5425,6 +5334,10 @@ static void tcpm_pd_event_handler(struct kthread_work *work) port->vbus_source = true;_tcpm_pd_vbus_on (port); } +if (events &TCPM_PORT_CLEAN ) { +tcpm_log (port,"port clean" ); +tcpm_set_state (port,TOGGLING ,0 ); + }spin_lock (&port->pd_event_lock); }
@@ -5477,6 +5390,19 @@ void tcpm_sourcing_vbus(struct tcpm_port *port) }EXPORT_SYMBOL_GPL (tcpm_sourcing_vbus); +/* +* Low level tcpc drivers invoke this once the port is deemed clean to return +* the port to TOGGLING state. +*/ +void tcpm_port_clean (struct tcpm_port *port) +{ +spin_lock (&port->pd_event_lock); + port->pd_events |=TCPM_PORT_CLEAN ; +spin_unlock (&port->pd_event_lock); +kthread_queue_work (port->wq, &port->event_work); +} +EXPORT_SYMBOL_GPL (tcpm_port_clean); +static void tcpm_enable_frs_work (struct kthread_work *work) { struct tcpm_port *port = container_of(work, struct tcpm_port, enable_frs);
include/linux/usb/tcpm.h +133 -0
156 lines not on this page · raw message
base-commit: 1524ceb14dd5ebd6f724d993c5ec1a9a8d445d8e
Signature · 1 line
2.39.0.rc0.267.gcb52ba06e7-goog
Badhri Jagan Sridharan
maintainerPATCH v5 2/3 usb: typec: tcpci: Add callback for evaluating contaminant presence
This change adds callback to evaluate presence of contaminant in the TCPCI layer.
---
Changes since v4:
* None
Changes since v3:
* None
Changes since v2:
* Added tcpci_is_potential_contaminant to offload
* disconnect_while_debounce logic
--- drivers/usb/typec/tcpm/tcpci.c | 20 ++++++++++++++++++++ include/linux/usb/tcpci.h | 13 +++++++++++++ 2 files changed, 33 insertions(+)
drivers/usb/typec/tcpm/tcpci.c +20 -0
@@ -403,6 +403,24 @@ static void tcpci_frs_sourcing_vbus(struct tcpc_dev *dev) tcpci->data->frs_sourcing_vbus (tcpci, tcpci->data); } +static bool tcpci_is_potential_contaminant (struct tcpc_dev *dev,enum tcpm_state current_state) +{ +struct tcpci *tcpci =tcpc_to_tcpci (dev); + +if (tcpci->data->is_potential_contaminant) +return tcpci->data->is_potential_contaminant (tcpci, tcpci->data, current_state); + +return false; +} + +static void tcpci_check_contaminant (struct tcpc_dev *dev) +{ +struct tcpci *tcpci =tcpc_to_tcpci (dev); + +if (tcpci->data->check_contaminant) + tcpci->data->check_contaminant (tcpci, tcpci->data); +} +static int tcpci_set_bist_data (struct tcpc_dev *tcpc,bool enable) {struct tcpci *tcpci =tcpc_to_tcpci (tcpc);
@@ -777,6 +795,8 @@ struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data) tcpci->tcpc.enable_frs = tcpci_enable_frs; tcpci->tcpc.frs_sourcing_vbus = tcpci_frs_sourcing_vbus; tcpci->tcpc.set_partner_usb_comm_capable = tcpci_set_partner_usb_comm_capable; + tcpci->tcpc.is_potential_contaminant = tcpci_is_potential_contaminant; + tcpci->tcpc.check_contaminant = tcpci_check_contaminant;if (tcpci->data->auto_discharge_disconnect) { tcpci->tcpc.enable_auto_vbus_discharge = tcpci_enable_auto_vbus_discharge;
include/linux/usb/tcpci.h +13 -0
@@ -188,6 +188,16 @@ struct tcpci;* Optional; The USB Communications Capable bit indicates if port * partner is capable of communication over the USB data lines * (e.g. D+/- or SS Tx/Rx). Called to notify the status of the bit. +* @check_contaminant: +* Optional; The callback is invoked when chiplevel drivers indicated +* that the USB port needs to be checked for contaminant presence. +* Chip level drivers are expected to check for contaminant and call +* tcpm_clean_port when the port is clean to put the port back into +* toggling state. +* @is_potential_contaminant: +* Optional; TCPM invokes the callback for every TCPM state machine +* transition. Chiplevel drivers can monitor the state machine +* transitions to flag for potential contaminant presence. */ struct tcpci_data {struct regmap *regmap;
@@ -204,6 +214,9 @@ struct tcpci_data {void (*frs_sourcing_vbus)(struct tcpci *tcpci,struct tcpci_data *data);void (*set_partner_usb_comm_capable)(struct tcpci *tcpci,struct tcpci_data *data,bool capable); +void (*check_contaminant)(struct tcpci *tcpci,struct tcpci_data *data); +bool (*is_potential_contaminant)(struct tcpci *tcpci,struct tcpci_data *data, +enum tcpm_state current_state); };struct tcpci *tcpci_register_port (struct device *dev,struct tcpci_data *data);
Signature · 1 line
2.39.0.rc0.267.gcb52ba06e7-goog
Badhri Jagan Sridharan
maintainerPATCH v5 3/3 usb: typec: maxim_contaminant: Implement check_contaminant callback
In reply to Badhri Jagan SridharanMaxim TCPC has additional ADCs and low current(1ua) current source to measure the impedance of CC and SBU pins. When tcpm invokes the check_contaminant callback, Maxim TCPC measures the impedance of the CC & SBU pins and when the impedance measured is less than 1MOhm, it is assumed that USB-C port is contaminated. CC comparators are also checked to differentiate between presence of sink and contaminant. Once USB-C is deemed to be contaminated, MAXIM TCPC has additional hardware to disable normal DRP toggling cycle and enable 1ua on CC pins once every 2.4secs/4.8secs. Maxim TCPC interrupts AP once the impedance on the CC pin is above the 1MOhm threshold. The Maxim tcpc driver then signals TCPM_PORT_CLEAN to restart toggling.
Renaming tcpci_maxim.c to tcpci_maxim_core.c and moving reg read/write helper functions to the tcpci_maxim.h header file.
---
Changes since v4:
* Missed committing local changes to fix ktest robot warnings. Updated the patch in v5.
Changes since v3:
* Renamed functions and removed the unecessary EXPORT.
* Fixed ktest robot warning.
Changes since v2:
* Implemented is_potential_contaminant to offload
* disconnect_while_debouncing
Changes since v1:
* Renamed tcpci_maxim.c to tcpci_maxim_core.c and compiling tcpci_maxim_core.o with maxim_contaminant.o as a single module as suggested by Guenter Roeck
* Got rid of exporting symbols for reg read/write helper functions and moved them to header as suggested by Heikki Krogerus
* Sqashed the commit which exposed the max_tcpci_read helper functions into this one.
---
drivers/usb/typec/tcpm/Makefile | 1 +
drivers/usb/typec/tcpm/maxim_contaminant.c | 337 ++++++++++++++++++
drivers/usb/typec/tcpm/tcpci_maxim.h | 91 +++++
.../{tcpci_maxim.c => tcpci_maxim_core.c} | 78 ++--
4 files changed, 475 insertions(+), 32 deletions(-)
create mode 100644 drivers/usb/typec/tcpm/maxim_contaminant.c
create mode 100644 drivers/usb/typec/tcpm/tcpci_maxim.h
rename drivers/usb/typec/tcpm/{tcpci_maxim.c => tcpci_maxim_core.c} (89%)drivers/usb/typec/tcpm/Makefile +1 -0
@@ -8,3 +8,4 @@ obj-$(CONFIG_TYPEC_RT1711H) += tcpci_rt1711h.o obj-$(CONFIG_TYPEC_MT6360) += tcpci_mt6360.o obj-$(CONFIG_TYPEC_TCPCI_MT6370) += tcpci_mt6370.o obj-$(CONFIG_TYPEC_TCPCI_MAXIM) += tcpci_maxim.o +tcpci_maxim-y += tcpci_maxim_core.o maxim_contaminant.o
drivers/usb/typec/tcpm/maxim_contaminant.c new file +337 -0
337 lines not on this page · raw message
drivers/usb/typec/tcpm/tcpci_maxim.h new file +91 -0
91 lines not on this page · raw message
drivers/usb/typec/tcpm/tcpci_maxim_core.c renamed from drivers/usb/typec/tcpm/tcpci_maxim.c +46 -32
118 lines not on this page · raw message
Signature · 1 line
2.39.0.rc0.267.gcb52ba06e7-goog
Greg Kroah-Hartman
maintainerQuoted 20 lines · Badhri Jagan Sridharan
On some of the TCPC implementations, when the Type-C port is exposed to contaminants, such as water, TCPC stops toggling while reporting OPEN either by the time TCPM reads CC pin status or during CC debounce window. This causes TCPM to be stuck in TOGGLING state. If TCPM is made to restart toggling, the behavior recurs causing redundant CPU wakeups till the USB-C port is free of contaminant.
[206199.287817] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.640337] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.985789] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected]...
TCPM invokes
is_potential_contaminantcallback to allow low level chip drivers to monitor TCPM state machine transitions and notify TCPM when the Type-C port needs to be checked for potential contaminant presence. TCPCs which do have the needed hardware can implement thecheck_contaminantcallback which is invoked by TCPM to evaluate for presence of contaminant. Lower level TCPC driver can restart toggling throughTCPM_PORT_CLEANevent when the driver detects that USB-C port is free of contaminant.
Quoted 3 lines
Signed-off-by Badhri Jagan Sridharan <[email protected]>Change-Id I136d788bb46d871d12e64bd73fd50a77b4659dbf---
Always run checkpatch.pl on your patches so you don't get a grumpy maintainer asking why you didn't run checkpatch.pl on your patches :(
Badhri Jagan Sridharan
maintainerApologies ! fixed it in Version 6.
Quoted 28 lines · Greg Kroah-Hartman
Quoted 20 lines · Badhri Jagan Sridharan
On some of the TCPC implementations, when the Type-C port is exposed to contaminants, such as water, TCPC stops toggling while reporting OPEN either by the time TCPM reads CC pin status or during CC debounce window. This causes TCPM to be stuck in TOGGLING state. If TCPM is made to restart toggling, the behavior recurs causing redundant CPU wakeups till the USB-C port is free of contaminant.
[206199.287817] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.640337] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected] [206199.985789] CC1: 0 -> 0, CC2: 0 -> 0 [state TOGGLING, polarity 0, disconnected]...
TCPM invokes
is_potential_contaminantcallback to allow low level chip drivers to monitor TCPM state machine transitions and notify TCPM when the Type-C port needs to be checked for potential contaminant presence. TCPCs which do have the needed hardware can implement thecheck_contaminantcallback which is invoked by TCPM to evaluate for presence of contaminant. Lower level TCPC driver can restart toggling throughTCPM_PORT_CLEANevent when the driver detects that USB-C port is free of contaminant.Quoted 3 lines
Signed-off-by Badhri Jagan Sridharan <[email protected]>Change-Id I136d788bb46d871d12e64bd73fd50a77b4659dbf---
Always run checkpatch.pl on your patches so you don't get a grumpy maintainer asking why you didn't run checkpatch.pl on your patches :(