Skip to contentSkip to conversation

w1-gpio: Add GPIO w1 bus master driver

PATCH In review Ville Syrjala 3 participants 6 messages Dec 21, 2007 – Jan 3, 2008

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 w1-gpio: Add GPIO w1 bus master driver

Add a GPIO 1-wire bus master driver. The driver used the GPIO API to control the wire and the GPIO pin can be specified using platform data similar to i2c-gpio. The driver was tested with AT91SAM9260 + DS2401.

---
 Documentation/w1/masters/00-INDEX |    2 +
 Documentation/w1/masters/w1-gpio  |   33 ++++++++++++
 drivers/w1/masters/Kconfig        |   10 ++++
 drivers/w1/masters/Makefile       |    1 +
 drivers/w1/masters/w1-gpio.c      |  100 +++++++++++++++++++++++++++++++++++++
 include/linux/w1-gpio.h           |   21 ++++++++
 6 files changed, 167 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/w1/masters/w1-gpio
 create mode 100644 drivers/w1/masters/w1-gpio.c
 create mode 100644 include/linux/w1-gpio.h
Documentation/w1/masters/00-INDEX +2 -0
index 752613c..7b0ceaa 100644
@@ -4,3 +4,5 @@ ds2482
 	- The Maxim/Dallas Semiconductor DS2482 provides 1-wire busses.
 ds2490
 	- The Maxim/Dallas Semiconductor DS2490 builds USB <-> W1 bridges.
+w1-gpio
+	- GPIO 1-wire bus master driver.
Documentation/w1/masters/w1-gpio new file +33 -0
new file mode 100644
index 0000000..c927139
@@ -0,0 +1,33 @@
+Kernel driver w1-gpio
+=====================
+
+Author: Ville Syrjala <[email protected]>
+
+
+Description
+-----------
+
+GPIO 1-wire bus master driver. The driver uses the GPIO API to control the
+wire and the GPIO pin can be specified using platform data. The GPIO pin
+must be configured as open-drain.
+
+
+Example (mach-at91)
+-------------------
+
+#include <linux/w1-gpio.h>
+
+static struct w1_gpio_platform_data foo_w1_gpio_pdata = {
+	.pin = AT91_PIN_PB20,
+};
+
+static struct platform_device foo_w1_device = {
+	.name			= "w1-gpio",
+	.id			= -1,
+	.dev.platform_data	= &foo_w1_gpio_pdata,
+};
+
+...
+	at91_set_GPIO_periph(foo_w1_gpio_pdata.pin, 1);
+	at91_set_multi_drive(foo_w1_gpio_pdata.pin, 1);
+	platform_device_register(&foo_w1_device);
drivers/w1/masters/Kconfig +10 -0
index 8236d44..c449309 100644
@@ -42,5 +42,15 @@ config W1_MASTER_DS1WM
 	  in HP iPAQ devices like h5xxx, h2200, and ASIC3-based like
 	  hx4700.
 
+config W1_MASTER_GPIO
+	tristate "GPIO 1-wire busmaster"
+	depends on GENERIC_GPIO
+	help
+	  Say Y here if you want to communicate with your 1-wire devices using
+	  GPIO pins. This driver uses the GPIO API to control the wire.
+
+	  This support is also available as a module.  If so, the module
+	  will be called w1-gpio.ko.
+
 endmenu
 
drivers/w1/masters/Makefile +1 -0
index 11551b3..1420b5b 100644
@@ -6,3 +6,4 @@ obj-$(CONFIG_W1_MASTER_MATROX)		+= matrox_w1.o
 obj-$(CONFIG_W1_MASTER_DS2490)		+= ds2490.o
 obj-$(CONFIG_W1_MASTER_DS2482)		+= ds2482.o
 obj-$(CONFIG_W1_MASTER_DS1WM)		+= ds1wm.o
+obj-$(CONFIG_W1_MASTER_GPIO)		+= w1-gpio.o
drivers/w1/masters/w1-gpio.c new file +100 -0

