staging:iio:adc: Add SPEAr ADC driver
[deliverable/linux.git] / drivers / staging / iio / adc / spear_adc.c
CommitLineData
b3201b56
SR
1/*
2 * ST SPEAr ADC driver
3 *
4 * Copyright 2012 Stefan Roese <sr@denx.de>
5 *
6 * Licensed under the GPL-2.
7 */
8
9#include <linux/module.h>
10#include <linux/platform_device.h>
11#include <linux/interrupt.h>
12#include <linux/device.h>
13#include <linux/kernel.h>
14#include <linux/slab.h>
15#include <linux/io.h>
16#include <linux/clk.h>
17#include <linux/err.h>
18#include <linux/completion.h>
19#include <linux/of.h>
20#include <linux/of_address.h>
21
22#include "../iio.h"
23#include "../sysfs.h"
24
25/*
26 * SPEAR registers definitions
27 */
28
29#define SCAN_RATE_LO(x) ((x) & 0xFFFF)
30#define SCAN_RATE_HI(x) (((x) >> 0x10) & 0xFFFF)
31#define CLK_LOW(x) (((x) & 0xf) << 0)
32#define CLK_HIGH(x) (((x) & 0xf) << 4)
33
34/* Bit definitions for SPEAR_ADC_STATUS */
35#define START_CONVERSION (1 << 0)
36#define CHANNEL_NUM(x) ((x) << 1)
37#define ADC_ENABLE (1 << 4)
38#define AVG_SAMPLE(x) ((x) << 5)
39#define VREF_INTERNAL (1 << 9)
40
41#define DATA_MASK 0x03ff
42#define DATA_BITS 10
43
44#define MOD_NAME "spear-adc"
45
46#define ADC_CHANNEL_NUM 8
47
48#define CLK_MIN 2500000
49#define CLK_MAX 20000000
50
51struct adc_regs_spear3xx {
52 u32 status;
53 u32 average;
54 u32 scan_rate;
55 u32 clk; /* Not avail for 1340 & 1310 */
56 u32 ch_ctrl[ADC_CHANNEL_NUM];
57 u32 ch_data[ADC_CHANNEL_NUM];
58};
59
60struct chan_data {
61 u32 lsb;
62 u32 msb;
63};
64
65struct adc_regs_spear6xx {
66 u32 status;
67 u32 pad[2];
68 u32 clk;
69 u32 ch_ctrl[ADC_CHANNEL_NUM];
70 struct chan_data ch_data[ADC_CHANNEL_NUM];
71 u32 scan_rate_lo;
72 u32 scan_rate_hi;
73 struct chan_data average;
74};
75
76struct spear_adc_info {
77 struct device_node *np;
78 struct adc_regs_spear3xx __iomem *adc_base_spear3xx;
79 struct adc_regs_spear6xx __iomem *adc_base_spear6xx;
80 struct clk *clk;
81 struct completion completion;
82 u32 current_clk;
83 u32 sampling_freq;
84 u32 avg_samples;
85 u32 vref_external;
86 u32 value;
87};
88
89/*
90 * Functions to access some SPEAr ADC register. Abstracted into
91 * static inline functions, because of different register offsets
92 * on different SoC variants (SPEAr300 vs SPEAr600 etc).
93 */
94static void spear_adc_set_status(struct spear_adc_info *info, u32 val)
95{
96 __raw_writel(val, &info->adc_base_spear6xx->status);
97}
98
99static void spear_adc_set_clk(struct spear_adc_info *info, u32 val)
100{
101 u32 clk_high, clk_low, count;
102 u32 apb_clk = clk_get_rate(info->clk);
103
104 count = (apb_clk + val - 1) / val;
105 clk_low = count / 2;
106 clk_high = count - clk_low;
107 info->current_clk = apb_clk / count;
108
109 __raw_writel(CLK_LOW(clk_low) | CLK_HIGH(clk_high),
110 &info->adc_base_spear6xx->clk);
111}
112
113static void spear_adc_set_ctrl(struct spear_adc_info *info, int n,
114 u32 val)
115{
116 __raw_writel(val, &info->adc_base_spear6xx->ch_ctrl[n]);
117}
118
119static u32 spear_adc_get_average(struct spear_adc_info *info)
120{
121 if (of_device_is_compatible(info->np, "st,spear600-adc")) {
122 return __raw_readl(&info->adc_base_spear6xx->average.msb) &
123 DATA_MASK;
124 } else {
125 return __raw_readl(&info->adc_base_spear3xx->average) &
126 DATA_MASK;
127 }
128}
129
130static void spear_adc_set_scanrate(struct spear_adc_info *info, u32 rate)
131{
132 if (of_device_is_compatible(info->np, "st,spear600-adc")) {
133 __raw_writel(SCAN_RATE_LO(rate),
134 &info->adc_base_spear6xx->scan_rate_lo);
135 __raw_writel(SCAN_RATE_HI(rate),
136 &info->adc_base_spear6xx->scan_rate_hi);
137 } else {
138 __raw_writel(rate, &info->adc_base_spear3xx->scan_rate);
139 }
140}
141
142static int spear_read_raw(struct iio_dev *indio_dev,
143 struct iio_chan_spec const *chan,
144 int *val,
145 int *val2,
146 long mask)
147{
148 struct spear_adc_info *info = iio_priv(indio_dev);
149 u32 scale_mv;
150 u32 status;
151
152 switch (mask) {
153 case 0:
154 mutex_lock(&indio_dev->mlock);
155
156 status = CHANNEL_NUM(chan->channel) |
157 AVG_SAMPLE(info->avg_samples) |
158 START_CONVERSION | ADC_ENABLE;
159 if (info->vref_external == 0)
160 status |= VREF_INTERNAL;
161
162 spear_adc_set_status(info, status);
163 wait_for_completion(&info->completion); /* set by ISR */
164 *val = info->value;
165
166 mutex_unlock(&indio_dev->mlock);
167
168 return IIO_VAL_INT;
169
170 case IIO_CHAN_INFO_SCALE:
171 scale_mv = (info->vref_external * 1000) >> DATA_BITS;
172 *val = scale_mv / 1000;
173 *val2 = (scale_mv % 1000) * 1000;
174 return IIO_VAL_INT_PLUS_MICRO;
175 }
176
177 return -EINVAL;
178}
179
180#define SPEAR_ADC_CHAN(idx) { \
181 .type = IIO_VOLTAGE, \
182 .indexed = 1, \
183 .info_mask = IIO_CHAN_INFO_SCALE_SHARED_BIT, \
184 .channel = idx, \
185 .scan_type = { \
186 .sign = 'u', \
187 .storagebits = 16, \
188 }, \
189}
190
191static struct iio_chan_spec spear_adc_iio_channels[] = {
192 SPEAR_ADC_CHAN(0),
193 SPEAR_ADC_CHAN(1),
194 SPEAR_ADC_CHAN(2),
195 SPEAR_ADC_CHAN(3),
196 SPEAR_ADC_CHAN(4),
197 SPEAR_ADC_CHAN(5),
198 SPEAR_ADC_CHAN(6),
199 SPEAR_ADC_CHAN(7),
200};
201
202static irqreturn_t spear_adc_isr(int irq, void *dev_id)
203{
204 struct spear_adc_info *info = (struct spear_adc_info *)dev_id;
205
206 /* Read value to clear IRQ */
207 info->value = spear_adc_get_average(info);
208 complete(&info->completion);
209
210 return IRQ_HANDLED;
211}
212
213static int spear_adc_configure(struct spear_adc_info *info)
214{
215 int i;
216
217 /* Reset ADC core */
218 spear_adc_set_status(info, 0);
219 __raw_writel(0, &info->adc_base_spear6xx->clk);
220 for (i = 0; i < 8; i++)
221 spear_adc_set_ctrl(info, i, 0);
222 spear_adc_set_scanrate(info, 0);
223
224 spear_adc_set_clk(info, info->sampling_freq);
225
226 return 0;
227}
228
229static ssize_t spear_adc_read_frequency(struct device *dev,
230 struct device_attribute *attr,
231 char *buf)
232{
233 struct iio_dev *indio_dev = dev_get_drvdata(dev);
234 struct spear_adc_info *info = iio_priv(indio_dev);
235
236 return sprintf(buf, "%d\n", info->current_clk);
237}
238
239static ssize_t spear_adc_write_frequency(struct device *dev,
240 struct device_attribute *attr,
241 const char *buf,
242 size_t len)
243{
244 struct iio_dev *indio_dev = dev_get_drvdata(dev);
245 struct spear_adc_info *info = iio_priv(indio_dev);
246 u32 clk_high, clk_low, count;
247 u32 apb_clk = clk_get_rate(info->clk);
248 unsigned long lval;
249 int ret;
250
251 ret = kstrtoul(buf, 10, &lval);
252 if (ret)
253 return ret;
254
255 mutex_lock(&indio_dev->mlock);
256
257 if ((lval < CLK_MIN) || (lval > CLK_MAX)) {
258 ret = -EINVAL;
259 goto out;
260 }
261
262 count = (apb_clk + lval - 1) / lval;
263 clk_low = count / 2;
264 clk_high = count - clk_low;
265 info->current_clk = apb_clk / count;
266 spear_adc_set_clk(info, lval);
267
268out:
269 mutex_unlock(&indio_dev->mlock);
270
271 return ret ? ret : len;
272}
273
274static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
275 spear_adc_read_frequency,
276 spear_adc_write_frequency);
277
278static struct attribute *spear_attributes[] = {
279 &iio_dev_attr_sampling_frequency.dev_attr.attr,
280 NULL
281};
282
283static const struct attribute_group spear_attribute_group = {
284 .attrs = spear_attributes,
285};
286
287static const struct iio_info spear_adc_iio_info = {
288 .read_raw = &spear_read_raw,
289 .attrs = &spear_attribute_group,
290 .driver_module = THIS_MODULE,
291};
292
293static int __devinit spear_adc_probe(struct platform_device *pdev)
294{
295 struct device_node *np = pdev->dev.of_node;
296 struct device *dev = &pdev->dev;
297 struct spear_adc_info *info;
298 struct iio_dev *iodev = NULL;
299 int ret = -ENODEV;
300 int irq;
301
302 iodev = iio_allocate_device(sizeof(struct spear_adc_info));
303 if (!iodev) {
304 dev_err(dev, "failed allocating iio device\n");
305 ret = -ENOMEM;
306 goto errout1;
307 }
308
309 info = iio_priv(iodev);
310 info->np = np;
311
312 /*
313 * SPEAr600 has a different register layout than other SPEAr SoC's
314 * (e.g. SPEAr3xx). Let's provide two register base addresses
315 * to support multi-arch kernels.
316 */
317 info->adc_base_spear6xx = of_iomap(np, 0);
318 if (!info->adc_base_spear6xx) {
319 dev_err(dev, "failed mapping memory\n");
320 ret = -ENOMEM;
321 goto errout2;
322 }
323 info->adc_base_spear3xx =
324 (struct adc_regs_spear3xx *)info->adc_base_spear6xx;
325
326 info->clk = clk_get(dev, NULL);
327 if (IS_ERR(info->clk)) {
328 dev_err(dev, "failed getting clock\n");
329 goto errout3;
330 }
331
332 ret = clk_prepare(info->clk);
333 if (ret) {
334 dev_err(dev, "failed preparing clock\n");
335 goto errout4;
336 }
337
338 ret = clk_enable(info->clk);
339 if (ret) {
340 dev_err(dev, "failed enabling clock\n");
341 goto errout5;
342 }
343
344 irq = platform_get_irq(pdev, 0);
345 if ((irq < 0) || (irq >= NR_IRQS)) {
346 dev_err(dev, "failed getting interrupt resource\n");
347 ret = -EINVAL;
348 goto errout6;
349 }
350
351 ret = devm_request_irq(dev, irq, spear_adc_isr, 0, MOD_NAME, info);
352 if (ret < 0) {
353 dev_err(dev, "failed requesting interrupt\n");
354 goto errout6;
355 }
356
357 if (of_property_read_u32(np, "sampling-frequency",
358 &info->sampling_freq)) {
359 dev_err(dev, "sampling-frequency missing in DT\n");
360 ret = -EINVAL;
361 goto errout6;
362 }
363
364 /*
365 * Optional avg_samples defaults to 0, resulting in single data
366 * conversion
367 */
368 of_property_read_u32(np, "average-samples", &info->avg_samples);
369
370 /*
371 * Optional vref_external defaults to 0, resulting in internal vref
372 * selection
373 */
374 of_property_read_u32(np, "vref-external", &info->vref_external);
375
376 spear_adc_configure(info);
377
378 platform_set_drvdata(pdev, iodev);
379
380 init_completion(&info->completion);
381
382 iodev->name = MOD_NAME;
383 iodev->dev.parent = dev;
384 iodev->info = &spear_adc_iio_info;
385 iodev->modes = INDIO_DIRECT_MODE;
386 iodev->channels = spear_adc_iio_channels;
387 iodev->num_channels = ARRAY_SIZE(spear_adc_iio_channels);
388
389 ret = iio_device_register(iodev);
390 if (ret)
391 goto errout6;
392
393 dev_info(dev, "SPEAR ADC driver loaded, IRQ %d\n", irq);
394
395 return 0;
396
397errout6:
398 clk_disable(info->clk);
399errout5:
400 clk_unprepare(info->clk);
401errout4:
402 clk_put(info->clk);
403errout3:
404 iounmap(info->adc_base_spear6xx);
405errout2:
406 iio_free_device(iodev);
407errout1:
408 return ret;
409}
410
411static int __devexit spear_adc_remove(struct platform_device *pdev)
412{
413 struct iio_dev *iodev = platform_get_drvdata(pdev);
414 struct spear_adc_info *info = iio_priv(iodev);
415
416 iio_device_unregister(iodev);
417 platform_set_drvdata(pdev, NULL);
418 clk_disable(info->clk);
419 clk_unprepare(info->clk);
420 clk_put(info->clk);
421 iounmap(info->adc_base_spear6xx);
422 iio_free_device(iodev);
423
424 return 0;
425}
426
427static const struct of_device_id spear_adc_dt_ids[] = {
428 { .compatible = "st,spear600-adc", },
429 { /* sentinel */ }
430};
431MODULE_DEVICE_TABLE(of, spear_adc_dt_ids);
432
433static struct platform_driver spear_adc_driver = {
434 .probe = spear_adc_probe,
435 .remove = __devexit_p(spear_adc_remove),
436 .driver = {
437 .name = MOD_NAME,
438 .owner = THIS_MODULE,
439 .of_match_table = of_match_ptr(spear_adc_dt_ids),
440 },
441};
442
443module_platform_driver(spear_adc_driver);
444
445MODULE_AUTHOR("Stefan Roese <sr@denx.de>");
446MODULE_DESCRIPTION("SPEAr ADC driver");
447MODULE_LICENSE("GPL");
This page took 0.056686 seconds and 5 git commands to generate.