xref: /openbmc/linux/drivers/hwmon/gl518sm.c (revision 171f1bc7)
1 /*
2  * gl518sm.c - Part of lm_sensors, Linux kernel modules for hardware
3  *             monitoring
4  * Copyright (C) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and
5  * Kyosti Malkki <kmalkki@cc.hut.fi>
6  * Copyright (C) 2004 Hong-Gunn Chew <hglinux@gunnet.org> and
7  * Jean Delvare <khali@linux-fr.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22  *
23  * Ported to Linux 2.6 by Hong-Gunn Chew with the help of Jean Delvare
24  * and advice of Greg Kroah-Hartman.
25  *
26  * Notes about the port:
27  * Release 0x00 of the GL518SM chipset doesn't support reading of in0,
28  * in1 nor in2. The original driver had an ugly workaround to get them
29  * anyway (changing limits and watching alarms trigger and wear off).
30  * We did not keep that part of the original driver in the Linux 2.6
31  * version, since it was making the driver significantly more complex
32  * with no real benefit.
33  */
34 
35 #include <linux/module.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/jiffies.h>
39 #include <linux/i2c.h>
40 #include <linux/hwmon.h>
41 #include <linux/hwmon-sysfs.h>
42 #include <linux/err.h>
43 #include <linux/mutex.h>
44 #include <linux/sysfs.h>
45 
46 /* Addresses to scan */
47 static const unsigned short normal_i2c[] = { 0x2c, 0x2d, I2C_CLIENT_END };
48 
49 enum chips { gl518sm_r00, gl518sm_r80 };
50 
51 /* Many GL518 constants specified below */
52 
53 /* The GL518 registers */
54 #define GL518_REG_CHIP_ID	0x00
55 #define GL518_REG_REVISION	0x01
56 #define GL518_REG_VENDOR_ID	0x02
57 #define GL518_REG_CONF		0x03
58 #define GL518_REG_TEMP_IN	0x04
59 #define GL518_REG_TEMP_MAX	0x05
60 #define GL518_REG_TEMP_HYST	0x06
61 #define GL518_REG_FAN_COUNT	0x07
62 #define GL518_REG_FAN_LIMIT	0x08
63 #define GL518_REG_VIN1_LIMIT	0x09
64 #define GL518_REG_VIN2_LIMIT	0x0a
65 #define GL518_REG_VIN3_LIMIT	0x0b
66 #define GL518_REG_VDD_LIMIT	0x0c
67 #define GL518_REG_VIN3		0x0d
68 #define GL518_REG_MISC		0x0f
69 #define GL518_REG_ALARM		0x10
70 #define GL518_REG_MASK		0x11
71 #define GL518_REG_INT		0x12
72 #define GL518_REG_VIN2		0x13
73 #define GL518_REG_VIN1		0x14
74 #define GL518_REG_VDD		0x15
75 
76 
77 /*
78  * Conversions. Rounding and limit checking is only done on the TO_REG
79  * variants. Note that you should be a bit careful with which arguments
80  * these macros are called: arguments may be evaluated more than once.
81  * Fixing this is just not worth it.
82  */
83 
84 #define RAW_FROM_REG(val)	val
85 
86 #define BOOL_FROM_REG(val)	((val)?0:1)
87 #define BOOL_TO_REG(val)	((val)?0:1)
88 
89 #define TEMP_TO_REG(val)	(SENSORS_LIMIT(((((val)<0? \
90 				(val)-500:(val)+500)/1000)+119),0,255))
91 #define TEMP_FROM_REG(val)	(((val) - 119) * 1000)
92 
93 static inline u8 FAN_TO_REG(long rpm, int div)
94 {
95 	long rpmdiv;
96 	if (rpm == 0)
97 		return 0;
98 	rpmdiv = SENSORS_LIMIT(rpm, 1, 960000) * div;
99 	return SENSORS_LIMIT((480000 + rpmdiv / 2) / rpmdiv, 1, 255);
100 }
101 #define FAN_FROM_REG(val,div)	((val)==0 ? 0 : (480000/((val)*(div))))
102 
103 #define IN_TO_REG(val)		(SENSORS_LIMIT((((val)+9)/19),0,255))
104 #define IN_FROM_REG(val)	((val)*19)
105 
106 #define VDD_TO_REG(val)		(SENSORS_LIMIT((((val)*4+47)/95),0,255))
107 #define VDD_FROM_REG(val)	(((val)*95+2)/4)
108 
109 #define DIV_FROM_REG(val)	(1 << (val))
110 
111 #define BEEP_MASK_TO_REG(val)	((val) & 0x7f & data->alarm_mask)
112 #define BEEP_MASK_FROM_REG(val)	((val) & 0x7f)
113 
114 /* Each client has this additional data */
115 struct gl518_data {
116 	struct device *hwmon_dev;
117 	enum chips type;
118 
119 	struct mutex update_lock;
120 	char valid;		/* !=0 if following fields are valid */
121 	unsigned long last_updated;	/* In jiffies */
122 
123 	u8 voltage_in[4];	/* Register values; [0] = VDD */
124 	u8 voltage_min[4];	/* Register values; [0] = VDD */
125 	u8 voltage_max[4];	/* Register values; [0] = VDD */
126 	u8 fan_in[2];
127 	u8 fan_min[2];
128 	u8 fan_div[2];		/* Register encoding, shifted right */
129 	u8 fan_auto1;		/* Boolean */
130 	u8 temp_in;		/* Register values */
131 	u8 temp_max;		/* Register values */
132 	u8 temp_hyst;		/* Register values */
133 	u8 alarms;		/* Register value */
134 	u8 alarm_mask;
135 	u8 beep_mask;		/* Register value */
136 	u8 beep_enable;		/* Boolean */
137 };
138 
139 static int gl518_probe(struct i2c_client *client,
140 		       const struct i2c_device_id *id);
141 static int gl518_detect(struct i2c_client *client, struct i2c_board_info *info);
142 static void gl518_init_client(struct i2c_client *client);
143 static int gl518_remove(struct i2c_client *client);
144 static int gl518_read_value(struct i2c_client *client, u8 reg);
145 static int gl518_write_value(struct i2c_client *client, u8 reg, u16 value);
146 static struct gl518_data *gl518_update_device(struct device *dev);
147 
148 static const struct i2c_device_id gl518_id[] = {
149 	{ "gl518sm", 0 },
150 	{ }
151 };
152 MODULE_DEVICE_TABLE(i2c, gl518_id);
153 
154 /* This is the driver that will be inserted */
155 static struct i2c_driver gl518_driver = {
156 	.class		= I2C_CLASS_HWMON,
157 	.driver = {
158 		.name	= "gl518sm",
159 	},
160 	.probe		= gl518_probe,
161 	.remove		= gl518_remove,
162 	.id_table	= gl518_id,
163 	.detect		= gl518_detect,
164 	.address_list	= normal_i2c,
165 };
166 
167 /*
168  * Sysfs stuff
169  */
170 
171 #define show(type, suffix, value)					\
172 static ssize_t show_##suffix(struct device *dev, struct device_attribute *attr, char *buf)		\
173 {									\
174 	struct gl518_data *data = gl518_update_device(dev);		\
175 	return sprintf(buf, "%d\n", type##_FROM_REG(data->value));	\
176 }
177 
178 show(TEMP, temp_input1, temp_in);
179 show(TEMP, temp_max1, temp_max);
180 show(TEMP, temp_hyst1, temp_hyst);
181 show(BOOL, fan_auto1, fan_auto1);
182 show(VDD, in_input0, voltage_in[0]);
183 show(IN, in_input1, voltage_in[1]);
184 show(IN, in_input2, voltage_in[2]);
185 show(IN, in_input3, voltage_in[3]);
186 show(VDD, in_min0, voltage_min[0]);
187 show(IN, in_min1, voltage_min[1]);
188 show(IN, in_min2, voltage_min[2]);
189 show(IN, in_min3, voltage_min[3]);
190 show(VDD, in_max0, voltage_max[0]);
191 show(IN, in_max1, voltage_max[1]);
192 show(IN, in_max2, voltage_max[2]);
193 show(IN, in_max3, voltage_max[3]);
194 show(RAW, alarms, alarms);
195 show(BOOL, beep_enable, beep_enable);
196 show(BEEP_MASK, beep_mask, beep_mask);
197 
198 static ssize_t show_fan_input(struct device *dev,
199 			      struct device_attribute *attr, char *buf)
200 {
201 	int nr = to_sensor_dev_attr(attr)->index;
202 	struct gl518_data *data = gl518_update_device(dev);
203 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_in[nr],
204 					DIV_FROM_REG(data->fan_div[nr])));
205 }
206 
207 static ssize_t show_fan_min(struct device *dev,
208 			    struct device_attribute *attr, char *buf)
209 {
210 	int nr = to_sensor_dev_attr(attr)->index;
211 	struct gl518_data *data = gl518_update_device(dev);
212 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_min[nr],
213 					DIV_FROM_REG(data->fan_div[nr])));
214 }
215 
216 static ssize_t show_fan_div(struct device *dev,
217 			    struct device_attribute *attr, char *buf)
218 {
219 	int nr = to_sensor_dev_attr(attr)->index;
220 	struct gl518_data *data = gl518_update_device(dev);
221 	return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
222 }
223 
224 #define set(type, suffix, value, reg)					\
225 static ssize_t set_##suffix(struct device *dev, struct device_attribute *attr, const char *buf,	\
226 	size_t count)							\
227 {									\
228 	struct i2c_client *client = to_i2c_client(dev);			\
229 	struct gl518_data *data = i2c_get_clientdata(client);		\
230 	long val = simple_strtol(buf, NULL, 10);			\
231 									\
232 	mutex_lock(&data->update_lock);					\
233 	data->value = type##_TO_REG(val);				\
234 	gl518_write_value(client, reg, data->value);			\
235 	mutex_unlock(&data->update_lock);				\
236 	return count;							\
237 }
238 
239 #define set_bits(type, suffix, value, reg, mask, shift)			\
240 static ssize_t set_##suffix(struct device *dev, struct device_attribute *attr, const char *buf,	\
241 	size_t count)							\
242 {									\
243 	struct i2c_client *client = to_i2c_client(dev);			\
244 	struct gl518_data *data = i2c_get_clientdata(client);		\
245 	int regvalue;							\
246 	unsigned long val = simple_strtoul(buf, NULL, 10);		\
247 									\
248 	mutex_lock(&data->update_lock);					\
249 	regvalue = gl518_read_value(client, reg);			\
250 	data->value = type##_TO_REG(val);				\
251 	regvalue = (regvalue & ~mask) | (data->value << shift);		\
252 	gl518_write_value(client, reg, regvalue);			\
253 	mutex_unlock(&data->update_lock);				\
254 	return count;							\
255 }
256 
257 #define set_low(type, suffix, value, reg)				\
258 	set_bits(type, suffix, value, reg, 0x00ff, 0)
259 #define set_high(type, suffix, value, reg)				\
260 	set_bits(type, suffix, value, reg, 0xff00, 8)
261 
262 set(TEMP, temp_max1, temp_max, GL518_REG_TEMP_MAX);
263 set(TEMP, temp_hyst1, temp_hyst, GL518_REG_TEMP_HYST);
264 set_bits(BOOL, fan_auto1, fan_auto1, GL518_REG_MISC, 0x08, 3);
265 set_low(VDD, in_min0, voltage_min[0], GL518_REG_VDD_LIMIT);
266 set_low(IN, in_min1, voltage_min[1], GL518_REG_VIN1_LIMIT);
267 set_low(IN, in_min2, voltage_min[2], GL518_REG_VIN2_LIMIT);
268 set_low(IN, in_min3, voltage_min[3], GL518_REG_VIN3_LIMIT);
269 set_high(VDD, in_max0, voltage_max[0], GL518_REG_VDD_LIMIT);
270 set_high(IN, in_max1, voltage_max[1], GL518_REG_VIN1_LIMIT);
271 set_high(IN, in_max2, voltage_max[2], GL518_REG_VIN2_LIMIT);
272 set_high(IN, in_max3, voltage_max[3], GL518_REG_VIN3_LIMIT);
273 set_bits(BOOL, beep_enable, beep_enable, GL518_REG_CONF, 0x04, 2);
274 set(BEEP_MASK, beep_mask, beep_mask, GL518_REG_ALARM);
275 
276 static ssize_t set_fan_min(struct device *dev, struct device_attribute *attr,
277 			   const char *buf, size_t count)
278 {
279 	struct i2c_client *client = to_i2c_client(dev);
280 	struct gl518_data *data = i2c_get_clientdata(client);
281 	int nr = to_sensor_dev_attr(attr)->index;
282 	int regvalue;
283 	unsigned long val = simple_strtoul(buf, NULL, 10);
284 
285 	mutex_lock(&data->update_lock);
286 	regvalue = gl518_read_value(client, GL518_REG_FAN_LIMIT);
287 	data->fan_min[nr] = FAN_TO_REG(val, DIV_FROM_REG(data->fan_div[nr]));
288 	regvalue = (regvalue & (0xff << (8 * nr)))
289 		 | (data->fan_min[nr] << (8 * (1 - nr)));
290 	gl518_write_value(client, GL518_REG_FAN_LIMIT, regvalue);
291 
292 	data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
293 	if (data->fan_min[nr] == 0)
294 		data->alarm_mask &= ~(0x20 << nr);
295 	else
296 		data->alarm_mask |= (0x20 << nr);
297 	data->beep_mask &= data->alarm_mask;
298 	gl518_write_value(client, GL518_REG_ALARM, data->beep_mask);
299 
300 	mutex_unlock(&data->update_lock);
301 	return count;
302 }
303 
304 static ssize_t set_fan_div(struct device *dev, struct device_attribute *attr,
305 			   const char *buf, size_t count)
306 {
307 	struct i2c_client *client = to_i2c_client(dev);
308 	struct gl518_data *data = i2c_get_clientdata(client);
309 	int nr = to_sensor_dev_attr(attr)->index;
310 	int regvalue;
311 	unsigned long val = simple_strtoul(buf, NULL, 10);
312 
313 	switch (val) {
314 	case 1: val = 0; break;
315 	case 2: val = 1; break;
316 	case 4: val = 2; break;
317 	case 8: val = 3; break;
318 	default:
319 		dev_err(dev, "Invalid fan clock divider %lu, choose one "
320 			"of 1, 2, 4 or 8\n", val);
321 		return -EINVAL;
322 	}
323 
324 	mutex_lock(&data->update_lock);
325 	regvalue = gl518_read_value(client, GL518_REG_MISC);
326 	data->fan_div[nr] = val;
327 	regvalue = (regvalue & ~(0xc0 >> (2 * nr)))
328 		 | (data->fan_div[nr] << (6 - 2 * nr));
329 	gl518_write_value(client, GL518_REG_MISC, regvalue);
330 	mutex_unlock(&data->update_lock);
331 	return count;
332 }
333 
334 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL);
335 static DEVICE_ATTR(temp1_max, S_IWUSR|S_IRUGO, show_temp_max1, set_temp_max1);
336 static DEVICE_ATTR(temp1_max_hyst, S_IWUSR|S_IRUGO,
337 	show_temp_hyst1, set_temp_hyst1);
338 static DEVICE_ATTR(fan1_auto, S_IWUSR|S_IRUGO, show_fan_auto1, set_fan_auto1);
339 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan_input, NULL, 0);
340 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan_input, NULL, 1);
341 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR|S_IRUGO,
342 	show_fan_min, set_fan_min, 0);
343 static SENSOR_DEVICE_ATTR(fan2_min, S_IWUSR|S_IRUGO,
344 	show_fan_min, set_fan_min, 1);
345 static SENSOR_DEVICE_ATTR(fan1_div, S_IWUSR|S_IRUGO,
346 	show_fan_div, set_fan_div, 0);
347 static SENSOR_DEVICE_ATTR(fan2_div, S_IWUSR|S_IRUGO,
348 	show_fan_div, set_fan_div, 1);
349 static DEVICE_ATTR(in0_input, S_IRUGO, show_in_input0, NULL);
350 static DEVICE_ATTR(in1_input, S_IRUGO, show_in_input1, NULL);
351 static DEVICE_ATTR(in2_input, S_IRUGO, show_in_input2, NULL);
352 static DEVICE_ATTR(in3_input, S_IRUGO, show_in_input3, NULL);
353 static DEVICE_ATTR(in0_min, S_IWUSR|S_IRUGO, show_in_min0, set_in_min0);
354 static DEVICE_ATTR(in1_min, S_IWUSR|S_IRUGO, show_in_min1, set_in_min1);
355 static DEVICE_ATTR(in2_min, S_IWUSR|S_IRUGO, show_in_min2, set_in_min2);
356 static DEVICE_ATTR(in3_min, S_IWUSR|S_IRUGO, show_in_min3, set_in_min3);
357 static DEVICE_ATTR(in0_max, S_IWUSR|S_IRUGO, show_in_max0, set_in_max0);
358 static DEVICE_ATTR(in1_max, S_IWUSR|S_IRUGO, show_in_max1, set_in_max1);
359 static DEVICE_ATTR(in2_max, S_IWUSR|S_IRUGO, show_in_max2, set_in_max2);
360 static DEVICE_ATTR(in3_max, S_IWUSR|S_IRUGO, show_in_max3, set_in_max3);
361 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
362 static DEVICE_ATTR(beep_enable, S_IWUSR|S_IRUGO,
363 	show_beep_enable, set_beep_enable);
364 static DEVICE_ATTR(beep_mask, S_IWUSR|S_IRUGO,
365 	show_beep_mask, set_beep_mask);
366 
367 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
368 			  char *buf)
369 {
370 	int bitnr = to_sensor_dev_attr(attr)->index;
371 	struct gl518_data *data = gl518_update_device(dev);
372 	return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
373 }
374 
375 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
376 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
377 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
378 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
379 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 4);
380 static SENSOR_DEVICE_ATTR(fan1_alarm, S_IRUGO, show_alarm, NULL, 5);
381 static SENSOR_DEVICE_ATTR(fan2_alarm, S_IRUGO, show_alarm, NULL, 6);
382 
383 static ssize_t show_beep(struct device *dev, struct device_attribute *attr,
384 			  char *buf)
385 {
386 	int bitnr = to_sensor_dev_attr(attr)->index;
387 	struct gl518_data *data = gl518_update_device(dev);
388 	return sprintf(buf, "%u\n", (data->beep_mask >> bitnr) & 1);
389 }
390 
391 static ssize_t set_beep(struct device *dev, struct device_attribute *attr,
392 			const char *buf, size_t count)
393 {
394 	struct i2c_client *client = to_i2c_client(dev);
395 	struct gl518_data *data = i2c_get_clientdata(client);
396 	int bitnr = to_sensor_dev_attr(attr)->index;
397 	unsigned long bit;
398 
399 	bit = simple_strtoul(buf, NULL, 10);
400 	if (bit & ~1)
401 		return -EINVAL;
402 
403 	mutex_lock(&data->update_lock);
404 	data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
405 	if (bit)
406 		data->beep_mask |= (1 << bitnr);
407 	else
408 		data->beep_mask &= ~(1 << bitnr);
409 	gl518_write_value(client, GL518_REG_ALARM, data->beep_mask);
410 	mutex_unlock(&data->update_lock);
411 	return count;
412 }
413 
414 static SENSOR_DEVICE_ATTR(in0_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 0);
415 static SENSOR_DEVICE_ATTR(in1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 1);
416 static SENSOR_DEVICE_ATTR(in2_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 2);
417 static SENSOR_DEVICE_ATTR(in3_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 3);
418 static SENSOR_DEVICE_ATTR(temp1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 4);
419 static SENSOR_DEVICE_ATTR(fan1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 5);
420 static SENSOR_DEVICE_ATTR(fan2_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 6);
421 
422 static struct attribute *gl518_attributes[] = {
423 	&dev_attr_in3_input.attr,
424 	&dev_attr_in0_min.attr,
425 	&dev_attr_in1_min.attr,
426 	&dev_attr_in2_min.attr,
427 	&dev_attr_in3_min.attr,
428 	&dev_attr_in0_max.attr,
429 	&dev_attr_in1_max.attr,
430 	&dev_attr_in2_max.attr,
431 	&dev_attr_in3_max.attr,
432 	&sensor_dev_attr_in0_alarm.dev_attr.attr,
433 	&sensor_dev_attr_in1_alarm.dev_attr.attr,
434 	&sensor_dev_attr_in2_alarm.dev_attr.attr,
435 	&sensor_dev_attr_in3_alarm.dev_attr.attr,
436 	&sensor_dev_attr_in0_beep.dev_attr.attr,
437 	&sensor_dev_attr_in1_beep.dev_attr.attr,
438 	&sensor_dev_attr_in2_beep.dev_attr.attr,
439 	&sensor_dev_attr_in3_beep.dev_attr.attr,
440 
441 	&dev_attr_fan1_auto.attr,
442 	&sensor_dev_attr_fan1_input.dev_attr.attr,
443 	&sensor_dev_attr_fan2_input.dev_attr.attr,
444 	&sensor_dev_attr_fan1_min.dev_attr.attr,
445 	&sensor_dev_attr_fan2_min.dev_attr.attr,
446 	&sensor_dev_attr_fan1_div.dev_attr.attr,
447 	&sensor_dev_attr_fan2_div.dev_attr.attr,
448 	&sensor_dev_attr_fan1_alarm.dev_attr.attr,
449 	&sensor_dev_attr_fan2_alarm.dev_attr.attr,
450 	&sensor_dev_attr_fan1_beep.dev_attr.attr,
451 	&sensor_dev_attr_fan2_beep.dev_attr.attr,
452 
453 	&dev_attr_temp1_input.attr,
454 	&dev_attr_temp1_max.attr,
455 	&dev_attr_temp1_max_hyst.attr,
456 	&sensor_dev_attr_temp1_alarm.dev_attr.attr,
457 	&sensor_dev_attr_temp1_beep.dev_attr.attr,
458 
459 	&dev_attr_alarms.attr,
460 	&dev_attr_beep_enable.attr,
461 	&dev_attr_beep_mask.attr,
462 	NULL
463 };
464 
465 static const struct attribute_group gl518_group = {
466 	.attrs = gl518_attributes,
467 };
468 
469 static struct attribute *gl518_attributes_r80[] = {
470 	&dev_attr_in0_input.attr,
471 	&dev_attr_in1_input.attr,
472 	&dev_attr_in2_input.attr,
473 	NULL
474 };
475 
476 static const struct attribute_group gl518_group_r80 = {
477 	.attrs = gl518_attributes_r80,
478 };
479 
480 /*
481  * Real code
482  */
483 
484 /* Return 0 if detection is successful, -ENODEV otherwise */
485 static int gl518_detect(struct i2c_client *client, struct i2c_board_info *info)
486 {
487 	struct i2c_adapter *adapter = client->adapter;
488 	int rev;
489 
490 	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
491 				     I2C_FUNC_SMBUS_WORD_DATA))
492 		return -ENODEV;
493 
494 	/* Now, we do the remaining detection. */
495 	if ((gl518_read_value(client, GL518_REG_CHIP_ID) != 0x80)
496 	 || (gl518_read_value(client, GL518_REG_CONF) & 0x80))
497 		return -ENODEV;
498 
499 	/* Determine the chip type. */
500 	rev = gl518_read_value(client, GL518_REG_REVISION);
501 	if (rev != 0x00 && rev != 0x80)
502 		return -ENODEV;
503 
504 	strlcpy(info->type, "gl518sm", I2C_NAME_SIZE);
505 
506 	return 0;
507 }
508 
509 static int gl518_probe(struct i2c_client *client,
510 		       const struct i2c_device_id *id)
511 {
512 	struct gl518_data *data;
513 	int err, revision;
514 
515 	data = kzalloc(sizeof(struct gl518_data), GFP_KERNEL);
516 	if (!data) {
517 		err = -ENOMEM;
518 		goto exit;
519 	}
520 
521 	i2c_set_clientdata(client, data);
522 	revision = gl518_read_value(client, GL518_REG_REVISION);
523 	data->type = revision == 0x80 ? gl518sm_r80 : gl518sm_r00;
524 	mutex_init(&data->update_lock);
525 
526 	/* Initialize the GL518SM chip */
527 	data->alarm_mask = 0xff;
528 	gl518_init_client(client);
529 
530 	/* Register sysfs hooks */
531 	if ((err = sysfs_create_group(&client->dev.kobj, &gl518_group)))
532 		goto exit_free;
533 	if (data->type == gl518sm_r80)
534 		if ((err = sysfs_create_group(&client->dev.kobj,
535 					      &gl518_group_r80)))
536 			goto exit_remove_files;
537 
538 	data->hwmon_dev = hwmon_device_register(&client->dev);
539 	if (IS_ERR(data->hwmon_dev)) {
540 		err = PTR_ERR(data->hwmon_dev);
541 		goto exit_remove_files;
542 	}
543 
544 	return 0;
545 
546 exit_remove_files:
547 	sysfs_remove_group(&client->dev.kobj, &gl518_group);
548 	if (data->type == gl518sm_r80)
549 		sysfs_remove_group(&client->dev.kobj, &gl518_group_r80);
550 exit_free:
551 	kfree(data);
552 exit:
553 	return err;
554 }
555 
556 
557 /* Called when we have found a new GL518SM.
558    Note that we preserve D4:NoFan2 and D2:beep_enable. */
559 static void gl518_init_client(struct i2c_client *client)
560 {
561 	/* Make sure we leave D7:Reset untouched */
562 	u8 regvalue = gl518_read_value(client, GL518_REG_CONF) & 0x7f;
563 
564 	/* Comparator mode (D3=0), standby mode (D6=0) */
565 	gl518_write_value(client, GL518_REG_CONF, (regvalue &= 0x37));
566 
567 	/* Never interrupts */
568 	gl518_write_value(client, GL518_REG_MASK, 0x00);
569 
570 	/* Clear status register (D5=1), start (D6=1) */
571 	gl518_write_value(client, GL518_REG_CONF, 0x20 | regvalue);
572 	gl518_write_value(client, GL518_REG_CONF, 0x40 | regvalue);
573 }
574 
575 static int gl518_remove(struct i2c_client *client)
576 {
577 	struct gl518_data *data = i2c_get_clientdata(client);
578 
579 	hwmon_device_unregister(data->hwmon_dev);
580 	sysfs_remove_group(&client->dev.kobj, &gl518_group);
581 	if (data->type == gl518sm_r80)
582 		sysfs_remove_group(&client->dev.kobj, &gl518_group_r80);
583 
584 	kfree(data);
585 	return 0;
586 }
587 
588 /* Registers 0x07 to 0x0c are word-sized, others are byte-sized
589    GL518 uses a high-byte first convention, which is exactly opposite to
590    the SMBus standard. */
591 static int gl518_read_value(struct i2c_client *client, u8 reg)
592 {
593 	if ((reg >= 0x07) && (reg <= 0x0c))
594 		return i2c_smbus_read_word_swapped(client, reg);
595 	else
596 		return i2c_smbus_read_byte_data(client, reg);
597 }
598 
599 static int gl518_write_value(struct i2c_client *client, u8 reg, u16 value)
600 {
601 	if ((reg >= 0x07) && (reg <= 0x0c))
602 		return i2c_smbus_write_word_swapped(client, reg, value);
603 	else
604 		return i2c_smbus_write_byte_data(client, reg, value);
605 }
606 
607 static struct gl518_data *gl518_update_device(struct device *dev)
608 {
609 	struct i2c_client *client = to_i2c_client(dev);
610 	struct gl518_data *data = i2c_get_clientdata(client);
611 	int val;
612 
613 	mutex_lock(&data->update_lock);
614 
615 	if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
616 	    || !data->valid) {
617 		dev_dbg(&client->dev, "Starting gl518 update\n");
618 
619 		data->alarms = gl518_read_value(client, GL518_REG_INT);
620 		data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
621 
622 		val = gl518_read_value(client, GL518_REG_VDD_LIMIT);
623 		data->voltage_min[0] = val & 0xff;
624 		data->voltage_max[0] = (val >> 8) & 0xff;
625 		val = gl518_read_value(client, GL518_REG_VIN1_LIMIT);
626 		data->voltage_min[1] = val & 0xff;
627 		data->voltage_max[1] = (val >> 8) & 0xff;
628 		val = gl518_read_value(client, GL518_REG_VIN2_LIMIT);
629 		data->voltage_min[2] = val & 0xff;
630 		data->voltage_max[2] = (val >> 8) & 0xff;
631 		val = gl518_read_value(client, GL518_REG_VIN3_LIMIT);
632 		data->voltage_min[3] = val & 0xff;
633 		data->voltage_max[3] = (val >> 8) & 0xff;
634 
635 		val = gl518_read_value(client, GL518_REG_FAN_COUNT);
636 		data->fan_in[0] = (val >> 8) & 0xff;
637 		data->fan_in[1] = val & 0xff;
638 
639 		val = gl518_read_value(client, GL518_REG_FAN_LIMIT);
640 		data->fan_min[0] = (val >> 8) & 0xff;
641 		data->fan_min[1] = val & 0xff;
642 
643 		data->temp_in = gl518_read_value(client, GL518_REG_TEMP_IN);
644 		data->temp_max =
645 		    gl518_read_value(client, GL518_REG_TEMP_MAX);
646 		data->temp_hyst =
647 		    gl518_read_value(client, GL518_REG_TEMP_HYST);
648 
649 		val = gl518_read_value(client, GL518_REG_MISC);
650 		data->fan_div[0] = (val >> 6) & 0x03;
651 		data->fan_div[1] = (val >> 4) & 0x03;
652 		data->fan_auto1  = (val >> 3) & 0x01;
653 
654 		data->alarms &= data->alarm_mask;
655 
656 		val = gl518_read_value(client, GL518_REG_CONF);
657 		data->beep_enable = (val >> 2) & 1;
658 
659 		if (data->type != gl518sm_r00) {
660 			data->voltage_in[0] =
661 			    gl518_read_value(client, GL518_REG_VDD);
662 			data->voltage_in[1] =
663 			    gl518_read_value(client, GL518_REG_VIN1);
664 			data->voltage_in[2] =
665 			    gl518_read_value(client, GL518_REG_VIN2);
666 		}
667 		data->voltage_in[3] =
668 		    gl518_read_value(client, GL518_REG_VIN3);
669 
670 		data->last_updated = jiffies;
671 		data->valid = 1;
672 	}
673 
674 	mutex_unlock(&data->update_lock);
675 
676 	return data;
677 }
678 
679 static int __init sensors_gl518sm_init(void)
680 {
681 	return i2c_add_driver(&gl518_driver);
682 }
683 
684 static void __exit sensors_gl518sm_exit(void)
685 {
686 	i2c_del_driver(&gl518_driver);
687 }
688 
689 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>, "
690 	"Kyosti Malkki <kmalkki@cc.hut.fi> and "
691 	"Hong-Gunn Chew <hglinux@gunnet.org>");
692 MODULE_DESCRIPTION("GL518SM driver");
693 MODULE_LICENSE("GPL");
694 
695 module_init(sensors_gl518sm_init);
696 module_exit(sensors_gl518sm_exit);
697