All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Marek Behún" <marek.behun@nic.cz>
To: Jassi Brar <jassisinghbrar@gmail.com>
Cc: "Jassi Brar" <jaswinder.singh@linaro.org>,
	linux-kernel@vger.kernel.org,
	"Gregory CLEMENT" <gregory.clement@bootlin.com>,
	"Miquel Raynal" <miquel.raynal@bootlin.com>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	linux-arm-kernel@lists.infradead.org, arm@kernel.org,
	"Marek Behún" <marek.behun@nic.cz>
Subject: [PATCH v3 mailbox+firmware 5/6] firmware: turris-mox-rwtm: Add sysfs documentation
Date: Fri, 15 Mar 2019 01:59:25 +0100	[thread overview]
Message-ID: <20190315005926.5994-6-marek.behun@nic.cz> (raw)
In-Reply-To: <20190315005926.5994-1-marek.behun@nic.cz>

Add sysfs ABI documentation for the sysfs files created by the
turris-mox-rwtm driver.

Signed-off-by: Marek Behún <marek.behun@nic.cz>
---
 .../testing/sysfs-firmware-turris-mox-rwtm    | 60 +++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm

diff --git a/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm b/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm
new file mode 100644
index 000000000000..ff6cd30f0cf2
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm
@@ -0,0 +1,60 @@
+What:		/sys/firmware/turris-mox-rwtm/board_version
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) Board version burned into eFuses of this Turris Mox board.
+		Format: %i
+
+What:		/sys/firmware/turris-mox-rwtm/do_sign
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(RW) Gate for writing requests for signature with the ECDSA
+		private key burned into eFuses during the manufacturing process,
+		and also for reading the resulting signature.
+
+		When requesting for signature, a SHA-512 hash of the message to
+		be signed should be written in binary form to this file. This
+		means that a write() operation into this file shall write
+		exactly 64 bytes, buffers of other size are ignored.
+
+		When the signature is done or the rWTM firmware responded with
+		an error, this file is notified via poll, and the result can
+		then be read. On error, the read() operation fails with errno
+		corresponding with the error. On success, 136 bytes are copied
+		to the buffer - 68 bytes for the R value and 68 for the S value
+		of the ECDSA signature, in binary form. These are 2 arrays of 17
+		32-bit words, in big-endian form, most significat word first.
+
+		Format: binary
+
+What:		/sys/firmware/turris-mox-rwtm/mac_address*
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) MAC addresses burned into eFuses of this Turris Mox board.
+		Format: %pM
+
+What:		/sys/firmware/turris-mox-rwtm/pubkey
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) ECDSA public key (in pubkey hex compressed form) computed
+		as pair to the ECDSA private key burned into eFuses of this
+		Turris Mox Board.
+		Format: string
+
+What:		/sys/firmware/turris-mox-rwtm/ram_size
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) RAM size in MiB of this Turris Mox board as was detected
+		during manufacturing and burned into eFuses. Can be 512 or 1024.
+		Format: %i
+
+What:		/sys/firmware/turris-mox-rwtm/serial_number
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) Serial number burned into eFuses of this Turris Mox device.
+		Format: %016X
-- 
2.19.2


WARNING: multiple messages have this Message-ID (diff)
From: "Marek Behún" <marek.behun@nic.cz>
To: Jassi Brar <jassisinghbrar@gmail.com>
Cc: "Gregory CLEMENT" <gregory.clement@bootlin.com>,
	linux-kernel@vger.kernel.org, "Marek Behún" <marek.behun@nic.cz>,
	"Jassi Brar" <jaswinder.singh@linaro.org>,
	arm@kernel.org, "Miquel Raynal" <miquel.raynal@bootlin.com>,
	"Linus Walleij" <linus.walleij@linaro.org>,
	linux-arm-kernel@lists.infradead.org
Subject: [PATCH v3 mailbox+firmware 5/6] firmware: turris-mox-rwtm: Add sysfs documentation
Date: Fri, 15 Mar 2019 01:59:25 +0100	[thread overview]
Message-ID: <20190315005926.5994-6-marek.behun@nic.cz> (raw)
In-Reply-To: <20190315005926.5994-1-marek.behun@nic.cz>

Add sysfs ABI documentation for the sysfs files created by the
turris-mox-rwtm driver.

Signed-off-by: Marek Behún <marek.behun@nic.cz>
---
 .../testing/sysfs-firmware-turris-mox-rwtm    | 60 +++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm

