| 1 |
582 |
jeremybenn |
/*
|
| 2 |
|
|
FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.
|
| 3 |
|
|
|
| 4 |
|
|
***************************************************************************
|
| 5 |
|
|
* *
|
| 6 |
|
|
* If you are: *
|
| 7 |
|
|
* *
|
| 8 |
|
|
* + New to FreeRTOS, *
|
| 9 |
|
|
* + Wanting to learn FreeRTOS or multitasking in general quickly *
|
| 10 |
|
|
* + Looking for basic training, *
|
| 11 |
|
|
* + Wanting to improve your FreeRTOS skills and productivity *
|
| 12 |
|
|
* *
|
| 13 |
|
|
* then take a look at the FreeRTOS books - available as PDF or paperback *
|
| 14 |
|
|
* *
|
| 15 |
|
|
* "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
|
| 16 |
|
|
* http://www.FreeRTOS.org/Documentation *
|
| 17 |
|
|
* *
|
| 18 |
|
|
* A pdf reference manual is also available. Both are usually delivered *
|
| 19 |
|
|
* to your inbox within 20 minutes to two hours when purchased between 8am *
|
| 20 |
|
|
* and 8pm GMT (although please allow up to 24 hours in case of *
|
| 21 |
|
|
* exceptional circumstances). Thank you for your support! *
|
| 22 |
|
|
* *
|
| 23 |
|
|
***************************************************************************
|
| 24 |
|
|
|
| 25 |
|
|
This file is part of the FreeRTOS distribution.
|
| 26 |
|
|
|
| 27 |
|
|
FreeRTOS is free software; you can redistribute it and/or modify it under
|
| 28 |
|
|
the terms of the GNU General Public License (version 2) as published by the
|
| 29 |
|
|
Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
|
| 30 |
|
|
***NOTE*** The exception to the GPL is included to allow you to distribute
|
| 31 |
|
|
a combined work that includes FreeRTOS without being obliged to provide the
|
| 32 |
|
|
source code for proprietary components outside of the FreeRTOS kernel.
|
| 33 |
|
|
FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
|
| 34 |
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
| 35 |
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
| 36 |
|
|
more details. You should have received a copy of the GNU General Public
|
| 37 |
|
|
License and the FreeRTOS license exception along with FreeRTOS; if not it
|
| 38 |
|
|
can be viewed here: http://www.freertos.org/a00114.html and also obtained
|
| 39 |
|
|
by writing to Richard Barry, contact details for whom are available on the
|
| 40 |
|
|
FreeRTOS WEB site.
|
| 41 |
|
|
|
| 42 |
|
|
1 tab == 4 spaces!
|
| 43 |
|
|
|
| 44 |
|
|
http://www.FreeRTOS.org - Documentation, latest information, license and
|
| 45 |
|
|
contact details.
|
| 46 |
|
|
|
| 47 |
|
|
http://www.SafeRTOS.com - A version that is certified for use in safety
|
| 48 |
|
|
critical systems.
|
| 49 |
|
|
|
| 50 |
|
|
http://www.OpenRTOS.com - Commercial support, development, porting,
|
| 51 |
|
|
licensing and training services.
|
| 52 |
|
|
*/
|
| 53 |
|
|
|
| 54 |
|
|
#ifndef STM_32_SERIAL_COMMS_H
|
| 55 |
|
|
#define STM_32_SERIAL_COMMS_H
|
| 56 |
|
|
|
| 57 |
|
|
/*
|
| 58 |
|
|
* Initialise a COM port. As supplied 2 COM ports are supported, so ulPort can
|
| 59 |
|
|
* be either 0 or 1. Note that COM 0 is in effect USART1 in ST library
|
| 60 |
|
|
* terminology. The baud rate can be any standard baud rate and has been tested
|
| 61 |
|
|
* up to 115200 baud.
|
| 62 |
|
|
*/
|
| 63 |
|
|
long lCOMPortInit( unsigned long ulPort, unsigned long ulWantedBaud );
|
| 64 |
|
|
|
| 65 |
|
|
/*
|
| 66 |
|
|
* Output a single char to a COM port. As supplied 2 COM ports are supported,
|
| 67 |
|
|
* so ulPort can be 0 or 1. Note that COM 0 is in effect USART1 in ST library
|
| 68 |
|
|
* terminology. cOutChar is the character to be transmit, and xBlockTime is
|
| 69 |
|
|
* the time the task should be held in the Blocked state (in ticks) for space
|
| 70 |
|
|
* to become available in the queue of characters waiting transmission. pdPASS
|
| 71 |
|
|
* will be returned if the character is successfully queued (possible after
|
| 72 |
|
|
* waiting in the Blocked state for up to xBlockTime ticks), otherwise pdFAIL
|
| 73 |
|
|
* will be returned.
|
| 74 |
|
|
*/
|
| 75 |
|
|
signed long xSerialPutChar( long lPort, signed char cOutChar, portTickType xBlockTime );
|
| 76 |
|
|
|
| 77 |
|
|
/*
|
| 78 |
|
|
* Retrieve a character from the queue of received characters. As supplied 2
|
| 79 |
|
|
* COM ports are supported, so ulPort can be 0 or 1. Note that COM 0 is in
|
| 80 |
|
|
* effect USART1 in ST library terminology. pcRxedChar is the address into
|
| 81 |
|
|
* which the received character will be copied, and xBlockTime is the time the
|
| 82 |
|
|
* task should be held in the Blocked state (in ticks) for a character to be
|
| 83 |
|
|
* available if one is not available immediately. pdPASS will be returned if a
|
| 84 |
|
|
* character is successfully returned (possible after waiting in the Blocked
|
| 85 |
|
|
* state for up to xBlockTime ticks), otherwise pdFAIL will be returned.
|
| 86 |
|
|
*/
|
| 87 |
|
|
signed long xSerialGetChar( long lPort, signed char *pcRxedChar, portTickType xBlockTime );
|
| 88 |
|
|
|
| 89 |
|
|
/*
|
| 90 |
|
|
* Send a string of characters to a COM port. As supplied 2 COM ports are
|
| 91 |
|
|
* supported, so ulPort can be 0 or 1. Note that COM 0 is in effect USART1 in
|
| 92 |
|
|
* ST library terminology. pcString contains the address of the first
|
| 93 |
|
|
* character to be transmit, and ulStringLength the total number of characters
|
| 94 |
|
|
* from and including *pcString. pdPASS will be returned if the entire string
|
| 95 |
|
|
* is queued for transmission successfully, otherwise pdFAIL will be returned.
|
| 96 |
|
|
* Note that serPUT_STRING_CHAR_DELAY within STM32_USART.c can be adjusted in
|
| 97 |
|
|
* accordance with the applications requirements. Comments are included where
|
| 98 |
|
|
* serPUT_STRING_CHAR_DELAY is defined.
|
| 99 |
|
|
*/
|
| 100 |
|
|
long lSerialPutString( long lPort, const char * const pcString, unsigned long ulStringLength );
|
| 101 |
|
|
|
| 102 |
|
|
#endif
|
| 103 |
|
|
|
| 104 |
|
|
|
