Re: [PATCH v11 2/3] usb: typec: tcpci: Add callback for evaluating contaminant presence

[Guenter Roeck <linux@xxxxxxxxxxxx>]

On 12/23/22 02:21, Badhri Jagan Sridharan wrote:
> This change adds callback to evaluate presence of contaminant in
> the TCPCI layer.
>
> Signed-off-by: Badhri Jagan Sridharan <badhri@xxxxxxxxxx>

Reviewed-by: Guenter Roeck <linux@xxxxxxxxxxxx>

> ---
> Changes since v10:
> * None
> Changes since v9:
> * Check for presence of low level check_contaminant before installing tcpc.check_contaminant.
> Changes since v7:
> * None. Skipped versions by mistake.
> Changes since v6:
> * Removed is_potential_contaminant callback
> Changes since v5:
> * None
> 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 | 11 +++++++++++
>   include/linux/usb/tcpci.h      |  7 +++++++
>   2 files changed, 18 insertions(+)
>
> diff --git a/drivers/usb/typec/tcpm/tcpci.c b/drivers/usb/typec/tcpm/tcpci.c
> index fe781a38dc82..699539e1be06 100644
> --- a/drivers/usb/typec/tcpm/tcpci.c
> +++ b/drivers/usb/typec/tcpm/tcpci.c
> @@ -403,6 +403,14 @@ static void tcpci_frs_sourcing_vbus(struct tcpc_dev *dev)
>   		tcpci->data->frs_sourcing_vbus(tcpci, tcpci->data);
>   }
>   
> +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);
> @@ -778,6 +786,9 @@ struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data)
>   	tcpci->tcpc.frs_sourcing_vbus = tcpci_frs_sourcing_vbus;
>   	tcpci->tcpc.set_partner_usb_comm_capable = tcpci_set_partner_usb_comm_capable;
>   
> +	if (tcpci->data->check_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;
>   		tcpci->tcpc.set_auto_vbus_discharge_threshold =
> diff --git a/include/linux/usb/tcpci.h b/include/linux/usb/tcpci.h
> index 17657451c762..85e95a3251d3 100644
> --- a/include/linux/usb/tcpci.h
> +++ b/include/linux/usb/tcpci.h
> @@ -188,6 +188,12 @@ 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.
>    */
>   struct tcpci_data {
>   	struct regmap *regmap;
> @@ -204,6 +210,7 @@ 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);
>   };
>   
>   struct tcpci *tcpci_register_port(struct device *dev, struct tcpci_data *data);