iLLD_TC27xD  1.0
IfxStdIf_PwmHl.h File Reference

Standard interface: Multi-channels, dual-complementary PWM interface. More...

#include "IfxStdIf.h"
#include "IfxStdIf_Timer.h"

Go to the source code of this file.

Data Structures

struct  IfxStdIf_PwmHl_
 Standard interface object. More...
 
struct  IfxStdIf_PwmHl_Config
 Multi-channels PWM object configuration. More...
 

Typedefs

typedef struct IfxStdIf_PwmHl_ IfxStdIf_PwmHl
 Forward declaration. More...
 
typedef boolean(* IfxStdIf_PwmHl_SetDeadtime )(IfxStdIf_InterfaceDriver driver, float32 deadtime)
 Set the dead time in s. More...
 
typedef float32(* IfxStdIf_PwmHl_GetDeadtime )(IfxStdIf_InterfaceDriver driver)
 Return the dead time in s. More...
 
typedef boolean(* IfxStdIf_PwmHl_SetMinPulse )(IfxStdIf_InterfaceDriver driver, float32 minPulse)
 Set the minimum pulse time in s. More...
 
typedef float32(* IfxStdIf_PwmHl_GetMinPulse )(IfxStdIf_InterfaceDriver driver)
 Return the minimum pulse time in s. More...
 
typedef Ifx_Pwm_Mode(* IfxStdIf_PwmHl_GetMode )(IfxStdIf_InterfaceDriver driver)
 Return the PWM mode. More...
 
typedef boolean(* IfxStdIf_PwmHl_SetMode )(IfxStdIf_InterfaceDriver driver, Ifx_Pwm_Mode mode)
 Set the pwm mode. More...
 
typedef void(* IfxStdIf_PwmHl_SetOnTime )(IfxStdIf_InterfaceDriver driver, Ifx_TimerValue *tOn)
 Set the pwm ON time. More...
 
typedef void(* IfxStdIf_PwmHl_SetupChannels )(IfxStdIf_InterfaceDriver driver, boolean *activeCh, boolean *stuckSt)
 Set channels which are generating PWM or in "stuck-at" state. More...
 

Functions

IFX_INLINE boolean IfxStdIf_PwmHl_setDeadtime (IfxStdIf_PwmHl *stdIf, float32 deadtime)
 Set the dead time in s. More...
 
IFX_INLINE float32 IfxStdIf_PwmHl_getDeadtime (IfxStdIf_PwmHl *stdIf)
 Return the dead time in s. More...
 
IFX_INLINE boolean IfxStdIf_PwmHl_setMinPulse (IfxStdIf_PwmHl *stdIf, float32 minPulse)
 Set the minimum pulse time in s. More...
 
IFX_INLINE float32 IfxStdIf_PwmHl_getMinPulse (IfxStdIf_PwmHl *stdIf)
 Return the minimum pulse time in s. More...
 
IFX_INLINE Ifx_Pwm_Mode IfxStdIf_PwmHl_getMode (IfxStdIf_PwmHl *stdIf)
 Return the PWM mode. More...
 
IFX_INLINE boolean IfxStdIf_PwmHl_setMode (IfxStdIf_PwmHl *stdIf, Ifx_Pwm_Mode mode)
 Set the pwm mode. More...
 
IFX_INLINE void IfxStdIf_PwmHl_setOnTime (IfxStdIf_PwmHl *stdIf, Ifx_TimerValue *tOn)
 Set the pwm ON time. More...
 
IFX_INLINE void IfxStdIf_PwmHl_setupChannels (IfxStdIf_PwmHl *driver, boolean *activeCh, boolean *stuckSt)
 Set channels which are generating PWM or in "stuck-at" state. More...
 
IFX_INLINE IfxStdIf_TimerIfxStdIf_PwmHl_getTimer (IfxStdIf_PwmHl *stdIf)
 Return the timer standard interface used by the IfxStdIf_PwmHl standard interface. More...
 
IFX_EXTERN void IfxStdIf_PwmHl_initConfig (IfxStdIf_PwmHl_Config *config)
 

Detailed Description

Standard interface: Multi-channels, dual-complementary PWM interface.

Version
iLLD_1_0_0_11_0
                            IMPORTANT NOTICE

Infineon Technologies AG (Infineon) is supplying this file for use exclusively with Infineon's microcontroller products. This file can be freely distributed within development tools that are supporting such microcontroller products.

THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. INFINEON SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

Definition in file IfxStdIf_PwmHl.h.


Data Structure Documentation

struct IfxStdIf_PwmHl_

Standard interface object.

Definition at line 139 of file IfxStdIf_PwmHl.h.

Collaboration diagram for IfxStdIf_PwmHl_:
Data Fields
IfxStdIf_InterfaceDriver driver Interface driver object.
IfxStdIf_PwmHl_GetDeadtime getDeadtime IfxStdIf_PwmHl_GetDeadtime.
IfxStdIf_PwmHl_GetMinPulse getMinPulse IfxStdIf_PwmHl_GetMinPulse.
IfxStdIf_PwmHl_GetMode getMode IfxStdIf_PwmHl_GetMode.
IfxStdIf_PwmHl_SetDeadtime setDeadtime IfxStdIf_PwmHl_SetDeadtime.
IfxStdIf_PwmHl_SetMinPulse setMinPulse IfxStdIf_PwmHl_SetMinPulse.
IfxStdIf_PwmHl_SetMode setMode IfxStdIf_PwmHl_SetMode.
IfxStdIf_PwmHl_SetOnTime setOnTime IfxStdIf_PwmHl_SetOnTime.
IfxStdIf_PwmHl_SetupChannels setupChannels IfxStdIf_PwmHl_SetupChannels.
IfxStdIf_Timer timer Timer related standard interface.
struct IfxStdIf_PwmHl_Config

