From: Sasha Levin <sashal@kernel.org>
To: peterhuewe@gmx.de, jarkko.sakkinen@linux.intel.com, jgg@ziepe.ca
Cc: corbet@lwn.net, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org, linux-integrity@vger.kernel.org,
linux-kernel@microsoft.com, thiruan@microsoft.com,
bryankel@microsoft.com, tee-dev@lists.linaro.org,
ilias.apalodimas@linaro.org, sumit.garg@linaro.org,
rdunlap@infradead.org, Sasha Levin <sashal@kernel.org>
Subject: [PATCH v8 2/2] fTPM: add documentation for ftpm driver
Date: Fri, 5 Jul 2019 16:47:46 -0400 [thread overview]
Message-ID: <20190705204746.27543-3-sashal@kernel.org> (raw)
In-Reply-To: <20190705204746.27543-1-sashal@kernel.org>
This patch adds basic documentation to describe the new fTPM driver.
Signed-off-by: Sasha Levin <sashal@kernel.org>
---
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/tpm_ftpm_tee.rst | 27 +++++++++++++++++++++
2 files changed, 28 insertions(+)
create mode 100644 Documentation/security/tpm/tpm_ftpm_tee.rst
diff --git a/Documentation/security/tpm/index.rst b/Documentation/security/tpm/index.rst
index af77a7bbb070..15783668644f 100644
--- a/Documentation/security/tpm/index.rst
+++ b/Documentation/security/tpm/index.rst
@@ -4,4 +4,5 @@ Trusted Platform Module documentation
.. toctree::
+ tpm_ftpm_tee
tpm_vtpm_proxy
diff --git a/Documentation/security/tpm/tpm_ftpm_tee.rst b/Documentation/security/tpm/tpm_ftpm_tee.rst
new file mode 100644
index 000000000000..8c2bae16e3d9
--- /dev/null
+++ b/Documentation/security/tpm/tpm_ftpm_tee.rst
@@ -0,0 +1,27 @@
+=============================================
+Firmware TPM Driver
+=============================================
+
+This document describes the firmware Trusted Platform Module (fTPM)
+device driver.
+
+Introduction
+============
+
+This driver is a shim for firmware implemented in ARM's TrustZone
+environment. The driver allows programs to interact with the TPM in the same
+way they would interact with a hardware TPM.
+
+Design
+======
+
+The driver acts as a thin layer that passes commands to and from a TPM
+implemented in firmware. The driver itself doesn't contain much logic and is
+used more like a dumb pipe between firmware and kernel/userspace.
+
+The firmware itself is based on the following paper:
+https://www.microsoft.com/en-us/research/wp-content/uploads/2017/06/ftpm1.pdf
+
+When the driver is loaded it will expose ``/dev/tpmX`` character devices to
+userspace which will enable userspace to communicate with the firmware TPM
+through this device.
--
2.20.1
next prev parent reply other threads:[~2019-07-05 20:48 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-05 20:47 [PATCH v8 0/2] fTPM: firmware TPM running in TEE Sasha Levin
2019-07-05 20:47 ` [PATCH v8 1/2] " Sasha Levin
2019-07-11 20:04 ` Jarkko Sakkinen
2019-07-05 20:47 ` Sasha Levin [this message]
2019-07-11 20:05 ` [PATCH v8 2/2] fTPM: add documentation for ftpm driver Jarkko Sakkinen
2019-07-11 20:08 ` [PATCH v8 0/2] fTPM: firmware TPM running in TEE Jarkko Sakkinen
2019-07-11 20:10 ` Ilias Apalodimas
2019-07-11 20:35 ` Sasha Levin
2019-07-12 3:37 ` Jarkko Sakkinen
2019-07-15 9:05 ` Ilias Apalodimas
2019-08-01 16:35 ` Jarkko Sakkinen
2019-08-04 21:44 ` Jarkko Sakkinen
2019-08-05 18:05 ` Sasha Levin
2019-08-05 22:51 ` Jarkko Sakkinen
2019-08-08 1:08 ` Sasha Levin
2019-08-07 13:21 ` [Tee-dev] " Rouven Czerwinski
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=20190705204746.27543-3-sashal@kernel.org \
--to=sashal@kernel.org \
--cc=bryankel@microsoft.com \
--cc=corbet@lwn.net \
--cc=ilias.apalodimas@linaro.org \
--cc=jarkko.sakkinen@linux.intel.com \
--cc=jgg@ziepe.ca \
--cc=linux-doc@vger.kernel.org \
--cc=linux-integrity@vger.kernel.org \
--cc=linux-kernel@microsoft.com \
--cc=linux-kernel@vger.kernel.org \
--cc=peterhuewe@gmx.de \
--cc=rdunlap@infradead.org \
--cc=sumit.garg@linaro.org \
--cc=tee-dev@lists.linaro.org \
--cc=thiruan@microsoft.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).