Skip to contentSkip to conversation

w1-gpio: add external pull-up enable callback

PATCH In review Daniel Mack 3 participants 9 messages May 5, 2009 – May 12, 2009 W1 dallas's 1-wire bus

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 w1-gpio: add external pull-up enable callback

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

When this callback is not provided, the code behaviour won't change.

---
 drivers/w1/masters/w1-gpio.c |   35 +++++++++++++++++++++++++++++++++++
 include/linux/w1-gpio.h      |    1 +
 2 files changed, 36 insertions(+), 0 deletions(-)
drivers/w1/masters/w1-gpio.c +35 -0
index a411702..6f8866d 100644
@@ -74,6 +74,9 @@ static int __init w1_gpio_probe(struct platform_device *pdev)
 	if (err)
 		goto free_gpio;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
 	platform_set_drvdata(pdev, master);
 
 	return 0;
@@ -91,6 +94,9 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	struct w1_bus_master *master = platform_get_drvdata(pdev);
 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
 	w1_remove_master_device(master);
 	gpio_free(pdata->pin);
 	kfree(master);
@@ -98,12 +104,41 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM
+
+static int w1_gpio_suspend(struct platform_device *pdev, pm_message_t state)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
+	return 0;
+}
+
+static int w1_gpio_resume(struct platform_device *pdev)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
+	return 0;
+}
+
+#else
+#define w1_gpio_suspend	NULL
+#define w1_gpio_resume	NULL
+#endif
+
 static struct platform_driver w1_gpio_driver = {
 	.driver = {
 		.name	= "w1-gpio",
 		.owner	= THIS_MODULE,
 	},
 	.remove	= __exit_p(w1_gpio_remove),
+	.suspend = w1_gpio_suspend,
+	.resume = w1_gpio_resume,
 };
 
 static int __init w1_gpio_init(void)
include/linux/w1-gpio.h +1 -0
index 9797fec..3adeff8 100644
@@ -18,6 +18,7 @@
 struct w1_gpio_platform_data {
 	unsigned int pin;
 	unsigned int is_open_drain:1;
+	void (*enable_external_pullup)(int enable);
 };
 
 #endif /* _LINUX_W1_GPIO_H */
Signature · 1 line
1.6.2.1
#1 lore raw
Quoted 8 lines · Daniel Mack

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

Looks simple enough but I wonder if you could just do this from the platform code. I suppose the downside would be that you would enable the pullup even if w1-gpio is not loaded.

Signature · 3 lines
Ville Syrjälä
[email protected]
http://www.sci.fi/~syrjala/
#2 lore raw
Quoted 6 lines · Ville Syrjälä
Quoted 5 lines · Daniel Mack

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

Quoted 7 lines
Quoted 3 lines

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

Looks simple enough but I wonder if you could just do this from the platform code. I suppose the downside would be that you would enable the pullup even if w1-gpio is not loaded.

That's right. Hence I put it where I believe it belongs to.

Thanks,
Daniel

#3 lore raw
Quoted 11 lines · Daniel Mack
Quoted 10 lines · Ville Syrjälä
Quoted 8 lines · Daniel Mack

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

Quoted 5 lines
Quoted 3 lines

Looks simple enough but I wonder if you could just do this from the platform code. I suppose the downside would be that you would enable the pullup even if w1-gpio is not loaded.

That's right. Hence I put it where I believe it belongs to.

Well, if you think you need it who am I to argue :)

Signature · 3 lines
Ville Syrjälä
[email protected]
http://www.sci.fi/~syrjala/
#4 lore raw
Quoted 8 lines · Ville Syrjälä
Quoted 8 lines
Quoted 7 lines
Quoted 3 lines

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

Looks simple enough but I wonder if you could just do this from the platform code. I suppose the downside would be that you would enable the pullup even if w1-gpio is not loaded.

Quoted 5 lines
Quoted 1 line

That's right. Hence I put it where I believe it belongs to.

Well, if you think you need it who am I to argue :)

Thanks :)

Daniel

#5 lore raw
Quoted 9 lines · Daniel Mack
Quoted 8 lines · Ville Syrjälä
Quoted 8 lines
Quoted 7 lines
Quoted 3 lines

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

Looks simple enough but I wonder if you could just do this from the platform code. I suppose the downside would be that you would enable the pullup even if w1-gpio is not loaded.

Quoted 7 lines
Quoted 5 lines
Quoted 1 line

That's right. Hence I put it where I believe it belongs to.

Well, if you think you need it who am I to argue :)

Thanks :)

BTW you should probably send this via Evgeniy Polyakov if you want it included in the kernel at some point.

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

(cc Evgeniy Polyakov)

Evgeniy, could you give some feedback on this? Ville Syrjala gave his Acked-by already.

Thanks,
Daniel

Quoted 99 lines · Daniel Mack

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

When this callback is not provided, the code behaviour won't change.

---
 drivers/w1/masters/w1-gpio.c |   35 +++++++++++++++++++++++++++++++++++
 include/linux/w1-gpio.h      |    1 +
 2 files changed, 36 insertions(+), 0 deletions(-)
