diff mbox series

[v2,4/6] phy: phy-can-transceiver: Add support for generic CAN transceiver driver

Message ID 20210414140521.11463-5-a-govindraju@ti.com
State Superseded
Headers show
Series CAN TRANSCEIVER: Add support for CAN transceivers | expand

Commit Message

Aswath Govindraju April 14, 2021, 2:05 p.m. UTC
The driver adds support for generic CAN transceivers. Currently
the modes supported by this driver are standby and normal modes for TI
TCAN1042 and TCAN1043 CAN transceivers.

The transceiver is modelled as a phy with pins controlled by gpios, to put
the transceiver in various device functional modes. It also gets the phy
attribute max_link_rate for the usage of CAN drivers.

Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
---
 MAINTAINERS                       |   1 +
 drivers/phy/Kconfig               |   9 ++
 drivers/phy/Makefile              |   1 +
 drivers/phy/phy-can-transceiver.c | 146 ++++++++++++++++++++++++++++++
 4 files changed, 157 insertions(+)
 create mode 100644 drivers/phy/phy-can-transceiver.c

Comments

Marc Kleine-Budde April 14, 2021, 3:39 p.m. UTC | #1
On 14.04.2021 19:35:19, Aswath Govindraju wrote:
> The driver adds support for generic CAN transceivers. Currently
> the modes supported by this driver are standby and normal modes for TI
> TCAN1042 and TCAN1043 CAN transceivers.
> 
> The transceiver is modelled as a phy with pins controlled by gpios, to put
> the transceiver in various device functional modes. It also gets the phy
> attribute max_link_rate for the usage of CAN drivers.
> 
> Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
> ---
>  MAINTAINERS                       |   1 +
>  drivers/phy/Kconfig               |   9 ++
>  drivers/phy/Makefile              |   1 +
>  drivers/phy/phy-can-transceiver.c | 146 ++++++++++++++++++++++++++++++
>  4 files changed, 157 insertions(+)
>  create mode 100644 drivers/phy/phy-can-transceiver.c
> 
> diff --git a/MAINTAINERS b/MAINTAINERS
> index e666d33af10d..70e1438c372d 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -4047,6 +4047,7 @@ T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can.git
>  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git
>  F:	Documentation/devicetree/bindings/net/can/
>  F:	Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
> +F:	drivers/phy/phy-can-transceiver.c
>  F:	drivers/net/can/

please keep this alphabetically sorted

Marc
Marc Kleine-Budde April 14, 2021, 3:40 p.m. UTC | #2
On 14.04.2021 19:35:19, Aswath Govindraju wrote:
> --- a/drivers/phy/Kconfig
> +++ b/drivers/phy/Kconfig
> @@ -61,6 +61,15 @@ config USB_LGM_PHY
>  	  interface to interact with USB GEN-II and USB 3.x PHY that is part
>  	  of the Intel network SOC.
>  
> +config PHY_CAN_TRANSCEIVER
> +	tristate "CAN transceiver PHY"
> +	select GENERIC_PHY
> +	help
> +	  This option enables support for CAN transceivers as a PHY. This
> +	  driver provides function for putting the transceivers in various
> +	  functional modes using gpios and sets the attribute max link
> +	  rate, for mcan drivers.
> +
>  source "drivers/phy/allwinner/Kconfig"
>  source "drivers/phy/amlogic/Kconfig"
>  source "drivers/phy/broadcom/Kconfig"
> diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
> index adac1b1a39d1..9c66101c9605 100644
> --- a/drivers/phy/Makefile
> +++ b/drivers/phy/Makefile
> @@ -9,6 +9,7 @@ obj-$(CONFIG_PHY_LPC18XX_USB_OTG)	+= phy-lpc18xx-usb-otg.o
>  obj-$(CONFIG_PHY_XGENE)			+= phy-xgene.o
>  obj-$(CONFIG_PHY_PISTACHIO_USB)		+= phy-pistachio-usb.o
>  obj-$(CONFIG_USB_LGM_PHY)		+= phy-lgm-usb.o
> +obj-$(CONFIG_PHY_CAN_TRANSCEIVER)	+= phy-can-transceiver.o
>  obj-y					+= allwinner/	\
>  					   amlogic/	\
>  					   broadcom/	\

