1 .. SPDX-License-Identifier: GPL-2.0 1 .. SPDX-License-Identifier: GPL-2.0
2 2
3 Kernel driver sg2042-mcu 3 Kernel driver sg2042-mcu
4 ======================== 4 ========================
5 5
6 Supported chips: 6 Supported chips:
7 7
8 * Onboard MCU for sg2042 8 * Onboard MCU for sg2042
9 9
10 Addresses scanned: - 10 Addresses scanned: -
11 11
12 Prefix: 'sg2042-mcu' 12 Prefix: 'sg2042-mcu'
13 13
14 Authors: 14 Authors:
15 15
16 - Inochi Amaoto <inochiama@outlook.com> 16 - Inochi Amaoto <inochiama@outlook.com>
17 17
18 Description 18 Description
19 ----------- 19 -----------
20 20
21 This driver supprts hardware monitoring for on 21 This driver supprts hardware monitoring for onboard MCU with
22 i2c interface. 22 i2c interface.
23 23
24 Usage Notes 24 Usage Notes
25 ----------- 25 -----------
26 26
27 This driver does not auto-detect devices. You 27 This driver does not auto-detect devices. You will have to instantiate
28 the devices explicitly. 28 the devices explicitly.
29 Please see Documentation/i2c/instantiating-dev 29 Please see Documentation/i2c/instantiating-devices.rst for details.
30 30
31 Sysfs Attributes 31 Sysfs Attributes
32 ---------------- 32 ----------------
33 33
34 The following table shows the standard entries 34 The following table shows the standard entries support by the driver:
35 35
36 ================= ============================ 36 ================= =====================================================
37 Name Description 37 Name Description
38 ================= ============================ 38 ================= =====================================================
39 temp1_input Measured temperature of SoC 39 temp1_input Measured temperature of SoC
40 temp1_crit Critical high temperature 40 temp1_crit Critical high temperature
41 temp1_crit_hyst hysteresis temperature resto 41 temp1_crit_hyst hysteresis temperature restore from Critical
42 temp2_input Measured temperature of the 42 temp2_input Measured temperature of the base board
43 ================= ============================ 43 ================= =====================================================
44 44
45 The following table shows the extra entries su 45 The following table shows the extra entries support by the driver
46 (the MCU device is in i2c subsystem): 46 (the MCU device is in i2c subsystem):
47 47
48 ================= ======= ==================== 48 ================= ======= =============================================
49 Name Perm Description 49 Name Perm Description
50 ================= ======= ==================== 50 ================= ======= =============================================
51 reset_count RO Reset count of the S 51 reset_count RO Reset count of the SoC
52 uptime RO Seconds after the MC 52 uptime RO Seconds after the MCU is powered
53 reset_reason RO Reset reason for the 53 reset_reason RO Reset reason for the last reset
54 repower_policy RW Execution policy whe 54 repower_policy RW Execution policy when triggering repower
55 ================= ======= ==================== 55 ================= ======= =============================================
56 56
57 ``repower_policy`` 57 ``repower_policy``
58 The repower is triggered when the temperatur 58 The repower is triggered when the temperature of the SoC falls below
59 the hysteresis temperature after triggering 59 the hysteresis temperature after triggering a shutdown due to
60 reaching the critical temperature. 60 reaching the critical temperature.
61 The valid values for this entry are "repower 61 The valid values for this entry are "repower" and "keep". "keep" will
62 leave the SoC down when the triggering repow 62 leave the SoC down when the triggering repower, and "repower" will
63 boot the SoC. 63 boot the SoC.
64 64
65 Debugfs Interfaces 65 Debugfs Interfaces
66 ------------------ 66 ------------------
67 67
68 If debugfs is available, this driver exposes s 68 If debugfs is available, this driver exposes some hardware specific
69 data in ``/sys/kernel/debug/sg2042-mcu/*/``. 69 data in ``/sys/kernel/debug/sg2042-mcu/*/``.
70 70
71 ================= ======= ==================== 71 ================= ======= =============================================
72 Name Format Description 72 Name Format Description
73 ================= ======= ==================== 73 ================= ======= =============================================
74 firmware_version 0x%02x firmware version of 74 firmware_version 0x%02x firmware version of the MCU
75 pcb_version 0x%02x version number of th 75 pcb_version 0x%02x version number of the base board
76 board_type 0x%02x identifiers for the 76 board_type 0x%02x identifiers for the base board
77 mcu_type %d type of the MCU: 0 i 77 mcu_type %d type of the MCU: 0 is STM32, 1 is GD32
78 ================= ======= ==================== 78 ================= ======= =============================================
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.