Multi-channels PWM object configuration.

Definition at line 157 of file IfxStdIf_PwmHl.h.

Data Fields
Ifx_ActiveState ccxActiveState Top PWM active state.
uint8 channelCount Number of PWM channels, one channel is made of a top and bottom channel.
Ifx_ActiveState coutxActiveState Bottom PWM active state.
float32 deadtime Dead time between the top and bottom channels in seconds.
boolean emergencyEnabled Specifies if the emergency stop should be enabled or not.
float32 minPulse Min pulse allowed as active state for the top and bottom PWM in seconds.
IfxPort_PadDriver outputDriver Output pad driver of ccx and coutx pins.
IfxPort_OutputMode outputMode Output mode of ccx and coutx pins.

Typedef Documentation

Forward declaration.

Definition at line 61 of file IfxStdIf_PwmHl.h.

typedef float32(* IfxStdIf_PwmHl_GetDeadtime)(IfxStdIf_InterfaceDriver driver)

Return the dead time in s.

It returns the last dead time values set by IfxStdIf_PwmHl_SetDeadtime() or during initialisation

Parameters
driverPointer to the interface driver object
Returns
Returns the deadtime in second

Definition at line 77 of file IfxStdIf_PwmHl.h.

typedef float32(* IfxStdIf_PwmHl_GetMinPulse)(IfxStdIf_InterfaceDriver driver)

Return the minimum pulse time in s.

It returns the last minimum pulse time values set by IfxStdIf_PwmHl_SetMinPulse() or during initialisation

Parameters
driverPointer to the interface driver object
Returns
Returns the minimum pulse time in second

Definition at line 93 of file IfxStdIf_PwmHl.h.

typedef Ifx_Pwm_Mode(* IfxStdIf_PwmHl_GetMode)(IfxStdIf_InterfaceDriver driver)

Return the PWM mode.

It returns the last pwm mode set by IfxStdIf_PwmHl_SetMode() or during initialisation

Parameters
driverPointer to the interface driver object
Returns
Returns the pwm mode

Definition at line 101 of file IfxStdIf_PwmHl.h.

typedef boolean(* IfxStdIf_PwmHl_SetDeadtime)(IfxStdIf_InterfaceDriver driver, float32 deadtime)

Set the dead time in s.

Parameters
driverPointer to the interface driver object
deadtimedeadtime in second
Return values
TRUEIn case of success
FALSEIn case of failure

Definition at line 69 of file IfxStdIf_PwmHl.h.

typedef boolean(* IfxStdIf_PwmHl_SetMinPulse)(IfxStdIf_InterfaceDriver driver, float32 minPulse)

Set the minimum pulse time in s.

Parameters
driverPointer to the interface driver object
minPulseminimal pulse in second
Return values
TRUEIn case of success
FALSEIn case of failure

Definition at line 85 of file IfxStdIf_PwmHl.h.

typedef boolean(* IfxStdIf_PwmHl_SetMode)(IfxStdIf_InterfaceDriver driver, Ifx_Pwm_Mode mode)

Set the pwm mode.

Parameters
driverPointer to the interface driver object
modePWM mode
Return values
TRUEIn case of success
FALSEIn case of failure (feature not supported)

Definition at line 109 of file IfxStdIf_PwmHl.h.

typedef void(* IfxStdIf_PwmHl_SetOnTime)(IfxStdIf_InterfaceDriver driver, Ifx_TimerValue *tOn)

Set the pwm ON time.

Parameters
driverPointer to the interface driver object
tOnPointer to an array of ON times in ticks. The array size must be equal to the number of PWM channels
Returns
none

Definition at line 116 of file IfxStdIf_PwmHl.h.

typedef void(* IfxStdIf_PwmHl_SetupChannels)(IfxStdIf_InterfaceDriver driver, boolean *activeCh, boolean *stuckSt)

Set channels which are generating PWM or in "stuck-at" state.

Parameters
driverPointer to the interface driver object
activeChPointer to boolean array containing values for PWM channels. If FALSE, the channel will be in stuck-at state, else the channel will generate PWM.
stuckStPointer to boolean array containing values for active channels. If FALSE, the stuck-at state is passive level, else the stuck-at state is active level.
Note
The values for the parameters are arranged as follows: index = 0 –> phase 0 top index = 1 –> phase 0 bottom index = 2 –> phase 1 top index = 3 –> phase 1 bottom index = 4 –> phase 2 top index = 5 –> phase 2 bottom

Definition at line 135 of file IfxStdIf_PwmHl.h.

Function Documentation

IFX_EXTERN void IfxStdIf_PwmHl_initConfig ( IfxStdIf_PwmHl_Config config)

Initialize the configuration structure to default

Parameters
configTimer configuration. This parameter is initialised by the function

Definition at line 28 of file IfxStdIf_PwmHl.c.

Referenced by IfxCcu6_PwmHl_initConfig(), IfxGtm_Atom_PwmHl_initConfig(), and IfxGtm_Tom_PwmHl_initConfig().