User`s manual

RX62N Group, RX621 Group 4. Library Reference
4.2. Description of Each API
This section describes each API and explains how to use them, showing a program example for each. The
description of each API is divided into the following items.
Synopsis
Summarises processing by the API function.
Prototype
The function format and a brief explanation of the arguments.
Description
Explains how to use the API function and shows assignable parameters separating
each argument with [argument].
Return value
Describes the returned value of the API function.
Category
Indicates the category of the API function.
Reference
Indicates the API functions to be referred.
Remark
Describes notes to use the API function.
Program example
Represents how to use the API function by a program example.
Two examples of return value checking are shown below.
/* RPDL definitions */
#include "r_pdl_pfc.h"
#include "r_pdl_sci.h"
/* RPDL device-specific definitions */
#include "r_pdl_definitions.h"
void func( void )
{
bool result;
/* Write 0xFF to register PFC1 */
result = (R_PFC_Write(
1,
0xFF
);
if (result == false)
{
/* Handle the error here */
}
/* Keep trying to send a string (if the channel is busy) */
do
{
result = R_SCI_Send(
2,
"Renesas RX",
NULL,
PDL_NO_FUNC
);
} while (result == false);
)
For clarity, the return value is not checked in the examples used in this manual.
The RPDL API is implemented using function macros. To avoid the possibility of parameters being evaluated
more than once do not use operators or function calls within the RPDL API parameter list.
R20UT0084EE0112 Rev.1.12 Page 4-4
July. 16, 2014