mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NRF51_DK/TOOLCHAIN_GCC_ARM/nrf_ecb.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
TARGET_TY51822R3/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/drivers_nrf/hal/nrf_ecb.h@169:a7c7b631e539 
mbed library. Release version 164

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 143:86740a56073b 1 /*
AnnaBridge 143:86740a56073b 2 * Copyright (c) 2012 Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 3 * All rights reserved.
AnnaBridge 143:86740a56073b 4 *
AnnaBridge 143:86740a56073b 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 143:86740a56073b 6 * are permitted provided that the following conditions are met:
AnnaBridge 143:86740a56073b 7 *
AnnaBridge 143:86740a56073b 8 * 1. Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 143:86740a56073b 9 * of conditions and the following disclaimer.
AnnaBridge 143:86740a56073b 10 *
AnnaBridge 143:86740a56073b 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
AnnaBridge 143:86740a56073b 12 * integrated circuit in a product or a software update for such product, must reproduce
AnnaBridge 143:86740a56073b 13 * the above copyright notice, this list of conditions and the following disclaimer in
AnnaBridge 143:86740a56073b 14 * the documentation and/or other materials provided with the distribution.
AnnaBridge 143:86740a56073b 15 *
AnnaBridge 143:86740a56073b 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
AnnaBridge 143:86740a56073b 17 * used to endorse or promote products derived from this software without specific prior
AnnaBridge 143:86740a56073b 18 * written permission.
AnnaBridge 143:86740a56073b 19 *
AnnaBridge 143:86740a56073b 20 * 4. This software, with or without modification, must only be used with a
AnnaBridge 143:86740a56073b 21 * Nordic Semiconductor ASA integrated circuit.
AnnaBridge 143:86740a56073b 22 *
AnnaBridge 143:86740a56073b 23 * 5. Any software provided in binary or object form under this license must not be reverse
AnnaBridge 143:86740a56073b 24 * engineered, decompiled, modified and/or disassembled.
AnnaBridge 143:86740a56073b 25 *
AnnaBridge 143:86740a56073b 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 143:86740a56073b 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 143:86740a56073b 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 143:86740a56073b 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 143:86740a56073b 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 143:86740a56073b 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 143:86740a56073b 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 143:86740a56073b 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 143:86740a56073b 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 143:86740a56073b 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 143:86740a56073b 36 *
AnnaBridge 143:86740a56073b 37 */
AnnaBridge 143:86740a56073b 38
AnnaBridge 143:86740a56073b 39
AnnaBridge 143:86740a56073b 40 /**
AnnaBridge 143:86740a56073b 41 * @file
AnnaBridge 143:86740a56073b 42 * @brief ECB driver API.
AnnaBridge 143:86740a56073b 43 */
AnnaBridge 143:86740a56073b 44
AnnaBridge 143:86740a56073b 45 #ifndef NRF_ECB_H__
AnnaBridge 143:86740a56073b 46 #define NRF_ECB_H__
AnnaBridge 143:86740a56073b 47
AnnaBridge 143:86740a56073b 48 /**
AnnaBridge 143:86740a56073b 49 * @defgroup nrf_ecb AES ECB encryption
AnnaBridge 143:86740a56073b 50 * @{
AnnaBridge 143:86740a56073b 51 * @ingroup nrf_drivers
AnnaBridge 143:86740a56073b 52 * @brief Driver for the AES Electronic Code Book (ECB) peripheral.
AnnaBridge 143:86740a56073b 53 *
AnnaBridge 143:86740a56073b 54 * To encrypt and decrypt data, the peripheral must first be powered on
AnnaBridge 143:86740a56073b 55 * using @ref nrf_ecb_init. Next, the key must be set using @ref nrf_ecb_set_key.
AnnaBridge 143:86740a56073b 56 */
AnnaBridge 143:86740a56073b 57
AnnaBridge 143:86740a56073b 58 #include <stdint.h>
AnnaBridge 143:86740a56073b 59
AnnaBridge 143:86740a56073b 60 /**
AnnaBridge 143:86740a56073b 61 * @brief Function for initializing and powering on the ECB peripheral.
AnnaBridge 143:86740a56073b 62 *
AnnaBridge 143:86740a56073b 63 * This function allocates memory for the ECBDATAPTR.
AnnaBridge 143:86740a56073b 64 * @retval true If initialization was successful.
AnnaBridge 143:86740a56073b 65 * @retval false If powering on failed.
AnnaBridge 143:86740a56073b 66 */
AnnaBridge 143:86740a56073b 67 bool nrf_ecb_init(void);
AnnaBridge 143:86740a56073b 68
AnnaBridge 143:86740a56073b 69 /**
AnnaBridge 143:86740a56073b 70 * @brief Function for encrypting and decrypting 16-byte data using current key.
AnnaBridge 143:86740a56073b 71 *
AnnaBridge 143:86740a56073b 72 * This function avoids unnecessary copying of data if the parameters point to the
AnnaBridge 143:86740a56073b 73 * correct locations in the ECB data structure.
AnnaBridge 143:86740a56073b 74 *
AnnaBridge 143:86740a56073b 75 * @param dst Result of encryption/decryption. 16 bytes will be written.
AnnaBridge 143:86740a56073b 76 * @param src Source with 16-byte data to be encrypted/decrypted.
AnnaBridge 143:86740a56073b 77 *
AnnaBridge 143:86740a56073b 78 * @retval true If the encryption operation completed.
AnnaBridge 143:86740a56073b 79 * @retval false If the encryption operation did not complete.
AnnaBridge 143:86740a56073b 80 */
AnnaBridge 143:86740a56073b 81 bool nrf_ecb_crypt(uint8_t * dst, const uint8_t * src);
AnnaBridge 143:86740a56073b 82
AnnaBridge 143:86740a56073b 83 /**
AnnaBridge 143:86740a56073b 84 * @brief Function for setting the key to be used for encryption and decryption.
AnnaBridge 143:86740a56073b 85 *
AnnaBridge 143:86740a56073b 86 * @param key Pointer to the key. 16 bytes will be read.
AnnaBridge 143:86740a56073b 87 */
AnnaBridge 143:86740a56073b 88 void nrf_ecb_set_key(const uint8_t * key);
AnnaBridge 143:86740a56073b 89
AnnaBridge 143:86740a56073b 90 #endif // NRF_ECB_H__
AnnaBridge 143:86740a56073b 91
AnnaBridge 143:86740a56073b 92 /** @} */