Continue development of STM32 Rowley demo.

This commit is contained in:
Richard Barry 2010-07-07 11:48:04 +00:00
parent 28b5ea32a4
commit 65d501d718
3 changed files with 57 additions and 10 deletions

View file

@ -54,10 +54,51 @@
#ifndef STM_32_SERIAL_COMMS_H
#define STM_32_SERIAL_COMMS_H
/*
* Initialise a COM port. As supplied 2 COM ports are supported, so ulPort can
* be either 0 or 1. Note that COM 0 is in effect USART1 in ST library
* terminology. The baud rate can be any standard baud rate and has been tested
* up to 115200 baud.
*/
long lCOMPortInit( unsigned long ulPort, unsigned long ulWantedBaud );
/*
* Output a single char to a COM port. As supplied 2 COM ports are supported,
* so ulPort can be 0 or 1. Note that COM 0 is in effect USART1 in ST library
* terminology. cOutChar is the character to be transmit, and xBlockTime is
* the time the task should be held in the Blocked state (in ticks) for space
* to become available in the queue of characters waiting transmission. pdPASS
* will be returned if the character is successfully queued (possible after
* waiting in the Blocked state for up to xBlockTime ticks), otherwise pdFAIL
* will be returned.
*/
signed long xSerialPutChar( long lPort, signed char cOutChar, portTickType xBlockTime );
/*
* Retrieve a character from the queue of received characters. As supplied 2
* COM ports are supported, so ulPort can be 0 or 1. Note that COM 0 is in
* effect USART1 in ST library terminology. pcRxedChar is the address into
* which the received character will be copied, and xBlockTime is the time the
* task should be held in the Blocked state (in ticks) for a character to be
* available if one is not available immediately. pdPASS will be returned if a
* character is successfully returned (possible after waiting in the Blocked
* state for up to xBlockTime ticks), otherwise pdFAIL will be returned.
*/
signed long xSerialGetChar( long lPort, signed char *pcRxedChar, portTickType xBlockTime );
/*
* Send a string of characters to a COM port. As supplied 2 COM ports are
* supported, so ulPort can be 0 or 1. Note that COM 0 is in effect USART1 in
* ST library terminology. pcString contains the address of the first
* character to be transmit, and ulStringLength the total number of characters
* from and including *pcString. pdPASS will be returned if the entire string
* is queued for transmission successfully, otherwise pdFAIL will be returned.
* Note that serPUT_STRING_CHAR_DELAY within STM32_USART.c can be adjusted in
* accordance with the applications requirements. Comments are included where
* serPUT_STRING_CHAR_DELAY is defined.
*/
long lSerialPutString( long lPort, const char * const pcString, unsigned long ulStringLength );
#endif