ST / stm-spirit1-rf-driver

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Prototype RF Driver for STM Sub-1 GHz RF Expansion Boards based on the SPSGRF-868 and SPSGRF-915 Modules for STM32 Nucleo

Currently supported boards:

Note, in order to use expansion board X-NUCLEO-IDS01A4 in mbed you need to perform the following HW modifications on the board:

  • Unmount resistor R4
  • Mount resistor R7

Furthermore, on some Nucleo development boards (e.g. the NUCLEO_F429ZI), in order to be able to use Ethernet together with these Sub-1 GHz RF expansion boards, you need to compile this driver with macro SPIRIT1_SPI_MOSI=PB_5 defined, while the development board typically requires some HW modification as e.g. described here!

This driver can be used together with the 6LoWPAN stack (a.k.a. Nanostack).

source/libs/spirit1/SPIRIT1_Library/Inc/SPIRIT_Aes.h@67:93bec0baf1de, 2017-07-06 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Jul 06 11:13:31 2017 +0200
Revision:
67:93bec0baf1de
Parent:
34:edda6a7238ec 
Clarify some comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 67:93bec0baf1de 1 /**
Wolfgang Betz 67:93bec0baf1de 2 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 3 * @file SPIRIT_Aes.h
Wolfgang Betz 67:93bec0baf1de 4 * @author VMA division - AMS
Wolfgang Betz 67:93bec0baf1de 5 * @version 3.2.2
Wolfgang Betz 67:93bec0baf1de 6 * @date 08-July-2015
Wolfgang Betz 67:93bec0baf1de 7 * @brief Configuration and management of SPIRIT AES Engine.
Wolfgang Betz 67:93bec0baf1de 8 *
Wolfgang Betz 67:93bec0baf1de 9 * @details
Wolfgang Betz 67:93bec0baf1de 10 *
Wolfgang Betz 67:93bec0baf1de 11 * In order to encrypt data, the user must manage the AES_END IRQ.
Wolfgang Betz 67:93bec0baf1de 12 * The data have to be splitted in blocks of 16 bytes and written
Wolfgang Betz 67:93bec0baf1de 13 * into the <i>AES DATA IN registers</i>. Then, after the key is written
Wolfgang Betz 67:93bec0baf1de 14 * into the <i>AES KEY registers</i>, a command of <i>Execute encryption</i>
Wolfgang Betz 67:93bec0baf1de 15 * has to be sent.
Wolfgang Betz 67:93bec0baf1de 16 *
Wolfgang Betz 67:93bec0baf1de 17 * <b>Example:</b>
Wolfgang Betz 67:93bec0baf1de 18 * @code
Wolfgang Betz 67:93bec0baf1de 19 *
Wolfgang Betz 67:93bec0baf1de 20 * SpiritAesWriteDataIn(data_buff , N_BYTES);
Wolfgang Betz 67:93bec0baf1de 21 * SpiritAesExecuteEncryption();
Wolfgang Betz 67:93bec0baf1de 22 *
Wolfgang Betz 67:93bec0baf1de 23 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
Wolfgang Betz 67:93bec0baf1de 24 * aes_end_flag=RESET;
Wolfgang Betz 67:93bec0baf1de 25 *
Wolfgang Betz 67:93bec0baf1de 26 * SpiritAesReadDataOut(enc_data_buff , N_BYTES);
Wolfgang Betz 67:93bec0baf1de 27 *
Wolfgang Betz 67:93bec0baf1de 28 * @endcode
Wolfgang Betz 67:93bec0baf1de 29 *
Wolfgang Betz 67:93bec0baf1de 30 * In order to decrypt data, the user must manage the AES_END IRQ and have a decryption key.
Wolfgang Betz 67:93bec0baf1de 31 * There are two operative modes to make the data decryption:
Wolfgang Betz 67:93bec0baf1de 32 * <ul>
Wolfgang Betz 67:93bec0baf1de 33 * <li> Derive the decryption key from the encryption key and decrypt data directly
Wolfgang Betz 67:93bec0baf1de 34 * using the <i>SpiritAesDeriveDecKeyExecuteDec()</i> function
Wolfgang Betz 67:93bec0baf1de 35 *
Wolfgang Betz 67:93bec0baf1de 36 * <b>Example:</b>
Wolfgang Betz 67:93bec0baf1de 37 * @code
Wolfgang Betz 67:93bec0baf1de 38 *
Wolfgang Betz 67:93bec0baf1de 39 * SpiritAesWriteDataIn(enc_data_buff , N_BYTES);
Wolfgang Betz 67:93bec0baf1de 40 * SpiritAesDeriveDecKeyExecuteDec();
Wolfgang Betz 67:93bec0baf1de 41 *
Wolfgang Betz 67:93bec0baf1de 42 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
Wolfgang Betz 67:93bec0baf1de 43 * aes_end_flag=RESET;
Wolfgang Betz 67:93bec0baf1de 44 *
Wolfgang Betz 67:93bec0baf1de 45 * SpiritAesReadDataOut(data_buff , N_BYTES);
Wolfgang Betz 67:93bec0baf1de 46 *
Wolfgang Betz 67:93bec0baf1de 47 * @endcode
Wolfgang Betz 67:93bec0baf1de 48 * </li>
Wolfgang Betz 67:93bec0baf1de 49 *
Wolfgang Betz 67:93bec0baf1de 50 * <li> Derive the decryption key from the encryption key using the <i>SpiritAesDeriveDecKeyFromEnc()</i>
Wolfgang Betz 67:93bec0baf1de 51 * function, store it into the <i>AES KEY registers</i> and then decrypt data using the
Wolfgang Betz 67:93bec0baf1de 52 * <i>SpiritAesExecuteDecryption()</i> function
Wolfgang Betz 67:93bec0baf1de 53 *
Wolfgang Betz 67:93bec0baf1de 54 * <b>Example:</b>
Wolfgang Betz 67:93bec0baf1de 55 * @code
Wolfgang Betz 67:93bec0baf1de 56 *
Wolfgang Betz 67:93bec0baf1de 57 * SpiritAesWriteDataIn(key_enc , 16);
Wolfgang Betz 67:93bec0baf1de 58 * SpiritAesDeriveDecKeyFromEnc();
Wolfgang Betz 67:93bec0baf1de 59 *
Wolfgang Betz 67:93bec0baf1de 60 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
Wolfgang Betz 67:93bec0baf1de 61 * aes_end_flag=RESET;
Wolfgang Betz 67:93bec0baf1de 62 *
Wolfgang Betz 67:93bec0baf1de 63 * SpiritAesReadDataOut(key_dec , 16);
Wolfgang Betz 67:93bec0baf1de 64 *
Wolfgang Betz 67:93bec0baf1de 65 * SpiritAesWriteKey(key_dec);
Wolfgang Betz 67:93bec0baf1de 66 * SpiritAesWriteDataIn(enc_data_buff , 16);
Wolfgang Betz 67:93bec0baf1de 67 * SpiritAesExecuteDecryption();
Wolfgang Betz 67:93bec0baf1de 68 *
Wolfgang Betz 67:93bec0baf1de 69 * while(!aes_end_flag); // the flag is set by the ISR routine which manages the AES_END irq
Wolfgang Betz 67:93bec0baf1de 70 * aes_end_flag=RESET;
Wolfgang Betz 67:93bec0baf1de 71 *
Wolfgang Betz 67:93bec0baf1de 72 * SpiritAesReadDataOut(data_buff , N_BYTES);
Wolfgang Betz 67:93bec0baf1de 73 *
Wolfgang Betz 67:93bec0baf1de 74 * @endcode
Wolfgang Betz 67:93bec0baf1de 75 * </li>
Wolfgang Betz 67:93bec0baf1de 76 * </ul>
Wolfgang Betz 67:93bec0baf1de 77 *
Wolfgang Betz 67:93bec0baf1de 78 * @attention
Wolfgang Betz 67:93bec0baf1de 79 *
Wolfgang Betz 67:93bec0baf1de 80 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Wolfgang Betz 67:93bec0baf1de 81 *
Wolfgang Betz 67:93bec0baf1de 82 * Redistribution and use in source and binary forms, with or without modification,
Wolfgang Betz 67:93bec0baf1de 83 * are permitted provided that the following conditions are met:
Wolfgang Betz 67:93bec0baf1de 84 * 1. Redistributions of source code must retain the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 85 * this list of conditions and the following disclaimer.
Wolfgang Betz 67:93bec0baf1de 86 * 2. Redistributions in binary form must reproduce the above copyright notice,
Wolfgang Betz 67:93bec0baf1de 87 * this list of conditions and the following disclaimer in the documentation
Wolfgang Betz 67:93bec0baf1de 88 * and/or other materials provided with the distribution.
Wolfgang Betz 67:93bec0baf1de 89 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Wolfgang Betz 67:93bec0baf1de 90 * may be used to endorse or promote products derived from this software
Wolfgang Betz 67:93bec0baf1de 91 * without specific prior written permission.
Wolfgang Betz 67:93bec0baf1de 92 *
Wolfgang Betz 67:93bec0baf1de 93 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Wolfgang Betz 67:93bec0baf1de 94 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Wolfgang Betz 67:93bec0baf1de 95 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Wolfgang Betz 67:93bec0baf1de 96 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Wolfgang Betz 67:93bec0baf1de 97 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Wolfgang Betz 67:93bec0baf1de 98 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Wolfgang Betz 67:93bec0baf1de 99 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Wolfgang Betz 67:93bec0baf1de 100 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Wolfgang Betz 67:93bec0baf1de 101 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Wolfgang Betz 67:93bec0baf1de 102 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Wolfgang Betz 67:93bec0baf1de 103 *
Wolfgang Betz 67:93bec0baf1de 104 ******************************************************************************
Wolfgang Betz 67:93bec0baf1de 105 */
Wolfgang Betz 67:93bec0baf1de 106
Wolfgang Betz 67:93bec0baf1de 107 /* Define to prevent recursive inclusion -------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 108 #ifndef __SPIRIT_AES_H
Wolfgang Betz 67:93bec0baf1de 109 #define __SPIRIT_AES_H
Wolfgang Betz 67:93bec0baf1de 110
Wolfgang Betz 67:93bec0baf1de 111
Wolfgang Betz 67:93bec0baf1de 112 /* Includes ------------------------------------------------------------------*/
Wolfgang Betz 67:93bec0baf1de 113
Wolfgang Betz 67:93bec0baf1de 114 #include "SPIRIT_Regs.h"
Wolfgang Betz 67:93bec0baf1de 115 #include "SPIRIT_Types.h"
Wolfgang Betz 67:93bec0baf1de 116
Wolfgang Betz 67:93bec0baf1de 117
Wolfgang Betz 67:93bec0baf1de 118 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 119 extern "C" {
Wolfgang Betz 67:93bec0baf1de 120 #endif
Wolfgang Betz 67:93bec0baf1de 121
Wolfgang Betz 67:93bec0baf1de 122
Wolfgang Betz 67:93bec0baf1de 123 /**
Wolfgang Betz 67:93bec0baf1de 124 * @addtogroup SPIRIT_Libraries
Wolfgang Betz 67:93bec0baf1de 125 * @{
Wolfgang Betz 67:93bec0baf1de 126 */
Wolfgang Betz 67:93bec0baf1de 127
Wolfgang Betz 67:93bec0baf1de 128
Wolfgang Betz 67:93bec0baf1de 129 /**
Wolfgang Betz 67:93bec0baf1de 130 * @defgroup SPIRIT_Aes AES
Wolfgang Betz 67:93bec0baf1de 131 * @brief Configuration and management of SPIRIT AES Engine.
Wolfgang Betz 67:93bec0baf1de 132 * @details See the file <i>@ref SPIRIT_Aes.h</i> for more details.
Wolfgang Betz 67:93bec0baf1de 133 * @{
Wolfgang Betz 67:93bec0baf1de 134 */
Wolfgang Betz 67:93bec0baf1de 135
Wolfgang Betz 67:93bec0baf1de 136 /**
Wolfgang Betz 67:93bec0baf1de 137 * @defgroup Aes_Exported_Types AES Exported Types
Wolfgang Betz 67:93bec0baf1de 138 * @{
Wolfgang Betz 67:93bec0baf1de 139 */
Wolfgang Betz 67:93bec0baf1de 140
Wolfgang Betz 67:93bec0baf1de 141 /**
Wolfgang Betz 67:93bec0baf1de 142 * @}
Wolfgang Betz 67:93bec0baf1de 143 */
Wolfgang Betz 67:93bec0baf1de 144
Wolfgang Betz 67:93bec0baf1de 145
Wolfgang Betz 67:93bec0baf1de 146 /**
Wolfgang Betz 67:93bec0baf1de 147 * @defgroup Aes_Exported_Constants AES Exported Constants
Wolfgang Betz 67:93bec0baf1de 148 * @{
Wolfgang Betz 67:93bec0baf1de 149 */
Wolfgang Betz 67:93bec0baf1de 150
Wolfgang Betz 67:93bec0baf1de 151
Wolfgang Betz 67:93bec0baf1de 152 /**
Wolfgang Betz 67:93bec0baf1de 153 * @}
Wolfgang Betz 67:93bec0baf1de 154 */
Wolfgang Betz 67:93bec0baf1de 155
Wolfgang Betz 67:93bec0baf1de 156
Wolfgang Betz 67:93bec0baf1de 157 /**
Wolfgang Betz 67:93bec0baf1de 158 * @defgroup Aes_Exported_Macros AES Exported Macros
Wolfgang Betz 67:93bec0baf1de 159 * @{
Wolfgang Betz 67:93bec0baf1de 160 */
Wolfgang Betz 67:93bec0baf1de 161
Wolfgang Betz 67:93bec0baf1de 162
Wolfgang Betz 67:93bec0baf1de 163 /**
Wolfgang Betz 67:93bec0baf1de 164 * @}
Wolfgang Betz 67:93bec0baf1de 165 */
Wolfgang Betz 67:93bec0baf1de 166
Wolfgang Betz 67:93bec0baf1de 167
Wolfgang Betz 67:93bec0baf1de 168 /**
Wolfgang Betz 67:93bec0baf1de 169 * @defgroup Aes_Exported_Functions AES Exported Functions
Wolfgang Betz 67:93bec0baf1de 170 * @{
Wolfgang Betz 67:93bec0baf1de 171 */
Wolfgang Betz 67:93bec0baf1de 172
Wolfgang Betz 67:93bec0baf1de 173 void SpiritAesMode(SpiritFunctionalState xNewState);
Wolfgang Betz 67:93bec0baf1de 174 void SpiritAesWriteDataIn(uint8_t* pcBufferDataIn, uint8_t cDataLength);
Wolfgang Betz 67:93bec0baf1de 175 void SpiritAesReadDataOut(uint8_t* pcBufferDataOut, uint8_t cDataLength);
Wolfgang Betz 67:93bec0baf1de 176 void SpiritAesWriteKey(uint8_t* pcKey);
Wolfgang Betz 67:93bec0baf1de 177 void SpiritAesReadKey(uint8_t* pcKey);
Wolfgang Betz 67:93bec0baf1de 178 void SpiritAesDeriveDecKeyFromEnc(void);
Wolfgang Betz 67:93bec0baf1de 179 void SpiritAesExecuteEncryption(void);
Wolfgang Betz 67:93bec0baf1de 180 void SpiritAesExecuteDecryption(void);
Wolfgang Betz 67:93bec0baf1de 181 void SpiritAesDeriveDecKeyExecuteDec(void);
Wolfgang Betz 67:93bec0baf1de 182
Wolfgang Betz 67:93bec0baf1de 183 /**
Wolfgang Betz 67:93bec0baf1de 184 * @}
Wolfgang Betz 67:93bec0baf1de 185 */
Wolfgang Betz 67:93bec0baf1de 186
Wolfgang Betz 67:93bec0baf1de 187 /**
Wolfgang Betz 67:93bec0baf1de 188 * @}
Wolfgang Betz 67:93bec0baf1de 189 */
Wolfgang Betz 67:93bec0baf1de 190
Wolfgang Betz 67:93bec0baf1de 191
Wolfgang Betz 67:93bec0baf1de 192 /**
Wolfgang Betz 67:93bec0baf1de 193 * @}
Wolfgang Betz 67:93bec0baf1de 194 */
Wolfgang Betz 67:93bec0baf1de 195
Wolfgang Betz 67:93bec0baf1de 196
Wolfgang Betz 67:93bec0baf1de 197
Wolfgang Betz 67:93bec0baf1de 198
Wolfgang Betz 67:93bec0baf1de 199 #ifdef __cplusplus
Wolfgang Betz 67:93bec0baf1de 200 }
Wolfgang Betz 67:93bec0baf1de 201 #endif
Wolfgang Betz 67:93bec0baf1de 202
Wolfgang Betz 67:93bec0baf1de 203 #endif
Wolfgang Betz 67:93bec0baf1de 204
Wolfgang Betz 67:93bec0baf1de 205 /******************* (C) COPYRIGHT 2015 STMicroelectronics *****END OF FILE****/