Skip to contentSkip to conversation

extcon: add Maxim MAX3355 driver

PATCH Superseded Sergei Shtylyov 3 participants 9 messages Dec 16, 2015 – Dec 18, 2015

Subsystems (3)

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 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.

---
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                             |  153 ++++++++++++
 4 files changed, 183 insertions(+)
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +21 -0
Index: renesas/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: renesas/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: renesas/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 +153 -0

153 lines not on this page · raw message

#1 lore raw

2015-12-17 3:07 GMT+09:00 Sergei Shtylyov <[email protected]>:

Quoted 46 lines

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.

---
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                             |  153 ++++++++++++
 4 files changed, 183 insertions(+)

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

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +1 -0
@@ -0,0 +1,21 @@
+Maxim Integrated MAX3355 USB OTG chip

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

Quoted 10 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +10 -0
+-------------------------------------
+
+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;

Could you add some indentation to the wrapped line for this property? For readability.

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

Quoted 2 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +2 -0
+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+  connected to the MAX3355's ID_OUT pin.

Ditto.

Why this property lacks the vendor prefix i(n comparison to shdn-gpios which has the prefix)?

Quoted 112 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +8 -0
+
+Example (Koelsch board):
+
+       usb-otg {
+               compatible = "maxim,max3355";
+               maxim,shdn-gpios = <&gpio2 4 GPIO_ACTIVE_LOW>;
+               id-gpios = <&gpio5 31 GPIO_ACTIVE_HIGH>;
+       };

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

drivers/extcon/Kconfig +8 -0
@@ -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

Index: renesas/drivers/extcon/Makefile
===================================================================

drivers/extcon/Makefile +1 -0
@@ -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

Index: renesas/drivers/extcon/extcon-max3355.c
===================================================================

