xref: /linux/drivers/hwmon/lm63.c (revision d7f7e577c83795cd8480ee468fbe5a34948d0293)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * lm63.c - driver for the National Semiconductor LM63 temperature sensor
4  *          with integrated fan control
5  * Copyright (C) 2004-2008  Jean Delvare <jdelvare@suse.de>
6  * Based on the lm90 driver.
7  *
8  * The LM63 is a sensor chip made by National Semiconductor. It measures
9  * two temperatures (its own and one external one) and the speed of one
10  * fan, those speed it can additionally control. Complete datasheet can be
11  * obtained from National's website at:
12  *   http://www.national.com/pf/LM/LM63.html
13  *
14  * The LM63 is basically an LM86 with fan speed monitoring and control
15  * capabilities added. It misses some of the LM86 features though:
16  *  - No low limit for local temperature.
17  *  - No critical limit for local temperature.
18  *  - Critical limit for remote temperature can be changed only once. We
19  *    will consider that the critical limit is read-only.
20  *
21  * The datasheet isn't very clear about what the tachometer reading is.
22  * I had a explanation from National Semiconductor though. The two lower
23  * bits of the read value have to be masked out. The value is still 16 bit
24  * in width.
25  */
26 
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/slab.h>
30 #include <linux/jiffies.h>
31 #include <linux/i2c.h>
32 #include <linux/hwmon-sysfs.h>
33 #include <linux/hwmon.h>
34 #include <linux/err.h>
35 #include <linux/mutex.h>
36 #include <linux/of.h>
37 #include <linux/sysfs.h>
38 #include <linux/thermal.h>
39 #include <linux/types.h>
40 
41 /*
42  * Addresses to scan
43  * Address is fully defined internally and cannot be changed except for
44  * LM64 which has one pin dedicated to address selection.
45  * LM63, LM96163, and CTF2301 have address 0x4c.
46  * LM64 can have address 0x18 or 0x4e.
47  */
48 
49 static const unsigned short normal_i2c[] = { 0x18, 0x4c, 0x4e, I2C_CLIENT_END };
50 
51 /*
52  * The LM63 registers
53  */
54 
55 #define LM63_REG_CONFIG1		0x03
56 #define LM63_REG_CONVRATE		0x04
57 #define LM63_REG_CONFIG2		0xBF
58 #define LM63_REG_CONFIG_FAN		0x4A
59 
60 #define LM63_REG_TACH_COUNT_MSB		0x47
61 #define LM63_REG_TACH_COUNT_LSB		0x46
62 #define LM63_REG_TACH_LIMIT_MSB		0x49
63 #define LM63_REG_TACH_LIMIT_LSB		0x48
64 
65 #define LM63_REG_PWM_VALUE		0x4C
66 #define LM63_REG_PWM_FREQ		0x4D
67 #define LM63_REG_LUT_TEMP_HYST		0x4F
68 #define LM63_REG_LUT_TEMP(nr)		(0x50 + 2 * (nr))
69 #define LM63_REG_LUT_PWM(nr)		(0x51 + 2 * (nr))
70 
71 #define LM63_REG_LOCAL_TEMP		0x00
72 #define LM63_REG_LOCAL_HIGH		0x05
73 
74 #define CTF2301_REG_LOCAL_TEMP_LSB	0x15
75 #define CTF2301_REG_LOCAL_HIGH_LSB	0x06
76 
77 #define LM63_REG_REMOTE_TEMP_MSB	0x01
78 #define LM63_REG_REMOTE_TEMP_LSB	0x10
79 #define LM63_REG_REMOTE_OFFSET_MSB	0x11
80 #define LM63_REG_REMOTE_OFFSET_LSB	0x12
81 #define LM63_REG_REMOTE_HIGH_MSB	0x07
82 #define LM63_REG_REMOTE_HIGH_LSB	0x13
83 #define LM63_REG_REMOTE_LOW_MSB		0x08
84 #define LM63_REG_REMOTE_LOW_LSB		0x14
85 #define LM63_REG_REMOTE_TCRIT		0x19
86 #define LM63_REG_REMOTE_TCRIT_HYST	0x21
87 
88 #define LM63_REG_ALERT_STATUS		0x02
89 #define LM63_REG_ALERT_MASK		0x16
90 
91 #define LM63_REG_MAN_ID			0xFE
92 #define LM63_REG_CHIP_ID		0xFF
93 
94 #define LM96163_REG_TRUTHERM		0x30
95 #define LM96163_REG_REMOTE_TEMP_U_MSB	0x31
96 #define LM96163_REG_REMOTE_TEMP_U_LSB	0x32
97 #define LM96163_REG_CONFIG_ENHANCED	0x45
98 
99 #define LM63_PWM_BASE_FAST_HZ		180000
100 #define LM63_PWM_BASE_SLOW_HZ		700
101 #define LM63_MAX_PWM			255
102 
103 #define LM63_MAX_CONVRATE		9
104 
105 #define LM63_MAX_CONVRATE_HZ		32
106 #define LM96163_MAX_CONVRATE_HZ		26
107 
108 /*
109  * Conversions and various macros
110  * For tachometer counts, the LM63 uses 16-bit values.
111  * For local temperature and high limit, remote critical limit and hysteresis
112  * value, it uses signed 8-bit values with LSB = 1 degree Celsius.
113  * For remote temperature, low and high limits, it uses signed 11-bit values
114  * with LSB = 0.125 degree Celsius, left-justified in 16-bit registers.
115  * For LM64 the actual remote diode temperature is 16 degree Celsius higher
116  * than the register reading. Remote temperature setpoints have to be
117  * adapted accordingly.
118  */
119 
120 #define FAN_FROM_REG(reg)	((reg) == 0xFFFC || (reg) == 0 ? 0 : \
121 				 5400000 / (reg))
122 #define FAN_TO_REG(val)		((val) <= 82 ? 0xFFFC : \
123 				 (5400000 / (val)) & 0xFFFC)
124 #define TEMP8_FROM_REG(reg)	((reg) * 1000)
125 #define TEMP8_TO_REG(val)	DIV_ROUND_CLOSEST(clamp_val((val), -128000, \
126 							    127000), 1000)
127 #define TEMP8U_TO_REG(val)	DIV_ROUND_CLOSEST(clamp_val((val), 0, \
128 							    255000), 1000)
129 #define TEMP12_FROM_REG(reg)	DIV_ROUND_CLOSEST((s16)(reg) * 1000, 256)
130 #define TEMP12_TO_REG(val)	(DIV_ROUND_CLOSEST(clamp_val((val), -128000, \
131 							     127937) * 16, 1000) * 16)
132 #define TEMP11_FROM_REG(reg)	((reg) / 32 * 125)
133 #define TEMP11_TO_REG(val)	(DIV_ROUND_CLOSEST(clamp_val((val), -128000, \
134 							     127875), 125) * 32)
135 #define TEMP11U_TO_REG(val)	(DIV_ROUND_CLOSEST(clamp_val((val), 0, \
136 							     255875), 125) * 32)
137 #define HYST_TO_REG(val)	DIV_ROUND_CLOSEST(clamp_val((val), 0, 127000), \
138 						  1000)
139 
140 #define UPDATE_INTERVAL(max, rate) \
141 			((1000 << (LM63_MAX_CONVRATE - (rate))) / (max))
142 
143 enum chips { ctf2301, lm63, lm64, lm96163 };
144 
145 static const unsigned int ctf2301_update_intervals[] = {
146 	20000, 10000, 4902, 2463, 1000, 615, 307, 154, 107
147 };
148 
149 /*
150  * Client data (each client gets its own)
151  */
152 
153 struct lm63_data {
154 	struct i2c_client *client;
155 	struct mutex update_lock;
156 	const struct attribute_group *groups[5];
157 	bool valid; /* false until following fields are valid */
158 	char lut_valid; /* zero until lut fields are valid */
159 	unsigned long last_updated; /* in jiffies */
160 	unsigned long lut_last_updated; /* in jiffies */
161 	enum chips kind;
162 	int temp2_offset;
163 
164 	int update_interval;	/* in milliseconds */
165 	int max_convrate_hz;
166 	int lut_size;		/* 8 or 12 */
167 
168 	/* registers values */
169 	u8 config, config_fan;
170 	u16 fan[2];	/* 0: input
171 			   1: low limit */
172 	u8 pwm1_freq;
173 	u8 pwm1[13];	/* 0: current output
174 			   1-12: lookup table */
175 	s8 temp8[15];	/* 0: local input
176 			   1: local high limit
177 			   2: remote critical limit
178 			   3-14: lookup table */
179 	s16 temp1_input; /* local input for chips with extended resolution */
180 	s16 temp1_max; /* local limit for chips with extended resolution */
181 	s16 temp11[4];	/* 0: remote input
182 			   1: remote low limit
183 			   2: remote high limit
184 			   3: remote offset */
185 	u16 temp11u;	/* remote input (unsigned) */
186 	u8 temp2_crit_hyst;
187 	u8 lut_temp_hyst;
188 	u8 alarms;
189 	bool pwm_highres;
190 	bool lut_temp_highres;
191 	bool remote_unsigned; /* true if unsigned remote upper limits */
192 	bool trutherm;
193 };
194 
195 static inline int temp8_from_reg(struct lm63_data *data, int nr)
196 {
197 	if (data->remote_unsigned)
198 		return TEMP8_FROM_REG((u8)data->temp8[nr]);
199 	return TEMP8_FROM_REG(data->temp8[nr]);
200 }
201 
202 static inline int lut_temp_from_reg(struct lm63_data *data, int nr)
203 {
204 	return data->temp8[nr] * (data->lut_temp_highres ? 500 : 1000);
205 }
206 
207 static inline int lut_temp_to_reg(struct lm63_data *data, long val)
208 {
209 	val -= data->temp2_offset;
210 	if (data->lut_temp_highres)
211 		return DIV_ROUND_CLOSEST(clamp_val(val, 0, 127500), 500);
212 	else
213 		return DIV_ROUND_CLOSEST(clamp_val(val, 0, 127000), 1000);
214 }
215 
216 /*
217  * Update the lookup table register cache.
218  * client->update_lock must be held when calling this function.
219  */
220 static void lm63_update_lut(struct lm63_data *data)
221 {
222 	struct i2c_client *client = data->client;
223 	int i;
224 
225 	if (time_after(jiffies, data->lut_last_updated + 5 * HZ) ||
226 	    !data->lut_valid) {
227 		for (i = 0; i < data->lut_size; i++) {
228 			data->pwm1[1 + i] = i2c_smbus_read_byte_data(client,
229 					    LM63_REG_LUT_PWM(i));
230 			data->temp8[3 + i] = i2c_smbus_read_byte_data(client,
231 					     LM63_REG_LUT_TEMP(i));
232 		}
233 		data->lut_temp_hyst = i2c_smbus_read_byte_data(client,
234 				      LM63_REG_LUT_TEMP_HYST);
235 
236 		data->lut_last_updated = jiffies;
237 		data->lut_valid = 1;
238 	}
239 }
240 
241 static struct lm63_data *lm63_update_device(struct device *dev)
242 {
243 	struct lm63_data *data = dev_get_drvdata(dev);
244 	struct i2c_client *client = data->client;
245 	unsigned long next_update;
246 	int msb, lsb;
247 
248 	mutex_lock(&data->update_lock);
249 
250 	next_update = data->last_updated +
251 		      msecs_to_jiffies(data->update_interval);
252 	if (time_after(jiffies, next_update) || !data->valid) {
253 		if (data->config & 0x04) { /* tachometer enabled  */
254 			/* order matters for fan1_input */
255 			data->fan[0] = i2c_smbus_read_byte_data(client,
256 				       LM63_REG_TACH_COUNT_LSB) & 0xFC;
257 			data->fan[0] |= i2c_smbus_read_byte_data(client,
258 					LM63_REG_TACH_COUNT_MSB) << 8;
259 			data->fan[1] = (i2c_smbus_read_byte_data(client,
260 					LM63_REG_TACH_LIMIT_LSB) & 0xFC)
261 				     | (i2c_smbus_read_byte_data(client,
262 					LM63_REG_TACH_LIMIT_MSB) << 8);
263 		}
264 
265 		data->pwm1_freq = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ) & 0x1f;
266 		if (data->pwm1_freq == 0)
267 			data->pwm1_freq = 1;
268 		data->pwm1[0] = i2c_smbus_read_byte_data(client,
269 				LM63_REG_PWM_VALUE);
270 
271 		if (data->kind == ctf2301) {
272 			msb = i2c_smbus_read_byte_data(client,
273 						       LM63_REG_LOCAL_TEMP);
274 			lsb = i2c_smbus_read_byte_data(client,
275 						       CTF2301_REG_LOCAL_TEMP_LSB);
276 			if (msb >= 0 && lsb >= 0)
277 				data->temp1_input = ((u16)(u8)msb << 8) | lsb;
278 
279 			msb = i2c_smbus_read_byte_data(client,
280 						       LM63_REG_LOCAL_HIGH);
281 			lsb = i2c_smbus_read_byte_data(client,
282 						       CTF2301_REG_LOCAL_HIGH_LSB);
283 			if (msb >= 0 && lsb >= 0)
284 				data->temp1_max = ((u16)(u8)msb << 8) | lsb;
285 		} else {
286 			data->temp8[0] = i2c_smbus_read_byte_data(client,
287 								  LM63_REG_LOCAL_TEMP);
288 			data->temp8[1] = i2c_smbus_read_byte_data(client,
289 								  LM63_REG_LOCAL_HIGH);
290 		}
291 
292 		/* order matters for temp2_input */
293 		data->temp11[0] = i2c_smbus_read_byte_data(client,
294 				  LM63_REG_REMOTE_TEMP_MSB) << 8;
295 		data->temp11[0] |= i2c_smbus_read_byte_data(client,
296 				   LM63_REG_REMOTE_TEMP_LSB);
297 		data->temp11[1] = (i2c_smbus_read_byte_data(client,
298 				  LM63_REG_REMOTE_LOW_MSB) << 8)
299 				| i2c_smbus_read_byte_data(client,
300 				  LM63_REG_REMOTE_LOW_LSB);
301 		data->temp11[2] = (i2c_smbus_read_byte_data(client,
302 				  LM63_REG_REMOTE_HIGH_MSB) << 8)
303 				| i2c_smbus_read_byte_data(client,
304 				  LM63_REG_REMOTE_HIGH_LSB);
305 		data->temp11[3] = (i2c_smbus_read_byte_data(client,
306 				  LM63_REG_REMOTE_OFFSET_MSB) << 8)
307 				| i2c_smbus_read_byte_data(client,
308 				  LM63_REG_REMOTE_OFFSET_LSB);
309 
310 		if (data->kind == lm96163 || data->kind == ctf2301)
311 			data->temp11u = (i2c_smbus_read_byte_data(client,
312 					LM96163_REG_REMOTE_TEMP_U_MSB) << 8)
313 				      | i2c_smbus_read_byte_data(client,
314 					LM96163_REG_REMOTE_TEMP_U_LSB);
315 
316 		data->temp8[2] = i2c_smbus_read_byte_data(client,
317 				 LM63_REG_REMOTE_TCRIT);
318 		data->temp2_crit_hyst = i2c_smbus_read_byte_data(client,
319 					LM63_REG_REMOTE_TCRIT_HYST);
320 
321 		data->alarms = i2c_smbus_read_byte_data(client,
322 			       LM63_REG_ALERT_STATUS) & 0x7F;
323 
324 		data->last_updated = jiffies;
325 		data->valid = true;
326 	}
327 
328 	lm63_update_lut(data);
329 
330 	mutex_unlock(&data->update_lock);
331 
332 	return data;
333 }
334 
335 /*
336  * Trip points in the lookup table should be in ascending order for both
337  * temperatures and PWM output values.
338  */
339 static int lm63_lut_looks_bad(struct device *dev, struct lm63_data *data)
340 {
341 	int i;
342 
343 	mutex_lock(&data->update_lock);
344 	lm63_update_lut(data);
345 
346 	for (i = 1; i < data->lut_size; i++) {
347 		if (data->pwm1[1 + i - 1] > data->pwm1[1 + i]
348 		 || data->temp8[3 + i - 1] > data->temp8[3 + i]) {
349 			dev_warn(dev,
350 				 "Lookup table doesn't look sane (check entries %d and %d)\n",
351 				 i, i + 1);
352 			break;
353 		}
354 	}
355 	mutex_unlock(&data->update_lock);
356 
357 	return i == data->lut_size ? 0 : 1;
358 }
359 
360 /*
361  * Sysfs callback functions and files
362  */
363 
364 static ssize_t show_fan(struct device *dev, struct device_attribute *devattr,
365 			char *buf)
366 {
367 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
368 	struct lm63_data *data = lm63_update_device(dev);
369 	int fan;
370 
371 	mutex_lock(&data->update_lock);
372 	fan = FAN_FROM_REG(data->fan[attr->index]);
373 	mutex_unlock(&data->update_lock);
374 
375 	return sprintf(buf, "%d\n", fan);
376 }
377 
378 static ssize_t set_fan(struct device *dev, struct device_attribute *dummy,
379 		       const char *buf, size_t count)
380 {
381 	struct lm63_data *data = dev_get_drvdata(dev);
382 	struct i2c_client *client = data->client;
383 	unsigned long val;
384 	int err;
385 
386 	err = kstrtoul(buf, 10, &val);
387 	if (err)
388 		return err;
389 
390 	mutex_lock(&data->update_lock);
391 	data->fan[1] = FAN_TO_REG(val);
392 	i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_LSB,
393 				  data->fan[1] & 0xFF);
394 	i2c_smbus_write_byte_data(client, LM63_REG_TACH_LIMIT_MSB,
395 				  data->fan[1] >> 8);
396 	mutex_unlock(&data->update_lock);
397 	return count;
398 }
399 
400 static int lm63_pwm_from_reg(struct lm63_data *data, u8 reg)
401 {
402 	if (data->pwm_highres)
403 		return reg;
404 
405 	return reg >= 2 * data->pwm1_freq ?
406 	       LM63_MAX_PWM :
407 	       (reg * LM63_MAX_PWM + data->pwm1_freq) / (2 * data->pwm1_freq);
408 }
409 
410 static u8 lm63_pwm_to_reg(struct lm63_data *data, unsigned long val)
411 {
412 	val = clamp_val(val, 0, LM63_MAX_PWM);
413 
414 	if (data->pwm_highres)
415 		return val;
416 
417 	return (val * data->pwm1_freq * 2 + LM63_MAX_PWM / 2) / LM63_MAX_PWM;
418 }
419 
420 static void lm63_update_pwm_highres(struct lm63_data *data,
421 				    int config_enhanced)
422 {
423 	data->pwm_highres = !(data->config_fan & 0x08) &&
424 			     data->pwm1_freq == 8 &&
425 			     (config_enhanced & 0x10);
426 }
427 
428 static int lm63_write_pwm(struct lm63_data *data, int nr, unsigned long val)
429 {
430 	struct i2c_client *client = data->client;
431 	u8 reg = nr ? LM63_REG_LUT_PWM(nr - 1) : LM63_REG_PWM_VALUE;
432 	u8 regval = lm63_pwm_to_reg(data, val);
433 	int ret;
434 
435 	ret = i2c_smbus_write_byte_data(client, reg, regval);
436 	if (ret)
437 		return ret;
438 	data->pwm1[nr] = regval;
439 
440 	return 0;
441 }
442 
443 static ssize_t show_pwm1(struct device *dev, struct device_attribute *devattr,
444 			 char *buf)
445 {
446 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
447 	struct lm63_data *data = lm63_update_device(dev);
448 	int nr = attr->index;
449 	int pwm;
450 
451 	mutex_lock(&data->update_lock);
452 	pwm = lm63_pwm_from_reg(data, data->pwm1[nr]);
453 	mutex_unlock(&data->update_lock);
454 
455 	return sprintf(buf, "%d\n", pwm);
456 }
457 
458 static ssize_t set_pwm1(struct device *dev, struct device_attribute *devattr,
459 			const char *buf, size_t count)
460 {
461 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
462 	struct lm63_data *data = dev_get_drvdata(dev);
463 	int nr = attr->index;
464 	unsigned long val;
465 	int err;
466 
467 	if (!(data->config_fan & 0x20)) /* register is read-only */
468 		return -EPERM;
469 
470 	err = kstrtoul(buf, 10, &val);
471 	if (err)
472 		return err;
473 
474 	mutex_lock(&data->update_lock);
475 	err = lm63_write_pwm(data, nr, val);
476 	mutex_unlock(&data->update_lock);
477 
478 	return err ? err : count;
479 }
480 
481 static ssize_t pwm1_enable_show(struct device *dev,
482 				struct device_attribute *dummy, char *buf)
483 {
484 	struct lm63_data *data = lm63_update_device(dev);
485 	return sprintf(buf, "%d\n", data->config_fan & 0x20 ? 1 : 2);
486 }
487 
488 static ssize_t pwm1_enable_store(struct device *dev,
489 				 struct device_attribute *dummy,
490 				 const char *buf, size_t count)
491 {
492 	struct lm63_data *data = dev_get_drvdata(dev);
493 	struct i2c_client *client = data->client;
494 	unsigned long val;
495 	int err;
496 
497 	err = kstrtoul(buf, 10, &val);
498 	if (err)
499 		return err;
500 	if (val < 1 || val > 2)
501 		return -EINVAL;
502 
503 	/*
504 	 * Only let the user switch to automatic mode if the lookup table
505 	 * looks sane.
506 	 */
507 	if (val == 2 && lm63_lut_looks_bad(dev, data))
508 		return -EPERM;
509 
510 	mutex_lock(&data->update_lock);
511 	data->config_fan = i2c_smbus_read_byte_data(client,
512 						    LM63_REG_CONFIG_FAN);
513 	if (val == 1)
514 		data->config_fan |= 0x20;
515 	else
516 		data->config_fan &= ~0x20;
517 	i2c_smbus_write_byte_data(client, LM63_REG_CONFIG_FAN,
518 				  data->config_fan);
519 	mutex_unlock(&data->update_lock);
520 	return count;
521 }
522 
523 static ssize_t pwm1_freq_show(struct device *dev,
524 			      struct device_attribute *dummy, char *buf)
525 {
526 	struct lm63_data *data = lm63_update_device(dev);
527 	unsigned int base, freq;
528 
529 	mutex_lock(&data->update_lock);
530 	base = (data->config_fan & 0x08) ?
531 	       LM63_PWM_BASE_SLOW_HZ : LM63_PWM_BASE_FAST_HZ;
532 	freq = data->pwm1_freq;
533 	mutex_unlock(&data->update_lock);
534 
535 	return sprintf(buf, "%u\n", base / freq);
536 }
537 
538 /*
539  * Pick the closest CONFIG_FAN.SCS + PFR for the requested frequency.
540  * PWM_FREQ writes need the LUT unlocked, same as set_pwm1(). LUT PWM
541  * bytes are register-relative; rewrite them after a frequency change
542  * if duty cycles must be preserved.
543  */
544 static ssize_t pwm1_freq_store(struct device *dev,
545 			       struct device_attribute *dummy,
546 			       const char *buf, size_t count)
547 {
548 	struct lm63_data *data = dev_get_drvdata(dev);
549 	struct i2c_client *client = data->client;
550 	unsigned long val, pfr_fast, pfr_slow, err_fast, err_slow, pfr;
551 	u8 config_fan;
552 	bool slow_clock;
553 	int config_enhanced = 0;
554 	int ret;
555 
556 	ret = kstrtoul(buf, 10, &val);
557 	if (ret)
558 		return ret;
559 	if (val == 0)
560 		return -EINVAL;
561 
562 	pfr_fast = clamp_val(DIV_ROUND_CLOSEST((unsigned long)LM63_PWM_BASE_FAST_HZ, val),
563 			     1UL, 31UL);
564 	pfr_slow = clamp_val(DIV_ROUND_CLOSEST((unsigned long)LM63_PWM_BASE_SLOW_HZ, val),
565 			     1UL, 31UL);
566 	err_fast = abs_diff(LM63_PWM_BASE_FAST_HZ / pfr_fast, val);
567 	err_slow = abs_diff(LM63_PWM_BASE_SLOW_HZ / pfr_slow, val);
568 
569 	if (err_slow < err_fast) {
570 		slow_clock = true;
571 		pfr = pfr_slow;
572 	} else {
573 		slow_clock = false;
574 		pfr = pfr_fast;
575 	}
576 
577 	mutex_lock(&data->update_lock);
578 	ret = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG_FAN);
579 	if (ret < 0)
580 		goto unlock;
581 	config_fan = ret;
582 	data->config_fan = config_fan;
583 
584 	if (!(config_fan & 0x20)) { /* register is read-only */
585 		ret = -EPERM;
586 		goto unlock;
587 	}
588 
589 	if (data->kind == lm96163 || data->kind == ctf2301) {
590 		ret = i2c_smbus_read_byte_data(client,
591 					       LM96163_REG_CONFIG_ENHANCED);
592 		if (ret < 0)
593 			goto unlock;
594 		config_enhanced = ret;
595 		lm63_update_pwm_highres(data, config_enhanced);
596 
597 		if (data->kind == ctf2301) {
598 			if (!slow_clock && pfr == 8)
599 				config_enhanced |= 0x10;
600 			else
601 				config_enhanced &= ~0x10;
602 			ret = i2c_smbus_write_byte_data(client,
603 							LM96163_REG_CONFIG_ENHANCED,
604 							config_enhanced);
605 			if (ret)
606 				goto unlock;
607 			lm63_update_pwm_highres(data, config_enhanced);
608 		}
609 	}
610 
611 	if (slow_clock)
612 		config_fan |= 0x08;
613 	else
614 		config_fan &= ~0x08;
615 	ret = i2c_smbus_write_byte_data(client, LM63_REG_PWM_FREQ, pfr);
616 	if (ret)
617 		goto unlock;
618 	data->pwm1_freq = pfr;
619 	lm63_update_pwm_highres(data, config_enhanced);
620 	ret = i2c_smbus_write_byte_data(client, LM63_REG_CONFIG_FAN,
621 					config_fan);
622 	if (ret)
623 		goto unlock;
624 
625 	data->config_fan = config_fan;
626 	lm63_update_pwm_highres(data, config_enhanced);
627 unlock:
628 	mutex_unlock(&data->update_lock);
629 
630 	return ret ? ret : count;
631 }
632 
633 /*
634  * There are 8bit registers for both local(temp1) and remote(temp2) sensor.
635  * For remote sensor registers temp2_offset has to be considered,
636  * for local sensor it must not.
637  * So we need separate 8bit accessors for local and remote sensor.
638  */
639 static ssize_t show_local_temp8(struct device *dev,
640 				struct device_attribute *devattr,
641 				char *buf)
642 {
643 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
644 	struct lm63_data *data = lm63_update_device(dev);
645 	int temp;
646 
647 	mutex_lock(&data->update_lock);
648 	if (data->kind == ctf2301)
649 		temp = TEMP12_FROM_REG(attr->index ? data->temp1_max :
650 				       data->temp1_input);
651 	else
652 		temp = TEMP8_FROM_REG(data->temp8[attr->index]);
653 	mutex_unlock(&data->update_lock);
654 
655 	return sprintf(buf, "%d\n", temp);
656 }
657 
658 static ssize_t show_remote_temp8(struct device *dev,
659 				 struct device_attribute *devattr,
660 				 char *buf)
661 {
662 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
663 	struct lm63_data *data = lm63_update_device(dev);
664 	return sprintf(buf, "%d\n", temp8_from_reg(data, attr->index)
665 		       + data->temp2_offset);
666 }
667 
668 static ssize_t show_lut_temp(struct device *dev,
669 			      struct device_attribute *devattr,
670 			      char *buf)
671 {
672 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
673 	struct lm63_data *data = lm63_update_device(dev);
674 	return sprintf(buf, "%d\n", lut_temp_from_reg(data, attr->index)
675 		       + data->temp2_offset);
676 }
677 
678 static ssize_t set_temp8(struct device *dev, struct device_attribute *devattr,
679 			 const char *buf, size_t count)
680 {
681 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
682 	struct lm63_data *data = dev_get_drvdata(dev);
683 	struct i2c_client *client = data->client;
684 	int nr = attr->index;
685 	long val;
686 	int err;
687 	int temp;
688 	u8 reg;
689 
690 	err = kstrtol(buf, 10, &val);
691 	if (err)
692 		return err;
693 
694 	mutex_lock(&data->update_lock);
695 	if (data->kind == ctf2301 && nr == 1) {
696 		temp = TEMP12_TO_REG(val);
697 		err = i2c_smbus_write_byte_data(client, LM63_REG_LOCAL_HIGH,
698 						temp >> 8);
699 		if (!err)
700 			err = i2c_smbus_write_byte_data(client,
701 							CTF2301_REG_LOCAL_HIGH_LSB,
702 							temp & 0xf0);
703 		if (!err)
704 			data->temp1_max = temp;
705 		mutex_unlock(&data->update_lock);
706 
707 		return err ? err : count;
708 	}
709 
710 	switch (nr) {
711 	case 2:
712 		reg = LM63_REG_REMOTE_TCRIT;
713 		if (data->remote_unsigned)
714 			temp = TEMP8U_TO_REG(val - data->temp2_offset);
715 		else
716 			temp = TEMP8_TO_REG(val - data->temp2_offset);
717 		break;
718 	case 1:
719 		reg = LM63_REG_LOCAL_HIGH;
720 		temp = TEMP8_TO_REG(val);
721 		break;
722 	default:	/* lookup table */
723 		reg = LM63_REG_LUT_TEMP(nr - 3);
724 		temp = lut_temp_to_reg(data, val);
725 	}
726 	err = i2c_smbus_write_byte_data(client, reg, temp);
727 	if (!err)
728 		data->temp8[nr] = temp;
729 	mutex_unlock(&data->update_lock);
730 
731 	return err ? err : count;
732 }
733 
734 static ssize_t show_temp11(struct device *dev, struct device_attribute *devattr,
735 			   char *buf)
736 {
737 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
738 	struct lm63_data *data = lm63_update_device(dev);
739 	int nr = attr->index;
740 	int temp;
741 
742 	mutex_lock(&data->update_lock);
743 	if (!nr) {
744 		/*
745 		 * Use unsigned temperature unless its value is zero.
746 		 * If it is zero, use signed temperature.
747 		 */
748 		if (data->temp11u)
749 			temp = TEMP11_FROM_REG(data->temp11u);
750 		else
751 			temp = TEMP11_FROM_REG(data->temp11[nr]);
752 	} else {
753 		if (data->remote_unsigned && nr == 2)
754 			temp = TEMP11_FROM_REG((u16)data->temp11[nr]);
755 		else
756 			temp = TEMP11_FROM_REG(data->temp11[nr]);
757 	}
758 	temp += data->temp2_offset;
759 	mutex_unlock(&data->update_lock);
760 
761 	return sprintf(buf, "%d\n", temp);
762 }
763 
764 static ssize_t set_temp11(struct device *dev, struct device_attribute *devattr,
765 			  const char *buf, size_t count)
766 {
767 	static const u8 reg[6] = {
768 		LM63_REG_REMOTE_LOW_MSB,
769 		LM63_REG_REMOTE_LOW_LSB,
770 		LM63_REG_REMOTE_HIGH_MSB,
771 		LM63_REG_REMOTE_HIGH_LSB,
772 		LM63_REG_REMOTE_OFFSET_MSB,
773 		LM63_REG_REMOTE_OFFSET_LSB,
774 	};
775 
776 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
777 	struct lm63_data *data = dev_get_drvdata(dev);
778 	struct i2c_client *client = data->client;
779 	long val;
780 	int err;
781 	int nr = attr->index;
782 
783 	err = kstrtol(buf, 10, &val);
784 	if (err)
785 		return err;
786 
787 	mutex_lock(&data->update_lock);
788 	if (data->remote_unsigned && nr == 2)
789 		data->temp11[nr] = TEMP11U_TO_REG(val - data->temp2_offset);
790 	else
791 		data->temp11[nr] = TEMP11_TO_REG(val - data->temp2_offset);
792 
793 	i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2],
794 				  data->temp11[nr] >> 8);
795 	i2c_smbus_write_byte_data(client, reg[(nr - 1) * 2 + 1],
796 				  data->temp11[nr] & 0xff);
797 	mutex_unlock(&data->update_lock);
798 	return count;
799 }
800 
801 /*
802  * Hysteresis register holds a relative value, while we want to present
803  * an absolute to user-space
804  */
805 static ssize_t temp2_crit_hyst_show(struct device *dev,
806 				    struct device_attribute *dummy, char *buf)
807 {
808 	struct lm63_data *data = lm63_update_device(dev);
809 	int temp;
810 
811 	mutex_lock(&data->update_lock);
812 	temp = temp8_from_reg(data, 2) + data->temp2_offset
813 	     - TEMP8_FROM_REG(data->temp2_crit_hyst);
814 	mutex_unlock(&data->update_lock);
815 
816 	return sprintf(buf, "%d\n", temp);
817 }
818 
819 static ssize_t show_lut_temp_hyst(struct device *dev,
820 				  struct device_attribute *devattr, char *buf)
821 {
822 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
823 	struct lm63_data *data = lm63_update_device(dev);
824 	int temp;
825 
826 	mutex_lock(&data->update_lock);
827 	temp = lut_temp_from_reg(data, attr->index) + data->temp2_offset
828 	     - TEMP8_FROM_REG(data->lut_temp_hyst);
829 	mutex_unlock(&data->update_lock);
830 
831 	return sprintf(buf, "%d\n", temp);
832 }
833 
834 /*
835  * The LM63 has a single hysteresis register shared by all LUT entries.
836  * Expose it as a chip-wide hysteresis amount in millidegrees; the
837  * per-point pwm1_auto_pointN_temp_hyst attributes remain read-only and
838  * show the resulting absolute trip-down temperature for each entry.
839  */
840 static ssize_t pwm1_auto_point_temp_hyst_show(struct device *dev,
841 					      struct device_attribute *dummy,
842 					      char *buf)
843 {
844 	struct lm63_data *data = lm63_update_device(dev);
845 	u8 hyst;
846 
847 	mutex_lock(&data->update_lock);
848 	hyst = data->lut_temp_hyst;
849 	mutex_unlock(&data->update_lock);
850 
851 	return sprintf(buf, "%d\n", TEMP8_FROM_REG(hyst));
852 }
853 
854 static ssize_t pwm1_auto_point_temp_hyst_store(struct device *dev,
855 					       struct device_attribute *dummy,
856 					       const char *buf, size_t count)
857 {
858 	struct lm63_data *data = dev_get_drvdata(dev);
859 	struct i2c_client *client = data->client;
860 	unsigned long val;
861 	int err;
862 
863 	err = kstrtoul(buf, 10, &val);
864 	if (err)
865 		return err;
866 
867 	mutex_lock(&data->update_lock);
868 	data->lut_temp_hyst = HYST_TO_REG(val);
869 	i2c_smbus_write_byte_data(client, LM63_REG_LUT_TEMP_HYST,
870 				  data->lut_temp_hyst);
871 	mutex_unlock(&data->update_lock);
872 	return count;
873 }
874 
875 /*
876  * And now the other way around, user-space provides an absolute
877  * hysteresis value and we have to store a relative one
878  */
879 static ssize_t temp2_crit_hyst_store(struct device *dev,
880 				     struct device_attribute *dummy,
881 				     const char *buf, size_t count)
882 {
883 	struct lm63_data *data = lm63_update_device(dev);
884 	struct i2c_client *client = data->client;
885 	long val;
886 	int err;
887 	long hyst;
888 
889 	err = kstrtol(buf, 10, &val);
890 	if (err)
891 		return err;
892 
893 	mutex_lock(&data->update_lock);
894 	hyst = temp8_from_reg(data, 2) + data->temp2_offset - val;
895 	i2c_smbus_write_byte_data(client, LM63_REG_REMOTE_TCRIT_HYST,
896 				  HYST_TO_REG(hyst));
897 	mutex_unlock(&data->update_lock);
898 	return count;
899 }
900 
901 /*
902  * Set conversion rate.
903  * client->update_lock must be held when calling this function.
904  */
905 static unsigned int lm63_update_interval(struct lm63_data *data, u8 rate)
906 {
907 	if (data->kind == ctf2301)
908 		return ctf2301_update_intervals[min_t(unsigned int, rate,
909 					ARRAY_SIZE(ctf2301_update_intervals) - 1)];
910 
911 	return UPDATE_INTERVAL(data->max_convrate_hz, rate);
912 }
913 
914 static int lm63_set_convrate(struct lm63_data *data, unsigned int interval)
915 {
916 	struct i2c_client *client = data->client;
917 	unsigned int update_interval, error, best_error = ~0U;
918 	unsigned int best = 0;
919 	unsigned int i;
920 	int ret;
921 
922 	if (data->kind == ctf2301) {
923 		for (i = 0; i < ARRAY_SIZE(ctf2301_update_intervals); i++) {
924 			error = abs_diff(interval, ctf2301_update_intervals[i]);
925 			if (error < best_error) {
926 				best_error = error;
927 				best = i;
928 			}
929 		}
930 
931 		ret = i2c_smbus_write_byte_data(client, LM63_REG_CONVRATE,
932 						best);
933 		if (ret)
934 			return ret;
935 		data->update_interval = ctf2301_update_intervals[best];
936 
937 		return 0;
938 	}
939 
940 	/* Shift calculations to avoid rounding errors */
941 	interval <<= 6;
942 
943 	/* find the nearest update rate */
944 	update_interval = (1 << (LM63_MAX_CONVRATE + 6)) * 1000
945 	  / data->max_convrate_hz;
946 	for (i = 0; i < LM63_MAX_CONVRATE; i++, update_interval >>= 1)
947 		if (interval >= update_interval * 3 / 4)
948 			break;
949 
950 	ret = i2c_smbus_write_byte_data(client, LM63_REG_CONVRATE, i);
951 	if (ret)
952 		return ret;
953 	data->update_interval = UPDATE_INTERVAL(data->max_convrate_hz, i);
954 
955 	return 0;
956 }
957 
958 static ssize_t update_interval_show(struct device *dev,
959 				    struct device_attribute *attr, char *buf)
960 {
961 	struct lm63_data *data = dev_get_drvdata(dev);
962 
963 	return sprintf(buf, "%u\n", data->update_interval);
964 }
965 
966 static ssize_t update_interval_store(struct device *dev,
967 				     struct device_attribute *attr,
968 				     const char *buf, size_t count)
969 {
970 	struct lm63_data *data = dev_get_drvdata(dev);
971 	unsigned long val;
972 	int err;
973 
974 	err = kstrtoul(buf, 10, &val);
975 	if (err)
976 		return err;
977 
978 	mutex_lock(&data->update_lock);
979 	err = lm63_set_convrate(data, clamp_val(val, 0, 100000));
980 	mutex_unlock(&data->update_lock);
981 
982 	return err ? err : count;
983 }
984 
985 static ssize_t temp2_type_show(struct device *dev,
986 			       struct device_attribute *attr, char *buf)
987 {
988 	struct lm63_data *data = dev_get_drvdata(dev);
989 
990 	return sprintf(buf, data->trutherm ? "1\n" : "2\n");
991 }
992 
993 static ssize_t temp2_type_store(struct device *dev,
994 				struct device_attribute *attr,
995 				const char *buf, size_t count)
996 {
997 	struct lm63_data *data = dev_get_drvdata(dev);
998 	struct i2c_client *client = data->client;
999 	unsigned long val;
1000 	int ret;
1001 	u8 reg;
1002 
1003 	ret = kstrtoul(buf, 10, &val);
1004 	if (ret < 0)
1005 		return ret;
1006 	if (val != 1 && val != 2)
1007 		return -EINVAL;
1008 
1009 	mutex_lock(&data->update_lock);
1010 	data->trutherm = val == 1;
1011 	reg = i2c_smbus_read_byte_data(client, LM96163_REG_TRUTHERM) & ~0x02;
1012 	i2c_smbus_write_byte_data(client, LM96163_REG_TRUTHERM,
1013 				  reg | (data->trutherm ? 0x02 : 0x00));
1014 	data->valid = false;
1015 	mutex_unlock(&data->update_lock);
1016 
1017 	return count;
1018 }
1019 
1020 static ssize_t alarms_show(struct device *dev, struct device_attribute *dummy,
1021 			   char *buf)
1022 {
1023 	struct lm63_data *data = lm63_update_device(dev);
1024 	return sprintf(buf, "%u\n", data->alarms);
1025 }
1026 
1027 static ssize_t show_alarm(struct device *dev, struct device_attribute *devattr,
1028 			  char *buf)
1029 {
1030 	struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
1031 	struct lm63_data *data = lm63_update_device(dev);
1032 	int bitnr = attr->index;
1033 
1034 	return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
1035 }
1036 
1037 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
1038 static SENSOR_DEVICE_ATTR(fan1_min, S_IWUSR | S_IRUGO, show_fan,
1039 	set_fan, 1);
1040 
1041 static SENSOR_DEVICE_ATTR(pwm1, S_IWUSR | S_IRUGO, show_pwm1, set_pwm1, 0);
1042 static DEVICE_ATTR_RW(pwm1_enable);
1043 static DEVICE_ATTR_RW(pwm1_freq);
1044 static DEVICE_ATTR_RW(pwm1_auto_point_temp_hyst);
1045 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_pwm, S_IWUSR | S_IRUGO,
1046 	show_pwm1, set_pwm1, 1);
1047 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_temp, S_IWUSR | S_IRUGO,
1048 	show_lut_temp, set_temp8, 3);
1049 static SENSOR_DEVICE_ATTR(pwm1_auto_point1_temp_hyst, S_IRUGO,
1050 	show_lut_temp_hyst, NULL, 3);
1051 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_pwm, S_IWUSR | S_IRUGO,
1052 	show_pwm1, set_pwm1, 2);
1053 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_temp, S_IWUSR | S_IRUGO,
1054 	show_lut_temp, set_temp8, 4);
1055 static SENSOR_DEVICE_ATTR(pwm1_auto_point2_temp_hyst, S_IRUGO,
1056 	show_lut_temp_hyst, NULL, 4);
1057 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_pwm, S_IWUSR | S_IRUGO,
1058 	show_pwm1, set_pwm1, 3);
1059 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_temp, S_IWUSR | S_IRUGO,
1060 	show_lut_temp, set_temp8, 5);
1061 static SENSOR_DEVICE_ATTR(pwm1_auto_point3_temp_hyst, S_IRUGO,
1062 	show_lut_temp_hyst, NULL, 5);
1063 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_pwm, S_IWUSR | S_IRUGO,
1064 	show_pwm1, set_pwm1, 4);
1065 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_temp, S_IWUSR | S_IRUGO,
1066 	show_lut_temp, set_temp8, 6);
1067 static SENSOR_DEVICE_ATTR(pwm1_auto_point4_temp_hyst, S_IRUGO,
1068 	show_lut_temp_hyst, NULL, 6);
1069 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_pwm, S_IWUSR | S_IRUGO,
1070 	show_pwm1, set_pwm1, 5);
1071 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_temp, S_IWUSR | S_IRUGO,
1072 	show_lut_temp, set_temp8, 7);
1073 static SENSOR_DEVICE_ATTR(pwm1_auto_point5_temp_hyst, S_IRUGO,
1074 	show_lut_temp_hyst, NULL, 7);
1075 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_pwm, S_IWUSR | S_IRUGO,
1076 	show_pwm1, set_pwm1, 6);
1077 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_temp, S_IWUSR | S_IRUGO,
1078 	show_lut_temp, set_temp8, 8);
1079 static SENSOR_DEVICE_ATTR(pwm1_auto_point6_temp_hyst, S_IRUGO,
1080 	show_lut_temp_hyst, NULL, 8);
1081 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_pwm, S_IWUSR | S_IRUGO,
1082 	show_pwm1, set_pwm1, 7);
1083 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_temp, S_IWUSR | S_IRUGO,
1084 	show_lut_temp, set_temp8, 9);
1085 static SENSOR_DEVICE_ATTR(pwm1_auto_point7_temp_hyst, S_IRUGO,
1086 	show_lut_temp_hyst, NULL, 9);
1087 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_pwm, S_IWUSR | S_IRUGO,
1088 	show_pwm1, set_pwm1, 8);
1089 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_temp, S_IWUSR | S_IRUGO,
1090 	show_lut_temp, set_temp8, 10);
1091 static SENSOR_DEVICE_ATTR(pwm1_auto_point8_temp_hyst, S_IRUGO,
1092 	show_lut_temp_hyst, NULL, 10);
1093 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_pwm, S_IWUSR | S_IRUGO,
1094 	show_pwm1, set_pwm1, 9);
1095 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_temp, S_IWUSR | S_IRUGO,
1096 	show_lut_temp, set_temp8, 11);
1097 static SENSOR_DEVICE_ATTR(pwm1_auto_point9_temp_hyst, S_IRUGO,
1098 	show_lut_temp_hyst, NULL, 11);
1099 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_pwm, S_IWUSR | S_IRUGO,
1100 	show_pwm1, set_pwm1, 10);
1101 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_temp, S_IWUSR | S_IRUGO,
1102 	show_lut_temp, set_temp8, 12);
1103 static SENSOR_DEVICE_ATTR(pwm1_auto_point10_temp_hyst, S_IRUGO,
1104 	show_lut_temp_hyst, NULL, 12);
1105 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_pwm, S_IWUSR | S_IRUGO,
1106 	show_pwm1, set_pwm1, 11);
1107 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_temp, S_IWUSR | S_IRUGO,
1108 	show_lut_temp, set_temp8, 13);
1109 static SENSOR_DEVICE_ATTR(pwm1_auto_point11_temp_hyst, S_IRUGO,
1110 	show_lut_temp_hyst, NULL, 13);
1111 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_pwm, S_IWUSR | S_IRUGO,
1112 	show_pwm1, set_pwm1, 12);
1113 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_temp, S_IWUSR | S_IRUGO,
1114 	show_lut_temp, set_temp8, 14);
1115 static SENSOR_DEVICE_ATTR(pwm1_auto_point12_temp_hyst, S_IRUGO,
1116 	show_lut_temp_hyst, NULL, 14);
1117 
1118 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_local_temp8, NULL, 0);
1119 static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_local_temp8,
1120 	set_temp8, 1);
1121 
1122 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp11, NULL, 0);
1123 static SENSOR_DEVICE_ATTR(temp2_min, S_IWUSR | S_IRUGO, show_temp11,
1124 	set_temp11, 1);
1125 static SENSOR_DEVICE_ATTR(temp2_max, S_IWUSR | S_IRUGO, show_temp11,
1126 	set_temp11, 2);
1127 static SENSOR_DEVICE_ATTR(temp2_offset, S_IWUSR | S_IRUGO, show_temp11,
1128 	set_temp11, 3);
1129 static SENSOR_DEVICE_ATTR(temp2_crit, S_IRUGO, show_remote_temp8,
1130 	set_temp8, 2);
1131 static DEVICE_ATTR_RW(temp2_crit_hyst);
1132 
1133 static DEVICE_ATTR_RW(temp2_type);
1134 
1135 /* Individual alarm files */
1136 static SENSOR_DEVICE_ATTR(fan1_min_alarm, S_IRUGO, show_alarm, NULL, 0);
1137 static SENSOR_DEVICE_ATTR(temp2_crit_alarm, S_IRUGO, show_alarm, NULL, 1);
1138 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 2);
1139 static SENSOR_DEVICE_ATTR(temp2_min_alarm, S_IRUGO, show_alarm, NULL, 3);
1140 static SENSOR_DEVICE_ATTR(temp2_max_alarm, S_IRUGO, show_alarm, NULL, 4);
1141 static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, 6);
1142 /* Raw alarm file for compatibility */
1143 static DEVICE_ATTR_RO(alarms);
1144 
1145 static DEVICE_ATTR_RW(update_interval);
1146 
1147 static int lm63_get_max_state(struct thermal_cooling_device *cdev,
1148 			      unsigned long *state)
1149 {
1150 	*state = LM63_MAX_PWM;
1151 
1152 	return 0;
1153 }
1154 
1155 static int lm63_get_cur_state(struct thermal_cooling_device *cdev,
1156 			      unsigned long *state)
1157 {
1158 	struct lm63_data *data = cdev->devdata;
1159 	int ret;
1160 
1161 	mutex_lock(&data->update_lock);
1162 	ret = i2c_smbus_read_byte_data(data->client, LM63_REG_PWM_VALUE);
1163 	if (ret < 0)
1164 		goto unlock;
1165 
1166 	data->pwm1[0] = ret;
1167 	*state = lm63_pwm_from_reg(data, data->pwm1[0]);
1168 unlock:
1169 	mutex_unlock(&data->update_lock);
1170 
1171 	return ret < 0 ? ret : 0;
1172 }
1173 
1174 static int lm63_set_cur_state(struct thermal_cooling_device *cdev,
1175 			      unsigned long state)
1176 {
1177 	struct lm63_data *data = cdev->devdata;
1178 	int config_fan;
1179 	int ret;
1180 
1181 	if (state > LM63_MAX_PWM)
1182 		return -EINVAL;
1183 
1184 	mutex_lock(&data->update_lock);
1185 	config_fan = i2c_smbus_read_byte_data(data->client,
1186 					      LM63_REG_CONFIG_FAN);
1187 	if (config_fan < 0) {
1188 		ret = config_fan;
1189 		goto unlock;
1190 	}
1191 	data->config_fan = config_fan;
1192 
1193 	if (!(config_fan & 0x20)) {
1194 		config_fan |= 0x20;
1195 		ret = i2c_smbus_write_byte_data(data->client,
1196 						LM63_REG_CONFIG_FAN,
1197 						config_fan);
1198 		if (ret)
1199 			goto unlock;
1200 		data->config_fan = config_fan;
1201 	}
1202 
1203 	ret = lm63_write_pwm(data, 0, state);
1204 unlock:
1205 	mutex_unlock(&data->update_lock);
1206 
1207 	return ret;
1208 }
1209 
1210 static const struct thermal_cooling_device_ops lm63_cooling_ops = {
1211 	.get_max_state = lm63_get_max_state,
1212 	.get_cur_state = lm63_get_cur_state,
1213 	.set_cur_state = lm63_set_cur_state,
1214 };
1215 
1216 static struct attribute *lm63_attributes[] = {
1217 	&sensor_dev_attr_pwm1.dev_attr.attr,
1218 	&dev_attr_pwm1_enable.attr,
1219 	&dev_attr_pwm1_freq.attr,
1220 	&dev_attr_pwm1_auto_point_temp_hyst.attr,
1221 	&sensor_dev_attr_pwm1_auto_point1_pwm.dev_attr.attr,
1222 	&sensor_dev_attr_pwm1_auto_point1_temp.dev_attr.attr,
1223 	&sensor_dev_attr_pwm1_auto_point1_temp_hyst.dev_attr.attr,
1224 	&sensor_dev_attr_pwm1_auto_point2_pwm.dev_attr.attr,
1225 	&sensor_dev_attr_pwm1_auto_point2_temp.dev_attr.attr,
1226 	&sensor_dev_attr_pwm1_auto_point2_temp_hyst.dev_attr.attr,
1227 	&sensor_dev_attr_pwm1_auto_point3_pwm.dev_attr.attr,
1228 	&sensor_dev_attr_pwm1_auto_point3_temp.dev_attr.attr,
1229 	&sensor_dev_attr_pwm1_auto_point3_temp_hyst.dev_attr.attr,
1230 	&sensor_dev_attr_pwm1_auto_point4_pwm.dev_attr.attr,
1231 	&sensor_dev_attr_pwm1_auto_point4_temp.dev_attr.attr,
1232 	&sensor_dev_attr_pwm1_auto_point4_temp_hyst.dev_attr.attr,
1233 	&sensor_dev_attr_pwm1_auto_point5_pwm.dev_attr.attr,
1234 	&sensor_dev_attr_pwm1_auto_point5_temp.dev_attr.attr,
1235 	&sensor_dev_attr_pwm1_auto_point5_temp_hyst.dev_attr.attr,
1236 	&sensor_dev_attr_pwm1_auto_point6_pwm.dev_attr.attr,
1237 	&sensor_dev_attr_pwm1_auto_point6_temp.dev_attr.attr,
1238 	&sensor_dev_attr_pwm1_auto_point6_temp_hyst.dev_attr.attr,
1239 	&sensor_dev_attr_pwm1_auto_point7_pwm.dev_attr.attr,
1240 	&sensor_dev_attr_pwm1_auto_point7_temp.dev_attr.attr,
1241 	&sensor_dev_attr_pwm1_auto_point7_temp_hyst.dev_attr.attr,
1242 	&sensor_dev_attr_pwm1_auto_point8_pwm.dev_attr.attr,
1243 	&sensor_dev_attr_pwm1_auto_point8_temp.dev_attr.attr,
1244 	&sensor_dev_attr_pwm1_auto_point8_temp_hyst.dev_attr.attr,
1245 
1246 	&sensor_dev_attr_temp1_input.dev_attr.attr,
1247 	&sensor_dev_attr_temp2_input.dev_attr.attr,
1248 	&sensor_dev_attr_temp2_min.dev_attr.attr,
1249 	&sensor_dev_attr_temp1_max.dev_attr.attr,
1250 	&sensor_dev_attr_temp2_max.dev_attr.attr,
1251 	&sensor_dev_attr_temp2_offset.dev_attr.attr,
1252 	&sensor_dev_attr_temp2_crit.dev_attr.attr,
1253 	&dev_attr_temp2_crit_hyst.attr,
1254 
1255 	&sensor_dev_attr_temp2_crit_alarm.dev_attr.attr,
1256 	&sensor_dev_attr_temp2_fault.dev_attr.attr,
1257 	&sensor_dev_attr_temp2_min_alarm.dev_attr.attr,
1258 	&sensor_dev_attr_temp2_max_alarm.dev_attr.attr,
1259 	&sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
1260 	&dev_attr_alarms.attr,
1261 	&dev_attr_update_interval.attr,
1262 	NULL
1263 };
1264 
1265 static struct attribute *lm63_attributes_temp2_type[] = {
1266 	&dev_attr_temp2_type.attr,
1267 	NULL
1268 };
1269 
1270 static const struct attribute_group lm63_group_temp2_type = {
1271 	.attrs = lm63_attributes_temp2_type,
1272 };
1273 
1274 static struct attribute *lm63_attributes_extra_lut[] = {
1275 	&sensor_dev_attr_pwm1_auto_point9_pwm.dev_attr.attr,
1276 	&sensor_dev_attr_pwm1_auto_point9_temp.dev_attr.attr,
1277 	&sensor_dev_attr_pwm1_auto_point9_temp_hyst.dev_attr.attr,
1278 	&sensor_dev_attr_pwm1_auto_point10_pwm.dev_attr.attr,
1279 	&sensor_dev_attr_pwm1_auto_point10_temp.dev_attr.attr,
1280 	&sensor_dev_attr_pwm1_auto_point10_temp_hyst.dev_attr.attr,
1281 	&sensor_dev_attr_pwm1_auto_point11_pwm.dev_attr.attr,
1282 	&sensor_dev_attr_pwm1_auto_point11_temp.dev_attr.attr,
1283 	&sensor_dev_attr_pwm1_auto_point11_temp_hyst.dev_attr.attr,
1284 	&sensor_dev_attr_pwm1_auto_point12_pwm.dev_attr.attr,
1285 	&sensor_dev_attr_pwm1_auto_point12_temp.dev_attr.attr,
1286 	&sensor_dev_attr_pwm1_auto_point12_temp_hyst.dev_attr.attr,
1287 	NULL
1288 };
1289 
1290 static const struct attribute_group lm63_group_extra_lut = {
1291 	.attrs = lm63_attributes_extra_lut,
1292 };
1293 
1294 /*
1295  * On LM63, temp2_crit can be set only once, which should be job
1296  * of the bootloader.
1297  * On LM64, temp2_crit can always be set.
1298  * On LM96163 and CTF2301, temp2_crit can be set if bit 1 of the
1299  * configuration register is true.
1300  */
1301 static umode_t lm63_attribute_mode(struct kobject *kobj,
1302 				   struct attribute *attr, int index)
1303 {
1304 	struct device *dev = kobj_to_dev(kobj);
1305 	struct lm63_data *data = dev_get_drvdata(dev);
1306 
1307 	if (attr == &sensor_dev_attr_temp2_crit.dev_attr.attr
1308 	    && (data->kind == lm64 ||
1309 		((data->kind == lm96163 || data->kind == ctf2301) &&
1310 		 (data->config & 0x02))))
1311 		return attr->mode | S_IWUSR;
1312 
1313 	return attr->mode;
1314 }
1315 
1316 static const struct attribute_group lm63_group = {
1317 	.is_visible = lm63_attribute_mode,
1318 	.attrs = lm63_attributes,
1319 };
1320 
1321 static struct attribute *lm63_attributes_fan1[] = {
1322 	&sensor_dev_attr_fan1_input.dev_attr.attr,
1323 	&sensor_dev_attr_fan1_min.dev_attr.attr,
1324 
1325 	&sensor_dev_attr_fan1_min_alarm.dev_attr.attr,
1326 	NULL
1327 };
1328 
1329 static const struct attribute_group lm63_group_fan1 = {
1330 	.attrs = lm63_attributes_fan1,
1331 };
1332 
1333 /*
1334  * Real code
1335  */
1336 
1337 /* Return 0 if detection is successful, -ENODEV otherwise */
1338 static int lm63_detect(struct i2c_client *client,
1339 		       struct i2c_board_info *info)
1340 {
1341 	struct i2c_adapter *adapter = client->adapter;
1342 	u8 man_id, chip_id, reg_config1, reg_config2;
1343 	u8 reg_alert_status, reg_alert_mask;
1344 	int address = client->addr;
1345 
1346 	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
1347 		return -ENODEV;
1348 
1349 	man_id = i2c_smbus_read_byte_data(client, LM63_REG_MAN_ID);
1350 	chip_id = i2c_smbus_read_byte_data(client, LM63_REG_CHIP_ID);
1351 
1352 	reg_config1 = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
1353 	reg_config2 = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG2);
1354 	reg_alert_status = i2c_smbus_read_byte_data(client,
1355 			   LM63_REG_ALERT_STATUS);
1356 	reg_alert_mask = i2c_smbus_read_byte_data(client, LM63_REG_ALERT_MASK);
1357 
1358 	if (man_id != 0x01 /* National Semiconductor */
1359 	 || (reg_config1 & 0x18) != 0x00
1360 	 || (reg_config2 & 0xF8) != 0x00
1361 	 || (reg_alert_status & 0x20) != 0x00
1362 	 || (reg_alert_mask & 0xA4) != 0xA4) {
1363 		dev_dbg(&adapter->dev,
1364 			"Unsupported chip (man_id=0x%02X, chip_id=0x%02X)\n",
1365 			man_id, chip_id);
1366 		return -ENODEV;
1367 	}
1368 
1369 	if (chip_id == 0x41 && address == 0x4c)
1370 		strscpy(info->type, "lm63", I2C_NAME_SIZE);
1371 	else if (chip_id == 0x51 && (address == 0x18 || address == 0x4e))
1372 		strscpy(info->type, "lm64", I2C_NAME_SIZE);
1373 	else if (chip_id == 0x49 && address == 0x4c)
1374 		strscpy(info->type, "lm96163", I2C_NAME_SIZE);
1375 	else
1376 		return -ENODEV;
1377 
1378 	return 0;
1379 }
1380 
1381 /*
1382  * Ideally we shouldn't have to initialize anything, since the BIOS
1383  * should have taken care of everything
1384  */
1385 static int lm63_init_client(struct lm63_data *data)
1386 {
1387 	struct i2c_client *client = data->client;
1388 	struct device *dev = &client->dev;
1389 	u8 convrate;
1390 	int ret;
1391 
1392 	ret = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG1);
1393 	if (ret < 0)
1394 		return ret;
1395 	data->config = ret;
1396 	ret = i2c_smbus_read_byte_data(client, LM63_REG_CONFIG_FAN);
1397 	if (ret < 0)
1398 		return ret;
1399 	data->config_fan = ret;
1400 
1401 	/* Start converting if needed */
1402 	if (data->config & 0x40) { /* standby */
1403 		dev_dbg(dev, "Switching to operational mode\n");
1404 		data->config &= 0xA7;
1405 		ret = i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
1406 						data->config);
1407 		if (ret)
1408 			return ret;
1409 	}
1410 	/* Tachometer is always enabled on LM64 */
1411 	if (data->kind == lm64)
1412 		data->config |= 0x04;
1413 	if (data->kind == ctf2301 && !client->irq && !(data->config & 0x04)) {
1414 		dev_dbg(dev, "Configuring ALERT/TACH pin for tachometer input\n");
1415 		data->config |= 0x04;
1416 		ret = i2c_smbus_write_byte_data(client, LM63_REG_CONFIG1,
1417 						data->config);
1418 		if (ret)
1419 			return ret;
1420 	}
1421 
1422 	/* We may need pwm1_freq before ever updating the client data */
1423 	ret = i2c_smbus_read_byte_data(client, LM63_REG_PWM_FREQ);
1424 	if (ret < 0)
1425 		return ret;
1426 	data->pwm1_freq = ret & 0x1f;
1427 	if (data->pwm1_freq == 0)
1428 		data->pwm1_freq = 1;
1429 
1430 	switch (data->kind) {
1431 	case lm63:
1432 	case lm64:
1433 		data->max_convrate_hz = LM63_MAX_CONVRATE_HZ;
1434 		data->lut_size = 8;
1435 		break;
1436 	case lm96163:
1437 		data->max_convrate_hz = LM96163_MAX_CONVRATE_HZ;
1438 		data->lut_size = 12;
1439 		ret = i2c_smbus_read_byte_data(client, LM96163_REG_TRUTHERM);
1440 		if (ret < 0)
1441 			return ret;
1442 		data->trutherm = ret & 0x02;
1443 		break;
1444 	case ctf2301:
1445 		data->lut_size = 12;
1446 		break;
1447 	}
1448 	ret = i2c_smbus_read_byte_data(client, LM63_REG_CONVRATE);
1449 	if (ret < 0)
1450 		return ret;
1451 	convrate = ret;
1452 	if (data->kind == ctf2301 &&
1453 	    convrate >= ARRAY_SIZE(ctf2301_update_intervals))
1454 		convrate = ARRAY_SIZE(ctf2301_update_intervals) - 1;
1455 	else if (unlikely(convrate > LM63_MAX_CONVRATE))
1456 		convrate = LM63_MAX_CONVRATE;
1457 	data->update_interval = lm63_update_interval(data, convrate);
1458 
1459 	/*
1460 	 * For LM96163 and CTF2301, check if high resolution PWM
1461 	 * and unsigned temperature format is enabled.
1462 	 */
1463 	if (data->kind == lm96163 || data->kind == ctf2301) {
1464 		u8 config_enhanced;
1465 
1466 		ret = i2c_smbus_read_byte_data(client,
1467 					       LM96163_REG_CONFIG_ENHANCED);
1468 		if (ret < 0)
1469 			return ret;
1470 		config_enhanced = ret;
1471 		if (config_enhanced & 0x20)
1472 			data->lut_temp_highres = true;
1473 		if ((config_enhanced & 0x10)
1474 		    && !(data->config_fan & 0x08) && data->pwm1_freq == 8)
1475 			data->pwm_highres = true;
1476 		if (config_enhanced & 0x08)
1477 			data->remote_unsigned = true;
1478 	}
1479 
1480 	/* Show some debug info about the LM63 configuration */
1481 	if (data->kind == lm63)
1482 		dev_dbg(dev, "Alert/tach pin configured for %s\n",
1483 			(data->config & 0x04) ? "tachometer input" :
1484 			"alert output");
1485 	dev_dbg(dev, "PWM clock %s kHz, output frequency %u Hz\n",
1486 		(data->config_fan & 0x08) ? "1.4" : "360",
1487 		((data->config_fan & 0x08) ? 700 : 180000) / data->pwm1_freq);
1488 	dev_dbg(dev, "PWM output active %s, %s mode\n",
1489 		(data->config_fan & 0x10) ? "low" : "high",
1490 		(data->config_fan & 0x20) ? "manual" : "auto");
1491 
1492 	return 0;
1493 }
1494 
1495 static const struct i2c_device_id lm63_id[];
1496 
1497 static int lm63_probe(struct i2c_client *client)
1498 {
1499 	struct device *dev = &client->dev;
1500 	struct thermal_cooling_device *cdev;
1501 	struct device *hwmon_dev;
1502 	struct lm63_data *data;
1503 	int groups = 0;
1504 	int ret;
1505 
1506 	data = devm_kzalloc(dev, sizeof(struct lm63_data), GFP_KERNEL);
1507 	if (!data)
1508 		return -ENOMEM;
1509 
1510 	data->client = client;
1511 	mutex_init(&data->update_lock);
1512 
1513 	/* Set the device type */
1514 	data->kind = (uintptr_t)i2c_get_match_data(client);
1515 	if (data->kind == lm64)
1516 		data->temp2_offset = 16000;
1517 
1518 	/* Initialize chip */
1519 	ret = lm63_init_client(data);
1520 	if (ret)
1521 		return dev_err_probe(dev, ret, "failed to initialize device\n");
1522 
1523 	/* Register sysfs hooks */
1524 	data->groups[groups++] = &lm63_group;
1525 	if (data->config & 0x04)	/* tachometer enabled */
1526 		data->groups[groups++] = &lm63_group_fan1;
1527 
1528 	if (data->kind == lm96163) {
1529 		data->groups[groups++] = &lm63_group_temp2_type;
1530 		data->groups[groups++] = &lm63_group_extra_lut;
1531 	} else if (data->kind == ctf2301) {
1532 		data->groups[groups++] = &lm63_group_extra_lut;
1533 	}
1534 
1535 	hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
1536 							   data, data->groups);
1537 	if (IS_ERR(hwmon_dev))
1538 		return PTR_ERR(hwmon_dev);
1539 
1540 	if (IS_ENABLED(CONFIG_THERMAL_OF) &&
1541 	    of_property_present(dev->of_node, "#cooling-cells")) {
1542 		cdev = devm_thermal_of_cooling_device_register(dev, 0,
1543 							       client->name,
1544 							       data,
1545 							       &lm63_cooling_ops);
1546 		if (IS_ERR(cdev))
1547 			return PTR_ERR(cdev);
1548 	}
1549 
1550 	return 0;
1551 }
1552 
1553 /*
1554  * Driver data (common to all clients)
1555  */
1556 
1557 static const struct i2c_device_id lm63_id[] = {
1558 	{ .name = "lm63", .driver_data = lm63 },
1559 	{ .name = "lm64", .driver_data = lm64 },
1560 	{ .name = "lm96163", .driver_data = lm96163 },
1561 	{ .name = "ctf2301", .driver_data = ctf2301 },
1562 	{ }
1563 };
1564 MODULE_DEVICE_TABLE(i2c, lm63_id);
1565 
1566 static const struct of_device_id __maybe_unused lm63_of_match[] = {
1567 	{
1568 		.compatible = "national,lm63",
1569 		.data = (void *)lm63
1570 	},
1571 	{
1572 		.compatible = "national,lm64",
1573 		.data = (void *)lm64
1574 	},
1575 	{
1576 		.compatible = "national,lm96163",
1577 		.data = (void *)lm96163
1578 	},
1579 	{
1580 		.compatible = "sensylink,ctf2301",
1581 		.data = (void *)ctf2301
1582 	},
1583 	{ },
1584 };
1585 MODULE_DEVICE_TABLE(of, lm63_of_match);
1586 
1587 static struct i2c_driver lm63_driver = {
1588 	.class		= I2C_CLASS_HWMON,
1589 	.driver = {
1590 		.name	= "lm63",
1591 		.of_match_table = of_match_ptr(lm63_of_match),
1592 	},
1593 	.probe		= lm63_probe,
1594 	.id_table	= lm63_id,
1595 	.detect		= lm63_detect,
1596 	.address_list	= normal_i2c,
1597 };
1598 
1599 module_i2c_driver(lm63_driver);
1600 
1601 MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
1602 MODULE_DESCRIPTION("LM63 driver");
1603 MODULE_LICENSE("GPL");
1604