Received: by 2002:a05:6358:701b:b0:131:369:b2a3 with SMTP id 27csp4166791rwo; Tue, 25 Jul 2023 01:26:44 -0700 (PDT) X-Google-Smtp-Source: APBJJlHVp/7bsbOX/sIexeHSTTthi1/3laq1YW5Wq91qWUBnMssgB4A1vZ3fJBR6xvaearshQ/F2 X-Received: by 2002:a17:90a:9f97:b0:268:2f6:61c4 with SMTP id o23-20020a17090a9f9700b0026802f661c4mr2343732pjp.12.1690273604010; Tue, 25 Jul 2023 01:26:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1690273603; cv=none; d=google.com; s=arc-20160816; b=ddEwZl/vioSjwANInKU3JmC9Coa34gsYbI6UrJv+wj3w1ESJaCB+ONc16VOSIuGHI+ L0nGJ21FrfRPSOtqSW34z3Jt85I/gP8KINTtELP7W9s3JAccslCWdprfqLZ5vjlpf/2N ilNGH722OP4H+BWjc0XZOREAXDQa9PhZ234cV8pQHwYqIK5BgInH84AmygwSK37Dom8K gtJfkrxydelQWW4LlDI5BDR9pvcd/VmQx9kTCb0Hr5ksJSjBPYFtqkbuVK658PZnIffD jEA6j2ZAyCdjdcgPeNd9t0SYZVc9HrFKPDsmcLQIr8/3KRZgvwZRCHl8hZ4OPEI8QiYa ilbw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=ES7DhNg4TT3WA1UjO3jocUXfY5odeofm/cJycug0gDo=; fh=S6i4gsbwxQEH6OXkC3rwSXMeGU402UmdwIL4qhxuhpk=; b=gtknmmO2apD3GTI1M8KEi1sCDs3G+OpLsf3bKpTJ18cracHC8TLp0SmEN/N8jqOh3N /OfKdiksdv0QgbE9aVkjR4Q696VCOivVtWtBSyfONDR4FEgxbTKwbeBP6Xf51LqLToHz HdXH2X5WyCop9t0y2AepTWe0xFNl0ErIwJyjdvMYQRsFpKGPQBT9XCjJaeIl5FeduVkE KsykH1l8mwV8G6WPeH/fVo7X/w81gpAsZL78PxRl99ExyPJTkgmrr1XqECVq3pgEnqsz PU4emTmvMQMEUSdEnrklkwmpNQjMH4rmHLkxC6y1efXVbIfH+0mh5YxWTRfN7OJInzy8 sGVw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id b14-20020a170903228e00b001b89bfd0c34si7329727plh.18.2023.07.25.01.26.31; Tue, 25 Jul 2023 01:26:43 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232229AbjGYH74 (ORCPT + 99 others); Tue, 25 Jul 2023 03:59:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38646 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232068AbjGYH7y (ORCPT ); Tue, 25 Jul 2023 03:59:54 -0400 Received: from szxga02-in.huawei.com (szxga02-in.huawei.com [45.249.212.188]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6EF3711B for ; Tue, 25 Jul 2023 00:59:52 -0700 (PDT) Received: from kwepemm600004.china.huawei.com (unknown [172.30.72.54]) by szxga02-in.huawei.com (SkyGuard) with ESMTP id 4R98Xm5xpYzVjrS; Tue, 25 Jul 2023 15:58:16 +0800 (CST) Received: from localhost.localdomain (10.69.192.56) by kwepemm600004.china.huawei.com (7.193.23.242) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Tue, 25 Jul 2023 15:59:48 +0800 From: Huisong Li To: , , , CC: , , , , , , Subject: [PATCH RESEND v3 2/2] doc: soc: hisilicon: Add Kunpeng HCCS driver documentation Date: Tue, 25 Jul 2023 15:57:06 +0800 Message-ID: <20230725075706.48939-3-lihuisong@huawei.com> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20230725075706.48939-1-lihuisong@huawei.com> References: <20230424073020.4039-1-lihuisong@huawei.com> <20230725075706.48939-1-lihuisong@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7BIT Content-Type: text/plain; charset=US-ASCII X-Originating-IP: [10.69.192.56] X-ClientProxiedBy: dggems705-chm.china.huawei.com (10.3.19.182) To kwepemm600004.china.huawei.com (7.193.23.242) X-CFilter-Loop: Reflected X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_MED, RCVD_IN_MSPIKE_H5,RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Document the sysfs attributes description provided by HCCS driver on Kunpeng SoC. Signed-off-by: Huisong Li --- .../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 +KernelVersion: 6.6 +Contact: Huisong Li +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 +KernelVersion: 6.6 +Contact: Huisong Li +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 +KernelVersion: 6.6 +Contact: Huisong Li +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 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 -- 2.33.0