printf: Remove unused 'bprintf'
[drm/drm-misc.git] / Documentation / ABI / testing / sysfs-devices-platform-kunpeng_hccs
blobd1b3a95a5518acb056ef315df7ecc6cdda325a74
1 What:           /sys/devices/platform/HISI04Bx:00/chipX/all_linked
2 What:           /sys/devices/platform/HISI04Bx:00/chipX/linked_full_lane
3 What:           /sys/devices/platform/HISI04Bx:00/chipX/crc_err_cnt
4 Date:           November 2023
5 KernelVersion:  6.6
6 Contact:        Huisong Li <lihuisong@huawei.com>
7 Description:
8                 The /sys/devices/platform/HISI04Bx:00/chipX/ directory
9                 contains read-only attributes exposing some summarization
10                 information of all HCCS ports under a specified chip.
11                 The X in 'chipX' indicates the Xth chip on platform.
13                 There are following attributes in this directory:
15                 ================= ==== =========================================
16                 all_linked:       (RO) if all enabled ports on this chip are
17                                        linked (bool).
18                 linked_full_lane: (RO) if all linked ports on this chip are full
19                                        lane (bool).
20                 crc_err_cnt:      (RO) total CRC err count for all ports on this
21                                        chip.
22                 ================= ==== =========================================
24 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/all_linked
25 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/linked_full_lane
26 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/crc_err_cnt
27 Date:           November 2023
28 KernelVersion:  6.6
29 Contact:        Huisong Li <lihuisong@huawei.com>
30 Description:
31                 The /sys/devices/platform/HISI04Bx:00/chipX/dieY/ directory
32                 contains read-only attributes exposing some summarization
33                 information of all HCCS ports under a specified die.
34                 The Y in 'dieY' indicates the hardware id of the die on chip who
35                 has chip id X.
37                 There are following attributes in this directory:
39                 ================= ==== =========================================
40                 all_linked:       (RO) if all enabled ports on this die are
41                                        linked (bool).
42                 linked_full_lane: (RO) if all linked ports on this die are full
43                                        lane (bool).
44                 crc_err_cnt:      (RO) total CRC err count for all ports on this
45                                        die.
46                 ================= ==== =========================================
48 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/type
49 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/lane_mode
50 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/enable
51 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/cur_lane_num
52 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/link_fsm
53 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/lane_mask
54 What:           /sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/crc_err_cnt
55 Date:           November 2023
56 KernelVersion:  6.6
57 Contact:        Huisong Li <lihuisong@huawei.com>
58 Description:
59                 The /sys/devices/platform/HISI04Bx/chipX/dieX/hccsN/ directory
60                 contains read-only attributes exposing information about
61                 a HCCS port. The N value in 'hccsN' indicates this port id.
62                 The X in 'chipX' indicates the ID of the chip to which the
63                 HCCS port belongs. For example, X ranges from to 'n - 1' if the
64                 chip number on platform is n.
65                 The Y in 'dieY' indicates the hardware id of the die to which
66                 the hccs port belongs.
67                 Note: type, lane_mode and enable are fixed attributes on running
68                 platform.
70                 The HCCS port have the following attributes:
72                 ============= ==== =============================================
73                 type:         (RO) port type (string), e.g. HCCS-v1 -> H32
74                 lane_mode:    (RO) the lane mode of this port (string), e.g. x8
75                 enable:       (RO) indicate if this port is enabled (bool).
76                 cur_lane_num: (RO) current lane number of this port.
77                 link_fsm:     (RO) link finite state machine of this port.
78                 lane_mask:    (RO) current lane mask of this port, every bit
79                                    indicates a lane.
80                 crc_err_cnt:  (RO) CRC err count on this port.
81                 ============= ==== =============================================
83 What:           /sys/devices/platform/HISI04Bx:00/used_types
84 Date:           August 2024
85 KernelVersion:  6.12
86 Contact:        Huisong Li <lihuisong@huawei.com>
87 Description:
88                 This interface is used to show all HCCS types used on the
89                 platform, like, HCCS-v1, HCCS-v2 and so on.
91 What:           /sys/devices/platform/HISI04Bx:00/available_inc_dec_lane_types
92 What:           /sys/devices/platform/HISI04Bx:00/dec_lane_of_type
93 What:           /sys/devices/platform/HISI04Bx:00/inc_lane_of_type
94 Date:           August 2024
95 KernelVersion:  6.12
96 Contact:        Huisong Li <lihuisong@huawei.com>
97 Description:
98                 These interfaces under /sys/devices/platform/HISI04Bx/ are
99                 used to support the low power consumption feature of some
100                 HCCS types by changing the number of lanes used. The interfaces
101                 changing the number of lanes used are 'dec_lane_of_type' and
102                 'inc_lane_of_type' which require root privileges. These
103                 interfaces aren't exposed if no HCCS type on platform support
104                 this feature. Please note that decreasing lane number is only
105                 allowed if all the specified HCCS ports are not busy.
107                 The low power consumption interfaces are as follows:
109                 ============================= ==== ================================
110                 available_inc_dec_lane_types: (RO) available HCCS types (string) to
111                                                    increase and decrease the number
112                                                    of lane used, e.g. HCCS-v2.
113                 dec_lane_of_type:             (WO) input HCCS type supported
114                                                    decreasing lane to decrease the
115                                                    used lane number of all specified
116                                                    HCCS type ports on platform to
117                                                    the minimum.
118                                                    You can query the 'cur_lane_num'
119                                                    to get the minimum lane number
120                                                    after executing successfully.
121                 inc_lane_of_type:             (WO) input HCCS type supported
122                                                    increasing lane to increase the
123                                                    used lane number of all specified
124                                                    HCCS type ports on platform to
125                                                    the full lane state.
126                 ============================= ==== ================================