gpio/v1/gpio.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Texas Instruments Incorporated
 *
 * 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 GPIO_H_
#define GPIO_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/hw_include/cslr.h>
#include <drivers/hw_include/cslr_gpio.h>
#include <kernel/dpl/SystemP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define GPIO_PIN_LOW                    (0U)
 
#define GPIO_PIN_HIGH                   (1U)
 
#define GPIO_DIRECTION_OUTPUT           (1U)
 
#define GPIO_DIRECTION_INPUT            (0U)
 
#define GPIO_OPEN_DRAIN_ENABLE           (1U)
 
#define GPIO_OPEN_DRAIN_DISABLE          (0U)
 
#define GPIO_TRIG_TYPE_NONE             (0U)
 
#define GPIO_TRIG_TYPE_RISE_EDGE        (1U)
 
#define GPIO_TRIG_TYPE_FALL_EDGE        (2U)
 
#define GPIO_TRIG_TYPE_BOTH_EDGE        (3U)
 
#define GPIO_INTR_LEVEL_LOW             (0U)
 
#define GPIO_INTR_LEVEL_HIGH            (1U)
 
#define GPIO_MAX_PORT                   (8U)
 
#define GPIO_MAX_INTERRUPT_PORT         (4U)
 
#define GPIO_MAX_PINS_PER_PORT          (8U)
 
#define GPIO_MAX_PINS                   (GPIO_MAX_PORT * GPIO_MAX_PINS_PER_PORT)
 
#define GPIO_MAX_INTERRUPT              (GPIO_MAX_INTERRUPT_PORT * GPIO_MAX_PINS_PER_PORT)
 
#define GPIO_GET_PIN_OFFSET(pinNum)     (((uint32_t)pinNum) % (GPIO_MAX_PORT * GPIO_MAX_PINS_PER_PORT))
 
#define GPIO_GET_PORT_NUM(pinNum)       ((GPIO_GET_PIN_OFFSET(pinNum)) / GPIO_MAX_PINS_PER_PORT)
 
#define GPIO_GET_PIN_INDEX(pinNum)      ((GPIO_GET_PIN_OFFSET(pinNum)) % GPIO_MAX_PINS_PER_PORT)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void GPIO_moduleEnable(uint32_t baseAddr);
 
int32_t GPIO_ignoreOrHonorPolarity(uint32_t baseAddr, uint32_t pinNum, uint32_t polLevel);
 
int32_t GPIO_setTrigType(uint32_t baseAddr, uint32_t pinNum, uint32_t polLevel);
 
int32_t GPIO_enableInterrupt(uint32_t baseAddr, uint32_t pinNum);
 
int32_t GPIO_disableInterrupt(uint32_t baseAddr, uint32_t pinNum);
 
 
int32_t GPIO_clearInterrupt(uint32_t baseAddr, uint32_t pinNum);
 
int32_t GPIO_markHighLowLevelInterrupt(uint32_t baseAddr, uint32_t pinNum, uint32_t interruptLevel);
 
uint32_t GPIO_getHighLowLevelPendingInterrupt(uint32_t baseAddr, uint32_t interruptLevel);
 
void GPIO_setDirMode(uint32_t baseAddr, uint32_t pinNum, uint32_t pinDir);
 
uint32_t GPIO_pinRead(uint32_t baseAddr, uint32_t pinNum);
 
void GPIO_pinWriteHigh(uint32_t baseAddr, uint32_t pinNum);
 
 
void GPIO_pinWriteLow(uint32_t baseAddr, uint32_t pinNum);
 
 
void GPIO_setOpenDrainStatus(uint32_t baseAddr, uint32_t pinNum, uint32_t openDrainStatus);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef GPIO_H_ */