1 /*
2 * smsc47b397.c - Part of lm_sensors, Linux kernel modules
3 * for hardware monitoring
4 *
5 * Supports the SMSC LPC47B397-NC Super-I/O chip.
6 *
7 * Author/Maintainer: Mark M. Hoffman <mhoffman@lightlink.com>
8 * Copyright (C) 2004 Utilitek Systems, Inc.
9 *
10 * derived in part from smsc47m1.c:
11 * Copyright (C) 2002 Mark D. Studebaker <mdsxyz123@yahoo.com>
12 * Copyright (C) 2004 Jean Delvare <khali@linux-fr.org>
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 */
28
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30
31 #include <linux/module.h>
32 #include <linux/slab.h>
33 #include <linux/ioport.h>
34 #include <linux/jiffies.h>
35 #include <linux/platform_device.h>
36 #include <linux/hwmon.h>
37 #include <linux/hwmon-sysfs.h>
38 #include <linux/err.h>
39 #include <linux/init.h>
40 #include <linux/mutex.h>
41 #include <linux/acpi.h>
42 #include <linux/io.h>
43
44 static unsigned short force_id;
45 module_param(force_id, ushort, 0);
46 MODULE_PARM_DESC(force_id, "Override the detected device ID");
47
48 static struct platform_device *pdev;
49
50 #define DRVNAME "smsc47b397"
51
52 /* Super-I/0 registers and commands */
53
54 #define REG 0x2e /* The register to read/write */
55 #define VAL 0x2f /* The value to read/write */
56
superio_outb(int reg,int val)57 static inline void superio_outb(int reg, int val)
58 {
59 outb(reg, REG);
60 outb(val, VAL);
61 }
62
superio_inb(int reg)63 static inline int superio_inb(int reg)
64 {
65 outb(reg, REG);
66 return inb(VAL);
67 }
68
69 /* select superio logical device */
superio_select(int ld)70 static inline void superio_select(int ld)
71 {
72 superio_outb(0x07, ld);
73 }
74
superio_enter(void)75 static inline void superio_enter(void)
76 {
77 outb(0x55, REG);
78 }
79
superio_exit(void)80 static inline void superio_exit(void)
81 {
82 outb(0xAA, REG);
83 }
84
85 #define SUPERIO_REG_DEVID 0x20
86 #define SUPERIO_REG_DEVREV 0x21
87 #define SUPERIO_REG_BASE_MSB 0x60
88 #define SUPERIO_REG_BASE_LSB 0x61
89 #define SUPERIO_REG_LD8 0x08
90
91 #define SMSC_EXTENT 0x02
92
93 /* 0 <= nr <= 3 */
94 static u8 smsc47b397_reg_temp[] = {0x25, 0x26, 0x27, 0x80};
95 #define SMSC47B397_REG_TEMP(nr) (smsc47b397_reg_temp[(nr)])
96
97 /* 0 <= nr <= 3 */
98 #define SMSC47B397_REG_FAN_LSB(nr) (0x28 + 2 * (nr))
99 #define SMSC47B397_REG_FAN_MSB(nr) (0x29 + 2 * (nr))
100
101 struct smsc47b397_data {
102 unsigned short addr;
103 const char *name;
104 struct device *hwmon_dev;
105 struct mutex lock;
106
107 struct mutex update_lock;
108 unsigned long last_updated; /* in jiffies */
109 int valid;
110
111 /* register values */
112 u16 fan[4];
113 u8 temp[4];
114 };
115
smsc47b397_read_value(struct smsc47b397_data * data,u8 reg)116 static int smsc47b397_read_value(struct smsc47b397_data *data, u8 reg)
117 {
118 int res;
119
120 mutex_lock(&data->lock);
121 outb(reg, data->addr);
122 res = inb_p(data->addr + 1);
123 mutex_unlock(&data->lock);
124 return res;
125 }
126
smsc47b397_update_device(struct device * dev)127 static struct smsc47b397_data *smsc47b397_update_device(struct device *dev)
128 {
129 struct smsc47b397_data *data = dev_get_drvdata(dev);
130 int i;
131
132 mutex_lock(&data->update_lock);
133
134 if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
135 dev_dbg(dev, "starting device update...\n");
136
137 /* 4 temperature inputs, 4 fan inputs */
138 for (i = 0; i < 4; i++) {
139 data->temp[i] = smsc47b397_read_value(data,
140 SMSC47B397_REG_TEMP(i));
141
142 /* must read LSB first */
143 data->fan[i] = smsc47b397_read_value(data,
144 SMSC47B397_REG_FAN_LSB(i));
145 data->fan[i] |= smsc47b397_read_value(data,
146 SMSC47B397_REG_FAN_MSB(i)) << 8;
147 }
148
149 data->last_updated = jiffies;
150 data->valid = 1;
151
152 dev_dbg(dev, "... device update complete\n");
153 }
154
155 mutex_unlock(&data->update_lock);
156
157 return data;
158 }
159
160 /*
161 * TEMP: 0.001C/bit (-128C to +127C)
162 * REG: 1C/bit, two's complement
163 */
temp_from_reg(u8 reg)164 static int temp_from_reg(u8 reg)
165 {
166 return (s8)reg * 1000;
167 }
168
show_temp(struct device * dev,struct device_attribute * devattr,char * buf)169 static ssize_t show_temp(struct device *dev, struct device_attribute
170 *devattr, char *buf)
171 {
172 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
173 struct smsc47b397_data *data = smsc47b397_update_device(dev);
174 return sprintf(buf, "%d\n", temp_from_reg(data->temp[attr->index]));
175 }
176
177 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
178 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
179 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
180 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 3);
181
182 /*
183 * FAN: 1 RPM/bit
184 * REG: count of 90kHz pulses / revolution
185 */
fan_from_reg(u16 reg)186 static int fan_from_reg(u16 reg)
187 {
188 if (reg == 0 || reg == 0xffff)
189 return 0;
190 return 90000 * 60 / reg;
191 }
192
show_fan(struct device * dev,struct device_attribute * devattr,char * buf)193 static ssize_t show_fan(struct device *dev, struct device_attribute
194 *devattr, char *buf)
195 {
196 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
197 struct smsc47b397_data *data = smsc47b397_update_device(dev);
198 return sprintf(buf, "%d\n", fan_from_reg(data->fan[attr->index]));
199 }
200 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
201 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
202 static SENSOR_DEVICE_ATTR(fan3_input, S_IRUGO, show_fan, NULL, 2);
203 static SENSOR_DEVICE_ATTR(fan4_input, S_IRUGO, show_fan, NULL, 3);
204
show_name(struct device * dev,struct device_attribute * devattr,char * buf)205 static ssize_t show_name(struct device *dev, struct device_attribute
206 *devattr, char *buf)
207 {
208 struct smsc47b397_data *data = dev_get_drvdata(dev);
209 return sprintf(buf, "%s\n", data->name);
210 }
211 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
212
213 static struct attribute *smsc47b397_attributes[] = {
214 &sensor_dev_attr_temp1_input.dev_attr.attr,
215 &sensor_dev_attr_temp2_input.dev_attr.attr,
216 &sensor_dev_attr_temp3_input.dev_attr.attr,
217 &sensor_dev_attr_temp4_input.dev_attr.attr,
218 &sensor_dev_attr_fan1_input.dev_attr.attr,
219 &sensor_dev_attr_fan2_input.dev_attr.attr,
220 &sensor_dev_attr_fan3_input.dev_attr.attr,
221 &sensor_dev_attr_fan4_input.dev_attr.attr,
222
223 &dev_attr_name.attr,
224 NULL
225 };
226
227 static const struct attribute_group smsc47b397_group = {
228 .attrs = smsc47b397_attributes,
229 };
230
smsc47b397_remove(struct platform_device * pdev)231 static int __devexit smsc47b397_remove(struct platform_device *pdev)
232 {
233 struct smsc47b397_data *data = platform_get_drvdata(pdev);
234 struct resource *res;
235
236 hwmon_device_unregister(data->hwmon_dev);
237 sysfs_remove_group(&pdev->dev.kobj, &smsc47b397_group);
238 res = platform_get_resource(pdev, IORESOURCE_IO, 0);
239 release_region(res->start, SMSC_EXTENT);
240 kfree(data);
241
242 return 0;
243 }
244
245 static int smsc47b397_probe(struct platform_device *pdev);
246
247 static struct platform_driver smsc47b397_driver = {
248 .driver = {
249 .owner = THIS_MODULE,
250 .name = DRVNAME,
251 },
252 .probe = smsc47b397_probe,
253 .remove = __devexit_p(smsc47b397_remove),
254 };
255
smsc47b397_probe(struct platform_device * pdev)256 static int __devinit smsc47b397_probe(struct platform_device *pdev)
257 {
258 struct device *dev = &pdev->dev;
259 struct smsc47b397_data *data;
260 struct resource *res;
261 int err = 0;
262
263 res = platform_get_resource(pdev, IORESOURCE_IO, 0);
264 if (!request_region(res->start, SMSC_EXTENT,
265 smsc47b397_driver.driver.name)) {
266 dev_err(dev, "Region 0x%lx-0x%lx already in use!\n",
267 (unsigned long)res->start,
268 (unsigned long)res->start + SMSC_EXTENT - 1);
269 return -EBUSY;
270 }
271
272 data = kzalloc(sizeof(struct smsc47b397_data), GFP_KERNEL);
273 if (!data) {
274 err = -ENOMEM;
275 goto error_release;
276 }
277
278 data->addr = res->start;
279 data->name = "smsc47b397";
280 mutex_init(&data->lock);
281 mutex_init(&data->update_lock);
282 platform_set_drvdata(pdev, data);
283
284 err = sysfs_create_group(&dev->kobj, &smsc47b397_group);
285 if (err)
286 goto error_free;
287
288 data->hwmon_dev = hwmon_device_register(dev);
289 if (IS_ERR(data->hwmon_dev)) {
290 err = PTR_ERR(data->hwmon_dev);
291 goto error_remove;
292 }
293
294 return 0;
295
296 error_remove:
297 sysfs_remove_group(&dev->kobj, &smsc47b397_group);
298 error_free:
299 kfree(data);
300 error_release:
301 release_region(res->start, SMSC_EXTENT);
302 return err;
303 }
304
smsc47b397_device_add(unsigned short address)305 static int __init smsc47b397_device_add(unsigned short address)
306 {
307 struct resource res = {
308 .start = address,
309 .end = address + SMSC_EXTENT - 1,
310 .name = DRVNAME,
311 .flags = IORESOURCE_IO,
312 };
313 int err;
314
315 err = acpi_check_resource_conflict(&res);
316 if (err)
317 goto exit;
318
319 pdev = platform_device_alloc(DRVNAME, address);
320 if (!pdev) {
321 err = -ENOMEM;
322 pr_err("Device allocation failed\n");
323 goto exit;
324 }
325
326 err = platform_device_add_resources(pdev, &res, 1);
327 if (err) {
328 pr_err("Device resource addition failed (%d)\n", err);
329 goto exit_device_put;
330 }
331
332 err = platform_device_add(pdev);
333 if (err) {
334 pr_err("Device addition failed (%d)\n", err);
335 goto exit_device_put;
336 }
337
338 return 0;
339
340 exit_device_put:
341 platform_device_put(pdev);
342 exit:
343 return err;
344 }
345
smsc47b397_find(void)346 static int __init smsc47b397_find(void)
347 {
348 u8 id, rev;
349 char *name;
350 unsigned short addr;
351
352 superio_enter();
353 id = force_id ? force_id : superio_inb(SUPERIO_REG_DEVID);
354
355 switch (id) {
356 case 0x81:
357 name = "SCH5307-NS";
358 break;
359 case 0x6f:
360 name = "LPC47B397-NC";
361 break;
362 case 0x85:
363 case 0x8c:
364 name = "SCH5317";
365 break;
366 default:
367 superio_exit();
368 return -ENODEV;
369 }
370
371 rev = superio_inb(SUPERIO_REG_DEVREV);
372
373 superio_select(SUPERIO_REG_LD8);
374 addr = (superio_inb(SUPERIO_REG_BASE_MSB) << 8)
375 | superio_inb(SUPERIO_REG_BASE_LSB);
376
377 pr_info("found SMSC %s (base address 0x%04x, revision %u)\n",
378 name, addr, rev);
379
380 superio_exit();
381 return addr;
382 }
383
smsc47b397_init(void)384 static int __init smsc47b397_init(void)
385 {
386 unsigned short address;
387 int ret;
388
389 ret = smsc47b397_find();
390 if (ret < 0)
391 return ret;
392 address = ret;
393
394 ret = platform_driver_register(&smsc47b397_driver);
395 if (ret)
396 goto exit;
397
398 /* Sets global pdev as a side effect */
399 ret = smsc47b397_device_add(address);
400 if (ret)
401 goto exit_driver;
402
403 return 0;
404
405 exit_driver:
406 platform_driver_unregister(&smsc47b397_driver);
407 exit:
408 return ret;
409 }
410
smsc47b397_exit(void)411 static void __exit smsc47b397_exit(void)
412 {
413 platform_device_unregister(pdev);
414 platform_driver_unregister(&smsc47b397_driver);
415 }
416
417 MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
418 MODULE_DESCRIPTION("SMSC LPC47B397 driver");
419 MODULE_LICENSE("GPL");
420
421 module_init(smsc47b397_init);
422 module_exit(smsc47b397_exit);
423