xref: /openbmc/linux/drivers/w1/masters/w1-gpio.c (revision 277ed0d542778182c863c30bdbd2441dee3f964c)
1ad8dc96eSVille Syrjala /*
2ad8dc96eSVille Syrjala  * w1-gpio - GPIO w1 bus master driver
3ad8dc96eSVille Syrjala  *
4ad8dc96eSVille Syrjala  * Copyright (C) 2007 Ville Syrjala <syrjala@sci.fi>
5ad8dc96eSVille Syrjala  *
6ad8dc96eSVille Syrjala  * This program is free software; you can redistribute it and/or modify
7ad8dc96eSVille Syrjala  * it under the terms of the GNU General Public License version 2
8ad8dc96eSVille Syrjala  * as published by the Free Software Foundation.
9ad8dc96eSVille Syrjala  */
10ad8dc96eSVille Syrjala 
11ad8dc96eSVille Syrjala #include <linux/init.h>
12ad8dc96eSVille Syrjala #include <linux/module.h>
13ad8dc96eSVille Syrjala #include <linux/platform_device.h>
145a0e3ad6STejun Heo #include <linux/slab.h>
15ad8dc96eSVille Syrjala #include <linux/w1-gpio.h>
16e250b34eSMark Brown #include <linux/gpio.h>
175f3d1382SDaniel Mack #include <linux/of_platform.h>
185f3d1382SDaniel Mack #include <linux/of_gpio.h>
19*277ed0d5SPantelis Antoniou #include <linux/pinctrl/consumer.h>
20*277ed0d5SPantelis Antoniou #include <linux/err.h>
21ad8dc96eSVille Syrjala 
22ad8dc96eSVille Syrjala #include "../w1.h"
23ad8dc96eSVille Syrjala #include "../w1_int.h"
24ad8dc96eSVille Syrjala 
25ad8dc96eSVille Syrjala static void w1_gpio_write_bit_dir(void *data, u8 bit)
26ad8dc96eSVille Syrjala {
27ad8dc96eSVille Syrjala 	struct w1_gpio_platform_data *pdata = data;
28ad8dc96eSVille Syrjala 
29ad8dc96eSVille Syrjala 	if (bit)
30ad8dc96eSVille Syrjala 		gpio_direction_input(pdata->pin);
31ad8dc96eSVille Syrjala 	else
32ad8dc96eSVille Syrjala 		gpio_direction_output(pdata->pin, 0);
33ad8dc96eSVille Syrjala }
34ad8dc96eSVille Syrjala 
35ad8dc96eSVille Syrjala static void w1_gpio_write_bit_val(void *data, u8 bit)
36ad8dc96eSVille Syrjala {
37ad8dc96eSVille Syrjala 	struct w1_gpio_platform_data *pdata = data;
38ad8dc96eSVille Syrjala 
39ad8dc96eSVille Syrjala 	gpio_set_value(pdata->pin, bit);
40ad8dc96eSVille Syrjala }
41ad8dc96eSVille Syrjala 
42ad8dc96eSVille Syrjala static u8 w1_gpio_read_bit(void *data)
43ad8dc96eSVille Syrjala {
44ad8dc96eSVille Syrjala 	struct w1_gpio_platform_data *pdata = data;
45ad8dc96eSVille Syrjala 
468d0df7a3SDaniel Mack 	return gpio_get_value(pdata->pin) ? 1 : 0;
47ad8dc96eSVille Syrjala }
48ad8dc96eSVille Syrjala 
495f3d1382SDaniel Mack #ifdef CONFIG_OF
505f3d1382SDaniel Mack static struct of_device_id w1_gpio_dt_ids[] = {
515f3d1382SDaniel Mack 	{ .compatible = "w1-gpio" },
525f3d1382SDaniel Mack 	{}
535f3d1382SDaniel Mack };
545f3d1382SDaniel Mack MODULE_DEVICE_TABLE(of, w1_gpio_dt_ids);
555f3d1382SDaniel Mack 
565f3d1382SDaniel Mack static int w1_gpio_probe_dt(struct platform_device *pdev)
575f3d1382SDaniel Mack {
585f3d1382SDaniel Mack 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
595f3d1382SDaniel Mack 	struct device_node *np = pdev->dev.of_node;
605f3d1382SDaniel Mack 	const struct of_device_id *of_id =
615f3d1382SDaniel Mack 			of_match_device(w1_gpio_dt_ids, &pdev->dev);
625f3d1382SDaniel Mack 
635f3d1382SDaniel Mack 	if (!of_id)
645f3d1382SDaniel Mack 		return 0;
655f3d1382SDaniel Mack 
665f3d1382SDaniel Mack 	pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
675f3d1382SDaniel Mack 	if (!pdata)
685f3d1382SDaniel Mack 		return -ENOMEM;
695f3d1382SDaniel Mack 
705f3d1382SDaniel Mack 	if (of_get_property(np, "linux,open-drain", NULL))
715f3d1382SDaniel Mack 		pdata->is_open_drain = 1;
725f3d1382SDaniel Mack 
735f3d1382SDaniel Mack 	pdata->pin = of_get_gpio(np, 0);
745f3d1382SDaniel Mack 	pdata->ext_pullup_enable_pin = of_get_gpio(np, 1);
755f3d1382SDaniel Mack 	pdev->dev.platform_data = pdata;
765f3d1382SDaniel Mack 
775f3d1382SDaniel Mack 	return 0;
785f3d1382SDaniel Mack }
795f3d1382SDaniel Mack #else
805f3d1382SDaniel Mack static int w1_gpio_probe_dt(struct platform_device *pdev)
815f3d1382SDaniel Mack {
825f3d1382SDaniel Mack 	return 0;
835f3d1382SDaniel Mack }
845f3d1382SDaniel Mack #endif
855f3d1382SDaniel Mack 
86ad8dc96eSVille Syrjala static int __init w1_gpio_probe(struct platform_device *pdev)
87ad8dc96eSVille Syrjala {
88ad8dc96eSVille Syrjala 	struct w1_bus_master *master;
895f3d1382SDaniel Mack 	struct w1_gpio_platform_data *pdata;
90*277ed0d5SPantelis Antoniou 	struct pinctrl *pinctrl;
91ad8dc96eSVille Syrjala 	int err;
92ad8dc96eSVille Syrjala 
93*277ed0d5SPantelis Antoniou 	pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
94*277ed0d5SPantelis Antoniou 	if (IS_ERR(pinctrl))
95*277ed0d5SPantelis Antoniou 		dev_warn(&pdev->dev, "unable to select pin group\n");
96*277ed0d5SPantelis Antoniou 
975f3d1382SDaniel Mack 	err = w1_gpio_probe_dt(pdev);
985f3d1382SDaniel Mack 	if (err < 0)
995f3d1382SDaniel Mack 		return err;
1005f3d1382SDaniel Mack 
1015f3d1382SDaniel Mack 	pdata = pdev->dev.platform_data;
1025f3d1382SDaniel Mack 
103ad8dc96eSVille Syrjala 	if (!pdata)
104ad8dc96eSVille Syrjala 		return -ENXIO;
105ad8dc96eSVille Syrjala 
106ad8dc96eSVille Syrjala 	master = kzalloc(sizeof(struct w1_bus_master), GFP_KERNEL);
107ad8dc96eSVille Syrjala 	if (!master)
108ad8dc96eSVille Syrjala 		return -ENOMEM;
109ad8dc96eSVille Syrjala 
110ad8dc96eSVille Syrjala 	err = gpio_request(pdata->pin, "w1");
111ad8dc96eSVille Syrjala 	if (err)
112ad8dc96eSVille Syrjala 		goto free_master;
113ad8dc96eSVille Syrjala 
114d2323cf7SDaniel Mack 	if (gpio_is_valid(pdata->ext_pullup_enable_pin)) {
115d2323cf7SDaniel Mack 		err = gpio_request_one(pdata->ext_pullup_enable_pin,
116d2323cf7SDaniel Mack 				       GPIOF_INIT_LOW, "w1 pullup");
117d2323cf7SDaniel Mack 		if (err < 0)
118d2323cf7SDaniel Mack 			goto free_gpio;
119d2323cf7SDaniel Mack 	}
120d2323cf7SDaniel Mack 
121ad8dc96eSVille Syrjala 	master->data = pdata;
122ad8dc96eSVille Syrjala 	master->read_bit = w1_gpio_read_bit;
123ad8dc96eSVille Syrjala 
124ad8dc96eSVille Syrjala 	if (pdata->is_open_drain) {
125ad8dc96eSVille Syrjala 		gpio_direction_output(pdata->pin, 1);
126ad8dc96eSVille Syrjala 		master->write_bit = w1_gpio_write_bit_val;
127ad8dc96eSVille Syrjala 	} else {
128ad8dc96eSVille Syrjala 		gpio_direction_input(pdata->pin);
129ad8dc96eSVille Syrjala 		master->write_bit = w1_gpio_write_bit_dir;
130ad8dc96eSVille Syrjala 	}
131ad8dc96eSVille Syrjala 
132ad8dc96eSVille Syrjala 	err = w1_add_master_device(master);
133ad8dc96eSVille Syrjala 	if (err)
134d2323cf7SDaniel Mack 		goto free_gpio_ext_pu;
135ad8dc96eSVille Syrjala 
136c8a06c1eSDaniel Mack 	if (pdata->enable_external_pullup)
137c8a06c1eSDaniel Mack 		pdata->enable_external_pullup(1);
138c8a06c1eSDaniel Mack 
139d2323cf7SDaniel Mack 	if (gpio_is_valid(pdata->ext_pullup_enable_pin))
140d2323cf7SDaniel Mack 		gpio_set_value(pdata->ext_pullup_enable_pin, 1);
141d2323cf7SDaniel Mack 
142ad8dc96eSVille Syrjala 	platform_set_drvdata(pdev, master);
143ad8dc96eSVille Syrjala 
144ad8dc96eSVille Syrjala 	return 0;
145ad8dc96eSVille Syrjala 
146d2323cf7SDaniel Mack  free_gpio_ext_pu:
147d2323cf7SDaniel Mack 	if (gpio_is_valid(pdata->ext_pullup_enable_pin))
148d2323cf7SDaniel Mack 		gpio_free(pdata->ext_pullup_enable_pin);
149ad8dc96eSVille Syrjala  free_gpio:
150ad8dc96eSVille Syrjala 	gpio_free(pdata->pin);
151ad8dc96eSVille Syrjala  free_master:
152ad8dc96eSVille Syrjala 	kfree(master);
153ad8dc96eSVille Syrjala 
154ad8dc96eSVille Syrjala 	return err;
155ad8dc96eSVille Syrjala }
156ad8dc96eSVille Syrjala 
157ad8dc96eSVille Syrjala static int __exit w1_gpio_remove(struct platform_device *pdev)
158ad8dc96eSVille Syrjala {
159ad8dc96eSVille Syrjala 	struct w1_bus_master *master = platform_get_drvdata(pdev);
160ad8dc96eSVille Syrjala 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
161ad8dc96eSVille Syrjala 
162c8a06c1eSDaniel Mack 	if (pdata->enable_external_pullup)
163c8a06c1eSDaniel Mack 		pdata->enable_external_pullup(0);
164c8a06c1eSDaniel Mack 
165d2323cf7SDaniel Mack 	if (gpio_is_valid(pdata->ext_pullup_enable_pin))
166d2323cf7SDaniel Mack 		gpio_set_value(pdata->ext_pullup_enable_pin, 0);
167d2323cf7SDaniel Mack 
168ad8dc96eSVille Syrjala 	w1_remove_master_device(master);
169ad8dc96eSVille Syrjala 	gpio_free(pdata->pin);
170ad8dc96eSVille Syrjala 	kfree(master);
171ad8dc96eSVille Syrjala 
172ad8dc96eSVille Syrjala 	return 0;
173ad8dc96eSVille Syrjala }
174ad8dc96eSVille Syrjala 
175c8a06c1eSDaniel Mack #ifdef CONFIG_PM
176c8a06c1eSDaniel Mack 
177c8a06c1eSDaniel Mack static int w1_gpio_suspend(struct platform_device *pdev, pm_message_t state)
178c8a06c1eSDaniel Mack {
179c8a06c1eSDaniel Mack 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
180c8a06c1eSDaniel Mack 
181c8a06c1eSDaniel Mack 	if (pdata->enable_external_pullup)
182c8a06c1eSDaniel Mack 		pdata->enable_external_pullup(0);
183c8a06c1eSDaniel Mack 
184c8a06c1eSDaniel Mack 	return 0;
185c8a06c1eSDaniel Mack }
186c8a06c1eSDaniel Mack 
187c8a06c1eSDaniel Mack static int w1_gpio_resume(struct platform_device *pdev)
188c8a06c1eSDaniel Mack {
189c8a06c1eSDaniel Mack 	struct w1_gpio_platform_data *pdata = pdev->dev.platform_data;
190c8a06c1eSDaniel Mack 
191c8a06c1eSDaniel Mack 	if (pdata->enable_external_pullup)
192c8a06c1eSDaniel Mack 		pdata->enable_external_pullup(1);
193c8a06c1eSDaniel Mack 
194c8a06c1eSDaniel Mack 	return 0;
195c8a06c1eSDaniel Mack }
196c8a06c1eSDaniel Mack 
197c8a06c1eSDaniel Mack #else
198c8a06c1eSDaniel Mack #define w1_gpio_suspend	NULL
199c8a06c1eSDaniel Mack #define w1_gpio_resume	NULL
200c8a06c1eSDaniel Mack #endif
201c8a06c1eSDaniel Mack 
202ad8dc96eSVille Syrjala static struct platform_driver w1_gpio_driver = {
203ad8dc96eSVille Syrjala 	.driver = {
204ad8dc96eSVille Syrjala 		.name	= "w1-gpio",
205ad8dc96eSVille Syrjala 		.owner	= THIS_MODULE,
2065f3d1382SDaniel Mack 		.of_match_table = of_match_ptr(w1_gpio_dt_ids),
207ad8dc96eSVille Syrjala 	},
208ad8dc96eSVille Syrjala 	.remove	= __exit_p(w1_gpio_remove),
209c8a06c1eSDaniel Mack 	.suspend = w1_gpio_suspend,
210c8a06c1eSDaniel Mack 	.resume = w1_gpio_resume,
211ad8dc96eSVille Syrjala };
212ad8dc96eSVille Syrjala 
213ad8dc96eSVille Syrjala static int __init w1_gpio_init(void)
214ad8dc96eSVille Syrjala {
215ad8dc96eSVille Syrjala 	return platform_driver_probe(&w1_gpio_driver, w1_gpio_probe);
216ad8dc96eSVille Syrjala }
217ad8dc96eSVille Syrjala 
218ad8dc96eSVille Syrjala static void __exit w1_gpio_exit(void)
219ad8dc96eSVille Syrjala {
220ad8dc96eSVille Syrjala 	platform_driver_unregister(&w1_gpio_driver);
221ad8dc96eSVille Syrjala }
222ad8dc96eSVille Syrjala 
223ad8dc96eSVille Syrjala module_init(w1_gpio_init);
224ad8dc96eSVille Syrjala module_exit(w1_gpio_exit);
225ad8dc96eSVille Syrjala 
226ad8dc96eSVille Syrjala MODULE_DESCRIPTION("GPIO w1 bus master driver");
227ad8dc96eSVille Syrjala MODULE_AUTHOR("Ville Syrjala <syrjala@sci.fi>");
228ad8dc96eSVille Syrjala MODULE_LICENSE("GPL");
229