drivers/w1/masters/w1-gpio.c +35 -0
index a411702..6f8866d 100644
@@ -74,6 +74,9 @@ static int __init w1_gpio_probe(struct platform_device *pdev)
 	if (err)
 		goto free_gpio;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
 	platform_set_drvdata(pdev, master);
 
 	return 0;
@@ -91,6 +94,9 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	struct w1_bus_master *master = platform_get_drvdata(pdev);
 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
 	w1_remove_master_device(master);
 	gpio_free(pdata->pin);
 	kfree(master);
@@ -98,12 +104,41 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM
+
+static int w1_gpio_suspend(struct platform_device *pdev, pm_message_t state)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
+	return 0;
+}
+
+static int w1_gpio_resume(struct platform_device *pdev)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
+	return 0;
+}
+
+#else
+#define w1_gpio_suspend	NULL
+#define w1_gpio_resume	NULL
+#endif
+
 static struct platform_driver w1_gpio_driver = {
 	.driver = {
 		.name	= "w1-gpio",
 		.owner	= THIS_MODULE,
 	},
 	.remove	= __exit_p(w1_gpio_remove),
+	.suspend = w1_gpio_suspend,
+	.resume = w1_gpio_resume,
 };
 
 static int __init w1_gpio_init(void)
include/linux/w1-gpio.h +1 -0
index 9797fec..3adeff8 100644
@@ -18,6 +18,7 @@
 struct w1_gpio_platform_data {
 	unsigned int pin;
 	unsigned int is_open_drain:1;
+	void (*enable_external_pullup)(int enable);
 };
 
 #endif /* _LINUX_W1_GPIO_H */
Signature · 1 line
1.6.2.1
#7 lore raw

Hi Daniel.

Quoted 4 lines · Daniel Mack

(cc Evgeniy Polyakov)

Evgeniy, could you give some feedback on this? Ville Syrjala gave his Acked-by already.

Looks good! Feel free to add mine too and submit through Andrew Morton or via other path.

Signature · 1 line
	Evgeniy Polyakov
author Acked-by Ville Syrjala Acked-by Evgeniy Polyakov on v1 1/1
#8 lore raw
In reply to Daniel Mack

(cc Andrew Morton)

Andrew,

could you add this to your patch queue? It's been acked by Ville Syrjala and Evgeniy Polyakov.

Thanks,
Daniel

Quoted 1 line

From 6a99f9453d9b0ad2dd705c012014063977781bf3 Mon Sep 17 00:00:00 2001

From: Daniel Mack <[email protected]>
Date: Tue, 5 May 2009 14:35:04 +0200
Subject: [PATCH] w1-gpio: add external pull-up enable callback

On embedded devices, sleep mode conditions can be tricky to handle, Especially when processors tend to pull-down the w1 bus during sleep. Bus slaves (such as the ds2760) may interpret this as a reason for power-down conditions and entirely switch off the device.

This patch adds a callback function pointer to let users switch on and off the external pull-up resistor. This lets the outside world know whether the processor is currently actively driving the bus or not.

When this callback is not provided, the code behaviour won't change.

---
 drivers/w1/masters/w1-gpio.c |   35 +++++++++++++++++++++++++++++++++++
 include/linux/w1-gpio.h      |    1 +
 2 files changed, 36 insertions(+), 0 deletions(-)
drivers/w1/masters/w1-gpio.c +35 -0
index a411702..6f8866d 100644
@@ -74,6 +74,9 @@ static int __init w1_gpio_probe(struct platform_device *pdev)
 	if (err)
 		goto free_gpio;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
 	platform_set_drvdata(pdev, master);
 
 	return 0;
@@ -91,6 +94,9 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	struct w1_bus_master *master = platform_get_drvdata(pdev);
 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
 
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
 	w1_remove_master_device(master);
 	gpio_free(pdata->pin);
 	kfree(master);
@@ -98,12 +104,41 @@ static int __exit w1_gpio_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM
+
+static int w1_gpio_suspend(struct platform_device *pdev, pm_message_t state)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(0);
+
+	return 0;
+}
+
+static int w1_gpio_resume(struct platform_device *pdev)
+{
+	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
+
+	if (pdata->enable_external_pullup)
+		pdata->enable_external_pullup(1);
+
+	return 0;
+}
+
+#else
+#define w1_gpio_suspend	NULL
+#define w1_gpio_resume	NULL
+#endif
+
 static struct platform_driver w1_gpio_driver = {
 	.driver = {
 		.name	= "w1-gpio",
 		.owner	= THIS_MODULE,
 	},
 	.remove	= __exit_p(w1_gpio_remove),
+	.suspend = w1_gpio_suspend,
+	.resume = w1_gpio_resume,
 };
 
 static int __init w1_gpio_init(void)
include/linux/w1-gpio.h +1 -0
index 9797fec..3adeff8 100644
@@ -18,6 +18,7 @@
 struct w1_gpio_platform_data {
 	unsigned int pin;
 	unsigned int is_open_drain:1;
+	void (*enable_external_pullup)(int enable);
 };
 
 #endif /* _LINUX_W1_GPIO_H */
Signature · 1 line
1.6.2.1