diff options
author | Olivier Deprez <olivier.deprez@arm.com> | 2020-02-07 16:54:36 +0100 |
---|---|---|
committer | Olivier Deprez <olivier.deprez@arm.com> | 2020-02-12 11:26:36 +0100 |
commit | 3ac82b258eb106be97e34915b7e72ca54175b281 (patch) | |
tree | eea9eeb4fd02f5156e51a56c04e485eb342f1ef9 /docs | |
parent | fa764c865dfa2d7980ac006681064585ae07b9de (diff) | |
download | platform_external_arm-trusted-firmware-3ac82b258eb106be97e34915b7e72ca54175b281.tar.gz platform_external_arm-trusted-firmware-3ac82b258eb106be97e34915b7e72ca54175b281.tar.bz2 platform_external_arm-trusted-firmware-3ac82b258eb106be97e34915b7e72ca54175b281.zip |
doc: debugfs remove references section and add topic to components index
Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I8c2e6dc98f2f30a81f4f80cc0ca1232fed7a53c9
Diffstat (limited to 'docs')
-rw-r--r-- | docs/components/debugfs-design.rst | 23 | ||||
-rw-r--r-- | docs/components/index.rst | 1 |
2 files changed, 9 insertions, 15 deletions
diff --git a/docs/components/debugfs-design.rst b/docs/components/debugfs-design.rst index 06916f3d9..8ce1ba6a7 100644 --- a/docs/components/debugfs-design.rst +++ b/docs/components/debugfs-design.rst @@ -15,8 +15,9 @@ Virtual filesystem ------------------ The core functionality lies in a virtual file system based on a 9p file server -interface (`Notes on the Plan 9 Kernel Source`_). The implementation permits -exposing virtual files, firmware drivers, and file blobs. +interface (`Notes on the Plan 9 Kernel Source`_ and +`Linux 9p remote filesystem protocol`_). +The implementation permits exposing virtual files, firmware drivers, and file blobs. Namespace ~~~~~~~~~ @@ -77,10 +78,10 @@ SMC interface ------------- The communication with the 9p layer in BL31 is made through an SMC conduit -(`SMC Calling Convention PDD`_), using a specific SiP Function Id. An NS shared -buffer is used to pass path string parameters, or e.g. to exchange data on a -read operation. Refer to `ARM SiP Services`_ for a description of the SMC -interface. +(`SMC Calling Convention PDD`_), using a specific SiP Function Id. An NS +shared buffer is used to pass path string parameters, or e.g. to exchange +data on a read operation. Refer to `ARM SiP Services`_ for a description +of the SMC interface. Security considerations ----------------------- @@ -114,17 +115,9 @@ The SMC interface is accessible from an NS environment, that is: - a Linux kernel driver running at NS-EL1 - a Linux userspace application through the kernel driver -References ----------- - -.. [#] `SMC Calling Convention PDD`_ -.. [#] `Notes on the Plan 9 Kernel Source`_ -.. [#] `Linux 9p remote filesystem protocol`_ -.. [#] `ARM SiP Services`_ - -------------- -*Copyright (c) 2019, Arm Limited and Contributors. All rights reserved.* +*Copyright (c) 2019-2020, Arm Limited and Contributors. All rights reserved.* .. _SMC Calling Convention PDD: http://infocenter.arm.com/help/topic/com.arm.doc.den0028b/ .. _Notes on the Plan 9 Kernel Source: http://lsub.org/who/nemo/9.pdf diff --git a/docs/components/index.rst b/docs/components/index.rst index f1904c004..84425831b 100644 --- a/docs/components/index.rst +++ b/docs/components/index.rst @@ -8,6 +8,7 @@ Components spd/index arm-sip-service + debugfs-design exception-handling firmware-update platform-interrupt-controller-API |