Received: by 2002:a05:6358:d09b:b0:dc:cd0c:909e with SMTP id jc27csp1831786rwb; Thu, 8 Dec 2022 16:11:51 -0800 (PST) X-Google-Smtp-Source: AA0mqf5Z6O7Oy1t9+jnY/0pY0nWAg4vu31ROra1XtnyWfjkJ21ZLvyUypqbUt27UA2FNKLik1GXk X-Received: by 2002:a05:6a21:358b:b0:ac:8a8e:164e with SMTP id az11-20020a056a21358b00b000ac8a8e164emr4897006pzc.41.1670544711255; Thu, 08 Dec 2022 16:11:51 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1670544711; cv=none; d=google.com; s=arc-20160816; b=eno1NpfIf8FW+SG+ukAXpgMgZrq8YmqVt73l6CqcD7ulMmqWZg3Aq5tg/qCFGNJInO QxSMreMOsEI4CyOfiIqEQLnygqhPqXyC9ALlcY8mjlvER3uh9vByvrJ10/enzu9orFH2 zEoA2gw49+PYIIFJbb/OTSKuUCC+DHpe1t08FCzPifv3Gt9p+JWc6xXGNhkll880xoQ5 UtF58kLrC/mLz7xPdlqXHzaBVYsbNaQrJ5z0jZTb6G/S/VbxLSqLd2eITJe0C/Ea6fSx 0YUYxiX0Vx1HVBziyJcc5NnEkLvGNVr5FdNYtU+Q5jl5gfczW7rwksX882LoyWuYO1SA nUVg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:in-reply-to:subject :from:references:cc:to:content-language:user-agent:mime-version:date :message-id:sender:dkim-signature; bh=ZwMNUoje7ps1V43et/DA1qFGdjA7wfo8Mcby7T8M07w=; b=t+B3ELKaHdnd7StWtTBKO7cp2l224+eYfk9Bcp95w+4SzS6GOZtsriLTYbiXsTOYlF vHHrR68AmVhyVdW5g1+5mzD+Nt1X4j2UlUZuoU63fGn60luAFdoy5Jij4Ax5FCsCxM7t RNUCtzk3kwlwPk7arVTs/tyIrQDivM6FVx13eYcJD9BIHXej0L/ft5E/WG4UCAYaR6Fp SaNE20zp6xUy2ku4BSlTSI28ADu3zpb0LgUTY9umjIpudlVPZb2DSTw7jAym6ty4Do2B M4nOzwD3or/PzxWBB6NLLhcF5MpJke7wbDacEfo8o7yJRMxdNQv6HPK2/vyoYA28M3zp EY4w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=TPBSpE6m; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id l15-20020a654c4f000000b0047701a2244esi25149427pgr.773.2022.12.08.16.11.41; Thu, 08 Dec 2022 16:11:51 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=TPBSpE6m; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230037AbiLHX5C (ORCPT + 73 others); Thu, 8 Dec 2022 18:57:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36750 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230074AbiLHX44 (ORCPT ); Thu, 8 Dec 2022 18:56:56 -0500 Received: from mail-oa1-x36.google.com (mail-oa1-x36.google.com [IPv6:2001:4860:4864:20::36]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F01D92A435; Thu, 8 Dec 2022 15:56:54 -0800 (PST) Received: by mail-oa1-x36.google.com with SMTP id 586e51a60fabf-1433ef3b61fso3742370fac.10; Thu, 08 Dec 2022 15:56:54 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:in-reply-to:subject:from:references:cc:to :content-language:user-agent:mime-version:date:message-id:sender :from:to:cc:subject:date:message-id:reply-to; bh=ZwMNUoje7ps1V43et/DA1qFGdjA7wfo8Mcby7T8M07w=; b=TPBSpE6mWzhVIt0QuFtiURqBrsXP4DTYX0pgfeCdRIJPszZ8ugCiSnxtn0AI91whYq TOKnNZq64DsfKnFBOzPdJwvL4RPzHplnMHAZFSor/YqCm5s/+LQ0Lr4C7Iy3bOY/nt+N ReVnIporrE1mAsrxju+LJMcqACkmbP8v2YNyD9ve/96t+aRyKov/CfMbt0jvRNDQF70t hNBdj3rQFg2/gp/JMBaGUl8VhePtznY9L0lq1VNoFMPpJqDch7lZ8yWjz9g0ga7q7OG+ 7yBmtETFd6ISx15SGR+s02eg0Bj4d1eLyjL5i/cdJT/n2+nSTyqnEfXQqMg1RUk9TAIQ 1/aA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:in-reply-to:subject:from:references:cc:to :content-language:user-agent:mime-version:date:message-id:sender :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=ZwMNUoje7ps1V43et/DA1qFGdjA7wfo8Mcby7T8M07w=; b=lelBcR2HI9eQSPp8U/68A1KnSgmezGTeDWh/v8ex4hRUzl/9TZhTuw3qvtWLpgRAFW uBHtDvNjlck1CCS8WN8HvffLc0N9vmYNQ+TutOWCSDEIxFpu9VXEBolBtVbBq8KIxyl6 P/expwcyE4PVdsUoFkhS0pMGaWzKqzHEa/lYa2D4BKFVPDjwGlrmXd9RKsKtsITSDzcN MPElvq72N03f5zVTDU4UT6Eb8MyUnj5UVf9kt/n9gUku4bge1XRC0K3IGq3KvQZoBhpJ RjN6/ASufXyxEitBEZrhidfPX9F/PAQEKt4q0a5dni+TGDgozYdUpSgGJt0N2wW9xq+7 MDhQ== X-Gm-Message-State: ANoB5pmCJNRwKsY9AcvC2d6Q5X3jCukySsaADbIYiqMuI+hAQu5k/bK0 ExW5pKJAM+yiVeD/oAM7Tr4= X-Received: by 2002:a05:6870:b289:b0:144:c778:e94b with SMTP id c9-20020a056870b28900b00144c778e94bmr2058239oao.32.1670543813627; Thu, 08 Dec 2022 15:56:53 -0800 (PST) Received: from ?IPV6:2600:1700:e321:62f0:329c:23ff:fee3:9d7c? ([2600:1700:e321:62f0:329c:23ff:fee3:9d7c]) by smtp.gmail.com with ESMTPSA id i6-20020a056870a68600b0013d9bd4ad2esm106046oam.12.2022.12.08.15.56.52 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Thu, 08 Dec 2022 15:56:53 -0800 (PST) Sender: Guenter Roeck Message-ID: <819cb665-ec2f-5542-8ecf-e8ff7ca29908@roeck-us.net> Date: Thu, 8 Dec 2022 15:56:51 -0800 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.4.2 Content-Language: en-US To: Badhri Jagan Sridharan , Heikki Krogerus , Greg Kroah-Hartman Cc: linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, Kyle Tso References: <20221208150456.473056-1-badhri@google.com> From: Guenter Roeck Subject: Re: [PATCH v6 1/3] usb: typec: tcpm: Add callbacks to mitigate wakeups due to contaminant In-Reply-To: <20221208150456.473056-1-badhri@google.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-1.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_EF,FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM,HEADER_FROM_DIFFERENT_DOMAINS, NICE_REPLY_A,RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 12/8/22 07:04, Badhri Jagan Sridharan wrote: > 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. > > Signed-off-by: Badhri Jagan Sridharan > --- > Changes since v5: > * Updated commit message. Removed change id. > 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(-) > > diff --git a/drivers/usb/typec/tcpm/tcpm.c b/drivers/usb/typec/tcpm/tcpm.c > index 904c7b4ce2f0..a138cea49612 100644 > --- a/drivers/usb/typec/tcpm/tcpm.c > +++ b/drivers/usb/typec/tcpm/tcpm.c > @@ -33,119 +33,6 @@ > > #include > > -#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); > + } That sets the state to TOGGLING unconditionally, even if it not currently CHECK_CONTAMINANT. Is that a potential problem ? > > 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); > diff --git a/include/linux/usb/tcpm.h b/include/linux/usb/tcpm.h > index bffc8d3e14ad..9cf16372a6e4 100644 > --- a/include/linux/usb/tcpm.h > +++ b/include/linux/usb/tcpm.h > @@ -10,6 +10,126 @@ > #include > #include "pd.h" > > +#define FOREACH_STATE(S) \ > + S(INVALID_STATE), \ > + S(TOGGLING), \ > + S(CHECK_CONTAMINANT), \ > + 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 GENERATE_ENUM(e) e > + > +enum tcpm_state { > + FOREACH_STATE(GENERATE_ENUM) > +}; > + Sorry for not bringing it up earlier; I have been struggling with it all along, and I could not decide if I should bring it up or not. I really don't feel comfortable with exporting states outside tcpm. Is this really necessary ? The only use seems to be + if ((tcpm_prev_state == SRC_ATTACH_WAIT && current_state == SRC_UNATTACHED) || + (tcpm_prev_state == SNK_ATTACH_WAIT && current_state == SNK_UNATTACHED)) Plus, of course, the CHECK_CONTAMINANT state. Is there reason to believe that the relevant state transitions would be different for other chips ? If not, would it possibly make sense to move this check into the state machine ? > enum typec_cc_status { > TYPEC_CC_OPEN, > TYPEC_CC_RA, > @@ -114,6 +234,16 @@ enum tcpm_transmit_type { > * 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. I kind of dislike the repeated checks for those callbacks in the state machine. Does it make any sense to have one of those callbacks but not the other ? Because if not it might make sense to check in the registration function if either both are NULL or both are set, and then drop most of the checks in the state machine handler. Thanks, Guenter > */ > struct tcpc_dev { > struct fwnode_handle *fwnode; > @@ -148,6 +278,8 @@ struct tcpc_dev { > bool pps_active, u32 requested_vbus_voltage); > bool (*is_vbus_vsafe0v)(struct tcpc_dev *dev); > void (*set_partner_usb_comm_capable)(struct tcpc_dev *dev, bool enable); > + void (*check_contaminant)(struct tcpc_dev *dev); > + bool (*is_potential_contaminant)(struct tcpc_dev *dev, enum tcpm_state current_state); > }; > > struct tcpm_port; > @@ -165,5 +297,6 @@ void tcpm_pd_transmit_complete(struct tcpm_port *port, > enum tcpm_transmit_status status); > void tcpm_pd_hard_reset(struct tcpm_port *port); > void tcpm_tcpc_reset(struct tcpm_port *port); > +void tcpm_port_clean(struct tcpm_port *port); > > #endif /* __LINUX_USB_TCPM_H */ > > base-commit: 1524ceb14dd5ebd6f724d993c5ec1a9a8d445d8e