Pwm_Types.h

Go to the documentation of this file.

#ifndef PWM_TYPES_H__
#define PWM_TYPES_H__
 
#include "Registers.h"
 

#define PWM_ID_INIT                     0x00u 
#define PWM_ID_DE_INIT                  0x01u 
#define PWM_ID_SET_DUTY_CYCLE           0x02u 
#define PWM_ID_SET_PERIOD_AND_DUTY      0x03u 
#define PWM_ID_SET_OUTPUT_TO_IDLE       0x04u 
#define PWM_ID_GET_OUTPUT_STATE         0x05u 
#define PWM_ID_DISABLE_NOTIFICATION     0x06u 
#define PWM_ID_ENABLE_NOTIFICATION      0x07u 
#define PWM_ID_SET_POWER_STATE          0x09u 
#define PWM_ID_GET_CURRENT_POWER_STATE  0x0au 
#define PWM_ID_GET_TARGET_POWER_STATE   0x0bu 
#define PWM_ID_PREPARE_POWER_STATE      0x0cu 
#define PWM_ID_GET_VERSION_INFO         0x08u 

#define PWM_E_INIT_FAILED               0x10u 
#define PWM_E_UNINIT                    0x11u 
#define PWM_E_PARAM_CHANNEL             0x12u 
#define PWM_E_PERIOD_UNCHANGEABLE       0x13u 
#define PWM_E_ALREADY_INITIALIZED       0x14u 
#define PWM_E_PARAM_POINTER             0x15u 
#define PWM_E_POWER_STATE_NOT_SUPPORTED 0x17u 
#define PWM_E_TRANSITION_NOT_POSSIBLE   0x18u 
#define PWM_E_PERIPHERAL_NOT_PREPARED   0x19u 
#define PWM_E_NOT_DISENGAGED            0x16u 

#ifndef UTEST
#define PWM_STATIC static 
#else
#define PWM_STATIC 
#endif

typedef uint32 Pwm_ChannelType;

typedef uint32 Pwm_PeriodType;

typedef enum _Pwm_OutputStateType
{
    PWM_HIGH = 0x00, 
    PWM_LOW          
} Pwm_OutputStateType;

typedef enum _Pwm_EdgeNotificationType
{
    PWM_RISING_EDGE = 0x00, 
    PWM_FALLING_EDGE,       
    PWM_BOTH_EDGES          
} Pwm_EdgeNotificationType;

/* cppcheck-suppress misra-c2012-2.3 ; the enum name it is neccesary */
typedef enum _Pwm_ChannelClassType
{                               /* cppcheck-suppress misra-c2012-2.4 ; this macro is neccesary */
    PWM_VARIABLE_PERIOD = 0x00, 
    PWM_FIXED_PERIOD,           
    PWM_FIXED_PERIOD_SHIFTED    
} Pwm_ChannelClassType;

typedef enum _Pwm_PowerStateRequestResultType
{
    PWM_SERVICE_ACCEPTED = 0x00, 
    PWM_NOT_INIT,                
    PWM_SEQUENCE_ERROR,          
    PWM_HW_FAILURE,              
    PWM_POWER_STATE_NOT_SUPP,    
    PWM_TRANS_NOT_POSSIBLE,      
} Pwm_PowerStateRequestResultType;

typedef enum _Pwm_PowerStateType
{
    PWM_FULL_POWER = 0x00 
} Pwm_PowerStateType;

typedef struct _Pwm_ConfigType
{
    uint32 dummy; 
} Pwm_ConfigType;

typedef enum
{
    PWM_STATE_UNINIT, 
    PWM_STATE_INIT    
} Pwm_StatusType;

typedef struct _Pwm_HwUnit
{
    const Pwm_ConfigType *Config;          
    Pwm_StatusType HwUnitState;            
    Pwm_ChannelClassType Pwm_ChannelClass; 
    uint8 Pwm_channelNumber;               
    uint16 Duty_Cycle;                     
    Pwm_PeriodType Period;                 
} Pwm_HwUnit;
 
#endif /* PWM_TYPES_H__ */