xref: /openbmc/linux/drivers/iio/dac/max517.c (revision 998f129c76e2030ad2e68cf59d75eef0e5a58fd3)
1dbdc025bSLars-Peter Clausen /*
2dbdc025bSLars-Peter Clausen  *  max517.c - Support for Maxim MAX517, MAX518 and MAX519
3dbdc025bSLars-Peter Clausen  *
4dbdc025bSLars-Peter Clausen  *  Copyright (C) 2010, 2011 Roland Stigge <stigge@antcom.de>
5dbdc025bSLars-Peter Clausen  *
6dbdc025bSLars-Peter Clausen  *  This program is free software; you can redistribute it and/or modify
7dbdc025bSLars-Peter Clausen  *  it under the terms of the GNU General Public License as published by
8dbdc025bSLars-Peter Clausen  *  the Free Software Foundation; either version 2 of the License, or
9dbdc025bSLars-Peter Clausen  *  (at your option) any later version.
10dbdc025bSLars-Peter Clausen  *
11dbdc025bSLars-Peter Clausen  *  This program is distributed in the hope that it will be useful,
12dbdc025bSLars-Peter Clausen  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13dbdc025bSLars-Peter Clausen  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14dbdc025bSLars-Peter Clausen  *  GNU General Public License for more details.
15dbdc025bSLars-Peter Clausen  *
16dbdc025bSLars-Peter Clausen  *  You should have received a copy of the GNU General Public License
17dbdc025bSLars-Peter Clausen  *  along with this program; if not, write to the Free Software
18dbdc025bSLars-Peter Clausen  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19dbdc025bSLars-Peter Clausen  */
20dbdc025bSLars-Peter Clausen 
21dbdc025bSLars-Peter Clausen #include <linux/module.h>
22dbdc025bSLars-Peter Clausen #include <linux/init.h>
23dbdc025bSLars-Peter Clausen #include <linux/slab.h>
24dbdc025bSLars-Peter Clausen #include <linux/jiffies.h>
25dbdc025bSLars-Peter Clausen #include <linux/i2c.h>
26dbdc025bSLars-Peter Clausen #include <linux/err.h>
27dbdc025bSLars-Peter Clausen 
28dbdc025bSLars-Peter Clausen #include <linux/iio/iio.h>
29dbdc025bSLars-Peter Clausen #include <linux/iio/sysfs.h>
30dbdc025bSLars-Peter Clausen #include <linux/iio/dac/max517.h>
31dbdc025bSLars-Peter Clausen 
32dbdc025bSLars-Peter Clausen #define MAX517_DRV_NAME	"max517"
33dbdc025bSLars-Peter Clausen 
34dbdc025bSLars-Peter Clausen /* Commands */
35dbdc025bSLars-Peter Clausen #define COMMAND_CHANNEL0	0x00
36dbdc025bSLars-Peter Clausen #define COMMAND_CHANNEL1	0x01 /* for MAX518 and MAX519 */
37dbdc025bSLars-Peter Clausen #define COMMAND_PD		0x08 /* Power Down */
38dbdc025bSLars-Peter Clausen 
39dbdc025bSLars-Peter Clausen enum max517_device_ids {
40dbdc025bSLars-Peter Clausen 	ID_MAX517,
41dbdc025bSLars-Peter Clausen 	ID_MAX518,
42dbdc025bSLars-Peter Clausen 	ID_MAX519,
43dbdc025bSLars-Peter Clausen };
44dbdc025bSLars-Peter Clausen 
45dbdc025bSLars-Peter Clausen struct max517_data {
46dbdc025bSLars-Peter Clausen 	struct i2c_client	*client;
47dbdc025bSLars-Peter Clausen 	unsigned short		vref_mv[2];
48dbdc025bSLars-Peter Clausen };
49dbdc025bSLars-Peter Clausen 
50dbdc025bSLars-Peter Clausen /*
51dbdc025bSLars-Peter Clausen  * channel: bit 0: channel 1
52dbdc025bSLars-Peter Clausen  *          bit 1: channel 2
53dbdc025bSLars-Peter Clausen  * (this way, it's possible to set both channels at once)
54dbdc025bSLars-Peter Clausen  */
55dbdc025bSLars-Peter Clausen static int max517_set_value(struct iio_dev *indio_dev,
56dbdc025bSLars-Peter Clausen 	long val, int channel)
57dbdc025bSLars-Peter Clausen {
58dbdc025bSLars-Peter Clausen 	struct max517_data *data = iio_priv(indio_dev);
59dbdc025bSLars-Peter Clausen 	struct i2c_client *client = data->client;
60dbdc025bSLars-Peter Clausen 	u8 outbuf[2];
61dbdc025bSLars-Peter Clausen 	int res;
62dbdc025bSLars-Peter Clausen 
63dbdc025bSLars-Peter Clausen 	if (val < 0 || val > 255)
64dbdc025bSLars-Peter Clausen 		return -EINVAL;
65dbdc025bSLars-Peter Clausen 
66dbdc025bSLars-Peter Clausen 	outbuf[0] = channel;
67dbdc025bSLars-Peter Clausen 	outbuf[1] = val;
68dbdc025bSLars-Peter Clausen 
69dbdc025bSLars-Peter Clausen 	res = i2c_master_send(client, outbuf, 2);
70dbdc025bSLars-Peter Clausen 	if (res < 0)
71dbdc025bSLars-Peter Clausen 		return res;
72dbdc025bSLars-Peter Clausen 	else if (res != 2)
73dbdc025bSLars-Peter Clausen 		return -EIO;
74dbdc025bSLars-Peter Clausen 	else
75dbdc025bSLars-Peter Clausen 		return 0;
76dbdc025bSLars-Peter Clausen }
77dbdc025bSLars-Peter Clausen 
78dbdc025bSLars-Peter Clausen static int max517_read_raw(struct iio_dev *indio_dev,
79dbdc025bSLars-Peter Clausen 			   struct iio_chan_spec const *chan,
80dbdc025bSLars-Peter Clausen 			   int *val,
81dbdc025bSLars-Peter Clausen 			   int *val2,
82dbdc025bSLars-Peter Clausen 			   long m)
83dbdc025bSLars-Peter Clausen {
84dbdc025bSLars-Peter Clausen 	struct max517_data *data = iio_priv(indio_dev);
85dbdc025bSLars-Peter Clausen 
86dbdc025bSLars-Peter Clausen 	switch (m) {
87dbdc025bSLars-Peter Clausen 	case IIO_CHAN_INFO_SCALE:
88dbdc025bSLars-Peter Clausen 		/* Corresponds to Vref / 2^(bits) */
89*998f129cSLars-Peter Clausen 		*val = data->vref_mv[chan->channel];
90*998f129cSLars-Peter Clausen 		*val2 = 8;
91*998f129cSLars-Peter Clausen 		return IIO_VAL_FRACTIONAL_LOG2;
92dbdc025bSLars-Peter Clausen 	default:
93dbdc025bSLars-Peter Clausen 		break;
94dbdc025bSLars-Peter Clausen 	}
95dbdc025bSLars-Peter Clausen 	return -EINVAL;
96dbdc025bSLars-Peter Clausen }
97dbdc025bSLars-Peter Clausen 
98dbdc025bSLars-Peter Clausen static int max517_write_raw(struct iio_dev *indio_dev,
99dbdc025bSLars-Peter Clausen 	struct iio_chan_spec const *chan, int val, int val2, long mask)
100dbdc025bSLars-Peter Clausen {
101dbdc025bSLars-Peter Clausen 	int ret;
102dbdc025bSLars-Peter Clausen 
103dbdc025bSLars-Peter Clausen 	switch (mask) {
104dbdc025bSLars-Peter Clausen 	case IIO_CHAN_INFO_RAW:
105dbdc025bSLars-Peter Clausen 		ret = max517_set_value(indio_dev, val, chan->channel);
106dbdc025bSLars-Peter Clausen 		break;
107dbdc025bSLars-Peter Clausen 	default:
108dbdc025bSLars-Peter Clausen 		ret = -EINVAL;
109dbdc025bSLars-Peter Clausen 		break;
110dbdc025bSLars-Peter Clausen 	}
111dbdc025bSLars-Peter Clausen 
112dbdc025bSLars-Peter Clausen 	return ret;
113dbdc025bSLars-Peter Clausen }
114dbdc025bSLars-Peter Clausen 
115dbdc025bSLars-Peter Clausen #ifdef CONFIG_PM_SLEEP
116dbdc025bSLars-Peter Clausen static int max517_suspend(struct device *dev)
117dbdc025bSLars-Peter Clausen {
118dbdc025bSLars-Peter Clausen 	u8 outbuf = COMMAND_PD;
119dbdc025bSLars-Peter Clausen 
120dbdc025bSLars-Peter Clausen 	return i2c_master_send(to_i2c_client(dev), &outbuf, 1);
121dbdc025bSLars-Peter Clausen }
122dbdc025bSLars-Peter Clausen 
123dbdc025bSLars-Peter Clausen static int max517_resume(struct device *dev)
124dbdc025bSLars-Peter Clausen {
125dbdc025bSLars-Peter Clausen 	u8 outbuf = 0;
126dbdc025bSLars-Peter Clausen 
127dbdc025bSLars-Peter Clausen 	return i2c_master_send(to_i2c_client(dev), &outbuf, 1);
128dbdc025bSLars-Peter Clausen }
129dbdc025bSLars-Peter Clausen 
130dbdc025bSLars-Peter Clausen static SIMPLE_DEV_PM_OPS(max517_pm_ops, max517_suspend, max517_resume);
131dbdc025bSLars-Peter Clausen #define MAX517_PM_OPS (&max517_pm_ops)
132dbdc025bSLars-Peter Clausen #else
133dbdc025bSLars-Peter Clausen #define MAX517_PM_OPS NULL
134dbdc025bSLars-Peter Clausen #endif
135dbdc025bSLars-Peter Clausen 
136dbdc025bSLars-Peter Clausen static const struct iio_info max517_info = {
137dbdc025bSLars-Peter Clausen 	.read_raw = max517_read_raw,
138dbdc025bSLars-Peter Clausen 	.write_raw = max517_write_raw,
139dbdc025bSLars-Peter Clausen 	.driver_module = THIS_MODULE,
140dbdc025bSLars-Peter Clausen };
141dbdc025bSLars-Peter Clausen 
142dbdc025bSLars-Peter Clausen #define MAX517_CHANNEL(chan) {				\
143dbdc025bSLars-Peter Clausen 	.type = IIO_VOLTAGE,				\
144dbdc025bSLars-Peter Clausen 	.indexed = 1,					\
145dbdc025bSLars-Peter Clausen 	.output = 1,					\
146dbdc025bSLars-Peter Clausen 	.channel = (chan),				\
147040b837eSJonathan Cameron 	.info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |	\
148040b837eSJonathan Cameron 	BIT(IIO_CHAN_INFO_SCALE),			\
149dbdc025bSLars-Peter Clausen 	.scan_type = IIO_ST('u', 8, 8, 0),		\
150dbdc025bSLars-Peter Clausen }
151dbdc025bSLars-Peter Clausen 
152dbdc025bSLars-Peter Clausen static const struct iio_chan_spec max517_channels[] = {
153dbdc025bSLars-Peter Clausen 	MAX517_CHANNEL(0),
154dbdc025bSLars-Peter Clausen 	MAX517_CHANNEL(1)
155dbdc025bSLars-Peter Clausen };
156dbdc025bSLars-Peter Clausen 
157fc52692cSGreg Kroah-Hartman static int max517_probe(struct i2c_client *client,
158dbdc025bSLars-Peter Clausen 			const struct i2c_device_id *id)
159dbdc025bSLars-Peter Clausen {
160dbdc025bSLars-Peter Clausen 	struct max517_data *data;
161dbdc025bSLars-Peter Clausen 	struct iio_dev *indio_dev;
162dbdc025bSLars-Peter Clausen 	struct max517_platform_data *platform_data = client->dev.platform_data;
163dbdc025bSLars-Peter Clausen 	int err;
164dbdc025bSLars-Peter Clausen 
165cc566fd5SSachin Kamat 	indio_dev = devm_iio_device_alloc(&client->dev, sizeof(*data));
166cc566fd5SSachin Kamat 	if (!indio_dev)
167cc566fd5SSachin Kamat 		return -ENOMEM;
168dbdc025bSLars-Peter Clausen 	data = iio_priv(indio_dev);
169dbdc025bSLars-Peter Clausen 	i2c_set_clientdata(client, indio_dev);
170dbdc025bSLars-Peter Clausen 	data->client = client;
171dbdc025bSLars-Peter Clausen 
172dbdc025bSLars-Peter Clausen 	/* establish that the iio_dev is a child of the i2c device */
173dbdc025bSLars-Peter Clausen 	indio_dev->dev.parent = &client->dev;
174dbdc025bSLars-Peter Clausen 
175dbdc025bSLars-Peter Clausen 	/* reduced channel set for MAX517 */
176dbdc025bSLars-Peter Clausen 	if (id->driver_data == ID_MAX517)
177dbdc025bSLars-Peter Clausen 		indio_dev->num_channels = 1;
178dbdc025bSLars-Peter Clausen 	else
179dbdc025bSLars-Peter Clausen 		indio_dev->num_channels = 2;
180dbdc025bSLars-Peter Clausen 	indio_dev->channels = max517_channels;
181dbdc025bSLars-Peter Clausen 	indio_dev->modes = INDIO_DIRECT_MODE;
182dbdc025bSLars-Peter Clausen 	indio_dev->info = &max517_info;
183dbdc025bSLars-Peter Clausen 
184dbdc025bSLars-Peter Clausen 	/*
185dbdc025bSLars-Peter Clausen 	 * Reference voltage on MAX518 and default is 5V, else take vref_mv
186dbdc025bSLars-Peter Clausen 	 * from platform_data
187dbdc025bSLars-Peter Clausen 	 */
188dbdc025bSLars-Peter Clausen 	if (id->driver_data == ID_MAX518 || !platform_data) {
189dbdc025bSLars-Peter Clausen 		data->vref_mv[0] = data->vref_mv[1] = 5000; /* mV */
190dbdc025bSLars-Peter Clausen 	} else {
191dbdc025bSLars-Peter Clausen 		data->vref_mv[0] = platform_data->vref_mv[0];
192dbdc025bSLars-Peter Clausen 		data->vref_mv[1] = platform_data->vref_mv[1];
193dbdc025bSLars-Peter Clausen 	}
194dbdc025bSLars-Peter Clausen 
195dbdc025bSLars-Peter Clausen 	err = iio_device_register(indio_dev);
196dbdc025bSLars-Peter Clausen 	if (err)
197cc566fd5SSachin Kamat 		return err;
198dbdc025bSLars-Peter Clausen 
199dbdc025bSLars-Peter Clausen 	dev_info(&client->dev, "DAC registered\n");
200dbdc025bSLars-Peter Clausen 
201dbdc025bSLars-Peter Clausen 	return 0;
202dbdc025bSLars-Peter Clausen }
203dbdc025bSLars-Peter Clausen 
204fc52692cSGreg Kroah-Hartman static int max517_remove(struct i2c_client *client)
205dbdc025bSLars-Peter Clausen {
206dbdc025bSLars-Peter Clausen 	iio_device_unregister(i2c_get_clientdata(client));
207dbdc025bSLars-Peter Clausen 	return 0;
208dbdc025bSLars-Peter Clausen }
209dbdc025bSLars-Peter Clausen 
210dbdc025bSLars-Peter Clausen static const struct i2c_device_id max517_id[] = {
211dbdc025bSLars-Peter Clausen 	{ "max517", ID_MAX517 },
212dbdc025bSLars-Peter Clausen 	{ "max518", ID_MAX518 },
213dbdc025bSLars-Peter Clausen 	{ "max519", ID_MAX519 },
214dbdc025bSLars-Peter Clausen 	{ }
215dbdc025bSLars-Peter Clausen };
216dbdc025bSLars-Peter Clausen MODULE_DEVICE_TABLE(i2c, max517_id);
217dbdc025bSLars-Peter Clausen 
218dbdc025bSLars-Peter Clausen static struct i2c_driver max517_driver = {
219dbdc025bSLars-Peter Clausen 	.driver = {
220dbdc025bSLars-Peter Clausen 		.name	= MAX517_DRV_NAME,
221dbdc025bSLars-Peter Clausen 		.pm		= MAX517_PM_OPS,
222dbdc025bSLars-Peter Clausen 	},
223dbdc025bSLars-Peter Clausen 	.probe		= max517_probe,
224fc52692cSGreg Kroah-Hartman 	.remove		= max517_remove,
225dbdc025bSLars-Peter Clausen 	.id_table	= max517_id,
226dbdc025bSLars-Peter Clausen };
227dbdc025bSLars-Peter Clausen module_i2c_driver(max517_driver);
228dbdc025bSLars-Peter Clausen 
229dbdc025bSLars-Peter Clausen MODULE_AUTHOR("Roland Stigge <stigge@antcom.de>");
230dbdc025bSLars-Peter Clausen MODULE_DESCRIPTION("MAX517/MAX518/MAX519 8-bit DAC");
231dbdc025bSLars-Peter Clausen MODULE_LICENSE("GPL");
232