sccp3.h File Reference

This is the generated driver header file for the SCCP3 driver. More...

#include <stddef.h>
#include "pwm_interface.h"
#include "pwm_types.h"

Include dependency graph for sccp3.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	FAN_PWM_Initialize   SCCP3_PWM_Initialize
	This macro defines the Custom Name for SCCP3_PWM_Initialize API.
#define	FAN_PWM_Deinitialize   SCCP3_PWM_Deinitialize
	This macro defines the Custom Name for SCCP3_PWM_Deinitialize API.
#define	FAN_PWM_Enable   SCCP3_PWM_Enable
	This macro defines the Custom Name for SCCP3_PWM_Enable API.
#define	FAN_PWM_Disable   SCCP3_PWM_Disable
	This macro defines the Custom Name for SCCP3_PWM_Disable API.
#define	FAN_PWM_PeriodSet   SCCP3_PWM_PeriodSet
	This macro defines the Custom Name for SCCP3_PWM_PeriodSet API.
#define	FAN_PWM_DutyCycleSet   SCCP3_PWM_DutyCycleSet
	This macro defines the Custom Name for SCCP3_PWM_DutyCycleSet API.
#define	FAN_PWM_DeadTimeSet   SCCP3_PWM_DeadTimeSet
	This macro defines the Custom Name for SCCP3_PWM_DeadTimeSet API.
#define	FAN_PWM_OutputModeSet   SCCP3_PWM_OutputModeSet
	This macro defines the Custom Name for SCCP3_PWM_OutputModeSet API.
#define	FAN_PWM_SoftwareTriggerSet   SCCP3_PWM_SoftwareTriggerSet
	This macro defines the Custom Name for SCCP3_PWM_SoftwareTriggerSet API.
#define	FAN_PWM_Tasks   SCCP3_PWM_Tasks
	This macro defines the Custom Name for SCCP3_PWM_Tasks API.
#define	FAN_PWM_PWM_CallbackRegister   SCCP3_PWM_CallbackRegister
	This macro defines the Custom Name for SCCP3_PWM_CallbackRegister API.

Functions
void	SCCP3_PWM_Initialize (void)
	Initializes the SCCP3 Pulse driver. This function must be called before any other SCCP3 function is called.
void	SCCP3_PWM_Deinitialize (void)
	Deinitializes the SCCP3 to POR values.
void	SCCP3_PWM_Enable (void)
	Enables the SCCP3 module.
void	SCCP3_PWM_Disable (void)
	Disables the SCCP3 module.
void	SCCP3_PWM_PeriodSet (size_t periodCount)
	Sets the cycle width.
void	SCCP3_PWM_DutyCycleSet (size_t dutyCycleCount)
	Sets the ON pulse width.
void	SCCP3_PWM_SoftwareTriggerSet (void)
	This function sets the manual trigger.
void	SCCP3_PWM_CallbackRegister (void(*handler)(void))
	This function can be used to override default callback and to define custom callback for SCCP3 PWM event.
void	SCCP3_PWM_Callback (void)
	This is the default callback with weak attribute. The user can override and implement the default callback without weak attribute or can register a custom callback function using SCCP3_PWM_CallbackRegister.
void	SCCP3_PWM_Tasks (void)
	This function is used to implement the tasks for polled implementations.

Variables
const struct PWM_INTERFACE	FAN_PWM
	Structure object of type PWM_INTERFACE with the custom name given by the user in the Melody Driver User interface. The default name e.g. PWM1 can be changed by the user in the MCCP user interface. This allows defining a structure with application specific name using the 'Custom Name' field. Application specific name allows the API Portability.

Detailed Description

SCCP3 Generated Driver Header File

Definition in file sccp3.h.