1 /* linux/drivers/hwmon/s3c-hwmon.c
3 * Copyright (C) 2005, 2008, 2009 Simtec Electronics
4 * http://armlinux.simtec.co.uk/
5 * Ben Dooks <ben@simtec.co.uk>
7 * S3C24XX/S3C64XX ADC hwmon support
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/slab.h>
25 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/err.h>
29 #include <linux/clk.h>
30 #include <linux/interrupt.h>
31 #include <linux/platform_device.h>
33 #include <linux/hwmon.h>
34 #include <linux/hwmon-sysfs.h>
37 #include <linux/platform_data/hwmon-s3c.h>
39 struct s3c_hwmon_attr {
40 struct sensor_device_attribute in;
41 struct sensor_device_attribute label;
47 * struct s3c_hwmon - ADC hwmon client information
48 * @lock: Access lock to serialise the conversions.
49 * @client: The client we registered with the S3C ADC core.
50 * @hwmon_dev: The hwmon device we created.
51 * @attr: The holders for the channel attributes.
55 struct s3c_adc_client *client;
56 struct device *hwmon_dev;
58 struct s3c_hwmon_attr attrs[8];
62 * s3c_hwmon_read_ch - read a value from a given adc channel.
65 * @channel: The channel we're reading from.
67 * Read a value from the @channel with the proper locking and sleep until
68 * either the read completes or we timeout awaiting the ADC core to get
71 static int s3c_hwmon_read_ch(struct device *dev,
72 struct s3c_hwmon *hwmon, int channel)
76 ret = mutex_lock_interruptible(&hwmon->lock);
80 dev_dbg(dev, "reading channel %d\n", channel);
82 ret = s3c_adc_read(hwmon->client, channel);
83 mutex_unlock(&hwmon->lock);
88 #ifdef CONFIG_SENSORS_S3C_RAW
90 * s3c_hwmon_show_raw - show a conversion from the raw channel number.
91 * @dev: The device that the attribute belongs to.
92 * @attr: The attribute being read.
93 * @buf: The result buffer.
95 * This show deals with the raw attribute, registered for each possible
96 * ADC channel. This does a conversion and returns the raw (un-scaled)
97 * value returned from the hardware.
99 static ssize_t s3c_hwmon_show_raw(struct device *dev,
100 struct device_attribute *attr, char *buf)
102 struct s3c_hwmon *adc = platform_get_drvdata(to_platform_device(dev));
103 struct sensor_device_attribute *sa = to_sensor_dev_attr(attr);
106 ret = s3c_hwmon_read_ch(dev, adc, sa->index);
108 return (ret < 0) ? ret : snprintf(buf, PAGE_SIZE, "%d\n", ret);
111 #define DEF_ADC_ATTR(x) \
112 static SENSOR_DEVICE_ATTR(adc##x##_raw, S_IRUGO, s3c_hwmon_show_raw, NULL, x)
123 static struct attribute *s3c_hwmon_attrs[9] = {
124 &sensor_dev_attr_adc0_raw.dev_attr.attr,
125 &sensor_dev_attr_adc1_raw.dev_attr.attr,
126 &sensor_dev_attr_adc2_raw.dev_attr.attr,
127 &sensor_dev_attr_adc3_raw.dev_attr.attr,
128 &sensor_dev_attr_adc4_raw.dev_attr.attr,
129 &sensor_dev_attr_adc5_raw.dev_attr.attr,
130 &sensor_dev_attr_adc6_raw.dev_attr.attr,
131 &sensor_dev_attr_adc7_raw.dev_attr.attr,
135 static struct attribute_group s3c_hwmon_attrgroup = {
136 .attrs = s3c_hwmon_attrs,
139 static inline int s3c_hwmon_add_raw(struct device *dev)
141 return sysfs_create_group(&dev->kobj, &s3c_hwmon_attrgroup);
144 static inline void s3c_hwmon_remove_raw(struct device *dev)
146 sysfs_remove_group(&dev->kobj, &s3c_hwmon_attrgroup);
151 static inline int s3c_hwmon_add_raw(struct device *dev) { return 0; }
152 static inline void s3c_hwmon_remove_raw(struct device *dev) { }
154 #endif /* CONFIG_SENSORS_S3C_RAW */
157 * s3c_hwmon_ch_show - show value of a given channel
158 * @dev: The device that the attribute belongs to.
159 * @attr: The attribute being read.
160 * @buf: The result buffer.
162 * Read a value from the ADC and scale it before returning it to the
163 * caller. The scale factor is gained from the channel configuration
164 * passed via the platform data when the device was registered.
166 static ssize_t s3c_hwmon_ch_show(struct device *dev,
167 struct device_attribute *attr,
170 struct sensor_device_attribute *sen_attr = to_sensor_dev_attr(attr);
171 struct s3c_hwmon *hwmon = platform_get_drvdata(to_platform_device(dev));
172 struct s3c_hwmon_pdata *pdata = dev->platform_data;
173 struct s3c_hwmon_chcfg *cfg;
176 cfg = pdata->in[sen_attr->index];
178 ret = s3c_hwmon_read_ch(dev, hwmon, sen_attr->index);
183 ret = DIV_ROUND_CLOSEST(ret, cfg->div);
185 return snprintf(buf, PAGE_SIZE, "%d\n", ret);
189 * s3c_hwmon_label_show - show label name of the given channel.
190 * @dev: The device that the attribute belongs to.
191 * @attr: The attribute being read.
192 * @buf: The result buffer.
194 * Return the label name of a given channel
196 static ssize_t s3c_hwmon_label_show(struct device *dev,
197 struct device_attribute *attr,
200 struct sensor_device_attribute *sen_attr = to_sensor_dev_attr(attr);
201 struct s3c_hwmon_pdata *pdata = dev->platform_data;
202 struct s3c_hwmon_chcfg *cfg;
204 cfg = pdata->in[sen_attr->index];
206 return snprintf(buf, PAGE_SIZE, "%s\n", cfg->name);
210 * s3c_hwmon_create_attr - create hwmon attribute for given channel.
211 * @dev: The device to create the attribute on.
212 * @cfg: The channel configuration passed from the platform data.
213 * @channel: The ADC channel number to process.
215 * Create the scaled attribute for use with hwmon from the specified
216 * platform data in @pdata. The sysfs entry is handled by the routine
217 * s3c_hwmon_ch_show().
219 * The attribute name is taken from the configuration data if present
220 * otherwise the name is taken by concatenating in_ with the channel
223 static int s3c_hwmon_create_attr(struct device *dev,
224 struct s3c_hwmon_chcfg *cfg,
225 struct s3c_hwmon_attr *attrs,
228 struct sensor_device_attribute *attr;
231 snprintf(attrs->in_name, sizeof(attrs->in_name), "in%d_input", channel);
234 attr->index = channel;
235 sysfs_attr_init(&attr->dev_attr.attr);
236 attr->dev_attr.attr.name = attrs->in_name;
237 attr->dev_attr.attr.mode = S_IRUGO;
238 attr->dev_attr.show = s3c_hwmon_ch_show;
240 ret = device_create_file(dev, &attr->dev_attr);
242 dev_err(dev, "failed to create input attribute\n");
246 /* if this has a name, add a label */
248 snprintf(attrs->label_name, sizeof(attrs->label_name),
249 "in%d_label", channel);
251 attr = &attrs->label;
252 attr->index = channel;
253 sysfs_attr_init(&attr->dev_attr.attr);
254 attr->dev_attr.attr.name = attrs->label_name;
255 attr->dev_attr.attr.mode = S_IRUGO;
256 attr->dev_attr.show = s3c_hwmon_label_show;
258 ret = device_create_file(dev, &attr->dev_attr);
260 device_remove_file(dev, &attrs->in.dev_attr);
261 dev_err(dev, "failed to create label attribute\n");
268 static void s3c_hwmon_remove_attr(struct device *dev,
269 struct s3c_hwmon_attr *attrs)
271 device_remove_file(dev, &attrs->in.dev_attr);
272 device_remove_file(dev, &attrs->label.dev_attr);
276 * s3c_hwmon_probe - device probe entry.
277 * @dev: The device being probed.
279 static int __devinit s3c_hwmon_probe(struct platform_device *dev)
281 struct s3c_hwmon_pdata *pdata = dev->dev.platform_data;
282 struct s3c_hwmon *hwmon;
287 dev_err(&dev->dev, "no platform data supplied\n");
291 hwmon = devm_kzalloc(&dev->dev, sizeof(struct s3c_hwmon), GFP_KERNEL);
293 dev_err(&dev->dev, "no memory\n");
297 platform_set_drvdata(dev, hwmon);
299 mutex_init(&hwmon->lock);
301 /* Register with the core ADC driver. */
303 hwmon->client = s3c_adc_register(dev, NULL, NULL, 0);
304 if (IS_ERR(hwmon->client)) {
305 dev_err(&dev->dev, "cannot register adc\n");
306 return PTR_ERR(hwmon->client);
309 /* add attributes for our adc devices. */
311 ret = s3c_hwmon_add_raw(&dev->dev);
315 /* register with the hwmon core */
317 hwmon->hwmon_dev = hwmon_device_register(&dev->dev);
318 if (IS_ERR(hwmon->hwmon_dev)) {
319 dev_err(&dev->dev, "error registering with hwmon\n");
320 ret = PTR_ERR(hwmon->hwmon_dev);
321 goto err_raw_attribute;
324 for (i = 0; i < ARRAY_SIZE(pdata->in); i++) {
325 struct s3c_hwmon_chcfg *cfg = pdata->in[i];
330 if (cfg->mult >= 0x10000)
332 "channel %d multiplier too large\n",
336 dev_err(&dev->dev, "channel %d divider zero\n", i);
340 ret = s3c_hwmon_create_attr(&dev->dev, pdata->in[i],
341 &hwmon->attrs[i], i);
344 "error creating channel %d\n", i);
346 for (i--; i >= 0; i--)
347 s3c_hwmon_remove_attr(&dev->dev,
350 goto err_hwmon_register;
357 hwmon_device_unregister(hwmon->hwmon_dev);
360 s3c_hwmon_remove_raw(&dev->dev);
363 s3c_adc_release(hwmon->client);
368 static int __devexit s3c_hwmon_remove(struct platform_device *dev)
370 struct s3c_hwmon *hwmon = platform_get_drvdata(dev);
373 s3c_hwmon_remove_raw(&dev->dev);
375 for (i = 0; i < ARRAY_SIZE(hwmon->attrs); i++)
376 s3c_hwmon_remove_attr(&dev->dev, &hwmon->attrs[i]);
378 hwmon_device_unregister(hwmon->hwmon_dev);
379 s3c_adc_release(hwmon->client);
384 static struct platform_driver s3c_hwmon_driver = {
387 .owner = THIS_MODULE,
389 .probe = s3c_hwmon_probe,
390 .remove = __devexit_p(s3c_hwmon_remove),
393 module_platform_driver(s3c_hwmon_driver);
395 MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
396 MODULE_DESCRIPTION("S3C ADC HWMon driver");
397 MODULE_LICENSE("GPL v2");
398 MODULE_ALIAS("platform:s3c-hwmon");