From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0F448EED61B for ; Fri, 15 Sep 2023 17:29:10 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 23F436B0362; Fri, 15 Sep 2023 13:29:09 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 1EF426B0364; Fri, 15 Sep 2023 13:29:09 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 068DA6B0366; Fri, 15 Sep 2023 13:29:09 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id EDAE36B0362 for ; Fri, 15 Sep 2023 13:29:08 -0400 (EDT) Received: from smtpin27.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id C5F711C9EA6 for ; Fri, 15 Sep 2023 17:29:08 +0000 (UTC) X-FDA: 81239517576.27.AEE59B2 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by imf28.hostedemail.com (Postfix) with ESMTP id E8BF0C0020 for ; Fri, 15 Sep 2023 17:29:06 +0000 (UTC) Authentication-Results: imf28.hostedemail.com; dkim=none; spf=pass (imf28.hostedemail.com: domain of shiju.jose@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=shiju.jose@huawei.com; dmarc=pass (policy=quarantine) header.from=huawei.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1694798947; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=gfs2p+DyXsPzwXua36eDZRhODnON6WUq3RWvT23VnpE=; b=F7A4kUSLFD74Yd9X0Dk2BGCT3yW0gBs6nnj19jWaXmDuz6i3V4Jufw5JMc14p3HzmgmEno UD5Az7o9p+fa9160JxXx4jf64UwphQzN6dBR4HFVcyRiIK+OqzhA0hLgfuOyrtZIDp2Kjr CRAfLLRCZuGSmLH8cNWHhqoeBuxAiC8= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1694798947; a=rsa-sha256; cv=none; b=naekG85dsJCiUu4LxNynLcwxbOiHeGRYmsT5b5Un4Ej8RzzWDi5k8O5Envy7+tjqaWv660 SqMAaaZG/8sdVgsAFPtgiUr6bBgFDoFanpnoKOtI55w/dvIDRd2IqZM+EvdSKn9D+f6uXv iUBr1VKxMs6IX5ypXFxvfQMR39wBDWI= ARC-Authentication-Results: i=1; imf28.hostedemail.com; dkim=none; spf=pass (imf28.hostedemail.com: domain of shiju.jose@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=shiju.jose@huawei.com; dmarc=pass (policy=quarantine) header.from=huawei.com Received: from lhrpeml500006.china.huawei.com (unknown [172.18.147.200]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4RnLkc52pkz6K6LZ; Sat, 16 Sep 2023 01:28:24 +0800 (CST) Received: from SecurePC30232.china.huawei.com (10.122.247.234) by lhrpeml500006.china.huawei.com (7.191.161.198) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.31; Fri, 15 Sep 2023 18:29:04 +0100 From: To: , , CC: , , , , , , , , , , , , , , , , , , , , , Subject: [RFC PATCH 3/9] Documentation/scrub-configure.rst: Add documentation for scrub driver Date: Sat, 16 Sep 2023 01:28:12 +0800 Message-ID: <20230915172818.761-4-shiju.jose@huawei.com> X-Mailer: git-send-email 2.35.1.windows.2 In-Reply-To: <20230915172818.761-1-shiju.jose@huawei.com> References: <20230915172818.761-1-shiju.jose@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.122.247.234] X-ClientProxiedBy: lhrpeml500001.china.huawei.com (7.191.163.213) To lhrpeml500006.china.huawei.com (7.191.161.198) X-CFilter-Loop: Reflected X-Rspamd-Queue-Id: E8BF0C0020 X-Rspam-User: X-Stat-Signature: noske7qu1nqbo44qtoka3gyzwhe8pdu9 X-Rspamd-Server: rspam03 X-HE-Tag: 1694798946-927003 X-HE-Meta: U2FsdGVkX1+66VA1MLE6uX9oc8ie/llnVtmGRQkJCklx6GvmMLV1l0bz5eTFIwkgyED99K7DnxEIM8EZb5cvGJn09LkENxseO4rs2bWXGCHH97ZDFUIRqnVUrZwbS8IVHxhC3rtmkm9HhHbYLtyxTj8yEwrp0JheoIdMTMWpC9Tw6BJCzji2xcMNGx231IukAyeB67MJMrdFMxY/25QCZvzoyOMnLrmPj5VNf73FeDKyUEHVTPKMSTTYIkvD2it4Yw4cqe2lsYiQkM5iDlBiErOj+U3r8G1yYvisfyJ4TDS83FrLWUOTwr04ylzUmjsRJF1JXCVR0RUL3wqPTNhahsx/KK+gViOmMPaIh0Z6riyxHCLqC7vOgM37CtUAPoIIaR946YaLRzhyDQAbiyYhc+VvyXIbxztBBEOXxg5EvIKxOATCrfWZGNkg/KaaYosYHBZoSh4mRHOsqLUUuZwqdYUdn2N+dWcbnSvZLFk9KEi8ieYs5dn1sGx1v1VhnkG3Df7uwBJpP8RLdU+5QVtv8aP9JOAO2E2phcey1gMoSynJUVzQQ5DexWARXmJcrJpCRqzW1opb0J7+dYTSVycmb23rE7QNIEoZKfGIN7MfxYf7Lz0efUECBzXRwnGnaalXF5Q509eQLDeaFPv7cgAs+JFjOfdRxrdqj1/3sKJXaMZCDznd8FutXzUkrqSbKrQf3hupvXaKW7GHuaP48s7xYWDcWxBiBJIttLL2Ds9BvDQg3hG9C/diAzmD1ApQ8o12nC6I8jFCvuptp/bYWOOF1SHhgpyHZ22QWQUsDQKEIyaMIP18WvwTKv0j5A+Pr1zu4z3NDMjXFj/DJQ4nTMs5oegRVapfk1hT0WjcwEdh7wZDmtEALMTp5jIcU7lfGXw1H2VISU/RPwU1lXUkfes2qKtvqnVBHk7IXrCKLjQwmv/1ctO+OasbRVqfkvOM5fHMk/krPh2UUfAthEFTFZ5 piootqvO Wrc1XdvVImB3p+mK4259ZmSLEKCMTrGjKuzxHLZrhGoZMAPb4x77jR6nWPqPB2dsELD8txrZmuPeOsgJITRYd4g10Z8dVxPPZklcfY3PZk/Vt5yeB1/MQ+p1gqh34xfdLi58xTC0jpQVySQ8= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: From: Shiju Jose Add documentation for scrub driver, supports configure scrub parameters, in Documentation/scrub-configure.rst Signed-off-by: Shiju Jose --- Documentation/scrub-configure.rst | 55 +++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 Documentation/scrub-configure.rst diff --git a/Documentation/scrub-configure.rst b/Documentation/scrub-configure.rst new file mode 100644 index 000000000000..9f8581b88788 --- /dev/null +++ b/Documentation/scrub-configure.rst @@ -0,0 +1,55 @@ +========================== +Scrub subsystem driver +========================== + +Copyright (c) 2023 HiSilicon Limited. + +:Author: Shiju Jose +:License: The GNU Free Documentation License, Version 1.2 + (dual licensed under the GPL v2) +:Original Reviewers: + +- Written for: 6.7 +- Updated for: + +Introduction +------------ +The scrub subsystem driver provides the interface for configure the +parameters of memory scrubbers in the system. The scrub device drivers +in the system register with the scrub configure subsystem. + +The scrub configure driver exposes the scrub controls to the user +via sysfs. + +The File System +--------------- + +The configuration parameters of the registered scrubbers could be +accessed via the /sys/class/scrub/scrubX/regionN/ + +sysfs +----- + +Sysfs files are documented in +`Documentation/ABI/testing/sysfs-class-scrub-configure`. + +Example +------- + + The usage takes the form shown in this example:: + + # echo 0x300000 > /sys/class/scrub/scrub0/region0/addr_base + # echo 0x100000 > /sys/class/scrub/scrub0/region0/addr_size + # cat /sys/class/scrub/scrub0/region0/speed_available + # 1-60 + # echo 25 > /sys/class/scrub/scrub0/region0/speed + # echo 1 > /sys/class/scrub/scrub0/region0/enable + + # cat /sys/class/scrub/scrub0/region0/speed + # 0x19 + # cat /sys/class/scrub/scrub0/region0/addr_base + # 0x100000 + # cat /sys/class/scrub/scrub0/region0/addr_size + # 0x200000 + + # echo 0 > /sys/class/scrub/scrub0/region0/enable -- 2.34.1