summaryrefslogtreecommitdiff
path: root/Documentation/ABI/testing/sysfs-driver-w1_therm
blob: 6ffd3e3286a7581847bd00cde28b750e88a477f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
What:		/sys/bus/w1/devices/.../eeprom
Date:		May 2020
Contact:	Akira Shimahara <akira215corp@gmail.com>
Description:
		(WO) writing that file will either trigger a save of the
		device data to its embedded EEPROM, either restore data
		embedded in device EEPROM. Be aware that devices support
		limited EEPROM writing cycles (typical 50k)
			* 'save': save device RAM to EEPROM
			* 'restore': restore EEPROM data in device RAM
Users:		any user space application which wants to communicate with
		w1_term device


What:		/sys/bus/w1/devices/.../ext_power
Date:		May 2020
Contact:	Akira Shimahara <akira215corp@gmail.com>
Description:
		(RO) return the power status by asking the device
			* '0': device parasite powered
			* '1': device externally powered
			* '-xx': xx is kernel error when reading power status
Users:		any user space application which wants to communicate with
		w1_term device


What:		/sys/bus/w1/devices/.../resolution
Date:		May 2020
Contact:	Akira Shimahara <akira215corp@gmail.com>
Description:
		(RW) get or set the device resolution (on supported devices,
		if not, this entry is not present). Note that the resolution
		will be changed only in device RAM, so it will be cleared when
		power is lost. Trigger a 'save' to EEPROM command to keep
		values after power-on. Read or write are :
			* '9..12': device resolution in bit
			or resolution to set in bit
			* '-xx': xx is kernel error when reading the resolution
			* Anything else: do nothing
Users:		any user space application which wants to communicate with
		w1_term device


What:		/sys/bus/w1/devices/.../temperature
Date:		May 2020
Contact:	Akira Shimahara <akira215corp@gmail.com>
Description:
		(RO) return the temperature in 1/1000 degC.
		Note that the conversion duration depend on the resolution (if
		device support this feature). It takes 94ms in 9bits
		resolution, 750ms for 12bits.
Users:		any user space application which wants to communicate with
		w1_term device


What:		/sys/bus/w1/devices/.../w1_slave
Date:		May 2020
Contact:	Akira Shimahara <akira215corp@gmail.com>
Description:
		(RW) return the temperature in 1/1000 degC.
		*read*: return 2 lines with the hexa output data sent on the
		bus, return the CRC check and temperature in 1/1000 degC
		*write* :
			* '0' : save the 2 or 3 bytes to the device EEPROM
			(i.e. TH, TL and config register)
			* '9..12' : set the device resolution in RAM
			(if supported)
			* Anything else: do nothing
		refer to Documentation/w1/slaves/w1_therm.rst for detailed
		information.
Users:		any user space application which wants to communicate with
		w1_term device