PWMOut.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  PWM Output
 *
 *  Use the function GetPWMOut() to get a handle to pass on to the other functions.
 *  Use the method PWMOut_release(PWMOUTHANDLE) to release the handle.
 *
 *  Note: The rise and fall times of the hardware limits the signal's usefulness in high frequencies.
 *  The duty cycle of the PWM signal affects the maximum attainable frequency: at 50% duty cycle, the attainable
 *  frequecy is at it's maximum. If the duty cycle is near 0 or 100%, the rise/fall times of the signal means that the
 *  maximum attainable frequency is significantly lower. A PWM signal is generated when both the frequency and the duty
 *  cycle of a channel is not zero.
 *
 *  Example Usage:
 *  @include pwmout_example.cpp
 *
 ************************************************/
#ifndef CC_PWMOUT_H
#define CC_PWMOUT_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *PWMOUTHANDLE;
 
EXTERN_C
CCAUXDLL_API
PWMOUTHANDLE
CCAUXDLL_CALLING_CONV
GetPWMOut(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV PWMOut_release(PWMOUTHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_setPWMOutputChannelDutyCycle(PWMOUTHANDLE, uint8_t channel, uint16_t duty_cycle);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_setPWMOutputChannelFrequency(PWMOUTHANDLE, uint8_t channel, float32_t frequency);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getPWMOutputChannelDutyCycle(PWMOUTHANDLE, uint8_t channel, uint16_t *duty_cycle);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getPWMOutputChannelFrequency(PWMOUTHANDLE, uint8_t channel, float32_t *frequency);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getPWMOutputStatus(PWMOUTHANDLE, uint16_t *status);
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getPWMOutputStatus2(PWMOUTHANDLE, uint8_t channel, uint16_t *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_setPWMOutOff(PWMOUTHANDLE, uint8_t channel);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getActiveIomcu(PWMOUTHANDLE, uint8_t *ioindex);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_setActiveIomcu(PWMOUTHANDLE, uint8_t ioindex);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_getPWMOutputPU(PWMOUTHANDLE, uint8_t channel, uint16_t *status);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV PWMOut_setPWMOutputPU(PWMOUTHANDLE, uint8_t channel, uint16_t status);
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_PWMOUT_H */