pwm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025, TUSAS Malaysia
 * All rights reserved. 
 * This file contains proprietary information. This
 * file shall not be duplicated, used, modified,
 * or disclosed in whole or in part without
 * the express written consent of TUSAS.
 */

 
#ifndef INCLUDED_PWM_H
#define INCLUDED_PWM_H
 
#include "commonDataTypes.h"
#include "driverStatus.h"
 
#define PWM_DEV_CH_MAX     (4U)
#define PWM_CHANNEL_MAX    (6U)
#define PWM_DUTY_CYCLE_MAX (100U)
#define PWM_ULD            (0x02U)
#define PWM_SG_COND        (0x03U)

typedef enum
{
   PWM_BIT_PASS = 0U, 
   PWM_BIT_FAIL = 1U 
} PwmBITState;

typedef struct
{
   PwmBITState incomplete; 
   PwmBITState pbitF5v5; 
   PwmBITState pbitIcCommErr[PWM_DEV_CH_MAX]; 
} PwmPbitStatus;

typedef struct
{
   PwmBITState tw[PWM_DEV_CH_MAX]; 
   PwmBITState uld[PWM_DEV_CH_MAX]; 
   PwmBITState psf[PWM_DEV_CH_MAX]; 
   PwmBITState ocs[PWM_DEV_CH_MAX]; 
   PwmBITState tsd[PWM_DEV_CH_MAX]; 
   PwmBITState pwmChUld[PWM_DEV_CH_MAX]; 
   PwmBITState pwmChOvercurrent[PWM_DEV_CH_MAX]; 
   PwmBITState notRun; 
   PwmBITState cbitF5v5; 
   PwmBITState cbitIcCommErr[PWM_DEV_CH_MAX]; 
   PwmBITState fIvdc[PWM_DEV_CH_MAX]; 
} PwmCbitStatus;

typedef struct
{
   UInt32 baseAddress; 
} PwmDevHandler;

DriverStatus pwm_getPbit(const PwmDevHandler pwmDevHdl, PwmPbitStatus *pbitStatus);

DriverStatus pwm_getCbit(const PwmDevHandler pwmDevHdl, PwmCbitStatus *cbitStatus);

DriverStatus pwm_getTemp(const PwmDevHandler pwmDevHdl, Float32 *temp);

DriverStatus pwm_enable(const PwmDevHandler pwmDevHdl, const UInt8 pwmChannel);

DriverStatus pwm_disable(const PwmDevHandler pwmDevHdl, const UInt8 pwmChannel);

DriverStatus pwm_setFrequencyDutycycle(const PwmDevHandler pwmDevHdl, const UInt16 frequency,
                                       const UInt16 dutyCycle);
 
#endif //INCLUDED_PWM_H