xref: /linux/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu (revision 0f135d3e30c43be2034299c560272e18c6166d04)
1What:		/sys/bus/i2c/devices/<mcu_device>/board_revision
2Date:		September 2024
3KernelVersion:	6.11
4Contact:	Marek Behún <kabel@kernel.org>
5Description:	(RO) Contains board revision number.
6
7		Only available if board information is burned in the MCU (older
8		revisions have board information burned in the ATSHA204-A chip).
9
10		Format: %u.
11
12What:		/sys/bus/i2c/devices/<mcu_device>/first_mac_address
13Date:		September 2024
14KernelVersion:	6.11
15Contact:	Marek Behún <kabel@kernel.org>
16Description:	(RO) Contains device first MAC address. Each Turris Omnia is
17		allocated 3 MAC addresses. The two additional addresses are
18		computed from the first one by incrementing it.
19
20		Only available if board information is burned in the MCU (older
21		revisions have board information burned in the ATSHA204-A chip).
22
23		Format: %pM.
24
25What:		/sys/bus/i2c/devices/<mcu_device>/front_button_mode
26Date:		September 2024
27KernelVersion:	6.11
28Contact:	Marek Behún <kabel@kernel.org>
29Description:	(RW) The front button on the Turris Omnia router can be
30		configured either to change the intensity of all the LEDs on the
31		front panel, or to send the press event to the CPU as an
32		interrupt.
33
34		This file switches between these two modes:
35		 - ``mcu`` makes the button press event be handled by the MCU to
36		   change the LEDs panel intensity.
37		 - ``cpu`` makes the button press event be handled by the CPU.
38
39		Format: %s.
40
41What:		/sys/bus/i2c/devices/<mcu_device>/front_button_poweron
42Date:		September 2024
43KernelVersion:	6.11
44Contact:	Marek Behún <kabel@kernel.org>
45Description:	(RW) Newer versions of the microcontroller firmware of the
46		Turris Omnia router support powering off the router into true
47		low power mode. The router can be powered on by pressing the
48		front button.
49
50		This file configures whether front button power on is enabled.
51
52		This file is present only if the power off feature is supported
53		by the firmware.
54
55		Format: %i.
56
57What:		/sys/bus/i2c/devices/<mcu_device>/fw_features
58Date:		September 2024
59KernelVersion:	6.11
60Contact:	Marek Behún <kabel@kernel.org>
61Description:	(RO) Newer versions of the microcontroller firmware report the
62		features they support. These can be read from this file. If the
63		MCU firmware is too old, this file reads 0x0.
64
65		Format: 0x%x.
66
67What:		/sys/bus/i2c/devices/<mcu_device>/fw_version_hash_application
68Date:		September 2024
69KernelVersion:	6.11
70Contact:	Marek Behún <kabel@kernel.org>
71Description:	(RO) Contains the version hash (commit hash) of the application
72		part of the microcontroller firmware.
73
74		Format: %s.
75
76What:		/sys/bus/i2c/devices/<mcu_device>/fw_version_hash_bootloader
77Date:		September 2024
78KernelVersion:	6.11
79Contact:	Marek Behún <kabel@kernel.org>
80Description:	(RO) Contains the version hash (commit hash) of the bootloader
81		part of the microcontroller firmware.
82
83		Format: %s.
84
85What:		/sys/bus/i2c/devices/<mcu_device>/mcu_type
86Date:		September 2024
87KernelVersion:	6.11
88Contact:	Marek Behún <kabel@kernel.org>
89Description:	(RO) Contains the microcontroller type (STM32, GD32, MKL).
90
91		Format: %s.
92
93What:		/sys/bus/i2c/devices/<mcu_device>/reset_selector
94Date:		September 2024
95KernelVersion:	6.11
96Contact:	Marek Behún <kabel@kernel.org>
97Description:	(RO) Contains the selected factory reset level, determined by
98		how long the rear reset button was held by the user during board
99		reset.
100
101		Format: %i.
102
103What:		/sys/bus/i2c/devices/<mcu_device>/serial_number
104Date:		September 2024
105KernelVersion:	6.11
106Contact:	Marek Behún <kabel@kernel.org>
107Description:	(RO) Contains the 64-bit board serial number in hexadecimal
108		format.
109
110		Only available if board information is burned in the MCU (older
111		revisions have board information burned in the ATSHA204-A chip).
112
113		Format: %016X.
114