git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4_SimpleLink_CC3220SF_CCS/ti/boards/CC3220SF_LAUNCHXL/CC3220SF_LAUNCHXL.h

   1 /*
   2  * Copyright (c) 2016, 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       C3220SF_LAUNCHXL.h
  34  *
  35  *  @brief      CC3220 Board Specific APIs
  36  *
  37  *  The CC3220SF_LAUNCHXL header file should be included in an application as
  38  *  follows:
  39  *  @code
  40  *  #include <CC3220SF_LAUNCHXL.h>
  41  *  @endcode
  42  *
  43  *  ============================================================================
  44  */
  45 #ifndef __CC3220SF_LAUNCHXL_H
  46 #define __CC3220SF_LAUNCHXL_H
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #define CC3220SF_LAUNCHXL_GPIO_LED_OFF (0)
  53 #define CC3220SF_LAUNCHXL_GPIO_LED_ON  (1)
  54
  55 /*!
  56  *  @def    CC3220SF_LAUNCHXL_ADCName
  57  *  @brief  Enum of ADC names on the CC3220SF_LAUNCHXL dev board
  58  */
  59 typedef enum CC3220SF_LAUNCHXL_ADCName {
  60     CC3220SF_LAUNCHXL_ADC0 = 0,
  61     CC3220SF_LAUNCHXL_ADC1,
  62
  63     CC3220SF_LAUNCHXL_ADCCOUNT
  64 } CC3220SF_LAUNCHXL_ADCName;
  65
  66 /*!
  67  *  @def    CC3220SF_LAUNCHXL_CryptoName
  68  *  @brief  Enum of Crypto names on the CC3220SF_LAUNCHXL dev board
  69  */
  70 typedef enum CC3220SF_LAUNCHXL_CryptoName {
  71     CC3220SF_LAUNCHXL_CRYPTO0 = 0,
  72
  73     CC3220SF_LAUNCHXL_CRYPTOCOUNT
  74 } CC3220SF_LAUNCHXL_CryptoName;
  75
  76 /*!
  77  *  @def    CC3220SF_LAUNCHXL_GPIOName
  78  *  @brief  Enum of GPIO names on the CC3220SF_LAUNCHXL dev board
  79  */
  80 typedef enum CC3220SF_LAUNCHXL_GPIOName {
  81     CC3220SF_LAUNCHXL_GPIO_SW2 = 0,
  82     CC3220SF_LAUNCHXL_GPIO_SW3,
  83     CC3220SF_LAUNCHXL_GPIO_LED_D7,
  84
  85     /*
  86      *  CC3220SF_LAUNCHXL_GPIO_LED_D5 and CC3220SF_LAUNCHXL_GPIO_LED_D6 are shared with the
  87      *  I2C and PWM peripherals. In order for those examples to work, these
  88      *  LEDs are  taken out of gpioPinCOnfig[]
  89      */
  90     //CC3220SF_LAUNCHXL_GPIO_LED_D6,
  91     //CC3220SF_LAUNCHXL_GPIO_LED_D5,
  92
  93     CC3220SF_LAUNCHXL_GPIOCOUNT
  94 } CC3220SF_LAUNCHXL_GPIOName;
  95
  96 /*!
  97  *  @def    CC3220SF_LAUNCHXL_I2CName
  98  *  @brief  Enum of I2C names on the CC3220SF_LAUNCHXL dev board
  99  */
 100 typedef enum CC3220SF_LAUNCHXL_I2CName {
 101     CC3220SF_LAUNCHXL_I2C0 = 0,
 102
 103     CC3220SF_LAUNCHXL_I2CCOUNT
 104 } CC3220SF_LAUNCHXL_I2CName;
 105
 106 /*!
 107  *  @def    CC3220SF_LAUNCHXL_I2SName
 108  *  @brief  Enum of I2S names on the CC3220SF_LAUNCHXL dev board
 109  */
 110 typedef enum CC3220SF_LAUNCHXL_I2SName {
 111     CC3220SF_LAUNCHXL_I2S0 = 0,
 112
 113     CC3220SF_LAUNCHXL_I2SCOUNT
 114 } CC3220SF_LAUNCHXL_I2SName;
 115
 116 /*!
 117  *  @def    CC3220SF_LAUNCHXL_PWMName
 118  *  @brief  Enum of PWM names on the CC3220SF_LAUNCHXL dev board
 119  */
 120 typedef enum CC3220SF_LAUNCHXL_PWMName {
 121     CC3220SF_LAUNCHXL_PWM6 = 0,
 122     CC3220SF_LAUNCHXL_PWM7,
 123
 124     CC3220SF_LAUNCHXL_PWMCOUNT
 125 } CC3220SF_LAUNCHXL_PWMName;
 126
 127 /*!
 128  *  @def    CC3220SF_LAUNCHXL_SDFatFSName
 129  *  @brief  Enum of SDFatFS names on the CC3220SF_LAUNCHXL dev board
 130  */
 131 typedef enum CC3220SF_LAUNCHXL_SDFatFSName {
 132     CC3220SF_LAUNCHXL_SDFatFS0 = 0,
 133
 134     CC3220SF_LAUNCHXL_SDFatFSCOUNT
 135 } CC3220SF_LAUNCHXL_SDFatFSName;
 136
 137 /*!
 138  *  @def    CC3220SF_LAUNCHXL_SDName
 139  *  @brief  Enum of SD names on the CC3220SF_LAUNCHXL dev board
 140  */
 141 typedef enum CC3220SF_LAUNCHXL_SDName {
 142     CC3220SF_LAUNCHXL_SD0 = 0,
 143
 144     CC3220SF_LAUNCHXL_SDCOUNT
 145 } CC3220SF_LAUNCHXL_SDName;
 146 /*!
 147  *  @def    CC3220SF_LAUNCHXL_SDSPIName
 148  *  @brief  Enum of SDSPI names on the CC3220SF_LAUNCHXL dev board
 149  */
 150 typedef enum CC3220SF_LAUNCHXL_SDSPIName {
 151     CC3220SF_LAUNCHXL_SDSPI0 = 0,
 152
 153     CC3220SF_LAUNCHXL_SDSPICOUNT
 154 } CC3220SF_LAUNCHXL_SDSPIName;
 155
 156 /*!
 157  *  @def    CC3220SF_LAUNCHXL_SPIName
 158  *  @brief  Enum of SPI names on the CC3220SF_LAUNCHXL dev board
 159  */
 160 typedef enum CC3220SF_LAUNCHXL_SPIName {
 161     CC3220SF_LAUNCHXL_SPI0 = 0,
 162     CC3220SF_LAUNCHXL_SPI1,
 163
 164     CC3220SF_LAUNCHXL_SPICOUNT
 165 } CC3220SF_LAUNCHXL_SPIName;
 166
 167 /*!
 168  *  @def    CC3220SF_LAUNCHXL_UARTName
 169  *  @brief  Enum of UARTs on the CC3220SF_LAUNCHXL dev board
 170  */
 171 typedef enum CC3220SF_LAUNCHXL_UARTName {
 172     CC3220SF_LAUNCHXL_UART0 = 0,
 173     CC3220SF_LAUNCHXL_UART1,
 174
 175     CC3220SF_LAUNCHXL_UARTCOUNT
 176 } CC3220SF_LAUNCHXL_UARTName;
 177
 178 /*!
 179  *  @def    CC3220SF_LAUNCHXL_WatchdogName
 180  *  @brief  Enum of Watchdogs on the CC3220SF_LAUNCHXL dev board
 181  */
 182 typedef enum CC3220SF_LAUNCHXL_WatchdogName {
 183     CC3220SF_LAUNCHXL_WATCHDOG0 = 0,
 184
 185     CC3220SF_LAUNCHXL_WATCHDOGCOUNT
 186 } CC3220SF_LAUNCHXL_WatchdogName;
 187
 188 /*!
 189  *  @brief  Initialize the general board specific settings
 190  *
 191  *  This function initializes the general board specific settings.
 192  */
 193 extern void CC3220SF_LAUNCHXL_initGeneral(void);
 194
 195 #ifdef __cplusplus
 196 }
 197 #endif
 198
 199 #endif /* __CC3220SF_LAUNCHXL_H */