/******************************************************************************* GPIO PLIB Company: Microchip Technology Inc. File Name: plib_gpio.h Summary: GPIO PLIB Header File Description: This library provides an interface to control and interact with Parallel Input/Output controller (GPIO) module. *******************************************************************************/ /******************************************************************************* * Copyright (C) 2019 Microchip Technology Inc. and its subsidiaries. * * Subject to your compliance with these terms, you may use Microchip software * and any derivatives exclusively with Microchip products. It is your * responsibility to comply with third party license terms applicable to your * use of third party software (including open source software) that may * accompany Microchip software. * * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A * PARTICULAR PURPOSE. * * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN * ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. *******************************************************************************/ #ifndef PLIB_GPIO_H #define PLIB_GPIO_H #include #include #include #include // DOM-IGNORE-BEGIN #ifdef __cplusplus // Provide C++ Compatibility extern "C" { #endif // DOM-IGNORE-END // ***************************************************************************** // ***************************************************************************** // Section: Data types and constants // ***************************************************************************** // ***************************************************************************** /*** Macros for GPIO_RE5 pin ***/ #define GPIO_RE5_Set() (LATESET = (1<<5)) #define GPIO_RE5_Clear() (LATECLR = (1<<5)) #define GPIO_RE5_Toggle() (LATEINV= (1<<5)) #define GPIO_RE5_OutputEnable() (TRISECLR = (1<<5)) #define GPIO_RE5_InputEnable() (TRISESET = (1<<5)) #define GPIO_RE5_Get() ((PORTE >> 5) & 0x1) #define GPIO_RE5_GetLatch() ((LATE >> 5) & 0x1) #define GPIO_RE5_PIN GPIO_PIN_RE5 /*** Macros for GPIO_RE1 pin ***/ #define GPIO_RE1_Set() (LATESET = (1<<1)) #define GPIO_RE1_Clear() (LATECLR = (1<<1)) #define GPIO_RE1_Toggle() (LATEINV= (1<<1)) #define GPIO_RE1_OutputEnable() (TRISECLR = (1<<1)) #define GPIO_RE1_InputEnable() (TRISESET = (1<<1)) #define GPIO_RE1_Get() ((PORTE >> 1) & 0x1) #define GPIO_RE1_GetLatch() ((LATE >> 1) & 0x1) #define GPIO_RE1_PIN GPIO_PIN_RE1 /*** Macros for GPIO_RB8 pin ***/ #define GPIO_RB8_Set() (LATBSET = (1<<8)) #define GPIO_RB8_Clear() (LATBCLR = (1<<8)) #define GPIO_RB8_Toggle() (LATBINV= (1<<8)) #define GPIO_RB8_OutputEnable() (TRISBCLR = (1<<8)) #define GPIO_RB8_InputEnable() (TRISBSET = (1<<8)) #define GPIO_RB8_Get() ((PORTB >> 8) & 0x1) #define GPIO_RB8_GetLatch() ((LATB >> 8) & 0x1) #define GPIO_RB8_PIN GPIO_PIN_RB8 #define GPIO_RB8_InterruptEnable() (CNENBSET = (1<<8)) #define GPIO_RB8_InterruptDisable() (CNENBCLR = (1<<8)) /*** Macros for GPIO_RB13 pin ***/ #define GPIO_RB13_Set() (LATBSET = (1<<13)) #define GPIO_RB13_Clear() (LATBCLR = (1<<13)) #define GPIO_RB13_Toggle() (LATBINV= (1<<13)) #define GPIO_RB13_OutputEnable() (TRISBCLR = (1<<13)) #define GPIO_RB13_InputEnable() (TRISBSET = (1<<13)) #define GPIO_RB13_Get() ((PORTB >> 13) & 0x1) #define GPIO_RB13_GetLatch() ((LATB >> 13) & 0x1) #define GPIO_RB13_PIN GPIO_PIN_RB13 /*** Macros for GPIO_RB14 pin ***/ #define GPIO_RB14_Set() (LATBSET = (1<<14)) #define GPIO_RB14_Clear() (LATBCLR = (1<<14)) #define GPIO_RB14_Toggle() (LATBINV= (1<<14)) #define GPIO_RB14_OutputEnable() (TRISBCLR = (1<<14)) #define GPIO_RB14_InputEnable() (TRISBSET = (1<<14)) #define GPIO_RB14_Get() ((PORTB >> 14) & 0x1) #define GPIO_RB14_GetLatch() ((LATB >> 14) & 0x1) #define GPIO_RB14_PIN GPIO_PIN_RB14 /*** Macros for GPIO_RF1 pin ***/ #define GPIO_RF1_Set() (LATFSET = (1<<1)) #define GPIO_RF1_Clear() (LATFCLR = (1<<1)) #define GPIO_RF1_Toggle() (LATFINV= (1<<1)) #define GPIO_RF1_OutputEnable() (TRISFCLR = (1<<1)) #define GPIO_RF1_InputEnable() (TRISFSET = (1<<1)) #define GPIO_RF1_Get() ((PORTF >> 1) & 0x1) #define GPIO_RF1_GetLatch() ((LATF >> 1) & 0x1) #define GPIO_RF1_PIN GPIO_PIN_RF1 // ***************************************************************************** /* GPIO Port Summary: Identifies the available GPIO Ports. Description: This enumeration identifies the available GPIO Ports. Remarks: The caller should not rely on the specific numbers assigned to any of these values as they may change from one processor to the next. Not all ports are available on all devices. Refer to the specific device data sheet to determine which ports are supported. */ #define GPIO_PORT_B (0U) #define GPIO_PORT_C (1U) #define GPIO_PORT_D (2U) #define GPIO_PORT_E (3U) #define GPIO_PORT_F (4U) #define GPIO_PORT_G (5U) typedef uint32_t GPIO_PORT; // ***************************************************************************** /* GPIO Port Pins Summary: Identifies the available GPIO port pins. Description: This enumeration identifies the available GPIO port pins. Remarks: The caller should not rely on the specific numbers assigned to any of these values as they may change from one processor to the next. Not all pins are available on all devices. Refer to the specific device data sheet to determine which pins are supported. */ #define GPIO_PIN_RB0 (0U) #define GPIO_PIN_RB1 (1U) #define GPIO_PIN_RB2 (2U) #define GPIO_PIN_RB3 (3U) #define GPIO_PIN_RB4 (4U) #define GPIO_PIN_RB5 (5U) #define GPIO_PIN_RB6 (6U) #define GPIO_PIN_RB7 (7U) #define GPIO_PIN_RB8 (8U) #define GPIO_PIN_RB9 (9U) #define GPIO_PIN_RB10 (10U) #define GPIO_PIN_RB11 (11U) #define GPIO_PIN_RB12 (12U) #define GPIO_PIN_RB13 (13U) #define GPIO_PIN_RB14 (14U) #define GPIO_PIN_RB15 (15U) #define GPIO_PIN_RC12 (28U) #define GPIO_PIN_RC13 (29U) #define GPIO_PIN_RC14 (30U) #define GPIO_PIN_RC15 (31U) #define GPIO_PIN_RD0 (32U) #define GPIO_PIN_RD1 (33U) #define GPIO_PIN_RD2 (34U) #define GPIO_PIN_RD3 (35U) #define GPIO_PIN_RD4 (36U) #define GPIO_PIN_RD5 (37U) #define GPIO_PIN_RD6 (38U) #define GPIO_PIN_RD7 (39U) #define GPIO_PIN_RD8 (40U) #define GPIO_PIN_RD9 (41U) #define GPIO_PIN_RD10 (42U) #define GPIO_PIN_RD11 (43U) #define GPIO_PIN_RE0 (48U) #define GPIO_PIN_RE1 (49U) #define GPIO_PIN_RE2 (50U) #define GPIO_PIN_RE3 (51U) #define GPIO_PIN_RE4 (52U) #define GPIO_PIN_RE5 (53U) #define GPIO_PIN_RE6 (54U) #define GPIO_PIN_RE7 (55U) #define GPIO_PIN_RF0 (64U) #define GPIO_PIN_RF1 (65U) #define GPIO_PIN_RF3 (67U) #define GPIO_PIN_RF4 (68U) #define GPIO_PIN_RF5 (69U) #define GPIO_PIN_RG6 (86U) #define GPIO_PIN_RG7 (87U) #define GPIO_PIN_RG8 (88U) #define GPIO_PIN_RG9 (89U) /* This element should not be used in any of the GPIO APIs. It will be used by other modules or application to denote that none of the GPIO Pin is used */ #define GPIO_PIN_NONE (-1) typedef uint32_t GPIO_PIN; typedef void (*GPIO_PIN_CALLBACK) ( GPIO_PIN pin, uintptr_t context); void GPIO_Initialize(void); // ***************************************************************************** // ***************************************************************************** // Section: GPIO Functions which operates on multiple pins of a port // ***************************************************************************** // ***************************************************************************** uint32_t GPIO_PortRead(GPIO_PORT port); void GPIO_PortWrite(GPIO_PORT port, uint32_t mask, uint32_t value); uint32_t GPIO_PortLatchRead ( GPIO_PORT port ); void GPIO_PortSet(GPIO_PORT port, uint32_t mask); void GPIO_PortClear(GPIO_PORT port, uint32_t mask); void GPIO_PortToggle(GPIO_PORT port, uint32_t mask); void GPIO_PortInputEnable(GPIO_PORT port, uint32_t mask); void GPIO_PortOutputEnable(GPIO_PORT port, uint32_t mask); void GPIO_PortInterruptEnable(GPIO_PORT port, uint32_t mask); void GPIO_PortInterruptDisable(GPIO_PORT port, uint32_t mask); // ***************************************************************************** // ***************************************************************************** // Section: Local Data types and Prototypes // ***************************************************************************** // ***************************************************************************** typedef struct { /* target pin */ GPIO_PIN pin; /* Callback for event on target pin*/ GPIO_PIN_CALLBACK callback; /* Callback Context */ uintptr_t context; } GPIO_PIN_CALLBACK_OBJ; // ***************************************************************************** // ***************************************************************************** // Section: GPIO Functions which operates on one pin at a time // ***************************************************************************** // ***************************************************************************** static inline void GPIO_PinWrite(GPIO_PIN pin, bool value) { GPIO_PortWrite((GPIO_PORT)(pin>>4), (uint32_t)(0x1) << (pin & 0xFU), (uint32_t)(value) << (pin & 0xFU)); } static inline bool GPIO_PinRead(GPIO_PIN pin) { return (bool)(((GPIO_PortRead((GPIO_PORT)(pin>>4))) >> (pin & 0xFU)) & 0x1U); } static inline bool GPIO_PinLatchRead(GPIO_PIN pin) { return (bool)((GPIO_PortLatchRead((GPIO_PORT)(pin>>4)) >> (pin & 0xFU)) & 0x1U); } static inline void GPIO_PinToggle(GPIO_PIN pin) { GPIO_PortToggle((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinSet(GPIO_PIN pin) { GPIO_PortSet((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinClear(GPIO_PIN pin) { GPIO_PortClear((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinInputEnable(GPIO_PIN pin) { GPIO_PortInputEnable((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinOutputEnable(GPIO_PIN pin) { GPIO_PortOutputEnable((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinInterruptEnable(GPIO_PIN pin) { GPIO_PortInterruptEnable((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } static inline void GPIO_PinInterruptDisable(GPIO_PIN pin) { GPIO_PortInterruptDisable((GPIO_PORT)(pin>>4), 0x1UL << (pin & 0xFU)); } bool GPIO_PinInterruptCallbackRegister( GPIO_PIN pin, const GPIO_PIN_CALLBACK callback, uintptr_t context ); // DOM-IGNORE-BEGIN #ifdef __cplusplus // Provide C++ Compatibility } #endif // DOM-IGNORE-END #endif // PLIB_GPIO_H