I'm not sure how the phy framework handles this, but I assume it's
alphabetically sorted, too.

Marc
kernel test robot April 15, 2021, 7:44 a.m. UTC | #3
Hi Aswath,

I love your patch! Perhaps something to improve:

[auto build test WARNING on mkl-can-next/testing]
[also build test WARNING on linux/master robh/for-next linus/master v5.12-rc7 next-20210414]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Aswath-Govindraju/CAN-TRANSCEIVER-Add-support-for-CAN-transceivers/20210414-220857
base:   https://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git testing
config: arm64-randconfig-r012-20210415 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project 6a18cc23efad410db48a3ccfc233d215de7d4cb9)
reproduce (this is a W=1 build):
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # install arm64 cross compiling tool for clang build
        # apt-get install binutils-aarch64-linux-gnu
        # https://github.com/0day-ci/linux/commit/f0bb46b67a1f6116c84a7691e05f5059377e4640
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review Aswath-Govindraju/CAN-TRANSCEIVER-Add-support-for-CAN-transceivers/20210414-220857
        git checkout f0bb46b67a1f6116c84a7691e05f5059377e4640
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross W=1 ARCH=arm64 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

>> drivers/phy/phy-can-transceiver.c:79:5: warning: no previous prototype for function 'can_transceiver_phy_probe' [-Wmissing-prototypes]
   int can_transceiver_phy_probe(struct platform_device *pdev)
       ^
   drivers/phy/phy-can-transceiver.c:79:1: note: declare 'static' if the function is not intended to be used outside of this translation unit
   int can_transceiver_phy_probe(struct platform_device *pdev)
   ^
   static 
   1 warning generated.


vim +/can_transceiver_phy_probe +79 drivers/phy/phy-can-transceiver.c

    78	
  > 79	int can_transceiver_phy_probe(struct platform_device *pdev)
    80	{
    81		struct phy_provider *phy_provider;
    82		struct device *dev = &pdev->dev;
    83		struct can_transceiver_phy *can_transceiver_phy;
    84		const struct can_transceiver_data *drvdata;
    85		const struct of_device_id *match;
    86		struct phy *phy;
    87		struct gpio_desc *standby_gpio;
    88		struct gpio_desc *enable_gpio;
    89		u32 max_bitrate = 0;
    90	
    91		can_transceiver_phy = devm_kzalloc(dev, sizeof(struct can_transceiver_phy), GFP_KERNEL);
    92		if (!can_transceiver_phy)
    93			return -ENOMEM;
    94	
    95		match = of_match_node(can_transceiver_phy_ids, pdev->dev.of_node);
    96		drvdata = match->data;
    97	
    98		phy = devm_phy_create(dev, dev->of_node,
    99				      &can_transceiver_phy_ops);
   100		if (IS_ERR(phy)) {
   101			dev_err(dev, "failed to create can transceiver phy\n");
   102			return PTR_ERR(phy);
   103		}
   104	
   105		device_property_read_u32(dev, "max-bitrate", &max_bitrate);
   106		if (!max_bitrate)
   107			dev_warn(dev, "Invalid value for transceiver max bitrate. Ignoring bitrate limit\n");
   108		phy->attrs.max_link_rate = max_bitrate;
   109	
   110		can_transceiver_phy->generic_phy = phy;
   111	
   112		if (drvdata->flags & CAN_TRANSCEIVER_STB_PRESENT) {
   113			standby_gpio = devm_gpiod_get(dev, "standby", GPIOD_OUT_HIGH);
   114			if (IS_ERR(standby_gpio))
   115				return PTR_ERR(standby_gpio);
   116			can_transceiver_phy->standby_gpio = standby_gpio;
   117		}
   118	
   119		if (drvdata->flags & CAN_TRANSCEIVER_EN_PRESENT) {
   120			enable_gpio = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
   121			if (IS_ERR(enable_gpio))
   122				return PTR_ERR(enable_gpio);
   123			can_transceiver_phy->enable_gpio = enable_gpio;
   124		}
   125	
   126		phy_set_drvdata(can_transceiver_phy->generic_phy, can_transceiver_phy);
   127	
   128		phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
   129	
   130		return PTR_ERR_OR_ZERO(phy_provider);
   131	}
   132	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org
