oc_pwm.h

Go to the documentation of this file.

#ifndef SYSTEM_CORE_INC_DRIVERS_PWM_OC_PWM_H_
#define SYSTEM_CORE_INC_DRIVERS_PWM_OC_PWM_H_

#define DRIVER_HEADER
#define DRIVER_NAME                 PWM

#include <oc_driver.h>
#include <oc_gpio.h>
#include <oc_frequency.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

typedef enum
{
    oC_PWM_ActiveState_Low  = oC_GPIO_PinsState_AllLow,
    oC_PWM_ActiveState_High = oC_GPIO_PinsState_AllHigh
} oC_PWM_ActiveState_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    oC_Pins_t               Pin;
    oC_PWM_ActiveState_t    ActiveState;
    uint64_t                MaximumValue;
    oC_Frequency_t          TickFrequency;
    oC_Frequency_t          PermissibleDiffernece;
} oC_PWM_Config_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct Context_t * oC_PWM_Context_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

extern oC_ErrorCode_t oC_PWM_Configure         ( const oC_PWM_Config_t * Config , oC_PWM_Context_t * outContext );
extern oC_ErrorCode_t oC_PWM_Unconfigure       ( const oC_PWM_Config_t * Config , oC_PWM_Context_t * outContext );
extern oC_ErrorCode_t oC_PWM_SetDuty           ( oC_PWM_Context_t Context , float PercentDuty );
extern oC_ErrorCode_t oC_PWM_ReadDuty          ( oC_PWM_Context_t Context , float * outPercentDuty );
extern oC_ErrorCode_t oC_PWM_SetValue          ( oC_PWM_Context_t Context , uint64_t Value );
extern oC_ErrorCode_t oC_PWM_ReadValue         ( oC_PWM_Context_t Context , uint64_t * outValue );

#undef  _________________________________________PROTOTYPES_SECTION_________________________________________________________________________


#endif /* SYSTEM_CORE_INC_DRIVERS_PWM_OC_PWM_H_ */