[PATCH RESEND v3 2/2] doc: soc: hisilicon: Add Kunpeng HCCS driver documentation

[lihuisong (C)]

在 2023/7/25 16:59, Wei Xu 写道:
> Hi Huisong,
>
> On 2023/7/25 15:57, Huisong Li wrote:
>> Document the sysfs attributes description provided by HCCS driver on
>> Kunpeng SoC.
>>
>> Signed-off-by: Huisong Li <lihuisong at huawei.com>
>> ---
>>   .../sysfs-devices-platform-kunpeng_hccs       | 76 +++++++++++++++++++
>>   MAINTAINERS                                   |  1 +
>>   2 files changed, 77 insertions(+)
>>   create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-kunpeng_hccs
>>
>> diff --git a/Documentation/ABI/testing/sysfs-devices-platform-kunpeng_hccs b/Documentation/ABI/testing/sysfs-devices-platform-kunpeng_hccs
>> new file mode 100644
>> index 000000000000..83ebed801249
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-devices-platform-kunpeng_hccs
>> @@ -0,0 +1,76 @@
>> +What:		/sys/devices/platform/HISI04Bx:00/chipX/all_linked
>> +		/sys/devices/platform/HISI04Bx:00/chipX/linked_full_lane
>> +		/sys/devices/platform/HISI04Bx:00/chipX/crc_err_cnt
>> +Date:		May 2023
> Please update the date to "November 2023" to match the 6.6 kernel.
Ack. will fix in next version.
>
>> +KernelVersion:	6.6
>> +Contact:	Huisong Li <lihuisong at huawei.org>
>> +Description:
>> +		The /sys/devices/platform/HISI04Bx:00/chipX/ directory
>> +		contains read-only attributes exposing some summarization
>> +		information of all HCCS ports under a specified chip.
>> +		The X in 'chipX' indicates the Xth chip on platform.
>> +
>> +		There are following attributes in this directory:
>> +		================= ==== =========================================
>> +		all_linked:       (RO) if all enabled ports on this chip are
>> +				       linked (bool).
>> +		linked_full_lane: (RO) if all linked ports on this chip are full
>> +				       lane (bool).
>> +		crc_err_cnt:      (RO) total CRC err count for all ports on this
>> +				       chip.
>> +		============= ==== =============================================
>> +
>> +What:		/sys/devices/platform/HISI04Bx:00/chipX/dieY/all_linked
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/linked_full_lane
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/crc_err_cnt
>> +Date:		May 2023
> Ditto.
Ack
>
>> +KernelVersion:	6.6
>> +Contact:	Huisong Li <lihuisong at huawei.org>
>> +Description:
>> +		The /sys/devices/platform/HISI04Bx:00/chipX/dieY/ directory
>> +		contains read-only attributes exposing some summarization
>> +		information of all HCCS ports under a specified die.
>> +		The Y in 'dieY' indicates the hardware id of the die on chip who
>> +		has chip id X.
>> +
>> +		There are following attributes in this directory:
>> +		================= ==== =========================================
>> +		all_linked:       (RO) if all enabled ports on this die are
>> +				       linked (bool).
>> +		linked_full_lane: (RO) if all linked ports on this die are full
>> +				       lane (bool).
>> +		crc_err_cnt:      (RO) total CRC err count for all ports on this
>> +				       die.
>> +		============= ==== =============================================
>> +
>> +What:		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/type
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/lane_mode
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/enable
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/cur_lane_num
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/lane_mask
>> +		/sys/devices/platform/HISI04Bx:00/chipX/dieY/hccsN/crc_err_cnt
>> +Date:		May 2023
> Ditto.

Ack

>
>> +KernelVersion:	6.6
>> +Contact:	Huisong Li <lihuisong at huawei.org>
>> +Description:
>> +		The /sys/devices/platform/HISI04Bx/chipX/dieX/hccsN/ directory
>> +		contains read-only attributes exposing information about
>> +		a HCCS port. The N value in 'hccsN' indicates this port id.
>> +		The X in 'chipX' indicates the ID of the chip to which the
>> +		HCCS port belongs. For example, X ranges from to 'n - 1' if the
>> +		chip number on platform is n.
>> +		The Y in 'dieY' indicates the hardware id of the die to which
>> +		the hccs port belongs.
>> +
>> +		The HCCS port have the following attributes:
>> +		============= ==== =============================================
>> +		type:         (RO) port type (string), e.g. HCCS-v1 -> H32
>> +		lane_mode:    (RO) the lane mode of this port (string), e.g. x8
>> +		enable:       (RO) indicate if this port is enabled (bool).
>> +		cur_lane_num: (RO) current lane number of this port.
>> +		lane_mask:    (RO) current lane mask of this port, every bit
>> +			           indicates a lane.
>> +		crc_err_cnt:  (RO) CRC err count on this port.
>> +		============= ==== =============================================
>> +		Note: type, lane_mode and enable are fixed attributes on
>> +		      running platform.
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 4e55ff992171..7a34bab232eb 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -9474,6 +9474,7 @@ F:	drivers/crypto/hisilicon/zip/
>>   HISILICON KUNPENG SOC HCCS DRIVER
>>   M:	Huisong Li <lihuisong at huawei.com>
>>   S:	Maintained
>> +F:	Documentation/ABI/testing/sysfs-devices-platform-kunpeng_hccs
>>   F:	drivers/soc/hisilicon/kunpeng_hccs.c
>>   F:	drivers/soc/hisilicon/kunpeng_hccs.h
>>   
>>
> .