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 : \
91 				(val) + 500) / 1000) + 119), 0, 255)
92 #define TEMP_FROM_REG(val)	(((val) - 119) * 1000)
93 
FAN_TO_REG(long rpm,int div)94 static inline u8 FAN_TO_REG(long rpm, int div)
95 {
96 	long rpmdiv;
97 	if (rpm == 0)
98 		return 0;
99 	rpmdiv = SENSORS_LIMIT(rpm, 1, 960000) * div;
100 	return SENSORS_LIMIT((480000 + rpmdiv / 2) / rpmdiv, 1, 255);
101 }
102 #define FAN_FROM_REG(val, div)	((val) == 0 ? 0 : (480000 / ((val) * (div))))
103 
104 #define IN_TO_REG(val)		SENSORS_LIMIT((((val) + 9) / 19), 0, 255)
105 #define IN_FROM_REG(val)	((val) * 19)
106 
107 #define VDD_TO_REG(val)		SENSORS_LIMIT((((val) * 4 + 47) / 95), 0, 255)
108 #define VDD_FROM_REG(val)	(((val) * 95 + 2) / 4)
109 
110 #define DIV_FROM_REG(val)	(1 << (val))
111 
112 #define BEEP_MASK_TO_REG(val)	((val) & 0x7f & data->alarm_mask)
113 #define BEEP_MASK_FROM_REG(val)	((val) & 0x7f)
114 
115 /* Each client has this additional data */
116 struct gl518_data {
117 	struct device *hwmon_dev;
118 	enum chips type;
119 
120 	struct mutex update_lock;
121 	char valid;		/* !=0 if following fields are valid */
122 	unsigned long last_updated;	/* In jiffies */
123 
124 	u8 voltage_in[4];	/* Register values; [0] = VDD */
125 	u8 voltage_min[4];	/* Register values; [0] = VDD */
126 	u8 voltage_max[4];	/* Register values; [0] = VDD */
127 	u8 fan_in[2];
128 	u8 fan_min[2];
129 	u8 fan_div[2];		/* Register encoding, shifted right */
130 	u8 fan_auto1;		/* Boolean */
131 	u8 temp_in;		/* Register values */
132 	u8 temp_max;		/* Register values */
133 	u8 temp_hyst;		/* Register values */
134 	u8 alarms;		/* Register value */
135 	u8 alarm_mask;
136 	u8 beep_mask;		/* Register value */
137 	u8 beep_enable;		/* Boolean */
138 };
139 
140 static int gl518_probe(struct i2c_client *client,
141 		       const struct i2c_device_id *id);
142 static int gl518_detect(struct i2c_client *client, struct i2c_board_info *info);
143 static void gl518_init_client(struct i2c_client *client);
144 static int gl518_remove(struct i2c_client *client);
145 static int gl518_read_value(struct i2c_client *client, u8 reg);
146 static int gl518_write_value(struct i2c_client *client, u8 reg, u16 value);
147 static struct gl518_data *gl518_update_device(struct device *dev);
148 
149 static const struct i2c_device_id gl518_id[] = {
150 	{ "gl518sm", 0 },
151 	{ }
152 };
153 MODULE_DEVICE_TABLE(i2c, gl518_id);
154 
155 /* This is the driver that will be inserted */
156 static struct i2c_driver gl518_driver = {
157 	.class		= I2C_CLASS_HWMON,
158 	.driver = {
159 		.name	= "gl518sm",
160 	},
161 	.probe		= gl518_probe,
162 	.remove		= gl518_remove,
163 	.id_table	= gl518_id,
164 	.detect		= gl518_detect,
165 	.address_list	= normal_i2c,
166 };
167 
168 /*
169  * Sysfs stuff
170  */
171 
172 #define show(type, suffix, value)					\
173 static ssize_t show_##suffix(struct device *dev,			\
174 			     struct device_attribute *attr, char *buf)	\
175 {									\
176 	struct gl518_data *data = gl518_update_device(dev);		\
177 	return sprintf(buf, "%d\n", type##_FROM_REG(data->value));	\
178 }
179 
180 show(TEMP, temp_input1, temp_in);
181 show(TEMP, temp_max1, temp_max);
182 show(TEMP, temp_hyst1, temp_hyst);
183 show(BOOL, fan_auto1, fan_auto1);
184 show(VDD, in_input0, voltage_in[0]);
185 show(IN, in_input1, voltage_in[1]);
186 show(IN, in_input2, voltage_in[2]);
187 show(IN, in_input3, voltage_in[3]);
188 show(VDD, in_min0, voltage_min[0]);
189 show(IN, in_min1, voltage_min[1]);
190 show(IN, in_min2, voltage_min[2]);
191 show(IN, in_min3, voltage_min[3]);
192 show(VDD, in_max0, voltage_max[0]);
193 show(IN, in_max1, voltage_max[1]);
194 show(IN, in_max2, voltage_max[2]);
195 show(IN, in_max3, voltage_max[3]);
196 show(RAW, alarms, alarms);
197 show(BOOL, beep_enable, beep_enable);
198 show(BEEP_MASK, beep_mask, beep_mask);
199 
show_fan_input(struct device * dev,struct device_attribute * attr,char * buf)200 static ssize_t show_fan_input(struct device *dev,
201 			      struct device_attribute *attr, char *buf)
202 {
203 	int nr = to_sensor_dev_attr(attr)->index;
204 	struct gl518_data *data = gl518_update_device(dev);
205 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_in[nr],
206 					DIV_FROM_REG(data->fan_div[nr])));
207 }
208 
show_fan_min(struct device * dev,struct device_attribute * attr,char * buf)209 static ssize_t show_fan_min(struct device *dev,
210 			    struct device_attribute *attr, char *buf)
211 {
212 	int nr = to_sensor_dev_attr(attr)->index;
213 	struct gl518_data *data = gl518_update_device(dev);
214 	return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan_min[nr],
215 					DIV_FROM_REG(data->fan_div[nr])));
216 }
217 
show_fan_div(struct device * dev,struct device_attribute * attr,char * buf)218 static ssize_t show_fan_div(struct device *dev,
219 			    struct device_attribute *attr, char *buf)
220 {
221 	int nr = to_sensor_dev_attr(attr)->index;
222 	struct gl518_data *data = gl518_update_device(dev);
223 	return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]));
224 }
225 
226 #define set(type, suffix, value, reg)					\
227 static ssize_t set_##suffix(struct device *dev,				\
228 			    struct device_attribute *attr,		\
229 			    const char *buf, size_t count)		\
230 {									\
231 	struct i2c_client *client = to_i2c_client(dev);			\
232 	struct gl518_data *data = i2c_get_clientdata(client);		\
233 	long val;							\
234 	int err = kstrtol(buf, 10, &val);				\
235 	if (err)							\
236 		return err;						\
237 									\
238 	mutex_lock(&data->update_lock);					\
239 	data->value = type##_TO_REG(val);				\
240 	gl518_write_value(client, reg, data->value);			\
241 	mutex_unlock(&data->update_lock);				\
242 	return count;							\
243 }
244 
245 #define set_bits(type, suffix, value, reg, mask, shift)			\
246 static ssize_t set_##suffix(struct device *dev,				\
247 			    struct device_attribute *attr,		\
248 			    const char *buf, size_t count)		\
249 {									\
250 	struct i2c_client *client = to_i2c_client(dev);			\
251 	struct gl518_data *data = i2c_get_clientdata(client);		\
252 	int regvalue;							\
253 	unsigned long val;						\
254 	int err = kstrtoul(buf, 10, &val);				\
255 	if (err)							\
256 		return err;						\
257 									\
258 	mutex_lock(&data->update_lock);					\
259 	regvalue = gl518_read_value(client, reg);			\
260 	data->value = type##_TO_REG(val);				\
261 	regvalue = (regvalue & ~mask) | (data->value << shift);		\
262 	gl518_write_value(client, reg, regvalue);			\
263 	mutex_unlock(&data->update_lock);				\
264 	return count;							\
265 }
266 
267 #define set_low(type, suffix, value, reg)				\
268 	set_bits(type, suffix, value, reg, 0x00ff, 0)
269 #define set_high(type, suffix, value, reg)				\
270 	set_bits(type, suffix, value, reg, 0xff00, 8)
271 
272 set(TEMP, temp_max1, temp_max, GL518_REG_TEMP_MAX);
273 set(TEMP, temp_hyst1, temp_hyst, GL518_REG_TEMP_HYST);
274 set_bits(BOOL, fan_auto1, fan_auto1, GL518_REG_MISC, 0x08, 3);
275 set_low(VDD, in_min0, voltage_min[0], GL518_REG_VDD_LIMIT);
276 set_low(IN, in_min1, voltage_min[1], GL518_REG_VIN1_LIMIT);
277 set_low(IN, in_min2, voltage_min[2], GL518_REG_VIN2_LIMIT);
278 set_low(IN, in_min3, voltage_min[3], GL518_REG_VIN3_LIMIT);
279 set_high(VDD, in_max0, voltage_max[0], GL518_REG_VDD_LIMIT);
280 set_high(IN, in_max1, voltage_max[1], GL518_REG_VIN1_LIMIT);
281 set_high(IN, in_max2, voltage_max[2], GL518_REG_VIN2_LIMIT);
282 set_high(IN, in_max3, voltage_max[3], GL518_REG_VIN3_LIMIT);
283 set_bits(BOOL, beep_enable, beep_enable, GL518_REG_CONF, 0x04, 2);
284 set(BEEP_MASK, beep_mask, beep_mask, GL518_REG_ALARM);
285 
set_fan_min(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)286 static ssize_t set_fan_min(struct device *dev, struct device_attribute *attr,
287 			   const char *buf, size_t count)
288 {
289 	struct i2c_client *client = to_i2c_client(dev);
290 	struct gl518_data *data = i2c_get_clientdata(client);
291 	int nr = to_sensor_dev_attr(attr)->index;
292 	int regvalue;
293 	unsigned long val;
294 	int err;
295 
296 	err = kstrtoul(buf, 10, &val);
297 	if (err)
298 		return err;
299 
300 	mutex_lock(&data->update_lock);
301 	regvalue = gl518_read_value(client, GL518_REG_FAN_LIMIT);
302 	data->fan_min[nr] = FAN_TO_REG(val, DIV_FROM_REG(data->fan_div[nr]));
303 	regvalue = (regvalue & (0xff << (8 * nr)))
304 		 | (data->fan_min[nr] << (8 * (1 - nr)));
305 	gl518_write_value(client, GL518_REG_FAN_LIMIT, regvalue);
306 
307 	data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
308 	if (data->fan_min[nr] == 0)
309 		data->alarm_mask &= ~(0x20 << nr);
310 	else
311 		data->alarm_mask |= (0x20 << nr);
312 	data->beep_mask &= data->alarm_mask;
313 	gl518_write_value(client, GL518_REG_ALARM, data->beep_mask);
314 
315 	mutex_unlock(&data->update_lock);
316 	return count;
317 }
318 
set_fan_div(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)319 static ssize_t set_fan_div(struct device *dev, struct device_attribute *attr,
320 			   const char *buf, size_t count)
321 {
322 	struct i2c_client *client = to_i2c_client(dev);
323 	struct gl518_data *data = i2c_get_clientdata(client);
324 	int nr = to_sensor_dev_attr(attr)->index;
325 	int regvalue;
326 	unsigned long val;
327 	int err;
328 
329 	err = kstrtoul(buf, 10, &val);
330 	if (err)
331 		return err;
332 
333 	switch (val) {
334 	case 1:
335 		val = 0;
336 		break;
337 	case 2:
338 		val = 1;
339 		break;
340 	case 4:
341 		val = 2;
342 		break;
343 	case 8:
344 		val = 3;
345 		break;
346 	default:
347 		dev_err(dev, "Invalid fan clock divider %lu, choose one "
348 			"of 1, 2, 4 or 8\n", val);
349 		return -EINVAL;
350 	}
351 
352 	mutex_lock(&data->update_lock);
353 	regvalue = gl518_read_value(client, GL518_REG_MISC);
354 	data->fan_div[nr] = val;
355 	regvalue = (regvalue & ~(0xc0 >> (2 * nr)))
356 		 | (data->fan_div[nr] << (6 - 2 * nr));
357 	gl518_write_value(client, GL518_REG_MISC, regvalue);
358 	mutex_unlock(&data->update_lock);
359 	return count;
360 }
361 
362 static DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_input1, NULL);
363 static DEVICE_ATTR(temp1_max, S_IWUSR|S_IRUGO, show_temp_max1, set_temp_max1);
364 static DEVICE_ATTR(temp1_max_hyst, S_IWUSR|S_IRUGO,
365 	show_temp_hyst1, set_temp_hyst1);
366 static DEVICE_ATTR(fan1_auto, S_IWUSR|S_IRUGO, show_fan_auto1, set_fan_auto1);
367 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan_input, NULL, 0);
368 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan_input, NULL, 1);
369 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR|S_IRUGO,
370 	show_fan_min, set_fan_min, 0);
371 static SENSOR_DEVICE_ATTR(fan2_min, S_IWUSR|S_IRUGO,
372 	show_fan_min, set_fan_min, 1);
373 static SENSOR_DEVICE_ATTR(fan1_div, S_IWUSR|S_IRUGO,
374 	show_fan_div, set_fan_div, 0);
375 static SENSOR_DEVICE_ATTR(fan2_div, S_IWUSR|S_IRUGO,
376 	show_fan_div, set_fan_div, 1);
377 static DEVICE_ATTR(in0_input, S_IRUGO, show_in_input0, NULL);
378 static DEVICE_ATTR(in1_input, S_IRUGO, show_in_input1, NULL);
379 static DEVICE_ATTR(in2_input, S_IRUGO, show_in_input2, NULL);
380 static DEVICE_ATTR(in3_input, S_IRUGO, show_in_input3, NULL);
381 static DEVICE_ATTR(in0_min, S_IWUSR|S_IRUGO, show_in_min0, set_in_min0);
382 static DEVICE_ATTR(in1_min, S_IWUSR|S_IRUGO, show_in_min1, set_in_min1);
383 static DEVICE_ATTR(in2_min, S_IWUSR|S_IRUGO, show_in_min2, set_in_min2);
384 static DEVICE_ATTR(in3_min, S_IWUSR|S_IRUGO, show_in_min3, set_in_min3);
385 static DEVICE_ATTR(in0_max, S_IWUSR|S_IRUGO, show_in_max0, set_in_max0);
386 static DEVICE_ATTR(in1_max, S_IWUSR|S_IRUGO, show_in_max1, set_in_max1);
387 static DEVICE_ATTR(in2_max, S_IWUSR|S_IRUGO, show_in_max2, set_in_max2);
388 static DEVICE_ATTR(in3_max, S_IWUSR|S_IRUGO, show_in_max3, set_in_max3);
389 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
390 static DEVICE_ATTR(beep_enable, S_IWUSR|S_IRUGO,
391 	show_beep_enable, set_beep_enable);
392 static DEVICE_ATTR(beep_mask, S_IWUSR|S_IRUGO,
393 	show_beep_mask, set_beep_mask);
394 
show_alarm(struct device * dev,struct device_attribute * attr,char * buf)395 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
396 			  char *buf)
397 {
398 	int bitnr = to_sensor_dev_attr(attr)->index;
399 	struct gl518_data *data = gl518_update_device(dev);
400 	return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
401 }
402 
403 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
404 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
405 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
406 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
407 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 4);
408 static SENSOR_DEVICE_ATTR(fan1_alarm, S_IRUGO, show_alarm, NULL, 5);
409 static SENSOR_DEVICE_ATTR(fan2_alarm, S_IRUGO, show_alarm, NULL, 6);
410 
show_beep(struct device * dev,struct device_attribute * attr,char * buf)411 static ssize_t show_beep(struct device *dev, struct device_attribute *attr,
412 			  char *buf)
413 {
414 	int bitnr = to_sensor_dev_attr(attr)->index;
415 	struct gl518_data *data = gl518_update_device(dev);
416 	return sprintf(buf, "%u\n", (data->beep_mask >> bitnr) & 1);
417 }
418 
set_beep(struct device * dev,struct device_attribute * attr,const char * buf,size_t count)419 static ssize_t set_beep(struct device *dev, struct device_attribute *attr,
420 			const char *buf, size_t count)
421 {
422 	struct i2c_client *client = to_i2c_client(dev);
423 	struct gl518_data *data = i2c_get_clientdata(client);
424 	int bitnr = to_sensor_dev_attr(attr)->index;
425 	unsigned long bit;
426 	int err;
427 
428 	err = kstrtoul(buf, 10, &bit);
429 	if (err)
430 		return err;
431 
432 	if (bit & ~1)
433 		return -EINVAL;
434 
435 	mutex_lock(&data->update_lock);
436 	data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
437 	if (bit)
438 		data->beep_mask |= (1 << bitnr);
439 	else
440 		data->beep_mask &= ~(1 << bitnr);
441 	gl518_write_value(client, GL518_REG_ALARM, data->beep_mask);
442 	mutex_unlock(&data->update_lock);
443 	return count;
444 }
445 
446 static SENSOR_DEVICE_ATTR(in0_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 0);
447 static SENSOR_DEVICE_ATTR(in1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 1);
448 static SENSOR_DEVICE_ATTR(in2_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 2);
449 static SENSOR_DEVICE_ATTR(in3_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 3);
450 static SENSOR_DEVICE_ATTR(temp1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 4);
451 static SENSOR_DEVICE_ATTR(fan1_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 5);
452 static SENSOR_DEVICE_ATTR(fan2_beep, S_IRUGO|S_IWUSR, show_beep, set_beep, 6);
453 
454 static struct attribute *gl518_attributes[] = {
455 	&dev_attr_in3_input.attr,
456 	&dev_attr_in0_min.attr,
457 	&dev_attr_in1_min.attr,
458 	&dev_attr_in2_min.attr,
459 	&dev_attr_in3_min.attr,
460 	&dev_attr_in0_max.attr,
461 	&dev_attr_in1_max.attr,
462 	&dev_attr_in2_max.attr,
463 	&dev_attr_in3_max.attr,
464 	&sensor_dev_attr_in0_alarm.dev_attr.attr,
465 	&sensor_dev_attr_in1_alarm.dev_attr.attr,
466 	&sensor_dev_attr_in2_alarm.dev_attr.attr,
467 	&sensor_dev_attr_in3_alarm.dev_attr.attr,
468 	&sensor_dev_attr_in0_beep.dev_attr.attr,
469 	&sensor_dev_attr_in1_beep.dev_attr.attr,
470 	&sensor_dev_attr_in2_beep.dev_attr.attr,
471 	&sensor_dev_attr_in3_beep.dev_attr.attr,
472 
473 	&dev_attr_fan1_auto.attr,
474 	&sensor_dev_attr_fan1_input.dev_attr.attr,
475 	&sensor_dev_attr_fan2_input.dev_attr.attr,
476 	&sensor_dev_attr_fan1_min.dev_attr.attr,
477 	&sensor_dev_attr_fan2_min.dev_attr.attr,
478 	&sensor_dev_attr_fan1_div.dev_attr.attr,
479 	&sensor_dev_attr_fan2_div.dev_attr.attr,
480 	&sensor_dev_attr_fan1_alarm.dev_attr.attr,
481 	&sensor_dev_attr_fan2_alarm.dev_attr.attr,
482 	&sensor_dev_attr_fan1_beep.dev_attr.attr,
483 	&sensor_dev_attr_fan2_beep.dev_attr.attr,
484 
485 	&dev_attr_temp1_input.attr,
486 	&dev_attr_temp1_max.attr,
487 	&dev_attr_temp1_max_hyst.attr,
488 	&sensor_dev_attr_temp1_alarm.dev_attr.attr,
489 	&sensor_dev_attr_temp1_beep.dev_attr.attr,
490 
491 	&dev_attr_alarms.attr,
492 	&dev_attr_beep_enable.attr,
493 	&dev_attr_beep_mask.attr,
494 	NULL
495 };
496 
497 static const struct attribute_group gl518_group = {
498 	.attrs = gl518_attributes,
499 };
500 
501 static struct attribute *gl518_attributes_r80[] = {
502 	&dev_attr_in0_input.attr,
503 	&dev_attr_in1_input.attr,
504 	&dev_attr_in2_input.attr,
505 	NULL
506 };
507 
508 static const struct attribute_group gl518_group_r80 = {
509 	.attrs = gl518_attributes_r80,
510 };
511 
512 /*
513  * Real code
514  */
515 
516 /* Return 0 if detection is successful, -ENODEV otherwise */
gl518_detect(struct i2c_client * client,struct i2c_board_info * info)517 static int gl518_detect(struct i2c_client *client, struct i2c_board_info *info)
518 {
519 	struct i2c_adapter *adapter = client->adapter;
520 	int rev;
521 
522 	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA |
523 				     I2C_FUNC_SMBUS_WORD_DATA))
524 		return -ENODEV;
525 
526 	/* Now, we do the remaining detection. */
527 	if ((gl518_read_value(client, GL518_REG_CHIP_ID) != 0x80)
528 	 || (gl518_read_value(client, GL518_REG_CONF) & 0x80))
529 		return -ENODEV;
530 
531 	/* Determine the chip type. */
532 	rev = gl518_read_value(client, GL518_REG_REVISION);
533 	if (rev != 0x00 && rev != 0x80)
534 		return -ENODEV;
535 
536 	strlcpy(info->type, "gl518sm", I2C_NAME_SIZE);
537 
538 	return 0;
539 }
540 
gl518_probe(struct i2c_client * client,const struct i2c_device_id * id)541 static int gl518_probe(struct i2c_client *client,
542 		       const struct i2c_device_id *id)
543 {
544 	struct gl518_data *data;
545 	int err, revision;
546 
547 	data = kzalloc(sizeof(struct gl518_data), GFP_KERNEL);
548 	if (!data) {
549 		err = -ENOMEM;
550 		goto exit;
551 	}
552 
553 	i2c_set_clientdata(client, data);
554 	revision = gl518_read_value(client, GL518_REG_REVISION);
555 	data->type = revision == 0x80 ? gl518sm_r80 : gl518sm_r00;
556 	mutex_init(&data->update_lock);
557 
558 	/* Initialize the GL518SM chip */
559 	data->alarm_mask = 0xff;
560 	gl518_init_client(client);
561 
562 	/* Register sysfs hooks */
563 	err = sysfs_create_group(&client->dev.kobj, &gl518_group);
564 	if (err)
565 		goto exit_free;
566 	if (data->type == gl518sm_r80) {
567 		err = sysfs_create_group(&client->dev.kobj, &gl518_group_r80);
568 		if (err)
569 			goto exit_remove_files;
570 	}
571 
572 	data->hwmon_dev = hwmon_device_register(&client->dev);
573 	if (IS_ERR(data->hwmon_dev)) {
574 		err = PTR_ERR(data->hwmon_dev);
575 		goto exit_remove_files;
576 	}
577 
578 	return 0;
579 
580 exit_remove_files:
581 	sysfs_remove_group(&client->dev.kobj, &gl518_group);
582 	if (data->type == gl518sm_r80)
583 		sysfs_remove_group(&client->dev.kobj, &gl518_group_r80);
584 exit_free:
585 	kfree(data);
586 exit:
587 	return err;
588 }
589 
590 
591 /*
592  * Called when we have found a new GL518SM.
593  * Note that we preserve D4:NoFan2 and D2:beep_enable.
594  */
gl518_init_client(struct i2c_client * client)595 static void gl518_init_client(struct i2c_client *client)
596 {
597 	/* Make sure we leave D7:Reset untouched */
598 	u8 regvalue = gl518_read_value(client, GL518_REG_CONF) & 0x7f;
599 
600 	/* Comparator mode (D3=0), standby mode (D6=0) */
601 	gl518_write_value(client, GL518_REG_CONF, (regvalue &= 0x37));
602 
603 	/* Never interrupts */
604 	gl518_write_value(client, GL518_REG_MASK, 0x00);
605 
606 	/* Clear status register (D5=1), start (D6=1) */
607 	gl518_write_value(client, GL518_REG_CONF, 0x20 | regvalue);
608 	gl518_write_value(client, GL518_REG_CONF, 0x40 | regvalue);
609 }
610 
gl518_remove(struct i2c_client * client)611 static int gl518_remove(struct i2c_client *client)
612 {
613 	struct gl518_data *data = i2c_get_clientdata(client);
614 
615 	hwmon_device_unregister(data->hwmon_dev);
616 	sysfs_remove_group(&client->dev.kobj, &gl518_group);
617 	if (data->type == gl518sm_r80)
618 		sysfs_remove_group(&client->dev.kobj, &gl518_group_r80);
619 
620 	kfree(data);
621 	return 0;
622 }
623 
624 /*
625  * Registers 0x07 to 0x0c are word-sized, others are byte-sized
626  * GL518 uses a high-byte first convention, which is exactly opposite to
627  * the SMBus standard.
628  */
gl518_read_value(struct i2c_client * client,u8 reg)629 static int gl518_read_value(struct i2c_client *client, u8 reg)
630 {
631 	if ((reg >= 0x07) && (reg <= 0x0c))
632 		return i2c_smbus_read_word_swapped(client, reg);
633 	else
634 		return i2c_smbus_read_byte_data(client, reg);
635 }
636 
gl518_write_value(struct i2c_client * client,u8 reg,u16 value)637 static int gl518_write_value(struct i2c_client *client, u8 reg, u16 value)
638 {
639 	if ((reg >= 0x07) && (reg <= 0x0c))
640 		return i2c_smbus_write_word_swapped(client, reg, value);
641 	else
642 		return i2c_smbus_write_byte_data(client, reg, value);
643 }
644 
gl518_update_device(struct device * dev)645 static struct gl518_data *gl518_update_device(struct device *dev)
646 {
647 	struct i2c_client *client = to_i2c_client(dev);
648 	struct gl518_data *data = i2c_get_clientdata(client);
649 	int val;
650 
651 	mutex_lock(&data->update_lock);
652 
653 	if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
654 	    || !data->valid) {
655 		dev_dbg(&client->dev, "Starting gl518 update\n");
656 
657 		data->alarms = gl518_read_value(client, GL518_REG_INT);
658 		data->beep_mask = gl518_read_value(client, GL518_REG_ALARM);
659 
660 		val = gl518_read_value(client, GL518_REG_VDD_LIMIT);
661 		data->voltage_min[0] = val & 0xff;
662 		data->voltage_max[0] = (val >> 8) & 0xff;
663 		val = gl518_read_value(client, GL518_REG_VIN1_LIMIT);
664 		data->voltage_min[1] = val & 0xff;
665 		data->voltage_max[1] = (val >> 8) & 0xff;
666 		val = gl518_read_value(client, GL518_REG_VIN2_LIMIT);
667 		data->voltage_min[2] = val & 0xff;
668 		data->voltage_max[2] = (val >> 8) & 0xff;
669 		val = gl518_read_value(client, GL518_REG_VIN3_LIMIT);
670 		data->voltage_min[3] = val & 0xff;
671 		data->voltage_max[3] = (val >> 8) & 0xff;
672 
673 		val = gl518_read_value(client, GL518_REG_FAN_COUNT);
674 		data->fan_in[0] = (val >> 8) & 0xff;
675 		data->fan_in[1] = val & 0xff;
676 
677 		val = gl518_read_value(client, GL518_REG_FAN_LIMIT);
678 		data->fan_min[0] = (val >> 8) & 0xff;
679 		data->fan_min[1] = val & 0xff;
680 
681 		data->temp_in = gl518_read_value(client, GL518_REG_TEMP_IN);
682 		data->temp_max =
683 		    gl518_read_value(client, GL518_REG_TEMP_MAX);
684 		data->temp_hyst =
685 		    gl518_read_value(client, GL518_REG_TEMP_HYST);
686 
687 		val = gl518_read_value(client, GL518_REG_MISC);
688 		data->fan_div[0] = (val >> 6) & 0x03;
689 		data->fan_div[1] = (val >> 4) & 0x03;
690 		data->fan_auto1  = (val >> 3) & 0x01;
691 
692 		data->alarms &= data->alarm_mask;
693 
694 		val = gl518_read_value(client, GL518_REG_CONF);
695 		data->beep_enable = (val >> 2) & 1;
696 
697 		if (data->type != gl518sm_r00) {
698 			data->voltage_in[0] =
699 			    gl518_read_value(client, GL518_REG_VDD);
700 			data->voltage_in[1] =
701 			    gl518_read_value(client, GL518_REG_VIN1);
702 			data->voltage_in[2] =
703 			    gl518_read_value(client, GL518_REG_VIN2);
704 		}
705 		data->voltage_in[3] =
706 		    gl518_read_value(client, GL518_REG_VIN3);
707 
708 		data->last_updated = jiffies;
709 		data->valid = 1;
710 	}
711 
712 	mutex_unlock(&data->update_lock);
713 
714 	return data;
715 }
716 
717 module_i2c_driver(gl518_driver);
718 
719 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>, "
720 	"Kyosti Malkki <kmalkki@cc.hut.fi> and "
721 	"Hong-Gunn Chew <hglinux@gunnet.org>");
722 MODULE_DESCRIPTION("GL518SM driver");
723 MODULE_LICENSE("GPL");
724