FreeRTOS Kernel - Reference Manual - AWS Documentation

1 FreeRTOS KernelReference ManualFreeRTOS Kernel : Reference ManualCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights Kernel Reference ManualAmazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Kernel Reference ManualTable of ContentsWelcome .. 1 API Usage Restrictions .. 1 Task and Scheduler API .. 2portSWITCH_TO_USER_MODE() .. 2 Summary .. 2 Parameters .. 2 Return Values .. 2vTaskAllocateMPUR egions() .. 3 Summary .. 2 Parameters .. 4xTaskAbortDelay () .. 6 Summary .. 2 Parameters .. 4xTaskCallApplicationTaskHook() .. 8 Summary .. 2 Parameters .. 4xTaskCheckForTimeOut().

2 10 Summary .. 2 Parameters .. 4xTaskCreate() .. 12 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskCreateStatic() .. 17 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskCreateRestricted() .. 21 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskDelay() .. 25 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskDelayUntil() .. 27 Summary .. 2 Differences Between vTaskDelay() and vTaskDelayUntil() .. 27 Parameters .. 2iiiFreeRTOS Kernel Reference ManualReturn Values .. 4vTaskDelete() .. 30 Summary .. 2 Parameters .. 2 Return Values .. 4taskDISABLE_INTERRUPTS() .. 32 Summary .. 2 Parameters .. 2 Return Values .. 2taskENABLE_INTERRUPTS() .. 33 Summary .. 2 Parameters .. 2 Return Values .. 2taskENTER_CRITICAL().. 34 Summary .. 2 Parameters .. 2 Return Values .. 4taskENTER_CRITICAL_FROM_ISR() .. 36 Summary .. 2 Parameters .. 2 Return Values .. 4taskEXIT_CRITICAL().. 38 Summary .. 2 Parameters .. 2 Return Values.

3 2taskEXIT_CRITICAL_FROM_ISR() .. 39 Summary .. 2 Parameters .. 2 Return Values .. 2xTaskGetApplicationTaskTag() .. 40 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskGetCurrentTaskHandle() .. 42 Summary .. 2 Parameters .. 2 Return Values .. 2xTaskGetIdleTaskHandle() .. 43 Summary .. 2 Parameters .. 2 Return Values .. 2xTaskGetHandle() .. 44 Summary .. 2 Parameters .. 2 Return Values .. 4uxTaskGetNumberOfTasks() .. 46ivFreeRTOS Kernel Reference ManualSummary .. 2 Parameters .. 2 Return Values .. 2vTaskGetRunTimeStats() .. 47 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskGetSchedulerState() .. 50 Summary .. 2 Parameters .. 2 Return Values .. 2uxTaskGetStackHighWaterMark() .. 51 Summary .. 2 Parameters .. 2 Return Values .. 4eTaskGetState() .. 53 Summary .. 2 Parameters .. 2 Return Values .. 2uxTaskGetSystemState() .. 55 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskGetTaskInfo() .. 59 Summary.

4 2 Parameters .. 4pvTaskGetThreadLocalStoragePointer() .. 61 Summary .. 2 Parameters .. 2 Return Values .. 4pcTaskGetName() .. 62 Summary .. 2 Parameters .. 2 Return Values .. 2xTaskGetTickCount() .. 63 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskGetTickCountFromISR() .. 65 Summary .. 2 Parameters .. 2 Return Values .. 4vFreeRTOS Kernel Reference ManualvTaskList() .. 67 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotify() .. 69 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotifyAndQuery() .. 72 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotifyAndQueryFromISR() .. 75 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotifyFromISR() .. 78 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotifyGive() .. 83 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskNotifyGiveFromISR() .. 86 Summary .. 2 Parameters .. 4xTaskNotifyStateClear() .. 89 Summary.

5 2 Parameters .. 2 Return Values .. 4ulTaskNotifyTake() .. 91 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskNotifyWait() .. 94 Summary .. 2 Parameters .. 2 Return Values .. 2viFreeRTOS Kernel Reference 4uxTaskPriorityGet() .. 97 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskPrioritySet() .. 99 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskResume() .. 101 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskResumeAll() .. 103 Summary .. 2 Parameters .. 2 Return Values .. 4xTaskResumeFromISR() .. 106 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskSetApplicationTaskTag() .. 109 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskSetThreadLocalStoragePointer() .. 112 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskSetTimeOutState() .. 114 Summary .. 2 Parameters .. 4vTaskStartScheduler() .. 116 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskStepTick() .. 118 Summary.

