2 FreeRTOS.org V4.0.4 - Copyright (C) 2003-2006 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify
\r
7 it under the terms of the GNU General Public License as published by
\r
8 the Free Software Foundation; either version 2 of the License, or
\r
9 (at your option) any later version.
\r
11 FreeRTOS.org is distributed in the hope that it will be useful,
\r
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
\r
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
\r
14 GNU General Public License for more details.
\r
16 You should have received a copy of the GNU General Public License
\r
17 along with FreeRTOS.org; if not, write to the Free Software
\r
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
\r
20 A special exception to the GPL can be applied should you wish to distribute
\r
21 a combined work that includes FreeRTOS.org, without being obliged to provide
\r
22 the source code for any proprietary components. See the licensing section
\r
23 of http://www.FreeRTOS.org for full details of how and when the exception
\r
26 ***************************************************************************
\r
27 See http://www.FreeRTOS.org for documentation, latest information, license
\r
28 and contact details. Please ensure to read the configuration and relevant
\r
29 port sections of the online documentation.
\r
30 ***************************************************************************
\r
36 #include "portable.h"
\r
39 /*-----------------------------------------------------------
\r
40 * MACROS AND DEFINITIONS
\r
41 *----------------------------------------------------------*/
\r
43 #define tskKERNEL_VERSION_NUMBER "V4.0.4"
\r
48 * Type by which tasks are referenced. For example, a call to xTaskCreate
\r
49 * returns (via a pointer parameter) an xTaskHandle variable that can then
\r
50 * be used as a parameter to vTaskDelete to delete the task.
\r
52 * \page xTaskHandle xTaskHandle
\r
55 typedef void * xTaskHandle;
\r
58 * Defines the priority used by the idle task. This must not be modified.
\r
60 * \ingroup TaskUtils
\r
62 #define tskIDLE_PRIORITY ( ( unsigned portBASE_TYPE ) 0 )
\r
67 * Macro for forcing a context switch.
\r
69 * \page taskYIELD taskYIELD
\r
70 * \ingroup SchedulerControl
\r
72 #define taskYIELD() portYIELD()
\r
77 * Macro to mark the start of a critical code region. Preemptive context
\r
78 * switches cannot occur when in a critical region.
\r
80 * NOTE: This may alter the stack (depending on the portable implementation)
\r
81 * so must be used with care!
\r
83 * \page taskENTER_CRITICAL taskENTER_CRITICAL
\r
84 * \ingroup SchedulerControl
\r
86 #define taskENTER_CRITICAL() portENTER_CRITICAL()
\r
91 * Macro to mark the end of a critical code region. Preemptive context
\r
92 * switches cannot occur when in a critical region.
\r
94 * NOTE: This may alter the stack (depending on the portable implementation)
\r
95 * so must be used with care!
\r
97 * \page taskEXIT_CRITICAL taskEXIT_CRITICAL
\r
98 * \ingroup SchedulerControl
\r
100 #define taskEXIT_CRITICAL() portEXIT_CRITICAL()
\r
105 * Macro to disable all maskable interrupts.
\r
107 * \page taskDISABLE_INTERRUPTS taskDISABLE_INTERRUPTS
\r
108 * \ingroup SchedulerControl
\r
110 #define taskDISABLE_INTERRUPTS() portDISABLE_INTERRUPTS()
\r
115 * Macro to enable microcontroller interrupts.
\r
117 * \page taskENABLE_INTERRUPTS taskENABLE_INTERRUPTS
\r
118 * \ingroup SchedulerControl
\r
120 #define taskENABLE_INTERRUPTS() portENABLE_INTERRUPTS()
\r
123 /*-----------------------------------------------------------
\r
124 * TASK CREATION API
\r
125 *----------------------------------------------------------*/
\r
130 portBASE_TYPE xTaskCreate(
\r
131 pdTASK_CODE pvTaskCode,
\r
132 const portCHAR * const pcName,
\r
133 unsigned portSHORT usStackDepth,
\r
134 void *pvParameters,
\r
135 unsigned portBASE_TYPE uxPriority,
\r
136 xTaskHandle *pvCreatedTask
\r
139 * Create a new task and add it to the list of tasks that are ready to run.
\r
141 * @param pvTaskCode Pointer to the task entry function. Tasks
\r
142 * must be implemented to never return (i.e. continuous loop).
\r
144 * @param pcName A descriptive name for the task. This is mainly used to
\r
145 * facilitate debugging. Max length defined by tskMAX_TASK_NAME_LEN - default
\r
148 * @param usStackDepth The size of the task stack specified as the number of
\r
149 * variables the stack can hold - not the number of bytes. For example, if
\r
150 * the stack is 16 bits wide and usStackDepth is defined as 100, 200 bytes
\r
151 * will be allocated for stack storage.
\r
153 * @param pvParameters Pointer that will be used as the parameter for the task
\r
156 * @param uxPriority The priority at which the task should run.
\r
158 * @param pvCreatedTask Used to pass back a handle by which the created task
\r
159 * can be referenced.
\r
161 * @return pdPASS if the task was successfully created and added to a ready
\r
162 * list, otherwise an error code defined in the file errors. h
\r
166 // Task to be created.
\r
167 void vTaskCode( void * pvParameters )
\r
171 // Task code goes here.
\r
175 // Function that creates a task.
\r
176 void vOtherFunction( void )
\r
178 unsigned char ucParameterToPass;
\r
179 xTaskHandle xHandle;
\r
181 // Create the task, storing the handle.
\r
182 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, &ucParameterToPass, tskIDLE_PRIORITY, &xHandle );
\r
184 // Use the handle to delete the task.
\r
185 vTaskDelete( xHandle );
\r
188 * \defgroup xTaskCreate xTaskCreate
\r
191 signed portBASE_TYPE xTaskCreate( pdTASK_CODE pvTaskCode, const signed portCHAR * const pcName, unsigned portSHORT usStackDepth, void *pvParameters, unsigned portBASE_TYPE uxPriority, xTaskHandle *pvCreatedTask );
\r
195 * <pre>void vTaskDelete( xTaskHandle pxTask );</pre>
\r
197 * INCLUDE_vTaskDelete must be defined as 1 for this function to be available.
\r
198 * See the configuration section for more information.
\r
200 * Remove a task from the RTOS real time kernels management. The task being
\r
201 * deleted will be removed from all ready, blocked, suspended and event lists.
\r
203 * NOTE: The idle task is responsible for freeing the kernel allocated
\r
204 * memory from tasks that have been deleted. It is therefore important that
\r
205 * the idle task is not starved of microcontroller processing time if your
\r
206 * application makes any calls to vTaskDelete (). Memory allocated by the
\r
207 * task code is not automatically freed, and should be freed before the task
\r
210 * See the demo application file death.c for sample code that utilises
\r
213 * @param pxTask The handle of the task to be deleted. Passing NULL will
\r
214 * cause the calling task to be deleted.
\r
218 void vOtherFunction( void )
\r
220 xTaskHandle xHandle;
\r
222 // Create the task, storing the handle.
\r
223 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
\r
225 // Use the handle to delete the task.
\r
226 vTaskDelete( xHandle );
\r
229 * \defgroup vTaskDelete vTaskDelete
\r
232 void vTaskDelete( xTaskHandle pxTask );
\r
235 /*-----------------------------------------------------------
\r
237 *----------------------------------------------------------*/
\r
241 * <pre>void vTaskDelay( portTickType xTicksToDelay );</pre>
\r
243 * Delay a task for a given number of ticks. The actual time that the
\r
244 * task remains blocked depends on the tick rate. The constant
\r
245 * portTICK_RATE_MS can be used to calculate real time from the tick
\r
246 * rate - with the resolution of one tick period.
\r
248 * INCLUDE_vTaskDelay must be defined as 1 for this function to be available.
\r
249 * See the configuration section for more information.
\r
251 * @param xTicksToDelay The amount of time, in tick periods, that
\r
252 * the calling task should block.
\r
256 // Wait 10 ticks before performing an action.
\r
258 // This is for demonstration only and would be better achieved
\r
259 // using vTaskDelayUntil ().
\r
260 void vTaskFunction( void * pvParameters )
\r
262 portTickType xDelay, xNextTime;
\r
264 // Calc the time at which we want to perform the action
\r
266 xNextTime = xTaskGetTickCount () + ( portTickType ) 10;
\r
270 xDelay = xNextTime - xTaskGetTickCount ();
\r
271 xNextTime += ( portTickType ) 10;
\r
273 // Guard against overflow
\r
274 if( xDelay <= ( portTickType ) 10 )
\r
276 vTaskDelay( xDelay );
\r
279 // Perform action here.
\r
283 * \defgroup vTaskDelay vTaskDelay
\r
284 * \ingroup TaskCtrl
\r
286 void vTaskDelay( portTickType xTicksToDelay );
\r
290 * <pre>void vTaskDelayUntil( portTickType *pxPreviousWakeTime, portTickType xTimeIncrement );</pre>
\r
292 * INCLUDE_vTaskDelayUntil must be defined as 1 for this function to be available.
\r
293 * See the configuration section for more information.
\r
295 * Delay a task until a specified time. This function can be used by cyclical
\r
296 * tasks to ensure a constant execution frequency.
\r
298 * This function differs from vTaskDelay () in one important aspect: vTaskDelay () will
\r
299 * cause a task to block for the specified number of ticks from the time vTaskDelay () is
\r
300 * called. It is therefore difficult to use vTaskDelay () by itself to generate a fixed
\r
301 * execution frequency as the time between a task starting to execute and that task
\r
302 * calling vTaskDelay () may not be fixed [the task may take a different path though the
\r
303 * code between calls, or may get interrupted or preempted a different number of times
\r
304 * each time it executes].
\r
306 * Whereas vTaskDelay () specifies a wake time relative to the time at which the function
\r
307 * is called, vTaskDelayUntil () specifies the absolute (exact) time at which it wishes to
\r
310 * The constant portTICK_RATE_MS can be used to calculate real time from the tick
\r
311 * rate - with the resolution of one tick period.
\r
313 * @param pxPreviousWakeTime Pointer to a variable that holds the time at which the
\r
314 * task was last unblocked. The variable must be initialised with the current time
\r
315 * prior to its first use (see the example below). Following this the variable is
\r
316 * automatically updated within vTaskDelayUntil ().
\r
318 * @param xTimeIncrement The cycle time period. The task will be unblocked at
\r
319 * time *pxPreviousWakeTime + xTimeIncrement. Calling vTaskDelayUntil with the
\r
320 * same xTimeIncrement parameter value will cause the task to execute with
\r
321 * a fixed interface period.
\r
325 // Perform an action every 10 ticks.
\r
326 void vTaskFunction( void * pvParameters )
\r
328 portTickType xLastWakeTime;
\r
329 const portTickType xFrequency = 10;
\r
331 // Initialise the xLastWakeTime variable with the current time.
\r
332 xLastWakeTime = xTaskGetTickCount ();
\r
335 // Wait for the next cycle.
\r
336 vTaskDelayUntil( &xLastWakeTime, xFrequency );
\r
338 // Perform action here.
\r
342 * \defgroup vTaskDelayUntil vTaskDelayUntil
\r
343 * \ingroup TaskCtrl
\r
345 void vTaskDelayUntil( portTickType *pxPreviousWakeTime, portTickType xTimeIncrement );
\r
349 * <pre>unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask );</pre>
\r
351 * INCLUDE_xTaskPriorityGet must be defined as 1 for this function to be available.
\r
352 * See the configuration section for more information.
\r
354 * Obtain the priority of any task.
\r
356 * @param pxTask Handle of the task to be queried. Passing a NULL
\r
357 * handle results in the priority of the calling task being returned.
\r
359 * @return The priority of pxTask.
\r
363 void vAFunction( void )
\r
365 xTaskHandle xHandle;
\r
367 // Create a task, storing the handle.
\r
368 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
\r
372 // Use the handle to obtain the priority of the created task.
\r
373 // It was created with tskIDLE_PRIORITY, but may have changed
\r
375 if( uxTaskPriorityGet( xHandle ) != tskIDLE_PRIORITY )
\r
377 // The task has changed it's priority.
\r
382 // Is our priority higher than the created task?
\r
383 if( uxTaskPriorityGet( xHandle ) < uxTaskPriorityGet( NULL ) )
\r
385 // Our priority (obtained using NULL handle) is higher.
\r
389 * \defgroup uxTaskPriorityGet uxTaskPriorityGet
\r
390 * \ingroup TaskCtrl
\r
392 unsigned portBASE_TYPE uxTaskPriorityGet( xTaskHandle pxTask );
\r
396 * <pre>void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority );</pre>
\r
398 * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.
\r
399 * See the configuration section for more information.
\r
401 * Set the priority of any task.
\r
403 * A context switch will occur before the function returns if the priority
\r
404 * being set is higher than the currently executing task.
\r
406 * @param pxTask Handle to the task for which the priority is being set.
\r
407 * Passing a NULL handle results in the priority of the calling task being set.
\r
409 * @param uxNewPriority The priority to which the task will be set.
\r
413 void vAFunction( void )
\r
415 xTaskHandle xHandle;
\r
417 // Create a task, storing the handle.
\r
418 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
\r
422 // Use the handle to raise the priority of the created task.
\r
423 vTaskPrioritySet( xHandle, tskIDLE_PRIORITY + 1 );
\r
427 // Use a NULL handle to raise our priority to the same value.
\r
428 vTaskPrioritySet( NULL, tskIDLE_PRIORITY + 1 );
\r
431 * \defgroup vTaskPrioritySet vTaskPrioritySet
\r
432 * \ingroup TaskCtrl
\r
434 void vTaskPrioritySet( xTaskHandle pxTask, unsigned portBASE_TYPE uxNewPriority );
\r
438 * <pre>void vTaskSuspend( xTaskHandle pxTaskToSuspend );</pre>
\r
440 * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.
\r
441 * See the configuration section for more information.
\r
443 * Suspend any task. When suspended a task will never get any microcontroller
\r
444 * processing time, no matter what its priority.
\r
446 * Calls to vTaskSuspend are not accumulative -
\r
447 * i.e. calling vTaskSuspend () twice on the same task still only requires one
\r
448 * call to vTaskResume () to ready the suspended task.
\r
450 * @param pxTaskToSuspend Handle to the task being suspended. Passing a NULL
\r
451 * handle will cause the calling task to be suspended.
\r
455 void vAFunction( void )
\r
457 xTaskHandle xHandle;
\r
459 // Create a task, storing the handle.
\r
460 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
\r
464 // Use the handle to suspend the created task.
\r
465 vTaskSuspend( xHandle );
\r
469 // The created task will not run during this period, unless
\r
470 // another task calls vTaskResume( xHandle ).
\r
475 // Suspend ourselves.
\r
476 vTaskSuspend( NULL );
\r
478 // We cannot get here unless another task calls vTaskResume
\r
479 // with our handle as the parameter.
\r
482 * \defgroup vTaskSuspend vTaskSuspend
\r
483 * \ingroup TaskCtrl
\r
485 void vTaskSuspend( xTaskHandle pxTaskToSuspend );
\r
489 * <pre>void vTaskResume( xTaskHandle pxTaskToResume );</pre>
\r
491 * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.
\r
492 * See the configuration section for more information.
\r
494 * Resumes a suspended task.
\r
496 * A task that has been suspended by one of more calls to vTaskSuspend ()
\r
497 * will be made available for running again by a single call to
\r
500 * @param pxTaskToResume Handle to the task being readied.
\r
504 void vAFunction( void )
\r
506 xTaskHandle xHandle;
\r
508 // Create a task, storing the handle.
\r
509 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, &xHandle );
\r
513 // Use the handle to suspend the created task.
\r
514 vTaskSuspend( xHandle );
\r
518 // The created task will not run during this period, unless
\r
519 // another task calls vTaskResume( xHandle ).
\r
524 // Resume the suspended task ourselves.
\r
525 vTaskResume( xHandle );
\r
527 // The created task will once again get microcontroller processing
\r
528 // time in accordance with it priority within the system.
\r
531 * \defgroup vTaskResume vTaskResume
\r
532 * \ingroup TaskCtrl
\r
534 void vTaskResume( xTaskHandle pxTaskToResume );
\r
536 /*-----------------------------------------------------------
\r
537 * SCHEDULER CONTROL
\r
538 *----------------------------------------------------------*/
\r
542 * <pre>void vTaskStartScheduler( void );</pre>
\r
544 * Starts the real time kernel tick processing. After calling the kernel
\r
545 * has control over which tasks are executed and when. This function
\r
546 * does not return until an executing task calls vTaskEndScheduler ().
\r
548 * At least one task should be created via a call to xTaskCreate ()
\r
549 * before calling vTaskStartScheduler (). The idle task is created
\r
550 * automatically when the first application task is created.
\r
552 * See the demo application file main.c for an example of creating
\r
553 * tasks and starting the kernel.
\r
557 void vAFunction( void )
\r
559 // Create at least one task before starting the kernel.
\r
560 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
562 // Start the real time kernel with preemption.
\r
563 vTaskStartScheduler ();
\r
565 // Will not get here unless a task calls vTaskEndScheduler ()
\r
569 * \defgroup vTaskStartScheduler vTaskStartScheduler
\r
570 * \ingroup SchedulerControl
\r
572 void vTaskStartScheduler( void );
\r
576 * <pre>void vTaskEndScheduler( void );</pre>
\r
578 * Stops the real time kernel tick. All created tasks will be automatically
\r
579 * deleted and multitasking (either preemptive or cooperative) will
\r
580 * stop. Execution then resumes from the point where vTaskStartScheduler ()
\r
581 * was called, as if vTaskStartScheduler () had just returned.
\r
583 * See the demo application file main. c in the demo/PC directory for an
\r
584 * example that uses vTaskEndScheduler ().
\r
586 * vTaskEndScheduler () requires an exit function to be defined within the
\r
587 * portable layer (see vPortEndScheduler () in port. c for the PC port). This
\r
588 * performs hardware specific operations such as stopping the kernel tick.
\r
590 * vTaskEndScheduler () will cause all of the resources allocated by the
\r
591 * kernel to be freed - but will not free resources allocated by application
\r
596 void vTaskCode( void * pvParameters )
\r
600 // Task code goes here.
\r
602 // At some point we want to end the real time kernel processing
\r
604 vTaskEndScheduler ();
\r
608 void vAFunction( void )
\r
610 // Create at least one task before starting the kernel.
\r
611 xTaskCreate( vTaskCode, "NAME", STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
613 // Start the real time kernel with preemption.
\r
614 vTaskStartScheduler ();
\r
616 // Will only get here when the vTaskCode () task has called
\r
617 // vTaskEndScheduler (). When we get here we are back to single task
\r
622 * \defgroup vTaskEndScheduler vTaskEndScheduler
\r
623 * \ingroup SchedulerControl
\r
625 void vTaskEndScheduler( void );
\r
629 * <pre>void vTaskSuspendAll( void );</pre>
\r
631 * Suspends all real time kernel activity while keeping interrupts (including the
\r
632 * kernel tick) enabled.
\r
634 * After calling vTaskSuspendAll () the calling task will continue to execute
\r
635 * without risk of being swapped out until a call to xTaskResumeAll () has been
\r
640 void vTask1( void * pvParameters )
\r
644 // Task code goes here.
\r
648 // At some point the task wants to perform a long operation during
\r
649 // which it does not want to get swapped out. It cannot use
\r
650 // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the
\r
651 // operation may cause interrupts to be missed - including the
\r
654 // Prevent the real time kernel swapping out the task.
\r
655 vTaskSuspendAll ();
\r
657 // Perform the operation here. There is no need to use critical
\r
658 // sections as we have all the microcontroller processing time.
\r
659 // During this time interrupts will still operate and the kernel
\r
660 // tick count will be maintained.
\r
664 // The operation is complete. Restart the kernel.
\r
669 * \defgroup vTaskSuspendAll vTaskSuspendAll
\r
670 * \ingroup SchedulerControl
\r
672 void vTaskSuspendAll( void );
\r
676 * <pre>portCHAR xTaskResumeAll( void );</pre>
\r
678 * Resumes real time kernel activity following a call to vTaskSuspendAll ().
\r
679 * After a call to vTaskSuspendAll () the kernel will take control of which
\r
680 * task is executing at any time.
\r
682 * @return If resuming the scheduler caused a context switch then pdTRUE is
\r
683 * returned, otherwise pdFALSE is returned.
\r
687 void vTask1( void * pvParameters )
\r
691 // Task code goes here.
\r
695 // At some point the task wants to perform a long operation during
\r
696 // which it does not want to get swapped out. It cannot use
\r
697 // taskENTER_CRITICAL ()/taskEXIT_CRITICAL () as the length of the
\r
698 // operation may cause interrupts to be missed - including the
\r
701 // Prevent the real time kernel swapping out the task.
\r
702 vTaskSuspendAll ();
\r
704 // Perform the operation here. There is no need to use critical
\r
705 // sections as we have all the microcontroller processing time.
\r
706 // During this time interrupts will still operate and the real
\r
707 // time kernel tick count will be maintained.
\r
711 // The operation is complete. Restart the kernel. We want to force
\r
712 // a context switch - but there is no point if resuming the scheduler
\r
713 // caused a context switch already.
\r
714 if( !xTaskResumeAll () )
\r
721 * \defgroup xTaskResumeAll xTaskResumeAll
\r
722 * \ingroup SchedulerControl
\r
724 signed portBASE_TYPE xTaskResumeAll( void );
\r
727 /*-----------------------------------------------------------
\r
729 *----------------------------------------------------------*/
\r
733 * <PRE>volatile portTickType xTaskGetTickCount( void );</PRE>
\r
735 * @return The count of ticks since vTaskStartScheduler was called.
\r
737 * \page xTaskGetTickCount xTaskGetTickCount
\r
738 * \ingroup TaskUtils
\r
740 portTickType xTaskGetTickCount( void );
\r
744 * <PRE>unsigned portSHORT uxTaskGetNumberOfTasks( void );</PRE>
\r
746 * @return The number of tasks that the real time kernel is currently managing.
\r
747 * This includes all ready, blocked and suspended tasks. A task that
\r
748 * has been deleted but not yet freed by the idle task will also be
\r
749 * included in the count.
\r
751 * \page uxTaskGetNumberOfTasks uxTaskGetNumberOfTasks
\r
752 * \ingroup TaskUtils
\r
754 unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void );
\r
758 * <PRE>void vTaskList( portCHAR *pcWriteBuffer );</PRE>
\r
760 * configUSE_TRACE_FACILITY, INCLUDE_vTaskDelete and INCLUDE_vTaskSuspend
\r
761 * must all be defined as 1 for this function to be available.
\r
762 * See the configuration section for more information.
\r
764 * NOTE: This function will disable interrupts for its duration. It is
\r
765 * not intended for normal application runtime use but as a debug aid.
\r
767 * Lists all the current tasks, along with their current state and stack
\r
768 * usage high water mark.
\r
770 * Tasks are reported as blocked ('B'), ready ('R'), deleted ('D') or
\r
773 * @param pcWriteBuffer A buffer into which the above mentioned details
\r
774 * will be written, in ascii form. This buffer is assumed to be large
\r
775 * enough to contain the generated report. Approximately 40 bytes per
\r
776 * task should be sufficient.
\r
778 * \page vTaskList vTaskList
\r
779 * \ingroup TaskUtils
\r
781 void vTaskList( signed portCHAR *pcWriteBuffer );
\r
785 * <PRE>void vTaskStartTrace( portCHAR * pcBuffer, unsigned portBASE_TYPE uxBufferSize );</PRE>
\r
787 * Starts a real time kernel activity trace. The trace logs the identity of
\r
788 * which task is running when.
\r
790 * The trace file is stored in binary format. A separate DOS utility called
\r
791 * convtrce.exe is used to convert this into a tab delimited text file which
\r
792 * can be viewed and plotted in a spread sheet.
\r
794 * @param pcBuffer The buffer into which the trace will be written.
\r
796 * @param ulBufferSize The size of pcBuffer in bytes. The trace will continue
\r
797 * until either the buffer in full, or ulTaskEndTrace () is called.
\r
799 * \page vTaskStartTrace vTaskStartTrace
\r
800 * \ingroup TaskUtils
\r
802 void vTaskStartTrace( signed portCHAR * pcBuffer, unsigned portLONG ulBufferSize );
\r
806 * <PRE>unsigned portLONG ulTaskEndTrace( void );</PRE>
\r
808 * Stops a kernel activity trace. See vTaskStartTrace ().
\r
810 * @return The number of bytes that have been written into the trace buffer.
\r
812 * \page usTaskEndTrace usTaskEndTrace
\r
813 * \ingroup TaskUtils
\r
815 unsigned portLONG ulTaskEndTrace( void );
\r
818 /*-----------------------------------------------------------
\r
819 * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES
\r
820 *----------------------------------------------------------*/
\r
823 * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY
\r
824 * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS
\r
825 * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
\r
827 * Called from the real time kernel tick (either preemptive or cooperative),
\r
828 * this increments the tick count and checks if any tasks that are blocked
\r
829 * for a finite period required removing from a blocked list and placing on
\r
832 inline void vTaskIncrementTick( void );
\r
835 * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN
\r
836 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
\r
838 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.
\r
840 * Removes the calling task from the ready list and places it both
\r
841 * on the list of tasks waiting for a particular event, and the
\r
842 * list of delayed tasks. The task will be removed from both lists
\r
843 * and replaced on the ready list should either the event occur (and
\r
844 * there be no higher priority tasks waiting on the same event) or
\r
845 * the delay period expires.
\r
847 * @param pxEventList The list containing tasks that are blocked waiting
\r
848 * for the event to occur.
\r
850 * @param xTicksToWait The maximum amount of time that the task should wait
\r
851 * for the event to occur. This is specified in kernel ticks,the constant
\r
852 * portTICK_RATE_MS can be used to convert kernel ticks into a real time
\r
855 void vTaskPlaceOnEventList( xList *pxEventList, portTickType xTicksToWait );
\r
858 * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN
\r
859 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
\r
861 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED.
\r
863 * Removes a task from both the specified event list and the list of blocked
\r
864 * tasks, and places it on a ready queue.
\r
866 * xTaskRemoveFromEventList () will be called if either an event occurs to
\r
867 * unblock a task, or the block timeout period expires.
\r
869 * @return pdTRUE if the task being removed has a higher priority than the task
\r
870 * making the call, otherwise pdFALSE.
\r
872 signed portBASE_TYPE xTaskRemoveFromEventList( const xList *pxEventList );
\r
875 * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS AN
\r
876 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
\r
878 * INCLUDE_vTaskCleanUpResources and INCLUDE_vTaskSuspend must be defined as 1
\r
879 * for this function to be available.
\r
880 * See the configuration section for more information.
\r
882 * Empties the ready and delayed queues of task control blocks, freeing the
\r
883 * memory allocated for the task control block and task stacks as it goes.
\r
885 void vTaskCleanUpResources( void );
\r
888 * THIS FUNCTION MUST NOT BE USED FROM APPLICATION CODE. IT IS ONLY
\r
889 * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS
\r
890 * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
\r
892 * Sets the pointer to the current TCB to the TCB of the highest priority task
\r
893 * that is ready to run.
\r
895 inline void vTaskSwitchContext( void );
\r
898 * Return the handle of the calling task.
\r
900 xTaskHandle xTaskGetCurrentTaskHandle( void );
\r
903 #endif /* TASK_H */
\r