Skip to contentSkip to conversation

extcon: add Maxim MAX3355 driver

PATCH Superseded Sergei Shtylyov 3 participants 4 messages Dec 17, 2015 – Dec 19, 2015

Subsystems (3)

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 extcon: add Maxim MAX3355 driver

Maxim Integrated MAX3355E chip integrates a charge pump and comparators to enable a system with an integrated USB OTG dual-role transceiver to function as an USB OTG dual-role device. In addition to sensing/controlling Vbus, the chip also passes thru the ID signal from the USB OTG connector. On some Renesas boards, this signal is just fed into the SoC thru a GPIO pin -- there's no real OTG controller, only host and gadget USB controllers sharing the same USB bus; however, we'd like to allow host or gadget drivers to be loaded depending on the cable type, hence the need for the MAX3355 extcon driver. The Vbus status signals are also wired to GPIOs (however, we aren't currently interested in them), the OFFVBUS# signal is controlled by the host controllers, there's also the SHDN# signal wired to a GPIO, it should be driven high for the normal operation.

---
The patch is against the 'extcon-next' branch of the 'extcon.git' repo.

Changes in version 4:
- stopped calling kstrdup() for the device name;
- removed unneeded 'owner' field initializer;
- moved devm_extcon_allocate() call further down in the probe() method;
- extended the driver copyright;
- indented the continuation lines in the binding document.

Changes in version 3:
- reformatted the change log.

Changes in version 2:
- added the USB gadget cable support;
- added the remove() driver method which drives SHDN# GPIO low to save power;
- dropped vendor prefix from the ID GPIO property name;
- changed the GPIO property name suffix to "-gpios";
- switched to usign extcon_set_cable_state_() API;
- switched to using the gpiod/sleeping 'gpiolib' APIs;
- addded error messages to max3355_probe();
- added IRQF_NO_SUSPEND flasg to the devm_request_threaded_irq() call;
- renamed 'ret' variable to 'err' in max3355_probe();
- expanded the Kconfig entry help text;
- added vendor name to the patch summary, the bindings document, the Kconfig entry, the driver heading comment, the module description, and the change log;
- fixed up and reformatted the change log.

 Documentation/devicetree/bindings/extcon/extcon-max3355.txt |   21 +
 drivers/extcon/Kconfig                                      |    8 
 drivers/extcon/Makefile                                     |    1 
 drivers/extcon/extcon-max3355.c                             |  151 ++++++++++++
 4 files changed, 181 insertions(+)
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +21 -0
Index: extcon/Documentation/devicetree/bindings/extcon/extcon-max3355.txt
===================================================================
@@ -0,0 +1,21 @@
+Maxim Integrated MAX3355 USB OTG chip
+-------------------------------------
+
+MAX3355 integrates a charge pump and comparators to enable a system with an
+integrated USB OTG dual-role transceiver to function as a USB OTG dual-role
+device.
+
+Required properties:
+- compatible: should be "maxim,max3355";
+- maxim,shdn-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+		    connected to the MAX3355's SHDN# pin;
+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+	    connected to the MAX3355's ID_OUT pin.
+
+Example (Koelsch board):
+
+	usb-otg {
+		compatible = "maxim,max3355";
+		maxim,shdn-gpios = <&gpio2 4 GPIO_ACTIVE_LOW>;
+		id-gpios = <&gpio5 31 GPIO_ACTIVE_HIGH>;
+	};
drivers/extcon/Kconfig +8 -0
Index: extcon/drivers/extcon/Kconfig
===================================================================
@@ -52,6 +52,14 @@ config EXTCON_MAX14577
 	  Maxim MAX14577/77836. The MAX14577/77836 MUIC is a USB port accessory
 	  detector and switch.
 
+config EXTCON_MAX3355
+	tristate "Maxim MAX3355 USB OTG EXTCON Support"
+	help
+	  If you say yes here you get support for the USB OTG role detection by
+	  MAX3355. The MAX3355 chip integrates a charge pump and comparators to
+	  enable a system with an integrated USB OTG dual-role transceiver to
+	  function as an USB OTG dual-role device.
+
 config EXTCON_MAX77693
 	tristate "Maxim MAX77693 EXTCON Support"
 	depends on MFD_MAX77693 && INPUT
drivers/extcon/Makefile +1 -0
Index: extcon/drivers/extcon/Makefile
===================================================================
@@ -8,6 +8,7 @@ obj-$(CONFIG_EXTCON_ARIZONA)	+= extcon-a
 obj-$(CONFIG_EXTCON_AXP288)	+= extcon-axp288.o
 obj-$(CONFIG_EXTCON_GPIO)	+= extcon-gpio.o
 obj-$(CONFIG_EXTCON_MAX14577)	+= extcon-max14577.o
+obj-$(CONFIG_EXTCON_MAX3355)	+= extcon-max3355.o
 obj-$(CONFIG_EXTCON_MAX77693)	+= extcon-max77693.o
 obj-$(CONFIG_EXTCON_MAX77843)	+= extcon-max77843.o
 obj-$(CONFIG_EXTCON_MAX8997)	+= extcon-max8997.o
drivers/extcon/extcon-max3355.c new file +151 -0

151 lines not on this page · raw message

maintainer Acked-by on v4 1/1
#1 lore raw

Hi Sergei,

Except for just one comment below, Looks good to me.

I'll wait for a few days to get the review from DT maintainer before applying it on extcon-next branch.

Quoted 59 lines · Sergei Shtylyov

Maxim Integrated MAX3355E chip integrates a charge pump and comparators to enable a system with an integrated USB OTG dual-role transceiver to function as an USB OTG dual-role device. In addition to sensing/controlling Vbus, the chip also passes thru the ID signal from the USB OTG connector. On some Renesas boards, this signal is just fed into the SoC thru a GPIO pin -- there's no real OTG controller, only host and gadget USB controllers sharing the same USB bus; however, we'd like to allow host or gadget drivers to be loaded depending on the cable type, hence the need for the MAX3355 extcon driver. The Vbus status signals are also wired to GPIOs (however, we aren't currently interested in them), the OFFVBUS# signal is controlled by the host controllers, there's also the SHDN# signal wired to a GPIO, it should be driven high for the normal operation.

---
The patch is against the 'extcon-next' branch of the 'extcon.git' repo.

Changes in version 4:
- stopped calling kstrdup() for the device name;
- removed unneeded 'owner' field initializer;
- moved devm_extcon_allocate() call further down in the probe() method;
- extended the driver copyright;
- indented the continuation lines in the binding document.

Changes in version 3:
- reformatted the change log.

Changes in version 2:
- added the USB gadget cable support;
- added the remove() driver method which drives SHDN# GPIO low to save power;
- dropped vendor prefix from the ID GPIO property name;
- changed the GPIO property name suffix to "-gpios";
- switched to usign extcon_set_cable_state_() API;
- switched to using the gpiod/sleeping 'gpiolib' APIs;
- addded error messages to max3355_probe();
- added IRQF_NO_SUSPEND flasg to the devm_request_threaded_irq() call;
- renamed 'ret' variable to 'err' in max3355_probe();
- expanded the Kconfig entry help text;
- added vendor name to the patch summary, the bindings document, the Kconfig entry, the driver heading comment, the module description, and the change log;
- fixed up and reformatted the change log.

 Documentation/devicetree/bindings/extcon/extcon-max3355.txt |   21 +
 drivers/extcon/Kconfig                                      |    8 
 drivers/extcon/Makefile                                     |    1 
 drivers/extcon/extcon-max3355.c                             |  151 ++++++++++++
 4 files changed, 181 insertions(+)

Index: extcon/Documentation/devicetree/bindings/extcon/extcon-max3355.txt
===================================================================

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +5 -0
@@ -0,0 +1,21 @@
+Maxim Integrated MAX3355 USB OTG chip
+-------------------------------------
+
+MAX3355 integrates a charge pump and comparators to enable a system with an
+integrated USB OTG dual-role transceiver to function as a USB OTG dual-role

Documentation/devicetree/bindings/extcon/extcon-max3355.txt line 15

Quoted 10 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +10 -0
+device.
+
+Required properties:
+- compatible: should be "maxim,max3355";
+- maxim,shdn-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+		    connected to the MAX3355's SHDN# pin;
+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+	    connected to the MAX3355's ID_OUT pin.
+
+Example (Koelsch board):

You mean that "koelsch" board might be arch/arm/boot/dts/r8a7791-koelsch.dts. But, the max3355 dt node isn't really included in r8a7791-koelsch.dts.

I recommend that you add the accurate information because the wrong info causes the confusion. So, I'd like you to change it as following:

	"Example (Koelsch board):" -> "Example:"

After adding the max3355 dt node to Koelsch board on separate patch, you modify this documentation for real usage case of max3355 dt node.

drivers/extcon/Kconfig config EXTCON_MAX14577 · line 53

Quoted 13 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +6 -0
+
+	usb-otg {
+		compatible = "maxim,max3355";
+		maxim,shdn-gpios = <&gpio2 4 GPIO_ACTIVE_LOW>;
+		id-gpios = <&gpio5 31 GPIO_ACTIVE_HIGH>;
+	};

Index: extcon/drivers/extcon/Kconfig
===================================================================

drivers/extcon/Kconfig +0 -0
@@ -52,6 +52,14 @@ config EXTCON_MAX14577
 	  Maxim MAX14577/77836. The MAX14577/77836 MUIC is a USB port accessory
 	  detector and switch.

[snip]

Thanks,
Chanwoo Choi

#2 lore raw

Hello.

Quoted 71 lines · Chanwoo Choi

Except for just one comment below, Looks good to me.

I'll wait for a few days to get the review from DT maintainer before applying it on extcon-next branch.

Quoted 64 lines · Sergei Shtylyov

Maxim Integrated MAX3355E chip integrates a charge pump and comparators to enable a system with an integrated USB OTG dual-role transceiver to function as an USB OTG dual-role device. In addition to sensing/controlling Vbus, the chip also passes thru the ID signal from the USB OTG connector. On some Renesas boards, this signal is just fed into the SoC thru a GPIO pin -- there's no real OTG controller, only host and gadget USB controllers sharing the same USB bus; however, we'd like to allow host or gadget drivers to be loaded depending on the cable type, hence the need for the MAX3355 extcon driver. The Vbus status signals are also wired to GPIOs (however, we aren't currently interested in them), the OFFVBUS# signal is controlled by the host controllers, there's also the SHDN# signal wired to a GPIO, it should be driven high for the normal operation.

---
The patch is against the 'extcon-next' branch of the 'extcon.git' repo.

Changes in version 4:
- stopped calling kstrdup() for the device name;
- removed unneeded 'owner' field initializer;
- moved devm_extcon_allocate() call further down in the probe() method;
- extended the driver copyright;
- indented the continuation lines in the binding document.

Changes in version 3:
- reformatted the change log.

Changes in version 2:
- added the USB gadget cable support;
- added the remove() driver method which drives SHDN# GPIO low to save power;
- dropped vendor prefix from the ID GPIO property name;
- changed the GPIO property name suffix to "-gpios";
- switched to usign extcon_set_cable_state_() API;
- switched to using the gpiod/sleeping 'gpiolib' APIs;
- addded error messages to max3355_probe();
- added IRQF_NO_SUSPEND flasg to the devm_request_threaded_irq() call;
- renamed 'ret' variable to 'err' in max3355_probe();
- expanded the Kconfig entry help text;
- added vendor name to the patch summary, the bindings document, the Kconfig entry, the driver heading comment, the module description, and the change log;
- fixed up and reformatted the change log.

  Documentation/devicetree/bindings/extcon/extcon-max3355.txt |   21 +
  drivers/extcon/Kconfig                                      |    8
  drivers/extcon/Makefile                                     |    1
  drivers/extcon/extcon-max3355.c                             |  151 ++++++++++++
  4 files changed, 181 insertions(+)

Index: extcon/Documentation/devicetree/bindings/extcon/extcon-max3355.txt
===================================================================

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +10 -0
@@ -0,0 +1,21 @@
+Maxim Integrated MAX3355 USB OTG chip
+-------------------------------------
+
+MAX3355 integrates a charge pump and comparators to enable a system with an
+integrated USB OTG dual-role transceiver to function as a USB OTG dual-role
+device.
+
+Required properties:
+- compatible: should be "maxim,max3355";
+- maxim,shdn-gpios: should contain a phandle and GPIO specifier for the GPIO pin
Quoted 8 lines

Documentation/devicetree/bindings/extcon/extcon-max3355.txt line 15

Quoted 5 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +5 -0
+		    connected to the MAX3355's SHDN# pin;
+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+	    connected to the MAX3355's ID_OUT pin.
+
+Example (Koelsch board):

You mean that "koelsch" board might be arch/arm/boot/dts/r8a7791-koelsch.dts. But, the max3355 dt node isn't really included in r8a7791-koelsch.dts.

Of course, I couldn't post the device tree patch before the binding was
accepted.

Quoted 7 lines

I recommend that you add the accurate information because the wrong info causes the confusion. So, I'd like you to change it as following:

	"Example (Koelsch board):" -> "Example:"

After adding the max3355 dt node to Koelsch board on separate patch, you modify this documentation for real usage case of max3355 dt node.

No dire need to modify the documentation then. Should I still repost?

[...]

Quoted 2 lines

Thanks,
Chanwoo Choi

MBR, Sergei

maintainer Acked-by on v4 1/1
#3 lore raw
In reply to Sergei Shtylyov
Quoted 43 lines · Sergei Shtylyov

Maxim Integrated MAX3355E chip integrates a charge pump and comparators to enable a system with an integrated USB OTG dual-role transceiver to function as an USB OTG dual-role device. In addition to sensing/controlling Vbus, the chip also passes thru the ID signal from the USB OTG connector. On some Renesas boards, this signal is just fed into the SoC thru a GPIO pin -- there's no real OTG controller, only host and gadget USB controllers sharing the same USB bus; however, we'd like to allow host or gadget drivers to be loaded depending on the cable type, hence the need for the MAX3355 extcon driver. The Vbus status signals are also wired to GPIOs (however, we aren't currently interested in them), the OFFVBUS# signal is controlled by the host controllers, there's also the SHDN# signal wired to a GPIO, it should be driven high for the normal operation.

---
The patch is against the 'extcon-next' branch of the 'extcon.git' repo.

Changes in version 4:
- stopped calling kstrdup() for the device name;
- removed unneeded 'owner' field initializer;
- moved devm_extcon_allocate() call further down in the probe() method;
- extended the driver copyright;
- indented the continuation lines in the binding document.

Changes in version 3:
- reformatted the change log.

Changes in version 2:
- added the USB gadget cable support;
- added the remove() driver method which drives SHDN# GPIO low to save power;
- dropped vendor prefix from the ID GPIO property name;
- changed the GPIO property name suffix to "-gpios";
- switched to usign extcon_set_cable_state_() API;
- switched to using the gpiod/sleeping 'gpiolib' APIs;
- addded error messages to max3355_probe();
- added IRQF_NO_SUSPEND flasg to the devm_request_threaded_irq() call;
- renamed 'ret' variable to 'err' in max3355_probe();
- expanded the Kconfig entry help text;
- added vendor name to the patch summary, the bindings document, the Kconfig entry, the driver heading comment, the module description, and the change log;
- fixed up and reformatted the change log.

Quoted 1 line
 Documentation/devicetree/bindings/extcon/extcon-max3355.txt |   21 +
Quoted 4 lines
 drivers/extcon/Kconfig                                      |    8 
 drivers/extcon/Makefile                                     |    1 
 drivers/extcon/extcon-max3355.c                             |  151 ++++++++++++
 4 files changed, 181 insertions(+)