Renesas Embedded Application Programming Interface, Reference Manual

Page: 39 / 204

Rev.1.01 2007.02.16
RJJ10J1643-0101
37
__CloseSerialDriver
Synopsis
<Close a serial port>
Boolean __CloseSerialDriver(unsigned long data)
data Setup data
Description
Closes a specified serial port.
[data]
For data, the following values can be set.
(M16C)
RAPI_COM1 UART0 RAPI_COM2 UART1
RAPI_COM3 UART2 RAPI_COM4 SI/O3
RAPI_COM5 SI/O4
(R8C)
RAPI_COM1 UART0 RAPI_COM2 UART1
(H8/300H)
RAPI_COM1 SCI3 channel 1 RAPI_COM2 SCI3 channel 2
SIO3_COM3 SIO3 channel 3
Return value
If the serial port specification is incorrect, RAPI_FALSE is returned; otherwise,
RAPI_TRUE is returned.
Functionality
Serial I/O
Reference
__OpenSerialDriver
Remark
•
The specifiable serial ports differ with each CPU used.
•
If an undefined value is specified in the argument, operation of the API cannot be
guaranteed.
•
When used for the H8/300H, this API places a specified serial port into module
standby state after closing it.
Program example
#include ”rapi_sif_r8c_13.h”
void func( void )
{
………………
/* Close serial driver */
return __CloseSerialDriver( RAPI_COM1 );
………………
}