ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit Readme.md 

Copy edit file, mostly for minor grammar nits.
pull/6794/head
Amanda Butler 2018-05-07 15:13:22 -05:00 committed by Ron Eldor
parent 7cdfd91bf8
commit de2e4875fd
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
features/mbedtls/targets/TARGET_CRYPTOCELL310/Readme.md
View File

@ -1,21 +1,22 @@
# Guidelines for porting Cryptocell to Mbed OS
Cryptocell (CC) 310 is a Hardware accelerator that can be ported to several boards, assuming these boards have CC 310 embedded in their Hardware.
CC 310 driver is consisted of three libraries:
Cryptocell (CC) 310 is a hardware accelerator that can be ported to several boards, assuming these boards have CC 310 embedded in their hardware.
* A common core library(`libcc_core.a`)
* A platform specific trng library, containing trng related information, for sampling sufficient entropy on the specific platform(`libcc_trng.a`)
* A platform specific library containig extra information, such as the CC register's base addresses on the specific board.(`libcc_ext.a`)
The CC 310 driver consists of three libraries:
In order to port your CC 310 driver to Mbed OS, on your specific target, do the following:
* A common core library(`libcc_core.a`).
* A platform-specific TRNG library, containing TRNG-related information, for sampling sufficient entropy on the specific platform(`libcc_trng.a`).
* A platform-specific library containig extra information, such as the CC register's base addresses on the specific board. (`libcc_ext.a`)
To port your CC 310 driver to Mbed OS on your specific target, do the following:
1. In `targets.json` add the following to your target:
* `MBEDTLS_CONFIG_HW_SUPPORT` to `macros_add` key.
* `CRYPTOCELL` to `device_has_add` key.
* `CRYPTOCELL310` to `extra_labels_add` key.
1. In `objects.h` include `objects_cryptocell.h`.(You can condition it with `#if DEVICE_CRYPTOCELL` in case you have another `trng` engine for a differnt board, and `objects.h` is common file for your boards, in this case your common `trng_api.c` file should be compiled only if `#if !defined(DEVICE_CRYPTOCELL)`).
1. In `features/mbedtls/targets/TARGET_CRYPTOCELL310/TARGET_<target name>` add your platform specific libraries for all toolchains in `TOOLCHAIN_ARM`, `TOOLCHAIN_GCC_ARM` and `TOOLCHAIN_IAR` respectively.
1. In `objects.h`, include `objects_cryptocell.h`. (You can condition it with `#if DEVICE_CRYPTOCELL` in case you have another `trng` engine for a differnt board, and `objects.h` is common file for your boards, in this case your common `trng_api.c` file should be compiled only if `#if !defined(DEVICE_CRYPTOCELL)`).
1. In `features/mbedtls/targets/TARGET_CRYPTOCELL310/TARGET_<target name>`, add your platform-specific libraries for all toolchains in `TOOLCHAIN_ARM`, `TOOLCHAIN_GCC_ARM` and `TOOLCHAIN_IAR` respectively.
1. Add your CC setup code:
* Implement `cc_platform_setup()` and `cc_platform_terminate()` to enable CC on your platform, in case you have such limitations. You can implement these functions as empty functions.
* Define `cc_platform_ctx` in `cc_platform.h` in a way that will suit your implementation.
* Define `cc_platform_ctx` in `cc_platform.h` in a way that suits your implementation.