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;
Message-ID: <082bfb32-be2a-0fc4-6818-2730e904c000@nvidia.com>
Date:   Mon, 5 Sep 2022 18:03:59 -0700
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.2.0
Subject: Re: [PATCH v9 8/8] ABI: sysfs-bus-pci: add documentation for p2pmem
 allocate
Content-Language: en-US
To:     Logan Gunthorpe <logang@deltatee.com>,
        linux-kernel@vger.kernel.org, linux-nvme@lists.infradead.org,
        linux-block@vger.kernel.org, linux-pci@vger.kernel.org,
        linux-mm@kvack.org
Cc:     Christoph Hellwig <hch@lst.de>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Dan Williams <dan.j.williams@intel.com>,
        Jason Gunthorpe <jgg@ziepe.ca>,
        =?UTF-8?Q?Christian_K=c3=b6nig?= <christian.koenig@amd.com>,
        Don Dutile <ddutile@redhat.com>,
        Matthew Wilcox <willy@infradead.org>,
        Daniel Vetter <daniel.vetter@ffwll.ch>,
        Minturn Dave B <dave.b.minturn@intel.com>,
        Jason Ekstrand <jason@jlekstrand.net>,
        Dave Hansen <dave.hansen@linux.intel.com>,
        Xiong Jianxin <jianxin.xiong@intel.com>,
        Bjorn Helgaas <helgaas@kernel.org>,
        Ira Weiny <ira.weiny@intel.com>,
        Robin Murphy <robin.murphy@arm.com>,
        Martin Oliveira <martin.oliveira@eideticom.com>,
        Chaitanya Kulkarni <ckulkarnilinux@gmail.com>,
        Ralph Campbell <rcampbell@nvidia.com>,
        Stephen Bates <sbates@raithlin.com>
References: <20220825152425.6296-1-logang@deltatee.com>
 <20220825152425.6296-9-logang@deltatee.com>
From:   John Hubbard <jhubbard@nvidia.com>
In-Reply-To: <20220825152425.6296-9-logang@deltatee.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TDl0NldZUDJlNzFVYkdPZ0x1S0J6ODREYXY0eXZRaXNMUkE3bzdDYlQzNXRl?=
 =?utf-8?B?MWhFeEYybHRoNEFNemRYLzZ3R2VyemxqaURtQWtNSjY0Slp0NklGVnB1UTNR?=
 =?utf-8?B?cFRXUWNrRHRFK0I1RUx4VFFCUWpnL2xIOHpNYWxVcW53VDJEUXgxM1VmVWZl?=
 =?utf-8?B?Uy84QzJ1bVVmeUdPR3NTQmRDTnN4L1NpK3pReUNjT00rNWhIS005RDI2Zkg0?=
 =?utf-8?B?RlF5MUxYUmdLcEkvL0dJVTlkbHJUMGtYcDdMN3lPRU5BTnNWY3RBMzdSWFk3?=
 =?utf-8?B?QTJoakgrNjNwOVNBS2t5eStCNTBaOFNTWEg5ME4wSytmeFFJVWx4UEhsWGxs?=
 =?utf-8?B?TzFRcThsdVNUU2ZDNUZCV1l2TXpoY1hQcVhIZldab0d4bkFVNFE1SkVCandt?=
 =?utf-8?B?Y0xUS2gvdG5QdVhheXpIbmFOTFpSYmdRQWdIaytINnNiNnhYZGZOV1FrV3ll?=
 =?utf-8?B?a3g1Y3hZT2tENHJuU05KMktySEVlTlRmTmdRN0c4cE1zWnM5SE1CWUdHOWJ1?=
 =?utf-8?B?TjBwS3UyMytYamdvVUZNYU5LdDhHVGY4SXlNZ3BGL0M1WmRQQ28ya2lsbno1?=
 =?utf-8?B?M1ZSeFIxQnFIS1VidVg2ZEQzeTdxZlhucXZsU0RwUDZqVkJNRFMyMit6MHZT?=
 =?utf-8?B?SGI5NGlHYThpcHhHWTV2UHlGNWppU3ZqQnFUWndKMUc1THpmRW0zaTU5dmlt?=
 =?utf-8?B?MnNBaUNvL0NKRVNvVDhnR0FHRTR1YmlnSExlR1plZ3E1aFAzWDh4dko3dHZp?=
 =?utf-8?B?T21Gd3hKcXNTQmY4ZS9nTnZGZlN0STBTZGI1eHNOR3FZWVBsK2hpVkszRG41?=
 =?utf-8?B?V1NzV0g3cmlEeWFJV08xa3FTVlIwbUY5ZVl2RUNaNEtwWFllR1krc3RQcnYr?=
 =?utf-8?B?ZFcrc2lGQnRIMzljV1Q1SE8wOHNUTEM1Y3BoZDFIYTRuNjNyUjUxVkVlV2pi?=
 =?utf-8?B?ZWRYYmk3SGh0ampJWUVCOE9FV2tHajJaMmIyQ3hNSFNwdDRsTTl5VzdJV2FW?=
 =?utf-8?B?eForbjdnTVdLWlQ4bHFPdkVCYUZ5RVF6M1dxOWFBN1daWVRwWVZkVFVtWkhW?=
 =?utf-8?B?Yzl3N0ZNdzhVMHo3MWFUb2tuYXdnQWhKUHNmTVBET0NSYmN0WHJvdlJFZGZj?=
 =?utf-8?B?TmxtYXVsTTRKTjRGNkxRVUpPUS81ckU0RFRFQkhUMmp5a3FwcldnWlNKWito?=
 =?utf-8?B?T3ZVZ2ZzYVJEaU5jMm1jaERSeThTaDg2TVNUa09iNWEyMTY1NHV2S0RiS3Fj?=
 =?utf-8?B?NmxtQ1o3NWlJZ2lQNUtTNnorM2wzVkt3UnZ1TEFrN2d4NHNUemZ5T2xmWjVM?=
 =?utf-8?B?MXhBd2FQeVE5R1ByVHRDRE5kMVcxdUk5Lzh3ZWd4NVZMWEhKZkdvbmlGRFhm?=
 =?utf-8?B?NzZGQVJSUWFXR1dsOTJlaHpCbTduYjVBMmpuZUgxMkRrd0FNc0w4VGRTa1ky?=
 =?utf-8?B?aVcybWV2SGYwMG1pTllQbFVjcmFoUk41dFo2SDA2S3JJTnplOTF2WnZONTYw?=
 =?utf-8?B?UE1mNTJpbVZGS1hHTEIzNnprak5lLy8zdmVDWC9tZDRMRVBBQ3dpOThieldt?=
 =?utf-8?B?U0FGRURhaE9RT3pVSG5Pc21PMWsrMUxKRDhMdWZocm5OdVllWEhob0EzUU1C?=
 =?utf-8?B?OGRkdWc1NkN3NzF4OWRxcS9URXNBc1hLTDhUcSszRXV0ZS9MbituV0RtNUY0?=
 =?utf-8?B?RlhjQkt5SmJRc3dLemdvV2xscEZianVEcW41dXJWRFRZcmRkakppTUU1TXJB?=
 =?utf-8?B?MEdZQ05OaVFyVGMrcnRmaGJ0bjI4K3Y4aFlxUkdrc1cvQVBqdTMvbmFRMUh6?=
 =?utf-8?B?R1FTZ1JpZzFVQ1FFTERuSGZldlJsUXloVDhkZUJjTVJTZlB2Q1V6bDVTdkN2?=
 =?utf-8?B?Ymc5YWVYN1U2T1ZHNjN5NEExcE9KeGxacEMxR0FrTTN3TzhIV05XQnBGZmw5?=
 =?utf-8?B?Q2UrclpwY2NydjE5bDM0M3V5T2VKNWM4aHFPZkRUM1VCdDJtZEp6UmFzWHVP?=
 =?utf-8?B?bXBuVjRCaVpBWWN1QjZ3QS9IUDRsbElFSnkyUFNWWWhINkpWam9DYWpITnRH?=
 =?utf-8?B?S2VuS2EwSmR2dytVbTdrSGlmT2l0VzJXMDB3ZnpqMzNlaGZ6VlhYV0lRVmJt?=
 =?utf-8?B?ekNSYldnbzIzdksxbThtTmJqZjhkaUxlMEl6bndPUUZzVTdNRnR3dXdvYlNP?=
 =?utf-8?B?b3c9PQ==?=
