Re: [PATCH v9 5/5] nvmem: eeprom: add documentation of sysfs fram and sernum file

[Greg Kroah-Hartman]

On Fri, Jun 11, 2021 at 07:26:52AM +0200, Jiri Prchal wrote:
> Added sysfs fram and sernum file documentation.
> 
> Signed-off-by: Jiri Prchal <jiri.prchal@xxxxxxxxxxx>
> ---
> v5: new
> v6: no change here
> v7: no change here
> v8: added fram file doc
> v9: rewritten description
> ---
>  .../ABI/testing/sysfs-class-spi-eeprom        | 20 +++++++++++++++++++
>  1 file changed, 20 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-class-spi-eeprom
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-spi-eeprom b/Documentation/ABI/testing/sysfs-class-spi-eeprom
> new file mode 100644
> index 000000000000..4e69c78f9f65
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-spi-eeprom
> @@ -0,0 +1,20 @@
> +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/sernum
> +Date:		May 2021
> +KernelVersion:	5.14
> +Contact:	Jiri Prchal <jiri.prchal@xxxxxxxxxxx>
> +Description:
> +	Contains the serial number of the Cypress FRAM (FM25VN) if it is
> +	present.  It will be displayed as a 8 byte hex string, as read
> +	from the device.
> +
> +	This is a read-only attribute.
> +
> +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/fram
> +Date:		June 2021
> +KernelVersion:	5.14
> +Contact:	Jiri Prchal <jiri.prchal@xxxxxxxxxxx>
> +Description:
> +	Contains the FRAM binary data. Same as EEPROM, just another file
> +	name to indicate that it employs ferroelectric process.
> +	It performs write operations at bus speed - no write delays, capable
> +	of 10^14 read/write cycles and 151 years data retention.

Are you sure of these statistics?  Don't promise something here that
might not be true, this is not a marketing document :)

thanks,

greg k-h