Api Specification - Freescale Semiconductor DSP56800E User Manual

Table 5-532. Buffer Space Monitoring Configuration Items
SYMBOL
SCI_ x _RX_BUFFER_PTR
SCI_ x _RX_BUFFER_SIZE
SCI_ x _RX_BUFFER_LOWLIMIT
SCI_ x _RX_BUFFER_OKLIMIT
SCI_ x _RX_XONXOFF
SCI_ x _XONCHAR
SCI_ x _XOFFCHAR
5.15.2.3

API Specification

This section specifies the exact usage for each API function.
Function arguments for each routine are described as in, out, or inout.
1. in argument means that the parameter value is an input only to the function.
2. out argument means that the parameter value is an output only from the function.
3. inout argument means that a parameter value is an input to the function, but the same
parameter is also an output from the function.
Note: inout parameters are typically input pointer variables in which the caller passes the address
of a pre-allocated data structure to a function. The function stores its results within that data
structure. The actual value of the inout pointer parameter is not changed.
5-648
TYPE
/ VALUE
pointer to array of
SCI0CHAR or
SCI1CHAR elements
UWord16
UWord16
UWord16
n/a
UWord8
UWord8
Targeting 56F8xxx Platform
DESCRIPTION
The buffer which will be used as internal circular
buffer for BUFFERED operation. When not
defined, the buffer is allocated as static array
directly by the driver.
The size of the buffer to allocate or specified by
SCI_x_RX_BUFFER_PTR.
When the free space in the buffer sinks bellow
this number, the buffer-low events are triggered.
When the free space in the buffer grows above
this number, the buffer-ok events are triggered.
When not defined, the value equal to
SCI_x_RX_BUFFER_LOWLIMIT is taken.
When defined, it must be equal or greater than
SCI_x_RX_BUFFER_LOWLIMIT.
When defined, the software XON/XOFF protocol
is enabled on this (slave) side. The buffer limit
values must be defined to enable XON/XOFF
protocol.
The value of XON character. When not defined,
the standard 0x11 is used.
The value of XOFF character. When not defined,
the standard 0x13 is used.
FREESCALE SEMICONDUCTOR