/* | |
FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd. | |
*************************************************************************** | |
* * | |
* If you are: * | |
* * | |
* + New to FreeRTOS, * | |
* + Wanting to learn FreeRTOS or multitasking in general quickly * | |
* + Looking for basic training, * | |
* + Wanting to improve your FreeRTOS skills and productivity * | |
* * | |
* then take a look at the FreeRTOS books - available as PDF or paperback * | |
* * | |
* "Using the FreeRTOS Real Time Kernel - a Practical Guide" * | |
* http://www.FreeRTOS.org/Documentation * | |
* * | |
* A pdf reference manual is also available. Both are usually delivered * | |
* to your inbox within 20 minutes to two hours when purchased between 8am * | |
* and 8pm GMT (although please allow up to 24 hours in case of * | |
* exceptional circumstances). Thank you for your support! * | |
* * | |
*************************************************************************** | |
This file is part of the FreeRTOS distribution. | |
FreeRTOS is free software; you can redistribute it and/or modify it under | |
the terms of the GNU General Public License (version 2) as published by the | |
Free Software Foundation AND MODIFIED BY the FreeRTOS exception. | |
***NOTE*** The exception to the GPL is included to allow you to distribute | |
a combined work that includes FreeRTOS without being obliged to provide the | |
source code for proprietary components outside of the FreeRTOS kernel. | |
FreeRTOS is distributed in the hope that it will be useful, but WITHOUT | |
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
more details. You should have received a copy of the GNU General Public | |
License and the FreeRTOS license exception along with FreeRTOS; if not it | |
can be viewed here: http://www.freertos.org/a00114.html and also obtained | |
by writing to Richard Barry, contact details for whom are available on the | |
FreeRTOS WEB site. | |
1 tab == 4 spaces! | |
http://www.FreeRTOS.org - Documentation, latest information, license and | |
contact details. | |
http://www.SafeRTOS.com - A version that is certified for use in safety | |
critical systems. | |
http://www.OpenRTOS.com - Commercial support, development, porting, | |
licensing and training services. | |
*/ | |
#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 | |