diff mbox series

[v8,5/5] nvmem: eeprom: add documentation of sysfs fram and sernum file

Message ID 20210607161201.223697-6-jiri.prchal@aksignal.cz
State New
Headers show
Series add support for FRAM | expand

Commit Message

Jiri Prchal June 7, 2021, 4:12 p.m. UTC
Added sysfs fram and sernum file documentation.

Signed-off-by: Jiri Prchal <jiri.prchal@aksignal.cz>
---
v5: new
v6: no change here
v7: no change here
v8: added fram file doc
---
 Documentation/ABI/testing/sysfs-class-spi-eeprom | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-spi-eeprom

Comments

Greg KH June 8, 2021, 9:05 a.m. UTC | #1
On Mon, Jun 07, 2021 at 06:12:01PM +0200, Jiri Prchal wrote:
> Added sysfs fram and sernum file documentation.
> 
> Signed-off-by: Jiri Prchal <jiri.prchal@aksignal.cz>
> ---
> v5: new
> v6: no change here
> v7: no change here
> v8: added fram file doc
> ---
>  Documentation/ABI/testing/sysfs-class-spi-eeprom | 13 +++++++++++++
>  1 file changed, 13 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..b41420fe1329
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-spi-eeprom
> @@ -0,0 +1,13 @@
> +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/sernum
> +Date:		May 2021
> +KernelVersion:	5.13
> +Contact:	Jiri Prchal <jiri.prchal@aksignal.cz>
> +Description:
> +		(RO) Exports serial number of Cypress FRAM (FM25VN). 8 bytes as is in chip in hex string.

Please properly wrap your lines.

What is "(RO)" here?

And the grammer is a bit odd, what is the second sentence supposed to
mean?

> +
> +What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/fram
> +Date:		June 2021
> +KernelVersion:	5.13

Obviously it can not make 5.13, right?

> +Contact:	Jiri Prchal <jiri.prchal@aksignal.cz>
> +Description:
> +		(RW) FRAM data.

I have no idea what that is, do you?

Please provide real documentation for these entries.

thannks,

greg k-h
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-spi-eeprom b/Documentation/ABI/testing/sysfs-class-spi-eeprom
new file mode 100644
index 000000000000..b41420fe1329
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-spi-eeprom
@@ -0,0 +1,13 @@ 
+What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/sernum
+Date:		May 2021
+KernelVersion:	5.13
+Contact:	Jiri Prchal <jiri.prchal@aksignal.cz>
+Description:
+		(RO) Exports serial number of Cypress FRAM (FM25VN). 8 bytes as is in chip in hex string.
+
+What:		/sys/class/spi_master/spi<bus>/spi<bus>.<dev>/fram
+Date:		June 2021
+KernelVersion:	5.13
+Contact:	Jiri Prchal <jiri.prchal@aksignal.cz>
+Description:
+		(RW) FRAM data.