Merge tag 'for-linus-5.7-rc6' of git://git.kernel.org/pub/scm/linux/kernel/git/rw/uml
[platform/kernel/linux-starfive.git] / Documentation / hwmon / shtc1.rst
1 Kernel driver shtc1
2 ===================
3
4 Supported chips:
5
6   * Sensirion SHTC1
7
8     Prefix: 'shtc1'
9
10     Addresses scanned: none
11
12     Datasheet: http://www.sensirion.com/file/datasheet_shtc1
13
14
15
16   * Sensirion SHTW1
17
18     Prefix: 'shtw1'
19
20     Addresses scanned: none
21
22     Datasheet: http://www.sensirion.com/file/datasheet_shtw1
23
24
25
26   * Sensirion SHTC3
27
28     Prefix: 'shtc3'
29
30     Addresses scanned: none
31
32     Datasheet: http://www.sensirion.com/file/datasheet_shtc3
33
34
35
36 Author:
37
38   Johannes Winkelmann <johannes.winkelmann@sensirion.com>
39
40 Description
41 -----------
42
43 This driver implements support for the Sensirion SHTC1, SHTW1, and SHTC3
44 chips, a humidity and temperature sensor. Temperature is measured in degrees
45 celsius, relative humidity is expressed as a percentage.
46
47 The device communicates with the I2C protocol. All sensors are set to I2C
48 address 0x70. See Documentation/i2c/instantiating-devices.rst for methods to
49 instantiate the device.
50
51 There are two options configurable by means of shtc1_platform_data:
52
53 1. blocking (pull the I2C clock line down while performing the measurement) or
54    non-blocking mode. Blocking mode will guarantee the fastest result but
55    the I2C bus will be busy during that time. By default, non-blocking mode
56    is used. Make sure clock-stretching works properly on your device if you
57    want to use blocking mode.
58 2. high or low accuracy. High accuracy is used by default and using it is
59    strongly recommended.
60
61 sysfs-Interface
62 ---------------
63
64 temp1_input
65         - temperature input
66 humidity1_input
67         - humidity input