]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_STM32F103_GCC_Rowley/Drivers/STM32_USART.h
Update version number to 8.1.2 after moving the defaulting of configUSE_PORT_OPTIMISE...
[freertos] / FreeRTOS / Demo / CORTEX_STM32F103_GCC_Rowley / Drivers / STM32_USART.h
1 /*\r
2     FreeRTOS V8.1.2 - Copyright (C) 2014 Real Time Engineers Ltd. \r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS provides completely free yet professionally developed,    *\r
10      *    robust, strictly quality controlled, supported, and cross          *\r
11      *    platform software that has become a de facto standard.             *\r
12      *                                                                       *\r
13      *    Help yourself get started quickly and support the FreeRTOS         *\r
14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
16      *                                                                       *\r
17      *    Thank you!                                                         *\r
18      *                                                                       *\r
19     ***************************************************************************\r
20 \r
21     This file is part of the FreeRTOS distribution.\r
22 \r
23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
24     the terms of the GNU General Public License (version 2) as published by the\r
25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
26 \r
27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
29     >>!   obliged to provide the source code for proprietary components     !<<\r
30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
31 \r
32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
35     link: http://www.freertos.org/a00114.html\r
36 \r
37     1 tab == 4 spaces!\r
38 \r
39     ***************************************************************************\r
40      *                                                                       *\r
41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
42      *    not run, what could be wrong?"                                     *\r
43      *                                                                       *\r
44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
45      *                                                                       *\r
46     ***************************************************************************\r
47 \r
48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
49     license and Real Time Engineers Ltd. contact details.\r
50 \r
51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
54 \r
55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
57     licenses offer ticketed support, indemnification and middleware.\r
58 \r
59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
60     engineered and independently SIL3 certified version for use in safety and\r
61     mission critical applications that require provable dependability.\r
62 \r
63     1 tab == 4 spaces!\r
64 */\r
65 \r
66 #ifndef STM_32_SERIAL_COMMS_H\r
67 #define STM_32_SERIAL_COMMS_H\r
68 \r
69 /*\r
70  * Initialise a COM port.  As supplied 2 COM ports are supported, so ulPort can\r
71  * be either 0 or 1.  Note that COM 0 is in effect USART1 in ST library \r
72  * terminology.  The baud rate can be any standard baud rate and has been tested\r
73  * up to 115200 baud.\r
74  */\r
75 long lCOMPortInit( unsigned long ulPort, unsigned long ulWantedBaud );\r
76 \r
77 /*\r
78  * Output a single char to a COM port.  As supplied 2 COM ports are supported,\r
79  * so ulPort can be 0 or 1.  Note that COM 0 is in effect USART1 in ST library\r
80  * terminology.  cOutChar is the character to be transmit, and xBlockTime is\r
81  * the time the task should be held in the Blocked state (in ticks) for space \r
82  * to become available in the queue of characters waiting transmission.  pdPASS \r
83  * will be returned if the character is successfully queued (possible after \r
84  * waiting in the Blocked state for up to xBlockTime ticks), otherwise pdFAIL \r
85  * will be returned.\r
86  */\r
87 signed long xSerialPutChar( long lPort, signed char cOutChar, TickType_t xBlockTime );\r
88 \r
89 /*\r
90  * Retrieve a character from the queue of received characters.  As supplied 2 \r
91  * COM ports are supported, so ulPort can be 0 or 1.  Note that COM 0 is in \r
92  * effect USART1 in ST library terminology.  pcRxedChar is the address into\r
93  * which the received character will be copied, and xBlockTime is the time the \r
94  * task should be held in the Blocked state (in ticks) for a character to be\r
95  * available if one is not available immediately.  pdPASS will be returned if a\r
96  * character is successfully returned (possible after waiting in the Blocked \r
97  * state for up to xBlockTime ticks), otherwise pdFAIL will be returned.\r
98  */\r
99 signed long xSerialGetChar( long lPort, signed char *pcRxedChar, TickType_t xBlockTime );\r
100 \r
101 /*\r
102  * Send a string of characters to a COM port.  As supplied 2 COM ports are \r
103  * supported, so ulPort can be 0 or 1.  Note that COM 0 is in effect USART1 in \r
104  * ST library terminology.  pcString contains the address of the first \r
105  * character to be transmit, and ulStringLength the total number of characters\r
106  * from and including *pcString.  pdPASS will be returned if the entire string\r
107  * is queued for transmission successfully, otherwise pdFAIL will be returned.\r
108  * Note that serPUT_STRING_CHAR_DELAY within STM32_USART.c can be adjusted in\r
109  * accordance with the applications requirements.  Comments are included where\r
110  * serPUT_STRING_CHAR_DELAY is defined.\r
111  */\r
112 long lSerialPutString( long lPort, const char * const pcString, unsigned long ulStringLength );\r
113 \r
114 #endif\r
115 \r
116 \r