mikroSDK Reference Manual
gpio.h
1//*****************************************************************************
2//
3// gpio.h - Defines and Macros for GPIO API.
4//
5// Copyright (c) 2005-2020 Texas Instruments Incorporated. All rights reserved.
6// Software License Agreement
7//
8// Redistribution and use in source and binary forms, with or without
9// modification, are permitted provided that the following conditions
10// are met:
11//
12// Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14//
15// Redistributions in binary form must reproduce the above copyright
16// notice, this list of conditions and the following disclaimer in the
17// documentation and/or other materials provided with the
18// distribution.
19//
20// Neither the name of Texas Instruments Incorporated nor the names of
21// its contributors may be used to endorse or promote products derived
22// from this software without specific prior written permission.
23//
24// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35//
36// This is part of revision 2.2.0.295 of the Tiva Peripheral Driver Library.
37//
38//*****************************************************************************
39
40#ifndef __DRIVERLIB_GPIO_H__
41#define __DRIVERLIB_GPIO_H__
42
43//*****************************************************************************
44//
45// If building with a C++ compiler, make all of the definitions in this header
46// have a C binding.
47//
48//*****************************************************************************
49#ifdef __cplusplus
50extern "C"
51{
52#endif
53
54//*****************************************************************************
55//
56// The following values define the bit field for the ui8Pins argument to
57// several of the APIs.
58//
59//*****************************************************************************
60#define GPIO_PIN_0 0x00000001 // GPIO pin 0
61#define GPIO_PIN_1 0x00000002 // GPIO pin 1
62#define GPIO_PIN_2 0x00000004 // GPIO pin 2
63#define GPIO_PIN_3 0x00000008 // GPIO pin 3
64#define GPIO_PIN_4 0x00000010 // GPIO pin 4
65#define GPIO_PIN_5 0x00000020 // GPIO pin 5
66#define GPIO_PIN_6 0x00000040 // GPIO pin 6
67#define GPIO_PIN_7 0x00000080 // GPIO pin 7
68
69//*****************************************************************************
70//
71// Values that can be passed to GPIODirModeSet as the ui32PinIO parameter, and
72// returned from GPIODirModeGet.
73//
74//*****************************************************************************
75#define GPIO_DIR_MODE_IN 0x00000000 // Pin is a GPIO input
76#define GPIO_DIR_MODE_OUT 0x00000001 // Pin is a GPIO output
77#define GPIO_DIR_MODE_HW 0x00000002 // Pin is a peripheral function
78
79//*****************************************************************************
80//
81// Values that can be passed to GPIOIntTypeSet as the ui32IntType parameter,
82// and returned from GPIOIntTypeGet.
83//
84//*****************************************************************************
85#define GPIO_FALLING_EDGE 0x00000000 // Interrupt on falling edge
86#define GPIO_RISING_EDGE 0x00000004 // Interrupt on rising edge
87#define GPIO_BOTH_EDGES 0x00000001 // Interrupt on both edges
88#define GPIO_LOW_LEVEL 0x00000002 // Interrupt on low level
89#define GPIO_HIGH_LEVEL 0x00000006 // Interrupt on high level
90#define GPIO_DISCRETE_INT 0x00010000 // Interrupt for individual pins
91
92//*****************************************************************************
93//
94// Values that can be passed to GPIOPadConfigSet as the ui32Strength parameter,
95// and returned by GPIOPadConfigGet in the *pui32Strength parameter.
96//
97//*****************************************************************************
98#define GPIO_STRENGTH_2MA 0x00000001 // 2mA drive strength
99#define GPIO_STRENGTH_4MA 0x00000002 // 4mA drive strength
100#define GPIO_STRENGTH_6MA 0x00000065 // 6mA drive strength
101#define GPIO_STRENGTH_8MA 0x00000066 // 8mA drive strength
102#define GPIO_STRENGTH_8MA_SC 0x0000006E // 8mA drive with slew rate control
103#define GPIO_STRENGTH_10MA 0x00000075 // 10mA drive strength
104#define GPIO_STRENGTH_12MA 0x00000077 // 12mA drive strength
105
106//*****************************************************************************
107//
108// Values that can be passed to GPIOPadConfigSet as the ui32PadType parameter,
109// and returned by GPIOPadConfigGet in the *pui32PadType parameter.
110//
111//*****************************************************************************
112#define GPIO_PIN_TYPE_STD 0x00000008 // Push-pull
113#define GPIO_PIN_TYPE_STD_WPU 0x0000000A // Push-pull with weak pull-up
114#define GPIO_PIN_TYPE_STD_WPD 0x0000000C // Push-pull with weak pull-down
115#define GPIO_PIN_TYPE_OD 0x00000009 // Open-drain
116#define GPIO_PIN_TYPE_ANALOG 0x00000000 // Analog comparator
117#define GPIO_PIN_TYPE_WAKE_HIGH 0x00000208 // Hibernate wake, high
118#define GPIO_PIN_TYPE_WAKE_LOW 0x00000108 // Hibernate wake, low
119
120//*****************************************************************************
121//
122// Values that can be passed to GPIOIntEnable() and GPIOIntDisable() functions
123// in the ui32IntFlags parameter.
124//
125//*****************************************************************************
126#define GPIO_INT_PIN_0 0x00000001
127#define GPIO_INT_PIN_1 0x00000002
128#define GPIO_INT_PIN_2 0x00000004
129#define GPIO_INT_PIN_3 0x00000008
130#define GPIO_INT_PIN_4 0x00000010
131#define GPIO_INT_PIN_5 0x00000020
132#define GPIO_INT_PIN_6 0x00000040
133#define GPIO_INT_PIN_7 0x00000080
134#define GPIO_INT_DMA 0x00000100
135
136//*****************************************************************************
137//
138// Prototypes for the APIs.
139//
140//*****************************************************************************
141extern void GPIODirModeSet(uint32_t ui32Port, uint8_t ui8Pins,
142 uint32_t ui32PinIO);
143extern uint32_t GPIODirModeGet(uint32_t ui32Port, uint8_t ui8Pin);
144extern void GPIOIntTypeSet(uint32_t ui32Port, uint8_t ui8Pins,
145 uint32_t ui32IntType);
146extern uint32_t GPIOIntTypeGet(uint32_t ui32Port, uint8_t ui8Pin);
147extern void GPIOPadConfigSet(uint32_t ui32Port, uint8_t ui8Pins,
148 uint32_t ui32Strength, uint32_t ui32PadType);
149extern void GPIOPadConfigGet(uint32_t ui32Port, uint8_t ui8Pin,
150 uint32_t *pui32Strength, uint32_t *pui32PadType);
151extern void GPIOIntEnable(uint32_t ui32Port, uint32_t ui32IntFlags);
152extern void GPIOIntDisable(uint32_t ui32Port, uint32_t ui32IntFlags);
153extern uint32_t GPIOIntStatus(uint32_t ui32Port, bool bMasked);
154extern void GPIOIntClear(uint32_t ui32Port, uint32_t ui32IntFlags);
155extern void GPIOIntRegister(uint32_t ui32Port, void (*pfnIntHandler)(void));
156extern void GPIOIntUnregister(uint32_t ui32Port);
157extern void GPIOIntRegisterPin(uint32_t ui32Port, uint32_t ui32Pin,
158 void (*pfnIntHandler)(void));
159extern void GPIOIntUnregisterPin(uint32_t ui32Port, uint32_t ui32Pin);
160extern int32_t GPIOPinRead(uint32_t ui32Port, uint8_t ui8Pins);
161extern void GPIOPinWrite(uint32_t ui32Port, uint8_t ui8Pins, uint8_t ui8Val);
162extern void GPIOPinConfigure(uint32_t ui32PinConfig);
163extern void GPIOPinTypeADC(uint32_t ui32Port, uint8_t ui8Pins);
164extern void GPIOPinTypeCAN(uint32_t ui32Port, uint8_t ui8Pins);
165extern void GPIOPinTypeComparator(uint32_t ui32Port, uint8_t ui8Pins);
166extern void GPIOPinTypeComparatorOutput(uint32_t ui32Port, uint8_t ui8Pins);
167extern void GPIOPinTypeDIVSCLK(uint32_t ui32Port, uint8_t ui8Pins);
168extern void GPIOPinTypeEPI(uint32_t ui32Port, uint8_t ui8Pins);
169extern void GPIOPinTypeEthernetLED(uint32_t ui32Port, uint8_t ui8Pins);
170extern void GPIOPinTypeEthernetMII(uint32_t ui32Port, uint8_t ui8Pins);
171extern void GPIOPinTypeGPIOInput(uint32_t ui32Port, uint8_t ui8Pins);
172extern void GPIOPinTypeGPIOOutput(uint32_t ui32Port, uint8_t ui8Pins);
173extern void GPIOPinTypeGPIOOutputOD(uint32_t ui32Port, uint8_t ui8Pins);
174extern void GPIOPinTypeHibernateRTCCLK(uint32_t ui32Port, uint8_t ui8Pins);
175extern void GPIOPinTypeI2C(uint32_t ui32Port, uint8_t ui8Pins);
176extern void GPIOPinTypeI2CSCL(uint32_t ui32Port, uint8_t ui8Pins);
177extern void GPIOPinTypeLCD(uint32_t ui32Port, uint8_t ui8Pins);
178extern void GPIOPinTypeOneWire(uint32_t ui32Port, uint8_t ui8Pins);
179extern void GPIOPinTypePWM(uint32_t ui32Port, uint8_t ui8Pins);
180extern void GPIOPinTypeQEI(uint32_t ui32Port, uint8_t ui8Pins);
181extern void GPIOPinTypeSSI(uint32_t ui32Port, uint8_t ui8Pins);
182extern void GPIOPinTypeTimer(uint32_t ui32Port, uint8_t ui8Pins);
183extern void GPIOPinTypeTrace(uint32_t ui32Port, uint8_t ui8Pins);
184extern void GPIOPinTypeUART(uint32_t ui32Port, uint8_t ui8Pins);
185extern void GPIOPinTypeUSBAnalog(uint32_t ui32Port, uint8_t ui8Pins);
186extern void GPIOPinTypeUSBDigital(uint32_t ui32Port, uint8_t ui8Pins);
187extern void GPIOPinTypeWakeHigh(uint32_t ui32Port, uint8_t ui8Pins);
188extern void GPIOPinTypeWakeLow(uint32_t ui32Port, uint8_t ui8Pins);
189extern uint32_t GPIOPinWakeStatus(uint32_t ui32Port);
190extern void GPIODMATriggerEnable(uint32_t ui32Port, uint8_t ui8Pins);
191extern void GPIODMATriggerDisable(uint32_t ui32Port, uint8_t ui8Pins);
192extern void GPIOADCTriggerEnable(uint32_t ui32Port, uint8_t ui8Pins);
193extern void GPIOADCTriggerDisable(uint32_t ui32Port, uint8_t ui8Pins);
194extern void GPIOUnlockPin(uint32_t ui32Port, uint8_t ui8Pins);
195
196//*****************************************************************************
197//
198// Mark the end of the C bindings section for C++ compilers.
199//
200//*****************************************************************************
201#ifdef __cplusplus
202}
203#endif
204
205#endif // __DRIVERLIB_GPIO_H__