2 FreeRTOS V9.0.0rc1 - Copyright (C) 2016 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /* Standard includes. */
\r
74 /* FreeRTOS includes. */
\r
75 #include "FreeRTOS.h"
\r
78 /* FreeRTOS+CLI includes. */
\r
79 #include "FreeRTOS_CLI.h"
\r
81 /* FreeRTOS+UDP includes. */
\r
82 #include "FreeRTOS_UDP_IP.h"
\r
83 #include "FreeRTOS_Sockets.h"
\r
85 /* Demo app includes. */
\r
86 #include "UDPCommandInterpreter.h"
\r
88 /* Dimensions the buffer into which input characters are placed. */
\r
89 #define cmdMAX_INPUT_SIZE 60
\r
91 /* Dimensions the buffer into which string outputs can be placed. */
\r
92 #define cmdMAX_OUTPUT_SIZE 1250
\r
94 /* Dimensions the buffer passed to the recvfrom() call. */
\r
95 #define cmdSOCKET_INPUT_BUFFER_SIZE 60
\r
98 * The task that runs FreeRTOS+CLI.
\r
100 void vUDPCommandInterpreterTask( void *pvParameters );
\r
103 * Open and configure the UDP socket.
\r
105 static xSocket_t prvOpenUDPServerSocket( uint16_t usPort );
\r
107 /*-----------------------------------------------------------*/
\r
109 void vStartUDPCommandInterpreterTask( uint16_t usStackSize, uint32_t ulPort, UBaseType_t uxPriority )
\r
111 xTaskCreate( vUDPCommandInterpreterTask, "CLI", usStackSize, ( void * ) ulPort, uxPriority, NULL );
\r
113 /*-----------------------------------------------------------*/
\r
116 * Task that provides the input and output for the FreeRTOS+CLI command
\r
117 * interpreter. In this case a UDP port is used. See the URL in the comments
\r
118 * within main.c for the location of the online documentation.
\r
120 void vUDPCommandInterpreterTask( void *pvParameters )
\r
122 long lBytes, lByte;
\r
123 signed char cInChar, cInputIndex = 0;
\r
124 static char cInputString[ cmdMAX_INPUT_SIZE ], cOutputString[ cmdMAX_OUTPUT_SIZE ], cLocalBuffer[ cmdSOCKET_INPUT_BUFFER_SIZE ];
\r
125 BaseType_t xMoreDataToFollow;
\r
126 struct freertos_sockaddr xClient;
\r
127 socklen_t xClientAddressLength = 0; /* This is required as a parameter to maintain the sendto() Berkeley sockets API - but it is not actually used so can take any value. */
\r
130 /* Just to prevent compiler warnings. */
\r
131 ( void ) pvParameters;
\r
133 /* Attempt to open the socket. The port number is passed in the task
\r
134 parameter. The strange casting is to remove compiler warnings on 32-bit
\r
136 xSocket = prvOpenUDPServerSocket( ( uint16_t ) ( ( uint32_t ) pvParameters ) & 0xffffUL );
\r
138 if( xSocket != FREERTOS_INVALID_SOCKET )
\r
142 /* Wait for incoming data on the opened socket. */
\r
143 lBytes = FreeRTOS_recvfrom( xSocket, ( void * ) cLocalBuffer, sizeof( cLocalBuffer ), 0, &xClient, &xClientAddressLength );
\r
145 if( lBytes != FREERTOS_SOCKET_ERROR )
\r
147 /* Process each received byte in turn. */
\r
149 while( lByte < lBytes )
\r
151 /* The next character in the input buffer. */
\r
152 cInChar = cLocalBuffer[ lByte ];
\r
155 /* Newline characters are taken as the end of the command
\r
157 if( cInChar == '\n' )
\r
159 /* Process the input string received prior to the
\r
163 /* Pass the string to FreeRTOS+CLI. */
\r
164 xMoreDataToFollow = FreeRTOS_CLIProcessCommand( cInputString, cOutputString, cmdMAX_OUTPUT_SIZE );
\r
166 /* Send the output generated by the command's
\r
168 FreeRTOS_sendto( xSocket, cOutputString, strlen( cOutputString ), 0, &xClient, xClientAddressLength );
\r
170 } while( xMoreDataToFollow != pdFALSE ); /* Until the command does not generate any more output. */
\r
172 /* All the strings generated by the command processing
\r
173 have been sent. Clear the input string ready to receive
\r
174 the next command. */
\r
176 memset( cInputString, 0x00, cmdMAX_INPUT_SIZE );
\r
178 /* Transmit a spacer, just to make the command console
\r
180 FreeRTOS_sendto( xSocket, "\r\n", strlen( "\r\n" ), 0, &xClient, xClientAddressLength );
\r
184 if( cInChar == '\r' )
\r
186 /* Ignore the character. Newlines are used to
\r
187 detect the end of the input string. */
\r
189 else if( cInChar == '\b' )
\r
191 /* Backspace was pressed. Erase the last character
\r
192 in the string - if any. */
\r
193 if( cInputIndex > 0 )
\r
196 cInputString[ cInputIndex ] = '\0';
\r
201 /* A character was entered. Add it to the string
\r
202 entered so far. When a \n is entered the complete
\r
203 string will be passed to the command interpreter. */
\r
204 if( cInputIndex < cmdMAX_INPUT_SIZE )
\r
206 cInputString[ cInputIndex ] = cInChar;
\r
217 /* The socket could not be opened. */
\r
218 vTaskDelete( NULL );
\r
221 /*-----------------------------------------------------------*/
\r
223 static xSocket_t prvOpenUDPServerSocket( uint16_t usPort )
\r
225 struct freertos_sockaddr xServer;
\r
226 xSocket_t xSocket = FREERTOS_INVALID_SOCKET;
\r
228 xSocket = FreeRTOS_socket( FREERTOS_AF_INET, FREERTOS_SOCK_DGRAM, FREERTOS_IPPROTO_UDP );
\r
229 if( xSocket != FREERTOS_INVALID_SOCKET)
\r
231 /* Zero out the server structure. */
\r
232 memset( ( void * ) &xServer, 0x00, sizeof( xServer ) );
\r
234 /* Set family and port. */
\r
235 xServer.sin_port = FreeRTOS_htons( usPort );
\r
237 /* Bind the address to the socket. */
\r
238 if( FreeRTOS_bind( xSocket, &xServer, sizeof( xServer ) ) == -1 )
\r
240 FreeRTOS_closesocket( xSocket );
\r
241 xSocket = FREERTOS_INVALID_SOCKET;
\r