2 * sht15.c - support for the SHT15 Temperature and Humidity Sensor
4 * Portions Copyright (c) 2010-2012 Savoir-faire Linux Inc.
5 * Jerome Oufella <jerome.oufella@savoirfairelinux.com>
6 * Vivien Didelot <vivien.didelot@savoirfairelinux.com>
8 * Copyright (c) 2009 Jonathan Cameron
10 * Copyright (c) 2007 Wouter Horre
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
16 * For further information, see the Documentation/hwmon/sht15 file.
19 #include <linux/interrupt.h>
20 #include <linux/irq.h>
21 #include <linux/gpio.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/hwmon.h>
25 #include <linux/hwmon-sysfs.h>
26 #include <linux/mutex.h>
27 #include <linux/platform_data/sht15.h>
28 #include <linux/platform_device.h>
29 #include <linux/sched.h>
30 #include <linux/delay.h>
31 #include <linux/jiffies.h>
32 #include <linux/err.h>
33 #include <linux/regulator/consumer.h>
34 #include <linux/slab.h>
35 #include <linux/atomic.h>
38 #define SHT15_MEASURE_TEMP 0x03
39 #define SHT15_MEASURE_RH 0x05
40 #define SHT15_WRITE_STATUS 0x06
41 #define SHT15_READ_STATUS 0x07
42 #define SHT15_SOFT_RESET 0x1E
45 #define SHT15_TSCKL 100 /* (nsecs) clock low */
46 #define SHT15_TSCKH 100 /* (nsecs) clock high */
47 #define SHT15_TSU 150 /* (nsecs) data setup time */
48 #define SHT15_TSRST 11 /* (msecs) soft reset time */
50 /* Status Register Bits */
51 #define SHT15_STATUS_LOW_RESOLUTION 0x01
52 #define SHT15_STATUS_NO_OTP_RELOAD 0x02
53 #define SHT15_STATUS_HEATER 0x04
54 #define SHT15_STATUS_LOW_BATTERY 0x40
56 /* List of supported chips */
57 enum sht15_chips
{ sht10
, sht11
, sht15
, sht71
, sht75
};
59 /* Actions the driver may be doing */
61 SHT15_READING_NOTHING
,
67 * struct sht15_temppair - elements of voltage dependent temp calc
68 * @vdd: supply voltage in microvolts
71 struct sht15_temppair
{
72 int vdd
; /* microvolts */
76 /* Table 9 from datasheet - relates temperature calculation to supply voltage */
77 static const struct sht15_temppair temppoints
[] = {
85 /* Table from CRC datasheet, section 2.4 */
86 static const u8 sht15_crc8_table
[] = {
87 0, 49, 98, 83, 196, 245, 166, 151,
88 185, 136, 219, 234, 125, 76, 31, 46,
89 67, 114, 33, 16, 135, 182, 229, 212,
90 250, 203, 152, 169, 62, 15, 92, 109,
91 134, 183, 228, 213, 66, 115, 32, 17,
92 63, 14, 93, 108, 251, 202, 153, 168,
93 197, 244, 167, 150, 1, 48, 99, 82,
94 124, 77, 30, 47, 184, 137, 218, 235,
95 61, 12, 95, 110, 249, 200, 155, 170,
96 132, 181, 230, 215, 64, 113, 34, 19,
97 126, 79, 28, 45, 186, 139, 216, 233,
98 199, 246, 165, 148, 3, 50, 97, 80,
99 187, 138, 217, 232, 127, 78, 29, 44,
100 2, 51, 96, 81, 198, 247, 164, 149,
101 248, 201, 154, 171, 60, 13, 94, 111,
102 65, 112, 35, 18, 133, 180, 231, 214,
103 122, 75, 24, 41, 190, 143, 220, 237,
104 195, 242, 161, 144, 7, 54, 101, 84,
105 57, 8, 91, 106, 253, 204, 159, 174,
106 128, 177, 226, 211, 68, 117, 38, 23,
107 252, 205, 158, 175, 56, 9, 90, 107,
108 69, 116, 39, 22, 129, 176, 227, 210,
109 191, 142, 221, 236, 123, 74, 25, 40,
110 6, 55, 100, 85, 194, 243, 160, 145,
111 71, 118, 37, 20, 131, 178, 225, 208,
112 254, 207, 156, 173, 58, 11, 88, 105,
113 4, 53, 102, 87, 192, 241, 162, 147,
114 189, 140, 223, 238, 121, 72, 27, 42,
115 193, 240, 163, 146, 5, 52, 103, 86,
116 120, 73, 26, 43, 188, 141, 222, 239,
117 130, 179, 224, 209, 70, 119, 36, 21,
118 59, 10, 89, 104, 255, 206, 157, 172
122 * struct sht15_data - device instance specific data
123 * @pdata: platform data (gpio's etc).
124 * @read_work: bh of interrupt handler.
125 * @wait_queue: wait queue for getting values from device.
126 * @val_temp: last temperature value read from device.
127 * @val_humid: last humidity value read from device.
128 * @val_status: last status register value read from device.
129 * @checksum_ok: last value read from the device passed CRC validation.
130 * @checksumming: flag used to enable the data validation with CRC.
131 * @state: state identifying the action the driver is doing.
132 * @measurements_valid: are the current stored measures valid (start condition).
133 * @status_valid: is the current stored status valid (start condition).
134 * @last_measurement: time of last measure.
135 * @last_status: time of last status reading.
136 * @read_lock: mutex to ensure only one read in progress at a time.
137 * @dev: associate device structure.
138 * @hwmon_dev: device associated with hwmon subsystem.
139 * @reg: associated regulator (if specified).
140 * @nb: notifier block to handle notifications of voltage
142 * @supply_uv: local copy of supply voltage used to allow use of
143 * regulator consumer if available.
144 * @supply_uv_valid: indicates that an updated value has not yet been
145 * obtained from the regulator and so any calculations
146 * based upon it will be invalid.
147 * @update_supply_work: work struct that is used to update the supply_uv.
148 * @interrupt_handled: flag used to indicate a handler has been scheduled.
151 struct sht15_platform_data
*pdata
;
152 struct work_struct read_work
;
153 wait_queue_head_t wait_queue
;
159 enum sht15_state state
;
160 bool measurements_valid
;
162 unsigned long last_measurement
;
163 unsigned long last_status
;
164 struct mutex read_lock
;
166 struct device
*hwmon_dev
;
167 struct regulator
*reg
;
168 struct notifier_block nb
;
170 bool supply_uv_valid
;
171 struct work_struct update_supply_work
;
172 atomic_t interrupt_handled
;
176 * sht15_reverse() - reverse a byte
177 * @byte: byte to reverse.
179 static u8
sht15_reverse(u8 byte
)
183 for (c
= 0, i
= 0; i
< 8; i
++)
184 c
|= (!!(byte
& (1 << i
))) << (7 - i
);
189 * sht15_crc8() - compute crc8
190 * @data: sht15 specific data.
191 * @value: sht15 retrieved data.
193 * This implements section 2 of the CRC datasheet.
195 static u8
sht15_crc8(struct sht15_data
*data
,
199 u8 crc
= sht15_reverse(data
->val_status
& 0x0F);
202 crc
= sht15_crc8_table
[*value
^ crc
];
210 * sht15_connection_reset() - reset the comms interface
211 * @data: sht15 specific data
213 * This implements section 3.4 of the data sheet
215 static int sht15_connection_reset(struct sht15_data
*data
)
219 err
= gpio_direction_output(data
->pdata
->gpio_data
, 1);
223 gpio_set_value(data
->pdata
->gpio_sck
, 0);
225 for (i
= 0; i
< 9; ++i
) {
226 gpio_set_value(data
->pdata
->gpio_sck
, 1);
228 gpio_set_value(data
->pdata
->gpio_sck
, 0);
235 * sht15_send_bit() - send an individual bit to the device
236 * @data: device state data
237 * @val: value of bit to be sent
239 static inline void sht15_send_bit(struct sht15_data
*data
, int val
)
241 gpio_set_value(data
->pdata
->gpio_data
, val
);
243 gpio_set_value(data
->pdata
->gpio_sck
, 1);
245 gpio_set_value(data
->pdata
->gpio_sck
, 0);
246 ndelay(SHT15_TSCKL
); /* clock low time */
250 * sht15_transmission_start() - specific sequence for new transmission
251 * @data: device state data
253 * Timings for this are not documented on the data sheet, so very
254 * conservative ones used in implementation. This implements
255 * figure 12 on the data sheet.
257 static int sht15_transmission_start(struct sht15_data
*data
)
261 /* ensure data is high and output */
262 err
= gpio_direction_output(data
->pdata
->gpio_data
, 1);
266 gpio_set_value(data
->pdata
->gpio_sck
, 0);
268 gpio_set_value(data
->pdata
->gpio_sck
, 1);
270 gpio_set_value(data
->pdata
->gpio_data
, 0);
272 gpio_set_value(data
->pdata
->gpio_sck
, 0);
274 gpio_set_value(data
->pdata
->gpio_sck
, 1);
276 gpio_set_value(data
->pdata
->gpio_data
, 1);
278 gpio_set_value(data
->pdata
->gpio_sck
, 0);
284 * sht15_send_byte() - send a single byte to the device
285 * @data: device state
286 * @byte: value to be sent
288 static void sht15_send_byte(struct sht15_data
*data
, u8 byte
)
292 for (i
= 0; i
< 8; i
++) {
293 sht15_send_bit(data
, !!(byte
& 0x80));
299 * sht15_wait_for_response() - checks for ack from device
300 * @data: device state
302 static int sht15_wait_for_response(struct sht15_data
*data
)
306 err
= gpio_direction_input(data
->pdata
->gpio_data
);
309 gpio_set_value(data
->pdata
->gpio_sck
, 1);
311 if (gpio_get_value(data
->pdata
->gpio_data
)) {
312 gpio_set_value(data
->pdata
->gpio_sck
, 0);
313 dev_err(data
->dev
, "Command not acknowledged\n");
314 err
= sht15_connection_reset(data
);
319 gpio_set_value(data
->pdata
->gpio_sck
, 0);
325 * sht15_send_cmd() - Sends a command to the device.
326 * @data: device state
327 * @cmd: command byte to be sent
329 * On entry, sck is output low, data is output pull high
330 * and the interrupt disabled.
332 static int sht15_send_cmd(struct sht15_data
*data
, u8 cmd
)
336 err
= sht15_transmission_start(data
);
339 sht15_send_byte(data
, cmd
);
340 return sht15_wait_for_response(data
);
344 * sht15_soft_reset() - send a soft reset command
345 * @data: sht15 specific data.
347 * As described in section 3.2 of the datasheet.
349 static int sht15_soft_reset(struct sht15_data
*data
)
353 ret
= sht15_send_cmd(data
, SHT15_SOFT_RESET
);
357 /* device resets default hardware status register value */
358 data
->val_status
= 0;
364 * sht15_ack() - send a ack
365 * @data: sht15 specific data.
367 * Each byte of data is acknowledged by pulling the data line
368 * low for one clock pulse.
370 static int sht15_ack(struct sht15_data
*data
)
374 err
= gpio_direction_output(data
->pdata
->gpio_data
, 0);
378 gpio_set_value(data
->pdata
->gpio_sck
, 1);
380 gpio_set_value(data
->pdata
->gpio_sck
, 0);
382 gpio_set_value(data
->pdata
->gpio_data
, 1);
384 return gpio_direction_input(data
->pdata
->gpio_data
);
388 * sht15_end_transmission() - notify device of end of transmission
389 * @data: device state.
391 * This is basically a NAK (single clock pulse, data high).
393 static int sht15_end_transmission(struct sht15_data
*data
)
397 err
= gpio_direction_output(data
->pdata
->gpio_data
, 1);
401 gpio_set_value(data
->pdata
->gpio_sck
, 1);
403 gpio_set_value(data
->pdata
->gpio_sck
, 0);
409 * sht15_read_byte() - Read a byte back from the device
410 * @data: device state.
412 static u8
sht15_read_byte(struct sht15_data
*data
)
417 for (i
= 0; i
< 8; ++i
) {
419 gpio_set_value(data
->pdata
->gpio_sck
, 1);
421 byte
|= !!gpio_get_value(data
->pdata
->gpio_data
);
422 gpio_set_value(data
->pdata
->gpio_sck
, 0);
429 * sht15_send_status() - write the status register byte
430 * @data: sht15 specific data.
431 * @status: the byte to set the status register with.
433 * As described in figure 14 and table 5 of the datasheet.
435 static int sht15_send_status(struct sht15_data
*data
, u8 status
)
439 err
= sht15_send_cmd(data
, SHT15_WRITE_STATUS
);
442 err
= gpio_direction_output(data
->pdata
->gpio_data
, 1);
446 sht15_send_byte(data
, status
);
447 err
= sht15_wait_for_response(data
);
451 data
->val_status
= status
;
456 * sht15_update_status() - get updated status register from device if too old
457 * @data: device instance specific data.
459 * As described in figure 15 and table 5 of the datasheet.
461 static int sht15_update_status(struct sht15_data
*data
)
470 mutex_lock(&data
->read_lock
);
471 if (time_after(jiffies
, data
->last_status
+ timeout
)
472 || !data
->status_valid
) {
473 ret
= sht15_send_cmd(data
, SHT15_READ_STATUS
);
476 status
= sht15_read_byte(data
);
478 if (data
->checksumming
) {
480 dev_checksum
= sht15_reverse(sht15_read_byte(data
));
481 checksum_vals
[0] = SHT15_READ_STATUS
;
482 checksum_vals
[1] = status
;
483 data
->checksum_ok
= (sht15_crc8(data
, checksum_vals
, 2)
487 ret
= sht15_end_transmission(data
);
492 * Perform checksum validation on the received data.
493 * Specification mentions that in case a checksum verification
494 * fails, a soft reset command must be sent to the device.
496 if (data
->checksumming
&& !data
->checksum_ok
) {
497 previous_config
= data
->val_status
& 0x07;
498 ret
= sht15_soft_reset(data
);
501 if (previous_config
) {
502 ret
= sht15_send_status(data
, previous_config
);
505 "CRC validation failed, unable "
506 "to restore device settings\n");
514 data
->val_status
= status
;
515 data
->status_valid
= true;
516 data
->last_status
= jiffies
;
520 mutex_unlock(&data
->read_lock
);
525 * sht15_measurement() - get a new value from device
526 * @data: device instance specific data
527 * @command: command sent to request value
528 * @timeout_msecs: timeout after which comms are assumed
529 * to have failed are reset.
531 static int sht15_measurement(struct sht15_data
*data
,
538 ret
= sht15_send_cmd(data
, command
);
542 ret
= gpio_direction_input(data
->pdata
->gpio_data
);
545 atomic_set(&data
->interrupt_handled
, 0);
547 enable_irq(gpio_to_irq(data
->pdata
->gpio_data
));
548 if (gpio_get_value(data
->pdata
->gpio_data
) == 0) {
549 disable_irq_nosync(gpio_to_irq(data
->pdata
->gpio_data
));
550 /* Only relevant if the interrupt hasn't occurred. */
551 if (!atomic_read(&data
->interrupt_handled
))
552 schedule_work(&data
->read_work
);
554 ret
= wait_event_timeout(data
->wait_queue
,
555 (data
->state
== SHT15_READING_NOTHING
),
556 msecs_to_jiffies(timeout_msecs
));
557 if (data
->state
!= SHT15_READING_NOTHING
) { /* I/O error occurred */
558 data
->state
= SHT15_READING_NOTHING
;
560 } else if (ret
== 0) { /* timeout occurred */
561 disable_irq_nosync(gpio_to_irq(data
->pdata
->gpio_data
));
562 ret
= sht15_connection_reset(data
);
569 * Perform checksum validation on the received data.
570 * Specification mentions that in case a checksum verification fails,
571 * a soft reset command must be sent to the device.
573 if (data
->checksumming
&& !data
->checksum_ok
) {
574 previous_config
= data
->val_status
& 0x07;
575 ret
= sht15_soft_reset(data
);
578 if (previous_config
) {
579 ret
= sht15_send_status(data
, previous_config
);
582 "CRC validation failed, unable "
583 "to restore device settings\n");
594 * sht15_update_measurements() - get updated measures from device if too old
595 * @data: device state
597 static int sht15_update_measurements(struct sht15_data
*data
)
602 mutex_lock(&data
->read_lock
);
603 if (time_after(jiffies
, data
->last_measurement
+ timeout
)
604 || !data
->measurements_valid
) {
605 data
->state
= SHT15_READING_HUMID
;
606 ret
= sht15_measurement(data
, SHT15_MEASURE_RH
, 160);
609 data
->state
= SHT15_READING_TEMP
;
610 ret
= sht15_measurement(data
, SHT15_MEASURE_TEMP
, 400);
613 data
->measurements_valid
= true;
614 data
->last_measurement
= jiffies
;
618 mutex_unlock(&data
->read_lock
);
623 * sht15_calc_temp() - convert the raw reading to a temperature
624 * @data: device state
626 * As per section 4.3 of the data sheet.
628 static inline int sht15_calc_temp(struct sht15_data
*data
)
630 int d1
= temppoints
[0].d1
;
631 int d2
= (data
->val_status
& SHT15_STATUS_LOW_RESOLUTION
) ? 40 : 10;
634 for (i
= ARRAY_SIZE(temppoints
) - 1; i
> 0; i
--)
635 /* Find pointer to interpolate */
636 if (data
->supply_uv
> temppoints
[i
- 1].vdd
) {
637 d1
= (data
->supply_uv
- temppoints
[i
- 1].vdd
)
638 * (temppoints
[i
].d1
- temppoints
[i
- 1].d1
)
639 / (temppoints
[i
].vdd
- temppoints
[i
- 1].vdd
)
640 + temppoints
[i
- 1].d1
;
644 return data
->val_temp
* d2
+ d1
;
648 * sht15_calc_humid() - using last temperature convert raw to humid
649 * @data: device state
651 * This is the temperature compensated version as per section 4.2 of
654 * The sensor is assumed to be V3, which is compatible with V4.
655 * Humidity conversion coefficients are shown in table 7 of the datasheet.
657 static inline int sht15_calc_humid(struct sht15_data
*data
)
659 int rh_linear
; /* milli percent */
660 int temp
= sht15_calc_temp(data
);
665 if (data
->val_status
& SHT15_STATUS_LOW_RESOLUTION
) {
666 c2
= 648000; /* x 10 ^ -6 */
667 c3
= -7200; /* x 10 ^ -7 */
670 c2
= 40500; /* x 10 ^ -6 */
671 c3
= -28; /* x 10 ^ -7 */
675 rh_linear
= c1
* 1000
676 + c2
* data
->val_humid
/ 1000
677 + (data
->val_humid
* data
->val_humid
* c3
) / 10000;
678 return (temp
- 25000) * (10000 + t2
* data
->val_humid
)
679 / 1000000 + rh_linear
;
683 * sht15_show_status() - show status information in sysfs
685 * @attr: device attribute.
686 * @buf: sysfs buffer where information is written to.
688 * Will be called on read access to temp1_fault, humidity1_fault
689 * and heater_enable sysfs attributes.
690 * Returns number of bytes written into buffer, negative errno on error.
692 static ssize_t
sht15_show_status(struct device
*dev
,
693 struct device_attribute
*attr
,
697 struct sht15_data
*data
= dev_get_drvdata(dev
);
698 u8 bit
= to_sensor_dev_attr(attr
)->index
;
700 ret
= sht15_update_status(data
);
702 return ret
? ret
: sprintf(buf
, "%d\n", !!(data
->val_status
& bit
));
706 * sht15_store_heater() - change heater state via sysfs
708 * @attr: device attribute.
709 * @buf: sysfs buffer to read the new heater state from.
710 * @count: length of the data.
712 * Will be called on write access to heater_enable sysfs attribute.
713 * Returns number of bytes actually decoded, negative errno on error.
715 static ssize_t
sht15_store_heater(struct device
*dev
,
716 struct device_attribute
*attr
,
717 const char *buf
, size_t count
)
720 struct sht15_data
*data
= dev_get_drvdata(dev
);
724 if (kstrtol(buf
, 10, &value
))
727 mutex_lock(&data
->read_lock
);
728 status
= data
->val_status
& 0x07;
730 status
|= SHT15_STATUS_HEATER
;
732 status
&= ~SHT15_STATUS_HEATER
;
734 ret
= sht15_send_status(data
, status
);
735 mutex_unlock(&data
->read_lock
);
737 return ret
? ret
: count
;
741 * sht15_show_temp() - show temperature measurement value in sysfs
743 * @attr: device attribute.
744 * @buf: sysfs buffer where measurement values are written to.
746 * Will be called on read access to temp1_input sysfs attribute.
747 * Returns number of bytes written into buffer, negative errno on error.
749 static ssize_t
sht15_show_temp(struct device
*dev
,
750 struct device_attribute
*attr
,
754 struct sht15_data
*data
= dev_get_drvdata(dev
);
756 /* Technically no need to read humidity as well */
757 ret
= sht15_update_measurements(data
);
759 return ret
? ret
: sprintf(buf
, "%d\n",
760 sht15_calc_temp(data
));
764 * sht15_show_humidity() - show humidity measurement value in sysfs
766 * @attr: device attribute.
767 * @buf: sysfs buffer where measurement values are written to.
769 * Will be called on read access to humidity1_input sysfs attribute.
770 * Returns number of bytes written into buffer, negative errno on error.
772 static ssize_t
sht15_show_humidity(struct device
*dev
,
773 struct device_attribute
*attr
,
777 struct sht15_data
*data
= dev_get_drvdata(dev
);
779 ret
= sht15_update_measurements(data
);
781 return ret
? ret
: sprintf(buf
, "%d\n", sht15_calc_humid(data
));
784 static ssize_t
show_name(struct device
*dev
,
785 struct device_attribute
*attr
,
788 struct platform_device
*pdev
= to_platform_device(dev
);
789 return sprintf(buf
, "%s\n", pdev
->name
);
792 static SENSOR_DEVICE_ATTR(temp1_input
, S_IRUGO
,
793 sht15_show_temp
, NULL
, 0);
794 static SENSOR_DEVICE_ATTR(humidity1_input
, S_IRUGO
,
795 sht15_show_humidity
, NULL
, 0);
796 static SENSOR_DEVICE_ATTR(temp1_fault
, S_IRUGO
, sht15_show_status
, NULL
,
797 SHT15_STATUS_LOW_BATTERY
);
798 static SENSOR_DEVICE_ATTR(humidity1_fault
, S_IRUGO
, sht15_show_status
, NULL
,
799 SHT15_STATUS_LOW_BATTERY
);
800 static SENSOR_DEVICE_ATTR(heater_enable
, S_IRUGO
| S_IWUSR
, sht15_show_status
,
801 sht15_store_heater
, SHT15_STATUS_HEATER
);
802 static DEVICE_ATTR(name
, S_IRUGO
, show_name
, NULL
);
803 static struct attribute
*sht15_attrs
[] = {
804 &sensor_dev_attr_temp1_input
.dev_attr
.attr
,
805 &sensor_dev_attr_humidity1_input
.dev_attr
.attr
,
806 &sensor_dev_attr_temp1_fault
.dev_attr
.attr
,
807 &sensor_dev_attr_humidity1_fault
.dev_attr
.attr
,
808 &sensor_dev_attr_heater_enable
.dev_attr
.attr
,
813 static const struct attribute_group sht15_attr_group
= {
814 .attrs
= sht15_attrs
,
817 static irqreturn_t
sht15_interrupt_fired(int irq
, void *d
)
819 struct sht15_data
*data
= d
;
821 /* First disable the interrupt */
822 disable_irq_nosync(irq
);
823 atomic_inc(&data
->interrupt_handled
);
824 /* Then schedule a reading work struct */
825 if (data
->state
!= SHT15_READING_NOTHING
)
826 schedule_work(&data
->read_work
);
830 static void sht15_bh_read_data(struct work_struct
*work_s
)
835 struct sht15_data
*data
836 = container_of(work_s
, struct sht15_data
,
839 /* Firstly, verify the line is low */
840 if (gpio_get_value(data
->pdata
->gpio_data
)) {
842 * If not, then start the interrupt again - care here as could
843 * have gone low in meantime so verify it hasn't!
845 atomic_set(&data
->interrupt_handled
, 0);
846 enable_irq(gpio_to_irq(data
->pdata
->gpio_data
));
847 /* If still not occurred or another handler was scheduled */
848 if (gpio_get_value(data
->pdata
->gpio_data
)
849 || atomic_read(&data
->interrupt_handled
))
853 /* Read the data back from the device */
854 val
= sht15_read_byte(data
);
858 val
|= sht15_read_byte(data
);
860 if (data
->checksumming
) {
862 * Ask the device for a checksum and read it back.
863 * Note: the device sends the checksum byte reversed.
867 dev_checksum
= sht15_reverse(sht15_read_byte(data
));
868 checksum_vals
[0] = (data
->state
== SHT15_READING_TEMP
) ?
869 SHT15_MEASURE_TEMP
: SHT15_MEASURE_RH
;
870 checksum_vals
[1] = (u8
) (val
>> 8);
871 checksum_vals
[2] = (u8
) val
;
873 = (sht15_crc8(data
, checksum_vals
, 3) == dev_checksum
);
876 /* Tell the device we are done */
877 if (sht15_end_transmission(data
))
880 switch (data
->state
) {
881 case SHT15_READING_TEMP
:
882 data
->val_temp
= val
;
884 case SHT15_READING_HUMID
:
885 data
->val_humid
= val
;
891 data
->state
= SHT15_READING_NOTHING
;
893 wake_up(&data
->wait_queue
);
896 static void sht15_update_voltage(struct work_struct
*work_s
)
898 struct sht15_data
*data
899 = container_of(work_s
, struct sht15_data
,
901 data
->supply_uv
= regulator_get_voltage(data
->reg
);
905 * sht15_invalidate_voltage() - mark supply voltage invalid when notified by reg
906 * @nb: associated notification structure
907 * @event: voltage regulator state change event code
908 * @ignored: function parameter - ignored here
910 * Note that as the notification code holds the regulator lock, we have
911 * to schedule an update of the supply voltage rather than getting it directly.
913 static int sht15_invalidate_voltage(struct notifier_block
*nb
,
917 struct sht15_data
*data
= container_of(nb
, struct sht15_data
, nb
);
919 if (event
== REGULATOR_EVENT_VOLTAGE_CHANGE
)
920 data
->supply_uv_valid
= false;
921 schedule_work(&data
->update_supply_work
);
926 static int sht15_probe(struct platform_device
*pdev
)
929 struct sht15_data
*data
;
932 data
= devm_kzalloc(&pdev
->dev
, sizeof(*data
), GFP_KERNEL
);
936 INIT_WORK(&data
->read_work
, sht15_bh_read_data
);
937 INIT_WORK(&data
->update_supply_work
, sht15_update_voltage
);
938 platform_set_drvdata(pdev
, data
);
939 mutex_init(&data
->read_lock
);
940 data
->dev
= &pdev
->dev
;
941 init_waitqueue_head(&data
->wait_queue
);
943 if (pdev
->dev
.platform_data
== NULL
) {
944 dev_err(&pdev
->dev
, "no platform data supplied\n");
947 data
->pdata
= pdev
->dev
.platform_data
;
948 data
->supply_uv
= data
->pdata
->supply_mv
* 1000;
949 if (data
->pdata
->checksum
)
950 data
->checksumming
= true;
951 if (data
->pdata
->no_otp_reload
)
952 status
|= SHT15_STATUS_NO_OTP_RELOAD
;
953 if (data
->pdata
->low_resolution
)
954 status
|= SHT15_STATUS_LOW_RESOLUTION
;
957 * If a regulator is available,
958 * query what the supply voltage actually is!
960 data
->reg
= devm_regulator_get(data
->dev
, "vcc");
961 if (!IS_ERR(data
->reg
)) {
964 voltage
= regulator_get_voltage(data
->reg
);
966 data
->supply_uv
= voltage
;
968 regulator_enable(data
->reg
);
970 * Setup a notifier block to update this if another device
971 * causes the voltage to change
973 data
->nb
.notifier_call
= &sht15_invalidate_voltage
;
974 ret
= regulator_register_notifier(data
->reg
, &data
->nb
);
977 "regulator notifier request failed\n");
978 regulator_disable(data
->reg
);
983 /* Try requesting the GPIOs */
984 ret
= devm_gpio_request_one(&pdev
->dev
, data
->pdata
->gpio_sck
,
985 GPIOF_OUT_INIT_LOW
, "SHT15 sck");
987 dev_err(&pdev
->dev
, "clock line GPIO request failed\n");
988 goto err_release_reg
;
991 ret
= devm_gpio_request(&pdev
->dev
, data
->pdata
->gpio_data
,
994 dev_err(&pdev
->dev
, "data line GPIO request failed\n");
995 goto err_release_reg
;
998 ret
= devm_request_irq(&pdev
->dev
, gpio_to_irq(data
->pdata
->gpio_data
),
999 sht15_interrupt_fired
,
1000 IRQF_TRIGGER_FALLING
,
1004 dev_err(&pdev
->dev
, "failed to get irq for data line\n");
1005 goto err_release_reg
;
1007 disable_irq_nosync(gpio_to_irq(data
->pdata
->gpio_data
));
1008 ret
= sht15_connection_reset(data
);
1010 goto err_release_reg
;
1011 ret
= sht15_soft_reset(data
);
1013 goto err_release_reg
;
1015 /* write status with platform data options */
1017 ret
= sht15_send_status(data
, status
);
1019 goto err_release_reg
;
1022 ret
= sysfs_create_group(&pdev
->dev
.kobj
, &sht15_attr_group
);
1024 dev_err(&pdev
->dev
, "sysfs create failed\n");
1025 goto err_release_reg
;
1028 data
->hwmon_dev
= hwmon_device_register(data
->dev
);
1029 if (IS_ERR(data
->hwmon_dev
)) {
1030 ret
= PTR_ERR(data
->hwmon_dev
);
1031 goto err_release_sysfs_group
;
1036 err_release_sysfs_group
:
1037 sysfs_remove_group(&pdev
->dev
.kobj
, &sht15_attr_group
);
1039 if (!IS_ERR(data
->reg
)) {
1040 regulator_unregister_notifier(data
->reg
, &data
->nb
);
1041 regulator_disable(data
->reg
);
1046 static int sht15_remove(struct platform_device
*pdev
)
1048 struct sht15_data
*data
= platform_get_drvdata(pdev
);
1051 * Make sure any reads from the device are done and
1052 * prevent new ones beginning
1054 mutex_lock(&data
->read_lock
);
1055 if (sht15_soft_reset(data
)) {
1056 mutex_unlock(&data
->read_lock
);
1059 hwmon_device_unregister(data
->hwmon_dev
);
1060 sysfs_remove_group(&pdev
->dev
.kobj
, &sht15_attr_group
);
1061 if (!IS_ERR(data
->reg
)) {
1062 regulator_unregister_notifier(data
->reg
, &data
->nb
);
1063 regulator_disable(data
->reg
);
1066 mutex_unlock(&data
->read_lock
);
1071 static struct platform_device_id sht15_device_ids
[] = {
1079 MODULE_DEVICE_TABLE(platform
, sht15_device_ids
);
1081 static struct platform_driver sht15_driver
= {
1084 .owner
= THIS_MODULE
,
1086 .probe
= sht15_probe
,
1087 .remove
= sht15_remove
,
1088 .id_table
= sht15_device_ids
,
1090 module_platform_driver(sht15_driver
);
1092 MODULE_LICENSE("GPL");
1093 MODULE_DESCRIPTION("Sensirion SHT15 temperature and humidity sensor driver");