GPIO.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, 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.
 */

/* @} */

#ifndef GPIO__H
#define GPIO__H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

typedef uint32_t GPIO_PinConfig;

#define GPIO_CFG_IO_MASK           0x00ff0000U
#define GPIO_CFG_IO_LSB            16U
#define GPIO_CFG_OUT_TYPE_MASK     0x00060000U
#define GPIO_CFG_OUT_TYPE_LSB      17U
#define GPIO_CFG_IN_TYPE_MASK      0x00060000U
#define GPIO_CFG_IN_TYPE_LSB       17U
#define GPIO_CFG_OUT_STRENGTH_MASK 0x00f00000U
#define GPIO_CFG_OUT_STRENGTH_LSB  20U
#define GPIO_CFG_INT_MASK          0x07000000U
#define GPIO_CFG_INT_LSB           24U
#define GPIO_CFG_OUT_BIT           19U



#define GPIO_CFG_OUTPUT            (((uint32_t) 0) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_OUT_STD           (((uint32_t) 0) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_OUT_OD_NOPULL     (((uint32_t) 2) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_OUT_OD_PU         (((uint32_t) 4) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_OUT_OD_PD         (((uint32_t) 6) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_OUT_HIGH          (((uint32_t) 1) << GPIO_CFG_OUT_BIT) 
#define GPIO_CFG_OUT_LOW           (((uint32_t) 0) << GPIO_CFG_OUT_BIT) 
#define GPIO_CFG_OUT_STR_LOW       (((uint32_t) 0) << GPIO_CFG_OUT_STRENGTH_LSB)
#define GPIO_CFG_OUT_STR_MED       (((uint32_t) 1) << GPIO_CFG_OUT_STRENGTH_LSB)
#define GPIO_CFG_OUT_STR_HIGH      (((uint32_t) 2) << GPIO_CFG_OUT_STRENGTH_LSB)

#define GPIO_CFG_INPUT             (((uint32_t) 1) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_IN_NOPULL         (((uint32_t) 1) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_IN_PU             (((uint32_t) 3) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_IN_PD             (((uint32_t) 5) << GPIO_CFG_IO_LSB) 
#define GPIO_CFG_IN_INT_NONE       (((uint32_t) 0) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_FALLING    (((uint32_t) 1) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_RISING     (((uint32_t) 2) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_BOTH_EDGES (((uint32_t) 3) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_LOW        (((uint32_t) 4) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_HIGH       (((uint32_t) 5) << GPIO_CFG_INT_LSB)    
#define GPIO_CFG_IN_INT_ONLY       (((uint32_t) 1) << 27)                  
#define GPIO_DO_NOT_CONFIG         0x7fff0001U                             
typedef void (*GPIO_CallbackFxn)(void);

typedef void        (*GPIO_InitFxn)           (void);

typedef uint32_t    (*GPIO_ReadFxn)           (uint32_t idx);

typedef void        (*GPIO_WriteFxn)          (uint32_t idx,
                                               uint32_t value);

typedef void        (*GPIO_clearIntFxn)       (uint32_t idx);

typedef void        (*GPIO_disableIntFxn)      (uint32_t idx);

typedef void        (*GPIO_enableIntFxn)       (uint32_t idx);

typedef void        (*GPIO_setCallbackFxn)     (uint32_t idx,
                                                GPIO_CallbackFxn callback);

typedef void        (*GPIO_setConfigFxn)       (uint32_t idx,
                                                GPIO_PinConfig pinConfig);
typedef void        (*GPIO_toggleFxn)          (uint32_t idx);

 typedef struct GPIO_FxnTable_s {
    GPIO_InitFxn            initFxn;
    GPIO_ReadFxn            readFxn;
    GPIO_WriteFxn           writeFxn;
    GPIO_clearIntFxn        clearIntFxn;
    GPIO_disableIntFxn      disableIntFxn;
    GPIO_enableIntFxn       enableIntFxn;
    GPIO_setCallbackFxn     setCallbackFxn;
    GPIO_setConfigFxn       setConfigFxn;
    GPIO_toggleFxn          toggleFxn;

} GPIO_FxnTable;


typedef struct GPIO_Config_s {
    GPIO_FxnTable const    *fxnTablePtr;

    void                   *object;

    void          const    *hwAttrs;
} GPIO_Config;

/* Avoid Misra warning "MISRA.DECL.ARRAY_SIZE" by pairing config array type 
 * with its array size to avoid externs with [] (no size) */
#define GPIO_MAX_CONFIG_CNT       (3U) 
typedef GPIO_Config GPIOConfigList[GPIO_MAX_CONFIG_CNT];

extern void GPIO_clearInt(uint32_t idx);

extern void GPIO_disableInt(uint32_t idx);

extern void GPIO_enableInt(uint32_t idx);

extern void GPIO_init(void);

extern uint32_t GPIO_read(uint32_t idx);

extern void GPIO_setCallback(uint32_t idx, GPIO_CallbackFxn callback);

extern void GPIO_setConfig(uint32_t idx, GPIO_PinConfig pinConfig);

extern void GPIO_toggle(uint32_t idx);

extern void GPIO_write(uint32_t idx, uint32_t value);

#ifdef __cplusplus
}
#endif

#endif /* _GPIO_H */

/* @} */