Pwm.h

Go to the documentation of this file.

/*
*
* Copyright (C) 2023 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/

 /*
 * Below are the global requirements which are met by this PWM
 * driver which can't be mapped to a particular source ID
 */
 /*
  * Design: MCAL-6809,MCAL-7617,MCAL-6772,MCAL-7638,MCAL-6808,MCAL-7571,MCAL-6845,MCAL-7625,MCAL-6826,MCAl-7536,MCAL-6820,MCAL-7570,MCAL-6778,MCAL-7613
  */

/*
 * Below are the PWM module's environment requirements which can't be mapped
 * to this driver
 */
 /*
 * Design: MCAL-6806,MCAL-7610,MCAL-6834,MCAL-7565,MCAL-6837,MCAL-7561
 */
#ifndef PWM_H
#define PWM_H

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
/*
 * Design: MCAL-6888,MCAL-7551,MCAL-6824,MCAL-7572
 */
#include "Std_Types.h"
#include "Pwm_Cfg.h"

#ifdef __cplusplus
extern "C"
{
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
#define PWM_SW_MAJOR_VERSION            (9U)

#define PWM_SW_MINOR_VERSION            (0U)

#define PWM_SW_PATCH_VERSION            (0U)
/* @} */



#define PWM_AR_RELEASE_MAJOR_VERSION    (4U)

#define PWM_AR_RELEASE_MINOR_VERSION    (3U)

#define PWM_AR_RELEASE_REVISION_VERSION (1U)
/* @} */

#define PWM_VENDOR_ID                   ((uint16) 44U)

#define PWM_MODULE_ID                   ((uint16) 121U)

/*
 * Design: MCAL-6847,MCAL-7527
 */

#ifndef PWM_E_INIT_FAILED
#define PWM_E_INIT_FAILED              ((uint8)(0x10U))
#endif

/*
 * Design: MCAL-6833,MCAL-7611
 */

#ifndef PWM_E_UNINIT
#define PWM_E_UNINIT                    ((uint8)(0x11U))
#endif

/*
* Design: MCAL-6872,MCAL-7523
*/


#ifndef PWM_E_PARAM_CHANNEL
#define PWM_E_PARAM_CHANNEL             ((uint8)(0x12U))
#endif

/*
 * Design: MCAL-6802,MCAL-7616
 */

#ifndef PWM_E_PERIOD_UNCHANGEABLE
#define PWM_E_PERIOD_UNCHANGEABLE       ((uint8)(0x13U))
#endif

/*
 * Design: MCAL-6856,MCAL-7574
 */
#ifndef PWM_E_ALREADY_INITIALIZED
#define PWM_E_ALREADY_INITIALIZED       ((uint8)(0x14U))
#endif

/*
 * Design: MCAL-6847,MCAL-7527
 */
#ifndef PWM_E_PARAM_POINTER
#define PWM_E_PARAM_POINTER             ((uint8)(0x15U))
#endif

/*
 * Design: MCAL-6879,MCAL-7529
 */
#ifndef PWM_E_NOT_DISENGAGED
#define PWM_E_NOT_DISENGAGED            ((uint8)(0x16U))
#endif
/* @} */

#define PWM_SID_INIT                        ((uint8)(0x0U))

#define PWM_SID_DEINIT                      ((uint8)(0x1U))

#define PWM_SID_SET_DUTY_CYCLE              ((uint8)(0x2U))

#define PWM_SID_SET_PERIOD_AND_DUTY         ((uint8)(0x3U))

#define PWM_SID_SET_OUTPUT_TO_IDLE          ((uint8)(0x4U))

#define PWM_SID_GET_OUTPUT_STATE            ((uint8)(0x5U))

#define PWM_SID_DISABLE_NOTIFICATION        ((uint8)(0x6U))

#define PWM_SID_ENABLE_NOTIFICATION         ((uint8)(0x7U))

#define PWM_SID_GET_VERSION_INFO            ((uint8)(0x8U))

#define PWM_SID_REGISTER_READBACK           ((uint8)(0xDU))
/* @} */

#define PWM_STATUS_UNINIT                   ((uint8)(0U))

#define PWM_STATUS_INIT                     ((uint8)(1U))

/* @} */

 /*
  * Design: MCAL-6801,MCAL-7544,MCAL-6880,MCAL-7547
  */
/* Design MCAL-6880,MCAL-7547 states that PWM module shall comply below duty cycle scheme
 *  - 0x0000 means 0%.
 *  - 0x8000 means 100%.
 *    0x8000 gives the highest resolution while allowing 100% duty cycle
 *    to be represented with a 16 bit value
 */
#define PWM_DUTY_0_PERCENT                (0x0U)

#define PWM_DUTY_100_PERCENT              (0x8000U)

#define PWM_DUTY_50_PERCENT               (0x4000U)




/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

/*
 * Design: MCAL-6775,MCAL-7543
 */
typedef enum
{
    PWM_LOW = 0U,
    PWM_HIGH
} Pwm_OutputStateType;

 /*
  * Design: MCAL-6836,MCAL-7576
  */
typedef enum
{
    PWM_RISING_EDGE  = 1U,
    PWM_FALLING_EDGE = 2U,
    PWM_BOTH_EDGES   = 3U
} Pwm_EdgeNotificationType;

/*
 * Design: MCAL-6763,MCAL-7587
 */
typedef uint32 Pwm_PeriodType;

/*
 * Design: MCAL-6883,MCAL-7505
 */
typedef uint32 Pwm_ChannelType;

typedef uint32 Pwm_FrequencyType;

/*
 * Design: MCAL-6796,MCAL-7589,MCAL-7597
 */
typedef enum
{
    PWM_FIXED_PERIOD = 0U,
    PWM_FIXED_PERIOD_SHIFTED,
    PWM_VARIABLE_PERIOD
} Pwm_ChannelClassType;

typedef enum Pwm_epwmOutputCh
{
    EPWM_OUTPUT_CH_A  = 0U,
    EPWM_OUTPUT_CH_B  = 1U,
    EPWM_OUTPUT_CH_BOTH_A_AND_B = 2U
} Pwm_epwmOutputCh_t;

typedef void (*Pwm_NotifyFuncType)(void);
typedef struct
{
    Pwm_ChannelType      channelId;
#ifdef PWM_USE_EPWM
    uint32               outputCh;
#endif /* PWM_USE_EPWM*/
} Pwm_ChannelConfigType_PC;

typedef struct Pwm_ConfigType_PC_s
{
    Pwm_ChannelConfigType_PC chCfg[PWM_NUM_CHANNELS];
} Pwm_ConfigType_PC;


typedef struct
{
    uint32               instanceClkHz;
    uint16               dutyCycle;
    uint32               hwPeriod;
    Pwm_OutputStateType  polarity;
    Pwm_OutputStateType  idleState;
    Pwm_ChannelClassType channelClass;
    uint32               prescale;
#ifdef PWM_USE_EPWM
    uint32               hsPrescale;
    boolean             enableHR;
#endif /*PWM_USE_EPWM*/
#if (PWM_NOTIFICATION_SUPPORTED == STD_ON)
    Pwm_NotifyFuncType   notificationHandler;
#endif
} Pwm_ChannelConfigType;

/*
 * Design: MCAL-6885,MCAL-7533,MCAL-6799,MCAL-7535
 */
typedef struct Pwm_ConfigType_s
{
    Pwm_ChannelConfigType chCfg[PWM_NUM_CHANNELS];
} Pwm_ConfigType;

#if (STD_ON == PWM_REGISTER_READBACK_API)

typedef struct
{
#ifdef PWM_USE_GPT
    /*
     * GPT related registers
     */
    uint32 pwmRev;
    uint32 pwmTtgr;
    uint32 pwmTimerSynCtrl;
#endif
    /*
     * EPWM related registers
     */
#ifdef PWM_USE_EPWM
    uint16 pwmTbCtl;
    uint16 pwmTbPhs;
    uint16 pwmTbCnt;
    uint16 pwmAqCtlA;
    uint16 pwmAqCtlB;
    uint16 pwmDbCtl;
    uint16 pwmTzSel;
    uint16 pwmTzCtl;
    uint16 pwmPcCtl;
    uint16 pwmTbsts;
    uint16 pwmTbprd;
    uint16 pwmAqsfrc;
    uint16 pwmAqcsfrc;
    /* < Action Qualifier Continuous Software Force Register */
    uint16 pwmDbred;
    /* < Dead Band Generator Rising Edge Delay Count Register */
    uint16 pwmDbfed;
    /* < Dead Band Generator Falling Edge Delay Count Register */
    uint16 pwmEtsel;
    /* < Event Trigger Selection Registe */

#endif
} Pwm_RegisterReadbackType;


#endif  /* #if (STD_ON == PWM_REGISTER_READBACK_API) */

/* @} */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

FUNC(void, PWM_CODE) Pwm_Init(
        P2CONST(Pwm_ConfigType, AUTOMATIC, PWM_PBCFG) CfgPtr);

#if (STD_ON == PWM_DEINIT_API)

FUNC(void, PWM_CODE) Pwm_DeInit(void);
#endif

#if (STD_ON == PWM_SET_DUTY_CYCLE_API)

FUNC(void, PWM_CODE) Pwm_SetDutyCycle(
    Pwm_ChannelType ChannelNumber, uint16 DutyCycle);
#endif

#if (STD_ON == PWM_SET_PERIOD_AND_DUTY_API)

FUNC(void, PWM_CODE) Pwm_SetPeriodAndDuty(
    Pwm_ChannelType ChannelNumber, Pwm_PeriodType Period, uint16 DutyCycle);
#endif

#if (STD_ON == PWM_SET_OUTPUT_TO_IDLE_API)

FUNC(void, PWM_CODE) Pwm_SetOutputToIdle(Pwm_ChannelType ChannelNumber);
#endif

 /* Function not implmented due to hardware limitation
    Dummy Function*/
FUNC(Pwm_OutputStateType, PWM_CODE) Pwm_GetOutputState(
    Pwm_ChannelType ChannelNumber);


#if (STD_ON == PWM_NOTIFICATION_SUPPORTED)

FUNC(void, PWM_CODE) Pwm_DisableNotification(Pwm_ChannelType ChannelNumber);
#endif

#if (STD_ON == PWM_NOTIFICATION_SUPPORTED)

FUNC(void, PWM_CODE) Pwm_EnableNotification(
    Pwm_ChannelType ChannelNumber, Pwm_EdgeNotificationType Notification);
#endif

#if (STD_ON == PWM_VERSION_INFO_API)

FUNC(void, PWM_CODE) Pwm_GetVersionInfo(
    P2VAR(Std_VersionInfoType, AUTOMATIC, PWM_APPL_DATA) versioninfo);
#endif

#if(STD_ON == PWM_REGISTER_READBACK_API)

Std_ReturnType Pwm_RegisterReadback(
    Pwm_ChannelType ChannelNumber, Pwm_RegisterReadbackType *RegRbPtr);
#endif

#ifdef __cplusplus
}
#endif

#endif  /* #ifndef PWM_H_ */

/* @} */