Nordic stack and drivers for the mbed BLE API

Fork of nRF51822 by Nordic Semiconductor

nordic/nrf-sdk/nrf_ecb.h

Committer:
Rohit Grover
Date:
2014-07-07
Revision:
37:c29c330d942c
Parent:
0:eff01767de02

File content as of revision 37:c29c330d942c:

/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is confidential property of Nordic 
 * Semiconductor ASA.Terms and conditions of usage are described in detail 
 * in NORDIC SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *              
 * $LastChangedRevision: 13999 $
 */

/**
 * @file
 * @brief ECB driver API.
 */

#ifndef NRF_ECB_H__
#define NRF_ECB_H__

/**
 * @defgroup nrf_ecb AES ECB encryption
 * @{
 * @ingroup nrf_drivers
 * @brief Driver for the nRF51 AES Electronic Code Book (ECB) peripheral.
 *
 * In order to encrypt and decrypt data the peripheral must be powered on
 * using nrf_ecb_init() and then the key set using nrf_ecb_set_key.
 */

#include <stdint.h>

/**
 * Initialize and power on the ECB peripheral.
 *
 * Allocates memory for the ECBDATAPTR.
 * @retval true Initialization was successful.
 * @retval false Powering up failed.
 */
bool nrf_ecb_init(void);

/**
 * Encrypt/decrypt 16-byte data using current key.
 *
 * The function avoids unnecessary copying of data if the point to the 
 * correct locations in the ECB data structure.
 *
 * @param dst Result of encryption/decryption. 16 bytes will be written. 
 * @param src Source with 16-byte data to be encrypted/decrypted.
 *
 * @retval true  If the encryption operation completed.
 * @retval false If the encryption operation did not complete.
 */
bool nrf_ecb_crypt(uint8_t * dst, const uint8_t * src);

/**
 * Set the key to be used for encryption/decryption.
 *
 * @param key Pointer to key. 16 bytes will be read.
 */
void nrf_ecb_set_key(const uint8_t * key);

#endif  // NRF_ECB_H__

/** @} */