6 2 Parameters .. 2 Return Values .. 4viiFreeRTOS Kernel Reference ManualvTaskSuspend() .. 120 Summary .. 2 Parameters .. 2 Return Values .. 4vTaskSuspendAll() .. 122 Summary .. 2 Parameters .. 2 Return Values .. 4taskYIELD().. 125 Summary .. 2 Parameters .. 2 Return Values .. 4 Queue 127vQueueAddToRegistry() .. 127 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueAddToSet() .. 129 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueCreate() .. 131 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueCreateSet() .. 133 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueCreateStatic() .. 137 Summary .. 2 Parameters .. 2 Return Values .. 4vQueueDelete().. 139 Summary .. 2 Parameters .. 2 Return Values .. 4pcQueueGetName().. 141 Summary .. 2viiiFreeRTOS Kernel Reference ManualParameters .. 2 Return Values .. 2xQueueIsQueueEmptyFromISR() .. 142 Summary .. 2 Parameters .. 2 Return Values.

7 2xQueueIsQueueFullFromISR() .. 143 Summary .. 2 Parameters .. 2 Return Values .. 2uxQueueMessagesWaiting() .. 144 Summary .. 2 Parameters .. 2 Returned Value .. 4uxQueueMessagesWaitingFromISR() .. 145 Summary .. 2 Parameters .. 2 Returned Value .. 4xQueueOverwrite() .. 147 Summary .. 2 Parameters .. 2 Returned Value .. 4xQueueOverwriteFromISR() .. 149 Summary .. 2 Parameters .. 2 Returned Value .. 4xQueuePeek() .. 151 Summary .. 2 Parameters .. 2 Return Values .. 4xQueuePeekFromISR() .. 155 Summary .. 2 Parameters .. 2 Return Values .. 2xQueueReceive() .. 156 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueReceiveFromISR() .. 160 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueRemoveFromSet() .. 163 Summary .. 2ixFreeRTOS Kernel Reference ManualParameters .. 2 Return Values .. 4xQueueReset() .. 165 Summary .. 2 Parameters .. 2 Return Values .. 2xQueueSelectFromSet() .. 166 Summary.

8 2 Parameters .. 2 Return Values .. 4xQueueSelectFromSetFromISR() .. 168 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueSend(), xQueueSendToFront(), xQueueSendToBack() .. 170 Summary .. 2 Parameters .. 2 Return Values .. 4xQueueSendFromISR(), xQueueSendToBackFromISR(), xQueueSendToFrontFromISR() .. 174 Summary .. 2 Parameters .. 2 Return Values .. 4uxQueueSpacesAvailable() .. 177 Summary .. 2 Parameters .. 2 Returned Value .. 4 Semaphore API .. 178vSemaphoreCreateBinary() .. 178 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateBinary() .. 180 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateBinaryStatic() .. 182 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateCounting() .. 184xFreeRTOS Kernel Reference ManualSummary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateCountingStatic() .. 187 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateMutex().

9 190 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateMutexStatic() .. 192 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateRecursiveMutex() .. 194 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreCreateRecursiveMutexStatic() .. 196 Summary .. 2 Parameters .. 2 Return Values .. 4vSemaphoreDelete() .. 198 Summary .. 2 Parameters .. 2 Return Values .. 2uxSemaphoreGetCount() .. 199 Summary .. 2 Parameters .. 2 Return Values .. 2xSemaphoreGetMutexHolder() .. 200 Summary .. 2 Parameters .. 2 Return Values .. 2xSemaphoreGive() .. 201 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreGiveFromISR() .. 204 Summary .. 2xiFreeRTOS Kernel Reference ManualParameters .. 2 Return Values .. 4xSemaphoreGiveRecursive() .. 206 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreTake() .. 209 Summary .. 2 Parameters .. 2 Return Values .. 4xSemaphoreTakeFromISR().

10 212 Summary .. 2 Parameters .. 2 Return Values .. 2xSemaphoreTakeRecursive() .. 213 Summary .. 2 Parameters .. 2 Return Values .. 4 Software Timer API .. 216xTimerChangePeriod() .. 216 Summary .. 2 Parameters .. 2 Return Values .. 4xTimerChangePeriodFromISR() .. 219 Summary .. 2 Parameters .. 2 Return Values .. 4xTimerCreate() .. 222 Summary .. 2 Parameters .. 2 Return Values .. 4xTimerCreateStatic() .. 226 Summary .. 2 Parameters .. 2 Return Values .. 4xTimerDelete().. 231 Summary .. 2 Parameters .. 2 Return Values .. 4xiiFreeRTOS Kernel Reference ManualxTimerGetExpiryTime() .. 233 Summary .. 2 Parameters .. 2 Return Values .. 4pcTimerGetName().. 235 Summary .. 2 Parameters .. 2 Return Values .. 2xTimerGetPeriod() .. 236 Summary .. 2 Parameters .. 2 Return Values .. 4xTimerGetTimerDaemonTaskHandle() .. 238 Summary .. 2 Parameters .. 2 Return Values .. 2pvTimerGetTimerID() .. 239 Summary.