xref: /openbmc/linux/drivers/hwmon/sis5595.c (revision f35e839a)
1 /*
2  * sis5595.c - Part of lm_sensors, Linux kernel modules
3  *	       for hardware monitoring
4  *
5  * Copyright (C) 1998 - 2001 Frodo Looijaard <frodol@dds.nl>,
6  *			     Kyösti Mälkki <kmalkki@cc.hut.fi>, and
7  *			     Mark D. Studebaker <mdsxyz123@yahoo.com>
8  * Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with
9  * the help of Jean Delvare <khali@linux-fr.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  */
25 
26 /*
27  * SiS southbridge has a LM78-like chip integrated on the same IC.
28  * This driver is a customized copy of lm78.c
29  *
30  * Supports following revisions:
31  *	Version		PCI ID		PCI Revision
32  *	1		1039/0008	AF or less
33  *	2		1039/0008	B0 or greater
34  *
35  *  Note: these chips contain a 0008 device which is incompatible with the
36  *	 5595. We recognize these by the presence of the listed
37  *	 "blacklist" PCI ID and refuse to load.
38  *
39  * NOT SUPPORTED	PCI ID		BLACKLIST PCI ID
40  *	 540		0008		0540
41  *	 550		0008		0550
42  *	5513		0008		5511
43  *	5581		0008		5597
44  *	5582		0008		5597
45  *	5597		0008		5597
46  *	5598		0008		5597/5598
47  *	 630		0008		0630
48  *	 645		0008		0645
49  *	 730		0008		0730
50  *	 735		0008		0735
51  */
52 
53 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
54 
55 #include <linux/module.h>
56 #include <linux/slab.h>
57 #include <linux/ioport.h>
58 #include <linux/pci.h>
59 #include <linux/platform_device.h>
60 #include <linux/hwmon.h>
61 #include <linux/hwmon-sysfs.h>
62 #include <linux/err.h>
63 #include <linux/init.h>
64 #include <linux/jiffies.h>
65 #include <linux/mutex.h>
66 #include <linux/sysfs.h>
67 #include <linux/acpi.h>
68 #include <linux/io.h>
69 
70 
71 /*
72  * If force_addr is set to anything different from 0, we forcibly enable
73  * the device at the given address.
74  */
75 static u16 force_addr;
76 module_param(force_addr, ushort, 0);
77 MODULE_PARM_DESC(force_addr,
78 		 "Initialize the base address of the sensors");
79 
80 static struct platform_device *pdev;
81 
82 /* Many SIS5595 constants specified below */
83 
84 /* Length of ISA address segment */
85 #define SIS5595_EXTENT 8
86 /* PCI Config Registers */
87 #define SIS5595_BASE_REG 0x68
88 #define SIS5595_PIN_REG 0x7A
89 #define SIS5595_ENABLE_REG 0x7B
90 
91 /* Where are the ISA address/data registers relative to the base address */
92 #define SIS5595_ADDR_REG_OFFSET 5
93 #define SIS5595_DATA_REG_OFFSET 6
94 
95 /* The SIS5595 registers */
96 #define SIS5595_REG_IN_MAX(nr) (0x2b + (nr) * 2)
97 #define SIS5595_REG_IN_MIN(nr) (0x2c + (nr) * 2)
98 #define SIS5595_REG_IN(nr) (0x20 + (nr))
99 
100 #define SIS5595_REG_FAN_MIN(nr) (0x3b + (nr))
101 #define SIS5595_REG_FAN(nr) (0x28 + (nr))
102 
103 /*
104  * On the first version of the chip, the temp registers are separate.
105  * On the second version,
106  * TEMP pin is shared with IN4, configured in PCI register 0x7A.
107  * The registers are the same as well.
108  * OVER and HYST are really MAX and MIN.
109  */
110 
111 #define REV2MIN	0xb0
112 #define SIS5595_REG_TEMP	(((data->revision) >= REV2MIN) ? \
113 					SIS5595_REG_IN(4) : 0x27)
114 #define SIS5595_REG_TEMP_OVER	(((data->revision) >= REV2MIN) ? \
115 					SIS5595_REG_IN_MAX(4) : 0x39)
116 #define SIS5595_REG_TEMP_HYST	(((data->revision) >= REV2MIN) ? \
117 					SIS5595_REG_IN_MIN(4) : 0x3a)
118 
119 #define SIS5595_REG_CONFIG 0x40
120 #define SIS5595_REG_ALARM1 0x41
121 #define SIS5595_REG_ALARM2 0x42
122 #define SIS5595_REG_FANDIV 0x47
123 
124 /*
125  * Conversions. Limit checking is only done on the TO_REG
126  * variants.
127  */
128 
129 /*
130  * IN: mV, (0V to 4.08V)
131  * REG: 16mV/bit
132  */
133 static inline u8 IN_TO_REG(unsigned long val)
134 {
135 	unsigned long nval = clamp_val(val, 0, 4080);
136 	return (nval + 8) / 16;
137 }
138 #define IN_FROM_REG(val) ((val) *  16)
139 
140 static inline u8 FAN_TO_REG(long rpm, int div)
141 {
142 	if (rpm <= 0)
143 		return 255;
144 	return clamp_val((1350000 + rpm * div / 2) / (rpm * div), 1, 254);
145 }
146 
147 static inline int FAN_FROM_REG(u8 val, int div)
148 {
149 	return val == 0 ? -1 : val == 255 ? 0 : 1350000 / (val * div);
150 }
151 
152 /*
153  * TEMP: mC (-54.12C to +157.53C)
154  * REG: 0.83C/bit + 52.12, two's complement
155  */
156 static inline int TEMP_FROM_REG(s8 val)
157 {
158 	return val * 830 + 52120;
159 }
160 static inline s8 TEMP_TO_REG(int val)
161 {
162 	int nval = clamp_val(val, -54120, 157530) ;
163 	return nval < 0 ? (nval - 5212 - 415) / 830 : (nval - 5212 + 415) / 830;
164 }
165 
166 /*
167  * FAN DIV: 1, 2, 4, or 8 (defaults to 2)
168  * REG: 0, 1, 2, or 3 (respectively) (defaults to 1)
169  */
170 static inline u8 DIV_TO_REG(int val)
171 {
172 	return val == 8 ? 3 : val == 4 ? 2 : val == 1 ? 0 : 1;
173 }
174 #define DIV_FROM_REG(val) (1 << (val))
175 
176 /*
177  * For each registered chip, we need to keep some data in memory.
178  * The structure is dynamically allocated.
179  */
180 struct sis5595_data {
181 	unsigned short addr;
182 	const char *name;
183 	struct device *hwmon_dev;
184 	struct mutex lock;
185 
186 	struct mutex update_lock;
187 	char valid;		/* !=0 if following fields are valid */
188 	unsigned long last_updated;	/* In jiffies */
189 	char maxins;		/* == 3 if temp enabled, otherwise == 4 */
190 	u8 revision;		/* Reg. value */
191 
192 	u8 in[5];		/* Register value */
193 	u8 in_max[5];		/* Register value */
194 	u8 in_min[5];		/* Register value */
195 	u8 fan[2];		/* Register value */
196 	u8 fan_min[2];		/* Register value */
197 	s8 temp;		/* Register value */
198 	s8 temp_over;		/* Register value */
199 	s8 temp_hyst;		/* Register value */
200 	u8 fan_div[2];		/* Register encoding, shifted right */
201 	u16 alarms;		/* Register encoding, combined */
202 };
203 
204 static struct pci_dev *s_bridge;	/* pointer to the (only) sis5595 */
205 
206 static int sis5595_probe(struct platform_device *pdev);
207 static int sis5595_remove(struct platform_device *pdev);
208 
209 static int sis5595_read_value(struct sis5595_data *data, u8 reg);
210 static void sis5595_write_value(struct sis5595_data *data, u8 reg, u8 value);
211 static struct sis5595_data *sis5595_update_device(struct device *dev);
212 static void sis5595_init_device(struct sis5595_data *data);
213 
214 static struct platform_driver sis5595_driver = {
215 	.driver = {
216 		.owner	= THIS_MODULE,
217 		.name	= "sis5595",
218 	},
219 	.probe		= sis5595_probe,
220 	.remove		= sis5595_remove,
221 };
222 
223 /* 4 Voltages */
224 static ssize_t show_in(struct device *dev, struct device_attribute *da,
225 		       char *buf)
226 {
227 	struct sis5595_data *data = sis5595_update_device(dev);
228 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
229 	int nr = attr->index;
230 	return sprintf(buf, "%d\n", IN_FROM_REG(data->in[nr]));
231 }
232 
233 static ssize_t show_in_min(struct device *dev, struct device_attribute *da,
234 			   char *buf)
235 {
236 	struct sis5595_data *data = sis5595_update_device(dev);
237 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
238 	int nr = attr->index;
239 	return sprintf(buf, "%d\n", IN_FROM_REG(data->in_min[nr]));
240 }
241 
242 static ssize_t show_in_max(struct device *dev, struct device_attribute *da,
243 			   char *buf)
244 {
245 	struct sis5595_data *data = sis5595_update_device(dev);
246 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
247 	int nr = attr->index;
248 	return sprintf(buf, "%d\n", IN_FROM_REG(data->in_max[nr]));
249 }
250 
251 static ssize_t set_in_min(struct device *dev, struct device_attribute *da,
252 			  const char *buf, size_t count)
253 {
254 	struct sis5595_data *data = dev_get_drvdata(dev);
255 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
256 	int nr = attr->index;
257 	unsigned long val;
258 	int err;
259 
260 	err = kstrtoul(buf, 10, &val);
261 	if (err)
262 		return err;
263 
264 	mutex_lock(&data->update_lock);
265 	data->in_min[nr] = IN_TO_REG(val);
266 	sis5595_write_value(data, SIS5595_REG_IN_MIN(nr), data->in_min[nr]);
267 	mutex_unlock(&data->update_lock);
268 	return count;
269 }
270 
271 static ssize_t set_in_max(struct device *dev, struct device_attribute *da,
272 			  const char *buf, size_t count)
273 {
274 	struct sis5595_data *data = dev_get_drvdata(dev);
275 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
276 	int nr = attr->index;
277 	unsigned long val;
278 	int err;
279 
280 	err = kstrtoul(buf, 10, &val);
281 	if (err)
282 		return err;
283 
284 	mutex_lock(&data->update_lock);
285 	data->in_max[nr] = IN_TO_REG(val);
286 	sis5595_write_value(data, SIS5595_REG_IN_MAX(nr), data->in_max[nr]);
287 	mutex_unlock(&data->update_lock);
288 	return count;
289 }
290 
291 #define show_in_offset(offset)					\
292 static SENSOR_DEVICE_ATTR(in##offset##_input, S_IRUGO,		\
293 		show_in, NULL, offset);				\
294 static SENSOR_DEVICE_ATTR(in##offset##_min, S_IRUGO | S_IWUSR,	\
295 		show_in_min, set_in_min, offset);		\
296 static SENSOR_DEVICE_ATTR(in##offset##_max, S_IRUGO | S_IWUSR,	\
297 		show_in_max, set_in_max, offset);
298 
299 show_in_offset(0);
300 show_in_offset(1);
301 show_in_offset(2);
302 show_in_offset(3);
303 show_in_offset(4);
304 
305 /* Temperature */
306 static ssize_t show_temp(struct device *dev, struct device_attribute *attr,
307 			 char *buf)
308 {
309 	struct sis5595_data *data = sis5595_update_device(dev);
310 	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp));
311 }
312 
313 static ssize_t show_temp_over(struct device *dev, struct device_attribute *attr,
314 			      char *buf)
315 {
316 	struct sis5595_data *data = sis5595_update_device(dev);
317 	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_over));
318 }
319 
320 static ssize_t set_temp_over(struct device *dev, struct device_attribute *attr,
321 			     const char *buf, size_t count)
322 {
323 	struct sis5595_data *data = dev_get_drvdata(dev);
324 	long val;
325 	int err;
326 
327 	err = kstrtol(buf, 10, &val);
328 	if (err)
329 		return err;
330 
331 	mutex_lock(&data->update_lock);
332 	data->temp_over = TEMP_TO_REG(val);
333 	sis5595_write_value(data, SIS5595_REG_TEMP_OVER, data->temp_over);
334 	mutex_unlock(&data->update_lock);
335 	return count;
336 }
337 
338 static ssize_t show_temp_hyst(struct device *dev, struct device_attribute *attr,
339 			      char *buf)
340 {
341 	struct sis5595_data *data = sis5595_update_device(dev);
342 	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_hyst));
343 }
344 
345 static ssize_t set_temp_hyst(struct device *dev, struct device_attribute *attr,
346 			     const char *buf, size_t count)
347 {
348 	struct sis5595_data *data = dev_get_drvdata(dev);
349 	long val;
350 	int err;
351 
352 	err = kstrtol(buf, 10, &val);
353 	if (err)
354 		return err;
355 
356 	mutex_lock(&data->update_lock);
357 	data->temp_hyst = TEMP_TO_REG(val);
358 	sis5595_write_value(data, SIS5595_REG_TEMP_HYST, data->temp_hyst);
359 	mutex_unlock(&data->update_lock);
360 	return count;
361 }
362 
363 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL);
364 static DEVICE_ATTR(temp1_max, S_IRUGO | S_IWUSR,
365 		show_temp_over, set_temp_over);
366 static DEVICE_ATTR(temp1_max_hyst, S_IRUGO | S_IWUSR,
367 		show_temp_hyst, set_temp_hyst);
368 
369 /* 2 Fans */
370 static ssize_t show_fan(struct device *dev, struct device_attribute *da,
371 			char *buf)
372 {
373 	struct sis5595_data *data = sis5595_update_device(dev);
374 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
375 	int nr = attr->index;
376 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[nr],
377 		DIV_FROM_REG(data->fan_div[nr])));
378 }
379 
380 static ssize_t show_fan_min(struct device *dev, struct device_attribute *da,
381 			    char *buf)
382 {
383 	struct sis5595_data *data = sis5595_update_device(dev);
384 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
385 	int nr = attr->index;
386 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_min[nr],
387 		DIV_FROM_REG(data->fan_div[nr])));
388 }
389 
390 static ssize_t set_fan_min(struct device *dev, struct device_attribute *da,
391 			   const char *buf, size_t count)
392 {
393 	struct sis5595_data *data = dev_get_drvdata(dev);
394 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
395 	int nr = attr->index;
396 	unsigned long val;
397 	int err;
398 
399 	err = kstrtoul(buf, 10, &val);
400 	if (err)
401 		return err;
402 
403 	mutex_lock(&data->update_lock);
404 	data->fan_min[nr] = FAN_TO_REG(val, DIV_FROM_REG(data->fan_div[nr]));
405 	sis5595_write_value(data, SIS5595_REG_FAN_MIN(nr), data->fan_min[nr]);
406 	mutex_unlock(&data->update_lock);
407 	return count;
408 }
409 
410 static ssize_t show_fan_div(struct device *dev, struct device_attribute *da,
411 			    char *buf)
412 {
413 	struct sis5595_data *data = sis5595_update_device(dev);
414 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
415 	int nr = attr->index;
416 	return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
417 }
418 
419 /*
420  * Note: we save and restore the fan minimum here, because its value is
421  * determined in part by the fan divisor.  This follows the principle of
422  * least surprise; the user doesn't expect the fan minimum to change just
423  * because the divisor changed.
424  */
425 static ssize_t set_fan_div(struct device *dev, struct device_attribute *da,
426 			   const char *buf, size_t count)
427 {
428 	struct sis5595_data *data = dev_get_drvdata(dev);
429 	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
430 	int nr = attr->index;
431 	unsigned long min;
432 	int reg;
433 	unsigned long val;
434 	int err;
435 
436 	err = kstrtoul(buf, 10, &val);
437 	if (err)
438 		return err;
439 
440 	mutex_lock(&data->update_lock);
441 	min = FAN_FROM_REG(data->fan_min[nr],
442 			DIV_FROM_REG(data->fan_div[nr]));
443 	reg = sis5595_read_value(data, SIS5595_REG_FANDIV);
444 
445 	switch (val) {
446 	case 1:
447 		data->fan_div[nr] = 0;
448 		break;
449 	case 2:
450 		data->fan_div[nr] = 1;
451 		break;
452 	case 4:
453 		data->fan_div[nr] = 2;
454 		break;
455 	case 8:
456 		data->fan_div[nr] = 3;
457 		break;
458 	default:
459 		dev_err(dev,
460 			"fan_div value %ld not supported. Choose one of 1, 2, 4 or 8!\n",
461 			val);
462 		mutex_unlock(&data->update_lock);
463 		return -EINVAL;
464 	}
465 
466 	switch (nr) {
467 	case 0:
468 		reg = (reg & 0xcf) | (data->fan_div[nr] << 4);
469 		break;
470 	case 1:
471 		reg = (reg & 0x3f) | (data->fan_div[nr] << 6);
472 		break;
473 	}
474 	sis5595_write_value(data, SIS5595_REG_FANDIV, reg);
475 	data->fan_min[nr] =
476 		FAN_TO_REG(min, DIV_FROM_REG(data->fan_div[nr]));
477 	sis5595_write_value(data, SIS5595_REG_FAN_MIN(nr), data->fan_min[nr]);
478 	mutex_unlock(&data->update_lock);
479 	return count;
480 }
481 
482 #define show_fan_offset(offset)						\
483 static SENSOR_DEVICE_ATTR(fan##offset##_input, S_IRUGO,			\
484 		show_fan, NULL, offset - 1);				\
485 static SENSOR_DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR,		\
486 		show_fan_min, set_fan_min, offset - 1);			\
487 static SENSOR_DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR,		\
488 		show_fan_div, set_fan_div, offset - 1);
489 
490 show_fan_offset(1);
491 show_fan_offset(2);
492 
493 /* Alarms */
494 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr,
495 			   char *buf)
496 {
497 	struct sis5595_data *data = sis5595_update_device(dev);
498 	return sprintf(buf, "%d\n", data->alarms);
499 }
500 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
501 
502 static ssize_t show_alarm(struct device *dev, struct device_attribute *da,
503 			  char *buf)
504 {
505 	struct sis5595_data *data = sis5595_update_device(dev);
506 	int nr = to_sensor_dev_attr(da)->index;
507 	return sprintf(buf, "%u\n", (data->alarms >> nr) & 1);
508 }
509 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
510 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
511 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
512 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
513 static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, show_alarm, NULL, 15);
514 static SENSOR_DEVICE_ATTR(fan1_alarm, S_IRUGO, show_alarm, NULL, 6);
515 static SENSOR_DEVICE_ATTR(fan2_alarm, S_IRUGO, show_alarm, NULL, 7);
516 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 15);
517 
518 static ssize_t show_name(struct device *dev, struct device_attribute *attr,
519 			 char *buf)
520 {
521 	struct sis5595_data *data = dev_get_drvdata(dev);
522 	return sprintf(buf, "%s\n", data->name);
523 }
524 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
525 
526 static struct attribute *sis5595_attributes[] = {
527 	&sensor_dev_attr_in0_input.dev_attr.attr,
528 	&sensor_dev_attr_in0_min.dev_attr.attr,
529 	&sensor_dev_attr_in0_max.dev_attr.attr,
530 	&sensor_dev_attr_in0_alarm.dev_attr.attr,
531 	&sensor_dev_attr_in1_input.dev_attr.attr,
532 	&sensor_dev_attr_in1_min.dev_attr.attr,
533 	&sensor_dev_attr_in1_max.dev_attr.attr,
534 	&sensor_dev_attr_in1_alarm.dev_attr.attr,
535 	&sensor_dev_attr_in2_input.dev_attr.attr,
536 	&sensor_dev_attr_in2_min.dev_attr.attr,
537 	&sensor_dev_attr_in2_max.dev_attr.attr,
538 	&sensor_dev_attr_in2_alarm.dev_attr.attr,
539 	&sensor_dev_attr_in3_input.dev_attr.attr,
540 	&sensor_dev_attr_in3_min.dev_attr.attr,
541 	&sensor_dev_attr_in3_max.dev_attr.attr,
542 	&sensor_dev_attr_in3_alarm.dev_attr.attr,
543 
544 	&sensor_dev_attr_fan1_input.dev_attr.attr,
545 	&sensor_dev_attr_fan1_min.dev_attr.attr,
546 	&sensor_dev_attr_fan1_div.dev_attr.attr,
547 	&sensor_dev_attr_fan1_alarm.dev_attr.attr,
548 	&sensor_dev_attr_fan2_input.dev_attr.attr,
549 	&sensor_dev_attr_fan2_min.dev_attr.attr,
550 	&sensor_dev_attr_fan2_div.dev_attr.attr,
551 	&sensor_dev_attr_fan2_alarm.dev_attr.attr,
552 
553 	&dev_attr_alarms.attr,
554 	&dev_attr_name.attr,
555 	NULL
556 };
557 
558 static const struct attribute_group sis5595_group = {
559 	.attrs = sis5595_attributes,
560 };
561 
562 static struct attribute *sis5595_attributes_in4[] = {
563 	&sensor_dev_attr_in4_input.dev_attr.attr,
564 	&sensor_dev_attr_in4_min.dev_attr.attr,
565 	&sensor_dev_attr_in4_max.dev_attr.attr,
566 	&sensor_dev_attr_in4_alarm.dev_attr.attr,
567 	NULL
568 };
569 
570 static const struct attribute_group sis5595_group_in4 = {
571 	.attrs = sis5595_attributes_in4,
572 };
573 
574 static struct attribute *sis5595_attributes_temp1[] = {
575 	&dev_attr_temp1_input.attr,
576 	&dev_attr_temp1_max.attr,
577 	&dev_attr_temp1_max_hyst.attr,
578 	&sensor_dev_attr_temp1_alarm.dev_attr.attr,
579 	NULL
580 };
581 
582 static const struct attribute_group sis5595_group_temp1 = {
583 	.attrs = sis5595_attributes_temp1,
584 };
585 
586 /* This is called when the module is loaded */
587 static int sis5595_probe(struct platform_device *pdev)
588 {
589 	int err = 0;
590 	int i;
591 	struct sis5595_data *data;
592 	struct resource *res;
593 	char val;
594 
595 	/* Reserve the ISA region */
596 	res = platform_get_resource(pdev, IORESOURCE_IO, 0);
597 	if (!devm_request_region(&pdev->dev, res->start, SIS5595_EXTENT,
598 				 sis5595_driver.driver.name))
599 		return -EBUSY;
600 
601 	data = devm_kzalloc(&pdev->dev, sizeof(struct sis5595_data),
602 			    GFP_KERNEL);
603 	if (!data)
604 		return -ENOMEM;
605 
606 	mutex_init(&data->lock);
607 	mutex_init(&data->update_lock);
608 	data->addr = res->start;
609 	data->name = "sis5595";
610 	platform_set_drvdata(pdev, data);
611 
612 	/*
613 	 * Check revision and pin registers to determine whether 4 or 5 voltages
614 	 */
615 	data->revision = s_bridge->revision;
616 	/* 4 voltages, 1 temp */
617 	data->maxins = 3;
618 	if (data->revision >= REV2MIN) {
619 		pci_read_config_byte(s_bridge, SIS5595_PIN_REG, &val);
620 		if (!(val & 0x80))
621 			/* 5 voltages, no temps */
622 			data->maxins = 4;
623 	}
624 
625 	/* Initialize the SIS5595 chip */
626 	sis5595_init_device(data);
627 
628 	/* A few vars need to be filled upon startup */
629 	for (i = 0; i < 2; i++) {
630 		data->fan_min[i] = sis5595_read_value(data,
631 					SIS5595_REG_FAN_MIN(i));
632 	}
633 
634 	/* Register sysfs hooks */
635 	err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group);
636 	if (err)
637 		return err;
638 	if (data->maxins == 4) {
639 		err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group_in4);
640 		if (err)
641 			goto exit_remove_files;
642 	} else {
643 		err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group_temp1);
644 		if (err)
645 			goto exit_remove_files;
646 	}
647 
648 	data->hwmon_dev = hwmon_device_register(&pdev->dev);
649 	if (IS_ERR(data->hwmon_dev)) {
650 		err = PTR_ERR(data->hwmon_dev);
651 		goto exit_remove_files;
652 	}
653 
654 	return 0;
655 
656 exit_remove_files:
657 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group);
658 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_in4);
659 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_temp1);
660 	return err;
661 }
662 
663 static int sis5595_remove(struct platform_device *pdev)
664 {
665 	struct sis5595_data *data = platform_get_drvdata(pdev);
666 
667 	hwmon_device_unregister(data->hwmon_dev);
668 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group);
669 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_in4);
670 	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_temp1);
671 
672 	return 0;
673 }
674 
675 
676 /* ISA access must be locked explicitly. */
677 static int sis5595_read_value(struct sis5595_data *data, u8 reg)
678 {
679 	int res;
680 
681 	mutex_lock(&data->lock);
682 	outb_p(reg, data->addr + SIS5595_ADDR_REG_OFFSET);
683 	res = inb_p(data->addr + SIS5595_DATA_REG_OFFSET);
684 	mutex_unlock(&data->lock);
685 	return res;
686 }
687 
688 static void sis5595_write_value(struct sis5595_data *data, u8 reg, u8 value)
689 {
690 	mutex_lock(&data->lock);
691 	outb_p(reg, data->addr + SIS5595_ADDR_REG_OFFSET);
692 	outb_p(value, data->addr + SIS5595_DATA_REG_OFFSET);
693 	mutex_unlock(&data->lock);
694 }
695 
696 /* Called when we have found a new SIS5595. */
697 static void sis5595_init_device(struct sis5595_data *data)
698 {
699 	u8 config = sis5595_read_value(data, SIS5595_REG_CONFIG);
700 	if (!(config & 0x01))
701 		sis5595_write_value(data, SIS5595_REG_CONFIG,
702 				(config & 0xf7) | 0x01);
703 }
704 
705 static struct sis5595_data *sis5595_update_device(struct device *dev)
706 {
707 	struct sis5595_data *data = dev_get_drvdata(dev);
708 	int i;
709 
710 	mutex_lock(&data->update_lock);
711 
712 	if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
713 	    || !data->valid) {
714 
715 		for (i = 0; i <= data->maxins; i++) {
716 			data->in[i] =
717 			    sis5595_read_value(data, SIS5595_REG_IN(i));
718 			data->in_min[i] =
719 			    sis5595_read_value(data,
720 					       SIS5595_REG_IN_MIN(i));
721 			data->in_max[i] =
722 			    sis5595_read_value(data,
723 					       SIS5595_REG_IN_MAX(i));
724 		}
725 		for (i = 0; i < 2; i++) {
726 			data->fan[i] =
727 			    sis5595_read_value(data, SIS5595_REG_FAN(i));
728 			data->fan_min[i] =
729 			    sis5595_read_value(data,
730 					       SIS5595_REG_FAN_MIN(i));
731 		}
732 		if (data->maxins == 3) {
733 			data->temp =
734 			    sis5595_read_value(data, SIS5595_REG_TEMP);
735 			data->temp_over =
736 			    sis5595_read_value(data, SIS5595_REG_TEMP_OVER);
737 			data->temp_hyst =
738 			    sis5595_read_value(data, SIS5595_REG_TEMP_HYST);
739 		}
740 		i = sis5595_read_value(data, SIS5595_REG_FANDIV);
741 		data->fan_div[0] = (i >> 4) & 0x03;
742 		data->fan_div[1] = i >> 6;
743 		data->alarms =
744 		    sis5595_read_value(data, SIS5595_REG_ALARM1) |
745 		    (sis5595_read_value(data, SIS5595_REG_ALARM2) << 8);
746 		data->last_updated = jiffies;
747 		data->valid = 1;
748 	}
749 
750 	mutex_unlock(&data->update_lock);
751 
752 	return data;
753 }
754 
755 static DEFINE_PCI_DEVICE_TABLE(sis5595_pci_ids) = {
756 	{ PCI_DEVICE(PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_503) },
757 	{ 0, }
758 };
759 
760 MODULE_DEVICE_TABLE(pci, sis5595_pci_ids);
761 
762 static int blacklist[] = {
763 	PCI_DEVICE_ID_SI_540,
764 	PCI_DEVICE_ID_SI_550,
765 	PCI_DEVICE_ID_SI_630,
766 	PCI_DEVICE_ID_SI_645,
767 	PCI_DEVICE_ID_SI_730,
768 	PCI_DEVICE_ID_SI_735,
769 	PCI_DEVICE_ID_SI_5511, /*
770 				* 5513 chip has the 0008 device but
771 				* that ID shows up in other chips so we
772 				* use the 5511 ID for recognition
773 				*/
774 	PCI_DEVICE_ID_SI_5597,
775 	PCI_DEVICE_ID_SI_5598,
776 	0 };
777 
778 static int sis5595_device_add(unsigned short address)
779 {
780 	struct resource res = {
781 		.start	= address,
782 		.end	= address + SIS5595_EXTENT - 1,
783 		.name	= "sis5595",
784 		.flags	= IORESOURCE_IO,
785 	};
786 	int err;
787 
788 	err = acpi_check_resource_conflict(&res);
789 	if (err)
790 		goto exit;
791 
792 	pdev = platform_device_alloc("sis5595", address);
793 	if (!pdev) {
794 		err = -ENOMEM;
795 		pr_err("Device allocation failed\n");
796 		goto exit;
797 	}
798 
799 	err = platform_device_add_resources(pdev, &res, 1);
800 	if (err) {
801 		pr_err("Device resource addition failed (%d)\n", err);
802 		goto exit_device_put;
803 	}
804 
805 	err = platform_device_add(pdev);
806 	if (err) {
807 		pr_err("Device addition failed (%d)\n", err);
808 		goto exit_device_put;
809 	}
810 
811 	return 0;
812 
813 exit_device_put:
814 	platform_device_put(pdev);
815 exit:
816 	return err;
817 }
818 
819 static int sis5595_pci_probe(struct pci_dev *dev,
820 				       const struct pci_device_id *id)
821 {
822 	u16 address;
823 	u8 enable;
824 	int *i;
825 
826 	for (i = blacklist; *i != 0; i++) {
827 		struct pci_dev *d;
828 		d = pci_get_device(PCI_VENDOR_ID_SI, *i, NULL);
829 		if (d) {
830 			dev_err(&d->dev,
831 				"Looked for SIS5595 but found unsupported device %.4x\n",
832 				*i);
833 			pci_dev_put(d);
834 			return -ENODEV;
835 		}
836 	}
837 
838 	force_addr &= ~(SIS5595_EXTENT - 1);
839 	if (force_addr) {
840 		dev_warn(&dev->dev, "Forcing ISA address 0x%x\n", force_addr);
841 		pci_write_config_word(dev, SIS5595_BASE_REG, force_addr);
842 	}
843 
844 	if (PCIBIOS_SUCCESSFUL !=
845 	    pci_read_config_word(dev, SIS5595_BASE_REG, &address)) {
846 		dev_err(&dev->dev, "Failed to read ISA address\n");
847 		return -ENODEV;
848 	}
849 
850 	address &= ~(SIS5595_EXTENT - 1);
851 	if (!address) {
852 		dev_err(&dev->dev,
853 			"Base address not set - upgrade BIOS or use force_addr=0xaddr\n");
854 		return -ENODEV;
855 	}
856 	if (force_addr && address != force_addr) {
857 		/* doesn't work for some chips? */
858 		dev_err(&dev->dev, "Failed to force ISA address\n");
859 		return -ENODEV;
860 	}
861 
862 	if (PCIBIOS_SUCCESSFUL !=
863 	    pci_read_config_byte(dev, SIS5595_ENABLE_REG, &enable)) {
864 		dev_err(&dev->dev, "Failed to read enable register\n");
865 		return -ENODEV;
866 	}
867 	if (!(enable & 0x80)) {
868 		if ((PCIBIOS_SUCCESSFUL !=
869 		     pci_write_config_byte(dev, SIS5595_ENABLE_REG,
870 					   enable | 0x80))
871 		 || (PCIBIOS_SUCCESSFUL !=
872 		     pci_read_config_byte(dev, SIS5595_ENABLE_REG, &enable))
873 		 || (!(enable & 0x80))) {
874 			/* doesn't work for some chips! */
875 			dev_err(&dev->dev, "Failed to enable HWM device\n");
876 			return -ENODEV;
877 		}
878 	}
879 
880 	if (platform_driver_register(&sis5595_driver)) {
881 		dev_dbg(&dev->dev, "Failed to register sis5595 driver\n");
882 		goto exit;
883 	}
884 
885 	s_bridge = pci_dev_get(dev);
886 	/* Sets global pdev as a side effect */
887 	if (sis5595_device_add(address))
888 		goto exit_unregister;
889 
890 	/*
891 	 * Always return failure here.  This is to allow other drivers to bind
892 	 * to this pci device.  We don't really want to have control over the
893 	 * pci device, we only wanted to read as few register values from it.
894 	 */
895 	return -ENODEV;
896 
897 exit_unregister:
898 	pci_dev_put(dev);
899 	platform_driver_unregister(&sis5595_driver);
900 exit:
901 	return -ENODEV;
902 }
903 
904 static struct pci_driver sis5595_pci_driver = {
905 	.name            = "sis5595",
906 	.id_table        = sis5595_pci_ids,
907 	.probe           = sis5595_pci_probe,
908 };
909 
910 static int __init sm_sis5595_init(void)
911 {
912 	return pci_register_driver(&sis5595_pci_driver);
913 }
914 
915 static void __exit sm_sis5595_exit(void)
916 {
917 	pci_unregister_driver(&sis5595_pci_driver);
918 	if (s_bridge != NULL) {
919 		platform_device_unregister(pdev);
920 		platform_driver_unregister(&sis5595_driver);
921 		pci_dev_put(s_bridge);
922 		s_bridge = NULL;
923 	}
924 }
925 
926 MODULE_AUTHOR("Aurelien Jarno <aurelien@aurel32.net>");
927 MODULE_DESCRIPTION("SiS 5595 Sensor device");
928 MODULE_LICENSE("GPL");
929 
930 module_init(sm_sis5595_init);
931 module_exit(sm_sis5595_exit);
932