kernel test robot April 15, 2021, 9:12 a.m. UTC | #4
Hi Aswath,

I love your patch! Perhaps something to improve:

[auto build test WARNING on mkl-can-next/testing]
[also build test WARNING on linux/master robh/for-next linus/master v5.12-rc7 next-20210414]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url:    https://github.com/0day-ci/linux/commits/Aswath-Govindraju/CAN-TRANSCEIVER-Add-support-for-CAN-transceivers/20210414-220857
base:   https://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git testing
config: m68k-randconfig-r014-20210415 (attached as .config)
compiler: m68k-linux-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
        wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
        chmod +x ~/bin/make.cross
        # https://github.com/0day-ci/linux/commit/f0bb46b67a1f6116c84a7691e05f5059377e4640
        git remote add linux-review https://github.com/0day-ci/linux
        git fetch --no-tags linux-review Aswath-Govindraju/CAN-TRANSCEIVER-Add-support-for-CAN-transceivers/20210414-220857
        git checkout f0bb46b67a1f6116c84a7691e05f5059377e4640
        # save the attached .config to linux build tree
        COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross W=1 ARCH=m68k 

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <lkp@intel.com>

All warnings (new ones prefixed by >>):

>> drivers/phy/phy-can-transceiver.c:79:5: warning: no previous prototype for 'can_transceiver_phy_probe' [-Wmissing-prototypes]
      79 | int can_transceiver_phy_probe(struct platform_device *pdev)
         |     ^~~~~~~~~~~~~~~~~~~~~~~~~


vim +/can_transceiver_phy_probe +79 drivers/phy/phy-can-transceiver.c

    78	
  > 79	int can_transceiver_phy_probe(struct platform_device *pdev)
    80	{
    81		struct phy_provider *phy_provider;
    82		struct device *dev = &pdev->dev;
    83		struct can_transceiver_phy *can_transceiver_phy;
    84		const struct can_transceiver_data *drvdata;
    85		const struct of_device_id *match;
    86		struct phy *phy;
    87		struct gpio_desc *standby_gpio;
    88		struct gpio_desc *enable_gpio;
    89		u32 max_bitrate = 0;
    90	
    91		can_transceiver_phy = devm_kzalloc(dev, sizeof(struct can_transceiver_phy), GFP_KERNEL);
    92		if (!can_transceiver_phy)
    93			return -ENOMEM;
    94	
    95		match = of_match_node(can_transceiver_phy_ids, pdev->dev.of_node);
    96		drvdata = match->data;
    97	
    98		phy = devm_phy_create(dev, dev->of_node,
    99				      &can_transceiver_phy_ops);
   100		if (IS_ERR(phy)) {
   101			dev_err(dev, "failed to create can transceiver phy\n");
   102			return PTR_ERR(phy);
   103		}
   104	
   105		device_property_read_u32(dev, "max-bitrate", &max_bitrate);
   106		if (!max_bitrate)
   107			dev_warn(dev, "Invalid value for transceiver max bitrate. Ignoring bitrate limit\n");
   108		phy->attrs.max_link_rate = max_bitrate;
   109	
   110		can_transceiver_phy->generic_phy = phy;
   111	
   112		if (drvdata->flags & CAN_TRANSCEIVER_STB_PRESENT) {
   113			standby_gpio = devm_gpiod_get(dev, "standby", GPIOD_OUT_HIGH);
   114			if (IS_ERR(standby_gpio))
   115				return PTR_ERR(standby_gpio);
   116			can_transceiver_phy->standby_gpio = standby_gpio;
   117		}
   118	
   119		if (drvdata->flags & CAN_TRANSCEIVER_EN_PRESENT) {
   120			enable_gpio = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
   121			if (IS_ERR(enable_gpio))
   122				return PTR_ERR(enable_gpio);
   123			can_transceiver_phy->enable_gpio = enable_gpio;
   124		}
   125	
   126		phy_set_drvdata(can_transceiver_phy->generic_phy, can_transceiver_phy);
   127	
   128		phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
   129	
   130		return PTR_ERR_OR_ZERO(phy_provider);
   131	}
   132	

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/kbuild-all@lists.01.org
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index e666d33af10d..70e1438c372d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4047,6 +4047,7 @@  T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can.git
 T:	git git://git.kernel.org/pub/scm/linux/kernel/git/mkl/linux-can-next.git
 F:	Documentation/devicetree/bindings/net/can/
 F:	Documentation/devicetree/bindings/phy/ti,tcan104x-can.yaml
