From de2e4875fd3a23a5380edf026a781fa539426b1d Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Mon, 7 May 2018 15:13:22 -0500 Subject: [PATCH] Copy edit Readme.md Copy edit file, mostly for minor grammar nits. --- .../targets/TARGET_CRYPTOCELL310/Readme.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/features/mbedtls/targets/TARGET_CRYPTOCELL310/Readme.md b/features/mbedtls/targets/TARGET_CRYPTOCELL310/Readme.md index 1a1f0e97be..2cf4adf7b4 100644 --- a/features/mbedtls/targets/TARGET_CRYPTOCELL310/Readme.md +++ b/features/mbedtls/targets/TARGET_CRYPTOCELL310/Readme.md @@ -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_` 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_`, 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.