Contiki-NG
CC1310_LAUNCHXL.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-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 CC1310_LAUNCHXL.h
34  *
35  * @brief CC1310 LaunchPad Board Specific header file.
36  *
37  * The CC1310_LAUNCHXL header file should be included in an application as
38  * follows:
39  * @code
40  * #include "CC1310_LAUNCHXL.h"
41  * @endcode
42  *
43  * ============================================================================
44  */
45 #ifndef __CC1310_LAUNCHXL_BOARD_H__
46 #define __CC1310_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 CC1310_LAUNCHXL
64 
65 /* Mapping of pins to board signals using general board aliases
66  * <board signal alias> <pin mapping> <comments>
67  */
68 
69 /* Analog capable DIOs */
70 #define CC1310_LAUNCHXL_DIO23_ANALOG IOID_23
71 #define CC1310_LAUNCHXL_DIO24_ANALOG IOID_24
72 #define CC1310_LAUNCHXL_DIO25_ANALOG IOID_25
73 #define CC1310_LAUNCHXL_DIO26_ANALOG IOID_26
74 #define CC1310_LAUNCHXL_DIO27_ANALOG IOID_27
75 #define CC1310_LAUNCHXL_DIO28_ANALOG IOID_28
76 #define CC1310_LAUNCHXL_DIO29_ANALOG IOID_29
77 #define CC1310_LAUNCHXL_DIO30_ANALOG IOID_30
78 
79 /* Digital IOs */
80 #define CC1310_LAUNCHXL_DIO0 IOID_0
81 #define CC1310_LAUNCHXL_DIO1 IOID_1
82 #define CC1310_LAUNCHXL_DIO12 IOID_12
83 #define CC1310_LAUNCHXL_DIO15 IOID_15
84 #define CC1310_LAUNCHXL_DIO16_TDO IOID_16
85 #define CC1310_LAUNCHXL_DIO17_TDI IOID_17
86 #define CC1310_LAUNCHXL_DIO21 IOID_21
87 #define CC1310_LAUNCHXL_DIO22 IOID_22
88 
89 /* Discrete Inputs */
90 #define CC1310_LAUNCHXL_PIN_BTN1 IOID_13
91 #define CC1310_LAUNCHXL_PIN_BTN2 IOID_14
92 
93 /* GPIO */
94 #define CC1310_LAUNCHXL_GPIO_LED_ON 1
95 #define CC1310_LAUNCHXL_GPIO_LED_OFF 0
96 
97 /* I2C */
98 #define CC1310_LAUNCHXL_I2C0_SCL0 IOID_4
99 #define CC1310_LAUNCHXL_I2C0_SDA0 IOID_5
100 
101 /* LEDs */
102 #define CC1310_LAUNCHXL_PIN_LED_ON 1
103 #define CC1310_LAUNCHXL_PIN_LED_OFF 0
104 #define CC1310_LAUNCHXL_PIN_RLED IOID_6
105 #define CC1310_LAUNCHXL_PIN_GLED IOID_7
106 
107 /* PWM Outputs */
108 #define CC1310_LAUNCHXL_PWMPIN0 CC1310_LAUNCHXL_PIN_RLED
109 #define CC1310_LAUNCHXL_PWMPIN1 CC1310_LAUNCHXL_PIN_GLED
110 #define CC1310_LAUNCHXL_PWMPIN2 PIN_UNASSIGNED
111 #define CC1310_LAUNCHXL_PWMPIN3 PIN_UNASSIGNED
112 #define CC1310_LAUNCHXL_PWMPIN4 PIN_UNASSIGNED
113 #define CC1310_LAUNCHXL_PWMPIN5 PIN_UNASSIGNED
114 #define CC1310_LAUNCHXL_PWMPIN6 PIN_UNASSIGNED
115 #define CC1310_LAUNCHXL_PWMPIN7 PIN_UNASSIGNED
116 
117 /* SPI */
118 #define CC1310_LAUNCHXL_SPI_FLASH_CS IOID_20
119 #define CC1310_LAUNCHXL_FLASH_CS_ON 0
120 #define CC1310_LAUNCHXL_FLASH_CS_OFF 1
121 
122 /* SPI Board */
123 #define CC1310_LAUNCHXL_SPI0_MISO IOID_8 /* RF1.20 */
124 #define CC1310_LAUNCHXL_SPI0_MOSI IOID_9 /* RF1.18 */
125 #define CC1310_LAUNCHXL_SPI0_CLK IOID_10 /* RF1.16 */
126 #define CC1310_LAUNCHXL_SPI0_CSN PIN_UNASSIGNED
127 #define CC1310_LAUNCHXL_SPI1_MISO PIN_UNASSIGNED
128 #define CC1310_LAUNCHXL_SPI1_MOSI PIN_UNASSIGNED
129 #define CC1310_LAUNCHXL_SPI1_CLK PIN_UNASSIGNED
130 #define CC1310_LAUNCHXL_SPI1_CSN PIN_UNASSIGNED
131 
132 /* UART Board */
133 #define CC1310_LAUNCHXL_UART_RX IOID_2 /* RXD */
134 #define CC1310_LAUNCHXL_UART_TX IOID_3 /* TXD */
135 #define CC1310_LAUNCHXL_UART_CTS IOID_19 /* CTS */
136 #define CC1310_LAUNCHXL_UART_RTS IOID_18 /* RTS */
137 
138 /*!
139  * @brief Initialize the general board specific settings
140  *
141  * This function initializes the general board specific settings.
142  */
143 void CC1310_LAUNCHXL_initGeneral(void);
144 
145 /*!
146  * @brief Turn off the external flash on LaunchPads
147  *
148  */
150 
151 /*!
152  * @brief Wake up the external flash present on the board files
153  *
154  * This function toggles the chip select for the amount of time needed
155  * to wake the chip up.
156  */
158 
159 /*!
160  * @def CC1310_LAUNCHXL_ADCBufName
161  * @brief Enum of ADCBufs
162  */
163 typedef enum CC1310_LAUNCHXL_ADCBufName {
164  CC1310_LAUNCHXL_ADCBUF0 = 0,
165 
166  CC1310_LAUNCHXL_ADCBUFCOUNT
167 } CC1310_LAUNCHXL_ADCBufName;
168 
169 /*!
170  * @def CC1310_LAUNCHXL_ADCBuf0ChannelName
171  * @brief Enum of ADCBuf channels
172  */
173 typedef enum CC1310_LAUNCHXL_ADCBuf0ChannelName {
174  CC1310_LAUNCHXL_ADCBUF0CHANNEL0 = 0,
175  CC1310_LAUNCHXL_ADCBUF0CHANNEL1,
176  CC1310_LAUNCHXL_ADCBUF0CHANNEL2,
177  CC1310_LAUNCHXL_ADCBUF0CHANNEL3,
178  CC1310_LAUNCHXL_ADCBUF0CHANNEL4,
179  CC1310_LAUNCHXL_ADCBUF0CHANNEL5,
180  CC1310_LAUNCHXL_ADCBUF0CHANNEL6,
181  CC1310_LAUNCHXL_ADCBUF0CHANNEL7,
182  CC1310_LAUNCHXL_ADCBUF0CHANNELVDDS,
183  CC1310_LAUNCHXL_ADCBUF0CHANNELDCOUPL,
184  CC1310_LAUNCHXL_ADCBUF0CHANNELVSS,
185 
186  CC1310_LAUNCHXL_ADCBUF0CHANNELCOUNT
187 } CC1310_LAUNCHXL_ADCBuf0ChannelName;
188 
189 /*!
190  * @def CC1310_LAUNCHXL_ADCName
191  * @brief Enum of ADCs
192  */
193 typedef enum CC1310_LAUNCHXL_ADCName {
194  CC1310_LAUNCHXL_ADC0 = 0,
195  CC1310_LAUNCHXL_ADC1,
196  CC1310_LAUNCHXL_ADC2,
197  CC1310_LAUNCHXL_ADC3,
198  CC1310_LAUNCHXL_ADC4,
199  CC1310_LAUNCHXL_ADC5,
200  CC1310_LAUNCHXL_ADC6,
201  CC1310_LAUNCHXL_ADC7,
202  CC1310_LAUNCHXL_ADCDCOUPL,
203  CC1310_LAUNCHXL_ADCVSS,
204  CC1310_LAUNCHXL_ADCVDDS,
205 
206  CC1310_LAUNCHXL_ADCCOUNT
207 } CC1310_LAUNCHXL_ADCName;
208 
209 /*!
210  * @def CC1310_LAUNCHXL_CryptoName
211  * @brief Enum of Crypto names
212  */
213 typedef enum CC1310_LAUNCHXL_CryptoName {
214  CC1310_LAUNCHXL_CRYPTO0 = 0,
215 
216  CC1310_LAUNCHXL_CRYPTOCOUNT
217 } CC1310_LAUNCHXL_CryptoName;
218 
219 /*!
220  * @def CC1310_LAUNCHXL_GPIOName
221  * @brief Enum of GPIO names
222  */
223 typedef enum CC1310_LAUNCHXL_GPIOName {
224  CC1310_LAUNCHXL_GPIO_S1 = 0,
225  CC1310_LAUNCHXL_GPIO_S2,
226  CC1310_LAUNCHXL_SPI_MASTER_READY,
227  CC1310_LAUNCHXL_SPI_SLAVE_READY,
228  CC1310_LAUNCHXL_GPIO_LED_GREEN,
229  CC1310_LAUNCHXL_GPIO_LED_RED,
230  CC1310_LAUNCHXL_GPIO_SPI_FLASH_CS,
231  CC1310_LAUNCHXL_SDSPI_CS,
232  CC1310_LAUNCHXL_GPIOCOUNT
233 } CC1310_LAUNCHXL_GPIOName;
234 
235 /*!
236  * @def CC1310_LAUNCHXL_GPTimerName
237  * @brief Enum of GPTimer parts
238  */
239 typedef enum CC1310_LAUNCHXL_GPTimerName {
240  CC1310_LAUNCHXL_GPTIMER0A = 0,
241  CC1310_LAUNCHXL_GPTIMER0B,
242  CC1310_LAUNCHXL_GPTIMER1A,
243  CC1310_LAUNCHXL_GPTIMER1B,
244  CC1310_LAUNCHXL_GPTIMER2A,
245  CC1310_LAUNCHXL_GPTIMER2B,
246  CC1310_LAUNCHXL_GPTIMER3A,
247  CC1310_LAUNCHXL_GPTIMER3B,
248 
249  CC1310_LAUNCHXL_GPTIMERPARTSCOUNT
250 } CC1310_LAUNCHXL_GPTimerName;
251 
252 /*!
253  * @def CC1310_LAUNCHXL_GPTimers
254  * @brief Enum of GPTimers
255  */
256 typedef enum CC1310_LAUNCHXL_GPTimers {
257  CC1310_LAUNCHXL_GPTIMER0 = 0,
258  CC1310_LAUNCHXL_GPTIMER1,
259  CC1310_LAUNCHXL_GPTIMER2,
260  CC1310_LAUNCHXL_GPTIMER3,
261 
262  CC1310_LAUNCHXL_GPTIMERCOUNT
263 } CC1310_LAUNCHXL_GPTimers;
264 
265 /*!
266  * @def CC1310_LAUNCHXL_I2CName
267  * @brief Enum of I2C names
268  */
269 typedef enum CC1310_LAUNCHXL_I2CName {
270 #if TI_I2C_CONF_I2C0_ENABLE
271  CC1310_LAUNCHXL_I2C0 = 0,
272 #endif
273 
274  CC1310_LAUNCHXL_I2CCOUNT
275 } CC1310_LAUNCHXL_I2CName;
276 
277 /*!
278  * @def CC1310_LAUNCHXL_NVSName
279  * @brief Enum of NVS names
280  */
281 typedef enum CC1310_LAUNCHXL_NVSName {
282 #if TI_NVS_CONF_NVS_INTERNAL_ENABLE
283  CC1310_LAUNCHXL_NVSCC26XX0 = 0,
284 #endif
285 #if TI_NVS_CONF_NVS_EXTERNAL_ENABLE
286  CC1310_LAUNCHXL_NVSSPI25X0,
287 #endif
288 
289  CC1310_LAUNCHXL_NVSCOUNT
290 } CC1310_LAUNCHXL_NVSName;
291 
292 /*!
293  * @def CC1310_LAUNCHXL_PWMName
294  * @brief Enum of PWM outputs
295  */
296 typedef enum CC1310_LAUNCHXL_PWMName {
297  CC1310_LAUNCHXL_PWM0 = 0,
298  CC1310_LAUNCHXL_PWM1,
299  CC1310_LAUNCHXL_PWM2,
300  CC1310_LAUNCHXL_PWM3,
301  CC1310_LAUNCHXL_PWM4,
302  CC1310_LAUNCHXL_PWM5,
303  CC1310_LAUNCHXL_PWM6,
304  CC1310_LAUNCHXL_PWM7,
305 
306  CC1310_LAUNCHXL_PWMCOUNT
307 } CC1310_LAUNCHXL_PWMName;
308 
309 /*!
310  * @def CC1310_LAUNCHXL_SDName
311  * @brief Enum of SD names
312  */
313 typedef enum CC1310_LAUNCHXL_SDName {
314  CC1310_LAUNCHXL_SDSPI0 = 0,
315 
316  CC1310_LAUNCHXL_SDCOUNT
317 } CC1310_LAUNCHXL_SDName;
318 
319 /*!
320  * @def CC1310_LAUNCHXL_SPIName
321  * @brief Enum of SPI names
322  */
323 typedef enum CC1310_LAUNCHXL_SPIName {
324 #if TI_SPI_CONF_SPI0_ENABLE
325  CC1310_LAUNCHXL_SPI0 = 0,
326 #endif
327 #if TI_SPI_CONF_SPI1_ENABLE
328  CC1310_LAUNCHXL_SPI1,
329 #endif
330 
331  CC1310_LAUNCHXL_SPICOUNT
332 } CC1310_LAUNCHXL_SPIName;
333 
334 /*!
335  * @def CC1310_LAUNCHXL_TRNGName
336  * @brief Enum of TRNGs
337  */
338 typedef enum CC1310_LAUNCHXL_TRNGName {
339  CC1310_LAUNCHXL_TRNG0 = 0,
340 
341  CC1310_LAUNCHXL_TRNGCOUNT
342 } CC1310_LAUNCHXL_TRNGName;
343 
344 /*!
345  * @def CC1310_LAUNCHXL_UARTName
346  * @brief Enum of UARTs
347  */
348 typedef enum CC1310_LAUNCHXL_UARTName {
349 #if TI_UART_CONF_UART0_ENABLE
350  CC1310_LAUNCHXL_UART0 = 0,
351 #endif
352 
353  CC1310_LAUNCHXL_UARTCOUNT
354 } CC1310_LAUNCHXL_UARTName;
355 
356 /*!
357  * @def CC1310_LAUNCHXL_UDMAName
358  * @brief Enum of DMA buffers
359  */
360 typedef enum CC1310_LAUNCHXL_UDMAName {
361  CC1310_LAUNCHXL_UDMA0 = 0,
362 
363  CC1310_LAUNCHXL_UDMACOUNT
364 } CC1310_LAUNCHXL_UDMAName;
365 
366 /*!
367  * @def CC1310_LAUNCHXL_WatchdogName
368  * @brief Enum of Watchdogs
369  */
370 typedef enum CC1310_LAUNCHXL_WatchdogName {
371  CC1310_LAUNCHXL_WATCHDOG0 = 0,
372 
373  CC1310_LAUNCHXL_WATCHDOGCOUNT
374 } CC1310_LAUNCHXL_WatchdogName;
375 
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 
381 #endif /* __CC1310_LAUNCHXL_BOARD_H__ */
void CC1310_LAUNCHXL_initGeneral(void)
Initialize the general board specific settings.
void CC1310_LAUNCHXL_wakeUpExtFlash(void)
Wake up the external flash present on the board files.
void CC1310_LAUNCHXL_shutDownExtFlash(void)
Turn off the external flash on LaunchPads.