Generic PHY Framework
Subsystems (9)
v6 cover Generic PHY Framework
Added a generic PHY framework that provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle.
This framework will be of use only to devices that uses external PHY (PHY functionality is not embedded within the controller).
The intention of creating this framework is to bring the phy drivers spread all over the Linux kernel to drivers/phy to increase code re-use and to increase code maintainability.
Comments to make PHY as bus wasn't done because PHY devices can be part of other bus and making a same device attached to multiple bus leads to bad design.
If the PHY driver has to send notification on connect/disconnect, the PHY driver should make use of the extcon framework. Using this susbsystem to use extcon framwork will have to be analysed.
Making omap-usb2 and twl4030 to use this framework is provided as a sample.
This patch series is developed on linux-next tree.
Changes from v5:
* removed the new sysfs entries as it dint have any new information other than what is already there in /sys/devices/...
* removed a bunch of APIs added to get the PHY and now only phy_get and devm_phy_get are used.
* Added new APIs to register/unregister the PHY provider. This is needed for dt boot case.
* Enabled pm runtime and incorporated the comments given by Alan Stern in a different patch series by Gautam.
* Removed the *phy_bind* API. Now the phy binding information should be passed using the platform data to the controller devices.
* Fixed a few typos.
Changes from v4:
* removed of_phy_get_with_args/devm_of_phy_get_with_args. Now the *phy providers* should use their custom implementation of of_xlate or use of_phy_xlate to get *phy instance* from *phy providers*.
* Added of_phy_xlate to be used by *phy providers* if it provides only one PHY.
* changed phy_core from having subsys_initcall to module_init.
* other minor fixes.
Changes from v3:
* Changed the return value of PHY APIs to ENOSYS
* Added APIs of_phy_get_with_args/devm_of_phy_get_with_args to support getting PHYs if the same IP implements multiple PHYs.
* modified phy_bind API so that the binding information can now be _updated_. In effect of this removed the binding information added in board files and added only in usb-musb.c. If a particular board uses a different phy binding, it can update it in board file after usb_musb_init().
* Added Documentation/devicetree/bindings/phy/phy-bindings.txt for dt binding information.
Changes from v2:
* removed phy_descriptor structure completely so changed the APIs which were taking phy_descriptor as parameters
* Added 2 more APIs *of_phy_get_byname* and *devm_of_phy_get_byname* to be used by PHY user drivers which has *phy* and *phy-names* binding in the dt data
* Fixed a few typos
* Removed phy_list and we now use class_dev_iter_init, class_dev_iter_next and class_dev_iter_exit for traversing through the phy list. (Note we still need phy_bind list and phy_bind_mutex).
* Changed the sysfs entry name from *bind* to *phy_bind*.
Changes from v1:
* Added Documentation for the PHY framework
* Added few more APIs mostly w.r.t devres
* Modified omap-usb2 and twl4030 to make use of the new framework
Did USB enumeration testing in panda and beagle.
Kishon Vijay Abraham I (9):
drivers: phy: add generic PHY framework
usb: phy: omap-usb2: use the new generic PHY framework
usb: phy: twl4030: use the new generic PHY framework
usb: phy: twl4030: twl4030 shouldn't be subsys_initcall
ARM: OMAP: USB: Add phy binding information
ARM: dts: omap: update usb_otg_hs data
usb: musb: omap2430: use the new generic PHY framework
usb: phy: omap-usb2: remove *set_suspend* callback from omap-usb2
usb: phy: twl4030-usb: remove *set_suspend* and *phy_init* ops
.../devicetree/bindings/phy/phy-bindings.txt | 66 +++ Documentation/devicetree/bindings/usb/omap-usb.txt | 5 + Documentation/devicetree/bindings/usb/usb-phy.txt | 6 + Documentation/phy.txt | 123 +++++ MAINTAINERS | 7 + arch/arm/boot/dts/omap3.dtsi | 2 + arch/arm/boot/dts/omap4.dtsi | 3 + arch/arm/boot/dts/twl4030.dtsi | 1 + arch/arm/mach-omap2/usb-musb.c | 6 +- drivers/Kconfig | 2 + drivers/Makefile | 2 + drivers/phy/Kconfig | 13 + drivers/phy/Makefile | 5 + drivers/phy/phy-core.c | 539 ++++++++++++++++++++ drivers/usb/musb/musb_core.c | 1 + drivers/usb/musb/musb_core.h | 3 + drivers/usb/musb/omap2430.c | 29 +- drivers/usb/phy/phy-omap-usb2.c | 50 +- drivers/usb/phy/phy-twl4030-usb.c | 69 +-- include/linux/phy/phy.h | 248 +++++++++ include/linux/usb/musb.h | 3 + 21 files changed, 1122 insertions(+), 61 deletions(-) create mode 100644 Documentation/devicetree/bindings/phy/phy-bindings.txt create mode 100644 Documentation/phy.txt create mode 100644 drivers/phy/Kconfig create mode 100644 drivers/phy/Makefile create mode 100644 drivers/phy/phy-core.c create mode 100644 include/linux/phy/phy.h
Signature · 1 line
1.7.10.4
PATCH v6 1/9 drivers: phy: add generic PHY framework
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.
PHY drivers should create the PHY by passing id and ops like init, exit, power_on and power_off. This framework is also pm runtime enabled.
The documentation for the generic PHY framework is added in Documentation/phy.txt and the documentation for dt binding can be found at Documentation/devicetree/bindings/phy/phy-bindings.txt
--- .../devicetree/bindings/phy/phy-bindings.txt | 66 +++ Documentation/phy.txt | 123 +++++ MAINTAINERS | 7 + drivers/Kconfig | 2 + drivers/Makefile | 2 + drivers/phy/Kconfig | 13 + drivers/phy/Makefile | 5 + drivers/phy/phy-core.c | 539 ++++++++++++++++++++ include/linux/phy/phy.h | 248 +++++++++ 9 files changed, 1005 insertions(+) create mode 100644 Documentation/devicetree/bindings/phy/phy-bindings.txt create mode 100644 Documentation/phy.txt create mode 100644 drivers/phy/Kconfig create mode 100644 drivers/phy/Makefile create mode 100644 drivers/phy/phy-core.c create mode 100644 include/linux/phy/phy.h
Documentation/devicetree/bindings/phy/phy-bindings.txt new file +66 -0
@@ -0,0 +1,66 @@ +This document explains only the device tree data binding. For general +information about PHY subsystem refer to Documentation/phy.txt + +PHY device node +=============== + +Required Properties: +#phy-cells: Number of cells in a PHY specifier; The meaning of all those + cells is defined by the binding for the phy node. The PHY + provider can use the values in cells to find the appropriate + PHY. + +For example: + +phys: phy { + compatible = "xxx"; + reg = <...>; + . + . + #phy-cells = <1>; + . + . +}; + +That node describes an IP block (PHY provider) that implements 2 different PHYs. +In order to differentiate between these 2 PHYs, an additonal specifier should be +given while trying to get a reference to it. + +PHY user node +============= + +Required Properties: +phys : the phandle for the PHY device (used by the PHY subsystem) +phy-names : the names of the PHY corresponding to the PHYs present in the + *phys* phandle + +Example 1: +usb1: usb_otg_ss at xxx { + compatible = "xxx"; + reg = <xxx>; + . + . + phys = <&usb2_phy>, <&usb3_phy>; + phy-names = "usb2phy", "usb3phy"; + . + . +}; + +This node represents a controller that uses two PHYs, one for usb2 and one for +usb3. + +Example 2: +usb2: usb_otg_ss at xxx { + compatible = "xxx"; + reg = <xxx>; + . + . + phys = <&phys 1>; + phy-names = "usbphy"; + . + . +}; + +This node represents a controller that uses one of the PHYs of the PHY provider +device defined previously. Note that the phy handle has an additional specifier +"1" to differentiate between the two PHYs.
Documentation/phy.txt new file +123 -0
123 lines not on this page · raw message
MAINTAINERS +7 -0
@@ -3515,6 +3515,13 @@ S: Maintained F: include/asm-generic F: include/uapi/asm-generic +GENERIC PHY FRAMEWORK +M: Kishon Vijay Abraham I <[email protected]> +L: linux-kernel at vger.kernel.org +S: Supported +F: drivers/phy/ +F: include/linux/phy/ + GENERIC UIO DRIVER FOR PCI DEVICES M: "Michael S. Tsirkin" <[email protected]> L: kvm at vger.kernel.org
drivers/Kconfig +2 -0
@@ -166,4 +166,6 @@ source "drivers/ipack/Kconfig" source "drivers/reset/Kconfig" +source "drivers/phy/Kconfig" + endmenu
drivers/Makefile +2 -0
@@ -8,6 +8,8 @@ obj-y += irqchip/ obj-y += bus/ +obj-y += phy/ + # GPIO must come after pinctrl as gpios may need to mux pins etc obj-y += pinctrl/ obj-y += gpio/
drivers/phy/Kconfig new file +13 -0
@@ -0,0 +1,13 @@ +# +# PHY +# + +menuconfig GENERIC_PHY + tristate "PHY Subsystem" + help + Generic PHY support. + + This framework is designed to provide a generic interface for PHY + devices present in the kernel. This layer will have the generic + API by which phy drivers can create PHY using the phy framework and + phy users can obtain reference to the PHY.
drivers/phy/Makefile new file +5 -0
@@ -0,0 +1,5 @@ +# +# Makefile for the phy drivers. +# + +obj-$(CONFIG_GENERIC_PHY) += phy-core.o
drivers/phy/phy-core.c new file +539 -0
539 lines not on this page · raw message
include/linux/phy/phy.h new file +248 -0
248 lines not on this page · raw message
Signature · 1 line
1.7.10.4
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi Kishon,
Quoted 5 lines · Kishon Vijay Abraham I
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.
Quoted 8 lines
PHY drivers should create the PHY by passing id and ops like init, exit,
power_onandpower_off. This framework is also pm runtime enabled.The documentation for the generic PHY framework is added in
Documentation/phy.txtand the documentation for dt binding can be found atDocumentation/devicetree/bindings/phy/phy-bindings.txtSigned-off-by Kishon Vijay Abraham I<[email protected]>
Thanks for working on this. For the record, I plan to give this a try in the end of this week, with my simple MIPI CSI/DSI PHY driver. I might have some more comments then. For now just couple of remarks after reading the documentation.
Quoted 99 lines
--- .../devicetree/bindings/phy/phy-bindings.txt | 66 +++ Documentation/phy.txt | 123 +++++ MAINTAINERS | 7 + drivers/Kconfig | 2 + drivers/Makefile | 2 + drivers/phy/Kconfig | 13 + drivers/phy/Makefile | 5 + drivers/phy/phy-core.c | 539 ++++++++++++++++++++ include/linux/phy/phy.h | 248 +++++++++ 9 files changed, 1005 insertions(+)create mode 100644
Documentation/devicetree/bindings/phy/phy-bindings.txtcreate mode 100644Documentation/phy.txt
create mode 100644drivers/phy/Kconfig
create mode 100644drivers/phy/Makefile
create mode 100644drivers/phy/phy-core.c
create mode 100644include/linux/phy/phy.hDocumentation/devicetree/bindings/phy/phy-bindings.txt new file +66
-0@@ -0,0 +1,66 @@ +This document explains only the device tree data binding. For general +information about PHY subsystem refer to Documentation/phy.txt + +PHY device node +=============== + +Required Properties: +#phy-cells: Number of cells in a PHY specifier; The meaning of all those + cells is defined by the binding for the phy node. The PHY + provider can use the values in cells to find the appropriate + PHY. + +For example: + +phys: phy { + compatible = "xxx"; + reg =<...>; + . + . + #phy-cells =<1>; + . + . +}; + +That node describes an IP block (PHY provider) that implements 2 different PHYs. +In order to differentiate between these 2 PHYs, an additonal specifier should be +given while trying to get a reference to it. + +PHY user node +============= + +Required Properties: +phys : the phandle for the PHY device (used by the PHY subsystem) +phy-names : the names of the PHY corresponding to the PHYs present in the + *phys* phandle + +Example 1: +usb1: usb_otg_ss at xxx { + compatible = "xxx"; + reg =<xxx>; + . + . + phys =<&usb2_phy>,<&usb3_phy>; + phy-names = "usb2phy", "usb3phy"; + . + . +}; + +This node represents a controller that uses two PHYs, one for usb2 and one for +usb3. + +Example 2: +usb2: usb_otg_ss at xxx { + compatible = "xxx"; + reg =<xxx>; + . + . + phys =<&phys 1>; + phy-names = "usbphy"; + . + . +}; + +This node represents a controller that uses one of the PHYs of the PHY provider +device defined previously. Note that the phy handle has an additional specifier +"1" to differentiate between the two PHYs.Documentation/phy.txt new file +3
-0@@ -0,0 +1,123 @@ + PHY SUBSYSTEM + Kishon Vijay Abraham I<[email protected]> +
Documentation/phy.txt line 13
Quoted 10 lines
Documentation/phy.txt new file +10
-0+This document explains the Generic PHY Framework along with the APIs provided, +and how-to-use. + +1. Introduction + +*PHY* is the abbreviation for physical layer. It is used to connect a device +to the physical medium e.g., the USB controller has a PHY to provide functions +such as serialization, de-serialization, encoding, decoding and is responsible +for obtaining the required data transmission rate. Note that some USB +controller has PHY functionality embedded into it and others use an external
"Note that some USB
controllers have PHY functionality embedded into them..." ?
Documentation/phy.txt line 14
Quoted 1 line
Documentation/phy.txt new file +1
-0+PHY. Other peripherals that uses a PHY include Wireless LAN, Ethernet,
s/uses/use ?
Documentation/phy.txt line 17
Quoted 3 lines
Documentation/phy.txt new file +3
-0+SATA etc. + +The intention of creating this framework is to bring the phy drivers spread
s/phy/PHY ?
Documentation/phy.txt line 21
Quoted 4 lines
Documentation/phy.txt new file +4
-0+all over the Linux kernel to drivers/phy to increase code re-use and for +better code maintainability. + +This framework will be of use only to devices that uses external PHY (PHY
s/that uses/that use ?
Documentation/phy.txt line 24
Quoted 3 lines
Documentation/phy.txt new file +3
-0+functionality is not embedded within the controller). + +2. Registering/UnRegistering the PHY provider
s/UnRegistering/Unregistering ?
Documentation/phy.txt line 30
Quoted 6 lines
Documentation/phy.txt new file +6
-0+ +PHY provider refers to an entity that implements one or more PHY instances. +For the simple case where the PHY provider implements only a single instance of +the PHY, the framework provides its own implementation of of_xlate in +of_phy_simple_xlate. If the PHY provider implements multiple instances, it +should provide it's own implementation of of_xlate. of_xlate is used only for
s/it's/its
Quoted 37 lines
Documentation/phy.txt new file +37
-0+dt boot case. + +struct phy_provider *of_phy_provider_register(struct device *dev, + struct module *owner, struct phy * (*of_xlate)(struct device *dev, + struct of_phandle_args *args)); +struct phy_provider *devm_of_phy_provider_register(struct device *dev, + struct module *owner, struct phy * (*of_xlate)(struct device *dev, + struct of_phandle_args *args)) + +of_phy_provider_register and devm_of_phy_provider_register can be used to +register the phy_provider and it takes device, owner and of_xlate as +arguments. For the dt boot case, all PHY providers should use one of the above +2 APIs to register the PHY provider. + +void devm_of_phy_provider_unregister(struct device *dev, + struct phy_provider *phy_provider); +void of_phy_provider_unregister(struct phy_provider *phy_provider); + +devm_of_phy_provider_unregister and of_phy_provider_unregister can be used to +unregister the PHY. + +3. Creating the PHY + +The PHY driver should create the PHY in order for other peripheral controllers +to make use of it. The PHY framework provides 2 APIs to create the PHY. + +struct phy *phy_create(struct device *dev, int id, const struct phy_ops *ops, + void *priv); +struct phy *devm_phy_create(struct device *dev, int id, + const struct phy_ops *ops, void *priv); + +The PHY drivers can use one of the above 2 APIs to create the PHY by passing +the device pointer, id, phy ops and a driver data. +phy_ops is a set of function pointers for performing PHY operations such as +init, exit, power_on and power_off. + +4. Getting a reference to the PHY
Documentation/phy.txt line 77
Quoted 10 lines
Documentation/phy.txt new file +10
-0+ +Before the controller can make use of the PHY, it has to get a reference to +it. This framework provides the following APIs to get a reference to the PHY. + +struct phy *phy_get(struct device *dev, const char *string); +struct phy *devm_phy_get(struct device *dev, const char *string); + +phy_get and devm_phy_get can be used to get the PHY. In the case of dt boot, +the string arguments should contain the phy name as given in the dt data and +in the case of non-dt boot, it should contain the device name of the PHY.
How about allowing null strings ? At least it seems not difficult for dt boot.
But there would have been some asymmetry, for non-dt an error would have to be returned when the passed string is null.
Documentation/phy.txt line 86
Quoted 9 lines
Documentation/phy.txt new file +9
-0+The only difference between the two APIs is that devm_phy_get associates the +device with the PHY using devres on successful PHY get. On driver detach, +release function is invoked on the the devres data and devres data is freed. + +5. Releasing a reference to the PHY + +When the controller no longer needs the PHY, it has to release the reference +to the PHY it has obtained using the APIs mentioned in the above section. The +PHY framework provides 2 APIS to release a reference to the PHY.
APIs ?
Quoted 5 lines
Documentation/phy.txt new file +5
-0+void phy_put(struct phy *phy); +void devm_phy_put(struct device *dev, struct phy *phy); + +Both these APIs are used to release a reference to the PHY and devm_phy_put +destroys the devres associated with this PHY.
Documentation/phy.txt line 102
Quoted 10 lines
Documentation/phy.txt new file +10
-0+ +6. Destroying the PHY + +When the driver that created the PHY is unloaded, it should destroy the PHY it +created using one of the following 2 APIs. + +void phy_destroy(struct phy *phy); +void devm_phy_destroy(struct device *dev, struct phy *phy); + +Both these APIs destroys the PHY and devm_phy_destroy destroys the devres
s/APIs destroys/APIs destroy ?
Documentation/phy.txt line 113
Quoted 11 lines
Documentation/phy.txt new file +11
-0+associated with this PHY. + +7. PM Runtime + +This subsystem is pm runtime enabled. So while creating the PHY, +pm_runtime_enable of the phy device created by this subsystem is called and +while destroying the PHY, pm_runtime_disable is called. Note that the phy +device created by this subsystem will be a child of the device that calls +phy_create (PHY provider device). + +During phy_init, the clocks are enabled by calling get_sync and the clocks are
I think, if you mean pm_runtime_get_sync(), it should be said precisely here.
Documentation/phy.txt line 114
Quoted 1 line
Documentation/phy.txt new file +1
-0+disable by calling put_sync during phy_exit. get_sync of the phy_device
Ditto.
s/disable/disabled
Documentation/phy.txt line 115
Quoted 1 line
Documentation/phy.txt new file +1
-0+created by this susbsystem will invoke get_sync of PHY provider device because
s/susbsystem/subsystem
Quoted 4 lines
Documentation/phy.txt new file +4
-0+of parent-child relationship. For all other pm operations, there are exported +APIs like phy_pm_runtime_get, phy_pm_runtime_get_sync, phy_pm_runtime_put, +phy_pm_runtime_put_sync, phy_pm_runtime_allow and phy_pm_runtime_forbid. +
Documentation/phy.txt
Quoted 10 lines
Documentation/phy.txt new file +9
-0+8. DeviceTree Binding + +The documentation for PHY dt binding can be found @ +Documentation/devicetree/bindings/phy/phy-bindings.txt +/** + * phy_release() - release the phy + * @dev: the dev member within phy + * + * when the last reference to the device is removed; it is called
s/when/When
s/removed;/removed ?
Quoted 5 lines
+ * from the embedded kobject as release method.
+ */+/**
+ * struct phy - represent the phy device
s/represent/represents ?
Documentation/phy.txt
Quoted 12 lines
+ * @dev: phy device
+ * @id: id of the phy
+ * @ops: function pointers for performing phy operations
+ */Documentation/phy.txt new file +8
-0+struct phy { + struct device dev; + int id; + const struct phy_ops *ops; +}; + +/** + * struct phy_provider - represent the phy provider
s/represent/represents ?
Quoted 4 lines
+ * @dev: phy provider device
+ * @owner: the module owner havingof_xlate
+ * @of_xlate: function pointer to obtain phy instance from phy pointer
+ * @list: to maintain a linked list of PHY provider
s/provider/providers ?
Documentation/phy.txt
Quoted 8 lines
+ */
Documentation/phy.txt new file +7
-0+struct phy_provider { + struct device *dev; + struct module *owner; + struct list_head list; + struct phy * (*of_xlate)(struct device *dev, + struct of_phandle_args *args); +};
Regards,
Sylwester
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi,
Quoted 17 lines · Sylwester Nawrocki
Hi Kishon,
Quoted 14 lines · Kishon Vijay Abraham I
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the
PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.PHY drivers should create the PHY by passing id and ops like init, exit,
power_onandpower_off. This framework is also pm runtime enabled.The documentation for the generic PHY framework is added in
Documentation/phy.txtand the documentation for dt binding can be found atDocumentation/devicetree/bindings/phy/phy-bindings.txt
Quoted 6 lines
Quoted 1 line
Signed-off-by Kishon Vijay Abraham I<[email protected]>Thanks for working on this. For the record, I plan to give this a try in the end of this week, with my simple MIPI CSI/DSI PHY driver. I might have some more comments then. For now just couple of remarks after reading the documentation.
Thanks for reviewing. I'll wait for your comments before posting the next version.
Thanks
Kishon
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi,
Quoted 18 lines · Kishon Vijay Abraham I
Quoted 17 lines · Sylwester Nawrocki
Quoted 17 lines · Kishon Vijay Abraham I
Quoted 15 lines
Quoted 15 lines
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the
PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.PHY drivers should create the PHY by passing id and ops like init, exit,
power_onandpower_off. This framework is also pm runtime enabled.The documentation for the generic PHY framework is added in
Documentation/phy.txtand the documentation for dt binding can be found atDocumentation/devicetree/bindings/phy/phy-bindings.txtSigned-off-by Kishon Vijay Abraham I<[email protected]>
Quoted 7 lines
Quoted 4 lines
Quoted 4 lines
Thanks for working on this. For the record, I plan to give this a try in the end of this week, with my simple MIPI CSI/DSI PHY driver. I might have some more comments then. For now just couple of remarks after reading the documentation.
Thanks for reviewing. I'll wait for your comments before posting the next version.
So I've used this API for the Exynos SoC MIPI CSI-2 and MIPI DSI DPHYs. I could remove all the local modifications, comparing to your v5, since this iteration already have what's needed, thanks! In my case the PHY provider was a platform device and so were the PHY consumer devices. Those PHYs are very simple, there is less than one register per PHY (some bits are shared across the MIPI CSI-2 receiver and MIPI DSI transmitter DPHYs), but having this generic PHY driver means, among others, there is a proper DT support. I could finally get rid of the the platform callback at arch/arm/plat-samsung/setup-mipiphy.c.
I found this code useful as is, except previous minor comments I don't really have more remarks now. This API looks quite good, and it seems much lighter comparing to the original version.
I assume, the way it is designed now, allows it to be used also with PHYs that hang off other buses, e.g. I2C.
It would be nice to get this in 3.11.
Hmm, actually I have some doubts, let me comment in other e-mail..
Regards,
Sylwester
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
In reply to Kishon Vijay Abraham IQuoted 31 lines · Kishon Vijay Abraham I
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.
PHY drivers should create the PHY by passing id and ops like init, exit,
power_onandpower_off. This framework is also pm runtime enabled.The documentation for the generic PHY framework is added in
Documentation/phy.txtand the documentation for dt binding can be found atDocumentation/devicetree/bindings/phy/phy-bindings.txtSigned-off-by Kishon Vijay Abraham I <[email protected]>--- .../devicetree/bindings/phy/phy-bindings.txt | 66 +++ Documentation/phy.txt | 123 +++++ MAINTAINERS | 7 + drivers/Kconfig | 2 + drivers/Makefile | 2 + drivers/phy/Kconfig | 13 + drivers/phy/Makefile | 5 + drivers/phy/phy-core.c | 539 ++++++++++++++++++++ include/linux/phy/phy.h | 248 +++++++++ 9 files changed, 1005 insertions(+) create mode 100644 Documentation/devicetree/bindings/phy/phy-bindings.txt create mode 100644 Documentation/phy.txt create mode 100644 drivers/phy/Kconfig create mode 100644 drivers/phy/Makefile create mode 100644 drivers/phy/phy-core.c create mode 100644 include/linux/phy/phy.h
include/linux/phy/phy.h line 165
Quoted 3 lines
include/linux/phy/phy.h new file +3
-0+static inline int phy_init (struct phy *phy) +{ +pm_runtime_get_sync (&phy->dev);
Hmm, no need to check return value here ? Also it looks a bit unexpected to possibly have runtime_resume callback of a PHY device called before ops->init() call ? It seems a bit unclear what the purpose of init() callback is.
Quoted 7 lines
include/linux/phy/phy.h new file +7
-0+if (phy->ops->init) +return phy->ops->init (phy); + +return -EINVAL ; +} + +static inline int phy_exit (struct phy *phy)
include/linux/phy/phy.h line 183
Quoted 10 lines
include/linux/phy/phy.h new file +10
-0+{ +int ret = -EINVAL ; + +if (phy->ops->exit) + ret = phy->ops->exit (phy); + +pm_runtime_put_sync (&phy->dev); + +return ret; +}
Do phy_init/phy_exit need to be mandatory ? What if there is really nothing to do in those callbacks ? Perhaps -ENOIOCTLCMD should be returned if a callback is not implemented, so PHY users can recognize such situation and proceed ?
Quoted 53 lines
include/linux/phy/phy.h new file +53
-0+static inline int phy_power_on (struct phy *phy) +{ +if (phy->ops->power_on) +return phy->ops->power_on (phy); + +return -EINVAL ; +} + +static inline int phy_power_off (struct phy *phy) +{ +if (phy->ops->power_off) +return phy->ops->power_off (phy); + +return -EINVAL ; +} + +static inline int phy_pm_runtime_get (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_get (&phy->dev); +} + +static inline int phy_pm_runtime_get_sync (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_get_sync (&phy->dev); +} + +static inline int phy_pm_runtime_put (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_put (&phy->dev); +} + +static inline int phy_pm_runtime_put_sync (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_put_sync (&phy->dev); +} + +static inline void phy_pm_runtime_allow (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return ; +
include/linux/phy/phy.h line 247
Quoted 10 lines
include/linux/phy/phy.h new file +10
-0+pm_runtime_allow (&phy->dev); +} + +static inline void phy_pm_runtime_forbid (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return ; + +pm_runtime_forbid (&phy->dev); +}
Do we need to have all these runtime PM wrappers ? I guess you intended to avoid referencing phy->dev from the PHY consumers ?
Thanks,
Sylwester
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi,
Quoted 32 lines · Sylwester Nawrocki
Quoted 30 lines · Kishon Vijay Abraham I
The PHY framework provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle. For dt-boot, the PHY drivers should also register *PHY provider* with the framework.
PHY drivers should create the PHY by passing id and ops like init, exit,
power_onandpower_off. This framework is also pm runtime enabled.The documentation for the generic PHY framework is added in
Documentation/phy.txtand the documentation for dt binding can be found atDocumentation/devicetree/bindings/phy/phy-bindings.txtSigned-off-by Kishon Vijay Abraham I <[email protected]>--- .../devicetree/bindings/phy/phy-bindings.txt | 66 +++ Documentation/phy.txt | 123 +++++ MAINTAINERS | 7 + drivers/Kconfig | 2 + drivers/Makefile | 2 + drivers/phy/Kconfig | 13 + drivers/phy/Makefile | 5 + drivers/phy/phy-core.c | 539 ++++++++++++++++++++ include/linux/phy/phy.h | 248 +++++++++ 9 files changed, 1005 insertions(+)create mode 100644
Documentation/devicetree/bindings/phy/phy-bindings.txtcreate mode 100644Documentation/phy.txt
create mode 100644drivers/phy/Kconfig
create mode 100644drivers/phy/Makefile
create mode 100644drivers/phy/phy-core.c
create mode 100644include/linux/phy/phy.h
Quoted 5 lines
include/linux/phy/phy.h line 165
Quoted 3 lines
include/linux/phy/phy.h new file +3
-0+static inline int phy_init (struct phy *phy) +{ +pm_runtime_get_sync (&phy->dev);Hmm, no need to check return value here ? Also it looks a bit unexpected to
I purposely dint check the return values in order to support platforms that don?t enable pm_runtime.
Quoted 2 lines
possibly have
runtime_resumecallback of a PHY device called beforeops->init()call ? It seems a bit unclear what the purpose ofinit()callback is.
Not really. Anything that is used to initialize the PHY (internal configuration) can go in phy_init. Usually in runtime_resume callback, optional functional clocks are enabled and also in some cases context restore is done. So it really makes sense to enable clocks/module (pm_runtime_get_sync) before doing a PHY configuration (phy_init).
Quoted 12 lines
Quoted 12 lines
include/linux/phy/phy.h new file +11
-0+if (phy->ops->init) +return phy->ops->init (phy); + +return -EINVAL ; +} + +static inline int phy_exit (struct phy *phy) +{ +int ret = -EINVAL ; + +if (phy->ops->exit)
Quoted 8 lines
include/linux/phy/phy.h line 183
Quoted 6 lines
include/linux/phy/phy.h new file +6
-0+ ret = phy->ops->exit (phy); + +pm_runtime_put_sync (&phy->dev); + +return ret; +}Do phy_init/phy_exit need to be mandatory ? What if there is really
No. phy_init/phy_exit is not mandatory at all.
Quoted 3 lines
nothing to do in those callbacks ? Perhaps
-ENOIOCTLCMDshould be returned if a callback is not implemented, so PHY users can recognize such situation and proceed ?
So currently these APIs return -EINVAL if these callbacks are not populated which is good enough IMHO.
Quoted 59 lines
Quoted 59 lines
include/linux/phy/phy.h new file +58
-0+static inline int phy_power_on (struct phy *phy) +{ +if (phy->ops->power_on) +return phy->ops->power_on (phy); + +return -EINVAL ; +} + +static inline int phy_power_off (struct phy *phy) +{ +if (phy->ops->power_off) +return phy->ops->power_off (phy); + +return -EINVAL ; +} + +static inline int phy_pm_runtime_get (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_get (&phy->dev); +} + +static inline int phy_pm_runtime_get_sync (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_get_sync (&phy->dev); +} + +static inline int phy_pm_runtime_put (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_put (&phy->dev); +} + +static inline int phy_pm_runtime_put_sync (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return -EINVAL ; + +return pm_runtime_put_sync (&phy->dev); +} + +static inline void phy_pm_runtime_allow (struct phy *phy) +{ +if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return ; + +pm_runtime_allow (&phy->dev); +} + +static inline void phy_pm_runtime_forbid (struct phy *phy) +{
Quoted 8 lines
include/linux/phy/phy.h line 247
Quoted 5 lines
include/linux/phy/phy.h new file +5
-0+if (WARN (IS_ERR (phy),"Invalid PHY reference\n" )) +return ; + +pm_runtime_forbid (&phy->dev); +}Do we need to have all these runtime PM wrappers ? I guess you intended to avoid referencing
phy->devfrom the PHY consumers ?
Yeah.. I dint want pm_runtime of phy core device to be called from PHY consumers.
Thanks
Kishon
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi,
Quoted 8 lines · Kishon Vijay Abraham I
Quoted 5 lines
include/linux/phy/phy.h line 165
Quoted 3 lines
include/linux/phy/phy.h new file +3
-0+static inline int phy_init (struct phy *phy) +{ +pm_runtime_get_sync (&phy->dev);Hmm, no need to check return value here ? Also it looks a bit unexpected to
I purposely dint check the return values in order to support platforms that don?t enable
pm_runtime.
Then I guess this should be called conditionally and any errors returned if runtime PM is enabled ? Not sure if pm_runtime_enabled() would be helpful such situation.
Quoted 8 lines
Quoted 2 lines
possibly have
runtime_resumecallback of a PHY device called beforeops->init()call ? It seems a bit unclear what the purpose ofinit()callback is.Not really. Anything that is used to initialize the PHY (internal configuration) can go in
phy_init. Usually inruntime_resumecallback, optional functional clocks are enabled and also in some cases context restore is done. So it really makes sense to enable clocks/module (pm_runtime_get_sync) before doing a PHY configuration (phy_init).
OK, that makes sense. All PHY device resources must be prepared anyway before a PHY object is registered with the PHY core.
Quoted 20 lines
Quoted 11 lines
Quoted 11 lines
include/linux/phy/phy.h new file +11
-0+if (phy->ops->init) +return phy->ops->init (phy); + +return -EINVAL ; +} + +static inline int phy_exit (struct phy *phy) +{ +int ret = -EINVAL ; + +if (phy->ops->exit)Quoted 8 lines
include/linux/phy/phy.h line 183
Quoted 6 lines
include/linux/phy/phy.h new file +6
-0+ ret = phy->ops->exit (phy); + +pm_runtime_put_sync (&phy->dev); + +return ret; +}Do phy_init/phy_exit need to be mandatory ? What if there is really
Quoted 7 lines
No. phy_init/phy_exit is not mandatory at all.
Quoted 3 lines
nothing to do in those callbacks ? Perhaps
-ENOIOCTLCMDshould be returned if a callback is not implemented, so PHY users can recognize such situation and proceed ?So currently these APIs return
-EINVALif these callbacks are not populated which is good enough IMHO.
But -EINVAL could be well returned from the callback function. Perhaps ENOTSUPP could be used instead ?
Thanks,
Sylwester
Re: [PATCH v6 1/9] drivers: phy: add generic PHY framework
Hi,
Quoted 9 lines · Sylwester Nawrocki
Hi,
Quoted 6 lines · Kishon Vijay Abraham I
Quoted 5 lines
include/linux/phy/phy.h line 165
Quoted 3 lines
include/linux/phy/phy.h new file +3
-0+static inline int phy_init (struct phy *phy) +{ +pm_runtime_get_sync (&phy->dev);Hmm, no need to check return value here ? Also it looks a bit unexpected to
Quoted 6 lines
Quoted 2 lines
I purposely dint check the return values in order to support platforms that don?t enable
pm_runtime.Then I guess this should be called conditionally and any errors returned if runtime PM is enabled ? Not sure if
pm_runtime_enabled()would be helpful such situation.
Indeed. I think it can be used.
Quoted 38 lines
Quoted 9 lines
Quoted 3 lines
possibly have
runtime_resumecallback of a PHY device called beforeops->init()call ? It seems a bit unclear what the purpose ofinit()callback is.Not really. Anything that is used to initialize the PHY (internal configuration) can go in
phy_init. Usually inruntime_resumecallback, optional functional clocks are enabled and also in some cases context restore is done. So it really makes sense to enable clocks/module (pm_runtime_get_sync) before doing a PHY configuration (phy_init).OK, that makes sense. All PHY device resources must be prepared anyway before a PHY object is registered with the PHY core.
Quoted 25 lines
Quoted 11 lines
Quoted 11 lines
include/linux/phy/phy.h new file +11
-0+if (phy->ops->init) +return phy->ops->init (phy); + +return -EINVAL ; +} + +static inline int phy_exit (struct phy *phy) +{ +int ret = -EINVAL ; + +if (phy->ops->exit)Quoted 8 lines
include/linux/phy/phy.h line 183
Quoted 6 lines
include/linux/phy/phy.h new file +6
-0+ ret = phy->ops->exit (phy); + +pm_runtime_put_sync (&phy->dev); + +return ret; +}Do phy_init/phy_exit need to be mandatory ? What if there is really
No. phy_init/phy_exit is not mandatory at all.
Quoted 3 lines
nothing to do in those callbacks ? Perhaps
-ENOIOCTLCMDshould be returned if a callback is not implemented, so PHY users can recognize such situation and proceed ?
Quoted 5 lines
Quoted 2 lines
So currently these APIs return
-EINVALif these callbacks are not populated which is good enough IMHO.But
-EINVALcould be well returned from the callback function. Perhaps ENOTSUPP could be used instead ?
hmm.. could be..
Thanks
Kishon
PATCH v6 2/9 usb: phy: omap-usb2: use the new generic PHY framework
In reply to Kishon Vijay Abraham IUsed the generic PHY framework API to create the PHY. Now the power off and power on are done in omap_usb_power_off and omap_usb_power_on respectively.
However using the old USB PHY library cannot be completely removed because OTG is intertwined with PHY and moving to the new framework will break OTG. Once we have a separate OTG state machine, we can get rid of the USB PHY library.
--- drivers/usb/phy/phy-omap-usb2.c | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)
drivers/usb/phy/phy-omap-usb2.c +36 -0
@@ -28,6 +28,7 @@#include <linux/pm_runtime.h> #include <linux/delay.h> #include <linux/usb/omap_control_usb.h> +#include <linux/phy/phy.h> /** * omap_usb2_set_comparator - links the comparator present in the sytem with
@@ -119,10 +120,36 @@ static int omap_usb2_suspend(struct usb_phy *x, int suspend)return 0 ; } +static int omap_usb_power_off (struct phy *x) +{ +struct omap_usb *phy =dev_get_drvdata (&x->dev); + +omap_control_usb_phy_power (phy->control_dev,0 ); + +return 0 ; +} + +static int omap_usb_power_on (struct phy *x) +{ +struct omap_usb *phy =dev_get_drvdata (&x->dev); + +omap_control_usb_phy_power (phy->control_dev,1 ); + +return 0 ; +} + +static struct phy_ops ops = { + .power_on = omap_usb_power_on, + .power_off = omap_usb_power_off, + .owner =THIS_MODULE , +}; +static int omap_usb2_probe (struct platform_device *pdev) {struct omap_usb *phy; +struct phy *generic_phy;struct usb_otg *otg; +struct phy_provider *phy_provider; phy =devm_kzalloc (&pdev->dev,sizeof (*phy),GFP_KERNEL );if (!phy) {
@@ -144,6 +171,15 @@ static int omap_usb2_probe(struct platform_device *pdev) phy->phy.otg = otg; phy->phy.type =USB_PHY_TYPE_USB2 ; + phy_provider =devm_of_phy_provider_register (phy->dev,THIS_MODULE , + of_phy_simple_xlate); +if (IS_ERR (phy_provider)) +return PTR_ERR (phy_provider); + + generic_phy =devm_phy_create (phy->dev,0 , &ops, phy); +if (IS_ERR (generic_phy)) +return PTR_ERR (generic_phy); + phy->control_dev =omap_get_control_dev ();if (IS_ERR (phy->control_dev)) {dev_dbg (&pdev->dev,"Failed to get control device\n" );
Signature · 1 line
1.7.10.4
PATCH v6 3/9 usb: phy: twl4030: use the new generic PHY framework
In reply to Kishon Vijay Abraham IUsed the generic PHY framework API to create the PHY. For powering on and powering off the PHY, power_on and power_off ops are used. Once the MUSB OMAP glue is adapted to the new framework, the suspend and resume ops of usb phy library will be removed.
However using the old usb phy library cannot be completely removed because otg is intertwined with phy and moving to the new framework completely will break otg. Once we have a separate otg state machine, we can get rid of the usb phy library.
--- drivers/usb/phy/phy-twl4030-usb.c | 44 +++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+)
drivers/usb/phy/phy-twl4030-usb.c +44 -0
@@ -33,6 +33,7 @@#include <linux/io.h> #include <linux/delay.h> #include <linux/usb/otg.h> +#include <linux/phy/phy.h> #include <linux/usb/musb-omap.h> #include <linux/usb/ulpi.h> #include <linux/i2c/twl.h>
@@ -431,6 +432,14 @@ static void twl4030_phy_suspend(struct twl4030_usb *twl, int controller_off)dev_dbg (twl->dev,"%s\n" , __func__); } +static int twl4030_phy_power_off (struct phy *phy) +{ +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); + +twl4030_phy_suspend (twl,0 ); +return 0 ; +} +static void __twl4030_phy_resume (struct twl4030_usb *twl) {twl4030_phy_power (twl,1 );
@@ -459,6 +468,14 @@ static void twl4030_phy_resume(struct twl4030_usb *twl) } } +static int twl4030_phy_power_on (struct phy *phy) +{ +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); + +twl4030_phy_resume (twl); +return 0 ; +} +static int twl4030_usb_ldo_init (struct twl4030_usb *twl) {/* Enable writing to power configuration registers */
@@ -609,6 +626,13 @@ static int twl4030_usb_phy_init(struct usb_phy *phy)return 0 ; } +static int twl4030_phy_init (struct phy *phy) +{ +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); + +return twl4030_usb_phy_init (&twl->phy); +} +static int twl4030_set_suspend (struct usb_phy *x,int suspend) {struct twl4030_usb *twl =phy_to_twl (x);
@@ -646,13 +670,22 @@ static int twl4030_set_host(struct usb_otg *otg, struct usb_bus *host)return 0 ; } +static const struct phy_ops ops = { + .init = twl4030_phy_init, + .power_on = twl4030_phy_power_on, + .power_off = twl4030_phy_power_off, + .owner =THIS_MODULE , +}; +static int twl4030_usb_probe (struct platform_device *pdev) {struct twl4030_usb_data *pdata = pdev->dev.platform_data;struct twl4030_usb *twl; +struct phy *phy;int status, err;struct usb_otg *otg;struct device_node *np = pdev->dev.of_node; +struct phy_provider *phy_provider; twl =devm_kzalloc (&pdev->dev,sizeof *twl,GFP_KERNEL );if (!twl)
@@ -689,6 +722,17 @@ static int twl4030_usb_probe(struct platform_device *pdev) otg->set_host = twl4030_set_host; otg->set_peripheral = twl4030_set_peripheral; + phy_provider =devm_of_phy_provider_register (twl->dev,THIS_MODULE , + of_phy_simple_xlate); +if (IS_ERR (phy_provider)) +return PTR_ERR (phy_provider); + + phy =devm_phy_create (twl->dev,0 , &ops, twl); +if (IS_ERR (phy)) { +dev_dbg (&pdev->dev,"Failed to create PHY\n" ); +return PTR_ERR (phy); + } +/* init spinlock for workqueue */ spin_lock_init (&twl->lock);
Signature · 1 line
1.7.10.4
PATCH v6 4/9 usb: phy: twl4030: twl4030 shouldn't be subsys_initcall
In reply to Kishon Vijay Abraham IChanged the inticall from subsys_initcall to module_init for twl4030-usb.
--- drivers/usb/phy/phy-twl4030-usb.c | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-)
drivers/usb/phy/phy-twl4030-usb.c +1 -11
@@ -820,17 +820,7 @@ static struct platform_driver twl4030_usb_driver = { }, }; -static int __init twl4030_usb_init (void ) -{ -return platform_driver_register (&twl4030_usb_driver); -} -subsys_initcall (twl4030_usb_init); - -static void __exit twl4030_usb_exit(void) -{ -platform_driver_unregister (&twl4030_usb_driver); -} -module_exit (twl4030_usb_exit); +module_platform_driver (twl4030_usb_driver);MODULE_ALIAS ("platform:twl4030_usb" );MODULE_AUTHOR ("Texas Instruments, Inc, Nokia Corporation" );
Signature · 1 line
1.7.10.4
PATCH v6 5/9 ARM: OMAP: USB: Add phy binding information
In reply to Kishon Vijay Abraham IIn order for controllers to get PHY in case of non dt boot, the phy binding information (phy device name) should be added in the platform data of the controller.
--- arch/arm/mach-omap2/usb-musb.c | 6 +++++- include/linux/usb/musb.h | 3 +++ 2 files changed, 8 insertions(+), 1 deletion(-)
arch/arm/mach-omap2/usb-musb.c +5 -1
@@ -85,8 +85,12 @@ void __init usb_musb_init(struct omap_musb_board_data *musb_board_data) musb_plat.mode = board_data->mode; musb_plat.extvbus = board_data->extvbus; -if (cpu_is_omap44xx ()) +if (cpu_is_omap44xx ()) { musb_plat.has_mailbox = true; + musb_plat.phy_dev_name ="omap-usb2.3.auto.0" ; + }else if (cpu_is_omap34xx ()) { + musb_plat.phy_dev_name ="twl4030_usb.0" ; + }if (soc_is_am35xx ()) { oh_name ="am35x_otg_hs" ;
include/linux/usb/musb.h +3 -0
@@ -104,6 +104,9 @@ struct musb_hdrc_platform_data {/* for clk_get() */ const char *clock; +/* phy device name */ +const char *phy_dev_name; +/* (HOST or OTG) switch VBUS on/off */ int (*set_vbus)(struct device *dev,int is_on);
Signature · 1 line
1.7.10.4
PATCH v6 6/9 ARM: dts: omap: update usb_otg_hs data
In reply to Kishon Vijay Abraham IUpdated the usb_otg_hs dt data to include the *phy* and *phy-names* binding in order for the driver to use the new generic PHY framework. Also updated the Documentation to include the binding information. The PHY binding information can be found at Documentation/devicetree/bindings/phy/phy-bindings.txt
--- Documentation/devicetree/bindings/usb/omap-usb.txt | 5 +++++ Documentation/devicetree/bindings/usb/usb-phy.txt | 6 ++++++ arch/arm/boot/dts/omap3.dtsi | 2 ++ arch/arm/boot/dts/omap4.dtsi | 3 +++ arch/arm/boot/dts/twl4030.dtsi | 1 + 5 files changed, 17 insertions(+)
Documentation/devicetree/bindings/usb/omap-usb.txt +5 -0
@@ -19,6 +19,9 @@ OMAP MUSB GLUE - power : Should be "50". This signifies the controller can supply upto 100mA when operating in host mode. - usb-phy : the phandle for the PHY device + - phys : the phandle for the PHY device (used by generic PHY framework) + - phy-names : the names of the PHY corresponding to the PHYs present in the + *phy* phandle. Optional properties: - ctrl-module : phandle of the control module this glue uses to write to
@@ -33,6 +36,8 @@ usb_otg_hs: usb_otg_hs at 4a0ab000 { num-eps = <16>; ram-bits = <12>; ctrl-module = <&omap_control_usb>; + phys = <&usb2_phy>; + phy-names = "usb2-phy"; }; Board specific device node entry
Documentation/devicetree/bindings/usb/usb-phy.txt +6 -0
@@ -5,6 +5,8 @@ OMAP USB2 PHY Required properties: - compatible: Should be "ti,omap-usb2" - reg : Address and length of the register set for the device. + - #phy-cells: determine the number of cells that should be given in the + phandle while referencing this phy. Optional properties: - ctrl-module : phandle of the control module used by PHY driver to power on
@@ -16,6 +18,7 @@ usb2phy at 4a0ad080 { compatible = "ti,omap-usb2"; reg = <0x4a0ad080 0x58>; ctrl-module = <&omap_control_usb>; + #phy-cells = <0>; }; OMAP USB3 PHY
@@ -25,6 +28,8 @@ Required properties: - reg : Address and length of the register set for the device. - reg-names: The names of the register addresses corresponding to the registers filled in "reg". + - #phy-cells: determine the number of cells that should be given in the + phandle while referencing this phy. Optional properties: - ctrl-module : phandle of the control module used by PHY driver to power on
@@ -39,4 +44,5 @@ usb3phy at 4a084400 { <0x4a084c00 0x40>; reg-names = "phy_rx", "phy_tx", "pll_ctrl"; ctrl-module = <&omap_control_usb>; + #phy-cells = <0>; };
arch/arm/boot/dts/omap3.dtsi +2 -0
@@ -520,6 +520,8 @@ interrupt-names = "mc", "dma"; ti,hwmods = "usb_otg_hs"; usb-phy = <&usb2_phy>; + phys = <&usb2_phy>; + phy-names = "usb2-phy"; multipoint = <1>; num-eps = <16>; ram-bits = <12>;
arch/arm/boot/dts/omap4.dtsi +3 -0
@@ -517,6 +517,7 @@ compatible = "ti,omap-usb2"; reg = <0x4a0ad080 0x58>; ctrl-module = <&omap_control_usb>; + #phy-cells = <0>; }; };
@@ -655,6 +656,8 @@ interrupt-names = "mc", "dma"; ti,hwmods = "usb_otg_hs"; usb-phy = <&usb2_phy>; + phys = <&usb2_phy>; + phy-names = "usb2-phy"; multipoint = <1>; num-eps = <16>; ram-bits = <12>;
arch/arm/boot/dts/twl4030.dtsi +1 -0
@@ -80,6 +80,7 @@ usb1v8-supply = <&vusb1v8>; usb3v1-supply = <&vusb3v1>; usb_mode = <1>; + #phy-cells = <0>; }; twl_pwm: pwm {
Signature · 1 line
1.7.10.4
PATCH v6 7/9 usb: musb: omap2430: use the new generic PHY framework
In reply to Kishon Vijay Abraham IUse the generic PHY framework API to get the PHY. The usb_phy_set_resume and usb_phy_set_suspend is replaced with power_on/get_sync and power_off/put_sync to align with the new PHY framework.
musb->xceiv can't be removed as of now because musb core uses xceiv.state and xceiv.otg. Once there is a separate state machine to handle otg, these can be moved out of xceiv and then we can start using the generic PHY framework.
--- drivers/usb/musb/musb_core.c | 1 + drivers/usb/musb/musb_core.h | 3 +++ drivers/usb/musb/omap2430.c | 29 +++++++++++++++++++++-------- 3 files changed, 25 insertions(+), 8 deletions(-)
drivers/usb/musb/musb_core.c +1 -0
@@ -1864,6 +1864,7 @@ musb_init_controller(struct device *dev, int nIrq, void __iomem *ctrl) musb->board_set_power = plat->set_power; musb->min_power = plat->min_power; musb->ops = plat->platform_ops; + musb->phy_dev_name = plat->phy_dev_name;/* The musb_platform_init() call: * - adjusts musb->mregs
drivers/usb/musb/musb_core.h +3 -0
@@ -46,6 +46,7 @@#include <linux/usb.h> #include <linux/usb/otg.h> #include <linux/usb/musb.h> +#include <linux/phy/phy.h> struct musb ;struct musb_hw_ep ;
@@ -357,6 +358,7 @@ struct musb {u16 int_tx;struct usb_phy *xceiv; +struct phy *phy;int nIrq; unsigned irq_wake:1;
@@ -434,6 +436,7 @@ struct musb { unsigned double_buffer_not_ok:1;struct musb_hdrc_config *config; +const char *phy_dev_name;#ifdef MUSB_CONFIG_PROC_FS struct proc_dir_entry *proc_entry;
drivers/usb/musb/omap2430.c +21 -8
@@ -348,14 +348,24 @@ static int omap2430_musb_init(struct musb *musb)* up through ULPI. TWL4030-family PMICs include one, * which needs a driver, drivers aren't always needed. */ -if (dev->parent->of_node) +if (dev->parent->of_node) { + musb->phy =devm_phy_get (dev->parent,"usb2-phy" ); + +/* We can't totally remove musb->xceiv as of now because +* musb core uses xceiv.state and xceiv.otg. Once we have +* a separate state machine to handle otg, these can be moved +* out of xceiv and then we can start using the generic PHY +* framework +*/ musb->xceiv =devm_usb_get_phy_by_phandle (dev->parent,"usb-phy" ,0 ); -else + }else { musb->xceiv =devm_usb_get_phy_dev (dev,0 ); + musb->phy =devm_phy_get (dev, musb->phy_dev_name); + } -if (IS_ERR (musb->xceiv)) { - status =PTR_ERR (musb->xceiv); +if (IS_ERR (musb->xceiv) ||IS_ERR (musb->phy)) { + status =PTR_ERR (musb->xceiv) |PTR_ERR (musb->phy);if (status == -ENXIO )return status;
@@ -397,9 +407,10 @@ static int omap2430_musb_init(struct musb *musb)if (glue->status !=OMAP_MUSB_UNKNOWN )omap_musb_set_mailbox (glue); -usb_phy_init (musb->xceiv); +phy_init (musb->phy);pm_runtime_put_noidle (musb->controller); +phy_pm_runtime_put (musb->phy);return 0 ; err1:
@@ -460,6 +471,7 @@ static int omap2430_musb_exit(struct musb *musb)del_timer_sync (&musb_idle_timer);omap2430_low_level_exit (musb); +phy_exit (musb->phy);return 0 ; }
@@ -618,7 +630,8 @@ static int omap2430_runtime_suspend(struct device *dev) OTG_INTERFSEL);omap2430_low_level_exit (musb); -usb_phy_set_suspend (musb->xceiv,1 ); +phy_power_off (musb->phy); +phy_pm_runtime_put (musb->phy); }return 0 ;
@@ -633,8 +646,8 @@ static int omap2430_runtime_resume(struct device *dev)omap2430_low_level_init (musb);musb_writel (musb->mregs,OTG_INTERFSEL , musb->context.otg_interfsel); - -usb_phy_set_suspend (musb->xceiv,0 ); +phy_pm_runtime_get_sync (musb->phy); +phy_power_on (musb->phy); }return 0 ;
Signature · 1 line
1.7.10.4
PATCH v6 8/9 usb: phy: omap-usb2: remove *set_suspend* callback from omap-usb2
In reply to Kishon Vijay Abraham INow that omap-usb2 is adapted to the new generic PHY framework, *set_suspend* ops can be removed from omap-usb2 driver.
--- drivers/usb/phy/phy-omap-usb2.c | 24 ------------------------ 1 file changed, 24 deletions(-)
drivers/usb/phy/phy-omap-usb2.c +0 -24
@@ -97,29 +97,6 @@ static int omap_usb_set_peripheral(struct usb_otg *otg,return 0 ; } -static int omap_usb2_suspend (struct usb_phy *x,int suspend) -{ -u32 ret; -struct omap_usb *phy =phy_to_omapusb (x); - -if (suspend && !phy->is_suspended) { -omap_control_usb_phy_power (phy->control_dev,0 ); -pm_runtime_put_sync (phy->dev); - phy->is_suspended =1 ; - }else if (!suspend && phy->is_suspended) { - ret =pm_runtime_get_sync (phy->dev); -if (ret <0 ) { -dev_err (phy->dev,"get_sync failed with err %d\n" , - ret); -return ret; - } -omap_control_usb_phy_power (phy->control_dev,1 ); - phy->is_suspended =0 ; - } - -return 0 ; -} -static int omap_usb_power_off (struct phy *x) {struct omap_usb *phy =dev_get_drvdata (&x->dev);
@@ -167,7 +144,6 @@ static int omap_usb2_probe(struct platform_device *pdev) phy->phy.dev = phy->dev; phy->phy.label ="omap-usb2" ; - phy->phy.set_suspend = omap_usb2_suspend; phy->phy.otg = otg; phy->phy.type =USB_PHY_TYPE_USB2 ;
Signature · 1 line
1.7.10.4
PATCH v6 9/9 usb: phy: twl4030-usb: remove *set_suspend* and *phy_init* ops
In reply to Kishon Vijay Abraham INow that twl4030-usb is adapted to the new generic PHY framework, *set_suspend* and *phy_init* ops can be removed from twl4030-usb driver.
--- drivers/usb/phy/phy-twl4030-usb.c | 55 ++++++++----------------------------- 1 file changed, 12 insertions(+), 43 deletions(-)
drivers/usb/phy/phy-twl4030-usb.c +12 -43
@@ -422,25 +422,20 @@ static void twl4030_phy_power(struct twl4030_usb *twl, int on) } } -static void twl4030_phy_suspend (struct twl4030_usb *twl,int controller_off) +static int twl4030_phy_power_off (struct phy *phy) { +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); +if (twl->asleep) -return ; +return 0 ;twl4030_phy_power (twl,0 ); twl->asleep =1 ;dev_dbg (twl->dev,"%s\n" , __func__); -} - -static int twl4030_phy_power_off (struct phy *phy) -{ -struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); - -twl4030_phy_suspend (twl,0 );return 0 ; } -static void __twl4030_phy_resume (struct twl4030_usb *twl) +static void __twl4030_phy_power_on (struct twl4030_usb *twl) {twl4030_phy_power (twl,1 );twl4030_i2c_access (twl,1 );
@@ -449,11 +444,13 @@ static void __twl4030_phy_resume(struct twl4030_usb *twl)twl4030_i2c_access (twl,0 ); } -static void twl4030_phy_resume (struct twl4030_usb *twl) +static int twl4030_phy_power_on (struct phy *phy) { +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); +if (!twl->asleep) -return ; -__twl4030_phy_resume (twl); +return 0 ; +__twl4030_phy_power_on (twl); twl->asleep =0 ;dev_dbg (twl->dev,"%s\n" , __func__);
@@ -466,13 +463,6 @@ static void twl4030_phy_resume(struct twl4030_usb *twl)cancel_delayed_work (&twl->id_workaround_work);schedule_delayed_work (&twl->id_workaround_work,HZ ); } -} - -static int twl4030_phy_power_on (struct phy *phy) -{ -struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); - -twl4030_phy_resume (twl);return 0 ; }
@@ -604,9 +594,9 @@ static void twl4030_id_workaround_work(struct work_struct *work) } } -static int twl4030_usb_phy_init (struct usb_phy *phy) +static int twl4030_phy_init (struct phy *phy) { -struct twl4030_usb *twl =phy_to_twl (phy); +struct twl4030_usb *twl =dev_get_drvdata (&phy->dev);enum omap_musb_vbus_id_status status;/*
@@ -626,25 +616,6 @@ static int twl4030_usb_phy_init(struct usb_phy *phy)return 0 ; } -static int twl4030_phy_init (struct phy *phy) -{ -struct twl4030_usb *twl =dev_get_drvdata (&phy->dev); - -return twl4030_usb_phy_init (&twl->phy); -} - -static int twl4030_set_suspend (struct usb_phy *x,int suspend) -{ -struct twl4030_usb *twl =phy_to_twl (x); - -if (suspend) -twl4030_phy_suspend (twl,1 ); -else -twl4030_phy_resume (twl); - -return 0 ; -} -static int twl4030_set_peripheral (struct usb_otg *otg,struct usb_gadget *gadget) {
@@ -715,8 +686,6 @@ static int twl4030_usb_probe(struct platform_device *pdev) twl->phy.label ="twl4030" ; twl->phy.otg = otg; twl->phy.type =USB_PHY_TYPE_USB2 ; - twl->phy.set_suspend = twl4030_set_suspend; - twl->phy.init = twl4030_usb_phy_init; otg->phy = &twl->phy; otg->set_host = twl4030_set_host;
Signature · 1 line
1.7.10.4
Hi,
Quoted 15 lines · Kishon Vijay Abraham I
Added a generic PHY framework that provides a set of APIs for the PHY drivers to create/destroy a PHY and APIs for the PHY users to obtain a reference to the PHY with or without using phandle.
This framework will be of use only to devices that uses external PHY (PHY functionality is not embedded within the controller).
The intention of creating this framework is to bring the phy drivers spread all over the Linux kernel to
drivers/phyto increase code re-use and to increase code maintainability.Comments to make PHY as bus wasn't done because PHY devices can be part of other bus and making a same device attached to multiple bus leads to bad design.
Quoted 7 lines
If the PHY driver has to send notification on connect/disconnect, the PHY driver should make use of the extcon framework. Using this susbsystem to use extcon framwork will have to be analysed.
Making omap-usb2 and twl4030 to use this framework is provided as a sample.
This patch series is developed on linux-next tree.
Any comments on this patch series?
Thanks
Kishon
Hi,
Quoted 26 lines · Kishon Vijay Abraham I
Hi,
Quoted 23 lines · Kishon Vijay Abraham I
Added a generic PHY framework that provides a set of APIs for the PHY drivers
to create/destroy a PHY and APIs for the PHY users to obtain a reference to
the PHY with or without using phandle.This framework will be of use only to devices that uses external PHY (PHY functionality is not embedded within the controller).
The intention of creating this framework is to bring the phy drivers spread
all over the Linux kernel todrivers/phyto increase code re-use and to increase code maintainability.Comments to make PHY as bus wasn't done because PHY devices can be part of
other bus and making a same device attached to multiple bus leads to bad design.If the PHY driver has to send notification on connect/disconnect, the PHY driver should make use of the extcon framework. Using this susbsystem to use extcon framwork will have to be analysed.
Quoted 6 lines
Quoted 4 lines
Making omap-usb2 and twl4030 to use this framework is provided as a sample.
This patch series is developed on linux-next tree.
Any comments on this patch series?
Ping..
This series is needed for usb3 phy/sata phy and can also be used by certain video phys. I think it's important to get this in.
Thanks
Kishon