CF2 API Reference (PDF) - Persistor Instruments Inc

CF2 API ReferenceSCIRxTxIdle -- Return true if all Rx and Tx flags indicate idleDescription:Prototype:Returns:Notes:Return TRUE if all Rx and Tx flags indicate idlebool SCIRxTxIdle(void);Returns a boolean that is TRUE if both the transmit and receive sections of the UART are idleand both queues are empty.This could be used to determine if the UART is ready to be shut down.SCITxBreak -- Start (-1) , stop (0) , or send timed break (+ val)Description:Prototype:Inputs:Sets the UART to transmit a break condition for the specified duration or to start or stop anindefinite break.void SCITxBreak(short millisecs)millisecs is the duration of the desired break in milliseconds. If it is -1 it will start an indefinitebreak and return, if it is 0 it will stop an indefinite break and return.SCITxFlush -- Delete any data in the transmit queueDescription:Prototype:Notes:Empties the transmit buffer and throws away any data not yet transmitted out the UART.void SCITxFlush(void);See STDIO Warning.SCITxHandshake -- Set transmit flow controlDescription:Prototype:Inputs:Notes:Set transmit flow controlvoid SCITxHandshake(short hshk, char xon, char xoff)hshk is the enumerated handshake selector (hshkOff by default)xon is the character sent to the CF2 to resume transmission (CTRL-Q by default).xoff is the character sent to the CF2 to pause transmission (CTRL-S by default)Flow control can be OFF (hshkOff), ON using the auxiliary RS-232 control signals (hshkCtsRts),or ON using definable XON/XOFF characters. Flow control is only supported when the input oroutput drivers are working in buffered (interrupt driven) modes.The BIOS SCI functions provide both hardware and software flow control options for both inputand output operations with the setup functions SCIRxHandshake() and SCITxHandshake() andthree enumerated setup constants.Output flow control, when enabled, lets the connected serial receiving device tell the CF2 to stopsending data when the receiver's senses it is near overflow. For hardware flow control, the stopmechanism is the detection of a negated RSRXX signal (EIA negative). For software flow control,the stop mechanism is the receipt of an an XOFF character, which can be user defined, but istypically a control-S (0x13) character.The CF2 resumes transmitting when the receiving device tells the CF2 it's ok to resume sendingdata. For hardware flow control, the resume mechanism is the detection by the CF2 of anasserted RSRXX signal (EIA positive). For software flow control, the resume mechanism is thereceipt by the CF2 of an XON character, which can be user defined, but is typically a control-Q(0x11) character.PERSISTORInstruments Inc.57 of 84CF2 API Reference7/19/2005