ptxGPIO.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_GPIO_H_
#define APIS_PTX_GPIO_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptx_Status.h"
#include "ptxOsal.h"
#include "ptxLog.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
    #define PTX_API_LIBFUNC __declspec(dllexport) /* */
#else
 
    #if defined (__GNUC__)                                                  /* GCC */
        #define PTX_API_LIBFUNC __attribute__ ((visibility("default")))     /* requires  -fvisibility=hidden  as compiler option */
    #elif defined (_linux) || defined (__linux)                             /* Linux with some other compiler */
        #error Missing Platform Specification                               /* To be added */
    #else
        #error Missing Platform Specification
    #endif
#endif
 
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
typedef struct ptxGPIO_InitParams
{
    void                            *StackComp;        
} ptxGPIO_InitParams_t;
 
typedef enum ptxGPIO_Pin
{
    GPIO_Pin_5      = 5,
    GPIO_Pin_6      = 6,
    GPIO_Pin_7      = 7,
    GPIO_Pin_8      = 8,
    GPIO_Pin_9      = 9,
    GPIO_Pin_10     = 10,
    GPIO_Pin_11     = 11,
    GPIO_Pin_12     = 12,
 
} ptxGPIO_Pin_t;
 
typedef enum ptxGPIO_Flags
{
    GPIO_Flags_None,
    GPIO_Flags_In_Enable_Internal_Pullup,
    GPIO_Flags_Out_Enable_High_Driver_Strength,
 
} ptxGPIO_Flags_t;
 
typedef enum ptxGPIO_Config
{
    GPIO_Config_Input,
    GPIO_Config_Output,
 
} ptxGPIO_Config_t;
 
typedef struct ptxGPIO
{
    /* Components */
    ptxStatus_Comps_t               CompId;                 
    struct ptxOsal                  *OS;                    
    ptxLog_t                        *LOG;                   
    void                            *StackComp;             
    ptxSemaphore_t                  *Sem_Completion;        
    uint16_t                        *CompletionStatus;      
    uint8_t                         *DataShared;                 
} ptxGPIO_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Init (ptxGPIO_t *gpioComp, ptxGPIO_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Deinit (ptxGPIO_t *gpioComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Config(ptxGPIO_t *gpioComp, ptxGPIO_Pin_t gpioNr, ptxGPIO_Config_t gpioConfig, ptxGPIO_Flags_t gpioFlags);
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Write(ptxGPIO_t *gpioComp, ptxGPIO_Pin_t gpioNr, uint8_t gpioValue);
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Read(ptxGPIO_t *gpioComp, ptxGPIO_Pin_t gpioNr, uint8_t *gpioValue);
 
PTX_API_LIBFUNC ptxStatus_t ptxGPIO_Write_DAC(ptxGPIO_t *gpioComp, uint8_t dacValue);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */