Loading...
1/* Sensirion SHT3x-DIS humidity and temperature sensor driver.
2 * The SHT3x comes in many different versions, this driver is for the
3 * I2C version only.
4 *
5 * Copyright (C) 2016 Sensirion AG, Switzerland
6 * Author: David Frey <david.frey@sensirion.com>
7 * Author: Pascal Sachs <pascal.sachs@sensirion.com>
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 */
20
21#include <asm/page.h>
22#include <linux/crc8.h>
23#include <linux/delay.h>
24#include <linux/err.h>
25#include <linux/hwmon.h>
26#include <linux/hwmon-sysfs.h>
27#include <linux/i2c.h>
28#include <linux/init.h>
29#include <linux/kernel.h>
30#include <linux/module.h>
31#include <linux/slab.h>
32#include <linux/jiffies.h>
33#include <linux/platform_data/sht3x.h>
34
35/* commands (high precision mode) */
36static const unsigned char sht3x_cmd_measure_blocking_hpm[] = { 0x2c, 0x06 };
37static const unsigned char sht3x_cmd_measure_nonblocking_hpm[] = { 0x24, 0x00 };
38
39/* commands (low power mode) */
40static const unsigned char sht3x_cmd_measure_blocking_lpm[] = { 0x2c, 0x10 };
41static const unsigned char sht3x_cmd_measure_nonblocking_lpm[] = { 0x24, 0x16 };
42
43/* commands for periodic mode */
44static const unsigned char sht3x_cmd_measure_periodic_mode[] = { 0xe0, 0x00 };
45static const unsigned char sht3x_cmd_break[] = { 0x30, 0x93 };
46
47/* commands for heater control */
48static const unsigned char sht3x_cmd_heater_on[] = { 0x30, 0x6d };
49static const unsigned char sht3x_cmd_heater_off[] = { 0x30, 0x66 };
50
51/* other commands */
52static const unsigned char sht3x_cmd_read_status_reg[] = { 0xf3, 0x2d };
53static const unsigned char sht3x_cmd_clear_status_reg[] = { 0x30, 0x41 };
54
55/* delays for non-blocking i2c commands, both in us */
56#define SHT3X_NONBLOCKING_WAIT_TIME_HPM 15000
57#define SHT3X_NONBLOCKING_WAIT_TIME_LPM 4000
58
59#define SHT3X_WORD_LEN 2
60#define SHT3X_CMD_LENGTH 2
61#define SHT3X_CRC8_LEN 1
62#define SHT3X_RESPONSE_LENGTH 6
63#define SHT3X_CRC8_POLYNOMIAL 0x31
64#define SHT3X_CRC8_INIT 0xFF
65#define SHT3X_MIN_TEMPERATURE -45000
66#define SHT3X_MAX_TEMPERATURE 130000
67#define SHT3X_MIN_HUMIDITY 0
68#define SHT3X_MAX_HUMIDITY 100000
69
70enum sht3x_chips {
71 sht3x,
72 sts3x,
73};
74
75enum sht3x_limits {
76 limit_max = 0,
77 limit_max_hyst,
78 limit_min,
79 limit_min_hyst,
80};
81
82DECLARE_CRC8_TABLE(sht3x_crc8_table);
83
84/* periodic measure commands (high precision mode) */
85static const char periodic_measure_commands_hpm[][SHT3X_CMD_LENGTH] = {
86 /* 0.5 measurements per second */
87 {0x20, 0x32},
88 /* 1 measurements per second */
89 {0x21, 0x30},
90 /* 2 measurements per second */
91 {0x22, 0x36},
92 /* 4 measurements per second */
93 {0x23, 0x34},
94 /* 10 measurements per second */
95 {0x27, 0x37},
96};
97
98/* periodic measure commands (low power mode) */
99static const char periodic_measure_commands_lpm[][SHT3X_CMD_LENGTH] = {
100 /* 0.5 measurements per second */
101 {0x20, 0x2f},
102 /* 1 measurements per second */
103 {0x21, 0x2d},
104 /* 2 measurements per second */
105 {0x22, 0x2b},
106 /* 4 measurements per second */
107 {0x23, 0x29},
108 /* 10 measurements per second */
109 {0x27, 0x2a},
110};
111
112struct sht3x_limit_commands {
113 const char read_command[SHT3X_CMD_LENGTH];
114 const char write_command[SHT3X_CMD_LENGTH];
115};
116
117static const struct sht3x_limit_commands limit_commands[] = {
118 /* temp1_max, humidity1_max */
119 [limit_max] = { {0xe1, 0x1f}, {0x61, 0x1d} },
120 /* temp_1_max_hyst, humidity1_max_hyst */
121 [limit_max_hyst] = { {0xe1, 0x14}, {0x61, 0x16} },
122 /* temp1_min, humidity1_min */
123 [limit_min] = { {0xe1, 0x02}, {0x61, 0x00} },
124 /* temp_1_min_hyst, humidity1_min_hyst */
125 [limit_min_hyst] = { {0xe1, 0x09}, {0x61, 0x0B} },
126};
127
128#define SHT3X_NUM_LIMIT_CMD ARRAY_SIZE(limit_commands)
129
130static const u16 mode_to_update_interval[] = {
131 0,
132 2000,
133 1000,
134 500,
135 250,
136 100,
137};
138
139struct sht3x_data {
140 struct i2c_client *client;
141 struct mutex i2c_lock; /* lock for sending i2c commands */
142 struct mutex data_lock; /* lock for updating driver data */
143
144 u8 mode;
145 const unsigned char *command;
146 u32 wait_time; /* in us*/
147 unsigned long last_update; /* last update in periodic mode*/
148
149 struct sht3x_platform_data setup;
150
151 /*
152 * cached values for temperature and humidity and limits
153 * the limits arrays have the following order:
154 * max, max_hyst, min, min_hyst
155 */
156 int temperature;
157 int temperature_limits[SHT3X_NUM_LIMIT_CMD];
158 u32 humidity;
159 u32 humidity_limits[SHT3X_NUM_LIMIT_CMD];
160};
161
162static u8 get_mode_from_update_interval(u16 value)
163{
164 size_t index;
165 u8 number_of_modes = ARRAY_SIZE(mode_to_update_interval);
166
167 if (value == 0)
168 return 0;
169
170 /* find next faster update interval */
171 for (index = 1; index < number_of_modes; index++) {
172 if (mode_to_update_interval[index] <= value)
173 return index;
174 }
175
176 return number_of_modes - 1;
177}
178
179static int sht3x_read_from_command(struct i2c_client *client,
180 struct sht3x_data *data,
181 const char *command,
182 char *buf, int length, u32 wait_time)
183{
184 int ret;
185
186 mutex_lock(&data->i2c_lock);
187 ret = i2c_master_send(client, command, SHT3X_CMD_LENGTH);
188
189 if (ret != SHT3X_CMD_LENGTH) {
190 ret = ret < 0 ? ret : -EIO;
191 goto out;
192 }
193
194 if (wait_time)
195 usleep_range(wait_time, wait_time + 1000);
196
197 ret = i2c_master_recv(client, buf, length);
198 if (ret != length) {
199 ret = ret < 0 ? ret : -EIO;
200 goto out;
201 }
202
203 ret = 0;
204out:
205 mutex_unlock(&data->i2c_lock);
206 return ret;
207}
208
209static int sht3x_extract_temperature(u16 raw)
210{
211 /*
212 * From datasheet:
213 * T = -45 + 175 * ST / 2^16
214 * Adapted for integer fixed point (3 digit) arithmetic.
215 */
216 return ((21875 * (int)raw) >> 13) - 45000;
217}
218
219static u32 sht3x_extract_humidity(u16 raw)
220{
221 /*
222 * From datasheet:
223 * RH = 100 * SRH / 2^16
224 * Adapted for integer fixed point (3 digit) arithmetic.
225 */
226 return (12500 * (u32)raw) >> 13;
227}
228
229static struct sht3x_data *sht3x_update_client(struct device *dev)
230{
231 struct sht3x_data *data = dev_get_drvdata(dev);
232 struct i2c_client *client = data->client;
233 u16 interval_ms = mode_to_update_interval[data->mode];
234 unsigned long interval_jiffies = msecs_to_jiffies(interval_ms);
235 unsigned char buf[SHT3X_RESPONSE_LENGTH];
236 u16 val;
237 int ret = 0;
238
239 mutex_lock(&data->data_lock);
240 /*
241 * Only update cached readings once per update interval in periodic
242 * mode. In single shot mode the sensor measures values on demand, so
243 * every time the sysfs interface is called, a measurement is triggered.
244 * In periodic mode however, the measurement process is handled
245 * internally by the sensor and reading out sensor values only makes
246 * sense if a new reading is available.
247 */
248 if (time_after(jiffies, data->last_update + interval_jiffies)) {
249 ret = sht3x_read_from_command(client, data, data->command, buf,
250 sizeof(buf), data->wait_time);
251 if (ret)
252 goto out;
253
254 val = be16_to_cpup((__be16 *)buf);
255 data->temperature = sht3x_extract_temperature(val);
256 val = be16_to_cpup((__be16 *)(buf + 3));
257 data->humidity = sht3x_extract_humidity(val);
258 data->last_update = jiffies;
259 }
260
261out:
262 mutex_unlock(&data->data_lock);
263 if (ret)
264 return ERR_PTR(ret);
265
266 return data;
267}
268
269/* sysfs attributes */
270static ssize_t temp1_input_show(struct device *dev,
271 struct device_attribute *attr, char *buf)
272{
273 struct sht3x_data *data = sht3x_update_client(dev);
274
275 if (IS_ERR(data))
276 return PTR_ERR(data);
277
278 return sprintf(buf, "%d\n", data->temperature);
279}
280
281static ssize_t humidity1_input_show(struct device *dev,
282 struct device_attribute *attr, char *buf)
283{
284 struct sht3x_data *data = sht3x_update_client(dev);
285
286 if (IS_ERR(data))
287 return PTR_ERR(data);
288
289 return sprintf(buf, "%u\n", data->humidity);
290}
291
292/*
293 * limits_update must only be called from probe or with data_lock held
294 */
295static int limits_update(struct sht3x_data *data)
296{
297 int ret;
298 u8 index;
299 int temperature;
300 u32 humidity;
301 u16 raw;
302 char buffer[SHT3X_RESPONSE_LENGTH];
303 const struct sht3x_limit_commands *commands;
304 struct i2c_client *client = data->client;
305
306 for (index = 0; index < SHT3X_NUM_LIMIT_CMD; index++) {
307 commands = &limit_commands[index];
308 ret = sht3x_read_from_command(client, data,
309 commands->read_command, buffer,
310 SHT3X_RESPONSE_LENGTH, 0);
311
312 if (ret)
313 return ret;
314
315 raw = be16_to_cpup((__be16 *)buffer);
316 temperature = sht3x_extract_temperature((raw & 0x01ff) << 7);
317 humidity = sht3x_extract_humidity(raw & 0xfe00);
318 data->temperature_limits[index] = temperature;
319 data->humidity_limits[index] = humidity;
320 }
321
322 return ret;
323}
324
325static ssize_t temp1_limit_show(struct device *dev,
326 struct device_attribute *attr,
327 char *buf)
328{
329 struct sht3x_data *data = dev_get_drvdata(dev);
330 u8 index = to_sensor_dev_attr(attr)->index;
331 int temperature_limit = data->temperature_limits[index];
332
333 return scnprintf(buf, PAGE_SIZE, "%d\n", temperature_limit);
334}
335
336static ssize_t humidity1_limit_show(struct device *dev,
337 struct device_attribute *attr,
338 char *buf)
339{
340 struct sht3x_data *data = dev_get_drvdata(dev);
341 u8 index = to_sensor_dev_attr(attr)->index;
342 u32 humidity_limit = data->humidity_limits[index];
343
344 return scnprintf(buf, PAGE_SIZE, "%u\n", humidity_limit);
345}
346
347/*
348 * limit_store must only be called with data_lock held
349 */
350static size_t limit_store(struct device *dev,
351 size_t count,
352 u8 index,
353 int temperature,
354 u32 humidity)
355{
356 char buffer[SHT3X_CMD_LENGTH + SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
357 char *position = buffer;
358 int ret;
359 u16 raw;
360 struct sht3x_data *data = dev_get_drvdata(dev);
361 struct i2c_client *client = data->client;
362 const struct sht3x_limit_commands *commands;
363
364 commands = &limit_commands[index];
365
366 memcpy(position, commands->write_command, SHT3X_CMD_LENGTH);
367 position += SHT3X_CMD_LENGTH;
368 /*
369 * ST = (T + 45) / 175 * 2^16
370 * SRH = RH / 100 * 2^16
371 * adapted for fixed point arithmetic and packed the same as
372 * in limit_show()
373 */
374 raw = ((u32)(temperature + 45000) * 24543) >> (16 + 7);
375 raw |= ((humidity * 42950) >> 16) & 0xfe00;
376
377 *((__be16 *)position) = cpu_to_be16(raw);
378 position += SHT3X_WORD_LEN;
379 *position = crc8(sht3x_crc8_table,
380 position - SHT3X_WORD_LEN,
381 SHT3X_WORD_LEN,
382 SHT3X_CRC8_INIT);
383
384 mutex_lock(&data->i2c_lock);
385 ret = i2c_master_send(client, buffer, sizeof(buffer));
386 mutex_unlock(&data->i2c_lock);
387
388 if (ret != sizeof(buffer))
389 return ret < 0 ? ret : -EIO;
390
391 data->temperature_limits[index] = temperature;
392 data->humidity_limits[index] = humidity;
393 return count;
394}
395
396static ssize_t temp1_limit_store(struct device *dev,
397 struct device_attribute *attr,
398 const char *buf,
399 size_t count)
400{
401 int temperature;
402 int ret;
403 struct sht3x_data *data = dev_get_drvdata(dev);
404 u8 index = to_sensor_dev_attr(attr)->index;
405
406 ret = kstrtoint(buf, 0, &temperature);
407 if (ret)
408 return ret;
409
410 temperature = clamp_val(temperature, SHT3X_MIN_TEMPERATURE,
411 SHT3X_MAX_TEMPERATURE);
412 mutex_lock(&data->data_lock);
413 ret = limit_store(dev, count, index, temperature,
414 data->humidity_limits[index]);
415 mutex_unlock(&data->data_lock);
416
417 return ret;
418}
419
420static ssize_t humidity1_limit_store(struct device *dev,
421 struct device_attribute *attr,
422 const char *buf,
423 size_t count)
424{
425 u32 humidity;
426 int ret;
427 struct sht3x_data *data = dev_get_drvdata(dev);
428 u8 index = to_sensor_dev_attr(attr)->index;
429
430 ret = kstrtou32(buf, 0, &humidity);
431 if (ret)
432 return ret;
433
434 humidity = clamp_val(humidity, SHT3X_MIN_HUMIDITY, SHT3X_MAX_HUMIDITY);
435 mutex_lock(&data->data_lock);
436 ret = limit_store(dev, count, index, data->temperature_limits[index],
437 humidity);
438 mutex_unlock(&data->data_lock);
439
440 return ret;
441}
442
443static void sht3x_select_command(struct sht3x_data *data)
444{
445 /*
446 * In blocking mode (clock stretching mode) the I2C bus
447 * is blocked for other traffic, thus the call to i2c_master_recv()
448 * will wait until the data is ready. For non blocking mode, we
449 * have to wait ourselves.
450 */
451 if (data->mode > 0) {
452 data->command = sht3x_cmd_measure_periodic_mode;
453 data->wait_time = 0;
454 } else if (data->setup.blocking_io) {
455 data->command = data->setup.high_precision ?
456 sht3x_cmd_measure_blocking_hpm :
457 sht3x_cmd_measure_blocking_lpm;
458 data->wait_time = 0;
459 } else {
460 if (data->setup.high_precision) {
461 data->command = sht3x_cmd_measure_nonblocking_hpm;
462 data->wait_time = SHT3X_NONBLOCKING_WAIT_TIME_HPM;
463 } else {
464 data->command = sht3x_cmd_measure_nonblocking_lpm;
465 data->wait_time = SHT3X_NONBLOCKING_WAIT_TIME_LPM;
466 }
467 }
468}
469
470static int status_register_read(struct device *dev,
471 struct device_attribute *attr,
472 char *buffer, int length)
473{
474 int ret;
475 struct sht3x_data *data = dev_get_drvdata(dev);
476 struct i2c_client *client = data->client;
477
478 ret = sht3x_read_from_command(client, data, sht3x_cmd_read_status_reg,
479 buffer, length, 0);
480
481 return ret;
482}
483
484static ssize_t temp1_alarm_show(struct device *dev,
485 struct device_attribute *attr,
486 char *buf)
487{
488 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
489 int ret;
490
491 ret = status_register_read(dev, attr, buffer,
492 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
493 if (ret)
494 return ret;
495
496 return scnprintf(buf, PAGE_SIZE, "%d\n", !!(buffer[0] & 0x04));
497}
498
499static ssize_t humidity1_alarm_show(struct device *dev,
500 struct device_attribute *attr,
501 char *buf)
502{
503 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
504 int ret;
505
506 ret = status_register_read(dev, attr, buffer,
507 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
508 if (ret)
509 return ret;
510
511 return scnprintf(buf, PAGE_SIZE, "%d\n", !!(buffer[0] & 0x08));
512}
513
514static ssize_t heater_enable_show(struct device *dev,
515 struct device_attribute *attr,
516 char *buf)
517{
518 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
519 int ret;
520
521 ret = status_register_read(dev, attr, buffer,
522 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
523 if (ret)
524 return ret;
525
526 return scnprintf(buf, PAGE_SIZE, "%d\n", !!(buffer[0] & 0x20));
527}
528
529static ssize_t heater_enable_store(struct device *dev,
530 struct device_attribute *attr,
531 const char *buf,
532 size_t count)
533{
534 struct sht3x_data *data = dev_get_drvdata(dev);
535 struct i2c_client *client = data->client;
536 int ret;
537 bool status;
538
539 ret = kstrtobool(buf, &status);
540 if (ret)
541 return ret;
542
543 mutex_lock(&data->i2c_lock);
544
545 if (status)
546 ret = i2c_master_send(client, (char *)&sht3x_cmd_heater_on,
547 SHT3X_CMD_LENGTH);
548 else
549 ret = i2c_master_send(client, (char *)&sht3x_cmd_heater_off,
550 SHT3X_CMD_LENGTH);
551
552 mutex_unlock(&data->i2c_lock);
553
554 return ret;
555}
556
557static ssize_t update_interval_show(struct device *dev,
558 struct device_attribute *attr,
559 char *buf)
560{
561 struct sht3x_data *data = dev_get_drvdata(dev);
562
563 return scnprintf(buf, PAGE_SIZE, "%u\n",
564 mode_to_update_interval[data->mode]);
565}
566
567static ssize_t update_interval_store(struct device *dev,
568 struct device_attribute *attr,
569 const char *buf,
570 size_t count)
571{
572 u16 update_interval;
573 u8 mode;
574 int ret;
575 const char *command;
576 struct sht3x_data *data = dev_get_drvdata(dev);
577 struct i2c_client *client = data->client;
578
579 ret = kstrtou16(buf, 0, &update_interval);
580 if (ret)
581 return ret;
582
583 mode = get_mode_from_update_interval(update_interval);
584
585 mutex_lock(&data->data_lock);
586 /* mode did not change */
587 if (mode == data->mode) {
588 mutex_unlock(&data->data_lock);
589 return count;
590 }
591
592 mutex_lock(&data->i2c_lock);
593 /*
594 * Abort periodic measure mode.
595 * To do any changes to the configuration while in periodic mode, we
596 * have to send a break command to the sensor, which then falls back
597 * to single shot (mode = 0).
598 */
599 if (data->mode > 0) {
600 ret = i2c_master_send(client, sht3x_cmd_break,
601 SHT3X_CMD_LENGTH);
602 if (ret != SHT3X_CMD_LENGTH)
603 goto out;
604 data->mode = 0;
605 }
606
607 if (mode > 0) {
608 if (data->setup.high_precision)
609 command = periodic_measure_commands_hpm[mode - 1];
610 else
611 command = periodic_measure_commands_lpm[mode - 1];
612
613 /* select mode */
614 ret = i2c_master_send(client, command, SHT3X_CMD_LENGTH);
615 if (ret != SHT3X_CMD_LENGTH)
616 goto out;
617 }
618
619 /* select mode and command */
620 data->mode = mode;
621 sht3x_select_command(data);
622
623out:
624 mutex_unlock(&data->i2c_lock);
625 mutex_unlock(&data->data_lock);
626 if (ret != SHT3X_CMD_LENGTH)
627 return ret < 0 ? ret : -EIO;
628
629 return count;
630}
631
632static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, temp1_input_show, NULL, 0);
633static SENSOR_DEVICE_ATTR(humidity1_input, S_IRUGO, humidity1_input_show,
634 NULL, 0);
635static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO | S_IWUSR,
636 temp1_limit_show, temp1_limit_store,
637 limit_max);
638static SENSOR_DEVICE_ATTR(humidity1_max, S_IRUGO | S_IWUSR,
639 humidity1_limit_show, humidity1_limit_store,
640 limit_max);
641static SENSOR_DEVICE_ATTR(temp1_max_hyst, S_IRUGO | S_IWUSR,
642 temp1_limit_show, temp1_limit_store,
643 limit_max_hyst);
644static SENSOR_DEVICE_ATTR(humidity1_max_hyst, S_IRUGO | S_IWUSR,
645 humidity1_limit_show, humidity1_limit_store,
646 limit_max_hyst);
647static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO | S_IWUSR,
648 temp1_limit_show, temp1_limit_store,
649 limit_min);
650static SENSOR_DEVICE_ATTR(humidity1_min, S_IRUGO | S_IWUSR,
651 humidity1_limit_show, humidity1_limit_store,
652 limit_min);
653static SENSOR_DEVICE_ATTR(temp1_min_hyst, S_IRUGO | S_IWUSR,
654 temp1_limit_show, temp1_limit_store,
655 limit_min_hyst);
656static SENSOR_DEVICE_ATTR(humidity1_min_hyst, S_IRUGO | S_IWUSR,
657 humidity1_limit_show, humidity1_limit_store,
658 limit_min_hyst);
659static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, temp1_alarm_show, NULL, 0);
660static SENSOR_DEVICE_ATTR(humidity1_alarm, S_IRUGO, humidity1_alarm_show,
661 NULL, 0);
662static SENSOR_DEVICE_ATTR(heater_enable, S_IRUGO | S_IWUSR,
663 heater_enable_show, heater_enable_store, 0);
664static SENSOR_DEVICE_ATTR(update_interval, S_IRUGO | S_IWUSR,
665 update_interval_show, update_interval_store, 0);
666
667static struct attribute *sht3x_attrs[] = {
668 &sensor_dev_attr_temp1_input.dev_attr.attr,
669 &sensor_dev_attr_humidity1_input.dev_attr.attr,
670 &sensor_dev_attr_temp1_max.dev_attr.attr,
671 &sensor_dev_attr_temp1_max_hyst.dev_attr.attr,
672 &sensor_dev_attr_humidity1_max.dev_attr.attr,
673 &sensor_dev_attr_humidity1_max_hyst.dev_attr.attr,
674 &sensor_dev_attr_temp1_min.dev_attr.attr,
675 &sensor_dev_attr_temp1_min_hyst.dev_attr.attr,
676 &sensor_dev_attr_humidity1_min.dev_attr.attr,
677 &sensor_dev_attr_humidity1_min_hyst.dev_attr.attr,
678 &sensor_dev_attr_temp1_alarm.dev_attr.attr,
679 &sensor_dev_attr_humidity1_alarm.dev_attr.attr,
680 &sensor_dev_attr_heater_enable.dev_attr.attr,
681 &sensor_dev_attr_update_interval.dev_attr.attr,
682 NULL
683};
684
685static struct attribute *sts3x_attrs[] = {
686 &sensor_dev_attr_temp1_input.dev_attr.attr,
687 NULL
688};
689
690ATTRIBUTE_GROUPS(sht3x);
691ATTRIBUTE_GROUPS(sts3x);
692
693static int sht3x_probe(struct i2c_client *client,
694 const struct i2c_device_id *id)
695{
696 int ret;
697 struct sht3x_data *data;
698 struct device *hwmon_dev;
699 struct i2c_adapter *adap = client->adapter;
700 struct device *dev = &client->dev;
701 const struct attribute_group **attribute_groups;
702
703 /*
704 * we require full i2c support since the sht3x uses multi-byte read and
705 * writes as well as multi-byte commands which are not supported by
706 * the smbus protocol
707 */
708 if (!i2c_check_functionality(adap, I2C_FUNC_I2C))
709 return -ENODEV;
710
711 ret = i2c_master_send(client, sht3x_cmd_clear_status_reg,
712 SHT3X_CMD_LENGTH);
713 if (ret != SHT3X_CMD_LENGTH)
714 return ret < 0 ? ret : -ENODEV;
715
716 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
717 if (!data)
718 return -ENOMEM;
719
720 data->setup.blocking_io = false;
721 data->setup.high_precision = true;
722 data->mode = 0;
723 data->last_update = jiffies - msecs_to_jiffies(3000);
724 data->client = client;
725 crc8_populate_msb(sht3x_crc8_table, SHT3X_CRC8_POLYNOMIAL);
726
727 if (client->dev.platform_data)
728 data->setup = *(struct sht3x_platform_data *)dev->platform_data;
729
730 sht3x_select_command(data);
731
732 mutex_init(&data->i2c_lock);
733 mutex_init(&data->data_lock);
734
735 ret = limits_update(data);
736 if (ret)
737 return ret;
738
739 if (id->driver_data == sts3x)
740 attribute_groups = sts3x_groups;
741 else
742 attribute_groups = sht3x_groups;
743
744 hwmon_dev = devm_hwmon_device_register_with_groups(dev,
745 client->name,
746 data,
747 attribute_groups);
748
749 if (IS_ERR(hwmon_dev))
750 dev_dbg(dev, "unable to register hwmon device\n");
751
752 return PTR_ERR_OR_ZERO(hwmon_dev);
753}
754
755/* device ID table */
756static const struct i2c_device_id sht3x_ids[] = {
757 {"sht3x", sht3x},
758 {"sts3x", sts3x},
759 {}
760};
761
762MODULE_DEVICE_TABLE(i2c, sht3x_ids);
763
764static struct i2c_driver sht3x_i2c_driver = {
765 .driver.name = "sht3x",
766 .probe = sht3x_probe,
767 .id_table = sht3x_ids,
768};
769
770module_i2c_driver(sht3x_i2c_driver);
771
772MODULE_AUTHOR("David Frey <david.frey@sensirion.com>");
773MODULE_AUTHOR("Pascal Sachs <pascal.sachs@sensirion.com>");
774MODULE_DESCRIPTION("Sensirion SHT3x humidity and temperature sensor driver");
775MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/* Sensirion SHT3x-DIS humidity and temperature sensor driver.
3 * The SHT3x comes in many different versions, this driver is for the
4 * I2C version only.
5 *
6 * Copyright (C) 2016 Sensirion AG, Switzerland
7 * Author: David Frey <david.frey@sensirion.com>
8 * Author: Pascal Sachs <pascal.sachs@sensirion.com>
9 */
10
11#include <asm/page.h>
12#include <linux/crc8.h>
13#include <linux/debugfs.h>
14#include <linux/delay.h>
15#include <linux/err.h>
16#include <linux/hwmon.h>
17#include <linux/hwmon-sysfs.h>
18#include <linux/i2c.h>
19#include <linux/init.h>
20#include <linux/kernel.h>
21#include <linux/module.h>
22#include <linux/slab.h>
23#include <linux/jiffies.h>
24
25/* commands (high repeatability mode) */
26static const unsigned char sht3x_cmd_measure_single_hpm[] = { 0x24, 0x00 };
27
28/* commands (medium repeatability mode) */
29static const unsigned char sht3x_cmd_measure_single_mpm[] = { 0x24, 0x0b };
30
31/* commands (low repeatability mode) */
32static const unsigned char sht3x_cmd_measure_single_lpm[] = { 0x24, 0x16 };
33
34/* commands for periodic mode */
35static const unsigned char sht3x_cmd_measure_periodic_mode[] = { 0xe0, 0x00 };
36static const unsigned char sht3x_cmd_break[] = { 0x30, 0x93 };
37
38/* commands for heater control */
39static const unsigned char sht3x_cmd_heater_on[] = { 0x30, 0x6d };
40static const unsigned char sht3x_cmd_heater_off[] = { 0x30, 0x66 };
41
42/* other commands */
43static const unsigned char sht3x_cmd_read_status_reg[] = { 0xf3, 0x2d };
44static const unsigned char sht3x_cmd_clear_status_reg[] = { 0x30, 0x41 };
45static const unsigned char sht3x_cmd_read_serial_number[] = { 0x37, 0x80 };
46
47static struct dentry *debugfs;
48
49/* delays for single-shot mode i2c commands, both in us */
50#define SHT3X_SINGLE_WAIT_TIME_HPM 15000
51#define SHT3X_SINGLE_WAIT_TIME_MPM 6000
52#define SHT3X_SINGLE_WAIT_TIME_LPM 4000
53
54#define SHT3X_WORD_LEN 2
55#define SHT3X_CMD_LENGTH 2
56#define SHT3X_CRC8_LEN 1
57#define SHT3X_RESPONSE_LENGTH 6
58#define SHT3X_CRC8_POLYNOMIAL 0x31
59#define SHT3X_CRC8_INIT 0xFF
60#define SHT3X_MIN_TEMPERATURE -45000
61#define SHT3X_MAX_TEMPERATURE 130000
62#define SHT3X_MIN_HUMIDITY 0
63#define SHT3X_MAX_HUMIDITY 100000
64
65enum sht3x_chips {
66 sht3x,
67 sts3x,
68};
69
70enum sht3x_limits {
71 limit_max = 0,
72 limit_max_hyst,
73 limit_min,
74 limit_min_hyst,
75};
76
77enum sht3x_repeatability {
78 low_repeatability,
79 medium_repeatability,
80 high_repeatability,
81};
82
83DECLARE_CRC8_TABLE(sht3x_crc8_table);
84
85/* periodic measure commands (high repeatability mode) */
86static const char periodic_measure_commands_hpm[][SHT3X_CMD_LENGTH] = {
87 /* 0.5 measurements per second */
88 {0x20, 0x32},
89 /* 1 measurements per second */
90 {0x21, 0x30},
91 /* 2 measurements per second */
92 {0x22, 0x36},
93 /* 4 measurements per second */
94 {0x23, 0x34},
95 /* 10 measurements per second */
96 {0x27, 0x37},
97};
98
99/* periodic measure commands (medium repeatability) */
100static const char periodic_measure_commands_mpm[][SHT3X_CMD_LENGTH] = {
101 /* 0.5 measurements per second */
102 {0x20, 0x24},
103 /* 1 measurements per second */
104 {0x21, 0x26},
105 /* 2 measurements per second */
106 {0x22, 0x20},
107 /* 4 measurements per second */
108 {0x23, 0x22},
109 /* 10 measurements per second */
110 {0x27, 0x21},
111};
112
113/* periodic measure commands (low repeatability mode) */
114static const char periodic_measure_commands_lpm[][SHT3X_CMD_LENGTH] = {
115 /* 0.5 measurements per second */
116 {0x20, 0x2f},
117 /* 1 measurements per second */
118 {0x21, 0x2d},
119 /* 2 measurements per second */
120 {0x22, 0x2b},
121 /* 4 measurements per second */
122 {0x23, 0x29},
123 /* 10 measurements per second */
124 {0x27, 0x2a},
125};
126
127struct sht3x_limit_commands {
128 const char read_command[SHT3X_CMD_LENGTH];
129 const char write_command[SHT3X_CMD_LENGTH];
130};
131
132static const struct sht3x_limit_commands limit_commands[] = {
133 /* temp1_max, humidity1_max */
134 [limit_max] = { {0xe1, 0x1f}, {0x61, 0x1d} },
135 /* temp_1_max_hyst, humidity1_max_hyst */
136 [limit_max_hyst] = { {0xe1, 0x14}, {0x61, 0x16} },
137 /* temp1_min, humidity1_min */
138 [limit_min] = { {0xe1, 0x02}, {0x61, 0x00} },
139 /* temp_1_min_hyst, humidity1_min_hyst */
140 [limit_min_hyst] = { {0xe1, 0x09}, {0x61, 0x0B} },
141};
142
143#define SHT3X_NUM_LIMIT_CMD ARRAY_SIZE(limit_commands)
144
145static const u16 mode_to_update_interval[] = {
146 0,
147 2000,
148 1000,
149 500,
150 250,
151 100,
152};
153
154static const struct hwmon_channel_info * const sht3x_channel_info[] = {
155 HWMON_CHANNEL_INFO(chip, HWMON_C_UPDATE_INTERVAL),
156 HWMON_CHANNEL_INFO(temp, HWMON_T_INPUT | HWMON_T_MIN |
157 HWMON_T_MIN_HYST | HWMON_T_MAX |
158 HWMON_T_MAX_HYST | HWMON_T_ALARM),
159 HWMON_CHANNEL_INFO(humidity, HWMON_H_INPUT | HWMON_H_MIN |
160 HWMON_H_MIN_HYST | HWMON_H_MAX |
161 HWMON_H_MAX_HYST | HWMON_H_ALARM),
162 NULL,
163};
164
165struct sht3x_data {
166 struct i2c_client *client;
167 enum sht3x_chips chip_id;
168 struct mutex i2c_lock; /* lock for sending i2c commands */
169 struct mutex data_lock; /* lock for updating driver data */
170 struct dentry *sensor_dir;
171
172 u8 mode;
173 const unsigned char *command;
174 u32 wait_time; /* in us*/
175 unsigned long last_update; /* last update in periodic mode*/
176 enum sht3x_repeatability repeatability;
177 u32 serial_number;
178
179 /*
180 * cached values for temperature and humidity and limits
181 * the limits arrays have the following order:
182 * max, max_hyst, min, min_hyst
183 */
184 int temperature;
185 int temperature_limits[SHT3X_NUM_LIMIT_CMD];
186 u32 humidity;
187 u32 humidity_limits[SHT3X_NUM_LIMIT_CMD];
188};
189
190static u8 get_mode_from_update_interval(u16 value)
191{
192 size_t index;
193 u8 number_of_modes = ARRAY_SIZE(mode_to_update_interval);
194
195 if (value == 0)
196 return 0;
197
198 /* find next faster update interval */
199 for (index = 1; index < number_of_modes; index++) {
200 if (mode_to_update_interval[index] <= value)
201 return index;
202 }
203
204 return number_of_modes - 1;
205}
206
207static int sht3x_read_from_command(struct i2c_client *client,
208 struct sht3x_data *data,
209 const char *command,
210 char *buf, int length, u32 wait_time)
211{
212 int ret;
213
214 mutex_lock(&data->i2c_lock);
215 ret = i2c_master_send(client, command, SHT3X_CMD_LENGTH);
216
217 if (ret != SHT3X_CMD_LENGTH) {
218 ret = ret < 0 ? ret : -EIO;
219 goto out;
220 }
221
222 if (wait_time)
223 usleep_range(wait_time, wait_time + 1000);
224
225 ret = i2c_master_recv(client, buf, length);
226 if (ret != length) {
227 ret = ret < 0 ? ret : -EIO;
228 goto out;
229 }
230
231 ret = 0;
232out:
233 mutex_unlock(&data->i2c_lock);
234 return ret;
235}
236
237static int sht3x_extract_temperature(u16 raw)
238{
239 /*
240 * From datasheet:
241 * T = -45 + 175 * ST / 2^16
242 * Adapted for integer fixed point (3 digit) arithmetic.
243 */
244 return ((21875 * (int)raw) >> 13) - 45000;
245}
246
247static u32 sht3x_extract_humidity(u16 raw)
248{
249 /*
250 * From datasheet:
251 * RH = 100 * SRH / 2^16
252 * Adapted for integer fixed point (3 digit) arithmetic.
253 */
254 return (12500 * (u32)raw) >> 13;
255}
256
257static struct sht3x_data *sht3x_update_client(struct device *dev)
258{
259 struct sht3x_data *data = dev_get_drvdata(dev);
260 struct i2c_client *client = data->client;
261 u16 interval_ms = mode_to_update_interval[data->mode];
262 unsigned long interval_jiffies = msecs_to_jiffies(interval_ms);
263 unsigned char buf[SHT3X_RESPONSE_LENGTH];
264 u16 val;
265 int ret = 0;
266
267 mutex_lock(&data->data_lock);
268 /*
269 * Only update cached readings once per update interval in periodic
270 * mode. In single shot mode the sensor measures values on demand, so
271 * every time the sysfs interface is called, a measurement is triggered.
272 * In periodic mode however, the measurement process is handled
273 * internally by the sensor and reading out sensor values only makes
274 * sense if a new reading is available.
275 */
276 if (time_after(jiffies, data->last_update + interval_jiffies)) {
277 ret = sht3x_read_from_command(client, data, data->command, buf,
278 sizeof(buf), data->wait_time);
279 if (ret)
280 goto out;
281
282 val = be16_to_cpup((__be16 *)buf);
283 data->temperature = sht3x_extract_temperature(val);
284 val = be16_to_cpup((__be16 *)(buf + 3));
285 data->humidity = sht3x_extract_humidity(val);
286 data->last_update = jiffies;
287 }
288
289out:
290 mutex_unlock(&data->data_lock);
291 if (ret)
292 return ERR_PTR(ret);
293
294 return data;
295}
296
297static int temp1_input_read(struct device *dev)
298{
299 struct sht3x_data *data = sht3x_update_client(dev);
300
301 if (IS_ERR(data))
302 return PTR_ERR(data);
303
304 return data->temperature;
305}
306
307static int humidity1_input_read(struct device *dev)
308{
309 struct sht3x_data *data = sht3x_update_client(dev);
310
311 if (IS_ERR(data))
312 return PTR_ERR(data);
313
314 return data->humidity;
315}
316
317/*
318 * limits_update must only be called from probe or with data_lock held
319 */
320static int limits_update(struct sht3x_data *data)
321{
322 int ret;
323 u8 index;
324 int temperature;
325 u32 humidity;
326 u16 raw;
327 char buffer[SHT3X_RESPONSE_LENGTH];
328 const struct sht3x_limit_commands *commands;
329 struct i2c_client *client = data->client;
330
331 for (index = 0; index < SHT3X_NUM_LIMIT_CMD; index++) {
332 commands = &limit_commands[index];
333 ret = sht3x_read_from_command(client, data,
334 commands->read_command, buffer,
335 SHT3X_RESPONSE_LENGTH, 0);
336
337 if (ret)
338 return ret;
339
340 raw = be16_to_cpup((__be16 *)buffer);
341 temperature = sht3x_extract_temperature((raw & 0x01ff) << 7);
342 humidity = sht3x_extract_humidity(raw & 0xfe00);
343 data->temperature_limits[index] = temperature;
344 data->humidity_limits[index] = humidity;
345 }
346
347 return ret;
348}
349
350static int temp1_limit_read(struct device *dev, int index)
351{
352 struct sht3x_data *data = dev_get_drvdata(dev);
353
354 return data->temperature_limits[index];
355}
356
357static int humidity1_limit_read(struct device *dev, int index)
358{
359 struct sht3x_data *data = dev_get_drvdata(dev);
360
361 return data->humidity_limits[index];
362}
363
364/*
365 * limit_write must only be called with data_lock held
366 */
367static size_t limit_write(struct device *dev,
368 u8 index,
369 int temperature,
370 u32 humidity)
371{
372 char buffer[SHT3X_CMD_LENGTH + SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
373 char *position = buffer;
374 int ret;
375 u16 raw;
376 struct sht3x_data *data = dev_get_drvdata(dev);
377 struct i2c_client *client = data->client;
378 const struct sht3x_limit_commands *commands;
379
380 commands = &limit_commands[index];
381
382 memcpy(position, commands->write_command, SHT3X_CMD_LENGTH);
383 position += SHT3X_CMD_LENGTH;
384 /*
385 * ST = (T + 45) / 175 * 2^16
386 * SRH = RH / 100 * 2^16
387 * adapted for fixed point arithmetic and packed the same as
388 * in limit_read()
389 */
390 raw = ((u32)(temperature + 45000) * 24543) >> (16 + 7);
391 raw |= ((humidity * 42950) >> 16) & 0xfe00;
392
393 *((__be16 *)position) = cpu_to_be16(raw);
394 position += SHT3X_WORD_LEN;
395 *position = crc8(sht3x_crc8_table,
396 position - SHT3X_WORD_LEN,
397 SHT3X_WORD_LEN,
398 SHT3X_CRC8_INIT);
399
400 mutex_lock(&data->i2c_lock);
401 ret = i2c_master_send(client, buffer, sizeof(buffer));
402 mutex_unlock(&data->i2c_lock);
403
404 if (ret != sizeof(buffer))
405 return ret < 0 ? ret : -EIO;
406
407 data->temperature_limits[index] = temperature;
408 data->humidity_limits[index] = humidity;
409
410 return 0;
411}
412
413static int temp1_limit_write(struct device *dev, int index, int val)
414{
415 int temperature;
416 int ret;
417 struct sht3x_data *data = dev_get_drvdata(dev);
418
419 temperature = clamp_val(val, SHT3X_MIN_TEMPERATURE,
420 SHT3X_MAX_TEMPERATURE);
421 mutex_lock(&data->data_lock);
422 ret = limit_write(dev, index, temperature,
423 data->humidity_limits[index]);
424 mutex_unlock(&data->data_lock);
425
426 return ret;
427}
428
429static int humidity1_limit_write(struct device *dev, int index, int val)
430{
431 u32 humidity;
432 int ret;
433 struct sht3x_data *data = dev_get_drvdata(dev);
434
435 humidity = clamp_val(val, SHT3X_MIN_HUMIDITY, SHT3X_MAX_HUMIDITY);
436 mutex_lock(&data->data_lock);
437 ret = limit_write(dev, index, data->temperature_limits[index],
438 humidity);
439 mutex_unlock(&data->data_lock);
440
441 return ret;
442}
443
444static void sht3x_select_command(struct sht3x_data *data)
445{
446 /*
447 * For single-shot mode, only non blocking mode is support,
448 * we have to wait ourselves for result.
449 */
450 if (data->mode > 0) {
451 data->command = sht3x_cmd_measure_periodic_mode;
452 data->wait_time = 0;
453 } else {
454 if (data->repeatability == high_repeatability) {
455 data->command = sht3x_cmd_measure_single_hpm;
456 data->wait_time = SHT3X_SINGLE_WAIT_TIME_HPM;
457 } else if (data->repeatability == medium_repeatability) {
458 data->command = sht3x_cmd_measure_single_mpm;
459 data->wait_time = SHT3X_SINGLE_WAIT_TIME_MPM;
460 } else {
461 data->command = sht3x_cmd_measure_single_lpm;
462 data->wait_time = SHT3X_SINGLE_WAIT_TIME_LPM;
463 }
464 }
465}
466
467static int status_register_read(struct device *dev,
468 char *buffer, int length)
469{
470 int ret;
471 struct sht3x_data *data = dev_get_drvdata(dev);
472 struct i2c_client *client = data->client;
473
474 ret = sht3x_read_from_command(client, data, sht3x_cmd_read_status_reg,
475 buffer, length, 0);
476
477 return ret;
478}
479
480static int temp1_alarm_read(struct device *dev)
481{
482 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
483 int ret;
484
485 ret = status_register_read(dev, buffer,
486 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
487 if (ret)
488 return ret;
489
490 return !!(buffer[0] & 0x04);
491}
492
493static int humidity1_alarm_read(struct device *dev)
494{
495 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
496 int ret;
497
498 ret = status_register_read(dev, buffer,
499 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
500 if (ret)
501 return ret;
502
503 return !!(buffer[0] & 0x08);
504}
505
506static ssize_t heater_enable_show(struct device *dev,
507 struct device_attribute *attr,
508 char *buf)
509{
510 char buffer[SHT3X_WORD_LEN + SHT3X_CRC8_LEN];
511 int ret;
512
513 ret = status_register_read(dev, buffer,
514 SHT3X_WORD_LEN + SHT3X_CRC8_LEN);
515 if (ret)
516 return ret;
517
518 return sysfs_emit(buf, "%d\n", !!(buffer[0] & 0x20));
519}
520
521static ssize_t heater_enable_store(struct device *dev,
522 struct device_attribute *attr,
523 const char *buf,
524 size_t count)
525{
526 struct sht3x_data *data = dev_get_drvdata(dev);
527 struct i2c_client *client = data->client;
528 int ret;
529 bool status;
530
531 ret = kstrtobool(buf, &status);
532 if (ret)
533 return ret;
534
535 mutex_lock(&data->i2c_lock);
536
537 if (status)
538 ret = i2c_master_send(client, (char *)&sht3x_cmd_heater_on,
539 SHT3X_CMD_LENGTH);
540 else
541 ret = i2c_master_send(client, (char *)&sht3x_cmd_heater_off,
542 SHT3X_CMD_LENGTH);
543
544 mutex_unlock(&data->i2c_lock);
545
546 return ret;
547}
548
549static int update_interval_read(struct device *dev)
550{
551 struct sht3x_data *data = dev_get_drvdata(dev);
552
553 return mode_to_update_interval[data->mode];
554}
555
556static int update_interval_write(struct device *dev, int val)
557{
558 u8 mode;
559 int ret;
560 const char *command;
561 struct sht3x_data *data = dev_get_drvdata(dev);
562 struct i2c_client *client = data->client;
563
564 mode = get_mode_from_update_interval(val);
565
566 mutex_lock(&data->data_lock);
567 /* mode did not change */
568 if (mode == data->mode) {
569 mutex_unlock(&data->data_lock);
570 return 0;
571 }
572
573 mutex_lock(&data->i2c_lock);
574 /*
575 * Abort periodic measure mode.
576 * To do any changes to the configuration while in periodic mode, we
577 * have to send a break command to the sensor, which then falls back
578 * to single shot (mode = 0).
579 */
580 if (data->mode > 0) {
581 ret = i2c_master_send(client, sht3x_cmd_break,
582 SHT3X_CMD_LENGTH);
583 if (ret != SHT3X_CMD_LENGTH)
584 goto out;
585 data->mode = 0;
586 }
587
588 if (mode > 0) {
589 if (data->repeatability == high_repeatability)
590 command = periodic_measure_commands_hpm[mode - 1];
591 else if (data->repeatability == medium_repeatability)
592 command = periodic_measure_commands_mpm[mode - 1];
593 else
594 command = periodic_measure_commands_lpm[mode - 1];
595
596 /* select mode */
597 ret = i2c_master_send(client, command, SHT3X_CMD_LENGTH);
598 if (ret != SHT3X_CMD_LENGTH)
599 goto out;
600 }
601
602 /* select mode and command */
603 data->mode = mode;
604 sht3x_select_command(data);
605
606out:
607 mutex_unlock(&data->i2c_lock);
608 mutex_unlock(&data->data_lock);
609 if (ret != SHT3X_CMD_LENGTH)
610 return ret < 0 ? ret : -EIO;
611
612 return 0;
613}
614
615static ssize_t repeatability_show(struct device *dev,
616 struct device_attribute *attr,
617 char *buf)
618{
619 struct sht3x_data *data = dev_get_drvdata(dev);
620
621 return sysfs_emit(buf, "%d\n", data->repeatability);
622}
623
624static ssize_t repeatability_store(struct device *dev,
625 struct device_attribute *attr,
626 const char *buf,
627 size_t count)
628{
629 int ret;
630 u8 val;
631
632 struct sht3x_data *data = dev_get_drvdata(dev);
633
634 ret = kstrtou8(buf, 0, &val);
635 if (ret)
636 return ret;
637
638 if (val > 2)
639 return -EINVAL;
640
641 data->repeatability = val;
642
643 return count;
644}
645
646static SENSOR_DEVICE_ATTR_RW(heater_enable, heater_enable, 0);
647static SENSOR_DEVICE_ATTR_RW(repeatability, repeatability, 0);
648
649static struct attribute *sht3x_attrs[] = {
650 &sensor_dev_attr_heater_enable.dev_attr.attr,
651 &sensor_dev_attr_repeatability.dev_attr.attr,
652 NULL
653};
654
655ATTRIBUTE_GROUPS(sht3x);
656
657static umode_t sht3x_is_visible(const void *data, enum hwmon_sensor_types type,
658 u32 attr, int channel)
659{
660 const struct sht3x_data *chip_data = data;
661
662 switch (type) {
663 case hwmon_chip:
664 switch (attr) {
665 case hwmon_chip_update_interval:
666 return 0644;
667 default:
668 break;
669 }
670 break;
671 case hwmon_temp:
672 switch (attr) {
673 case hwmon_temp_input:
674 case hwmon_temp_alarm:
675 return 0444;
676 case hwmon_temp_max:
677 case hwmon_temp_max_hyst:
678 case hwmon_temp_min:
679 case hwmon_temp_min_hyst:
680 return 0644;
681 default:
682 break;
683 }
684 break;
685 case hwmon_humidity:
686 if (chip_data->chip_id == sts3x)
687 break;
688 switch (attr) {
689 case hwmon_humidity_input:
690 case hwmon_humidity_alarm:
691 return 0444;
692 case hwmon_humidity_max:
693 case hwmon_humidity_max_hyst:
694 case hwmon_humidity_min:
695 case hwmon_humidity_min_hyst:
696 return 0644;
697 default:
698 break;
699 }
700 break;
701 default:
702 break;
703 }
704
705 return 0;
706}
707
708static int sht3x_read(struct device *dev, enum hwmon_sensor_types type,
709 u32 attr, int channel, long *val)
710{
711 enum sht3x_limits index;
712
713 switch (type) {
714 case hwmon_chip:
715 switch (attr) {
716 case hwmon_chip_update_interval:
717 *val = update_interval_read(dev);
718 break;
719 default:
720 return -EOPNOTSUPP;
721 }
722 break;
723 case hwmon_temp:
724 switch (attr) {
725 case hwmon_temp_input:
726 *val = temp1_input_read(dev);
727 break;
728 case hwmon_temp_alarm:
729 *val = temp1_alarm_read(dev);
730 break;
731 case hwmon_temp_max:
732 index = limit_max;
733 *val = temp1_limit_read(dev, index);
734 break;
735 case hwmon_temp_max_hyst:
736 index = limit_max_hyst;
737 *val = temp1_limit_read(dev, index);
738 break;
739 case hwmon_temp_min:
740 index = limit_min;
741 *val = temp1_limit_read(dev, index);
742 break;
743 case hwmon_temp_min_hyst:
744 index = limit_min_hyst;
745 *val = temp1_limit_read(dev, index);
746 break;
747 default:
748 return -EOPNOTSUPP;
749 }
750 break;
751 case hwmon_humidity:
752 switch (attr) {
753 case hwmon_humidity_input:
754 *val = humidity1_input_read(dev);
755 break;
756 case hwmon_humidity_alarm:
757 *val = humidity1_alarm_read(dev);
758 break;
759 case hwmon_humidity_max:
760 index = limit_max;
761 *val = humidity1_limit_read(dev, index);
762 break;
763 case hwmon_humidity_max_hyst:
764 index = limit_max_hyst;
765 *val = humidity1_limit_read(dev, index);
766 break;
767 case hwmon_humidity_min:
768 index = limit_min;
769 *val = humidity1_limit_read(dev, index);
770 break;
771 case hwmon_humidity_min_hyst:
772 index = limit_min_hyst;
773 *val = humidity1_limit_read(dev, index);
774 break;
775 default:
776 return -EOPNOTSUPP;
777 }
778 break;
779 default:
780 return -EOPNOTSUPP;
781 }
782
783 return 0;
784}
785
786static int sht3x_write(struct device *dev, enum hwmon_sensor_types type,
787 u32 attr, int channel, long val)
788{
789 enum sht3x_limits index;
790
791 switch (type) {
792 case hwmon_chip:
793 switch (attr) {
794 case hwmon_chip_update_interval:
795 return update_interval_write(dev, val);
796 default:
797 return -EOPNOTSUPP;
798 }
799 case hwmon_temp:
800 switch (attr) {
801 case hwmon_temp_max:
802 index = limit_max;
803 break;
804 case hwmon_temp_max_hyst:
805 index = limit_max_hyst;
806 break;
807 case hwmon_temp_min:
808 index = limit_min;
809 break;
810 case hwmon_temp_min_hyst:
811 index = limit_min_hyst;
812 break;
813 default:
814 return -EOPNOTSUPP;
815 }
816 return temp1_limit_write(dev, index, val);
817 case hwmon_humidity:
818 switch (attr) {
819 case hwmon_humidity_max:
820 index = limit_max;
821 break;
822 case hwmon_humidity_max_hyst:
823 index = limit_max_hyst;
824 break;
825 case hwmon_humidity_min:
826 index = limit_min;
827 break;
828 case hwmon_humidity_min_hyst:
829 index = limit_min_hyst;
830 break;
831 default:
832 return -EOPNOTSUPP;
833 }
834 return humidity1_limit_write(dev, index, val);
835 default:
836 return -EOPNOTSUPP;
837 }
838}
839
840static void sht3x_debugfs_init(struct sht3x_data *data)
841{
842 char name[32];
843
844 snprintf(name, sizeof(name), "i2c%u-%02x",
845 data->client->adapter->nr, data->client->addr);
846 data->sensor_dir = debugfs_create_dir(name, debugfs);
847 debugfs_create_u32("serial_number", 0444,
848 data->sensor_dir, &data->serial_number);
849}
850
851static void sht3x_debugfs_remove(void *sensor_dir)
852{
853 debugfs_remove_recursive(sensor_dir);
854}
855
856static int sht3x_serial_number_read(struct sht3x_data *data)
857{
858 int ret;
859 char buffer[SHT3X_RESPONSE_LENGTH];
860 struct i2c_client *client = data->client;
861
862 ret = sht3x_read_from_command(client, data,
863 sht3x_cmd_read_serial_number,
864 buffer,
865 SHT3X_RESPONSE_LENGTH, 0);
866 if (ret)
867 return ret;
868
869 data->serial_number = (buffer[0] << 24) | (buffer[1] << 16) |
870 (buffer[3] << 8) | buffer[4];
871 return ret;
872}
873
874static const struct hwmon_ops sht3x_ops = {
875 .is_visible = sht3x_is_visible,
876 .read = sht3x_read,
877 .write = sht3x_write,
878};
879
880static const struct hwmon_chip_info sht3x_chip_info = {
881 .ops = &sht3x_ops,
882 .info = sht3x_channel_info,
883};
884
885static int sht3x_probe(struct i2c_client *client)
886{
887 int ret;
888 struct sht3x_data *data;
889 struct device *hwmon_dev;
890 struct i2c_adapter *adap = client->adapter;
891 struct device *dev = &client->dev;
892
893 /*
894 * we require full i2c support since the sht3x uses multi-byte read and
895 * writes as well as multi-byte commands which are not supported by
896 * the smbus protocol
897 */
898 if (!i2c_check_functionality(adap, I2C_FUNC_I2C))
899 return -ENODEV;
900
901 ret = i2c_master_send(client, sht3x_cmd_clear_status_reg,
902 SHT3X_CMD_LENGTH);
903 if (ret != SHT3X_CMD_LENGTH)
904 return ret < 0 ? ret : -ENODEV;
905
906 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
907 if (!data)
908 return -ENOMEM;
909
910 data->repeatability = high_repeatability;
911 data->mode = 0;
912 data->last_update = jiffies - msecs_to_jiffies(3000);
913 data->client = client;
914 data->chip_id = (uintptr_t)i2c_get_match_data(client);
915 crc8_populate_msb(sht3x_crc8_table, SHT3X_CRC8_POLYNOMIAL);
916
917 sht3x_select_command(data);
918
919 mutex_init(&data->i2c_lock);
920 mutex_init(&data->data_lock);
921
922 /*
923 * An attempt to read limits register too early
924 * causes a NACK response from the chip.
925 * Waiting for an empirical delay of 500 us solves the issue.
926 */
927 usleep_range(500, 600);
928
929 ret = limits_update(data);
930 if (ret)
931 return ret;
932
933 ret = sht3x_serial_number_read(data);
934 if (ret) {
935 dev_dbg(dev, "unable to read serial number\n");
936 } else {
937 sht3x_debugfs_init(data);
938 ret = devm_add_action_or_reset(dev,
939 sht3x_debugfs_remove,
940 data->sensor_dir);
941 if (ret)
942 return ret;
943 }
944
945 hwmon_dev = devm_hwmon_device_register_with_info(dev,
946 client->name,
947 data,
948 &sht3x_chip_info,
949 sht3x_groups);
950
951 if (IS_ERR(hwmon_dev))
952 dev_dbg(dev, "unable to register hwmon device\n");
953
954 return PTR_ERR_OR_ZERO(hwmon_dev);
955}
956
957/* device ID table */
958static const struct i2c_device_id sht3x_ids[] = {
959 {"sht3x", sht3x},
960 {"sts3x", sts3x},
961 {}
962};
963
964MODULE_DEVICE_TABLE(i2c, sht3x_ids);
965
966static struct i2c_driver sht3x_i2c_driver = {
967 .driver.name = "sht3x",
968 .probe = sht3x_probe,
969 .id_table = sht3x_ids,
970};
971
972static int __init sht3x_init(void)
973{
974 debugfs = debugfs_create_dir("sht3x", NULL);
975 return i2c_add_driver(&sht3x_i2c_driver);
976}
977module_init(sht3x_init);
978
979static void __exit sht3x_cleanup(void)
980{
981 debugfs_remove_recursive(debugfs);
982 i2c_del_driver(&sht3x_i2c_driver);
983}
984module_exit(sht3x_cleanup);
985
986MODULE_AUTHOR("David Frey <david.frey@sensirion.com>");
987MODULE_AUTHOR("Pascal Sachs <pascal.sachs@sensirion.com>");
988MODULE_DESCRIPTION("Sensirion SHT3x humidity and temperature sensor driver");
989MODULE_LICENSE("GPL");