2 * Driver for Linear Technology LTC4245 I2C Multiple Supply Hot Swap Controller
4 * Copyright (C) 2008 Ira W. Snyder <iws@ovro.caltech.edu>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
10 * This driver is based on the ds1621 and ina209 drivers.
13 * http://www.linear.com/pc/downloadDocument.do?navId=H0,C1,C1003,C1006,C1140,P19392,D13517
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/init.h>
19 #include <linux/err.h>
20 #include <linux/slab.h>
21 #include <linux/i2c.h>
22 #include <linux/hwmon.h>
23 #include <linux/hwmon-sysfs.h>
24 #include <linux/jiffies.h>
25 #include <linux/i2c/ltc4245.h>
27 /* Here are names of the chip's registers (a.k.a. commands) */
29 LTC4245_STATUS
= 0x00, /* readonly */
31 LTC4245_CONTROL
= 0x02,
33 LTC4245_FAULT1
= 0x04,
34 LTC4245_FAULT2
= 0x05,
36 LTC4245_ADCADR
= 0x07,
39 LTC4245_12VSENSE
= 0x11,
40 LTC4245_12VOUT
= 0x12,
42 LTC4245_5VSENSE
= 0x14,
45 LTC4245_3VSENSE
= 0x17,
48 LTC4245_VEESENSE
= 0x1a,
49 LTC4245_VEEOUT
= 0x1b,
50 LTC4245_GPIOADC
= 0x1c,
54 struct i2c_client
*client
;
56 const struct attribute_group
*groups
[3];
58 struct mutex update_lock
;
60 unsigned long last_updated
; /* in jiffies */
62 /* Control registers */
65 /* Voltage registers */
68 /* GPIO ADC registers */
74 * Update the readings from the GPIO pins. If the driver has been configured to
75 * sample all GPIO's as analog voltages, a round-robin sampling method is used.
76 * Otherwise, only the configured GPIO pin is sampled.
78 * LOCKING: must hold data->update_lock
80 static void ltc4245_update_gpios(struct device
*dev
)
82 struct ltc4245_data
*data
= dev_get_drvdata(dev
);
83 struct i2c_client
*client
= data
->client
;
84 u8 gpio_curr
, gpio_next
, gpio_reg
;
87 /* no extra gpio support, we're basically done */
88 if (!data
->use_extra_gpios
) {
89 data
->gpios
[0] = data
->vregs
[LTC4245_GPIOADC
- 0x10];
94 * If the last reading was too long ago, then we mark all old GPIO
95 * readings as stale by setting them to -EAGAIN
97 if (time_after(jiffies
, data
->last_updated
+ 5 * HZ
)) {
98 for (i
= 0; i
< ARRAY_SIZE(data
->gpios
); i
++)
99 data
->gpios
[i
] = -EAGAIN
;
103 * Get the current GPIO pin
105 * The datasheet calls these GPIO[1-3], but we'll calculate the zero
106 * based array index instead, and call them GPIO[0-2]. This is much
107 * easier to think about.
109 gpio_curr
= (data
->cregs
[LTC4245_GPIO
] & 0xc0) >> 6;
113 /* Read the GPIO voltage from the GPIOADC register */
114 data
->gpios
[gpio_curr
] = data
->vregs
[LTC4245_GPIOADC
- 0x10];
116 /* Find the next GPIO pin to read */
117 gpio_next
= (gpio_curr
+ 1) % ARRAY_SIZE(data
->gpios
);
120 * Calculate the correct setting for the GPIO register so it will
121 * sample the next GPIO pin
123 gpio_reg
= (data
->cregs
[LTC4245_GPIO
] & 0x3f) | ((gpio_next
+ 1) << 6);
125 /* Update the GPIO register */
126 i2c_smbus_write_byte_data(client
, LTC4245_GPIO
, gpio_reg
);
128 /* Update saved data */
129 data
->cregs
[LTC4245_GPIO
] = gpio_reg
;
132 static struct ltc4245_data
*ltc4245_update_device(struct device
*dev
)
134 struct ltc4245_data
*data
= dev_get_drvdata(dev
);
135 struct i2c_client
*client
= data
->client
;
139 mutex_lock(&data
->update_lock
);
141 if (time_after(jiffies
, data
->last_updated
+ HZ
) || !data
->valid
) {
143 /* Read control registers -- 0x00 to 0x07 */
144 for (i
= 0; i
< ARRAY_SIZE(data
->cregs
); i
++) {
145 val
= i2c_smbus_read_byte_data(client
, i
);
146 if (unlikely(val
< 0))
149 data
->cregs
[i
] = val
;
152 /* Read voltage registers -- 0x10 to 0x1c */
153 for (i
= 0; i
< ARRAY_SIZE(data
->vregs
); i
++) {
154 val
= i2c_smbus_read_byte_data(client
, i
+0x10);
155 if (unlikely(val
< 0))
158 data
->vregs
[i
] = val
;
161 /* Update GPIO readings */
162 ltc4245_update_gpios(dev
);
164 data
->last_updated
= jiffies
;
168 mutex_unlock(&data
->update_lock
);
173 /* Return the voltage from the given register in millivolts */
174 static int ltc4245_get_voltage(struct device
*dev
, u8 reg
)
176 struct ltc4245_data
*data
= ltc4245_update_device(dev
);
177 const u8 regval
= data
->vregs
[reg
- 0x10];
183 voltage
= regval
* 55;
187 voltage
= regval
* 22;
191 voltage
= regval
* 15;
195 voltage
= regval
* -55;
197 case LTC4245_GPIOADC
:
198 voltage
= regval
* 10;
201 /* If we get here, the developer messed up */
209 /* Return the current in the given sense register in milliAmperes */
210 static unsigned int ltc4245_get_current(struct device
*dev
, u8 reg
)
212 struct ltc4245_data
*data
= ltc4245_update_device(dev
);
213 const u8 regval
= data
->vregs
[reg
- 0x10];
214 unsigned int voltage
;
218 * The strange looking conversions that follow are fixed-point
219 * math, since we cannot do floating point in the kernel.
221 * Step 1: convert sense register to microVolts
222 * Step 2: convert voltage to milliAmperes
224 * If you play around with the V=IR equation, you come up with
225 * the following: X uV / Y mOhm == Z mA
227 * With the resistors that are fractions of a milliOhm, we multiply
228 * the voltage and resistance by 10, to shift the decimal point.
229 * Now we can use the normal division operator again.
233 case LTC4245_12VSENSE
:
234 voltage
= regval
* 250; /* voltage in uV */
235 curr
= voltage
/ 50; /* sense resistor 50 mOhm */
237 case LTC4245_5VSENSE
:
238 voltage
= regval
* 125; /* voltage in uV */
239 curr
= (voltage
* 10) / 35; /* sense resistor 3.5 mOhm */
241 case LTC4245_3VSENSE
:
242 voltage
= regval
* 125; /* voltage in uV */
243 curr
= (voltage
* 10) / 25; /* sense resistor 2.5 mOhm */
245 case LTC4245_VEESENSE
:
246 voltage
= regval
* 250; /* voltage in uV */
247 curr
= voltage
/ 100; /* sense resistor 100 mOhm */
250 /* If we get here, the developer messed up */
259 static ssize_t
ltc4245_show_voltage(struct device
*dev
,
260 struct device_attribute
*da
,
263 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(da
);
264 const int voltage
= ltc4245_get_voltage(dev
, attr
->index
);
266 return snprintf(buf
, PAGE_SIZE
, "%d\n", voltage
);
269 static ssize_t
ltc4245_show_current(struct device
*dev
,
270 struct device_attribute
*da
,
273 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(da
);
274 const unsigned int curr
= ltc4245_get_current(dev
, attr
->index
);
276 return snprintf(buf
, PAGE_SIZE
, "%u\n", curr
);
279 static ssize_t
ltc4245_show_power(struct device
*dev
,
280 struct device_attribute
*da
,
283 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(da
);
284 const unsigned int curr
= ltc4245_get_current(dev
, attr
->index
);
285 const int output_voltage
= ltc4245_get_voltage(dev
, attr
->index
+1);
287 /* current in mA * voltage in mV == power in uW */
288 const unsigned int power
= abs(output_voltage
* curr
);
290 return snprintf(buf
, PAGE_SIZE
, "%u\n", power
);
293 static ssize_t
ltc4245_show_alarm(struct device
*dev
,
294 struct device_attribute
*da
,
297 struct sensor_device_attribute_2
*attr
= to_sensor_dev_attr_2(da
);
298 struct ltc4245_data
*data
= ltc4245_update_device(dev
);
299 const u8 reg
= data
->cregs
[attr
->index
];
300 const u32 mask
= attr
->nr
;
302 return snprintf(buf
, PAGE_SIZE
, "%u\n", (reg
& mask
) ? 1 : 0);
305 static ssize_t
ltc4245_show_gpio(struct device
*dev
,
306 struct device_attribute
*da
,
309 struct sensor_device_attribute
*attr
= to_sensor_dev_attr(da
);
310 struct ltc4245_data
*data
= ltc4245_update_device(dev
);
311 int val
= data
->gpios
[attr
->index
];
313 /* handle stale GPIO's */
317 /* Convert to millivolts and print */
318 return snprintf(buf
, PAGE_SIZE
, "%u\n", val
* 10);
321 /* Construct a sensor_device_attribute structure for each register */
324 static SENSOR_DEVICE_ATTR(in1_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
326 static SENSOR_DEVICE_ATTR(in2_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
328 static SENSOR_DEVICE_ATTR(in3_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
330 static SENSOR_DEVICE_ATTR(in4_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
333 /* Input undervoltage alarms */
334 static SENSOR_DEVICE_ATTR_2(in1_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
335 1 << 0, LTC4245_FAULT1
);
336 static SENSOR_DEVICE_ATTR_2(in2_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
337 1 << 1, LTC4245_FAULT1
);
338 static SENSOR_DEVICE_ATTR_2(in3_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
339 1 << 2, LTC4245_FAULT1
);
340 static SENSOR_DEVICE_ATTR_2(in4_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
341 1 << 3, LTC4245_FAULT1
);
343 /* Currents (via sense resistor) */
344 static SENSOR_DEVICE_ATTR(curr1_input
, S_IRUGO
, ltc4245_show_current
, NULL
,
346 static SENSOR_DEVICE_ATTR(curr2_input
, S_IRUGO
, ltc4245_show_current
, NULL
,
348 static SENSOR_DEVICE_ATTR(curr3_input
, S_IRUGO
, ltc4245_show_current
, NULL
,
350 static SENSOR_DEVICE_ATTR(curr4_input
, S_IRUGO
, ltc4245_show_current
, NULL
,
353 /* Overcurrent alarms */
354 static SENSOR_DEVICE_ATTR_2(curr1_max_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
355 1 << 4, LTC4245_FAULT1
);
356 static SENSOR_DEVICE_ATTR_2(curr2_max_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
357 1 << 5, LTC4245_FAULT1
);
358 static SENSOR_DEVICE_ATTR_2(curr3_max_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
359 1 << 6, LTC4245_FAULT1
);
360 static SENSOR_DEVICE_ATTR_2(curr4_max_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
361 1 << 7, LTC4245_FAULT1
);
363 /* Output voltages */
364 static SENSOR_DEVICE_ATTR(in5_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
366 static SENSOR_DEVICE_ATTR(in6_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
368 static SENSOR_DEVICE_ATTR(in7_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
370 static SENSOR_DEVICE_ATTR(in8_input
, S_IRUGO
, ltc4245_show_voltage
, NULL
,
373 /* Power Bad alarms */
374 static SENSOR_DEVICE_ATTR_2(in5_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
375 1 << 0, LTC4245_FAULT2
);
376 static SENSOR_DEVICE_ATTR_2(in6_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
377 1 << 1, LTC4245_FAULT2
);
378 static SENSOR_DEVICE_ATTR_2(in7_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
379 1 << 2, LTC4245_FAULT2
);
380 static SENSOR_DEVICE_ATTR_2(in8_min_alarm
, S_IRUGO
, ltc4245_show_alarm
, NULL
,
381 1 << 3, LTC4245_FAULT2
);
384 static SENSOR_DEVICE_ATTR(in9_input
, S_IRUGO
, ltc4245_show_gpio
, NULL
, 0);
385 static SENSOR_DEVICE_ATTR(in10_input
, S_IRUGO
, ltc4245_show_gpio
, NULL
, 1);
386 static SENSOR_DEVICE_ATTR(in11_input
, S_IRUGO
, ltc4245_show_gpio
, NULL
, 2);
388 /* Power Consumption (virtual) */
389 static SENSOR_DEVICE_ATTR(power1_input
, S_IRUGO
, ltc4245_show_power
, NULL
,
391 static SENSOR_DEVICE_ATTR(power2_input
, S_IRUGO
, ltc4245_show_power
, NULL
,
393 static SENSOR_DEVICE_ATTR(power3_input
, S_IRUGO
, ltc4245_show_power
, NULL
,
395 static SENSOR_DEVICE_ATTR(power4_input
, S_IRUGO
, ltc4245_show_power
, NULL
,
399 * Finally, construct an array of pointers to members of the above objects,
400 * as required for sysfs_create_group()
402 static struct attribute
*ltc4245_std_attributes
[] = {
403 &sensor_dev_attr_in1_input
.dev_attr
.attr
,
404 &sensor_dev_attr_in2_input
.dev_attr
.attr
,
405 &sensor_dev_attr_in3_input
.dev_attr
.attr
,
406 &sensor_dev_attr_in4_input
.dev_attr
.attr
,
408 &sensor_dev_attr_in1_min_alarm
.dev_attr
.attr
,
409 &sensor_dev_attr_in2_min_alarm
.dev_attr
.attr
,
410 &sensor_dev_attr_in3_min_alarm
.dev_attr
.attr
,
411 &sensor_dev_attr_in4_min_alarm
.dev_attr
.attr
,
413 &sensor_dev_attr_curr1_input
.dev_attr
.attr
,
414 &sensor_dev_attr_curr2_input
.dev_attr
.attr
,
415 &sensor_dev_attr_curr3_input
.dev_attr
.attr
,
416 &sensor_dev_attr_curr4_input
.dev_attr
.attr
,
418 &sensor_dev_attr_curr1_max_alarm
.dev_attr
.attr
,
419 &sensor_dev_attr_curr2_max_alarm
.dev_attr
.attr
,
420 &sensor_dev_attr_curr3_max_alarm
.dev_attr
.attr
,
421 &sensor_dev_attr_curr4_max_alarm
.dev_attr
.attr
,
423 &sensor_dev_attr_in5_input
.dev_attr
.attr
,
424 &sensor_dev_attr_in6_input
.dev_attr
.attr
,
425 &sensor_dev_attr_in7_input
.dev_attr
.attr
,
426 &sensor_dev_attr_in8_input
.dev_attr
.attr
,
428 &sensor_dev_attr_in5_min_alarm
.dev_attr
.attr
,
429 &sensor_dev_attr_in6_min_alarm
.dev_attr
.attr
,
430 &sensor_dev_attr_in7_min_alarm
.dev_attr
.attr
,
431 &sensor_dev_attr_in8_min_alarm
.dev_attr
.attr
,
433 &sensor_dev_attr_in9_input
.dev_attr
.attr
,
435 &sensor_dev_attr_power1_input
.dev_attr
.attr
,
436 &sensor_dev_attr_power2_input
.dev_attr
.attr
,
437 &sensor_dev_attr_power3_input
.dev_attr
.attr
,
438 &sensor_dev_attr_power4_input
.dev_attr
.attr
,
443 static struct attribute
*ltc4245_gpio_attributes
[] = {
444 &sensor_dev_attr_in10_input
.dev_attr
.attr
,
445 &sensor_dev_attr_in11_input
.dev_attr
.attr
,
449 static const struct attribute_group ltc4245_std_group
= {
450 .attrs
= ltc4245_std_attributes
,
453 static const struct attribute_group ltc4245_gpio_group
= {
454 .attrs
= ltc4245_gpio_attributes
,
457 static void ltc4245_sysfs_add_groups(struct ltc4245_data
*data
)
459 /* standard sysfs attributes */
460 data
->groups
[0] = <c4245_std_group
;
462 /* if we're using the extra gpio support, register it's attributes */
463 if (data
->use_extra_gpios
)
464 data
->groups
[1] = <c4245_gpio_group
;
467 static bool ltc4245_use_extra_gpios(struct i2c_client
*client
)
469 struct ltc4245_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
470 struct device_node
*np
= client
->dev
.of_node
;
472 /* prefer platform data */
474 return pdata
->use_extra_gpios
;
477 if (of_find_property(np
, "ltc4245,use-extra-gpios", NULL
))
483 static int ltc4245_probe(struct i2c_client
*client
,
484 const struct i2c_device_id
*id
)
486 struct i2c_adapter
*adapter
= client
->adapter
;
487 struct ltc4245_data
*data
;
488 struct device
*hwmon_dev
;
490 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
493 data
= devm_kzalloc(&client
->dev
, sizeof(*data
), GFP_KERNEL
);
497 data
->client
= client
;
498 mutex_init(&data
->update_lock
);
499 data
->use_extra_gpios
= ltc4245_use_extra_gpios(client
);
501 /* Initialize the LTC4245 chip */
502 i2c_smbus_write_byte_data(client
, LTC4245_FAULT1
, 0x00);
503 i2c_smbus_write_byte_data(client
, LTC4245_FAULT2
, 0x00);
505 /* Add sysfs hooks */
506 ltc4245_sysfs_add_groups(data
);
508 hwmon_dev
= devm_hwmon_device_register_with_groups(&client
->dev
,
511 return PTR_ERR_OR_ZERO(hwmon_dev
);
514 static const struct i2c_device_id ltc4245_id
[] = {
518 MODULE_DEVICE_TABLE(i2c
, ltc4245_id
);
520 /* This is the driver that will be inserted */
521 static struct i2c_driver ltc4245_driver
= {
525 .probe
= ltc4245_probe
,
526 .id_table
= ltc4245_id
,
529 module_i2c_driver(ltc4245_driver
);
531 MODULE_AUTHOR("Ira W. Snyder <iws@ovro.caltech.edu>");
532 MODULE_DESCRIPTION("LTC4245 driver");
533 MODULE_LICENSE("GPL");