Renesas Embedded Application Programming Interface, Reference Manual

Page: 137 / 204

Rev.1.01 2007.02.16
RJJ10J1643-0101
135
__DestroyOutputCompare
Synopsis
<Discard settings of output compare mode>
Boolean __DestroyOutputCompare(unsigned long data)
data Setup data (content differs with MCU type)
Description
Discards settings of the timer that is set to specified output compare mode.
[data]
For data, the following definition values can be set.
(M16C)
RAPI_TIMER_S Selects timer S.
(R8C)
RAPI_TIMER_C Selects timer C.
RAPI_TIMER_RD0 Selects timer RD channel 0.
RAPI_TIMER_RD1 Selects timer RD channel 1.
RAPI_TIMER_RE Selects timer RE.
(H8/300H)
RAPI_TIMER_W Selects timer W.
RAPI_TIMER_Z0 Selects timer Z channel 0.
RAPI_TIMER_Z1 Selects timer Z channel 1.
RAPI_TIMER_RC Selects timer RD0.
RAPI_TIMER_RD0 Selects timer RD0 channe 0.
RAPI_TIMER_RD1 Selects timer RD0 channe 1.
RAPI_TIMER_RD2 Selects timer RD0 channe 2.
RAPI_TIMER_RD3 Selects timer RD0 channe 3.
Return value
If the timer specification is incorrect, RAPI_FALSE is returned; otherwise, RAPI_TRUE
is returned.
Functionality
Timer (output compare mode)
Reference
__CreateOutputCompare , __EnableOutputCompare
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 timer into module stanby
state after discarding it.
Program example
#include "rapi_timer_r8c_13.h"