^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) What: /sys/bus/w1/devices/.../alarms
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) (RW) read or write TH and TL (Temperature High an Low) alarms.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) Values shall be space separated and in the device range
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) (typical -55 degC to 125 degC), if not values will be trimmed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) to device min/max capabilities. Values are integer as they are
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) stored in a 8bit register in the device. Lowest value is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) automatically put to TL. Once set, alarms could be search at
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) master level, refer to Documentation/w1/w1-generic.rst for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) detailed information
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) What: /sys/bus/w1/devices/.../eeprom
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) (WO) writing that file will either trigger a save of the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) device data to its embedded EEPROM, either restore data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) embedded in device EEPROM. Be aware that devices support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) limited EEPROM writing cycles (typical 50k)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * 'save': save device RAM to EEPROM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * 'restore': restore EEPROM data in device RAM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) What: /sys/bus/w1/devices/.../ext_power
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) (RO) return the power status by asking the device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * '0': device parasite powered
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * '1': device externally powered
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * '-xx': xx is kernel error when reading power status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) What: /sys/bus/w1/devices/.../resolution
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) (RW) get or set the device resolution (on supported devices,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) if not, this entry is not present). Note that the resolution
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) will be changed only in device RAM, so it will be cleared when
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) power is lost. Trigger a 'save' to EEPROM command to keep
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) values after power-on. Read or write are :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) * '9..14': device resolution in bit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) or resolution to set in bit
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) * '-xx': xx is kernel error when reading the resolution
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * Anything else: do nothing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) Some DS18B20 clones are fixed in 12-bit resolution, so the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) actual resolution is read back from the chip and verified. Error
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) is reported if the results differ.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) What: /sys/bus/w1/devices/.../temperature
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) (RO) return the temperature in 1/1000 degC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) * If a bulk read has been triggered, it will directly
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) return the temperature computed when the bulk read
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) occurred, if available. If not yet available, nothing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) is returned (a debug kernel message is sent), you
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) should retry later on.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * If no bulk read has been triggered, it will trigger
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) a conversion and send the result. Note that the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) conversion duration depend on the resolution (if
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) device support this feature). It takes 94ms in 9bits
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) resolution, 750ms for 12bits.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) What: /sys/bus/w1/devices/.../w1_slave
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) (RW) return the temperature in 1/1000 degC.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) *read*: return 2 lines with the hexa output data sent on the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) bus, return the CRC check and temperature in 1/1000 degC
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) *write*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) * '0' : save the 2 or 3 bytes to the device EEPROM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) (i.e. TH, TL and config register)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) * '9..14' : set the device resolution in RAM
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) (if supported)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) * Anything else: do nothing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) refer to Documentation/w1/slaves/w1_therm.rst for detailed
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) information.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) What: /sys/bus/w1/devices/w1_bus_masterXX/therm_bulk_read
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) Date: May 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) Contact: Akira Shimahara <akira215corp@gmail.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) (RW) trigger a bulk read conversion. read the status
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) *read*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) * '-1':
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) conversion in progress on at least 1 sensor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) * '1' :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) conversion complete but at least one sensor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) value has not been read yet
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) * '0' :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) no bulk operation. Reading temperature will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) trigger a conversion on each device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) *write*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) 'trigger': trigger a bulk read on all supporting
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) devices on the bus
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) Note that if a bulk read is sent but one sensor is not read
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) immediately, the next access to temperature on this device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) will return the temperature measured at the time of issue
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) of the bulk read command (not the current temperature).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) Users: any user space application which wants to communicate with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) What: /sys/bus/w1/devices/.../conv_time
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) Date: July 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) Contact: Ivan Zaentsev <ivan.zaentsev@wirenboard.ru>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) (RW) Get, set, or measure a temperature conversion time. The
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) setting remains active until a resolution change. Then it is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) reset to default (datasheet) conversion time for a new
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) resolution.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) *read*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) Actual conversion time in milliseconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) *write*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) * '0':
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) Set the default conversion time from the datasheet.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) * '1':
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) Measure and set the conversion time. Make a single
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) temperature conversion, measure an actual value.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) Increase it by 20% for temperature range. A new
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) conversion time can be obtained by reading this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) same attribute.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) * other positive value:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) Set the conversion time in milliseconds.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) Users: An application using the w1_term device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) What: /sys/bus/w1/devices/.../features
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) Date: July 2020
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) Contact: Ivan Zaentsev <ivan.zaentsev@wirenboard.ru>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) (RW) Control optional driver settings.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) Bit masks to read/write (bitwise OR):
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) == ============================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) 1 Enable check for conversion success. If byte 6 of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) scratchpad memory is 0xC after conversion, and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) temperature reads 85.00 (powerup value) or 127.94
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) (insufficient power) - return a conversion error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 2 Enable poll for conversion completion. Generate read cycles
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) after the conversion start and wait for 1's. In parasite
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) power mode this feature is not available.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) == ============================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) *read*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) Currently selected features.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) *write*:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) Select features.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) Users: An application using the w1_term device