X-OriginatorOrg: Nvidia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 967079d0-7870-4ad5-e8dc-08da8fa3afd5
X-MS-Exchange-CrossTenant-AuthSource: BY5PR12MB4130.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Sep 2022 01:04:02.1475
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 1WokUuAzWVmkZrri9r6cNnFyD+S306FaIIT29ySSEbX1LSUQv9GNWj9byMRDfQVnFHbEazi73vQeodNvbm+yYQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR12MB6732
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
        DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FORGED_SPF_HELO,
        NICE_REPLY_A,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,
        SPF_NONE,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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 8/25/22 08:24, Logan Gunthorpe wrote:
> Add documentation for the p2pmem/allocate binary file which allows
> for allocating p2pmem buffers in userspace for passing to drivers
> that support them. (Currently only O_DIRECT to NVMe devices.)
> 
> Signed-off-by: Logan Gunthorpe <logang@deltatee.com>
> ---
>  Documentation/ABI/testing/sysfs-bus-pci | 12 +++++++++++-
>  1 file changed, 11 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-pci b/Documentation/ABI/testing/sysfs-bus-pci
> index 6fc2c2efe8ab..dca5e032b4fa 100644
> --- a/Documentation/ABI/testing/sysfs-bus-pci
> +++ b/Documentation/ABI/testing/sysfs-bus-pci
> @@ -171,7 +171,7 @@ Description:
>  		binary file containing the Vital Product Data for the
>  		device.  It should follow the VPD format defined in
>  		PCI Specification 2.1 or 2.2, but users should consider
> -		that some devices may have incorrectly formatted data.  
> +		that some devices may have incorrectly formatted data.
>  		If the underlying VPD has a writable section then the
>  		corresponding section of this file will be writable.
>  
> @@ -407,6 +407,16 @@ Description:
>  	        file contains a '1' if the memory has been published for
>  		use outside the driver that owns the device.
>  
> +What:		/sys/bus/pci/devices/.../p2pmem/allocate
> +Date:		August 2022
> +Contact:	Logan Gunthorpe <logang@deltatee.com>
> +Description:
> +		Thes attribute allows mapping p2pmem into userspace. For

s/Thes/This/

Actually, the sentence goes on to say "file", which refers to the same
thing as "attribute". So maybe just saying "This attribute" would be
slightly clearer? So:

		This file allows mapping p2pmem into userspace. For


With the typo fix and optionally the "attribute" change (up to you),
please feel free to add:

Reviewed-by: John Hubbard <jhubbard@nvidia.com>


thanks,

-- 
John Hubbard
NVIDIA

> +		each mmap() call on this file, the kernel will allocate
> +		a chunk of Peer-to-Peer memory for use in Peer-to-Peer
> +		transactions. This memory can be used in O_DIRECT calls
> +		to NVMe backed files for Peer-to-Peer copies.
> +
>  What:		/sys/bus/pci/devices/.../link/clkpm
>  		/sys/bus/pci/devices/.../link/l0s_aspm
>  		/sys/bus/pci/devices/.../link/l1_aspm