Re: [PATCH v6 7/7] cdx: add device attributes

From: Randy Dunlap <rdunlap@infradead.org>
To: Nipun Gupta <nipun.gupta@amd.com>,
	robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org,
	gregkh@linuxfoundation.org, rafael@kernel.org,
	eric.auger@redhat.com, alex.williamson@redhat.com,
	cohuck@redhat.com, song.bao.hua@hisilicon.com,
	mchehab+huawei@kernel.org, maz@kernel.org, f.fainelli@gmail.com,
	jeffrey.l.hugo@gmail.com, saravanak@google.com,
	Michael.Srba@seznam.cz, mani@kernel.org, yishaih@nvidia.com,
	jgg@ziepe.ca, jgg@nvidia.com, robin.murphy@arm.com,
	will@kernel.org, joro@8bytes.org, masahiroy@kernel.org,
	ndesaulniers@google.com, linux-arm-kernel@lists.infradead.org,
	linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org,
	devicetree@vger.kernel.org
Cc: okaya@kernel.org, harpreet.anand@amd.com, nikhil.agarwal@amd.com,
	michal.simek@amd.com, git@amd.com
Subject: Re: [PATCH v6 7/7] cdx: add device attributes
Date: Thu, 26 Jan 2023 08:55:36 -0800	[thread overview]
Message-ID: <97a939cd-3898-3d54-e496-a8f33a62856a@infradead.org> (raw)
In-Reply-To: <20230126104630.15493-8-nipun.gupta@amd.com>

Hi--

On 1/26/23 02:46, Nipun Gupta wrote:
> diff --git a/Documentation/ABI/testing/sysfs-bus-cdx b/Documentation/ABI/testing/sysfs-bus-cdx
> index 8c2425fdb6d9..69bdbc891743 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cdx
> +++ b/Documentation/ABI/testing/sysfs-bus-cdx
> @@ -10,3 +10,47 @@ Description:
>                  For example::
>  
>  		  # echo 1 > /sys/bus/cdx/rescan
> +
> +What:		/sys/bus/cdx/devices/.../vendor
> +Date:		January 2023
> +Contact:	nipun.gupta@amd.com
> +Description:
> +		Vendor ID for this CDX device. Vendor ID is 16 bit
> +		identifier which is specific to the device manufacturer.
> +		Combination of Vendor ID and Device ID identifies a device.
> +
> +What:		/sys/bus/cdx/devices/.../device
> +Date:		January 2023
> +Contact:	nipun.gupta@amd.com
> +Description:
> +		Device ID for this CDX device. Device ID is a 16 bit
> +		identifier to identify a device type within the range
> +		of a device manufacturer.
> +		Combination of Vendor ID and Device ID identifies a device.
> +
> +What:		/sys/bus/cdx/devices/.../reset
> +Date:		January 2023
> +Contact:	nipun.gupta@amd.com
> +Description:

Reads better without "would":

> +		Writing a non-zero value to this file would reset the CDX> +		device. On resetting the device, the corresponding driver
> +		would be notified twice, once before the device is being
> +		reset, and again after the reset has been complete.

		Writing a non-zero value to this file resets the CDX
		device. On resetting the device, the corresponding driver
		is notified twice, once before the device is being
		reset, and again after the reset has been complete.

> +
> +                For example::
> +
> +		  # echo 1 > /sys/bus/cdx/.../reset
> +
> +What:		/sys/bus/cdx/devices/.../remove
> +Date:		January 2023
> +Contact:	tarak.reddy@amd.com
> +Description:
> +		Writing a non-zero value to this file would remove the
> +		corrosponding device from the CDX bus. If the device is
> +		to be reconfigured in the Hardware, the device can be
> +		removed, so that the device driver does not access the
> +		device while it is being reconfigured.

and: (also fix typo of corresponding)

		Writing a non-zero value to this file removes the
		corresponding device from the CDX bus. If the device is
		to be reconfigured in the Hardware, the device can be
		removed, so that the device driver does not access the
		device while it is being reconfigured.

> +
> +		For example::
> +
> +		  # echo 1 > /sys/bus/cdx/devices/.../remove

-- 
~Randy