+F:	drivers/phy/phy-can-transceiver.c
 F:	drivers/net/can/
 F:	include/linux/can/bittiming.h
 F:	include/linux/can/dev.h
diff --git a/drivers/phy/Kconfig b/drivers/phy/Kconfig
index 54c1f2f0985f..51902b629fc6 100644
--- a/drivers/phy/Kconfig
+++ b/drivers/phy/Kconfig
@@ -61,6 +61,15 @@  config USB_LGM_PHY
 	  interface to interact with USB GEN-II and USB 3.x PHY that is part
 	  of the Intel network SOC.
 
+config PHY_CAN_TRANSCEIVER
+	tristate "CAN transceiver PHY"
+	select GENERIC_PHY
+	help
+	  This option enables support for CAN transceivers as a PHY. This
+	  driver provides function for putting the transceivers in various
+	  functional modes using gpios and sets the attribute max link
+	  rate, for mcan drivers.
+
 source "drivers/phy/allwinner/Kconfig"
 source "drivers/phy/amlogic/Kconfig"
 source "drivers/phy/broadcom/Kconfig"
diff --git a/drivers/phy/Makefile b/drivers/phy/Makefile
index adac1b1a39d1..9c66101c9605 100644
--- a/drivers/phy/Makefile
+++ b/drivers/phy/Makefile
@@ -9,6 +9,7 @@  obj-$(CONFIG_PHY_LPC18XX_USB_OTG)	+= phy-lpc18xx-usb-otg.o
 obj-$(CONFIG_PHY_XGENE)			+= phy-xgene.o
 obj-$(CONFIG_PHY_PISTACHIO_USB)		+= phy-pistachio-usb.o
 obj-$(CONFIG_USB_LGM_PHY)		+= phy-lgm-usb.o
+obj-$(CONFIG_PHY_CAN_TRANSCEIVER)	+= phy-can-transceiver.o
 obj-y					+= allwinner/	\
 					   amlogic/	\
 					   broadcom/	\
