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