Lines Matching full:for
19 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
76 * configTASK_NOTIFICATION_ARRAY_ENTRIES. For backward compatibility, any use of the
84 * Type by which tasks are referenced. For example, a call to xTaskCreate
174 …tackHighWaterMark; /* The minimum amount of stack space that has remained for the task since the …
176 UBaseType_t uxCoreAffinityMask; /* The core affinity mask for the task */
180 /* Possible return values for eTaskConfirmSleepModeStatus(). */
186 …eNoTasksWaitingTimeout /* No tasks are waiting for a timeout so it is safe to enter a sleep mode t…
207 * Macro for forcing a context switch.
311 * See xTaskCreateStatic() for a version that does not use any dynamic memory
322 * @param pcName A descriptive name for the task. This is mainly used to
327 * variables the stack can hold - not the number of bytes. For example, if
329 * will be allocated for stack storage.
331 * @param pvParameters Pointer that will be used as the parameter for the task
336 * mode by setting bit portPRIVILEGE_BIT of the priority parameter. For
351 * for( ;; )
364 …* // must exist for the lifetime of the task, so in this case is declared static. If it was jus…
426 * @param pcName A descriptive name for the task. This is mainly used to
431 * variables the stack can hold - not the number of bytes. For example, if
433 * will be allocated for stack storage.
435 * @param pvParameters Pointer that will be used as the parameter for the task
442 * removing the need for the stack to be allocated dynamically.
445 * then be used to hold the task's data structures, removing the need for the
458 * // bytes. For example, if each stack item is 32-bits, and this is set to 100,
477 * for( ;; )
491 * "NAME", // Text name for the task.
543 * See xTaskCreateRestrictedStatic() for a version that does not use any
547 * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API
563 * "ATask", // pcName - just a text name for the task to assist debugging.
569 * // xRegions - Allocate up to three separate memory regions for access by
572 * // for full information.
586 * // is requested (the second parameter is not NULL) but in this case just for
595 * for( ;; );
635 * for each of the normal xTaskCreate() parameters (see the xTaskCreate() API
657 * "ATask", // pcName - just a text name for the task to assist debugging.
663 * // xRegions - Allocate up to three separate memory regions for access by
666 * // for full information.
682 * // is requested (the second parameter is not NULL) but in this case just for
691 * for( ;; );
726 * // allowing read/write access for 1024 bytes starting at the beginning of the
743 * // for this purpose. NULL is used as the task handle to indicate that this
766 * INCLUDE_vTaskDelete must be defined as 1 for this function to be available.
767 * See the configuration section for more information.
772 * NOTE: The idle task is responsible for freeing the kernel allocated
779 * See the demo application file death.c for sample code that utilises
813 * Delay a task for a given number of ticks. The actual time that the
818 * INCLUDE_vTaskDelay must be defined as 1 for this function to be available.
819 * See the configuration section for more information.
823 * the time at which vTaskDelay() is called. For example, specifying a block
829 * next executes. See xTaskDelayUntil() for an alternative API function designed
841 * // Block for 500ms.
844 * for( ;; )
863 * INCLUDE_xTaskDelayUntil must be defined as 1 for this function to be available.
864 * See the configuration section for more information.
870 * cause a task to block for the specified number of ticks from the time vTaskDelay () is
909 * for( ;; )
911 * // Wait for the next cycle.
941 * INCLUDE_xTaskAbortDelay must be defined as 1 in FreeRTOSConfig.h for this
944 * A task will enter the Blocked state when it is waiting for an event. The
945 * event it is waiting for can be a temporal event (waiting for a time), such
954 * take. For example, if the task was blocked on a queue the interrupt handler
975 * INCLUDE_uxTaskPriorityGet must be defined as 1 for this function to be available.
976 * See the configuration section for more information.
1034 * INCLUDE_uxTaskPriorityGet and configUSE_MUTEXES must be defined as 1 for this
1035 * function to be available. See the configuration section for more information.
1065 * INCLUDE_eTaskGetState must be defined as 1 for this function to be available.
1066 * See the configuration section for more information.
1087 * configUSE_TRACE_FACILITY must be defined as 1 for this function to be
1088 * available. See the configuration section for more information.
1150 * INCLUDE_vTaskPrioritySet must be defined as 1 for this function to be available.
1151 * See the configuration section for more information.
1158 * @param xTask Handle to the task for which the priority is being set.
1195 * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.
1196 * See the configuration section for more information.
1248 * INCLUDE_vTaskSuspend must be defined as 1 for this function to be available.
1249 * See the configuration section for more information.
1254 * will be made available for running again by a single call to
1299 * INCLUDE_xTaskResumeFromISR must be defined as 1 for this function to be
1300 * available. See the configuration section for more information.
1305 * will be made available for running again by a single call to
1327 * @brief Sets the core affinity mask for a task.
1330 * be defined as 1 for this function to be available.
1332 * @param xTask The handle of the task to set the core affinity mask for.
1333 * Passing NULL will set the core affinity mask for the calling task.
1337 * For example, to ensure that a task can run on core 0 and core 1, set
1355 * //Set the core affinity mask for the task.
1366 * @brief Gets the core affinity mask for a task.
1368 * configUSE_CORE_AFFINITY must be defined as 1 for this function to be
1371 * @param xTask The handle of the task to get the core affinity mask for.
1372 * Passing NULL will get the core affinity mask for the calling task.
1376 * configNUMBER_OF_CORES - 1. For example, if a task can run on core 0 and core 1,
1392 * //Get the core affinity mask for the networking task.
1395 * // Here is a hypothetical scenario, just for the example. Assume that we
1417 * @brief Disables preemption for a task.
1420 * disables preemption for the calling task.
1429 * for( ;; )
1433 * // Disable preemption for this task.
1451 * @brief Enables preemption for a task.
1454 * enables preemption for the calling task.
1463 * for( ;; )
1467 * // Disable preemption for this task.
1495 * See the demo application file main.c for an example of creating
1531 * See the demo application file main. c in the demo/PC directory for an
1535 * portable layer (see vPortEndScheduler () in port. c for the PC port). This
1546 * for( ;; )
1588 * API functions that have the potential to cause a context switch (for example,
1596 * for( ;; )
1647 * for( ;; )
1761 * must be set to 1 in FreeRTOSConfig.h for pcTaskGetHandle() to be available.
1782 * @param xTask The task for which to retrieve the buffers.
1806 * INCLUDE_uxTaskGetStackHighWaterMark must be set to 1 in FreeRTOSConfig.h for
1815 * same except for their return type. Using configSTACK_DEPTH_TYPE allows the
1817 * overflowing on 8-bit types without breaking backward compatibility for
1837 * INCLUDE_uxTaskGetStackHighWaterMark2 must be set to 1 in FreeRTOSConfig.h for
1846 * same except for their return type. Using configSTACK_DEPTH_TYPE allows the
1848 * overflowing on 8-bit types without breaking backward compatibility for
1914 * the pointers for any purpose they wish. The following two functions are
1932 * The application stack overflow hook is called when a stack overflow is detected for a task.
1994 …* configSUPPORT_STATIC_ALLOCATION is set. For more information see this URI: https://www.FreeRTOS…
1997 * @param ppxIdleTaskStackBuffer A handle to a statically allocated Stack buffer for the idle task
2011 …* configSUPPORT_STATIC_ALLOCATION is set. For more information see this URI: https://www.FreeRTOS…
2020 * task index 0, 1 ... ( configNUMBER_OF_CORES - 2 ) to get memory for passive idle
2024 * @param ppxIdleTaskStackBuffer A handle to a statically allocated Stack buffer for the idle task
2045 * pvParameter is passed to the hook function for the task to interpret as it
2080 * configUSE_TRACE_FACILITY must be defined as 1 in FreeRTOSConfig.h for
2083 * uxTaskGetSystemState() populates an TaskStatus_t structure for each task in
2085 * for the task handle, task name, task priority, task state, and total amount
2087 * definition in this file for the full member list.
2089 * NOTE: This function is intended for debugging use only as its use results in
2090 * the scheduler remaining suspended for an extended period.
2093 * The array must contain at least one TaskStatus_t structure for each task
2131 * // Allocate a TaskStatus_t structure for each task. An array could be
2140 * // For percentage calculations.
2146 * // For each populated position in the pxTaskStatusArray array,
2148 * for( x = 0; x < uxArraySize; x++ )
2189 * both be defined as 1 for this function to be available. See the
2190 * configuration section of the FreeRTOS.org website for more information.
2192 * NOTE 1: This function will disable interrupts for its duration. It is
2193 * not intended for normal application runtime use but as a debug aid.
2203 * This function is provided for convenience only, and is used by many of the
2245 * both be defined as 1 for this function to be available. See the
2246 * configuration section of the FreeRTOS.org website for more information.
2249 * configSTATS_BUFFER_MAX_LENGTH. This function is there only for
2253 * NOTE 1: This function will disable interrupts for its duration. It is
2254 * not intended for normal application runtime use but as a debug aid.
2264 * This function is provided for convenience only, and is used by many of the
2301 * must both be defined as 1 for this function to be available. The application
2302 * must also then provide definitions for
2308 * NOTE 1: This function will disable interrupts for its duration. It is
2309 * not intended for normal application runtime use but as a debug aid.
2312 * accumulated execution time being stored for each task. The resolution
2321 * This function is provided for convenience only, and is used by many of the
2362 * must both be defined as 1 for this function to be available. The application
2363 * must also then provide definitions for
2370 * configSTATS_BUFFER_MAX_LENGTH. This function is there only for
2375 * NOTE 1: This function will disable interrupts for its duration. It is
2376 * not intended for normal application runtime use but as a debug aid.
2379 * accumulated execution time being stored for each task. The resolution
2388 * This function is provided for convenience only, and is used by many of the
2424 * configGENERATE_RUN_TIME_STATS must be defined as 1 for these functions to be
2425 * available. The application must also then provide definitions for
2432 * accumulated execution time being stored for each task. The resolution
2462 * configGENERATE_RUN_TIME_STATS must be defined as 1 for these functions to be
2463 * available. The application must also then provide definitions for
2470 * accumulated execution time being stored for each task. The resolution
2504 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
2506 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for these
2515 * array, and (for backward compatibility) defaults to 1 if left undefined.
2520 * are a method of sending an event directly to a task without the need for such
2529 * [optionally] block to wait for a notification to be pending. The task does
2535 * wait for a notification when the notification arrives then the task will
2567 * value, if at all. Valid values for eAction are as follows:
2622 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
2651 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
2653 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for these
2662 * array, and (for backward compatibility) defaults to 1 if left undefined.
2667 * are a method of sending an event directly to a task without the need for such
2675 * A task can use xTaskNotifyWaitIndexed() to [optionally] block to wait for a
2677 * to wait for a notification value to have a non-zero value. The task does
2683 * wait for a notification when the notification arrives then the task will
2715 * value, if at all. Valid values for eAction are as follows:
2749 * for the port in use.
2775 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
2805 * Waits for a direct to task notification to be pending at a given index within
2808 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
2810 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this
2816 * array, and (for backward compatibility) defaults to 1 if left undefined.
2821 * are a method of sending an event directly to a task without the need for such
2832 * wait for a notification when the notification arrives then the task will
2836 * A task can use xTaskNotifyWaitIndexed() to [optionally] block to wait for a
2838 * to wait for a notification value to have a non-zero value. The task does
2856 * notification values on which the calling task will wait for a notification to
2859 * not have this parameter and always waits for notifications on index 0.
2887 * the Blocked state for a notification to be received, should a notification
2921 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for more details.
2923 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for these
2929 * array, and (for backward compatibility) defaults to 1 if left undefined.
2934 * are a method of sending an event directly to a task without the need for such
2942 * xTaskNotifyGiveIndexed() is a helper macro intended for use when task
2949 * equivalent then the task being notified should wait for the notification
2998 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for more details.
3000 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro
3006 * array, and (for backward compatibility) defaults to 1 if left undefined.
3011 * are a method of sending an event directly to a task without the need for such
3019 * vTaskNotifyGiveIndexedFromISR() is intended for use when task notifications
3026 * equivalent then the task being notified should wait for the notification
3062 * for the port in use.
3083 * Waits for a direct to task notification on a particular index in the calling
3086 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
3088 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this
3094 * array, and (for backward compatibility) defaults to 1 if left undefined.
3099 * are a method of sending an event directly to a task without the need for such
3107 * ulTaskNotifyTakeIndexed() is intended for use when a task notification is
3124 * A task can use ulTaskNotifyTakeIndexed() to [optionally] block to wait for
3147 * notification values on which the calling task will wait for a notification to
3150 * not have this parameter and always waits for notifications on index 0.
3160 * the Blocked state for the task's notification value to be greater than zero,
3189 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
3191 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for these
3197 * array, and (for backward compatibility) defaults to 1 if left undefined.
3226 * notification values to act upon. For example, setting uxIndexToClear to 1
3253 * See https://www.FreeRTOS.org/RTOS-task-notifications.html for details.
3255 * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for these
3261 * array, and (for backward compatibility) defaults to 1 if left undefined.
3317 * Capture the current time for future use with xTaskCheckForTimeOut().
3340 * @param pxTicksToWait The number of ticks to check for timeout i.e. if
3381 * // enter the Blocked state. Adjusting xTicksToWait to account for
3392 * // Wait for a maximum of xTicksToWait ticks to be notified that the
3420 * interrupts disabled for an extended period resulting in tick interrupts having
3443 * SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES
3454 * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS
3455 * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
3459 * for a finite period required removing from a blocked list and placing on
3471 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
3476 * on the list of tasks waiting for a particular event, and the
3490 * for the event to occur.
3492 * @param xItemValue The item value to use for the event list item when the
3496 * for the event to occur. This is specified in kernel ticks, the constant
3508 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
3523 * INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
3551 * INTENDED FOR USE WHEN IMPLEMENTING A PORT OF THE SCHEDULER AND IS
3552 * AN INTERFACE WHICH IS FOR THE EXCLUSIVE USE OF THE SCHEDULER.
3610 * the highest priority task that is still waiting for the mutex (if there were
3611 * more than one task waiting for the mutex).
3646 * Provided for use within portSUPPRESS_TICKS_AND_SLEEP() to allow the port
3652 * is therefore possible for an interrupt to request a context switch between
3663 * For internal use only. Increment the mutex held count when a mutex is
3669 * For internal use only. Same as vTaskSetTimeOutState(), but without a critical
3675 * For internal use only. Same as portYIELD_WITHIN_API() in single core FreeRTOS.
3676 * For SMP this is not defined by the port.
3683 * This function is only intended for use when implementing a port of the scheduler
3695 * This function is only intended for use when implementing a port of the scheduler
3707 * This function is only intended for use when implementing a port of the scheduler
3717 * This function is only intended for use when implementing a port of the scheduler
3729 * For internal use only. Get MPU settings associated with a task.
3739 * For internal use only. Grant/Revoke a task's access to a kernel object.
3747 * For internal use only. Grant/Revoke a task's access to a kernel object.