Orange Pi5 kernel

Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards

3 Commits   0 Branches   0 Tags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  1) Kernel driver sht3x
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  2) ===================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  3) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  4) Supported chips:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  5) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  6)   * Sensirion SHT3x-DIS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  7) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  8)     Prefix: 'sht3x'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  9) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)     Addresses scanned: none
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)     Datasheet: https://www.sensirion.com/file/datasheet_sht3x_digital
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) Author:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)   - David Frey <david.frey@sensirion.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)   - Pascal Sachs <pascal.sachs@sensirion.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Description
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) -----------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) This driver implements support for the Sensirion SHT3x-DIS chip, a humidity
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) and temperature sensor. Temperature is measured in degrees celsius, relative
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) humidity is expressed as a percentage. In the sysfs interface, all values are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) The device communicates with the I2C protocol. Sensors can have the I2C
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) addresses 0x44 or 0x45, depending on the wiring. See
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) Documentation/i2c/instantiating-devices.rst for methods to instantiate the device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) There are two options configurable by means of sht3x_platform_data:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) 1. blocking (pull the I2C clock line down while performing the measurement) or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)    non-blocking mode. Blocking mode will guarantee the fastest result but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)    the I2C bus will be busy during that time. By default, non-blocking mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)    is used. Make sure clock-stretching works properly on your device if you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)    want to use blocking mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) 2. high or low accuracy. High accuracy is used by default and using it is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)    strongly recommended.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) The sht3x sensor supports a single shot mode as well as 5 periodic measure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) modes, which can be controlled with the update_interval sysfs interface.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) The allowed update_interval in milliseconds are as follows:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)     ===== ======= ====================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)        0          single shot mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)     2000   0.5 Hz periodic measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)     1000   1   Hz periodic measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)      500   2   Hz periodic measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)      250   4   Hz periodic measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51)      100  10   Hz periodic measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)     ===== ======= ====================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) In the periodic measure mode, the sensor automatically triggers a measurement
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) with the configured update interval on the chip. When a temperature or humidity
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) reading exceeds the configured limits, the alert attribute is set to 1 and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) the alert pin on the sensor is set to high.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) When the temperature and humidity readings move back between the hysteresis
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) values, the alert bit is set to 0 and the alert pin on the sensor is set to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) low.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) sysfs-Interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) ---------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) =================== ============================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) temp1_input:        temperature input
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) humidity1_input:    humidity input
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) temp1_max:          temperature max value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) temp1_max_hyst:     temperature hysteresis value for max limit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) humidity1_max:      humidity max value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) humidity1_max_hyst: humidity hysteresis value for max limit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) temp1_min:          temperature min value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) temp1_min_hyst:     temperature hysteresis value for min limit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) humidity1_min:      humidity min value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) humidity1_min_hyst: humidity hysteresis value for min limit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) temp1_alarm:        alarm flag is set to 1 if the temperature is outside the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) 		    configured limits. Alarm only works in periodic measure mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) humidity1_alarm:    alarm flag is set to 1 if the humidity is outside the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) 		    configured limits. Alarm only works in periodic measure mode
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) heater_enable:      heater enable, heating element removes excess humidity from
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) 		    sensor:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) 			- 0: turned off
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) 			- 1: turned on
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) update_interval:    update interval, 0 for single shot, interval in msec
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) 		    for periodic measurement. If the interval is not supported
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) 		    by the sensor, the next faster interval is chosen
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) =================== ============================================================