drivers/extcon/extcon-max3355.c new file +68 -0
@@ -0,0 +1,153 @@
+/*
+ * Maxim Integrated MAX3355 USB OTG chip extcon driver
+ *
+ * Copyright (C) 2014 Cogent Embedded, Inc.
+ * Author: Sergei Shtylyov <[email protected]>
+ *
+ * This software is licensed under the terms of the GNU General Public
+ * License version 2, as published by the Free Software Foundation, and
+ * may be copied, distributed, and modified under those terms.
+ */
+
+#include <linux/extcon.h>
+#include <linux/gpio.h>
+#include <linux/init.h>
+#include <linux/interrupt.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of_gpio.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <linux/workqueue.h>
+
+struct max3355_data {
+       struct extcon_dev *edev;
+       struct gpio_desc *id_gpiod;
+       struct gpio_desc *shdn_gpiod;
+};
+
+static const unsigned int max3355_cable[] = {
+       EXTCON_USB,
+       EXTCON_USB_HOST,
+       EXTCON_NONE,
+};
+
+static irqreturn_t max3355_id_irq(int irq, void *dev_id)
+{
+       struct max3355_data *data = dev_id;
+       int id = gpiod_get_value_cansleep(data->id_gpiod);
+
+       if (id) {
+               /*
+                * ID = 1 means USB HOST cable detached.
+                * As we don't have event for USB peripheral cable attached,
+                * we simulate USB peripheral attach here.
+                */
+               extcon_set_cable_state_(data->edev, EXTCON_USB_HOST, false);
+               extcon_set_cable_state_(data->edev, EXTCON_USB, true);
+       } else {
+               /*
+                * ID = 0 means USB HOST cable attached.
+                * As we don't have event for USB peripheral cable detached,
+                * we simulate USB peripheral detach here.
+                */
+               extcon_set_cable_state_(data->edev, EXTCON_USB, false);
+               extcon_set_cable_state_(data->edev, EXTCON_USB_HOST, true);
+       }
+
+       return IRQ_HANDLED;
+}
+
+static int max3355_probe(struct platform_device *pdev)
+{
+       struct device_node *np = pdev->dev.of_node;
+       struct max3355_data *data;
+       struct gpio_desc *gpiod;
+       int irq, err;
+
+       data = devm_kzalloc(&pdev->dev, sizeof(struct max3355_data),

drivers/extcon/extcon-max3355.c line 78

Quoted 10 lines
drivers/extcon/extcon-max3355.c new file +10 -0
+                           GFP_KERNEL);
+       if (!data)
+               return -ENOMEM;
+
+       data->edev = devm_extcon_dev_allocate(&pdev->dev, max3355_cable);
+       if (IS_ERR(data->edev)) {
+               dev_err(&pdev->dev, "failed to allocate extcon device\n");
+               return PTR_ERR(data->edev);
+       }
+       data->edev->name = kstrdup(np->name, GFP_KERNEL);

I think it is not needed any more (extcon_dev_register()) will set it. Anyway there is no checking for NULL return value and no freeing in error/exit paths.

Quoted 57 lines
drivers/extcon/extcon-max3355.c new file +57 -0
+
+       gpiod = devm_gpiod_get(&pdev->dev, "id", GPIOD_IN);
+       if (IS_ERR(gpiod)) {
+               dev_err(&pdev->dev, "failed to get ID_OUT GPIO\n");
+               return PTR_ERR(gpiod);
+       }
+       data->id_gpiod = gpiod;
+
+       gpiod = devm_gpiod_get(&pdev->dev, "maxim,shdn", GPIOD_OUT_HIGH);
+       if (IS_ERR(gpiod)) {
+               dev_err(&pdev->dev, "failed to get SHDN# GPIO\n");
+               return PTR_ERR(gpiod);
+       }
+       data->shdn_gpiod = gpiod;
+
+       err = devm_extcon_dev_register(&pdev->dev, data->edev);
+       if (err < 0) {
+               dev_err(&pdev->dev, "failed to register extcon device\n");
+               return err;
+       }
+
+       irq = gpiod_to_irq(data->id_gpiod);
+       if (irq < 0) {
+               dev_err(&pdev->dev, "failed to translate ID_OUT GPIO to IRQ\n");
+               return irq;
+       }
+
+       err = devm_request_threaded_irq(&pdev->dev, irq, NULL, max3355_id_irq,
+                                       IRQF_ONESHOT | IRQF_NO_SUSPEND |
+                                       IRQF_TRIGGER_RISING |
+                                       IRQF_TRIGGER_FALLING,
+                                       pdev->name, data);
+       if (err < 0) {
+               dev_err(&pdev->dev, "failed to request ID_OUT IRQ\n");
+               return err;
+       }
+
+       platform_set_drvdata(pdev, data);
+
+       /* Perform initial detection */
+       max3355_id_irq(irq, data);
+
+       return 0;
+}
+
+static int max3355_remove(struct platform_device *pdev)
+{
+       struct max3355_data *data = platform_get_drvdata(pdev);
+
+       gpiod_set_value_cansleep(data->shdn_gpiod, 0);
+
+       return 0;
+}
+
+static const struct of_device_id max3355_match_table[] = {
+       { .compatible = "maxim,max3355", },
+       { }

drivers/extcon/extcon-max3355.c line 145

Quoted 10 lines
drivers/extcon/extcon-max3355.c new file +10 -0
+};
+MODULE_DEVICE_TABLE(of, max3355_match_table);
+
+static struct platform_driver max3355_driver = {
+       .probe          = max3355_probe,
+       .remove         = max3355_remove,
+       .driver         = {
+               .name   = "extcon-max3355",
+               .of_match_table = max3355_match_table,
+               .owner  = THIS_MODULE,

No need for owner.
Please pass the source through recent coccicheck and fix the findings.

Best regards,
Krzysztof

#2 lore raw

Hello.

Quoted 51 lines · Krzysztof Kozlowski
Quoted 51 lines

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.

---
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                             |  153 ++++++++++++
  4 files changed, 183 insertions(+)

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

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +6 -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.
Quoted 8 lines

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

Quoted 5 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +5 -0
+
+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;

Could you add some indentation to the wrapped line for this property? For readability.

If it's not indented enough, I can add more spaces/tabs.

Quoted 7 lines

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

Quoted 2 lines
Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +2 -0
+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+  connected to the MAX3355's ID_OUT pin.

Ditto.

Why this property lacks the vendor prefix i(n comparison to shdn-gpios which has the prefix)?

Since the extcon-usb-gpio driver uses "id-gpio" prop already. I can add
back the vendor prefix if you insist.

[...]

Quoted 5 lines
Quoted 5 lines

Index: renesas/drivers/extcon/extcon-max3355.c
===================================================================

drivers/extcon/extcon-max3355.c new file +0 -0
@@ -0,0 +1,153 @@

[...]

Quoted 14 lines
Quoted 14 lines
drivers/extcon/extcon-max3355.c new file +14 -0
+static int max3355_probe(struct platform_device *pdev)
+{
+       struct device_node *np = pdev->dev.of_node;
+       struct max3355_data *data;
+       struct gpio_desc *gpiod;
+       int irq, err;
+
+       data = devm_kzalloc(&pdev->dev, sizeof(struct max3355_data),
+                           GFP_KERNEL);
+       if (!data)
+               return -ENOMEM;
+
+       data->edev = devm_extcon_dev_allocate(&pdev->dev, max3355_cable);
+       if (IS_ERR(data->edev)) {
Quoted 8 lines

drivers/extcon/extcon-max3355.c line 78

Quoted 4 lines
drivers/extcon/extcon-max3355.c new file +4 -0
+               dev_err(&pdev->dev, "failed to allocate extcon device\n");
+               return PTR_ERR(data->edev);
+       }
+       data->edev->name = kstrdup(np->name, GFP_KERNEL);

I think it is not needed any more (extcon_dev_register()) will set it. Anyway there is no checking for NULL return value and no freeing in error/exit paths.

Oops, will fix.

[...]

Quoted 10 lines

drivers/extcon/extcon-max3355.c line 145

Quoted 7 lines
drivers/extcon/extcon-max3355.c new file +7 -0
+static struct platform_driver max3355_driver = {
+       .probe          = max3355_probe,
+       .remove         = max3355_remove,
+       .driver         = {
+               .name   = "extcon-max3355",
+               .of_match_table = max3355_match_table,
+               .owner  = THIS_MODULE,

No need for owner.
Please pass the source through recent coccicheck and fix the findings.

Has it been included in the kernel source somewhere already?

Quoted 2 lines

Best regards,
Krzysztof

MBR, Sergei

#3 lore raw
Quoted 78 lines · Sergei Shtylyov

Hello.

Quoted 65 lines · Krzysztof Kozlowski
Quoted 65 lines

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.

---
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                             |  153
++++++++++++
  4 files changed, 183 insertions(+)

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

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +4 -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 new file +2 -0
+device.
+
Quoted 8 lines
Quoted 5 lines

+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;

Could you add some indentation to the wrapped line for this property? For readability.

Quoted 1 line

If it's not indented enough, I can add more spaces/tabs.

Ahh, now I see it is sufficient. I need fix my email client.

Quoted 5 lines
Quoted 5 lines
Quoted 4 lines

+- id-gpios: should contain a phandle and GPIO specifier for the GPIO pin
+ connected to the MAX3355's ID_OUT pin.

Quoted 7 lines
Quoted 4 lines

Ditto.

Why this property lacks the vendor prefix i(n comparison to shdn-gpios which has the prefix)?

Since the extcon-usb-gpio driver uses "id-gpio" prop already. I can
add back the vendor prefix if you insist.

It is for USB ID and palmas has it already as well so I do not insist. Seems generic.

Quoted 44 lines

[...]

Quoted 5 lines
Quoted 5 lines

Index: renesas/drivers/extcon/extcon-max3355.c
===================================================================

drivers/extcon/extcon-max3355.c new file +0 -0
@@ -0,0 +1,153 @@

[...]

Quoted 16 lines
Quoted 16 lines
drivers/extcon/extcon-max3355.c new file +13 -0
+static int max3355_probe(struct platform_device *pdev)
+{
+       struct device_node *np = pdev->dev.of_node;
+       struct max3355_data *data;
+       struct gpio_desc *gpiod;
+       int irq, err;
+
+       data = devm_kzalloc(&pdev->dev, sizeof(struct max3355_data),
+                           GFP_KERNEL);
+       if (!data)
+               return -ENOMEM;
+
+       data->edev = devm_extcon_dev_allocate(&pdev->dev,

max3355_cable);

drivers/extcon/extcon-max3355.c new file +2 -0
+       if (IS_ERR(data->edev)) {
+               dev_err(&pdev->dev, "failed to allocate extcon
Quoted 8 lines

drivers/extcon/extcon-max3355.c line 78

Quoted 4 lines

device\n");

drivers/extcon/extcon-max3355.c new file +3 -0
+               return PTR_ERR(data->edev);
+       }
+       data->edev->name = kstrdup(np->name, GFP_KERNEL);

I think it is not needed any more (extcon_dev_register()) will set it. Anyway there is no checking for NULL return value and no freeing in error/exit paths.

Oops, will fix.

[...]

Quoted 8 lines
Quoted 7 lines
drivers/extcon/extcon-max3355.c new file +7 -0
+static struct platform_driver max3355_driver = {
+       .probe          = max3355_probe,
+       .remove         = max3355_remove,
+       .driver         = {
+               .name   = "extcon-max3355",
+               .of_match_table = max3355_match_table,
+               .owner  = THIS_MODULE,
Quoted 4 lines
Quoted 2 lines

No need for owner.
Please pass the source through recent coccicheck and fix the findings.

Has it been included in the kernel source somewhere already?

The rules detecting the unnecessary owner should be there for some time (sice 4.2 or 4.1?). The coccicheck is in kernel - scripts/coccicheck. It uses coccinelle/spatch. You can run it just like other code-checker tools - sparse and smatch.

Best regards,
Krzysztof

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

#4 lore raw

Hello.

On 12/18/2015 3:19 AM, Krzysztof Kozlowski wrote:

[...]

Quoted 6 lines
Quoted 3 lines
Quoted 1 line

Please pass the source through recent coccicheck and fix the findings.

Has it been included in the kernel source somewhere already?

The rules detecting the unnecessary owner should be there for some time (sice 4.2 or 4.1?). The coccicheck is in kernel - scripts/coccicheck. It

Found it already.

Quoted 1 line

uses coccinelle/spatch.

Installed it.

Quoted 2 lines

You can run it just like other code-checker
tools - sparse and smatch.

I tried but couldn't figure out how to confine 'make coccicheck'only to
the files I need.

Quoted 2 lines

Best regards,
Krzysztof

MBR, Sergei

maintainer
#5 lore raw
In reply to Sergei Shtylyov

Hi Sergei,

Quoted 102 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.

---
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                             |  153 ++++++++++++
 4 files changed, 183 insertions(+)

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

Documentation/devicetree/bindings/extcon/extcon-max3355.txt new file +21 -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
+  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>;
+	};

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

drivers/extcon/Kconfig +8 -0
@@ -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

Index: renesas/drivers/extcon/Makefile
===================================================================

drivers/extcon/Makefile +1 -0
@@ -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

Index: renesas/drivers/extcon/extcon-max3355.c
===================================================================

drivers/extcon/extcon-max3355.c line 4

Quoted 4 lines
drivers/extcon/extcon-max3355.c new file +4 -0
@@ -0,0 +1,153 @@
+/*
+ * Maxim Integrated MAX3355 USB OTG chip extcon driver
+ *
+ * Copyright (C) 2014 Cogent Embedded, Inc.

2014 -> 2015

Quoted 64 lines
drivers/extcon/extcon-max3355.c new file +64 -0
+ * Author: Sergei Shtylyov <sergei.shtylyov-M4DtvfQ/[email protected]>
+ *
+ * This software is licensed under the terms of the GNU General Public
+ * License version 2, as published by the Free Software Foundation, and
+ * may be copied, distributed, and modified under those terms.
+ */
+
+#include <linux/extcon.h>
+#include <linux/gpio.h>
+#include <linux/init.h>
+#include <linux/interrupt.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of_gpio.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <linux/workqueue.h>
+
+struct max3355_data {
+	struct extcon_dev *edev;
+	struct gpio_desc *id_gpiod;
+	struct gpio_desc *shdn_gpiod;
+};
+
+static const unsigned int max3355_cable[] = {
+	EXTCON_USB,
+	EXTCON_USB_HOST,
+	EXTCON_NONE,
+};
+
+static irqreturn_t max3355_id_irq(int irq, void *dev_id)
+{
+	struct max3355_data *data = dev_id;
+	int id = gpiod_get_value_cansleep(data->id_gpiod);
+
+	if (id) {
+		/*
+		 * ID = 1 means USB HOST cable detached.
+		 * As we don't have event for USB peripheral cable attached,
+		 * we simulate USB peripheral attach here.
+		 */
+		extcon_set_cable_state_(data->edev, EXTCON_USB_HOST, false);
+		extcon_set_cable_state_(data->edev, EXTCON_USB, true);
+	} else {
+		/*
+		 * ID = 0 means USB HOST cable attached.
+		 * As we don't have event for USB peripheral cable detached,
+		 * we simulate USB peripheral detach here.
+		 */
+		extcon_set_cable_state_(data->edev, EXTCON_USB, false);
+		extcon_set_cable_state_(data->edev, EXTCON_USB_HOST, true);
+	}
+
+	return IRQ_HANDLED;
+}
+
+static int max3355_probe(struct platform_device *pdev)
+{
+	struct device_node *np = pdev->dev.of_node;
+	struct max3355_data *data;
+	struct gpio_desc *gpiod;
+	int irq, err;
+
+	data = devm_kzalloc(&pdev->dev, sizeof(struct max3355_data),

drivers/extcon/extcon-max3355.c line 78

Quoted 10 lines
drivers/extcon/extcon-max3355.c new file +10 -0
+			    GFP_KERNEL);
+	if (!data)
+		return -ENOMEM;
+
+	data->edev = devm_extcon_dev_allocate(&pdev->dev, max3355_cable);
+	if (IS_ERR(data->edev)) {
+		dev_err(&pdev->dev, "failed to allocate extcon device\n");
+		return PTR_ERR(data->edev);
+	}
+	data->edev->name = kstrdup(np->name, GFP_KERNEL);

You don't need to set the name of extcon device.
Instead, the extcon_dev_register() will set it.

Quoted 26 lines
drivers/extcon/extcon-max3355.c new file +26 -0
+
+	gpiod = devm_gpiod_get(&pdev->dev, "id", GPIOD_IN);
+	if (IS_ERR(gpiod)) {
+		dev_err(&pdev->dev, "failed to get ID_OUT GPIO\n");
+		return PTR_ERR(gpiod);
+	}
+	data->id_gpiod = gpiod;
+
+	gpiod = devm_gpiod_get(&pdev->dev, "maxim,shdn", GPIOD_OUT_HIGH);
+	if (IS_ERR(gpiod)) {
+		dev_err(&pdev->dev, "failed to get SHDN# GPIO\n");
+		return PTR_ERR(gpiod);
+	}
+	data->shdn_gpiod = gpiod;
+
+	err = devm_extcon_dev_register(&pdev->dev, data->edev);
+	if (err < 0) {
+		dev_err(&pdev->dev, "failed to register extcon device\n");
+		return err;
+	}
+
+	irq = gpiod_to_irq(data->id_gpiod);
+	if (irq < 0) {
+		dev_err(&pdev->dev, "failed to translate ID_OUT GPIO to IRQ\n");
+		return irq;
+	}

drivers/extcon/extcon-max3355.c line 114

Quoted 10 lines
drivers/extcon/extcon-max3355.c new file +10 -0
+
+	err = devm_request_threaded_irq(&pdev->dev, irq, NULL, max3355_id_irq,
+					IRQF_ONESHOT | IRQF_NO_SUSPEND |
+					IRQF_TRIGGER_RISING |
+					IRQF_TRIGGER_FALLING,
+					pdev->name, data);
+	if (err < 0) {
+		dev_err(&pdev->dev, "failed to request ID_OUT IRQ\n");
+		return err;
+	}

I recommend that you reorder the init code in probe() as following:

1. Allocate the memory of max3355_data *data.
2. Parse and initialize the gpio (id, shdn)
3. Allocate the memory of extcon_dev and register it.
4. Request the interrupt.

Quoted 21 lines
drivers/extcon/extcon-max3355.c new file +21 -0
+
+	platform_set_drvdata(pdev, data);
+
+	/* Perform initial detection */
+	max3355_id_irq(irq, data);
+
+	return 0;
+}
+
+static int max3355_remove(struct platform_device *pdev)
+{
+	struct max3355_data *data = platform_get_drvdata(pdev);
+
+	gpiod_set_value_cansleep(data->shdn_gpiod, 0);
+
+	return 0;
+}
+
+static const struct of_device_id max3355_match_table[] = {
+	{ .compatible = "maxim,max3355", },
+	{ }

drivers/extcon/extcon-max3355.c line 145

Quoted 10 lines
drivers/extcon/extcon-max3355.c new file +10 -0
+};
+MODULE_DEVICE_TABLE(of, max3355_match_table);
+
+static struct platform_driver max3355_driver = {
+	.probe		= max3355_probe,
+	.remove		= max3355_remove,
+	.driver		= {
+		.name	= "extcon-max3355",
+		.of_match_table = max3355_match_table,
+		.owner	= THIS_MODULE,

You don't need to add the 'owner'.

drivers/extcon/extcon-max3355.c line 153

Quoted 8 lines
drivers/extcon/extcon-max3355.c new file +8 -0
+	},
+};
+
+module_platform_driver(max3355_driver);
+
+MODULE_AUTHOR("Sergei Shtylyov <sergei.shtylyov-M4DtvfQ/[email protected]>");
+MODULE_DESCRIPTION("Maxim MAX3355 extcon driver");
+MODULE_LICENSE("GPL v2");

Thanks,
Chanwoo Choi

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

maintainer
#6 lore raw

Hi,

Quoted 43 lines · Chanwoo Choi

Hi Sergei,

Quoted 40 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.

---
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                             |  153 ++++++++++++
 4 files changed, 183 insertions(+)

[snip]

Quoted 8 lines

drivers/extcon/extcon-max3355.c line 128

Quoted 8 lines
drivers/extcon/extcon-max3355.c new file +8 -0
+	return 0;
+}
+
+static int max3355_remove(struct platform_device *pdev)
+{
+	struct max3355_data *data = platform_get_drvdata(pdev);
+
+	gpiod_set_value_cansleep(data->shdn_gpiod, 0);

Don't need to handle the 'shdn' gpio on resume/suspend funtcion?

But, if the interrput of id gpio is used for wakeup source, there is no reason to handle it for suspend mode.

[snip]

Thanks,
Chanwoo Choi
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html

#7 lore raw

Hello.

Quoted 55 lines · Chanwoo Choi
Quoted 41 lines · Sergei Shtylyov
Quoted 40 lines

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.

---
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                             |  153 ++++++++++++
  4 files changed, 183 insertions(+)

[snip]

Quoted 8 lines

drivers/extcon/extcon-max3355.c line 128

Quoted 8 lines
drivers/extcon/extcon-max3355.c new file +8 -0
+	return 0;
+}
+
+static int max3355_remove(struct platform_device *pdev)
+{
+	struct max3355_data *data = platform_get_drvdata(pdev);
+
+	gpiod_set_value_cansleep(data->shdn_gpiod, 0);

Don't need to handle the 'shdn' gpio on resume/suspend funtcion?

Quoted 2 lines

But, if the interrput of id gpio is used for wakeup source, there is no reason to handle it for suspend mode.

You told me to pass IRQF_NO_SUSPEND to devm_request_threaded_irq(), didn't
you?

Quoted 4 lines

[snip]

Thanks,
Chanwoo Choi

MBR, Sergei

maintainer
#8 lore raw
Quoted 59 lines · Sergei Shtylyov

Hello.

Quoted 55 lines · Chanwoo Choi
Quoted 41 lines · Sergei Shtylyov
Quoted 40 lines

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.

---
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                             |  153 ++++++++++++
  4 files changed, 183 insertions(+)

[snip]

Quoted 8 lines

drivers/extcon/extcon-max3355.c line 128

Quoted 8 lines
drivers/extcon/extcon-max3355.c new file +8 -0
+    return 0;
+}
+
+static int max3355_remove(struct platform_device *pdev)
+{
+    struct max3355_data *data = platform_get_drvdata(pdev);
+
+    gpiod_set_value_cansleep(data->shdn_gpiod, 0);

Don't need to handle the 'shdn' gpio on resume/suspend funtcion?

Quoted 4 lines
Quoted 2 lines

But, if the interrput of id gpio is used for wakeup source, there is no reason to handle it for suspend mode.

You told me to pass IRQF_NO_SUSPEND to devm_request_threaded_irq(), didn't you?

Yes. You add the this flag on v4 patch. Looks good to me.

Thanks,
Chanwoo Choi

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html