Mustahsin Chowdhury / nRF51822

Nordic stack and drivers for the mbed BLE API

Fork of nRF51822 by Nordic Semiconductor

TARGET_MCU_NRF51822/sdk/source/drivers_nrf/hal/nrf_ecb.h@640:c90ae1400bf2, 2016-09-14 (annotated)

Committer:
Vincent Coubard
Date:
Wed Sep 14 14:39:43 2016 +0100
Revision:
640:c90ae1400bf2
Sync with bdab10dc0f90748b6989c8b577771bb403ca6bd8 from ARMmbed/mbed-os.

Who changed what in which revision?

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