PINCC26XX.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015-2017, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*!*****************************************************************************
 *  @file       PINCC26XX.h
 *  @brief      Device-specific pin & GPIO driver for CC26xx family [def]
 *
 *  # Overview #
 *  This is the device-specific implementation of the generic PIN driver for the
 *  CC26xx family of devices.
 *
 *  Refer to @ref PIN.h for a complete description of APIs & example of use.
 *
 *******************************************************************************
 */

#ifndef ti_drivers_PINCC26XX__include
#define ti_drivers_PINCC26XX__include
#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stddef.h>

#include <ti/drivers/dpl/HwiP.h>

#include <ti/drivers/PIN.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(driverlib/ioc.h)
#include DeviceFamily_constructPath(driverlib/gpio.h)

//------------------------------------------------------------------------------
// Internal function used to find the index of the rightmost set bit in
// efficient way
#if defined(__IAR_SYSTEMS_ICC__) || defined(DOXYGEN)
    #include <intrinsics.h>
#endif

__STATIC_INLINE uint32_t PIN_ctz(uint32_t x) {
#if defined(codered) || defined(gcc) || defined(sourcerygxx) || defined(__GNUC__)
    return __builtin_ctz(x);
#elif defined(__IAR_SYSTEMS_ICC__) || defined(DOXYGEN)
    return __CLZ(__RBIT(x));
#elif defined(rvmdk) || defined(__ARMCC_VERSION)
    return __clz(__rbit(x));
#elif defined(__TI_COMPILER_VERSION__)
    return __clz(__rbit(x));
#else
    #error "Unsupported compiler used"
#endif
}

//------------------------------------------------------------------------------

// Constant that can be used to remove run-time checks for improved efficiency
// Activate through preprocessor define PIN_DISABLE_RUNTIME_CHECKS
#ifdef PIN_DISABLE_RUNTIME_CHECKS
    #define PIN_CHKEN 0
#else
    #define PIN_CHKEN 1
#endif

#define PINCC26XX_INPUT_EN          (1 << 29)         
#define PINCC26XX_HYSTERESIS        (1 << 30)         
#define PINCC26XX_NOPULL            (0x3 << 13)       
#define PINCC26XX_PULLUP            (0x2 << 13)       
#define PINCC26XX_PULLDOWN          (0x1 << 13)       
#define PINCC26XX_BM_INPUT_EN       (0x01 << 29)      
#define PINCC26XX_BM_HYSTERESIS     (0x01 << 30)      
#define PINCC26XX_BM_PULLING        (0x03 << 13)      
#define PINCC26XX_BM_INPUT_MODE     (PINCC26XX_BM_INPUT_EN | PINCC26XX_BM_HYSTERESIS | \
                                     PINCC26XX_BM_PULLING)

#define PINCC26XX_GPIO_OUTPUT_EN    (1 << 23)     
#define PINCC26XX_GPIO_LOW          (0 << 22)     
#define PINCC26XX_GPIO_HIGH         (1 << 22)     
#define PINCC26XX_PUSHPULL          (0x0 << 25)   
#define PINCC26XX_OPENDRAIN         (0x2 << 25)   
#define PINCC26XX_OPENSOURCE        (0x3 << 25)   
#define PINCC26XX_SLEWCTRL          (1 << 12)     
#define PINCC26XX_DRVSTR_MIN        (0x0 << 8)    
#define PINCC26XX_DRVSTR_MED        (0x4 << 8)    
#define PINCC26XX_DRVSTR_MAX        (0x8 << 8)    
#define PINCC26XX_BM_GPIO_OUTPUT_EN (1 << 23)     
#define PINCC26XX_BM_GPIO_OUTPUT_VAL (1 << 22)    
#define PINCC26XX_BM_OUTPUT_BUF     (3 << 25)     
#define PINCC26XX_BM_SLEWCTRL       (1 << 12)     
#define PINCC26XX_BM_DRVSTR         (0xF << 8)    
#define PINCC26XX_BM_GPIO_OUTPUT_MODE (PINCC26XX_BM_GPIO_OUTPUT_EN | PINCC26XX_BM_GPIO_OUTPUT_VAL)
#define PINCC26XX_BM_OUTPUT_MODE    (PINCC26XX_BM_GPIO_OUTPUT_MODE | PINCC26XX_BM_OUTPUT_BUF | \
                                     PINCC26XX_BM_SLEWCTRL | PINCC26XX_BM_DRVSTR)