100 lines not on this page · raw message

include/linux/w1-gpio.h new file +21 -0
new file mode 100644
index 0000000..3b80bb2
@@ -0,0 +1,21 @@
+/*
+ * w1-gpio interface to platform code
+ *
+ * Copyright (C) 2007 Ville Syrjala <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2
+ * as published by the Free Software Foundation.
+ */
+#ifndef _LINUX_W1_GPIO_H
+#define _LINUX_W1_GPIO_H
+
+/**
+ * struct w1_gpio_platform_data - Platform-dependent data for w1-gpio
+ * @pin: GPIO pin to use
+ */
+struct w1_gpio_platform_data {
+	unsigned int	pin;
+};
+
+#endif /* _LINUX_W1_GPIO_H */
Signature · 1 line
1.5.2.5
#1 lore raw

Hi Ville.

Quoted 3 lines · Ville Syrjala

Add a GPIO 1-wire bus master driver. The driver used the GPIO API to control the wire and the GPIO pin can be specified using platform data similar to i2c-gpio. The driver was tested with AT91SAM9260 + DS2401.

This looks ok, only a minor nit about codying style below.

Quoted 1 line

ACK.

drivers/w1/masters/w1-gpio.c line 47

Quoted 13 lines
drivers/w1/masters/w1-gpio.c new file +13 -0
+static int __init w1_gpio_probe(struct platform_device *pdev)
+{
+	struct w1_bus_master *master;
+	struct w1_gpio_platform_data *pdata;
+	int err;
+
+	pdata = pdev->dev.platform_data;
+	if (!pdata)
+		return -ENXIO;
+
+	master = kzalloc(sizeof *master, GFP_KERNEL);
+	if (!master)
+		return -ENOMEM;

I think sizeof(struct w1_bus_master) is a better way.

include/linux/w1-gpio.h

Quoted 4 lines

new file mode 100644
index 0000000..3b80bb2

include/linux/w1-gpio.h new file +0 -0

Does anyone use this file except driver itself?

Signature · 1 line
	Evgeniy Polyakov
#2 lore raw
Quoted 13 lines · Evgeniy Polyakov

Hi Ville.

Quoted 3 lines · Ville Syrjala

Add a GPIO 1-wire bus master driver. The driver used the GPIO API to control the wire and the GPIO pin can be specified using platform data similar to i2c-gpio. The driver was tested with AT91SAM9260 + DS2401.

This looks ok, only a minor nit about codying style below.

Quoted 1 line

ACK.

Quoted 15 lines

drivers/w1/masters/w1-gpio.c line 47

Quoted 13 lines
drivers/w1/masters/w1-gpio.c new file +13 -0
+static int __init w1_gpio_probe(struct platform_device *pdev)
+{
+	struct w1_bus_master *master;
+	struct w1_gpio_platform_data *pdata;
+	int err;
+
+	pdata = pdev->dev.platform_data;
+	if (!pdata)
+		return -ENXIO;
+
+	master = kzalloc(sizeof *master, GFP_KERNEL);
+	if (!master)
+		return -ENOMEM;

I think sizeof(struct w1_bus_master) is a better way.

Will change.

Quoted 6 lines

include/linux/w1-gpio.h

Quoted 4 lines

new file mode 100644
index 0000000..3b80bb2

include/linux/w1-gpio.h new file +0 -0

Does anyone use this file except driver itself?

It's supposed to be used by the code that registers the platform device (see the example in the documentation). No in-tree users since the board I'm using is not supported by the kernel.

I just had a better look at i2c-gpio and noticed that I missed gpio_request()/gpio_free() calls from the driver. Also the open-drain requirement could be removed like i2c-gpio does. I'll send a new patch ASAP.

Signature · 3 lines
Ville Syrjälä
[email protected]
http://www.sci.fi/~syrjala/
#3 lore raw
In reply to Ville Syrjala

Documentation/w1/masters/w1-gpio line 26

Quoted 3 lines · On Fri, 21 Dec 2007 09:34:01 +0200 Ville Syrjala <[email protected]> wrote:
Documentation/w1/masters/w1-gpio new file +3 -0
+static struct platform_device foo_w1_device = {
+	.name			= "w1-gpio",
+	.id			= -1,

Assigning -1 to a u32 member isn't a very nice example. What does it mean anyway?

Quoted 1 line

+static int __init w1_gpio_probe(struct platform_device *pdev)

This must be __devinit, or if you want to save a bit of memory...

drivers/w1/masters/w1-gpio.c line 81

Quoted 1 line
drivers/w1/masters/w1-gpio.c new file +1 -0
+	.probe	= w1_gpio_probe,

...remove this line, and...

drivers/w1/masters/w1-gpio.c line 87

Quoted 3 lines
drivers/w1/masters/w1-gpio.c new file +3 -0
+static int __init w1_gpio_init(void)
+{
+	return platform_driver_register(&w1_gpio_driver);

...call platform_driver_probe(&w1_gpio_driver, w1_gpio_probe) here.

Haavard

#4 lore raw
Quoted 9 lines · Haavard Skinnemoen

Documentation/w1/masters/w1-gpio line 26

Quoted 3 lines · On Fri, 21 Dec 2007 09:34:01 +0200 Ville Syrjala <[email protected]> wrote:
Documentation/w1/masters/w1-gpio new file +3 -0
+static struct platform_device foo_w1_device = {
+	.name			= "w1-gpio",
+	.id			= -1,

Assigning -1 to a u32 member isn't a very nice example. What does it mean anyway?

id is 'int'. The bus_name won't include the id when -1 is used.

Quoted 8 lines
Quoted 1 line

+static int __init w1_gpio_probe(struct platform_device *pdev)

This must be __devinit, or if you want to save a bit of memory...

drivers/w1/masters/w1-gpio.c line 81

Quoted 1 line
drivers/w1/masters/w1-gpio.c new file +1 -0
+	.probe	= w1_gpio_probe,

...remove this line, and...

Quoted 5 lines

drivers/w1/masters/w1-gpio.c line 87

Quoted 3 lines
drivers/w1/masters/w1-gpio.c new file +3 -0
+static int __init w1_gpio_init(void)
+{
+	return platform_driver_register(&w1_gpio_driver);

...call platform_driver_probe(&w1_gpio_driver, w1_gpio_probe) here.

I was wondering what platform_driver_probe() was for but never bothered to read the code. I'll change the code to use it.

I already sent an updated patch but forgot to send this reply.

Signature · 3 lines
Ville Syrjälä
[email protected]
http://www.sci.fi/~syrjala/
#5 lore raw
Quoted 4 lines · On Thu, 3 Jan 2008 15:48:35 +0200 Ville Syrjälä <[email protected]> wrote:
Quoted 3 lines · Haavard Skinnemoen

On Fri, 21 Dec 2007 09:34:01 +0200
Ville Syrjala <[email protected]> wrote:

Quoted 8 lines
Quoted 6 lines

Documentation/w1/masters/w1-gpio line 26

Quoted 3 lines
Documentation/w1/masters/w1-gpio new file +3 -0
+static struct platform_device foo_w1_device = {
+	.name			= "w1-gpio",
+	.id			= -1,

Assigning -1 to a u32 member isn't a very nice example. What does it mean anyway?

id is 'int'. The bus_name won't include the id when -1 is used.

Ah, indeed. I was looking at 2.6.23, where it is u32.

Quoted 6 lines
Quoted 1 line

...call platform_driver_probe(&w1_gpio_driver, w1_gpio_probe) here.

I was wondering what platform_driver_probe() was for but never bothered to read the code. I'll change the code to use it.

I already sent an updated patch but forgot to send this reply.

I saw it. Thanks :)

Haavard