| Message ID | 20200914112716.2.I7c9a1f1d6ced41dd8310e8a03da666a32364e790@changeid (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [1/2] dt-bindings: usb: Add binding for onboard USB hubs | expand |
Hi, I just noticed that building this results in a compilation error, due to a missing brace. I tested this patch, but with another patch on top with debug logs, the other patch adds the brace. I'll still hold off a bit before sending v2, for if others have comments. On Mon, Sep 14, 2020 at 11:27:49AM -0700, Matthias Kaehlcke wrote: > diff --git a/drivers/usb/misc/onboard_usb_hub.c b/drivers/usb/misc/onboard_usb_hub.c > new file mode 100644 > index 000000000000..e5a816d0b124 > --- /dev/null > +++ b/drivers/usb/misc/onboard_usb_hub.c > > +static int onboard_hub_suspend(struct platform_device *pdev, pm_message_t msg) > +{ > + struct onboard_hub *hub = dev_get_drvdata(&pdev->dev); > + int rc = 0; > + > + if (!hub->cfg.power_off_in_suspend) > + return 0; > + > + hub->has_wakeup_capable_descendants = false; > + > + if (hub->cfg.wakeup_source) { > + struct udev_node *node; > + > + mutex_lock(&hub->lock); > + > + list_for_each_entry(node, &hub->udev_list, list) { > + if (usb_wakeup_enabled_descendants(node->udev)) { > + hub->has_wakeup_capable_descendants = true; > + break; missing brace here: } > + } > + > + mutex_unlock(&hub->lock); > + } > + > + if (!hub->has_wakeup_capable_descendants) > + rc = onboard_hub_power_off(hub); > + > + return rc; > +}
On Mon, Sep 14, 2020 at 11:27:49AM -0700, Matthias Kaehlcke wrote: > The main issue this driver addresses is that a USB hub needs to be > powered before it can be discovered. For onboard hubs this is often > solved by supplying the hub with an 'always-on' regulator, which is > kind of a hack. Some onboard hubs may require further initialization > steps, like changing the state of a GPIO or enabling a clock, which > requires further hacks. This driver creates a platform device > representing the hub which performs the necessary initialization. > Currently it only supports switching on a single regulator, support > for multiple regulators or other actions can be added as needed. > Different initialization sequences can be supported based on the > compatible string. > > Besides performing the initialization the driver can be configured > to power the hub off during system suspend. This can help to extend > battery life on battery powered devices, which have no requirements > to keep the hub powered during suspend. The driver can also be > configured to leave the hub powered when a wakeup capable USB device > is connected when suspending, and keeping it powered otherwise. > > Technically the driver consists of two drivers, the platform driver > described above and a very thin USB driver that subclasses the > generic hub driver. Actually it subclasses the generic usb device driver, not the hub driver. > The purpose of this driver is to provide the > platform driver with the USB devices corresponding to the hub(s) > (a hub controller may provide multiple 'logical' hubs, e.g. one > to support USB 2.0 and another for USB 3.x). > > Co-developed-by: Ravi Chandra Sadineni <ravisadineni@chromium.org> > Signed-off-by: Ravi Chandra Sadineni <ravisadineni@chromium.org> > Signed-off-by: Matthias Kaehlcke <mka@chromium.org> > --- > This is an evolution of '[RFC] USB: misc: Add usb_hub_pwr driver' > (https://lore.kernel.org/patchwork/patch/1299239/). > > Changes in v1: > - renamed the driver to 'onboard_usb_hub' > - single file for platform and USB driver > - USB hub devices register with the platform device > - the DT includes a phandle of the platform device > - the platform device now controls when power is turned off > - the USB driver became a very thin subclass of the generic hub > driver > - enabled autosuspend support See https://marc.info/?l=linux-usb&m=159914635920888&w=2 and the accompanying submissions. You'll probably want to include those updates in your driver. Alan Stern
Hi Alan, thanks for your feedback! On Mon, Sep 14, 2020 at 04:14:03PM -0400, Alan Stern wrote: > On Mon, Sep 14, 2020 at 11:27:49AM -0700, Matthias Kaehlcke wrote: > > The main issue this driver addresses is that a USB hub needs to be > > powered before it can be discovered. For onboard hubs this is often > > solved by supplying the hub with an 'always-on' regulator, which is > > kind of a hack. Some onboard hubs may require further initialization > > steps, like changing the state of a GPIO or enabling a clock, which > > requires further hacks. This driver creates a platform device > > representing the hub which performs the necessary initialization. > > Currently it only supports switching on a single regulator, support > > for multiple regulators or other actions can be added as needed. > > Different initialization sequences can be supported based on the > > compatible string. > > > > Besides performing the initialization the driver can be configured > > to power the hub off during system suspend. This can help to extend > > battery life on battery powered devices, which have no requirements > > to keep the hub powered during suspend. The driver can also be > > configured to leave the hub powered when a wakeup capable USB device > > is connected when suspending, and keeping it powered otherwise. > > > > Technically the driver consists of two drivers, the platform driver > > described above and a very thin USB driver that subclasses the > > generic hub driver. > > Actually it subclasses the generic usb device driver, not the hub > driver. ok, I'll change it in the next version. > > The purpose of this driver is to provide the > > platform driver with the USB devices corresponding to the hub(s) > > (a hub controller may provide multiple 'logical' hubs, e.g. one > > to support USB 2.0 and another for USB 3.x). > > > > Co-developed-by: Ravi Chandra Sadineni <ravisadineni@chromium.org> > > Signed-off-by: Ravi Chandra Sadineni <ravisadineni@chromium.org> > > Signed-off-by: Matthias Kaehlcke <mka@chromium.org> > > --- > > This is an evolution of '[RFC] USB: misc: Add usb_hub_pwr driver' > > (https://lore.kernel.org/patchwork/patch/1299239/). > > > > Changes in v1: > > - renamed the driver to 'onboard_usb_hub' > > - single file for platform and USB driver > > - USB hub devices register with the platform device > > - the DT includes a phandle of the platform device > > - the platform device now controls when power is turned off > > - the USB driver became a very thin subclass of the generic hub > > driver > > - enabled autosuspend support > > See https://marc.info/?l=linux-usb&m=159914635920888&w=2 and the > accompanying submissions. You'll probably want to include those updates > in your driver. Thanks for the pointer! I'll change the driver to use pm_ptr as suggested.
On 20-09-14 11:27:49, Matthias Kaehlcke wrote: > The main issue this driver addresses is that a USB hub needs to be > powered before it can be discovered. For onboard hubs this is often > solved by supplying the hub with an 'always-on' regulator, which is > kind of a hack. Some onboard hubs may require further initialization > steps, like changing the state of a GPIO or enabling a clock, which > requires further hacks. This driver creates a platform device > representing the hub which performs the necessary initialization. > Currently it only supports switching on a single regulator, support > for multiple regulators or other actions can be added as needed. > Different initialization sequences can be supported based on the > compatible string. > > Besides performing the initialization the driver can be configured > to power the hub off during system suspend. This can help to extend > battery life on battery powered devices, which have no requirements > to keep the hub powered during suspend. The driver can also be > configured to leave the hub powered when a wakeup capable USB device > is connected when suspending, and keeping it powered otherwise. > > Technically the driver consists of two drivers, the platform driver > described above and a very thin USB driver that subclasses the > generic hub driver. The purpose of this driver is to provide the > platform driver with the USB devices corresponding to the hub(s) > (a hub controller may provide multiple 'logical' hubs, e.g. one > to support USB 2.0 and another for USB 3.x). I agree with Alan, you may change this driver to apply for generic onboard USB devices. > +static int onboard_hub_probe(struct platform_device *pdev) > +{ > + struct device *dev = &pdev->dev; > + struct onboard_hub *hub; > + > + hub = devm_kzalloc(dev, sizeof(*hub), GFP_KERNEL); > + if (!hub) > + return -ENOMEM; > + > + hub->vdd = devm_regulator_get(dev, "vdd"); > + if (IS_ERR(hub->vdd)) > + return PTR_ERR(hub->vdd); > + > + hub->dev = dev; > + mutex_init(&hub->lock); > + INIT_LIST_HEAD(&hub->udev_list); > + > + hub->cfg.power_off_in_suspend = of_property_read_bool(dev->of_node, "power-off-in-suspend"); > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, "wakeup-source"); Do you really need these two properties? If the device (and its children if existed) has wakeup enabled, you keep power in suspend, otherwise, you could close it, any exceptions? Peter > + > + dev_set_drvdata(dev, hub); > + > + return onboard_hub_power_on(hub); > +} > + > +static int onboard_hub_remove(struct platform_device *pdev) > +{ > + struct onboard_hub *hub = dev_get_drvdata(&pdev->dev); > + > + return onboard_hub_power_off(hub); > +} > + > +static const struct of_device_id onboard_hub_match[] = { > + { .compatible = "onboard-usb-hub" }, > + { .compatible = "realtek,rts5411" }, > + {} > +}; > +MODULE_DEVICE_TABLE(of, onboard_hub_match); > + > +static struct platform_driver onboard_hub_driver = { > + .probe = onboard_hub_probe, > + .remove = onboard_hub_remove, > +#ifdef CONFIG_PM > + .suspend = onboard_hub_suspend, > + .resume = onboard_hub_resume, > +#endif > + .driver = { > + .name = "onboard-usb-hub", > + .of_match_table = onboard_hub_match, > + }, > +}; > + > +/************************** USB driver **************************/ > + > +#define VENDOR_ID_REALTEK 0x0bda > + > +static struct onboard_hub *_find_onboard_hub(struct device *dev) > +{ > + const phandle *ph; > + struct device_node *np; > + struct platform_device *pdev; > + > + ph = of_get_property(dev->of_node, "hub", NULL); > + if (!ph) { > + dev_err(dev, "failed to read 'hub' property\n"); > + return ERR_PTR(-EINVAL); > + } > + > + np = of_find_node_by_phandle(be32_to_cpu(*ph)); > + if (!np) { > + dev_err(dev, "failed find device node for onboard hub\n"); > + return ERR_PTR(-EINVAL); > + } > + > + pdev = of_find_device_by_node(np); > + of_node_put(np); > + if (!pdev) > + return ERR_PTR(-EPROBE_DEFER); > + > + return dev_get_drvdata(&pdev->dev); > +} > + > +static int onboard_hub_usbdev_probe(struct usb_device *udev) > +{ > + struct device *dev = &udev->dev; > + struct onboard_hub *hub; > + > + /* ignore supported hubs without device tree node */ > + if (!dev->of_node) > + return -ENODEV; > + > + hub = _find_onboard_hub(dev); > + if (IS_ERR(hub)) > + return PTR_ERR(dev); > + > + dev_set_drvdata(dev, hub); > + > + onboard_hub_add_usbdev(hub, udev); > + > + return 0; > +} > + > +static void onboard_hub_usbdev_disconnect(struct usb_device *udev) > +{ > + struct onboard_hub *hub = dev_get_drvdata(&udev->dev); > + > + onboard_hub_remove_usbdev(hub, udev); > + > + put_device(hub->dev); > +} > + > +static const struct usb_device_id onboard_hub_id_table[] = { > + { .idVendor = VENDOR_ID_REALTEK, > + .idProduct = 0x0411, /* RTS5411 USB 3.0 */ > + .match_flags = USB_DEVICE_ID_MATCH_DEVICE }, > + { .idVendor = VENDOR_ID_REALTEK, > + .idProduct = 0x5411, /* RTS5411 USB 2.0 */ > + .match_flags = USB_DEVICE_ID_MATCH_DEVICE }, > + {}, > +}; > + > +MODULE_DEVICE_TABLE(usb, onboard_hub_id_table); > + > +static struct usb_device_driver onboard_hub_usbdev_driver = { > + > + .name = "onboard-usb-hub", > + .probe = onboard_hub_usbdev_probe, > + .disconnect = onboard_hub_usbdev_disconnect, > + .generic_subclass = 1, > + .supports_autosuspend = 1, > + .id_table = onboard_hub_id_table, > +}; > + > +/************************** Driver (de)registration **************************/ > + > +static int __init onboard_hub_init(void) > +{ > + int rc; > + > + rc = platform_driver_register(&onboard_hub_driver); > + if (rc) > + return rc; > + > + return usb_register_device_driver(&onboard_hub_usbdev_driver, THIS_MODULE); > +} > +device_initcall(onboard_hub_init); > + > +static void __exit onboard_hub_exit(void) > +{ > + usb_deregister_device_driver(&onboard_hub_usbdev_driver); > + platform_driver_unregister(&onboard_hub_driver); > +} > +module_exit(onboard_hub_exit); > + > +MODULE_AUTHOR("Matthias Kaehlcke <mka@chromium.org>"); > +MODULE_DESCRIPTION("Onboard USB Hub driver"); > +MODULE_LICENSE("GPL v2"); > -- > 2.28.0.618.gf4bc123cb7-goog >
Hi Peter, thanks for your comments! On Tue, Sep 15, 2020 at 02:55:06AM +0000, Peter Chen wrote: > On 20-09-14 11:27:49, Matthias Kaehlcke wrote: > > The main issue this driver addresses is that a USB hub needs to be > > powered before it can be discovered. For onboard hubs this is often > > solved by supplying the hub with an 'always-on' regulator, which is > > kind of a hack. Some onboard hubs may require further initialization > > steps, like changing the state of a GPIO or enabling a clock, which > > requires further hacks. This driver creates a platform device > > representing the hub which performs the necessary initialization. > > Currently it only supports switching on a single regulator, support > > for multiple regulators or other actions can be added as needed. > > Different initialization sequences can be supported based on the > > compatible string. > > > > Besides performing the initialization the driver can be configured > > to power the hub off during system suspend. This can help to extend > > battery life on battery powered devices, which have no requirements > > to keep the hub powered during suspend. The driver can also be > > configured to leave the hub powered when a wakeup capable USB device > > is connected when suspending, and keeping it powered otherwise. > > > > Technically the driver consists of two drivers, the platform driver > > described above and a very thin USB driver that subclasses the > > generic hub driver. The purpose of this driver is to provide the > > platform driver with the USB devices corresponding to the hub(s) > > (a hub controller may provide multiple 'logical' hubs, e.g. one > > to support USB 2.0 and another for USB 3.x). > > I agree with Alan, you may change this driver to apply for generic > onboard USB devices. I interpreted that Alan only corrected my terminology and didn't suggest to extend the driver to generic onboard devices. Actually I like that we now have a abstraction for a specific physical 'device', rather than the initial usb_hub_pwr/usb_hub_psupply split, which seemed a bit contrived (thanks Doug!). > > +static int onboard_hub_probe(struct platform_device *pdev) > > +{ > > + struct device *dev = &pdev->dev; > > + struct onboard_hub *hub; > > + > > + hub = devm_kzalloc(dev, sizeof(*hub), GFP_KERNEL); > > + if (!hub) > > + return -ENOMEM; > > + > > + hub->vdd = devm_regulator_get(dev, "vdd"); > > + if (IS_ERR(hub->vdd)) > > + return PTR_ERR(hub->vdd); > > + > > + hub->dev = dev; > > + mutex_init(&hub->lock); > > + INIT_LIST_HEAD(&hub->udev_list); > > + > > + hub->cfg.power_off_in_suspend = of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, "wakeup-source"); > > Do you really need these two properties? If the device (and its children > if existed) has wakeup enabled, you keep power in suspend, otherwise, > you could close it, any exceptions? That would work for my use case, but I'm not sure it's a universally good configuration. I don't have a specific USB device in mind, but you could have a device that shouldn't lose it's context during suspend or keep operating autonomously (e.g. a sensor with a large buffer collecting samples). Not sure if something like this exists in the real though. I'm not an expert, but it seems there are USB controllers with wakeup support which is always enabled. A board with such a controller then couldn't have a policy to power down the hub regardless of wakeup capable devices being connected. Thanks Matthias
> > > + hub->cfg.power_off_in_suspend = > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > +"wakeup-source"); > > > > Do you really need these two properties? If the device (and its > > children if existed) has wakeup enabled, you keep power in suspend, > > otherwise, you could close it, any exceptions? > > That would work for my use case, but I'm not sure it's a universally good > configuration. > > I don't have a specific USB device in mind, but you could have a device that > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > a sensor with a large buffer collecting samples). Not sure if something like this > exists in the real though. > > I'm not an expert, but it seems there are USB controllers with wakeup support > which is always enabled. A board with such a controller then couldn't have a > policy to power down the hub regardless of wakeup capable devices being > connected. > Whether or not it is a wakeup_source, it could get through its or its children's /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants to know it. If the onboard HUB needs to reflect wakeup signal, it should not power off its regulator. For another property power-off-in-suspend, I think it is also a user option, but not a hardware feature. If (wakeup-source || ! power-off-in-suspend) power off; else keep power; Peter
Hi Peter, On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > > + hub->cfg.power_off_in_suspend = > > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > > +"wakeup-source"); > > > > > > Do you really need these two properties? If the device (and its > > > children if existed) has wakeup enabled, you keep power in suspend, > > > otherwise, you could close it, any exceptions? > > > > That would work for my use case, but I'm not sure it's a universally good > > configuration. > > > > I don't have a specific USB device in mind, but you could have a device that > > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > > a sensor with a large buffer collecting samples). Not sure if something like this > > exists in the real though. > > > > I'm not an expert, but it seems there are USB controllers with wakeup support > > which is always enabled. A board with such a controller then couldn't have a > > policy to power down the hub regardless of wakeup capable devices being > > connected. > > > > Whether or not it is a wakeup_source, it could get through its or its children's > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > to know it. I conceptually agree, but in practice there are some conflicting details: wakeup for the hubs on my system is by default disabled, yet USB wakeup works regardless, so the flag doesn't really provide useful information. I guess we could still use it if there is no better way, but it doesn't seem ideal. Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup support. Please let me know if there is a reliable way to check if wakeup is enabled on the controller of a device. > If the onboard HUB needs to reflect wakeup signal, it should not power off its regulator. > > For another property power-off-in-suspend, I think it is also a user option, > but not a hardware feature. Ok, I think you are suggesting a sysfs attribute instead of a DT property, that sounds good to me.
On Tue, Sep 15, 2020 at 04:03:45PM -0700, Matthias Kaehlcke wrote: > Hi Peter, > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > Whether or not it is a wakeup_source, it could get through its or its children's > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > to know it. > > I conceptually agree, but in practice there are some conflicting details: > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > regardless, so the flag doesn't really provide useful information. I guess we > could still use it if there is no better way, but it doesn't seem ideal. The wakeup setting for USB hubs affects only the following events: port connect, port disconnect, and port overcurrent. It does not refer to forwarding wakeup requests from downstream USB devices; that is always enabled. So maybe your wakeup flag really is accurate and you didn't realize it. > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > support. Please let me know if there is a reliable way to check if wakeup is > enabled on the controller of a device. The host controller's sysfs wakeup setting should always be correct. If it isn't, that indicates there is a bug in the host controller driver or the corresponding platform-specific code. What driver does your system use? Alan Stern
On 20-09-15 16:03:45, Matthias Kaehlcke wrote: > Hi Peter, > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > > > > + hub->cfg.power_off_in_suspend = > > > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > > > +"wakeup-source"); > > > > > > > > Do you really need these two properties? If the device (and its > > > > children if existed) has wakeup enabled, you keep power in suspend, > > > > otherwise, you could close it, any exceptions? > > > > > > That would work for my use case, but I'm not sure it's a universally good > > > configuration. > > > > > > I don't have a specific USB device in mind, but you could have a device that > > > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > > > a sensor with a large buffer collecting samples). Not sure if something like this > > > exists in the real though. > > > > > > I'm not an expert, but it seems there are USB controllers with wakeup support > > > which is always enabled. A board with such a controller then couldn't have a > > > policy to power down the hub regardless of wakeup capable devices being > > > connected. > > > > > > > Whether or not it is a wakeup_source, it could get through its or its children's > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > to know it. > > I conceptually agree, but in practice there are some conflicting details: > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > regardless, so the flag doesn't really provide useful information. I guess we > could still use it if there is no better way, but it doesn't seem ideal. > > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > support. Please let me know if there is a reliable way to check if wakeup is > enabled on the controller of a device. Then, how could your code work, you use usb_wakeup_enabled_descendants to get if HUB or the descendants under the HUB has wakeup enabled? If you use dwc3, you need to enable xhci-plat.c's wakeup entry if your system needs xHCI connect/disconnect wakeup event. I have one pending patch to do it: https://www.spinics.net/lists/linux-usb/msg199406.html > > > If the onboard HUB needs to reflect wakeup signal, it should not power off its regulator. > > > > For another property power-off-in-suspend, I think it is also a user option, > > but not a hardware feature. > > Ok, I think you are suggesting a sysfs attribute instead of a DT property, that > sounds good to me. Yes.
Hi Peter, On Wed, Sep 16, 2020 at 08:19:07AM +0000, Peter Chen wrote: > On 20-09-15 16:03:45, Matthias Kaehlcke wrote: > > Hi Peter, > > > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > > > > > > + hub->cfg.power_off_in_suspend = > > > > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > > > > +"wakeup-source"); > > > > > > > > > > Do you really need these two properties? If the device (and its > > > > > children if existed) has wakeup enabled, you keep power in suspend, > > > > > otherwise, you could close it, any exceptions? > > > > > > > > That would work for my use case, but I'm not sure it's a universally good > > > > configuration. > > > > > > > > I don't have a specific USB device in mind, but you could have a device that > > > > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > > > > a sensor with a large buffer collecting samples). Not sure if something like this > > > > exists in the real though. > > > > > > > > I'm not an expert, but it seems there are USB controllers with wakeup support > > > > which is always enabled. A board with such a controller then couldn't have a > > > > policy to power down the hub regardless of wakeup capable devices being > > > > connected. > > > > > > > > > > Whether or not it is a wakeup_source, it could get through its or its children's > > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > > to know it. > > > > I conceptually agree, but in practice there are some conflicting details: > > > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > > regardless, so the flag doesn't really provide useful information. I guess we > > could still use it if there is no better way, but it doesn't seem ideal. > > > > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > > support. Please let me know if there is a reliable way to check if wakeup is > > enabled on the controller of a device. > > Then, how could your code work, you use usb_wakeup_enabled_descendants > to get if HUB or the descendants under the HUB has wakeup enabled? Doing just that would not allow to switch the hub off when wakeup enabled descendants are connected, which might be desirable in some configurations. > If you use dwc3, you need to enable xhci-plat.c's wakeup entry if your > system needs xHCI connect/disconnect wakeup event. I have one pending > patch to do it: > > https://www.spinics.net/lists/linux-usb/msg199406.html Thanks, my system has indeed a dwc3(-qcom) controller, your patch adds the missing wakeup entry to sysfs. So it seems your patch should solve my problem (sharp timing!), however you mention specifically the 'xHCI connect/disconnect wakeup event', so I wonder if the xHCI wakeup flag isn't applicable to other wakeup events. I know the dwc3-qcom platform device has its own wakeup flag. The driver currently enables wakeup interrupts unconditionally, I sent a patch to change that (https://lore.kernel.org/patchwork/patch/1305894/), however I now wonder if it should evaluate the xHCI wakeup flag instead of its own. Thanks Matthias
On Tue, Sep 15, 2020 at 10:14:21PM -0400, Alan Stern wrote: > On Tue, Sep 15, 2020 at 04:03:45PM -0700, Matthias Kaehlcke wrote: > > Hi Peter, > > > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > Whether or not it is a wakeup_source, it could get through its or its children's > > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > > to know it. > > > > I conceptually agree, but in practice there are some conflicting details: > > > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > > regardless, so the flag doesn't really provide useful information. I guess we > > could still use it if there is no better way, but it doesn't seem ideal. > > The wakeup setting for USB hubs affects only the following events: port > connect, port disconnect, and port overcurrent. It does not refer to > forwarding wakeup requests from downstream USB devices; that is always > enabled. So maybe your wakeup flag really is accurate and you didn't > realize it. Thanks for the clarification! > > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > > support. Please let me know if there is a reliable way to check if wakeup is > > enabled on the controller of a device. > > The host controller's sysfs wakeup setting should always be correct. If > it isn't, that indicates there is a bug in the host controller driver or > the corresponding platform-specific code. Good to know :) > What driver does your system use? The driver is dwc3-qcom, Peter pointed me to a patch he recently sent to add the missing wakeup entry (https://patchwork.kernel.org/patch/11717835/). It seems that should solve the problem, except for some confusion on my side about the wakeup flag of the xHCI device vs. that of the platform device (details in my reply to Peter).
On 20-09-16 12:16:07, Matthias Kaehlcke wrote: > Hi Peter, > > On Wed, Sep 16, 2020 at 08:19:07AM +0000, Peter Chen wrote: > > On 20-09-15 16:03:45, Matthias Kaehlcke wrote: > > > Hi Peter, > > > > > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > > > > > > > > + hub->cfg.power_off_in_suspend = > > > > > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > > > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > > > > > +"wakeup-source"); > > > > > > > > > > > > Do you really need these two properties? If the device (and its > > > > > > children if existed) has wakeup enabled, you keep power in suspend, > > > > > > otherwise, you could close it, any exceptions? > > > > > > > > > > That would work for my use case, but I'm not sure it's a universally good > > > > > configuration. > > > > > > > > > > I don't have a specific USB device in mind, but you could have a device that > > > > > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > > > > > a sensor with a large buffer collecting samples). Not sure if something like this > > > > > exists in the real though. > > > > > > > > > > I'm not an expert, but it seems there are USB controllers with wakeup support > > > > > which is always enabled. A board with such a controller then couldn't have a > > > > > policy to power down the hub regardless of wakeup capable devices being > > > > > connected. > > > > > > > > > > > > > Whether or not it is a wakeup_source, it could get through its or its children's > > > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > > > to know it. > > > > > > I conceptually agree, but in practice there are some conflicting details: > > > > > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > > > regardless, so the flag doesn't really provide useful information. I guess we > > > could still use it if there is no better way, but it doesn't seem ideal. > > > > > > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > > > support. Please let me know if there is a reliable way to check if wakeup is > > > enabled on the controller of a device. > > > > Then, how could your code work, you use usb_wakeup_enabled_descendants > > to get if HUB or the descendants under the HUB has wakeup enabled? > > Doing just that would not allow to switch the hub off when wakeup enabled > descendants are connected, which might be desirable in some configurations. > > > If you use dwc3, you need to enable xhci-plat.c's wakeup entry if your > > system needs xHCI connect/disconnect wakeup event. I have one pending > > patch to do it: > > > > https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.spinics.net%2Flists%2Flinux-usb%2Fmsg199406.html&data=02%7C01%7Cpeter.chen%40nxp.com%7C02c4cc75e26a47d0224d08d85a74f945%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637358805725394858&sdata=cjZhSmQiXVJoLsN5PjFACsLwsikH%2BeRTztPhsckJFNs%3D&reserved=0 > > Thanks, my system has indeed a dwc3(-qcom) controller, your patch adds > the missing wakeup entry to sysfs. So it seems your patch should solve > my problem (sharp timing!), however you mention specifically the 'xHCI > connect/disconnect wakeup event', so I wonder if the xHCI wakeup flag > isn't applicable to other wakeup events. I know the dwc3-qcom platform > device has its own wakeup flag. The driver currently enables wakeup > interrupts unconditionally, I sent a patch to change that > (https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.kernel.org%2Fpatchwork%2Fpatch%2F1305894%2F&data=02%7C01%7Cpeter.chen%40nxp.com%7C02c4cc75e26a47d0224d08d85a74f945%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637358805725394858&sdata=6IjiiHJql%2FW4vzDla9q3qdfiiOzOQy1Vk7ryUhKOOTc%3D&reserved=0), however I now wonder > if it should evaluate the xHCI wakeup flag instead of its own. > You may need both (glue & xhci), it depends on system design, and usually, these two kinds of wakeup setting isn't conflict.
On Thu, Sep 17, 2020 at 12:27:29AM +0000, Peter Chen wrote: > On 20-09-16 12:16:07, Matthias Kaehlcke wrote: > > Hi Peter, > > > > On Wed, Sep 16, 2020 at 08:19:07AM +0000, Peter Chen wrote: > > > On 20-09-15 16:03:45, Matthias Kaehlcke wrote: > > > > Hi Peter, > > > > > > > > On Tue, Sep 15, 2020 at 07:05:38AM +0000, Peter Chen wrote: > > > > > > > > > > > > > + hub->cfg.power_off_in_suspend = > > > > > > of_property_read_bool(dev->of_node, "power-off-in-suspend"); > > > > > > > > + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, > > > > > > > > +"wakeup-source"); > > > > > > > > > > > > > > Do you really need these two properties? If the device (and its > > > > > > > children if existed) has wakeup enabled, you keep power in suspend, > > > > > > > otherwise, you could close it, any exceptions? > > > > > > > > > > > > That would work for my use case, but I'm not sure it's a universally good > > > > > > configuration. > > > > > > > > > > > > I don't have a specific USB device in mind, but you could have a device that > > > > > > shouldn't lose it's context during suspend or keep operating autonomously (e.g. > > > > > > a sensor with a large buffer collecting samples). Not sure if something like this > > > > > > exists in the real though. > > > > > > > > > > > > I'm not an expert, but it seems there are USB controllers with wakeup support > > > > > > which is always enabled. A board with such a controller then couldn't have a > > > > > > policy to power down the hub regardless of wakeup capable devices being > > > > > > connected. > > > > > > > > > > > > > > > > Whether or not it is a wakeup_source, it could get through its or its children's > > > > > /sys/../power/wakeup value, you have already used usb_wakeup_enabled_descendants > > > > > to know it. > > > > > > > > I conceptually agree, but in practice there are some conflicting details: > > > > > > > > wakeup for the hubs on my system is by default disabled, yet USB wakeup works > > > > regardless, so the flag doesn't really provide useful information. I guess we > > > > could still use it if there is no better way, but it doesn't seem ideal. > > > > > > > > Similar for udev->bus->controller, according to sysfs it doesn't even have wakeup > > > > support. Please let me know if there is a reliable way to check if wakeup is > > > > enabled on the controller of a device. > > > > > > Then, how could your code work, you use usb_wakeup_enabled_descendants > > > to get if HUB or the descendants under the HUB has wakeup enabled? > > > > Doing just that would not allow to switch the hub off when wakeup enabled > > descendants are connected, which might be desirable in some configurations. > > > > > If you use dwc3, you need to enable xhci-plat.c's wakeup entry if your > > > system needs xHCI connect/disconnect wakeup event. I have one pending > > > patch to do it: > > > > > > https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.spinics.net%2Flists%2Flinux-usb%2Fmsg199406.html&data=02%7C01%7Cpeter.chen%40nxp.com%7C02c4cc75e26a47d0224d08d85a74f945%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637358805725394858&sdata=cjZhSmQiXVJoLsN5PjFACsLwsikH%2BeRTztPhsckJFNs%3D&reserved=0 > > > > Thanks, my system has indeed a dwc3(-qcom) controller, your patch adds > > the missing wakeup entry to sysfs. So it seems your patch should solve > > my problem (sharp timing!), however you mention specifically the 'xHCI > > connect/disconnect wakeup event', so I wonder if the xHCI wakeup flag > > isn't applicable to other wakeup events. I know the dwc3-qcom platform > > device has its own wakeup flag. The driver currently enables wakeup > > interrupts unconditionally, I sent a patch to change that > > (https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Flore.kernel.org%2Fpatchwork%2Fpatch%2F1305894%2F&data=02%7C01%7Cpeter.chen%40nxp.com%7C02c4cc75e26a47d0224d08d85a74f945%7C686ea1d3bc2b4c6fa92cd99c5c301635%7C0%7C0%7C637358805725394858&sdata=6IjiiHJql%2FW4vzDla9q3qdfiiOzOQy1Vk7ryUhKOOTc%3D&reserved=0), however I now wonder > > if it should evaluate the xHCI wakeup flag instead of its own. > > > > You may need both (glue & xhci), it depends on system design, and > usually, these two kinds of wakeup setting isn't conflict. Ok, thanks. So if I understand correctly the onboard hub driver should check the wakeup state of the xHCI to determine if remote wakeup is enabled for the controller (after all it doesn't know anything about the platform device). Wakeup might not work properly if it is disabled for the platform device, but it's the responsability of the board software/config to make sure it is enabled (possibly this could be done by making the dwc3-qcom driver understand the 'wakeup-source' property, as the xhci-mtk driver does).
> > > > > > > You may need both (glue & xhci), it depends on system design, and > > usually, these two kinds of wakeup setting isn't conflict. > > Ok, thanks. So if I understand correctly the onboard hub driver should check the > wakeup state of the xHCI to determine if remote wakeup is enabled for the > controller (after all it doesn't know anything about the platform device). > Wakeup might not work properly if it is disabled for the platform device, but it's > the responsability of the board software/config to make sure it is enabled > (possibly this could be done by making the dwc3-qcom driver understand the > 'wakeup-source' property, as the xhci-mtk driver does). No, every level should handle its own wakeup setting. You may have to do this since the USB bus and platform bus are two different buses, you should not visit device structure across the bus. And you don't need a device tree property to do it. For platform driver, you could use device_may_wakeup, for onboard hub power driver, you could use usb_wakeup_enabled_descendants since you need to cover descendants. The purpose of these two wakeup logic is different, for USB bus, it is used to tell USB devices to enable remote wakeup and do not power off its regulator; for platform bus, it is used to tell the controller to enable its wakeup setting and keep the regulator for its USB controller and USB PHY (if needed). Peter
On Thu, Sep 17, 2020 at 01:24:30AM +0000, Peter Chen wrote: > > > > > > > > > > You may need both (glue & xhci), it depends on system design, and > > > usually, these two kinds of wakeup setting isn't conflict. > > > > Ok, thanks. So if I understand correctly the onboard hub driver should check the > > wakeup state of the xHCI to determine if remote wakeup is enabled for the > > controller (after all it doesn't know anything about the platform device). > > Wakeup might not work properly if it is disabled for the platform device, but it's > > the responsability of the board software/config to make sure it is enabled > > (possibly this could be done by making the dwc3-qcom driver understand the > > 'wakeup-source' property, as the xhci-mtk driver does). > > No, every level should handle its own wakeup setting. You may have to do this since the USB bus and platform bus > are two different buses, you should not visit device structure across the bus. And you don't need a device tree property > to do it. For platform driver, you could use device_may_wakeup, for onboard hub power driver, you could use > usb_wakeup_enabled_descendants since you need to cover descendants. > > The purpose of these two wakeup logic is different, for USB bus, it is used to tell USB devices to enable remote wakeup > and do not power off its regulator; for platform bus, it is used to tell the controller to enable its wakeup setting and keep > the regulator for its USB controller and USB PHY (if needed). Sorry, I didn't express myself clearly. With the platform device I was referring to the dwc3-qcom ('glue') in this case, which could check it's own 'wakeup-source' attribute to enable wakeup at boot. The driver currently enables wakeup statically. The onboard_hub driver is agnostic of this device.
diff --git a/drivers/usb/misc/Kconfig b/drivers/usb/misc/Kconfig index 6818ea689cd9..e941244e24e5 100644 --- a/drivers/usb/misc/Kconfig +++ b/drivers/usb/misc/Kconfig @@ -275,3 +275,18 @@ config USB_CHAOSKEY To compile this driver as a module, choose M here: the module will be called chaoskey. + +config USB_ONBOARD_HUB + tristate "Onboard USB hub support" + depends on OF + help + Say Y here if you want to support onboard USB hubs. The driver + powers supported hubs on and may perform other initialization + steps. + + The driver can also switch off the power of the hub during + system suspend if it is configured accordingly. This may + reduce power consumption while the system is suspended. + + To compile this driver as a module, choose M here: the + module will be called onboard_usb_hub. diff --git a/drivers/usb/misc/Makefile b/drivers/usb/misc/Makefile index da39bddb0604..6f10a1c6f7e9 100644 --- a/drivers/usb/misc/Makefile +++ b/drivers/usb/misc/Makefile @@ -31,3 +31,4 @@ obj-$(CONFIG_USB_CHAOSKEY) += chaoskey.o obj-$(CONFIG_USB_SISUSBVGA) += sisusbvga/ obj-$(CONFIG_USB_LINK_LAYER_TEST) += lvstest.o +obj-$(CONFIG_USB_ONBOARD_HUB) += onboard_usb_hub.o diff --git a/drivers/usb/misc/onboard_usb_hub.c b/drivers/usb/misc/onboard_usb_hub.c new file mode 100644 index 000000000000..e5a816d0b124 --- /dev/null +++ b/drivers/usb/misc/onboard_usb_hub.c @@ -0,0 +1,306 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Driver for onboard USB hubs + * + * Copyright (c) 2020, Google LLC + */ + +#include <linux/init.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/of.h> +#include <linux/of_platform.h> +#include <linux/platform_device.h> +#include <linux/regulator/consumer.h> +#include <linux/suspend.h> +#include <linux/usb.h> +#include <linux/usb/hcd.h> +#include "../core/usb.h" + +/************************** Platform driver **************************/ + +struct udev_node { + struct usb_device *udev; + struct list_head list; +}; + +struct onboard_hub { + struct regulator *vdd; + struct device *dev; + struct { + bool power_off_in_suspend; + bool wakeup_source; + } cfg; + struct list_head udev_list; + struct mutex lock; + bool has_wakeup_capable_descendants; +}; + +static int onboard_hub_power_on(struct onboard_hub *hub) +{ + int err; + + err = regulator_enable(hub->vdd); + if (err) { + dev_err(hub->dev, "failed to enable regulator: %d\n", err); + return err; + } + + return 0; +} + +static int onboard_hub_power_off(struct onboard_hub *hub) +{ + int err; + + err = regulator_disable(hub->vdd); + if (err) { + dev_err(hub->dev, "failed to enable regulator: %d\n", err); + return err; + } + + return 0; +} + +#ifdef CONFIG_PM + +static int onboard_hub_suspend(struct platform_device *pdev, pm_message_t msg) +{ + struct onboard_hub *hub = dev_get_drvdata(&pdev->dev); + int rc = 0; + + if (!hub->cfg.power_off_in_suspend) + return 0; + + hub->has_wakeup_capable_descendants = false; + + if (hub->cfg.wakeup_source) { + struct udev_node *node; + + mutex_lock(&hub->lock); + + list_for_each_entry(node, &hub->udev_list, list) { + if (usb_wakeup_enabled_descendants(node->udev)) { + hub->has_wakeup_capable_descendants = true; + break; + } + + mutex_unlock(&hub->lock); + } + + if (!hub->has_wakeup_capable_descendants) + rc = onboard_hub_power_off(hub); + + return rc; +} + +static int onboard_hub_resume(struct platform_device *pdev) +{ + struct onboard_hub *hub = dev_get_drvdata(&pdev->dev); + int rc = 0; + + if (hub->cfg.power_off_in_suspend && !hub->has_wakeup_capable_descendants) + rc = onboard_hub_power_on(hub); + + return rc; +} + +#endif + +static int onboard_hub_add_usbdev(struct onboard_hub *hub, struct usb_device *udev) +{ + struct udev_node *node; + + node = devm_kzalloc(hub->dev, sizeof(*node), GFP_KERNEL); + if (!node) + return -ENOMEM; + + node->udev = udev; + + mutex_lock(&hub->lock); + list_add(&node->list, &hub->udev_list); + mutex_unlock(&hub->lock); + + return 0; +} + +static int onboard_hub_remove_usbdev(struct onboard_hub *hub, struct usb_device *udev) +{ + struct udev_node *node; + + mutex_lock(&hub->lock); + + list_for_each_entry(node, &hub->udev_list, list) { + if (node->udev == udev) { + list_del(&node->list); + devm_kfree(hub->dev, node); + break; + } + } + + mutex_unlock(&hub->lock); + + if (node == NULL) + return -EINVAL; + + return 0; +} + +static int onboard_hub_probe(struct platform_device *pdev) +{ + struct device *dev = &pdev->dev; + struct onboard_hub *hub; + + hub = devm_kzalloc(dev, sizeof(*hub), GFP_KERNEL); + if (!hub) + return -ENOMEM; + + hub->vdd = devm_regulator_get(dev, "vdd"); + if (IS_ERR(hub->vdd)) + return PTR_ERR(hub->vdd); + + hub->dev = dev; + mutex_init(&hub->lock); + INIT_LIST_HEAD(&hub->udev_list); + + hub->cfg.power_off_in_suspend = of_property_read_bool(dev->of_node, "power-off-in-suspend"); + hub->cfg.wakeup_source = of_property_read_bool(dev->of_node, "wakeup-source"); + + dev_set_drvdata(dev, hub); + + return onboard_hub_power_on(hub); +} + +static int onboard_hub_remove(struct platform_device *pdev) +{ + struct onboard_hub *hub = dev_get_drvdata(&pdev->dev); + + return onboard_hub_power_off(hub); +} + +static const struct of_device_id onboard_hub_match[] = { + { .compatible = "onboard-usb-hub" }, + { .compatible = "realtek,rts5411" }, + {} +}; +MODULE_DEVICE_TABLE(of, onboard_hub_match); + +static struct platform_driver onboard_hub_driver = { + .probe = onboard_hub_probe, + .remove = onboard_hub_remove, +#ifdef CONFIG_PM + .suspend = onboard_hub_suspend, + .resume = onboard_hub_resume, +#endif + .driver = { + .name = "onboard-usb-hub", + .of_match_table = onboard_hub_match, + }, +}; + +/************************** USB driver **************************/ + +#define VENDOR_ID_REALTEK 0x0bda + +static struct onboard_hub *_find_onboard_hub(struct device *dev) +{ + const phandle *ph; + struct device_node *np; + struct platform_device *pdev; + + ph = of_get_property(dev->of_node, "hub", NULL); + if (!ph) { + dev_err(dev, "failed to read 'hub' property\n"); + return ERR_PTR(-EINVAL); + } + + np = of_find_node_by_phandle(be32_to_cpu(*ph)); + if (!np) { + dev_err(dev, "failed find device node for onboard hub\n"); + return ERR_PTR(-EINVAL); + } + + pdev = of_find_device_by_node(np); + of_node_put(np); + if (!pdev) + return ERR_PTR(-EPROBE_DEFER); + + return dev_get_drvdata(&pdev->dev); +} + +static int onboard_hub_usbdev_probe(struct usb_device *udev) +{ + struct device *dev = &udev->dev; + struct onboard_hub *hub; + + /* ignore supported hubs without device tree node */ + if (!dev->of_node) + return -ENODEV; + + hub = _find_onboard_hub(dev); + if (IS_ERR(hub)) + return PTR_ERR(dev); + + dev_set_drvdata(dev, hub); + + onboard_hub_add_usbdev(hub, udev); + + return 0; +} + +static void onboard_hub_usbdev_disconnect(struct usb_device *udev) +{ + struct onboard_hub *hub = dev_get_drvdata(&udev->dev); + + onboard_hub_remove_usbdev(hub, udev); + + put_device(hub->dev); +} + +static const struct usb_device_id onboard_hub_id_table[] = { + { .idVendor = VENDOR_ID_REALTEK, + .idProduct = 0x0411, /* RTS5411 USB 3.0 */ + .match_flags = USB_DEVICE_ID_MATCH_DEVICE }, + { .idVendor = VENDOR_ID_REALTEK, + .idProduct = 0x5411, /* RTS5411 USB 2.0 */ + .match_flags = USB_DEVICE_ID_MATCH_DEVICE }, + {}, +}; + +MODULE_DEVICE_TABLE(usb, onboard_hub_id_table); + +static struct usb_device_driver onboard_hub_usbdev_driver = { + + .name = "onboard-usb-hub", + .probe = onboard_hub_usbdev_probe, + .disconnect = onboard_hub_usbdev_disconnect, + .generic_subclass = 1, + .supports_autosuspend = 1, + .id_table = onboard_hub_id_table, +}; + +/************************** Driver (de)registration **************************/ + +static int __init onboard_hub_init(void) +{ + int rc; + + rc = platform_driver_register(&onboard_hub_driver); + if (rc) + return rc; + + return usb_register_device_driver(&onboard_hub_usbdev_driver, THIS_MODULE); +} +device_initcall(onboard_hub_init); + +static void __exit onboard_hub_exit(void) +{ + usb_deregister_device_driver(&onboard_hub_usbdev_driver); + platform_driver_unregister(&onboard_hub_driver); +} +module_exit(onboard_hub_exit); + +MODULE_AUTHOR("Matthias Kaehlcke <mka@chromium.org>"); +MODULE_DESCRIPTION("Onboard USB Hub driver"); +MODULE_LICENSE("GPL v2");