Contiki-NG
CC1352P_4_LAUNCHXL.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2018, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /** ===========================================================================
33  * @file CC1352P_4_LAUNCHXL.h
34  *
35  * @brief CC1352P_4_LAUNCHXL Board Specific header file.
36  *
37  * The CC1352P_4_LAUNCHXL header file should be included in an application as
38  * follows:
39  * @code
40  * #include "CC1352P_4_LAUNCHXL.h"
41  * @endcode
42  *
43  * ===========================================================================
44  */
45 #ifndef __CC1352P_4_LAUNCHXL_BOARD_H__
46 #define __CC1352P_4_LAUNCHXL_BOARD_H__
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #include "contiki-conf.h"
53 
54 /* Includes */
55 #include <ti/drivers/PIN.h>
56 #include <ti/devices/DeviceFamily.h>
57 #include DeviceFamily_constructPath(driverlib/ioc.h)
58 
59 /* Externs */
60 extern const PIN_Config BoardGpioInitTable[];
61 
62 /* Defines */
63 #define CC1352P_4_LAUNCHXL
64 
65 /* Mapping of pins to board signals using general board aliases
66  * <board signal alias> <pin mapping> <comments>
67  */
68 
69 /* Mapping of pins to board signals using general board aliases
70  * <board signal alias> <pin mapping>
71  */
72 /* Analog Capable DIOs */
73 #define CC1352P_4_LAUNCHXL_DIO23_ANALOG IOID_23
74 #define CC1352P_4_LAUNCHXL_DIO24_ANALOG IOID_24
75 #define CC1352P_4_LAUNCHXL_DIO25_ANALOG IOID_25
76 #define CC1352P_4_LAUNCHXL_DIO26_ANALOG IOID_26
77 #define CC1352P_4_LAUNCHXL_DIO27_ANALOG IOID_27
78 
79 /* RF Antenna Switch */
80 #define CC1352P_4_LAUNCHXL_DIO28_RF_24GHZ IOID_28
81 #define CC1352P_4_LAUNCHXL_DIO29_RF_HIGH_PA IOID_29
82 #define CC1352P_4_LAUNCHXL_DIO30_RF_SUB1GHZ IOID_30
83 
84 /* Digital IOs */
85 #define CC1352P_4_LAUNCHXL_DIO12 IOID_12
86 #define CC1352P_4_LAUNCHXL_DIO15 IOID_15
87 #define CC1352P_4_LAUNCHXL_DIO16_TDO IOID_16
88 #define CC1352P_4_LAUNCHXL_DIO17_TDI IOID_17
89 #define CC1352P_4_LAUNCHXL_DIO21 IOID_21
90 #define CC1352P_4_LAUNCHXL_DIO22 IOID_22
91 
92 /* Discrete Inputs */
93 #define CC1352P_4_LAUNCHXL_PIN_BTN1 IOID_15
94 #define CC1352P_4_LAUNCHXL_PIN_BTN2 IOID_14
95 
96 /* GPIO */
97 #define CC1352P_4_LAUNCHXL_GPIO_LED_ON 1
98 #define CC1352P_4_LAUNCHXL_GPIO_LED_OFF 0
99 
100 /* I2C */
101 #define CC1352P_4_LAUNCHXL_I2C0_SCL0 IOID_21
102 #define CC1352P_4_LAUNCHXL_I2C0_SDA0 IOID_5
103 
104 /* LEDs */
105 #define CC1352P_4_LAUNCHXL_PIN_LED_ON 1
106 #define CC1352P_4_LAUNCHXL_PIN_LED_OFF 0
107 #define CC1352P_4_LAUNCHXL_PIN_RLED IOID_6
108 #define CC1352P_4_LAUNCHXL_PIN_GLED IOID_7
109 
110 /* PWM Outputs */
111 #define CC1352P_4_LAUNCHXL_PWMPIN0 CC1352P_4_LAUNCHXL_PIN_RLED
112 #define CC1352P_4_LAUNCHXL_PWMPIN1 CC1352P_4_LAUNCHXL_PIN_GLED
113 #define CC1352P_4_LAUNCHXL_PWMPIN2 PIN_UNASSIGNED
114 #define CC1352P_4_LAUNCHXL_PWMPIN3 PIN_UNASSIGNED
115 #define CC1352P_4_LAUNCHXL_PWMPIN4 PIN_UNASSIGNED
116 #define CC1352P_4_LAUNCHXL_PWMPIN5 PIN_UNASSIGNED
117 #define CC1352P_4_LAUNCHXL_PWMPIN6 PIN_UNASSIGNED
118 #define CC1352P_4_LAUNCHXL_PWMPIN7 PIN_UNASSIGNED
119 
120 /* SPI */
121 #define CC1352P_4_LAUNCHXL_SPI_FLASH_CS IOID_20
122 #define CC1352P_4_LAUNCHXL_FLASH_CS_ON 0
123 #define CC1352P_4_LAUNCHXL_FLASH_CS_OFF 1
124 
125 /* SPI Board */
126 #define CC1352P_4_LAUNCHXL_SPI0_MISO IOID_8 /* RF1.20 */
127 #define CC1352P_4_LAUNCHXL_SPI0_MOSI IOID_9 /* RF1.18 */
128 #define CC1352P_4_LAUNCHXL_SPI0_CLK IOID_10 /* RF1.16 */
129 #define CC1352P_4_LAUNCHXL_SPI0_CSN PIN_UNASSIGNED
130 #define CC1352P_4_LAUNCHXL_SPI1_MISO PIN_UNASSIGNED
131 #define CC1352P_4_LAUNCHXL_SPI1_MOSI PIN_UNASSIGNED
132 #define CC1352P_4_LAUNCHXL_SPI1_CLK PIN_UNASSIGNED
133 #define CC1352P_4_LAUNCHXL_SPI1_CSN PIN_UNASSIGNED
134 
135 /* UART Board */
136 #define CC1352P_4_LAUNCHXL_UART0_RX IOID_12 /* RXD */
137 #define CC1352P_4_LAUNCHXL_UART0_TX IOID_13 /* TXD */
138 #define CC1352P_4_LAUNCHXL_UART0_CTS PIN_UNASSIGNED /* CTS */
139 #define CC1352P_4_LAUNCHXL_UART0_RTS IOID_18 /* RTS */
140 #define CC1352P_4_LAUNCHXL_UART1_RX PIN_UNASSIGNED
141 #define CC1352P_4_LAUNCHXL_UART1_TX PIN_UNASSIGNED
142 #define CC1352P_4_LAUNCHXL_UART1_CTS PIN_UNASSIGNED
143 #define CC1352P_4_LAUNCHXL_UART1_RTS PIN_UNASSIGNED
144 /* For backward compatibility */
145 #define CC1352P_4_LAUNCHXL_UART_RX CC1352P_4_LAUNCHXL_UART0_RX
146 #define CC1352P_4_LAUNCHXL_UART_TX CC1352P_4_LAUNCHXL_UART0_TX
147 #define CC1352P_4_LAUNCHXL_UART_CTS CC1352P_4_LAUNCHXL_UART0_CTS
148 #define CC1352P_4_LAUNCHXL_UART_RTS CC1352P_4_LAUNCHXL_UART0_RTS
149 
150 /*!
151  * @brief Initialize the general board specific settings
152  *
153  * This function initializes the general board specific settings.
154  */
156 
157 /*!
158  * @brief Shut down the external flash present on the board files
159  *
160  * This function bitbangs the SPI sequence necessary to turn off
161  * the external flash on LaunchPads.
162  */
164 
165 /*!
166  * @brief Wake up the external flash present on the board files
167  *
168  * This function toggles the chip select for the amount of time needed
169  * to wake the chip up.
170  */
172 
173 
174 /*!
175  * \brief Initializes the antenna switch IOs.
176  *
177  * This function sets up the antenna switch and occupies
178  * the necessary IO pins. After calling this function, they
179  * cannot be used in the application anymore.
180  */
182 
183 /*!
184  * @def CC1352P_4_LAUNCHXL_ADCBufName
185  * @brief Enum of ADCs
186  */
187 typedef enum CC1352P_4_LAUNCHXL_ADCBufName {
188  CC1352P_4_LAUNCHXL_ADCBUF0 = 0,
189 
190  CC1352P_4_LAUNCHXL_ADCBUFCOUNT
191 } CC1352P_4_LAUNCHXL_ADCBufName;
192 
193 /*!
194  * @def CC1352P_4_LAUNCHXL_ADCBuf0ChannelName
195  * @brief Enum of ADCBuf channels
196  */
197 typedef enum CC1352P_4_LAUNCHXL_ADCBuf0ChannelName {
198  CC1352P_4_LAUNCHXL_ADCBUF0CHANNEL0 = 0,
199  CC1352P_4_LAUNCHXL_ADCBUF0CHANNEL1,
200  CC1352P_4_LAUNCHXL_ADCBUF0CHANNEL2,
201  CC1352P_4_LAUNCHXL_ADCBUF0CHANNEL3,
202  CC1352P_4_LAUNCHXL_ADCBUF0CHANNEL4,
203  CC1352P_4_LAUNCHXL_ADCBUF0CHANNELVDDS,
204  CC1352P_4_LAUNCHXL_ADCBUF0CHANNELDCOUPL,
205  CC1352P_4_LAUNCHXL_ADCBUF0CHANNELVSS,
206 
207  CC1352P_4_LAUNCHXL_ADCBUF0CHANNELCOUNT
208 } CC1352P_4_LAUNCHXL_ADCBuf0ChannelName;
209 
210 /*!
211  * @def CC1352P_4_LAUNCHXL_ADCName
212  * @brief Enum of ADCs
213  */
214 typedef enum CC1352P_4_LAUNCHXL_ADCName {
215  CC1352P_4_LAUNCHXL_ADC0 = 0,
216  CC1352P_4_LAUNCHXL_ADC1,
217  CC1352P_4_LAUNCHXL_ADC2,
218  CC1352P_4_LAUNCHXL_ADC3,
219  CC1352P_4_LAUNCHXL_ADC4,
220  CC1352P_4_LAUNCHXL_ADCDCOUPL,
221  CC1352P_4_LAUNCHXL_ADCVSS,
222  CC1352P_4_LAUNCHXL_ADCVDDS,
223 
224  CC1352P_4_LAUNCHXL_ADCCOUNT
225 } CC1352P_4_LAUNCHXL_ADCName;
226 
227 /*!
228  * @def CC1352P_4_LAUNCHXL_ECDHName
229  * @brief Enum of ECDH names
230  */
231 typedef enum CC1352P_4_LAUNCHXL_ECDHName {
232  CC1352P_4_LAUNCHXL_ECDH0 = 0,
233 
234  CC1352P_4_LAUNCHXL_ECDHCOUNT
235 } CC1352P_4_LAUNCHXL_ECDHName;
236 
237 /*!
238  * @def CC1352P_4_LAUNCHXL_ECDSAName
239  * @brief Enum of ECDSA names
240  */
241 typedef enum CC1352P_4_LAUNCHXL_ECDSAName {
242  CC1352P_4_LAUNCHXL_ECDSA0 = 0,
243 
244  CC1352P_4_LAUNCHXL_ECDSACOUNT
245 } CC1352P_4_LAUNCHXL_ECDSAName;
246 
247 /*!
248  * @def CC1352P_4_LAUNCHXL_ECJPAKEName
249  * @brief Enum of ECJPAKE names
250  */
251 typedef enum CC1352P_4_LAUNCHXL_ECJPAKEName {
252  CC1352P_4_LAUNCHXL_ECJPAKE0 = 0,
253 
254  CC1352P_4_LAUNCHXL_ECJPAKECOUNT
255 } CC1352P_4_LAUNCHXL_ECJPAKEName;
256 
257 /*!
258  * @def CC1352P_4_LAUNCHXL_AESCCMName
259  * @brief Enum of AESCCM names
260  */
261 typedef enum CC1352P_4_LAUNCHXL_AESCCMName {
262  CC1352P_4_LAUNCHXL_AESCCM0 = 0,
263 
264  CC1352P_4_LAUNCHXL_AESCCMCOUNT
265 } CC1352P_4_LAUNCHXL_AESCCMName;
266 
267 /*!
268  * @def CC1352P_4_LAUNCHXL_AESECBName
269  * @brief Enum of AESECB names
270  */
271 typedef enum CC1352P_4_LAUNCHXL_AESECBName {
272  CC1352P_4_LAUNCHXL_AESECB0 = 0,
273 
274  CC1352P_4_LAUNCHXL_AESECBCOUNT
275 } CC1352P_4_LAUNCHXL_AESECBName;
276 
277 /*!
278  * @def CC1352P_4_LAUNCHXL_SHA2Name
279  * @brief Enum of SHA2 names
280  */
281 typedef enum CC1352P_4_LAUNCHXL_SHA2Name {
282  CC1352P_4_LAUNCHXL_SHA20 = 0,
283 
284  CC1352P_4_LAUNCHXL_SHA2COUNT
285 } CC1352P_4_LAUNCHXL_SHA2Name;
286 
287 /*!
288  * @def CC1352P_4_LAUNCHXL_GPIOName
289  * @brief Enum of GPIO names
290  */
291 typedef enum CC1352P_4_LAUNCHXL_GPIOName {
292  CC1352P_4_LAUNCHXL_GPIO_S1 = 0,
293  CC1352P_4_LAUNCHXL_GPIO_S2,
294  CC1352P_4_LAUNCHXL_SPI_MASTER_READY,
295  CC1352P_4_LAUNCHXL_SPI_SLAVE_READY,
296  CC1352P_4_LAUNCHXL_GPIO_LED_GREEN,
297  CC1352P_4_LAUNCHXL_GPIO_LED_RED,
298  CC1352P_4_LAUNCHXL_GPIO_SPI_FLASH_CS,
299  CC1352P_4_LAUNCHXL_GPIO_SDSPI_CS,
300  CC1352P_4_LAUNCHXL_GPIOCOUNT
301 } CC1352P_4_LAUNCHXL_GPIOName;
302 
303 /*!
304  * @def CC1352P_4_LAUNCHXL_GPTimerName
305  * @brief Enum of GPTimer parts
306  */
307 typedef enum CC1352P_4_LAUNCHXL_GPTimerName {
308  CC1352P_4_LAUNCHXL_GPTIMER0A = 0,
309  CC1352P_4_LAUNCHXL_GPTIMER0B,
310  CC1352P_4_LAUNCHXL_GPTIMER1A,
311  CC1352P_4_LAUNCHXL_GPTIMER1B,
312  CC1352P_4_LAUNCHXL_GPTIMER2A,
313  CC1352P_4_LAUNCHXL_GPTIMER2B,
314  CC1352P_4_LAUNCHXL_GPTIMER3A,
315  CC1352P_4_LAUNCHXL_GPTIMER3B,
316 
317  CC1352P_4_LAUNCHXL_GPTIMERPARTSCOUNT
318 } CC1352P_4_LAUNCHXL_GPTimerName;
319 
320 /*!
321  * @def CC1352P_4_LAUNCHXL_GPTimers
322  * @brief Enum of GPTimers
323  */
324 typedef enum CC1352P_4_LAUNCHXL_GPTimers {
325  CC1352P_4_LAUNCHXL_GPTIMER0 = 0,
326  CC1352P_4_LAUNCHXL_GPTIMER1,
327  CC1352P_4_LAUNCHXL_GPTIMER2,
328  CC1352P_4_LAUNCHXL_GPTIMER3,
329 
330  CC1352P_4_LAUNCHXL_GPTIMERCOUNT
331 } CC1352P_4_LAUNCHXL_GPTimers;
332 
333 /*!
334  * @def CC1352P_4_LAUNCHXL_I2CName
335  * @brief Enum of I2C names
336  */
337 typedef enum CC1352P_4_LAUNCHXL_I2CName {
338 #if TI_I2C_CONF_I2C0_ENABLE
339  CC1352P_4_LAUNCHXL_I2C0 = 0,
340 #endif
341 
342  CC1352P_4_LAUNCHXL_I2CCOUNT
343 } CC1352P_4_LAUNCHXL_I2CName;
344 
345 /*!
346  * @def CC1352P_4_LAUNCHXL_NVSName
347  * @brief Enum of NVS names
348  */
349 typedef enum CC1352P_4_LAUNCHXL_NVSName {
350 #if TI_NVS_CONF_NVS_INTERNAL_ENABLE
351  CC1352P_4_LAUNCHXL_NVSCC26XX0 = 0,
352 #endif
353 #if TI_NVS_CONF_NVS_EXTERNAL_ENABLE
354  CC1352P_4_LAUNCHXL_NVSSPI25X0,
355 #endif
356 
357  CC1352P_4_LAUNCHXL_NVSCOUNT
358 } CC1352P_4_LAUNCHXL_NVSName;
359 
360 /*!
361  * @def CC1352P_4_LAUNCHXL_PWMName
362  * @brief Enum of PWM outputs
363  */
364 typedef enum CC1352P_4_LAUNCHXL_PWMName {
365  CC1352P_4_LAUNCHXL_PWM0 = 0,
366  CC1352P_4_LAUNCHXL_PWM1,
367  CC1352P_4_LAUNCHXL_PWM2,
368  CC1352P_4_LAUNCHXL_PWM3,
369  CC1352P_4_LAUNCHXL_PWM4,
370  CC1352P_4_LAUNCHXL_PWM5,
371  CC1352P_4_LAUNCHXL_PWM6,
372  CC1352P_4_LAUNCHXL_PWM7,
373 
374  CC1352P_4_LAUNCHXL_PWMCOUNT
375 } CC1352P_4_LAUNCHXL_PWMName;
376 
377 /*!
378  * @def CC1352P_4_LAUNCHXL_SDName
379  * @brief Enum of SD names
380  */
381 typedef enum CC1352P_4_LAUNCHXL_SDName {
382  CC1352P_4_LAUNCHXL_SDSPI0 = 0,
383 
384  CC1352P_4_LAUNCHXL_SDCOUNT
385 } CC1352P_4_LAUNCHXL_SDName;
386 
387 /*!
388  * @def CC1352P_4_LAUNCHXL_SPIName
389  * @brief Enum of SPI names
390  */
391 typedef enum CC1352P_4_LAUNCHXL_SPIName {
392 #if TI_SPI_CONF_SPI0_ENABLE
393  CC1352P_4_LAUNCHXL_SPI0 = 0,
394 #endif
395 #if TI_SPI_CONF_SPI1_ENABLE
396  CC1352P_4_LAUNCHXL_SPI1,
397 #endif
398 
399  CC1352P_4_LAUNCHXL_SPICOUNT
400 } CC1352P_4_LAUNCHXL_SPIName;
401 
402 /*!
403  * @def CC1352P_4_LAUNCHXL_TRNGName
404  * @brief Enum of TRNGs
405  */
406 typedef enum CC1352P_4_LAUNCHXL_TRNGName {
407  CC1352P_4_LAUNCHXL_TRNG0 = 0,
408 
409  CC1352P_4_LAUNCHXL_TRNGCOUNT
410 } CC1352P_4_LAUNCHXL_TRNGName;
411 
412 /*!
413  * @def CC1352P_4_LAUNCHXL_UARTName
414  * @brief Enum of UARTs
415  */
416 typedef enum CC1352P_4_LAUNCHXL_UARTName {
417 #if TI_UART_CONF_UART0_ENABLE
418  CC1352P_4_LAUNCHXL_UART0 = 0,
419 #endif
420 #if TI_UART_CONF_UART1_ENABLE
421  CC1352P_4_LAUNCHXL_UART1,
422 #endif
423 
424  CC1352P_4_LAUNCHXL_UARTCOUNT
425 } CC1352P_4_LAUNCHXL_UARTName;
426 
427 /*!
428  * @def CC1352P_4_LAUNCHXL_UDMAName
429  * @brief Enum of DMA buffers
430  */
431 typedef enum CC1352P_4_LAUNCHXL_UDMAName {
432  CC1352P_4_LAUNCHXL_UDMA0 = 0,
433 
434  CC1352P_4_LAUNCHXL_UDMACOUNT
435 } CC1352P_4_LAUNCHXL_UDMAName;
436 
437 /*!
438  * @def CC1352P_4_LAUNCHXL_WatchdogName
439  * @brief Enum of Watchdogs
440  */
441 typedef enum CC1352P_4_LAUNCHXL_WatchdogName {
442  CC1352P_4_LAUNCHXL_WATCHDOG0 = 0,
443 
444  CC1352P_4_LAUNCHXL_WATCHDOGCOUNT
445 } CC1352P_4_LAUNCHXL_WatchdogName;
446 
447 
448 #ifdef __cplusplus
449 }
450 #endif
451 
452 #endif /* __CC1352P_4_LAUNCHXL_BOARD_H__ */
void CC1352P_4_LAUNCHXL_wakeUpExtFlash(void)
Wake up the external flash present on the board files.
void CC1352P_4_LAUNCHXL_initGeneral(void)
Initialize the general board specific settings.
void CC1352P_4_LAUNCHXL_initAntennaSwitch(void)
Initializes the antenna switch IOs.
void CC1352P_4_LAUNCHXL_shutDownExtFlash(void)
Shut down the external flash present on the board files.