#define PINCC26XX_INV_INOUT         (1 << 24)     
#define PINCC26XX_IRQ_DIS           (0x0 << 16)   
#define PINCC26XX_IRQ_NEGEDGE       (0x5 << 16)   
#define PINCC26XX_IRQ_POSEDGE       (0x6 << 16)   
#define PINCC26XX_IRQ_BOTHEDGES     (0x7 << 16)   
#define PINCC26XX_BM_INV_INOUT      (1 << 24)     
#define PINCC26XX_BM_IRQ            (0x7 << 16)   

#define PINCC26XX_NO_WAKEUP         (0 << 27)     
#define PINCC26XX_WAKEUP_POSEDGE    (3 << 27)     
#define PINCC26XX_WAKEUP_NEGEDGE    (2 << 27)     
#define PINCC26XX_BM_WAKEUP         (3 << 27)     

#define PINCC26XX_BM_IOCFG          (PINCC26XX_BM_INPUT_MODE|PINCC26XX_BM_OUTPUT_BUF | \
                                     PINCC26XX_BM_SLEWCTRL | PINCC26XX_BM_DRVSTR | \
                                     PINCC26XX_BM_INV_INOUT | PINCC26XX_BM_IRQ | PINCC26XX_BM_WAKEUP)
#define PINCC26XX_BM_ALL            (PINCC26XX_BM_IOCFG | PINCC26XX_BM_GPIO_OUTPUT_MODE)

#define PINCC26XX_DIO0    0
#define PINCC26XX_DIO1    1
#define PINCC26XX_DIO2    2
#define PINCC26XX_DIO3    3
#define PINCC26XX_DIO4    4
#define PINCC26XX_DIO5    5
#define PINCC26XX_DIO6    6
#define PINCC26XX_DIO7    7
#define PINCC26XX_DIO8    8
#define PINCC26XX_DIO9    9
#define PINCC26XX_DIO10   10
#define PINCC26XX_DIO11   11
#define PINCC26XX_DIO12   12
#define PINCC26XX_DIO13   13
#define PINCC26XX_DIO14   14
#define PINCC26XX_DIO15   15
#define PINCC26XX_DIO16   16
#define PINCC26XX_DIO17   17
#define PINCC26XX_DIO18   18
#define PINCC26XX_DIO19   19
#define PINCC26XX_DIO20   20
#define PINCC26XX_DIO21   21
#define PINCC26XX_DIO22   22
#define PINCC26XX_DIO23   23
#define PINCC26XX_DIO24   24
#define PINCC26XX_DIO25   25
#define PINCC26XX_DIO26   26
#define PINCC26XX_DIO27   27
#define PINCC26XX_DIO28   28
#define PINCC26XX_DIO29   29
#define PINCC26XX_DIO30   30
#define PINCC26XX_DIO31   31

// Array of handles, one per pin (pin id is index)
extern PIN_Handle PIN_HandleTable[];

// Number of pins available on device
extern uint32_t PIN_NumPins;


__STATIC_INLINE uint32_t PINCC26XX_getInputValue(PIN_Id pinId) {
    return (HWREG(GPIO_BASE + GPIO_O_DIN31_0) >> pinId) & 1;
}


/* @brief Fast/efficient version of #PIN_setOutputEnable()
 * @note  Does not include any checks on handle for efficiency reasons,
 *        use #PIN_setOutputEnable() for checked version
 */
__STATIC_INLINE void PINCC26XX_setOutputEnable(PIN_Id pinId, bool outputEnable) {
    uint32_t key = HwiP_disable();
        HWREG(GPIO_BASE + GPIO_O_DOE31_0) =
            ((HWREG(GPIO_BASE + GPIO_O_DOE31_0) & ~(1 << pinId)) | (outputEnable << pinId));
    HwiP_restore(key);
}


/* @brief Fast/efficient version of #PIN_setOutputValue()
 * @note  Does not include any checks on handle for efficiency reasons,
 *        use #PIN_setOutputValue() for checked version
 */
__STATIC_INLINE void PINCC26XX_setOutputValue(PIN_Id pinId, uint32_t val) {
    HWREGB(GPIO_BASE + GPIO_O_DOUT3_0 + pinId) = (val) ? 1 : 0;
}


__STATIC_INLINE uint32_t PINCC26XX_getOutputValue(PIN_Id pinId) {
    return (HWREG(GPIO_BASE + GPIO_O_DOUT31_0) >> pinId) & 1;
}


