csl_gpio.h

Go to the documentation of this file.

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005, 2008
 *
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.
 *  ============================================================================
 */

/* ============================================================================
 * Revision History
 * ================
 * 22-Sept-2008 - Added GPIO for CSL
 * ============================================================================
 */

#ifndef _CSL_GPIO_H_
#define _CSL_GPIO_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <cslr.h>
#include <soc.h>
#include <cslr_gpio.h>
#include <csl_error.h>
#include <csl_types.h>
#include <csl_general.h>


/*****************************************************************************\
          GPIO global macro declarations
\*****************************************************************************/

#define CSL_GPIO_NUM_PIN  32

#define CSL_GPIO_BIT_SET 1

#define CSL_GPIO_BIT_RESET 0

#define GPIO_DRIVE_HIGH    1

#define GPIO_DRIVE_LOW     0

/**************************************************************************\
* GPIO global typedef declarations                                         *
\**************************************************************************/

typedef enum {
    CSL_GPIO_PIN0 = 0,
    CSL_GPIO_PIN1 =1,
    CSL_GPIO_PIN2 = 2,
    CSL_GPIO_PIN3 = 3,
    CSL_GPIO_PIN4 = 4,
    CSL_GPIO_PIN5 = 5,
    CSL_GPIO_PIN6 = 6,
    CSL_GPIO_PIN7 = 7,
    CSL_GPIO_PIN8 = 8,
    CSL_GPIO_PIN9 = 9,
    CSL_GPIO_PIN10 = 10,
    CSL_GPIO_PIN11 = 11,
    CSL_GPIO_PIN12 = 12,
    CSL_GPIO_PIN13 = 13,
    CSL_GPIO_PIN14 = 14,
    CSL_GPIO_PIN15 = 15,
    CSL_GPIO_PIN16 = 16,
    CSL_GPIO_PIN17 = 17,
    CSL_GPIO_PIN18 = 18,
    CSL_GPIO_PIN19 = 19,
    CSL_GPIO_PIN20 = 20,
    CSL_GPIO_PIN21 = 21,
    CSL_GPIO_PIN22 = 22,
    CSL_GPIO_PIN23 = 23,
    CSL_GPIO_PIN24 = 24,
    CSL_GPIO_PIN25 = 25,
    CSL_GPIO_PIN26 = 26,
    CSL_GPIO_PIN27 = 27,
    CSL_GPIO_PIN28 = 28,
    CSL_GPIO_PIN29 = 29,
    CSL_GPIO_PIN30 = 30,
    CSL_GPIO_PIN31 = 31
} CSL_GpioPinNum;


typedef enum {

    CSL_GPIO_TRIG_RISING_EDGE = 0,

    CSL_GPIO_TRIG_FALLING_EDGE = 1,

    CSL_GPIO_TRIG_CLEAR_EDGE = 2

} CSL_GpioTriggerType;


typedef enum {

    CSL_GPIO_DIR_INPUT = 0,
    CSL_GPIO_DIR_OUTPUT = 1

} CSL_GpioDirection;


typedef enum {

    CSL_GPIO_CMD_CONFIG_BIT = 0,
    CSL_GPIO_CMD_INT_DISABLE = 1,
    CSL_GPIO_CMD_INT_ENABLE = 2,
    CSL_GPIO_CMD_CLEAR_INT_FLAG = 3

} CSL_GpioConfigCmd;

typedef struct  {

    volatile Uint16 GPIODIRL;
    volatile Uint16 GPIODIRH;

    volatile Uint16 GPIOINTTRIGL;
    volatile Uint16 GPIOINTTRIGH;

    volatile Uint16 GPIOINTENAL;
    volatile Uint16 GPIOINTENAH;

}CSL_GpioConfig;


typedef struct {

    CSL_GpioPinNum pinNum;

    CSL_GpioDirection direction;

    CSL_GpioTriggerType trigger;

} CSL_GpioPinConfig;

typedef struct{

    CSL_GpioRegsOvly baseAddr;

    Uint8 numPins;

}CSL_GpioObj;

typedef CSL_GpioObj*  GPIO_Handle;

/*******************************************************************************
 * GPIO function declarations
 ******************************************************************************/

GPIO_Handle GPIO_open (
CSL_GpioObj *GPIOobj,
CSL_Status  *status
 );

CSL_Status GPIO_close (
GPIO_Handle       hGPIO
);


CSL_Status GPIO_config (
GPIO_Handle                  GPIOHandle,
CSL_GpioConfig               *config
);



CSL_Status  GPIO_getConfig(
GPIO_Handle       hGpio,
CSL_GpioConfig    *config
);

CSL_Status GPIO_read (
GPIO_Handle     hGPIO,
CSL_GpioPinNum  pinNum,
Uint16          *buffer
);

CSL_Status GPIO_write (
GPIO_Handle     hGPIO,
CSL_GpioPinNum  pinNum,
Uint16          buffer
);

CSL_Status GPIO_reset (
GPIO_Handle     hGPIO
);


CSL_Status GPIO_configBit (
GPIO_Handle       hGpio,
CSL_GpioPinConfig *config
);

CSL_Status GPIO_disableInt (
GPIO_Handle    hGpio,
CSL_GpioPinNum pin
);


CSL_Status GPIO_enableInt (
GPIO_Handle      hGpio,
CSL_GpioPinNum   pin
);


CSL_Status GPIO_clearInt (
GPIO_Handle    hGpio,
CSL_GpioPinNum pin
);


int GPIO_statusBit (
GPIO_Handle    hGpio,
CSL_GpioPinNum pin,
CSL_Status    *status
);
#ifdef __cplusplus
}
#endif

#endif /* _CSL_GPIO_H_ */