Various small formatting and wording changes in Linux demo

This commit is contained in:
Cobus van Eeden 2020-09-08 20:51:54 -07:00
parent 8ada8156e0
commit c0df730de7
4 changed files with 24 additions and 26 deletions

View file

@ -27,19 +27,18 @@
/****************************************************************************** /******************************************************************************
* This project provides three demo applications. A simple blinky style project, * This project provides three demo applications. A simple blinky style project,
* a more comprehensive test and demo application, and a TCP echo application. * a more comprehensive test and demo application, and a TCP echo demo.
* The mainSELECTED_APPLICATION setting is used to select between * The mainSELECTED_APPLICATION setting is used to select between
* the three * the three
* *
* if mainSELECTED_APPLICATION is BLINKY_DEMO. * If mainSELECTED_APPLICATION = BLINKY_DEMO the simple blinky demo will be built.
* The simply blinky demo is implemented and described in main_blinky.c. * The simply blinky demo is implemented and described in main_blinky.c.
* *
* The more comprehensive test and demo application is implemented * If mainSELECTED_APPLICATION = FULL_DEMO the more comprehensive test and demo
* and described in main_full.c and activated by * application built. This is implemented and described in main_full.c.
* setting mainSELECTED_APPLICATION FULL_DEMO.
* *
* The ECHO_CLIENT_DEMO setting is used to select the tcp echo * If mainSELECTED_APPLICATION = ECHO_CLIENT_DEMO the tcp echo demo will be built.
* application implemeted in main_networking.c * This is implemented and described in main_networking.c
* *
* This file implements the code that is not demo specific, including the * This file implements the code that is not demo specific, including the
* hardware setup and FreeRTOS hook functions. * hardware setup and FreeRTOS hook functions.
@ -156,10 +155,10 @@ int main( void )
console_print("Starting full demo\n"); console_print("Starting full demo\n");
main_full(); main_full();
} }
#else #else
{ {
#error "The selected demo is not valid" #error "The selected demo is not valid"
} }
#endif /* if ( mainSELECTED_APPLICATION ) */ #endif /* if ( mainSELECTED_APPLICATION ) */
@ -197,13 +196,12 @@ void vApplicationIdleHook( void )
because it is the responsibility of the idle task to clean up memory because it is the responsibility of the idle task to clean up memory
allocated by the kernel to any task that has since deleted itself. */ allocated by the kernel to any task that has since deleted itself. */
sleep( 1 );
#if ( mainSELECTED_APPLICATION == FULL_DEMO ) #if ( mainSELECTED_APPLICATION == FULL_DEMO )
{ {
/* Call the idle task processing used by the full demo. The simple /* Call the idle task processing used by the full demo. The simple
blinky demo does not use the idle task hook. */ blinky demo does not use the idle task hook. */
/* vFullDemoIdleFunction(); */ vFullDemoIdleFunction();
} }
#endif #endif
} }
@ -233,9 +231,9 @@ void vApplicationTickHook( void )
functions can be used (those that end in FromISR()). */ functions can be used (those that end in FromISR()). */
#if (mainSELECTED_APPLICATION == FULL_DEMO ) #if (mainSELECTED_APPLICATION == FULL_DEMO )
{ {
vFullDemoTickHookFunction(); vFullDemoTickHookFunction();
} }
#endif /* mainSELECTED_APPLICATION */ #endif /* mainSELECTED_APPLICATION */
} }
@ -291,8 +289,8 @@ volatile uint32_t ulSetToNonZeroInDebuggerToContinue = 0;
value. */ value. */
while( ulSetToNonZeroInDebuggerToContinue == 0 ) while( ulSetToNonZeroInDebuggerToContinue == 0 )
{ {
__asm volatile ( "NOP" ); __asm volatile ( "NOP" );
__asm volatile ( "NOP" ); __asm volatile ( "NOP" );
} }
} }
taskEXIT_CRITICAL(); taskEXIT_CRITICAL();

View file

@ -30,7 +30,7 @@
* this demo application. Also, the timing information in the FreeRTOS+Trace * this demo application. Also, the timing information in the FreeRTOS+Trace
* logs have no meaningful units. See the documentation page for the Linux * logs have no meaningful units. See the documentation page for the Linux
* port for further information: * port for further information:
* https://freertos-wordpress.corp.amazon.com/FreeRTOS-simulator-for-Linux.html * https://freertos.org/FreeRTOS-simulator-for-Linux.html
* *
* NOTE 2: This project provides two demo applications. A simple blinky style * NOTE 2: This project provides two demo applications. A simple blinky style
* project, and a more comprehensive test and demo application. The * project, and a more comprehensive test and demo application. The
@ -75,9 +75,9 @@
* data was received on the queue from the queue send software timer. * data was received on the queue from the queue send software timer.
* *
* NOTE: Console input and output relies on Linux system calls, which can * NOTE: Console input and output relies on Linux system calls, which can
* interfere with the execution of the FreeRTOS Linux port. This demo only * interfere with the execution of the FreeRTOS Linux port. This demo only
* uses Linux system call occasionally. Heavier use of Linux system calls * uses Linux system call occasionally. Heavier use of Linux system calls
* can crash the port. * may crash the port.
*/ */
#include <stdio.h> #include <stdio.h>

View file

@ -27,8 +27,8 @@
/* /*
******************************************************************************* *******************************************************************************
* NOTE 1: The Win32 port is a simulation (or is that emulation?) only! Do not * NOTE 1: The Linux port is a simulation (or is that emulation?) only! Do not
* expect to get real time behaviour from the Win32 port or this demo * expect to get real time behaviour from the Linux port or this demo
* application. It is provided as a convenient development and demonstration * application. It is provided as a convenient development and demonstration
* test bed only. * test bed only.
* *
@ -224,7 +224,7 @@ int main_full( void )
vStartMessageBufferTasks( configMINIMAL_STACK_SIZE ); vStartMessageBufferTasks( configMINIMAL_STACK_SIZE );
/* vStartStreamBufferTasks(); */ /* vStartStreamBufferTasks(); */
/* vStartStreamBufferInterruptDemo(); */ /* vStartStreamBufferInterruptDemo(); */
vStartMessageBufferAMPTasks( configMINIMAL_STACK_SIZE ); /* vStartMessageBufferAMPTasks( configMINIMAL_STACK_SIZE ); */
#if( configSUPPORT_STATIC_ALLOCATION == 1 ) #if( configSUPPORT_STATIC_ALLOCATION == 1 )
{ {

View file

@ -158,7 +158,7 @@ const uint32_t ulLongTime_ms = pdMS_TO_TICKS( 1000UL );
there was insufficient FreeRTOS heap memory available for the idle and/or there was insufficient FreeRTOS heap memory available for the idle and/or
timer tasks to be created. See the memory management section on the timer tasks to be created. See the memory management section on the
FreeRTOS web site for more details (this is standard text that is not not FreeRTOS web site for more details (this is standard text that is not not
really applicable to the Win32 simulator port). */ really applicable to the Linux simulator port). */
for( ; ; ) for( ; ; )
{ {
usleep( ulLongTime_ms * 1000 ); usleep( ulLongTime_ms * 1000 );