__STATIC_INLINE void PINCC26XX_clrPendInterrupt(PIN_Id pinId) {
    HWREG(GPIO_NONBUF_BASE + GPIO_O_EVFLAGS31_0) = (1 << pinId);
}


__STATIC_INLINE uint32_t PINCC26XX_getPortInputValue(PIN_Handle handle) {
    // Only a single port on CC26xx
    return HWREG(GPIO_BASE + GPIO_O_DIN31_0);
}


__STATIC_INLINE uint32_t PINCC26XX_getPortOutputValue(PIN_Handle handle) {
    // Only a single port on CC26xx
    return HWREG(GPIO_BASE + GPIO_O_DOUT31_0);
}


/* @brief Fast/efficient version of #PIN_setPortOutputValue()
 * @note  Does not include any checks on handle for efficiency reasons,
 *        use #PIN_setPortOutputValue() for checked version
 */
__STATIC_INLINE void PINCC26XX_setPortOutputValue(PIN_Handle handle, uint32_t outputValueMask) {
    // Only a single port on CC26xx
    HWREG(GPIO_BASE + GPIO_O_DOUTTGL31_0) =
         (HWREG(GPIO_BASE + GPIO_O_DOUT31_0) ^ outputValueMask) & handle->portMask;
}


/* @brief Fast/efficient version of #PIN_setPortOutputEnable()
 * @note  Does not include any checks on handle for efficiency reasons,
 *        use #PIN_setPortOutputEnable() for checked version
 */
__STATIC_INLINE void PINCC26XX_setPortOutputEnable(PIN_Handle handle, uint32_t outputEnableMask) {
    // Only a single port on CC26xx
    uint32_t key = HwiP_disable();
        HWREG(GPIO_BASE + GPIO_O_DOE31_0) =
            (HWREG(GPIO_BASE + GPIO_O_DOE31_0) & (~handle->portMask)) | (outputEnableMask & handle->portMask);
    HwiP_restore(key);
}


extern PIN_Config PINCC26XX_getConfig(PIN_Id pinId);


extern PIN_Status PINCC26XX_setWakeup(const PIN_Config aPinCfg[]);


extern int32_t PINCC26XX_getMux(PIN_Id pinId);

extern uint32_t PINCC26XX_getPinCount();

extern PIN_Status PINCC26XX_setMux(PIN_Handle handle, PIN_Id pinId, int32_t nMux);

typedef struct PINCC26XX_HWAttrs{
    uint8_t          intPriority;
    uint32_t         swiPriority;
} PINCC26XX_HWAttrs;

