206 lines
10 KiB
C
206 lines
10 KiB
C
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// gpio.h - Defines and Macros for GPIO API.
|
||
|
|
//
|
||
|
|
// Copyright (c) 2005-2017 Texas Instruments Incorporated. All rights reserved.
|
||
|
|
// Software License Agreement
|
||
|
|
//
|
||
|
|
// 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.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
|
||
|
|
#ifndef __DRIVERLIB_GPIO_H__
|
||
|
|
#define __DRIVERLIB_GPIO_H__
|
||
|
|
|
||
|
|
#include <stdint.h>
|
||
|
|
#include <stdbool.h>
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// If building with a C++ compiler, make all of the definitions in this header
|
||
|
|
// have a C binding.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#endif
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// The following values define the bit field for the ui8Pins argument to
|
||
|
|
// several of the APIs.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_PIN_0 0x00000001 // GPIO pin 0
|
||
|
|
#define GPIO_PIN_1 0x00000002 // GPIO pin 1
|
||
|
|
#define GPIO_PIN_2 0x00000004 // GPIO pin 2
|
||
|
|
#define GPIO_PIN_3 0x00000008 // GPIO pin 3
|
||
|
|
#define GPIO_PIN_4 0x00000010 // GPIO pin 4
|
||
|
|
#define GPIO_PIN_5 0x00000020 // GPIO pin 5
|
||
|
|
#define GPIO_PIN_6 0x00000040 // GPIO pin 6
|
||
|
|
#define GPIO_PIN_7 0x00000080 // GPIO pin 7
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Values that can be passed to GPIODirModeSet as the ui32PinIO parameter, and
|
||
|
|
// returned from GPIODirModeGet.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_DIR_MODE_IN 0x00000000 // Pin is a GPIO input
|
||
|
|
#define GPIO_DIR_MODE_OUT 0x00000001 // Pin is a GPIO output
|
||
|
|
#define GPIO_DIR_MODE_HW 0x00000002 // Pin is a peripheral function
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Values that can be passed to GPIOIntTypeSet as the ui32IntType parameter,
|
||
|
|
// and returned from GPIOIntTypeGet.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_FALLING_EDGE 0x00000000 // Interrupt on falling edge
|
||
|
|
#define GPIO_RISING_EDGE 0x00000004 // Interrupt on rising edge
|
||
|
|
#define GPIO_BOTH_EDGES 0x00000001 // Interrupt on both edges
|
||
|
|
#define GPIO_LOW_LEVEL 0x00000002 // Interrupt on low level
|
||
|
|
#define GPIO_HIGH_LEVEL 0x00000006 // Interrupt on high level
|
||
|
|
#define GPIO_DISCRETE_INT 0x00010000 // Interrupt for individual pins
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Values that can be passed to GPIOPadConfigSet as the ui32Strength parameter,
|
||
|
|
// and returned by GPIOPadConfigGet in the *pui32Strength parameter.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_STRENGTH_2MA 0x00000001 // 2mA drive strength
|
||
|
|
#define GPIO_STRENGTH_4MA 0x00000002 // 4mA drive strength
|
||
|
|
#define GPIO_STRENGTH_6MA 0x00000065 // 6mA drive strength
|
||
|
|
#define GPIO_STRENGTH_8MA 0x00000066 // 8mA drive strength
|
||
|
|
#define GPIO_STRENGTH_8MA_SC 0x0000006E // 8mA drive with slew rate control
|
||
|
|
#define GPIO_STRENGTH_10MA 0x00000075 // 10mA drive strength
|
||
|
|
#define GPIO_STRENGTH_12MA 0x00000077 // 12mA drive strength
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Values that can be passed to GPIOPadConfigSet as the ui32PadType parameter,
|
||
|
|
// and returned by GPIOPadConfigGet in the *pui32PadType parameter.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_PIN_TYPE_STD 0x00000008 // Push-pull
|
||
|
|
#define GPIO_PIN_TYPE_STD_WPU 0x0000000A // Push-pull with weak pull-up
|
||
|
|
#define GPIO_PIN_TYPE_STD_WPD 0x0000000C // Push-pull with weak pull-down
|
||
|
|
#define GPIO_PIN_TYPE_OD 0x00000009 // Open-drain
|
||
|
|
#define GPIO_PIN_TYPE_ANALOG 0x00000000 // Analog comparator
|
||
|
|
#define GPIO_PIN_TYPE_WAKE_HIGH 0x00000208 // Hibernate wake, high
|
||
|
|
#define GPIO_PIN_TYPE_WAKE_LOW 0x00000108 // Hibernate wake, low
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Values that can be passed to GPIOIntEnable() and GPIOIntDisable() functions
|
||
|
|
// in the ui32IntFlags parameter.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#define GPIO_INT_PIN_0 0x00000001
|
||
|
|
#define GPIO_INT_PIN_1 0x00000002
|
||
|
|
#define GPIO_INT_PIN_2 0x00000004
|
||
|
|
#define GPIO_INT_PIN_3 0x00000008
|
||
|
|
#define GPIO_INT_PIN_4 0x00000010
|
||
|
|
#define GPIO_INT_PIN_5 0x00000020
|
||
|
|
#define GPIO_INT_PIN_6 0x00000040
|
||
|
|
#define GPIO_INT_PIN_7 0x00000080
|
||
|
|
#define GPIO_INT_DMA 0x00000100
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Prototypes for the APIs.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
extern void GPIODirModeSet(uint32_t ui32Port, uint8_t ui8Pins,
|
||
|
|
uint32_t ui32PinIO);
|
||
|
|
extern uint32_t GPIODirModeGet(uint32_t ui32Port, uint8_t ui8Pin);
|
||
|
|
extern void GPIOIntTypeSet(uint32_t ui32Port, uint8_t ui8Pins,
|
||
|
|
uint32_t ui32IntType);
|
||
|
|
extern uint32_t GPIOIntTypeGet(uint32_t ui32Port, uint8_t ui8Pin);
|
||
|
|
extern void GPIOPadConfigSet(uint32_t ui32Port, uint8_t ui8Pins,
|
||
|
|
uint32_t ui32Strength, uint32_t ui32PadType);
|
||
|
|
extern void GPIOPadConfigGet(uint32_t ui32Port, uint8_t ui8Pin,
|
||
|
|
uint32_t *pui32Strength, uint32_t *pui32PadType);
|
||
|
|
extern void GPIOIntEnable(uint32_t ui32Port, uint32_t ui32IntFlags);
|
||
|
|
extern void GPIOIntDisable(uint32_t ui32Port, uint32_t ui32IntFlags);
|
||
|
|
extern uint32_t GPIOIntStatus(uint32_t ui32Port, bool bMasked);
|
||
|
|
extern void GPIOIntClear(uint32_t ui32Port, uint32_t ui32IntFlags);
|
||
|
|
extern void GPIOIntRegister(uint32_t ui32Port, void (*pfnIntHandler)(void));
|
||
|
|
extern void GPIOIntUnregister(uint32_t ui32Port);
|
||
|
|
extern void GPIOIntRegisterPin(uint32_t ui32Port, uint32_t ui32Pin,
|
||
|
|
void (*pfnIntHandler)(void));
|
||
|
|
extern void GPIOIntUnregisterPin(uint32_t ui32Port, uint32_t ui32Pin);
|
||
|
|
extern int32_t GPIOPinRead(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinWrite(uint32_t ui32Port, uint8_t ui8Pins, uint8_t ui8Val);
|
||
|
|
extern void GPIOPinConfigure(uint32_t ui32PinConfig);
|
||
|
|
extern void GPIOPinTypeADC(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeCAN(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeComparator(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeComparatorOutput(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeDIVSCLK(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeEPI(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeEthernetLED(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeEthernetMII(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeGPIOInput(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeGPIOOutput(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeGPIOOutputOD(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeHibernateRTCCLK(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeI2C(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeI2CSCL(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeLCD(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeOneWire(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypePWM(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeQEI(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeSSI(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeTimer(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeTrace(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeUART(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeUSBAnalog(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeUSBDigital(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeWakeHigh(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOPinTypeWakeLow(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern uint32_t GPIOPinWakeStatus(uint32_t ui32Port);
|
||
|
|
extern void GPIODMATriggerEnable(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIODMATriggerDisable(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOADCTriggerEnable(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
extern void GPIOADCTriggerDisable(uint32_t ui32Port, uint8_t ui8Pins);
|
||
|
|
|
||
|
|
//*****************************************************************************
|
||
|
|
//
|
||
|
|
// Mark the end of the C bindings section for C++ compilers.
|
||
|
|
//
|
||
|
|
//*****************************************************************************
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif // __DRIVERLIB_GPIO_H__
|