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 A358EC46CA1 for ; Mon, 18 Sep 2023 07:24:02 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 3B71E6B026B; Mon, 18 Sep 2023 03:24:02 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 368136B026C; Mon, 18 Sep 2023 03:24:02 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 22FF76B026D; Mon, 18 Sep 2023 03:24:02 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 132526B026B for ; Mon, 18 Sep 2023 03:24:02 -0400 (EDT) Received: from smtpin14.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay10.hostedemail.com (Postfix) with ESMTP id D369BC0BFF for ; Mon, 18 Sep 2023 07:24:01 +0000 (UTC) X-FDA: 81248879082.14.F16AB59 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by imf14.hostedemail.com (Postfix) with ESMTP id 8206810000D for ; Mon, 18 Sep 2023 07:23:59 +0000 (UTC) Authentication-Results: imf14.hostedemail.com; dkim=pass header.d=redhat.com header.s=mimecast20190719 header.b=C1LmDzfA; dmarc=pass (policy=none) header.from=redhat.com; spf=pass (imf14.hostedemail.com: domain of david@redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=david@redhat.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1695021839; 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:dkim-signature; bh=0X6nPXSE7/E4A2/k0Un11UGzVNET9zDINiZ1CDm6B3I=; b=Q4apifBbaHSlVLS9Y5VPMPLgPTCP1WfH7Rotmu02Fn3+tFWld+zVq7GOMXfeygy3w3tPW1 hJgUQ+NjNWXWWQw093FaszGq3hUp9XT7oYIGRpoAd7xNfRYU1NUFN1BLic9rGN8wJE1ai1 doprAXUcApkmn5eBIMBBdXE/8D7mr8U= ARC-Authentication-Results: i=1; imf14.hostedemail.com; dkim=pass header.d=redhat.com header.s=mimecast20190719 header.b=C1LmDzfA; dmarc=pass (policy=none) header.from=redhat.com; spf=pass (imf14.hostedemail.com: domain of david@redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=david@redhat.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1695021839; a=rsa-sha256; cv=none; b=robt0t5T17fIUGBwx3ThPbPJfRNK1G6piB3Rzq50MfW3zT1VFzceIF3srTGk5DjloV+3/D hLz/GtGDDxlHeEhsdEujy+z9g1mnWxAhcuMmGV4lSJzjWOHe5hpX8RAYu7I2p90B+5AmNK h1WqjaA5lSHmhp74L07mLlS03RAStlo= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1695021838; h=from:from: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=0X6nPXSE7/E4A2/k0Un11UGzVNET9zDINiZ1CDm6B3I=; b=C1LmDzfAt3M2PMTT/cIFh0+ToJQ17IL9ffdjjERP7Y4KNnzi5GcHEMiYg+7C9ngIqyxSjU LAyB91X6ZTjmsKY1qz6x2ZFufRMxhbC4FXdIb6rQWfj9Dgqvalu//wMlbnrIWqgfk8O+jx 7t49sXM1+/yvLmFoPPCjeakCugYafXg= Received: from mail-wr1-f69.google.com (mail-wr1-f69.google.com [209.85.221.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-167-sQ1Z2KzRM1mAbdBPiYFqRg-1; Mon, 18 Sep 2023 03:23:54 -0400 X-MC-Unique: sQ1Z2KzRM1mAbdBPiYFqRg-1 Received: by mail-wr1-f69.google.com with SMTP id ffacd0b85a97d-31ff9e40977so1568608f8f.3 for ; Mon, 18 Sep 2023 00:23:53 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695021833; x=1695626633; h=content-transfer-encoding:in-reply-to:organization:from :content-language:references:cc:to:subject:user-agent:mime-version :date:message-id:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=0X6nPXSE7/E4A2/k0Un11UGzVNET9zDINiZ1CDm6B3I=; b=XSlbsMimzC2OJFVwfpY8j2oS8JgLTvt8sYIvisj4myxkvKt8Ckwtr4IBpD18oO9c+3 /znjhGQHQYliq+P1/k+EA0EGYjDIec5pxJ5q83jptJWW1NLKJmGY+TjLCoZFbFpp3dnO NkSEagp1EV/FRNdCN/Xq5JCocctkDB8LHReN6IuP8nRjAU/yR/63baJ5O6jU9/tE3kDm CuYyM5K5K4TpuodMCHIDRuC3vwUnUN4AlQUe7avLatAAeMn/OuCThBH4h+GOzOpiqQmh fPC7tqPbj08+0iMIawb4+tvKU7eansE5TOjaGkI9mo9j8Bjheeyqve74MeNHkFYkrbRR LWQw== X-Gm-Message-State: AOJu0Yya8xVxQWTDpYo7z1js3U86HnZ4T0B/sgmw1tT8aAomsWC2krIh lacxW+cYCXFtuW+15LWtkqvJq3qyAAy+ydDgRf3InG4oNRAHP6Hm0J/7GF5g/NaR0V1j6RK4n1m i7CAZqbswQzM= X-Received: by 2002:a05:6000:1f14:b0:320:93a:6273 with SMTP id bv20-20020a0560001f1400b00320093a6273mr3892313wrb.49.1695021832882; Mon, 18 Sep 2023 00:23:52 -0700 (PDT) X-Google-Smtp-Source: AGHT+IHIyCgcmFGegFagb9F0fyM3I9eD4NSBhk7L/MYBNHEWKeTUb+wBLOpIUnInAQZtY2UKF9U56g== X-Received: by 2002:a05:6000:1f14:b0:320:93a:6273 with SMTP id bv20-20020a0560001f1400b00320093a6273mr3892289wrb.49.1695021832512; Mon, 18 Sep 2023 00:23:52 -0700 (PDT) Received: from ?IPV6:2003:cb:c74b:3400:ec51:7a3a:274e:cbee? (p200300cbc74b3400ec517a3a274ecbee.dip0.t-ipconnect.de. [2003:cb:c74b:3400:ec51:7a3a:274e:cbee]) by smtp.gmail.com with ESMTPSA id ba13-20020a0560001c0d00b0031ddf6cc89csm8905269wrb.98.2023.09.18.00.23.51 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 18 Sep 2023 00:23:52 -0700 (PDT) Message-ID: <887344ee-068d-f78f-d5f8-e816b966d875@redhat.com> Date: Mon, 18 Sep 2023 09:23:50 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.13.0 Subject: Re: [RFC PATCH 3/9] Documentation/scrub-configure.rst: Add documentation for scrub driver To: shiju.jose@huawei.com, linux-acpi@vger.kernel.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org Cc: rafael@kernel.org, lenb@kernel.org, naoya.horiguchi@nec.com, tony.luck@intel.com, james.morse@arm.com, dave.hansen@linux.intel.com, jiaqiyan@google.com, jthoughton@google.com, somasundaram.a@hpe.com, erdemaktas@google.com, pgonda@google.com, rientjes@google.com, duenwen@google.com, Vilas.Sridharan@amd.com, mike.malvestuto@intel.com, gthelen@google.com, linuxarm@huawei.com, jonathan.cameron@huawei.com, tanxiaofei@huawei.com, prime.zeng@hisilicon.com References: <20230915172818.761-1-shiju.jose@huawei.com> <20230915172818.761-4-shiju.jose@huawei.com> From: David Hildenbrand Organization: Red Hat In-Reply-To: <20230915172818.761-4-shiju.jose@huawei.com> X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-Rspam-User: X-Stat-Signature: 3wp4ep7y7x4cxhg37n8rqhzr1qzmqacq X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 8206810000D X-HE-Tag: 1695021839-396728 X-HE-Meta: U2FsdGVkX1+kfx6jFdhD/9UdiF/TLXC1MnwrS9gqCVFpHRBlu8GLvlf01MahD/Qx842l5QeOQWIh6yQjWdar3SNDsIa9YPNpQ6DQl/rNXd2fHFgMjuBtvDNC4Y9dz9K/EEyR8tc8Du5VbxB8WRt6gpHhJHZ8ER5VwwT0U9sqkclIiKwM0oJV2DkhTqXH/jpTJyLJMJ5MCLaNXJGrUcHCvnBB+frYbaI30jNn1Fa2lzFryReNXCChU2vgE7SE5kIMVxHEiQO4iZXnrsVWJ8qwJSrizMYIGqRz5vZArH6XMV260V1JNQVoVamFQ4X9Z9rujGWrpvyJiH6KcAU7hc+sYwxxTgnuQIH3yxOmItlQ5PU3bv4zU204Jdj0nWu+X49Asba6IU6mezbXbg1Q5Srv+BxIwcZjpSmta1eoiKLIZ91zjWjymtOWYrE22rX4zc7vq5W4+8JPqyMGQWuU/jjgYKRzrz5Vcmy1p07rb7wN+FL+X1CSWf1YkyEbaX2YHKiQDI9DyulENa3eLahWicWe0VQ8GY4Y9Gtdg4gF/8s+2DGKAfmSy9ydZVG+LijjGRwztXYWI0OleyVC3A3nrMYBPULs0sZ95WlWF+E2Qbtql3oxUZvEpL2Tu92UZL4mYC78muDPj/QZ8+B9OfFPHU4Xywybtu9XokIjARfLgC/GSIhwiiSlP6dnqGbcdmrHGzA7Ki9MSwZvNApr/mn5rumxoPTjzJQvViSYpBRpZSKtrOTOHuV9Q3dkUp68JdDtAoq41MZu6x2SNYy+ld91hYaNOoFIi6qdpSIWscpmt5/v8h2aL5e8fkDYUQO6b9lVSc14JcvIJyyGivyWgEMYJiuTvkQ+B1Qx/1PnX12gFL7wLDtC1wPShDuf+KKhqG7vTfzMLSsHqhXgRNssKGZrTf5oU3SB7WdgVbXTxcNH7zTkpe6ZGO+4CfPQufBbo/iFAL/hnvvcu1AMNmyCKkX/9td ghObzbT+ Z/wJPhDapUNOvhgAX6X8rk1/HEPybK0vowmZRzQbY/MoxxqGOYxK4ufcYtCU3mFS2EkKq8303vsrn8rRfmo+TgbvC8yye8ncOdCQY2ovgB8vLPSyJn9Cvws+fYVU/Ft19bjBZwDqnCUAs0fNSNmDFE6w6rmQ96RJLWxLCd2rPkXM+vj1jc6Xer4dozn1cW5g5dnRk4VE9jsk5Ji9Q91A9h0U+Qt7Obb1p9lYa0Z6DneKZI1ozzNe1uYuyHkcauzWHGBWTTUip6F/GIC9rxHb//iF3z6Dwa8OiN+iNLd4ZxKGQAX13Pg+Y3Je2QgnaWMIrCpRPJ1NI5IaVudFkAEs3HOzpvxjeagjml+PHXmlskLULHcSbLVJftnWq3xIJ2UBpsecKXCP9fhrZR6d1sdhVY7pW/6bPyxiFYeud 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: On 15.09.23 19:28, shiju.jose@huawei.com wrote: > 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 "... interface for configuring memory scrubbers in the system." are we only configuring firmware/hw-based memory scrubbing? I assume so. > +parameters of memory scrubbers in the system. The scrub device drivers > +in the system register with the scrub configure subsystem. Maybe say a few words what memory scrubbing is, and what it is used for. > + > +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 Is it reasonable to return the speed as hex? You set it as dec. > + # cat /sys/class/scrub/scrub0/region0/addr_base > + # 0x100000 But didn't we set it to 0x300000 ... > + # cat /sys/class/scrub/scrub0/region0/addr_size > + # 0x200000 ... and didn't we set it to 0x100000 ? Or what's the magic happening here? > + > + # echo 0 > /sys/class/scrub/scrub0/region0/enable -- Cheers, David / dhildenb