diff --git a/drivers/phy/phy-can-transceiver.c b/drivers/phy/phy-can-transceiver.c
new file mode 100644
index 000000000000..f2976c1f4d0f
--- /dev/null
+++ b/drivers/phy/phy-can-transceiver.c
@@ -0,0 +1,146 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * phy-can-transceiver.c - phy driver for CAN transceivers
+ *
+ * Copyright (C) 2021 Texas Instruments Incorporated - http://www.ti.com
+ *
+ */
+#include<linux/phy/phy.h>
+#include<linux/platform_device.h>
+#include<linux/module.h>
+#include<linux/gpio.h>
+#include<linux/gpio/consumer.h>
+
+struct can_transceiver_data {
+	u32 flags;
+#define CAN_TRANSCEIVER_STB_PRESENT	BIT(0)
+#define CAN_TRANSCEIVER_EN_PRESENT	BIT(1)
+};
+
+struct can_transceiver_phy {
+	struct phy *generic_phy;
+	struct gpio_desc *standby_gpio;
+	struct gpio_desc *enable_gpio;
+};
+
+/* Power on function */
+static int can_transceiver_phy_power_on(struct phy *phy)
+{
+	struct can_transceiver_phy *can_transceiver_phy = phy_get_drvdata(phy);
+
+	if (can_transceiver_phy->standby_gpio)
+		gpiod_set_value_cansleep(can_transceiver_phy->standby_gpio, 0);
+	if (can_transceiver_phy->enable_gpio)
+		gpiod_set_value_cansleep(can_transceiver_phy->enable_gpio, 1);
+
+	return 0;
+}
+
+/* Power off function */
+static int can_transceiver_phy_power_off(struct phy *phy)
+{
+	struct can_transceiver_phy *can_transceiver_phy = phy_get_drvdata(phy);
+
+	if (can_transceiver_phy->standby_gpio)
+		gpiod_set_value_cansleep(can_transceiver_phy->standby_gpio, 1);
+	if (can_transceiver_phy->enable_gpio)
+		gpiod_set_value_cansleep(can_transceiver_phy->enable_gpio, 0);
+
+	return 0;
+}
+
+static const struct phy_ops can_transceiver_phy_ops = {
+	.power_on	= can_transceiver_phy_power_on,
+	.power_off	= can_transceiver_phy_power_off,
+	.owner		= THIS_MODULE,
+};
+
+static const struct can_transceiver_data tcan1042_drvdata = {
+	.flags = CAN_TRANSCEIVER_STB_PRESENT,
+};
+
+static const struct can_transceiver_data tcan1043_drvdata = {
+	.flags = CAN_TRANSCEIVER_STB_PRESENT | CAN_TRANSCEIVER_EN_PRESENT,
+};
+
+static const struct of_device_id can_transceiver_phy_ids[] = {
+	{
+		.compatible = "ti,tcan1042",
+		.data = &tcan1042_drvdata
+	},
+	{
+		.compatible = "ti,tcan1043",
+		.data = &tcan1043_drvdata
+	},
+	{ }
+};
+MODULE_DEVICE_TABLE(of, can_transceiver_phy_ids);
+
+int can_transceiver_phy_probe(struct platform_device *pdev)
+{
+	struct phy_provider *phy_provider;
+	struct device *dev = &pdev->dev;
+	struct can_transceiver_phy *can_transceiver_phy;
+	const struct can_transceiver_data *drvdata;
+	const struct of_device_id *match;
+	struct phy *phy;
+	struct gpio_desc *standby_gpio;
+	struct gpio_desc *enable_gpio;
+	u32 max_bitrate = 0;
+
+	can_transceiver_phy = devm_kzalloc(dev, sizeof(struct can_transceiver_phy), GFP_KERNEL);
+	if (!can_transceiver_phy)
+		return -ENOMEM;
+
+	match = of_match_node(can_transceiver_phy_ids, pdev->dev.of_node);
+	drvdata = match->data;
+
+	phy = devm_phy_create(dev, dev->of_node,
+			      &can_transceiver_phy_ops);
+	if (IS_ERR(phy)) {
+		dev_err(dev, "failed to create can transceiver phy\n");
+		return PTR_ERR(phy);
+	}
+
+	device_property_read_u32(dev, "max-bitrate", &max_bitrate);
+	if (!max_bitrate)
+		dev_warn(dev, "Invalid value for transceiver max bitrate. Ignoring bitrate limit\n");
+	phy->attrs.max_link_rate = max_bitrate;
+
+	can_transceiver_phy->generic_phy = phy;
+
+	if (drvdata->flags & CAN_TRANSCEIVER_STB_PRESENT) {
+		standby_gpio = devm_gpiod_get(dev, "standby", GPIOD_OUT_HIGH);
+		if (IS_ERR(standby_gpio))
+			return PTR_ERR(standby_gpio);
+		can_transceiver_phy->standby_gpio = standby_gpio;
+	}
+
+	if (drvdata->flags & CAN_TRANSCEIVER_EN_PRESENT) {
+		enable_gpio = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
+		if (IS_ERR(enable_gpio))
+			return PTR_ERR(enable_gpio);
+		can_transceiver_phy->enable_gpio = enable_gpio;
+	}
+
+	phy_set_drvdata(can_transceiver_phy->generic_phy, can_transceiver_phy);
+
+	phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
+
+	return PTR_ERR_OR_ZERO(phy_provider);
+}
+
+static struct platform_driver can_transceiver_phy_driver = {
+	.probe = can_transceiver_phy_probe,
+	.driver = {
+		.name = "can-transceiver-phy",
+		.of_match_table = can_transceiver_phy_ids,
+	},
+};
+
+module_platform_driver(can_transceiver_phy_driver);
+
+MODULE_AUTHOR("Faiz Abbas <faiz_abbas@ti.com>");
+MODULE_AUTHOR("Aswath Govindraju <a-govindraju@ti.com>");
+MODULE_DESCRIPTION("CAN TRANSCEIVER PHY driver");
+MODULE_LICENSE("GPL v2");