xref: /linux/Documentation/ABI/testing/sysfs-bus-i2c-devices-turris-omnia-mcu (revision 0f135d3e30c43be2034299c560272e18c6166d04)
1992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/board_revision
2992f1a3dSMarek BehúnDate:		September 2024
3992f1a3dSMarek BehúnKernelVersion:	6.11
4992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
5992f1a3dSMarek BehúnDescription:	(RO) Contains board revision number.
6992f1a3dSMarek Behún
7992f1a3dSMarek Behún		Only available if board information is burned in the MCU (older
8992f1a3dSMarek Behún		revisions have board information burned in the ATSHA204-A chip).
9992f1a3dSMarek Behún
10992f1a3dSMarek Behún		Format: %u.
11992f1a3dSMarek Behún
12992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/first_mac_address
13992f1a3dSMarek BehúnDate:		September 2024
14992f1a3dSMarek BehúnKernelVersion:	6.11
15992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
16992f1a3dSMarek BehúnDescription:	(RO) Contains device first MAC address. Each Turris Omnia is
17992f1a3dSMarek Behún		allocated 3 MAC addresses. The two additional addresses are
18992f1a3dSMarek Behún		computed from the first one by incrementing it.
19992f1a3dSMarek Behún
20992f1a3dSMarek Behún		Only available if board information is burned in the MCU (older
21992f1a3dSMarek Behún		revisions have board information burned in the ATSHA204-A chip).
22992f1a3dSMarek Behún
23992f1a3dSMarek Behún		Format: %pM.
24992f1a3dSMarek Behún
25dfa556e4SMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/front_button_mode
26dfa556e4SMarek BehúnDate:		September 2024
27dfa556e4SMarek BehúnKernelVersion:	6.11
28dfa556e4SMarek BehúnContact:	Marek Behún <kabel@kernel.org>
29dfa556e4SMarek BehúnDescription:	(RW) The front button on the Turris Omnia router can be
30dfa556e4SMarek Behún		configured either to change the intensity of all the LEDs on the
31dfa556e4SMarek Behún		front panel, or to send the press event to the CPU as an
32dfa556e4SMarek Behún		interrupt.
33dfa556e4SMarek Behún
34dfa556e4SMarek Behún		This file switches between these two modes:
35*e1793feaSMarek Behún		 - ``mcu`` makes the button press event be handled by the MCU to
36dfa556e4SMarek Behún		   change the LEDs panel intensity.
37*e1793feaSMarek Behún		 - ``cpu`` makes the button press event be handled by the CPU.
38dfa556e4SMarek Behún
39dfa556e4SMarek Behún		Format: %s.
40dfa556e4SMarek Behún
4190e700fdSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/front_button_poweron
4290e700fdSMarek BehúnDate:		September 2024
4390e700fdSMarek BehúnKernelVersion:	6.11
4490e700fdSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
4590e700fdSMarek BehúnDescription:	(RW) Newer versions of the microcontroller firmware of the
4690e700fdSMarek Behún		Turris Omnia router support powering off the router into true
4790e700fdSMarek Behún		low power mode. The router can be powered on by pressing the
4890e700fdSMarek Behún		front button.
4990e700fdSMarek Behún
5090e700fdSMarek Behún		This file configures whether front button power on is enabled.
5190e700fdSMarek Behún
5290e700fdSMarek Behún		This file is present only if the power off feature is supported
5390e700fdSMarek Behún		by the firmware.
5490e700fdSMarek Behún
5590e700fdSMarek Behún		Format: %i.
5690e700fdSMarek Behún
57992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/fw_features
58992f1a3dSMarek BehúnDate:		September 2024
59992f1a3dSMarek BehúnKernelVersion:	6.11
60992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
61992f1a3dSMarek BehúnDescription:	(RO) Newer versions of the microcontroller firmware report the
62992f1a3dSMarek Behún		features they support. These can be read from this file. If the
63992f1a3dSMarek Behún		MCU firmware is too old, this file reads 0x0.
64992f1a3dSMarek Behún
65992f1a3dSMarek Behún		Format: 0x%x.
66992f1a3dSMarek Behún
67992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/fw_version_hash_application
68992f1a3dSMarek BehúnDate:		September 2024
69992f1a3dSMarek BehúnKernelVersion:	6.11
70992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
71992f1a3dSMarek BehúnDescription:	(RO) Contains the version hash (commit hash) of the application
72992f1a3dSMarek Behún		part of the microcontroller firmware.
73992f1a3dSMarek Behún
74992f1a3dSMarek Behún		Format: %s.
75992f1a3dSMarek Behún
76992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/fw_version_hash_bootloader
77992f1a3dSMarek BehúnDate:		September 2024
78992f1a3dSMarek BehúnKernelVersion:	6.11
79992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
80992f1a3dSMarek BehúnDescription:	(RO) Contains the version hash (commit hash) of the bootloader
81992f1a3dSMarek Behún		part of the microcontroller firmware.
82992f1a3dSMarek Behún
83992f1a3dSMarek Behún		Format: %s.
84992f1a3dSMarek Behún
85992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/mcu_type
86992f1a3dSMarek BehúnDate:		September 2024
87992f1a3dSMarek BehúnKernelVersion:	6.11
88992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
89992f1a3dSMarek BehúnDescription:	(RO) Contains the microcontroller type (STM32, GD32, MKL).
90992f1a3dSMarek Behún
91992f1a3dSMarek Behún		Format: %s.
92992f1a3dSMarek Behún
93992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/reset_selector
94992f1a3dSMarek BehúnDate:		September 2024
95992f1a3dSMarek BehúnKernelVersion:	6.11
96992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
97992f1a3dSMarek BehúnDescription:	(RO) Contains the selected factory reset level, determined by
98992f1a3dSMarek Behún		how long the rear reset button was held by the user during board
99992f1a3dSMarek Behún		reset.
100992f1a3dSMarek Behún
101992f1a3dSMarek Behún		Format: %i.
102992f1a3dSMarek Behún
103992f1a3dSMarek BehúnWhat:		/sys/bus/i2c/devices/<mcu_device>/serial_number
104992f1a3dSMarek BehúnDate:		September 2024
105992f1a3dSMarek BehúnKernelVersion:	6.11
106992f1a3dSMarek BehúnContact:	Marek Behún <kabel@kernel.org>
107992f1a3dSMarek BehúnDescription:	(RO) Contains the 64-bit board serial number in hexadecimal
108992f1a3dSMarek Behún		format.
109992f1a3dSMarek Behún
110992f1a3dSMarek Behún		Only available if board information is burned in the MCU (older
111992f1a3dSMarek Behún		revisions have board information burned in the ATSHA204-A chip).
112992f1a3dSMarek Behún
113992f1a3dSMarek Behún		Format: %016X.
114