Rev.1.01 2007.02.16
RJJ10J1643-0101
82
__DestroyPulseWidthModulationMode
Synopsis <Discard settings of pulse width modulation mode>
Boolean __DestroyPulseWidthModulationMode(unsigned long data)
data Setup data (content differs with MCU type)
Description Discards settings of the timer that is set to specified pulse width modulation mode.
[data]
For data, the following definition values can be set.
(M16C)
RAPI_TIMER_A0 Selects timer A channel 0.
RAPI_TIMER_A1 Selects timer A channel 1.
RAPI_TIMER_A2 Selects timer A channel 2.
RAPI_TIMER_A3 Selects timer A channel 3.
RAPI_TIMER_A4 Selects timer A channel 4.
(R8C)
RAPI_TIMER_Y Selects timer Y.
RAPI_TIMER_Z Selects timer Z.
RAPI_TIMER_RB Selects timer RB.
(H8/300H)
RAPI_TIMER_V Selects timer V.
Return value
If the timer specification is incorrect, RAPI_FALSE is returned; otherwise, RAPI_TRUE
is returned.
Functionality Timer (pulse width modulation mode (PWM mode))
Reference __CreatePulseWidthModulationMode, __EnablePulseWidthModulationMode
Remark
If an undefined value is specified in the argument, operation of the API cannot be
guaranteed.
The specifiable timers differ with each CPU used.
When used for the H8/300H, this API places a specified ti mer into module stanby
state after discarding it.
Program example
#include "rapi_timer_r8c_13.h"
void func( void )
{
/* Destroy the setting of timer Z as pulse width modulation mode */
__DestroyPulseWidthModulationMode( RAPI_TIMER_Z );
}