Skip to content

Commit 55212e4

Browse files
committed
doc: update the doc of library secureshield
Signed-off-by: Yiping Peng <[email protected]>
1 parent 16d5b85 commit 55212e4

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

doc/documents/lib/secureshield.rst

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Memory Mapped Resources
7272
^^^^^^^^^^^^^^^^^^^^^^^
7373

7474
The memory mapped resources are resources that are mapped into memory address
75-
space, e.g. ram, rom, peripherals (UART/I2/SPI). Memory mapped resources are
75+
space, e.g. ram, rom, peripherals (UART/I2C/SPI). Memory mapped resources are
7676
isolated and protected by the MPU.
7777

7878
System Resources
@@ -143,22 +143,22 @@ An access-control table example is shown below:
143143
.. code-block:: c
144144
145145
 static CONTAINER_AC_TABLE g_container_act[] = {
146-
/* memory mapper peripheral, {start_address, size in bytes, type | access} */
146+
/* memory mapper peripheral, {start_address, size in bytes, type | access} */
147147
  {(void *)(PERIPHERAL_ADDR_BASE + REL_REGBASE_PINMUX), 0x1000, SECURESHIELD_ACDEF_UPERIPH},
148148
  /* memory, {start_address, size in bytes, type | access} */
149-
{(void *)0x10000, 0x1000, SECURESHIELD_ACDEF_URAM},
150-
/* system resources-interrupt, {interrupt handler, interrupt no, type} */
151-
{default_interrupt_handler, INTNO_GPIO, SECURESHIELD_AC_IRQ},
152-
/* system resources-auxiliary registers, {start_address, size, type}*/
153-
{(void *)0x21, 0x3, SECURESHIELD_AC_AUX},
154-
/* container interface, {interface handler, number of interface handler arguments, type} */
155-
{tst_func4, 4, SECURESHIELD_AC_INTERFACE},
149+
{(void *)0x10000, 0x1000, SECURESHIELD_ACDEF_URAM},
150+
/* system resources-interrupt, {interrupt handler, interrupt no, type} */
151+
{default_interrupt_handler, INTNO_GPIO, SECURESHIELD_AC_IRQ},
152+
/* system resources-auxiliary registers, {start_address, size, type}*/
153+
{(void *)0x21, 0x3, SECURESHIELD_AC_AUX},
154+
/* container interface, {interface handler, number of interface handler arguments, type} */
155+
{tst_func4, 4, SECURESHIELD_AC_INTERFACE},
156156
 };
157157
158158
According to this access control table, the container is allocated the
159159
peripheral area of PIN_MUX, a 0x1000 bytes ram region starting from 0x10000, a
160160
GPIO interrupt (INTNO_GPIO), an auxiliary-register area starting from 0x21
161-
with a size of 03. The container also has an interface (tst_func4) to provide
161+
with a size of 0x3. The container also has an interface (tst_func4) to provide
162162
the service with 4 arguments in the interface handler function
163163

164164
The resource type describes the kind of resource, such as interrupt, register,
@@ -186,7 +186,7 @@ services. The following SecureShield runtime services are provided:
186186

187187
- container call: call the services provided by other containers
188188

189-
- interrupt management: see secureshield_int_exports.h
189+
- interrupt management: see ``secureshield_int_exports.h``
190190

191191
- auxiliary-register access and benchmark function: see
192192
``secureshield_sys_ops_exports.h``
@@ -223,7 +223,7 @@ interface must first be registered in the access control table. The background
223223
container has no interface as its resources are shared to all other
224224
containers.
225225

226-
To call a container interface, container all is required. The following is an
226+
To call a container interface, container call is required. The following is an
227227
example.
228228

229229

@@ -284,7 +284,7 @@ containers, is in normal memory (normal rom and ram). The secure world,
284284
consisting of secure containers, is in secure memory (secure rom and ram). In
285285
each world, containers are isolated with each other through MPU, an address
286286
alignment is also required. Besides secure containers, SecureShield runtime,
287-
can be viewed as a special secure container, is in secure memory with a fixed
287+
can be regarded as a special secure container, is in secure memory with a fixed
288288
position. SecureShield runtime will be compiled and linked independently with
289289
the application, so it's a black box to application.
290290

@@ -329,7 +329,7 @@ Steps to Create a SecureShield Application
329329
- APPL_SECURE_CSRC_DIR (optional), the directories of C source files which
330330
need to be compiled and linked with SecureShield runtime
331331

332-
- SECURE_SYMBOL_LIST (optional ), the file of symbols need to be exported to
332+
- SECURE_SYMBOL_LIST (optional), the file of symbols need to be exported to
333333
normal application from secure binary
334334

335335
2. Container Memory Configuration File (secureshield_appl_config.h)
@@ -430,11 +430,18 @@ Upon compiling and linking, the following files will be generated:
430430

431431
- linker_xx.ldf: the generated linker script for normal application
432432

433-
- the generated linker script for secure binary
433+
- secure_linker_xx.ldf: the generated linker script for secure binary
434434

435435
- secureshield_secure.bin/elf: secure binary
436436

437437
- secureshield_secure.syms: the exported secure symbol list
438438

439+
- <app_name>_xx_xx.bin/elf: normal application binary
440+
439441
SecureShield Application Examples
440442
=================================
443+
444+
* :ref:`example_secureshield_secret_normal`
445+
* :ref:`example_secureshield_secret_secure`
446+
* :ref:`example_secureshield_secret_secure_sid`
447+
* :ref:`example_secureshield_test_case`

0 commit comments

Comments
 (0)