diff --git a/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm b/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm
new file mode 100644
index 000000000000..ff6cd30f0cf2
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-firmware-turris-mox-rwtm
@@ -0,0 +1,60 @@
+What:		/sys/firmware/turris-mox-rwtm/board_version
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) Board version burned into eFuses of this Turris Mox board.
+		Format: %i
+
+What:		/sys/firmware/turris-mox-rwtm/do_sign
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(RW) Gate for writing requests for signature with the ECDSA
+		private key burned into eFuses during the manufacturing process,
+		and also for reading the resulting signature.
+
+		When requesting for signature, a SHA-512 hash of the message to
+		be signed should be written in binary form to this file. This
+		means that a write() operation into this file shall write
+		exactly 64 bytes, buffers of other size are ignored.
+
+		When the signature is done or the rWTM firmware responded with
+		an error, this file is notified via poll, and the result can
+		then be read. On error, the read() operation fails with errno
+		corresponding with the error. On success, 136 bytes are copied
+		to the buffer - 68 bytes for the R value and 68 for the S value
+		of the ECDSA signature, in binary form. These are 2 arrays of 17
+		32-bit words, in big-endian form, most significat word first.
+
+		Format: binary
+
+What:		/sys/firmware/turris-mox-rwtm/mac_address*
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) MAC addresses burned into eFuses of this Turris Mox board.
+		Format: %pM
+
+What:		/sys/firmware/turris-mox-rwtm/pubkey
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) ECDSA public key (in pubkey hex compressed form) computed
+		as pair to the ECDSA private key burned into eFuses of this
+		Turris Mox Board.
+		Format: string
+
+What:		/sys/firmware/turris-mox-rwtm/ram_size
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) RAM size in MiB of this Turris Mox board as was detected
+		during manufacturing and burned into eFuses. Can be 512 or 1024.
+		Format: %i
+
+What:		/sys/firmware/turris-mox-rwtm/serial_number
+Date:		March 2019
+KernelVersion:	5.2
+Contact:	Marek Behún <marek.behun@nic.cz>
+Description:	(R) Serial number burned into eFuses of this Turris Mox device.
+		Format: %016X
-- 
2.19.2


_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  parent reply	other threads:[~2019-03-15  1:00 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-15  0:59 [PATCH v3 mailbox+firmware 0/6] Armada 37xx mailbox + Turris Mox secure firmware support Marek Behún
2019-03-15  0:59 ` Marek Behún
2019-03-15  0:59 ` [PATCH v3 mailbox+firmware 1/6] mailbox: Add support for Armada 37xx rWTM mailbox Marek Behún
2019-03-15  0:59   ` Marek Behún
2019-03-15  0:59 ` [PATCH v3 mailbox+firmware 2/6] dt-bindings: mailbox: Document armada-3700-rwtm-mailbox binding Marek Behún
2019-03-15  0:59   ` Marek Behún
2019-03-15  0:59 ` [PATCH v3 mailbox+firmware 3/6] arm64: dts: marvell: armada-37xx: add mailbox node Marek Behún
2019-03-15  0:59   ` Marek Behún
2019-03-15  0:59 ` [PATCH v3 mailbox+firmware 4/6] firmware: Add Turris Mox rWTM firmware driver Marek Behún
2019-03-15  0:59   ` Marek Behún
2019-03-15  0:59 ` Marek Behún [this message]
2019-03-15  0:59   ` [PATCH v3 mailbox+firmware 5/6] firmware: turris-mox-rwtm: Add sysfs documentation Marek Behún
2019-03-15  0:59 ` [PATCH v3 mailbox+firmware 6/6] dt-bindings: firmware: Document cznic,turris-mox-rwtm binding Marek Behún
2019-03-15  0:59   ` [PATCH v3 mailbox+firmware 6/6] dt-bindings: firmware: Document cznic, turris-mox-rwtm binding Marek Behún
2019-03-28 17:49   ` [PATCH v3 mailbox+firmware 6/6] dt-bindings: firmware: Document cznic,turris-mox-rwtm binding Rob Herring
2019-03-28 17:49     ` Rob Herring
2019-03-28 17:49     ` Rob Herring

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190315005926.5994-6-marek.behun@nic.cz \
    --to=marek.behun@nic.cz \
    --cc=arm@kernel.org \
    --cc=gregory.clement@bootlin.com \
    --cc=jassisinghbrar@gmail.com \
    --cc=jaswinder.singh@linaro.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=miquel.raynal@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.