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 <jdelvare@suse.de>
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 */
75static u16 force_addr;
76module_param(force_addr, ushort, 0);
77MODULE_PARM_DESC(force_addr,
78		 "Initialize the base address of the sensors");
79
80static 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 */
133static 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
140static inline u8 FAN_TO_REG(long rpm, int div)
141{
142	if (rpm <= 0)
143		return 255;
144	if (rpm > 1350000)
145		return 1;
146	return clamp_val((1350000 + rpm * div / 2) / (rpm * div), 1, 254);
147}
148
149static inline int FAN_FROM_REG(u8 val, int div)
150{
151	return val == 0 ? -1 : val == 255 ? 0 : 1350000 / (val * div);
152}
153
154/*
155 * TEMP: mC (-54.12C to +157.53C)
156 * REG: 0.83C/bit + 52.12, two's complement
157 */
158static inline int TEMP_FROM_REG(s8 val)
159{
160	return val * 830 + 52120;
161}
162static inline s8 TEMP_TO_REG(long val)
163{
164	int nval = clamp_val(val, -54120, 157530) ;
165	return nval < 0 ? (nval - 5212 - 415) / 830 : (nval - 5212 + 415) / 830;
166}
167
168/*
169 * FAN DIV: 1, 2, 4, or 8 (defaults to 2)
170 * REG: 0, 1, 2, or 3 (respectively) (defaults to 1)
171 */
172static inline u8 DIV_TO_REG(int val)
173{
174	return val == 8 ? 3 : val == 4 ? 2 : val == 1 ? 0 : 1;
175}
176#define DIV_FROM_REG(val) (1 << (val))
177
178/*
179 * For each registered chip, we need to keep some data in memory.
180 * The structure is dynamically allocated.
181 */
182struct sis5595_data {
183	unsigned short addr;
184	const char *name;
185	struct device *hwmon_dev;
186	struct mutex lock;
187
188	struct mutex update_lock;
189	char valid;		/* !=0 if following fields are valid */
190	unsigned long last_updated;	/* In jiffies */
191	char maxins;		/* == 3 if temp enabled, otherwise == 4 */
192	u8 revision;		/* Reg. value */
193
194	u8 in[5];		/* Register value */
195	u8 in_max[5];		/* Register value */
196	u8 in_min[5];		/* Register value */
197	u8 fan[2];		/* Register value */
198	u8 fan_min[2];		/* Register value */
199	s8 temp;		/* Register value */
200	s8 temp_over;		/* Register value */
201	s8 temp_hyst;		/* Register value */
202	u8 fan_div[2];		/* Register encoding, shifted right */
203	u16 alarms;		/* Register encoding, combined */
204};
205
206static struct pci_dev *s_bridge;	/* pointer to the (only) sis5595 */
207
208static int sis5595_probe(struct platform_device *pdev);
209static int sis5595_remove(struct platform_device *pdev);
210
211static int sis5595_read_value(struct sis5595_data *data, u8 reg);
212static void sis5595_write_value(struct sis5595_data *data, u8 reg, u8 value);
213static struct sis5595_data *sis5595_update_device(struct device *dev);
214static void sis5595_init_device(struct sis5595_data *data);
215
216static struct platform_driver sis5595_driver = {
217	.driver = {
218		.owner	= THIS_MODULE,
219		.name	= "sis5595",
220	},
221	.probe		= sis5595_probe,
222	.remove		= sis5595_remove,
223};
224
225/* 4 Voltages */
226static ssize_t show_in(struct device *dev, struct device_attribute *da,
227		       char *buf)
228{
229	struct sis5595_data *data = sis5595_update_device(dev);
230	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
231	int nr = attr->index;
232	return sprintf(buf, "%d\n", IN_FROM_REG(data->in[nr]));
233}
234
235static ssize_t show_in_min(struct device *dev, struct device_attribute *da,
236			   char *buf)
237{
238	struct sis5595_data *data = sis5595_update_device(dev);
239	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
240	int nr = attr->index;
241	return sprintf(buf, "%d\n", IN_FROM_REG(data->in_min[nr]));
242}
243
244static ssize_t show_in_max(struct device *dev, struct device_attribute *da,
245			   char *buf)
246{
247	struct sis5595_data *data = sis5595_update_device(dev);
248	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
249	int nr = attr->index;
250	return sprintf(buf, "%d\n", IN_FROM_REG(data->in_max[nr]));
251}
252
253static ssize_t set_in_min(struct device *dev, struct device_attribute *da,
254			  const char *buf, size_t count)
255{
256	struct sis5595_data *data = dev_get_drvdata(dev);
257	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
258	int nr = attr->index;
259	unsigned long val;
260	int err;
261
262	err = kstrtoul(buf, 10, &val);
263	if (err)
264		return err;
265
266	mutex_lock(&data->update_lock);
267	data->in_min[nr] = IN_TO_REG(val);
268	sis5595_write_value(data, SIS5595_REG_IN_MIN(nr), data->in_min[nr]);
269	mutex_unlock(&data->update_lock);
270	return count;
271}
272
273static ssize_t set_in_max(struct device *dev, struct device_attribute *da,
274			  const char *buf, size_t count)
275{
276	struct sis5595_data *data = dev_get_drvdata(dev);
277	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
278	int nr = attr->index;
279	unsigned long val;
280	int err;
281
282	err = kstrtoul(buf, 10, &val);
283	if (err)
284		return err;
285
286	mutex_lock(&data->update_lock);
287	data->in_max[nr] = IN_TO_REG(val);
288	sis5595_write_value(data, SIS5595_REG_IN_MAX(nr), data->in_max[nr]);
289	mutex_unlock(&data->update_lock);
290	return count;
291}
292
293#define show_in_offset(offset)					\
294static SENSOR_DEVICE_ATTR(in##offset##_input, S_IRUGO,		\
295		show_in, NULL, offset);				\
296static SENSOR_DEVICE_ATTR(in##offset##_min, S_IRUGO | S_IWUSR,	\
297		show_in_min, set_in_min, offset);		\
298static SENSOR_DEVICE_ATTR(in##offset##_max, S_IRUGO | S_IWUSR,	\
299		show_in_max, set_in_max, offset);
300
301show_in_offset(0);
302show_in_offset(1);
303show_in_offset(2);
304show_in_offset(3);
305show_in_offset(4);
306
307/* Temperature */
308static ssize_t show_temp(struct device *dev, struct device_attribute *attr,
309			 char *buf)
310{
311	struct sis5595_data *data = sis5595_update_device(dev);
312	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp));
313}
314
315static ssize_t show_temp_over(struct device *dev, struct device_attribute *attr,
316			      char *buf)
317{
318	struct sis5595_data *data = sis5595_update_device(dev);
319	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_over));
320}
321
322static ssize_t set_temp_over(struct device *dev, struct device_attribute *attr,
323			     const char *buf, size_t count)
324{
325	struct sis5595_data *data = dev_get_drvdata(dev);
326	long val;
327	int err;
328
329	err = kstrtol(buf, 10, &val);
330	if (err)
331		return err;
332
333	mutex_lock(&data->update_lock);
334	data->temp_over = TEMP_TO_REG(val);
335	sis5595_write_value(data, SIS5595_REG_TEMP_OVER, data->temp_over);
336	mutex_unlock(&data->update_lock);
337	return count;
338}
339
340static ssize_t show_temp_hyst(struct device *dev, struct device_attribute *attr,
341			      char *buf)
342{
343	struct sis5595_data *data = sis5595_update_device(dev);
344	return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_hyst));
345}
346
347static ssize_t set_temp_hyst(struct device *dev, struct device_attribute *attr,
348			     const char *buf, size_t count)
349{
350	struct sis5595_data *data = dev_get_drvdata(dev);
351	long val;
352	int err;
353
354	err = kstrtol(buf, 10, &val);
355	if (err)
356		return err;
357
358	mutex_lock(&data->update_lock);
359	data->temp_hyst = TEMP_TO_REG(val);
360	sis5595_write_value(data, SIS5595_REG_TEMP_HYST, data->temp_hyst);
361	mutex_unlock(&data->update_lock);
362	return count;
363}
364
365static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL);
366static DEVICE_ATTR(temp1_max, S_IRUGO | S_IWUSR,
367		show_temp_over, set_temp_over);
368static DEVICE_ATTR(temp1_max_hyst, S_IRUGO | S_IWUSR,
369		show_temp_hyst, set_temp_hyst);
370
371/* 2 Fans */
372static ssize_t show_fan(struct device *dev, struct device_attribute *da,
373			char *buf)
374{
375	struct sis5595_data *data = sis5595_update_device(dev);
376	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
377	int nr = attr->index;
378	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[nr],
379		DIV_FROM_REG(data->fan_div[nr])));
380}
381
382static ssize_t show_fan_min(struct device *dev, struct device_attribute *da,
383			    char *buf)
384{
385	struct sis5595_data *data = sis5595_update_device(dev);
386	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
387	int nr = attr->index;
388	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_min[nr],
389		DIV_FROM_REG(data->fan_div[nr])));
390}
391
392static ssize_t set_fan_min(struct device *dev, struct device_attribute *da,
393			   const char *buf, size_t count)
394{
395	struct sis5595_data *data = dev_get_drvdata(dev);
396	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
397	int nr = attr->index;
398	unsigned long val;
399	int err;
400
401	err = kstrtoul(buf, 10, &val);
402	if (err)
403		return err;
404
405	mutex_lock(&data->update_lock);
406	data->fan_min[nr] = FAN_TO_REG(val, DIV_FROM_REG(data->fan_div[nr]));
407	sis5595_write_value(data, SIS5595_REG_FAN_MIN(nr), data->fan_min[nr]);
408	mutex_unlock(&data->update_lock);
409	return count;
410}
411
412static ssize_t show_fan_div(struct device *dev, struct device_attribute *da,
413			    char *buf)
414{
415	struct sis5595_data *data = sis5595_update_device(dev);
416	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
417	int nr = attr->index;
418	return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
419}
420
421/*
422 * Note: we save and restore the fan minimum here, because its value is
423 * determined in part by the fan divisor.  This follows the principle of
424 * least surprise; the user doesn't expect the fan minimum to change just
425 * because the divisor changed.
426 */
427static ssize_t set_fan_div(struct device *dev, struct device_attribute *da,
428			   const char *buf, size_t count)
429{
430	struct sis5595_data *data = dev_get_drvdata(dev);
431	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
432	int nr = attr->index;
433	unsigned long min;
434	int reg;
435	unsigned long val;
436	int err;
437
438	err = kstrtoul(buf, 10, &val);
439	if (err)
440		return err;
441
442	mutex_lock(&data->update_lock);
443	min = FAN_FROM_REG(data->fan_min[nr],
444			DIV_FROM_REG(data->fan_div[nr]));
445	reg = sis5595_read_value(data, SIS5595_REG_FANDIV);
446
447	switch (val) {
448	case 1:
449		data->fan_div[nr] = 0;
450		break;
451	case 2:
452		data->fan_div[nr] = 1;
453		break;
454	case 4:
455		data->fan_div[nr] = 2;
456		break;
457	case 8:
458		data->fan_div[nr] = 3;
459		break;
460	default:
461		dev_err(dev,
462			"fan_div value %ld not supported. Choose one of 1, 2, 4 or 8!\n",
463			val);
464		mutex_unlock(&data->update_lock);
465		return -EINVAL;
466	}
467
468	switch (nr) {
469	case 0:
470		reg = (reg & 0xcf) | (data->fan_div[nr] << 4);
471		break;
472	case 1:
473		reg = (reg & 0x3f) | (data->fan_div[nr] << 6);
474		break;
475	}
476	sis5595_write_value(data, SIS5595_REG_FANDIV, reg);
477	data->fan_min[nr] =
478		FAN_TO_REG(min, DIV_FROM_REG(data->fan_div[nr]));
479	sis5595_write_value(data, SIS5595_REG_FAN_MIN(nr), data->fan_min[nr]);
480	mutex_unlock(&data->update_lock);
481	return count;
482}
483
484#define show_fan_offset(offset)						\
485static SENSOR_DEVICE_ATTR(fan##offset##_input, S_IRUGO,			\
486		show_fan, NULL, offset - 1);				\
487static SENSOR_DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR,		\
488		show_fan_min, set_fan_min, offset - 1);			\
489static SENSOR_DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR,		\
490		show_fan_div, set_fan_div, offset - 1);
491
492show_fan_offset(1);
493show_fan_offset(2);
494
495/* Alarms */
496static ssize_t show_alarms(struct device *dev, struct device_attribute *attr,
497			   char *buf)
498{
499	struct sis5595_data *data = sis5595_update_device(dev);
500	return sprintf(buf, "%d\n", data->alarms);
501}
502static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
503
504static ssize_t show_alarm(struct device *dev, struct device_attribute *da,
505			  char *buf)
506{
507	struct sis5595_data *data = sis5595_update_device(dev);
508	int nr = to_sensor_dev_attr(da)->index;
509	return sprintf(buf, "%u\n", (data->alarms >> nr) & 1);
510}
511static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
512static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
513static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
514static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
515static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, show_alarm, NULL, 15);
516static SENSOR_DEVICE_ATTR(fan1_alarm, S_IRUGO, show_alarm, NULL, 6);
517static SENSOR_DEVICE_ATTR(fan2_alarm, S_IRUGO, show_alarm, NULL, 7);
518static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 15);
519
520static ssize_t show_name(struct device *dev, struct device_attribute *attr,
521			 char *buf)
522{
523	struct sis5595_data *data = dev_get_drvdata(dev);
524	return sprintf(buf, "%s\n", data->name);
525}
526static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
527
528static struct attribute *sis5595_attributes[] = {
529	&sensor_dev_attr_in0_input.dev_attr.attr,
530	&sensor_dev_attr_in0_min.dev_attr.attr,
531	&sensor_dev_attr_in0_max.dev_attr.attr,
532	&sensor_dev_attr_in0_alarm.dev_attr.attr,
533	&sensor_dev_attr_in1_input.dev_attr.attr,
534	&sensor_dev_attr_in1_min.dev_attr.attr,
535	&sensor_dev_attr_in1_max.dev_attr.attr,
536	&sensor_dev_attr_in1_alarm.dev_attr.attr,
537	&sensor_dev_attr_in2_input.dev_attr.attr,
538	&sensor_dev_attr_in2_min.dev_attr.attr,
539	&sensor_dev_attr_in2_max.dev_attr.attr,
540	&sensor_dev_attr_in2_alarm.dev_attr.attr,
541	&sensor_dev_attr_in3_input.dev_attr.attr,
542	&sensor_dev_attr_in3_min.dev_attr.attr,
543	&sensor_dev_attr_in3_max.dev_attr.attr,
544	&sensor_dev_attr_in3_alarm.dev_attr.attr,
545
546	&sensor_dev_attr_fan1_input.dev_attr.attr,
547	&sensor_dev_attr_fan1_min.dev_attr.attr,
548	&sensor_dev_attr_fan1_div.dev_attr.attr,
549	&sensor_dev_attr_fan1_alarm.dev_attr.attr,
550	&sensor_dev_attr_fan2_input.dev_attr.attr,
551	&sensor_dev_attr_fan2_min.dev_attr.attr,
552	&sensor_dev_attr_fan2_div.dev_attr.attr,
553	&sensor_dev_attr_fan2_alarm.dev_attr.attr,
554
555	&dev_attr_alarms.attr,
556	&dev_attr_name.attr,
557	NULL
558};
559
560static const struct attribute_group sis5595_group = {
561	.attrs = sis5595_attributes,
562};
563
564static struct attribute *sis5595_attributes_in4[] = {
565	&sensor_dev_attr_in4_input.dev_attr.attr,
566	&sensor_dev_attr_in4_min.dev_attr.attr,
567	&sensor_dev_attr_in4_max.dev_attr.attr,
568	&sensor_dev_attr_in4_alarm.dev_attr.attr,
569	NULL
570};
571
572static const struct attribute_group sis5595_group_in4 = {
573	.attrs = sis5595_attributes_in4,
574};
575
576static struct attribute *sis5595_attributes_temp1[] = {
577	&dev_attr_temp1_input.attr,
578	&dev_attr_temp1_max.attr,
579	&dev_attr_temp1_max_hyst.attr,
580	&sensor_dev_attr_temp1_alarm.dev_attr.attr,
581	NULL
582};
583
584static const struct attribute_group sis5595_group_temp1 = {
585	.attrs = sis5595_attributes_temp1,
586};
587
588/* This is called when the module is loaded */
589static int sis5595_probe(struct platform_device *pdev)
590{
591	int err = 0;
592	int i;
593	struct sis5595_data *data;
594	struct resource *res;
595	char val;
596
597	/* Reserve the ISA region */
598	res = platform_get_resource(pdev, IORESOURCE_IO, 0);
599	if (!devm_request_region(&pdev->dev, res->start, SIS5595_EXTENT,
600				 sis5595_driver.driver.name))
601		return -EBUSY;
602
603	data = devm_kzalloc(&pdev->dev, sizeof(struct sis5595_data),
604			    GFP_KERNEL);
605	if (!data)
606		return -ENOMEM;
607
608	mutex_init(&data->lock);
609	mutex_init(&data->update_lock);
610	data->addr = res->start;
611	data->name = "sis5595";
612	platform_set_drvdata(pdev, data);
613
614	/*
615	 * Check revision and pin registers to determine whether 4 or 5 voltages
616	 */
617	data->revision = s_bridge->revision;
618	/* 4 voltages, 1 temp */
619	data->maxins = 3;
620	if (data->revision >= REV2MIN) {
621		pci_read_config_byte(s_bridge, SIS5595_PIN_REG, &val);
622		if (!(val & 0x80))
623			/* 5 voltages, no temps */
624			data->maxins = 4;
625	}
626
627	/* Initialize the SIS5595 chip */
628	sis5595_init_device(data);
629
630	/* A few vars need to be filled upon startup */
631	for (i = 0; i < 2; i++) {
632		data->fan_min[i] = sis5595_read_value(data,
633					SIS5595_REG_FAN_MIN(i));
634	}
635
636	/* Register sysfs hooks */
637	err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group);
638	if (err)
639		return err;
640	if (data->maxins == 4) {
641		err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group_in4);
642		if (err)
643			goto exit_remove_files;
644	} else {
645		err = sysfs_create_group(&pdev->dev.kobj, &sis5595_group_temp1);
646		if (err)
647			goto exit_remove_files;
648	}
649
650	data->hwmon_dev = hwmon_device_register(&pdev->dev);
651	if (IS_ERR(data->hwmon_dev)) {
652		err = PTR_ERR(data->hwmon_dev);
653		goto exit_remove_files;
654	}
655
656	return 0;
657
658exit_remove_files:
659	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group);
660	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_in4);
661	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_temp1);
662	return err;
663}
664
665static int sis5595_remove(struct platform_device *pdev)
666{
667	struct sis5595_data *data = platform_get_drvdata(pdev);
668
669	hwmon_device_unregister(data->hwmon_dev);
670	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group);
671	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_in4);
672	sysfs_remove_group(&pdev->dev.kobj, &sis5595_group_temp1);
673
674	return 0;
675}
676
677
678/* ISA access must be locked explicitly. */
679static int sis5595_read_value(struct sis5595_data *data, u8 reg)
680{
681	int res;
682
683	mutex_lock(&data->lock);
684	outb_p(reg, data->addr + SIS5595_ADDR_REG_OFFSET);
685	res = inb_p(data->addr + SIS5595_DATA_REG_OFFSET);
686	mutex_unlock(&data->lock);
687	return res;
688}
689
690static void sis5595_write_value(struct sis5595_data *data, u8 reg, u8 value)
691{
692	mutex_lock(&data->lock);
693	outb_p(reg, data->addr + SIS5595_ADDR_REG_OFFSET);
694	outb_p(value, data->addr + SIS5595_DATA_REG_OFFSET);
695	mutex_unlock(&data->lock);
696}
697
698/* Called when we have found a new SIS5595. */
699static void sis5595_init_device(struct sis5595_data *data)
700{
701	u8 config = sis5595_read_value(data, SIS5595_REG_CONFIG);
702	if (!(config & 0x01))
703		sis5595_write_value(data, SIS5595_REG_CONFIG,
704				(config & 0xf7) | 0x01);
705}
706
707static struct sis5595_data *sis5595_update_device(struct device *dev)
708{
709	struct sis5595_data *data = dev_get_drvdata(dev);
710	int i;
711
712	mutex_lock(&data->update_lock);
713
714	if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
715	    || !data->valid) {
716
717		for (i = 0; i <= data->maxins; i++) {
718			data->in[i] =
719			    sis5595_read_value(data, SIS5595_REG_IN(i));
720			data->in_min[i] =
721			    sis5595_read_value(data,
722					       SIS5595_REG_IN_MIN(i));
723			data->in_max[i] =
724			    sis5595_read_value(data,
725					       SIS5595_REG_IN_MAX(i));
726		}
727		for (i = 0; i < 2; i++) {
728			data->fan[i] =
729			    sis5595_read_value(data, SIS5595_REG_FAN(i));
730			data->fan_min[i] =
731			    sis5595_read_value(data,
732					       SIS5595_REG_FAN_MIN(i));
733		}
734		if (data->maxins == 3) {
735			data->temp =
736			    sis5595_read_value(data, SIS5595_REG_TEMP);
737			data->temp_over =
738			    sis5595_read_value(data, SIS5595_REG_TEMP_OVER);
739			data->temp_hyst =
740			    sis5595_read_value(data, SIS5595_REG_TEMP_HYST);
741		}
742		i = sis5595_read_value(data, SIS5595_REG_FANDIV);
743		data->fan_div[0] = (i >> 4) & 0x03;
744		data->fan_div[1] = i >> 6;
745		data->alarms =
746		    sis5595_read_value(data, SIS5595_REG_ALARM1) |
747		    (sis5595_read_value(data, SIS5595_REG_ALARM2) << 8);
748		data->last_updated = jiffies;
749		data->valid = 1;
750	}
751
752	mutex_unlock(&data->update_lock);
753
754	return data;
755}
756
757static const struct pci_device_id sis5595_pci_ids[] = {
758	{ PCI_DEVICE(PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_503) },
759	{ 0, }
760};
761
762MODULE_DEVICE_TABLE(pci, sis5595_pci_ids);
763
764static int blacklist[] = {
765	PCI_DEVICE_ID_SI_540,
766	PCI_DEVICE_ID_SI_550,
767	PCI_DEVICE_ID_SI_630,
768	PCI_DEVICE_ID_SI_645,
769	PCI_DEVICE_ID_SI_730,
770	PCI_DEVICE_ID_SI_735,
771	PCI_DEVICE_ID_SI_5511, /*
772				* 5513 chip has the 0008 device but
773				* that ID shows up in other chips so we
774				* use the 5511 ID for recognition
775				*/
776	PCI_DEVICE_ID_SI_5597,
777	PCI_DEVICE_ID_SI_5598,
778	0 };
779
780static int sis5595_device_add(unsigned short address)
781{
782	struct resource res = {
783		.start	= address,
784		.end	= address + SIS5595_EXTENT - 1,
785		.name	= "sis5595",
786		.flags	= IORESOURCE_IO,
787	};
788	int err;
789
790	err = acpi_check_resource_conflict(&res);
791	if (err)
792		goto exit;
793
794	pdev = platform_device_alloc("sis5595", address);
795	if (!pdev) {
796		err = -ENOMEM;
797		pr_err("Device allocation failed\n");
798		goto exit;
799	}
800
801	err = platform_device_add_resources(pdev, &res, 1);
802	if (err) {
803		pr_err("Device resource addition failed (%d)\n", err);
804		goto exit_device_put;
805	}
806
807	err = platform_device_add(pdev);
808	if (err) {
809		pr_err("Device addition failed (%d)\n", err);
810		goto exit_device_put;
811	}
812
813	return 0;
814
815exit_device_put:
816	platform_device_put(pdev);
817exit:
818	return err;
819}
820
821static int sis5595_pci_probe(struct pci_dev *dev,
822				       const struct pci_device_id *id)
823{
824	u16 address;
825	u8 enable;
826	int *i;
827
828	for (i = blacklist; *i != 0; i++) {
829		struct pci_dev *d;
830		d = pci_get_device(PCI_VENDOR_ID_SI, *i, NULL);
831		if (d) {
832			dev_err(&d->dev,
833				"Looked for SIS5595 but found unsupported device %.4x\n",
834				*i);
835			pci_dev_put(d);
836			return -ENODEV;
837		}
838	}
839
840	force_addr &= ~(SIS5595_EXTENT - 1);
841	if (force_addr) {
842		dev_warn(&dev->dev, "Forcing ISA address 0x%x\n", force_addr);
843		pci_write_config_word(dev, SIS5595_BASE_REG, force_addr);
844	}
845
846	if (PCIBIOS_SUCCESSFUL !=
847	    pci_read_config_word(dev, SIS5595_BASE_REG, &address)) {
848		dev_err(&dev->dev, "Failed to read ISA address\n");
849		return -ENODEV;
850	}
851
852	address &= ~(SIS5595_EXTENT - 1);
853	if (!address) {
854		dev_err(&dev->dev,
855			"Base address not set - upgrade BIOS or use force_addr=0xaddr\n");
856		return -ENODEV;
857	}
858	if (force_addr && address != force_addr) {
859		/* doesn't work for some chips? */
860		dev_err(&dev->dev, "Failed to force ISA address\n");
861		return -ENODEV;
862	}
863
864	if (PCIBIOS_SUCCESSFUL !=
865	    pci_read_config_byte(dev, SIS5595_ENABLE_REG, &enable)) {
866		dev_err(&dev->dev, "Failed to read enable register\n");
867		return -ENODEV;
868	}
869	if (!(enable & 0x80)) {
870		if ((PCIBIOS_SUCCESSFUL !=
871		     pci_write_config_byte(dev, SIS5595_ENABLE_REG,
872					   enable | 0x80))
873		 || (PCIBIOS_SUCCESSFUL !=
874		     pci_read_config_byte(dev, SIS5595_ENABLE_REG, &enable))
875		 || (!(enable & 0x80))) {
876			/* doesn't work for some chips! */
877			dev_err(&dev->dev, "Failed to enable HWM device\n");
878			return -ENODEV;
879		}
880	}
881
882	if (platform_driver_register(&sis5595_driver)) {
883		dev_dbg(&dev->dev, "Failed to register sis5595 driver\n");
884		goto exit;
885	}
886
887	s_bridge = pci_dev_get(dev);
888	/* Sets global pdev as a side effect */
889	if (sis5595_device_add(address))
890		goto exit_unregister;
891
892	/*
893	 * Always return failure here.  This is to allow other drivers to bind
894	 * to this pci device.  We don't really want to have control over the
895	 * pci device, we only wanted to read as few register values from it.
896	 */
897	return -ENODEV;
898
899exit_unregister:
900	pci_dev_put(dev);
901	platform_driver_unregister(&sis5595_driver);
902exit:
903	return -ENODEV;
904}
905
906static struct pci_driver sis5595_pci_driver = {
907	.name            = "sis5595",
908	.id_table        = sis5595_pci_ids,
909	.probe           = sis5595_pci_probe,
910};
911
912static int __init sm_sis5595_init(void)
913{
914	return pci_register_driver(&sis5595_pci_driver);
915}
916
917static void __exit sm_sis5595_exit(void)
918{
919	pci_unregister_driver(&sis5595_pci_driver);
920	if (s_bridge != NULL) {
921		platform_device_unregister(pdev);
922		platform_driver_unregister(&sis5595_driver);
923		pci_dev_put(s_bridge);
924		s_bridge = NULL;
925	}
926}
927
928MODULE_AUTHOR("Aurelien Jarno <aurelien@aurel32.net>");
929MODULE_DESCRIPTION("SiS 5595 Sensor device");
930MODULE_LICENSE("GPL");
931
932module_init(sm_sis5595_init);
933module_exit(sm_sis5595_exit);
934