use of FreeRTOS.*/\r
#if( configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES == 0 )\r
/* Define the macros to do nothing. */\r
- #define listLIST_ITEM_INTEGRITY_CHECK_VALUE_1\r
- #define listLIST_ITEM_INTEGRITY_CHECK_VALUE_2\r
- #define listLIST_INTEGRITY_CHECK_VALUE_1\r
- #define listLIST_INTEGRITY_CHECK_VALUE_2\r
- #define listSET_LIST_ITEM_INTEGRITY_CHECK_1_VALUE( pxItem )\r
- #define listSET_LIST_ITEM_INTEGRITY_CHECK_2_VALUE( pxItem )\r
+ #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+ #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE\r
+ #define listFIRST_LIST_INTEGRITY_CHECK_VALUE\r
+ #define listSECOND_LIST_INTEGRITY_CHECK_VALUE\r
+ #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
+ #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem )\r
#define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList )\r
#define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList )\r
#define listTEST_LIST_ITEM_INTEGRITY( pxItem )\r
#define listTEST_LIST_INTEGRITY( pxList )\r
#else\r
/* Define macros that add new members into the list structures. */\r
- #define listLIST_ITEM_INTEGRITY_CHECK_VALUE_1 TickType_t xListItemIntegrityValue1;\r
- #define listLIST_ITEM_INTEGRITY_CHECK_VALUE_2 TickType_t xListItemIntegrityValue2;\r
- #define listLIST_INTEGRITY_CHECK_VALUE_1 TickType_t xListIntegrityValue1;\r
- #define listLIST_INTEGRITY_CHECK_VALUE_2 TickType_t xListIntegrityValue2;\r
+ #define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue1;\r
+ #define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE TickType_t xListItemIntegrityValue2;\r
+ #define listFIRST_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue1;\r
+ #define listSECOND_LIST_INTEGRITY_CHECK_VALUE TickType_t xListIntegrityValue2;\r
\r
/* Define macros that set the new structure members to known values. */\r
- #define listSET_LIST_ITEM_INTEGRITY_CHECK_1_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
- #define listSET_LIST_ITEM_INTEGRITY_CHECK_2_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
+ #define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
+ #define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE( pxItem ) ( pxItem )->xListItemIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
#define listSET_LIST_INTEGRITY_CHECK_1_VALUE( pxList ) ( pxList )->xListIntegrityValue1 = pdINTEGRITY_CHECK_VALUE\r
#define listSET_LIST_INTEGRITY_CHECK_2_VALUE( pxList ) ( pxList )->xListIntegrityValue2 = pdINTEGRITY_CHECK_VALUE\r
\r
*/\r
struct xLIST_ITEM\r
{\r
- listLIST_ITEM_INTEGRITY_CHECK_VALUE_1 /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+ listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
configLIST_VOLATILE TickType_t xItemValue; /*< The value being listed. In most cases this is used to sort the list in descending order. */\r
struct xLIST_ITEM * configLIST_VOLATILE pxNext; /*< Pointer to the next ListItem_t in the list. */\r
struct xLIST_ITEM * configLIST_VOLATILE pxPrevious; /*< Pointer to the previous ListItem_t in the list. */\r
void * pvOwner; /*< Pointer to the object (normally a TCB) that contains the list item. There is therefore a two way link between the object containing the list item and the list item itself. */\r
void * configLIST_VOLATILE pvContainer; /*< Pointer to the list in which this list item is placed (if any). */\r
- listLIST_ITEM_INTEGRITY_CHECK_VALUE_2 /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+ listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
};\r
typedef struct xLIST_ITEM ListItem_t; /* For some reason lint wants this as two separate definitions. */\r
\r
struct xMINI_LIST_ITEM\r
{\r
- listLIST_ITEM_INTEGRITY_CHECK_VALUE_1 /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+ listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
configLIST_VOLATILE TickType_t xItemValue;\r
struct xLIST_ITEM * configLIST_VOLATILE pxNext;\r
struct xLIST_ITEM * configLIST_VOLATILE pxPrevious;\r
*/\r
typedef struct xLIST\r
{\r
- listLIST_INTEGRITY_CHECK_VALUE_1 /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+ listFIRST_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
configLIST_VOLATILE UBaseType_t uxNumberOfItems;\r
ListItem_t * configLIST_VOLATILE pxIndex; /*< Used to walk through the list. Points to the last item returned by a call to listGET_OWNER_OF_NEXT_ENTRY (). */\r
MiniListItem_t xListEnd; /*< List item that contains the maximum possible item value meaning it is always at the end of the list and is therefore used as a marker. */\r
- listLIST_INTEGRITY_CHECK_VALUE_2 /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
+ listSECOND_LIST_INTEGRITY_CHECK_VALUE /*< Set to a known value if configUSE_LIST_DATA_INTEGRITY_CHECK_BYTES is set to 1. */\r
} List_t;\r
\r
/*\r
/* Actions that can be performed when vTaskNotify() is called. */\r
typedef enum\r
{\r
- eNoAction, /* Notify the task without updating its notify value. */\r
+ eNoAction = 0, /* Notify the task without updating its notify value. */\r
eSetBits, /* Set bits in the task's notification value. */\r
eIncrement, /* Increment the task's notification value. */\r
eSetValueWithOverwrite, /* Set the task's notification value to a specific value even if the previous value has not yet been read by the task. */\r
* task. h\r
* <PRE>BaseType_t xTaskNotify( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction );</PRE>\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this function to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
+ * function to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* (unblocked) and the notification cleared.\r
*\r
* A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or xTaskNotifyTake() to [optionally] block\r
+ * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
* to wait for its notification value to have a non-zero value. The task does\r
* not consume any CPU time while it is in the Blocked state.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for details of when\r
- * it is best to use a task notification to send an event to a task compared to\r
- * when it is best to use an intermediary object (such as a queue, semaphore,\r
- * mutex or event group) to send an event to a task.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
*\r
* @param xTaskToNotify The handle of the task being notified. The handle to a\r
* task can be returned from the xTaskCreate() API function used to create the\r
* task. h\r
* <PRE>BaseType_t xTaskNotifyFromISR( TaskHandle_t xTaskToNotify, uint32_t ulValue, eNotifyAction eAction, BaseType_t *pxHigherPriorityTaskWoken );</PRE>\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this function to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
+ * function to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* (unblocked) and the notification cleared.\r
*\r
* A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or xTaskNotifyTake() to [optionally] block\r
+ * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
* to wait for its notification value to have a non-zero value. The task does\r
* not consume any CPU time while it is in the Blocked state.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for details of when\r
- * it is best to use a task notification to send an event to a task compared to\r
- * when it is best to use an intermediary object (such as a queue, semaphore,\r
- * mutex or event group) to send an event to a task.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
*\r
* @param xTaskToNotify The handle of the task being notified. The handle to a\r
* task can be returned from the xTaskCreate() API function used to create the\r
\r
/**\r
* task. h\r
- * <PRE>BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, BaseType_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );</pre>\r
+ * <PRE>BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );</pre>\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this function to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
+ * function to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* (unblocked) and the notification cleared.\r
*\r
* A task can use xTaskNotifyWait() to [optionally] block to wait for a\r
- * notification to be pending, or xTaskNotifyTake() to [optionally] block\r
+ * notification to be pending, or ulTaskNotifyTake() to [optionally] block\r
* to wait for its notification value to have a non-zero value. The task does\r
* not consume any CPU time while it is in the Blocked state.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for details of when\r
- * it is best to use a task notification to send an event to a task compared to\r
- * when it is best to use an intermediary object (such as a queue, semaphore,\r
- * mutex or event group) to send an event to a task.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
*\r
* @param ulBitsToClearOnEntry Bits that are set in ulBitsToClearOnEntry value\r
* will be cleared in the calling task's notification value before the task\r
* \defgroup xTaskNotifyWait xTaskNotifyWait\r
* \ingroup TaskNotifications\r
*/\r
-BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, BaseType_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );\r
+BaseType_t xTaskNotifyWait( uint32_t ulBitsToClearOnEntry, uint32_t ulBitsToClearOnExit, uint32_t *pulNotificationValue, TickType_t xTicksToWait );\r
\r
/**\r
* task. h\r
- * <PRE>BaseType_t xTaskNotifyGive( TaskHandle_t xTaskHandle, BaseType_t *pxHigherPriorityTaskWoken );\r
+ * <PRE>BaseType_t xTaskNotifyGive( TaskHandle_t xTaskToNotify );</PRE>\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this macro to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
+ * to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* using the ulTaskNotificationTake() API function rather than the\r
* xTaskNotifyWait() API function.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for more details.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
*\r
* @param xTaskToNotify The handle of the task being notified. The handle to a\r
* task can be returned from the xTaskCreate() API function used to create the\r
\r
/**\r
* task. h\r
- * <PRE>BaseType_t xTaskNotifyGiveFromISR( TaskHandle_t xTaskHandle, BaseType_t *pxHigherPriorityTaskWoken );\r
+ * <PRE>void vTaskNotifyGiveFromISR( TaskHandle_t xTaskHandle, BaseType_t *pxHigherPriorityTaskWoken );\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this macro to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this macro\r
+ * to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* task notifications can be used to send data to a task, or be used as light\r
* weight and fast binary or counting semaphores.\r
*\r
- * xTaskNotifyGiveFromISR() is a helper macro intended for use when task\r
- * notifications are used as light weight and faster binary or counting\r
- * semaphore equivalents. Actual FreeRTOS semaphores are given from an ISR\r
- * using the xSemaphoreGiveFromISR() API function, the equivalent action that\r
- * instead uses a task notification is xTaskNotifyGiveFromISR().\r
+ * vTaskNotifyGiveFromISR() is intended for use when task notifications are\r
+ * used as light weight and faster binary or counting semaphore equivalents.\r
+ * Actual FreeRTOS semaphores are given from an ISR using the\r
+ * xSemaphoreGiveFromISR() API function, the equivalent action that instead uses\r
+ * a task notification is vTaskNotifyGiveFromISR().\r
*\r
* When task notifications are being used as a binary or counting semaphore\r
* equivalent then the task being notified should wait for the notification\r
* using the ulTaskNotificationTake() API function rather than the\r
* xTaskNotifyWait() API function.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for more details.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for more details.\r
*\r
* @param xTaskToNotify The handle of the task being notified. The handle to a\r
* task can be returned from the xTaskCreate() API function used to create the\r
* task, and the handle of the currently running task can be obtained by calling\r
* xTaskGetCurrentTaskHandle().\r
*\r
- * @param pxHigherPriorityTaskWoken xTaskNotifyGiveFromISR() will set\r
+ * @param pxHigherPriorityTaskWoken vTaskNotifyGiveFromISR() will set\r
* *pxHigherPriorityTaskWoken to pdTRUE if sending the notification caused the\r
* task to which the notification was sent to leave the Blocked state, and the\r
* unblocked task has a priority higher than the currently running task. If\r
- * xTaskNotifyGiveFromISR() sets this value to pdTRUE then a context switch\r
+ * vTaskNotifyGiveFromISR() sets this value to pdTRUE then a context switch\r
* should be requested before the interrupt is exited. How a context switch is\r
* requested from an ISR is dependent on the port - see the documentation page\r
* for the port in use.\r
*\r
- * @return xTaskNotifyGiveFromISR() is a macro that calls xTaskNotifyFromISR()\r
- * with the eAction parameter set to eIncrement - so pdPASS is always returned.\r
- *\r
* \defgroup xTaskNotifyWait xTaskNotifyWait\r
* \ingroup TaskNotifications\r
*/\r
-BaseType_t xTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken );\r
+void vTaskNotifyGiveFromISR( TaskHandle_t xTaskToNotify, BaseType_t *pxHigherPriorityTaskWoken );\r
\r
/**\r
* task. h\r
* <PRE>uint32_t ulTaskNotifyTake( BaseType_t xClearCountOnExit, TickType_t xTicksToWait );</pre>\r
*\r
- * configUSE_TASK_NOTIFICATIONS must be defined as 1 for this function to be\r
- * available.\r
+ * configUSE_TASK_NOTIFICATIONS must be undefined or defined as 1 for this\r
+ * function to be available.\r
*\r
* When configUSE_TASK_NOTIFICATIONS is set to one each task has its own private\r
* "notification value", which is a 32-bit unsigned integer (uint32_t).\r
* faster and lighter weight binary or counting semaphore alternative. Actual\r
* FreeRTOS semaphores are taken using the xSemaphoreTake() API function, the\r
* equivalent action that instead uses a task notification is\r
- * xTaskNotifyTake().\r
+ * ulTaskNotifyTake().\r
*\r
* When a task is using its notification value as a binary or counting semaphore\r
* other tasks should send notifications to it using the xTaskNotifyGive()\r
* macro, or xTaskNotify() function with the eAction parameter set to\r
* eIncrement.\r
*\r
- * xTaskNotifyTake() can either clear the task's notification value to\r
+ * ulTaskNotifyTake() can either clear the task's notification value to\r
* zero on exit, in which case the notification value acts like a binary\r
* semaphore, or decrement the task's notification value on exit, in which case\r
* the notification value acts like a counting semaphore.\r
*\r
- * A task can use xTaskNotifyTake() to [optionally] block to wait for a\r
- * the tasks notification value to be non-zero. The task does not consume any\r
+ * A task can use ulTaskNotifyTake() to [optionally] block to wait for a\r
+ * the task's notification value to be non-zero. The task does not consume any\r
* CPU time while it is in the Blocked state.\r
*\r
* Where as xTaskNotifyWait() will return when a notification is pending,\r
- * xTaskNotifyTake() will return when the task's notification value is\r
+ * ulTaskNotifyTake() will return when the task's notification value is\r
* not zero.\r
*\r
- * See http://www.FreeRTOS.org/RTOS_task_notifications.html for details of when\r
- * it is best to use a task notification to send an event to a task compared to\r
- * when it is best to use an intermediary object (such as a queue, semaphore,\r
- * mutex or event group) to send an event to a task.\r
+ * See http://www.FreeRTOS.org/RTOS-task-notifications.html for details.\r
*\r
* @param xClearCountOnExit if xClearCountOnExit is pdFALSE then the task's\r
* notification value is decremented when the function exits. In this way the\r
* @param xTicksToWait The maximum amount of time that the task should wait in\r
* the Blocked state for the task's notification value to be greater than zero,\r
* should the count not already be greater than zero when\r
- * xTaskNotifyTake() was called. The task will not consume any processing\r
+ * ulTaskNotifyTake() was called. The task will not consume any processing\r
* time while it is in the Blocked state. This is specified in kernel ticks,\r
* the macro pdMS_TO_TICSK( value_in_ms ) can be used to convert a time\r
* specified in milliseconds to a time specified in ticks.\r
projects / freertos / commitdiff