#define PINCC26XX_MUX_GPIO           IOC_PORT_GPIO            // Default general purpose IO usage
#define PINCC26XX_MUX_AON_CLK32K     IOC_PORT_AON_CLK32K      // AON External 32kHz clock
#define PINCC26XX_MUX_AUX_IO         IOC_PORT_AUX_IO          // AUX IO Pin
#define PINCC26XX_MUX_MCU_SSI0_RX    IOC_PORT_MCU_SSI0_RX     // MCU SSI0 Receive Pin
#define PINCC26XX_MUX_MCU_SSI0_TX    IOC_PORT_MCU_SSI0_TX     // MCU SSI0 Transmit Pin
#define PINCC26XX_MUX_MCU_SSI0_FSS   IOC_PORT_MCU_SSI0_FSS    // MCU SSI0 FSS Pin
#define PINCC26XX_MUX_MCU_SSI0_CLK   IOC_PORT_MCU_SSI0_CLK    // MCU SSI0 Clock Pin
#define PINCC26XX_MUX_MCU_I2C_MSSDA  IOC_PORT_MCU_I2C_MSSDA   // MCU I2C Data Pin
#define PINCC26XX_MUX_MCU_I2C_MSSCL  IOC_PORT_MCU_I2C_MSSCL   // MCU I2C Clock Pin
#define PINCC26XX_MUX_MCU_UART0_RX   IOC_PORT_MCU_UART0_RX    // MCU UART0 Receive Pin
#define PINCC26XX_MUX_MCU_UART0_TX   IOC_PORT_MCU_UART0_TX    // MCU UART0 Transmit Pin
#define PINCC26XX_MUX_MCU_UART0_CTS  IOC_PORT_MCU_UART0_CTS   // MCU UART0 Clear To Send Pin
#define PINCC26XX_MUX_MCU_UART0_RTS  IOC_PORT_MCU_UART0_RTS   // MCU UART0 Request To Send Pin
#define PINCC26XX_MUX_MCU_PORT_EV_0  IOC_PORT_MCU_PORT_EVENT0 // MCU power event 0
#define PINCC26XX_MUX_MCU_PORT_EV_1  IOC_PORT_MCU_PORT_EVENT1 // MCU power event 1
#define PINCC26XX_MUX_MCU_PORT_EV_2  IOC_PORT_MCU_PORT_EVENT2 // MCU power event 2
#define PINCC26XX_MUX_MCU_PORT_EV_3  IOC_PORT_MCU_PORT_EVENT3 // MCU power event 3
#define PINCC26XX_MUX_MCU_PORT_EV_4  IOC_PORT_MCU_PORT_EVENT4 // MCU power event 4
#define PINCC26XX_MUX_MCU_PORT_EV_5  IOC_PORT_MCU_PORT_EVENT5 // MCU power event 5
#define PINCC26XX_MUX_MCU_PORT_EV_6  IOC_PORT_MCU_PORT_EVENT6 // MCU power event 6
#define PINCC26XX_MUX_MCU_PORT_EV_7  IOC_PORT_MCU_PORT_EVENT7 // MCU power event 7
#define PINCC26XX_MUX_SWV            IOC_PORT_MCU_SWV         // MCU serial wire viewer
#define PINCC26XX_MUX_MCU_SSI1_RX    IOC_PORT_MCU_SSI1_RX     // MCU SSI1 Receive Pin
#define PINCC26XX_MUX_MCU_SSI1_TX    IOC_PORT_MCU_SSI1_TX     // MCU SSI1 Transmit Pin
#define PINCC26XX_MUX_MCU_SSI1_FSS   IOC_PORT_MCU_SSI1_FSS    // MCU SSI1 FSS Pin
#define PINCC26XX_MUX_MCU_SSI1_CLK   IOC_PORT_MCU_SSI1_CLK    // MCU SSI1 Clock Pin
#define PINCC26XX_MUX_MCU_I2S_AD0    IOC_PORT_MCU_I2S_AD0     // MCU I2S Data Pin 0
#define PINCC26XX_MUX_MCU_I2S_AD1    IOC_PORT_MCU_I2S_AD1     // MCU I2S Data Pin 1
#define PINCC26XX_MUX_MCU_I2S_WCLK   IOC_PORT_MCU_I2S_WCLK    // MCU I2S Frame/Word Clock
#define PINCC26XX_MUX_MCU_I2S_BCLK   IOC_PORT_MCU_I2S_BCLK    // MCU I2S Bit Clock
#define PINCC26XX_MUX_MCU_I2S_MCLK   IOC_PORT_MCU_I2S_MCLK    // MCU I2S Master clock 2
#define PINCC26XX_MUX_RFC_TRC        IOC_PORT_RFC_TRC         // RF Core Tracer
#define PINCC26XX_MUX_RFC_GPO0       IOC_PORT_RFC_GPO0        // RC Core Data Out Pin 0
#define PINCC26XX_MUX_RFC_GPO1       IOC_PORT_RFC_GPO1        // RC Core Data Out Pin 1
#define PINCC26XX_MUX_RFC_GPO2       IOC_PORT_RFC_GPO2        // RC Core Data Out Pin 2
#define PINCC26XX_MUX_RFC_GPO3       IOC_PORT_RFC_GPO3        // RC Core Data Out Pin 3
#define PINCC26XX_MUX_RFC_GPI0       IOC_PORT_RFC_GPI0        // RC Core Data In Pin 0
#define PINCC26XX_MUX_RFC_GPI1       IOC_PORT_RFC_GPI1        // RC Core Data In Pin 1
#define PINCC26XX_MUX_RFC_SMI_DL_OUT IOC_PORT_RFC_SMI_DL_OUT  // RF Core SMI Data Link Out
#define PINCC26XX_MUX_RFC_SMI_DL_IN  IOC_PORT_RFC_SMI_DL_IN   // RF Core SMI Data Link in
#define PINCC26XX_MUX_RFC_SMI_CL_OUT IOC_PORT_RFC_SMI_CL_OUT  // RF Core SMI Command Link Out
#define PINCC26XX_MUX_RFC_SMI_CL_IN  IOC_PORT_RFC_SMI_CL_IN   // RF Core SMI Command Link In

#ifdef __cplusplus
}
#endif
#endif /* ti_drivers_PINCC26XX__include */