[V3,08/18] usb: xhci-tegra: Add OTG support

Get usb-phy's for availbale USB 2 phys. Register id notifiers for available
usb-phy's to receive role change notifications. Perform PP for the received
role change usb ports.

Signed-off-by: Nagarjuna Kristam <nkristam@nvidia.com>
---
V3:
 - No changes in this version
---
V2:
 - Removed extra line before tegra_xusb_probe API.
---
 drivers/usb/host/xhci-tegra.c | 225 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 224 insertions(+), 1 deletion(-)

On Mon, Dec 30, 2019 at 04:39:45PM +0530, Nagarjuna Kristam wrote:
> Get usb-phy's for availbale USB 2 phys. Register id notifiers for available
> usb-phy's to receive role change notifications. Perform PP for the received
> role change usb ports.
> 
> Signed-off-by: Nagarjuna Kristam <nkristam@nvidia.com>
> ---
> V3:
>  - No changes in this version
> ---
> V2:
>  - Removed extra line before tegra_xusb_probe API.
> ---
>  drivers/usb/host/xhci-tegra.c | 225 +++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 224 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/host/xhci-tegra.c b/drivers/usb/host/xhci-tegra.c
> index 0b58ef3..22f1d36 100644
> --- a/drivers/usb/host/xhci-tegra.c
> +++ b/drivers/usb/host/xhci-tegra.c
> @@ -24,6 +24,9 @@
>  #include <linux/regulator/consumer.h>
>  #include <linux/reset.h>
>  #include <linux/slab.h>
> +#include <linux/usb/otg.h>
> +#include <linux/usb/phy.h>
> +#include <linux/usb/role.h>
>  #include <soc/tegra/pmc.h>
>  
>  #include "xhci.h"
> @@ -203,6 +206,7 @@ struct tegra_xusb_soc {
>  
>  	bool scale_ss_clock;
>  	bool has_ipfs;
> +	bool otg_reset_sspi;
>  };
>  
>  struct tegra_xusb_context {
> @@ -250,6 +254,14 @@ struct tegra_xusb {
>  	struct phy **phys;
>  	unsigned int num_phys;
>  
> +	struct usb_phy **usbphy;
> +	unsigned int num_usb_phys;
> +	int otg_usb2_port;
> +	int otg_usb3_port;
> +	bool host_mode;
> +	struct notifier_block id_nb;
> +	struct work_struct id_work;
> +
>  	/* Firmware loading related */
>  	struct {
>  		size_t size;
> @@ -1081,6 +1093,205 @@ static int tegra_xusb_enable_firmware_messages(struct tegra_xusb *tegra)
>  	return err;
>  }
>  
> +static void tegra_xhci_set_port_power(struct tegra_xusb *tegra, bool main,
> +						 bool set)
> +{
> +	struct xhci_hcd *xhci = hcd_to_xhci(tegra->hcd);
> +	struct usb_hcd *hcd = main ?  xhci->main_hcd : xhci->shared_hcd;
> +	int wait = (!main && !set) ? 1000 : 10;
> +	u16 typeReq = set ? SetPortFeature : ClearPortFeature;
> +	u16 wIndex = main ? tegra->otg_usb2_port + 1 : tegra->otg_usb3_port + 1;
> +	u32 status;
> +	u32 stat_power = main ? USB_PORT_STAT_POWER : USB_SS_PORT_STAT_POWER;
> +	u32 status_val = set ? stat_power : 0;
> +
> +	dev_dbg(tegra->dev, "%s:%s %s PP\n", __func__, set ? "set" : "clear",
> +							main ? "HS" : "SS");

Perhaps add parentheses after the first %s to make it clear that it's a
function name. Also, maybe spell out PP to make it a bit clearer what's
meant by it?

> +
> +	tegra_xhci_hc_driver.hub_control(hcd, typeReq, USB_PORT_FEAT_POWER,

Can we replace tegra_xhci_hc_driver. by hcd->driver-> here and below?
That's slightly shorter and decouples the implementation from this hard-
coded name.

> +					 wIndex, NULL, 0);
> +
> +	do {
> +		tegra_xhci_hc_driver.hub_control(hcd, GetPortStatus, 0, wIndex,
> +					(char *) &status, sizeof(status));
> +		if (status_val == (status & stat_power))
> +			break;
> +
> +		if (!main && !set)
> +			usleep_range(600, 700);
> +		else
> +			usleep_range(10, 20);
> +	} while (--wait > 0);
> +
> +	if (status_val != (status & stat_power))
> +		dev_info(tegra->dev, "failed to %s %s PP %d\n",
> +						set ? "set" : "clear",
> +						main ? "HS" : "SS", status);
> +}
> +
> +static struct phy *tegra_xusb_get_phy(struct tegra_xusb *tegra, char *name,
> +								int port)
> +{
> +	int i, phy_count = 0;

These can be unsigned int. Same elsewhere.

> +
> +	for (i = 0; i < tegra->soc->num_types; i++) {
> +		if (!strncmp(tegra->soc->phy_types[i].name, "usb2",
> +							    strlen(name)))
> +			return tegra->phys[phy_count+port];
> +
> +		phy_count += tegra->soc->phy_types[i].num;
> +	}
> +
> +	return NULL;
> +}
> +
> +static void tegra_xhci_id_work(struct work_struct *work)
> +{
> +	struct tegra_xusb *tegra = container_of(work, struct tegra_xusb,
> +						id_work);
> +	struct xhci_hcd *xhci = hcd_to_xhci(tegra->hcd);
> +	struct tegra_xusb_mbox_msg msg;
> +	struct phy *phy = tegra_xusb_get_phy(tegra, "usb2",
> +						    tegra->otg_usb2_port);
> +	u32 status;
> +	int ret;
> +
> +	dev_dbg(tegra->dev, "host mode %s\n", tegra->host_mode ? "on" : "off");
> +
> +	mutex_lock(&tegra->lock);
> +
> +	if (tegra->host_mode)
> +		phy_set_mode_ext(phy, PHY_MODE_USB_OTG, USB_ROLE_HOST);
> +	else
> +		phy_set_mode_ext(phy, PHY_MODE_USB_OTG, USB_ROLE_NONE);
> +
> +	mutex_unlock(&tegra->lock);
> +
> +	if (tegra->host_mode) {
> +		/* switch to host mode */
> +		if (tegra->otg_usb3_port >= 0) {
> +			if (tegra->soc->otg_reset_sspi) {
> +				/* set PP=0 */
> +				tegra_xhci_hc_driver.hub_control(
> +					xhci->shared_hcd, GetPortStatus,
> +					0, tegra->otg_usb3_port+1,
> +					(char *) &status, sizeof(status));
> +				if (status & USB_SS_PORT_STAT_POWER)
> +					tegra_xhci_set_port_power(tegra, false,
> +								  false);
> +
> +				/* reset OTG port SSPI */
> +				msg.cmd = MBOX_CMD_RESET_SSPI;
> +				msg.data = tegra->otg_usb3_port+1;
> +
> +				ret = tegra_xusb_mbox_send(tegra, &msg);
> +				if (ret < 0) {
> +					dev_info(tegra->dev,
> +						"failed to RESET_SSPI %d\n",
> +						ret);
> +				}
> +			}
> +
> +			tegra_xhci_set_port_power(tegra, false, true);
> +		}
> +
> +		tegra_xhci_set_port_power(tegra, true, true);
> +
> +	} else {
> +		if (tegra->otg_usb3_port >= 0)
> +			tegra_xhci_set_port_power(tegra, false, false);
> +
> +		tegra_xhci_set_port_power(tegra, true, false);
> +	}
> +}
> +
> +static int tegra_xusb_get_usb2_port(struct tegra_xusb *tegra,
> +					      struct usb_phy *usbphy)
> +{
> +	int i;
> +
> +	for (i = 0; i < tegra->num_usb_phys; i++) {
> +		if (tegra->usbphy[i] && usbphy == tegra->usbphy[i])
> +			return i;
> +	}
> +
> +	return -1;
> +}
> +
> +static int tegra_xhci_id_notify(struct notifier_block *nb,
> +					 unsigned long action, void *data)
> +{
> +	struct tegra_xusb *tegra = container_of(nb, struct tegra_xusb,
> +						    id_nb);
> +	struct usb_phy *usbphy = (struct usb_phy *)data;
> +
> +	dev_dbg(tegra->dev, "%s: action is %ld", __func__, action);
> +
> +	if ((tegra->host_mode && action == USB_ROLE_HOST) ||
> +		(!tegra->host_mode && action != USB_ROLE_HOST)) {
> +		dev_dbg(tegra->dev, "Same role(%d) received. Ignore",
> +							tegra->host_mode);
> +		return NOTIFY_OK;
> +	}
> +
> +	tegra->otg_usb2_port = tegra_xusb_get_usb2_port(tegra, usbphy);
> +	tegra->otg_usb3_port = tegra_xusb_padctl_get_usb3_companion(
> +							tegra->padctl,
> +							tegra->otg_usb2_port);
> +
> +	tegra->host_mode = (action == USB_ROLE_HOST) ? true : false;
> +
> +	schedule_work(&tegra->id_work);
> +
> +	return NOTIFY_OK;
> +}
> +
> +static int tegra_xusb_init_usb_phy(struct tegra_xusb *tegra)
> +{
> +	int i;
> +
> +	tegra->usbphy = devm_kcalloc(tegra->dev, tegra->num_usb_phys,
> +				   sizeof(*tegra->usbphy), GFP_KERNEL);
> +	if (!tegra->usbphy)
> +		return -ENOMEM;
> +
> +	INIT_WORK(&tegra->id_work, tegra_xhci_id_work);
> +	tegra->id_nb.notifier_call = tegra_xhci_id_notify;
> +
> +	for (i = 0; i < tegra->num_usb_phys; i++) {
> +		struct phy *phy = tegra_xusb_get_phy(tegra, "usb2", i);
> +
> +		if (!phy)
> +			continue;
> +
> +		tegra->usbphy[i] = devm_usb_get_phy_by_node(tegra->dev,
> +							phy->dev.of_node,
> +							&tegra->id_nb);
> +		if (!IS_ERR(tegra->usbphy[i])) {
> +			dev_dbg(tegra->dev, "usbphy-%d registered", i);
> +			otg_set_host(tegra->usbphy[i]->otg, &tegra->hcd->self);
> +		} else {
> +			/*
> +			 * usb-phy is optional, continue if its not available.
> +			 */
> +			tegra->usbphy[i] = NULL;
> +		}
> +	}
> +
> +	return 0;
> +}
> +
> +static void tegra_xusb_deinit_usb_phy(struct tegra_xusb *tegra)
> +{
> +	int i;
> +
> +	cancel_work_sync(&tegra->id_work);
> +
> +	for (i = 0; i < tegra->num_usb_phys; i++)
> +		if (tegra->usbphy[i])
> +			otg_set_host(tegra->usbphy[i]->otg, NULL);
> +}
> +
>  static int tegra_xusb_probe(struct platform_device *pdev)
>  {
>  	struct tegra_xusb *tegra;
> @@ -1254,8 +1465,11 @@ static int tegra_xusb_probe(struct platform_device *pdev)
>  		goto put_powerdomains;
>  	}
>  
> -	for (i = 0; i < tegra->soc->num_types; i++)
> +	for (i = 0; i < tegra->soc->num_types; i++) {
> +		if (!strncmp(tegra->soc->phy_types[i].name, "usb2", 4))
> +			tegra->num_usb_phys = tegra->soc->phy_types[i].num;
>  		tegra->num_phys += tegra->soc->phy_types[i].num;
> +	}
>  
>  	tegra->phys = devm_kcalloc(&pdev->dev, tegra->num_phys,
>  				   sizeof(*tegra->phys), GFP_KERNEL);
> @@ -1384,6 +1598,12 @@ static int tegra_xusb_probe(struct platform_device *pdev)
>  		goto remove_usb3;
>  	}
>  
> +	err = tegra_xusb_init_usb_phy(tegra);
> +	if (err < 0) {
> +		dev_err(&pdev->dev, "failed to Init usb-phy: %d\n", err);

s/Init/init/, s/usb-phy/USB PHY/

> +		goto remove_usb3;
> +	}
> +
>  	return 0;
>  
>  remove_usb3:
> @@ -1420,6 +1640,8 @@ static int tegra_xusb_remove(struct platform_device *pdev)
>  	struct tegra_xusb *tegra = platform_get_drvdata(pdev);
>  	struct xhci_hcd *xhci = hcd_to_xhci(tegra->hcd);
>  
> +	tegra_xusb_deinit_usb_phy(tegra);
> +
>  	usb_remove_hcd(xhci->shared_hcd);
>  	usb_put_hcd(xhci->shared_hcd);
>  	xhci->shared_hcd = NULL;
> @@ -1733,6 +1955,7 @@ static const struct tegra_xusb_soc tegra210_soc = {
>  	},
>  	.scale_ss_clock = false,
>  	.has_ipfs = true,
> +	.otg_reset_sspi = true,

I'd prefer if these were initialized to false for the other per-SoC
structures. This has the advantage of making it clear what exactly is
supported and helps clarify whether this was done on purpose or whether
it was just omitted by accident.

With the nitpicks addressed, feel free to add:

Acked-by: Thierry Reding <treding@nvidia.com>