list.h File Reference

Data Structures
struct	ListItem_t
struct	MiniListItem_t
struct	List_t

Macros
#define	configLIST_VOLATILE
#define	listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE
#define	listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE
#define	listFIRST_LIST_INTEGRITY_CHECK_VALUE
#define	listSECOND_LIST_INTEGRITY_CHECK_VALUE
#define	listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE(pxItem)
#define	listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE(pxItem)
#define	listSET_LIST_INTEGRITY_CHECK_1_VALUE(pxList)
#define	listSET_LIST_INTEGRITY_CHECK_2_VALUE(pxList)
#define	listTEST_LIST_ITEM_INTEGRITY(pxItem)
#define	listTEST_LIST_INTEGRITY(pxList)
#define	listSET_LIST_ITEM_OWNER(pxListItem, pxOwner)
#define	listGET_LIST_ITEM_OWNER(pxListItem)
#define	listSET_LIST_ITEM_VALUE(pxListItem, xValue)
#define	listGET_LIST_ITEM_VALUE(pxListItem)
#define	listGET_ITEM_VALUE_OF_HEAD_ENTRY(pxList)
#define	listGET_HEAD_ENTRY(pxList)
#define	listGET_NEXT(pxListItem)
#define	listGET_END_MARKER(pxList)
#define	listLIST_IS_EMPTY(pxList)
#define	listCURRENT_LIST_LENGTH(pxList)
#define	listGET_OWNER_OF_NEXT_ENTRY(pxTCB, pxList)
#define	listGET_OWNER_OF_HEAD_ENTRY(pxList)
#define	listIS_CONTAINED_WITHIN(pxList, pxListItem)
#define	listLIST_ITEM_CONTAINER(pxListItem)
#define	listLIST_IS_INITIALISED(pxList)

Functions
void	vListInitialise (List_t *const pxList) PRIVILEGED_FUNCTION
void	vListInitialiseItem (ListItem_t *const pxItem) PRIVILEGED_FUNCTION
void	vListInsert (List_t *const pxList, ListItem_t *const pxNewListItem) PRIVILEGED_FUNCTION
void	vListInsertEnd (List_t *const pxList, ListItem_t *const pxNewListItem) PRIVILEGED_FUNCTION
UBaseType_t	uxListRemove (ListItem_t *const pxItemToRemove) PRIVILEGED_FUNCTION

Macro Definition Documentation

#define configLIST_VOLATILE

#define listCURRENT_LIST_LENGTH

(

pxList

)

Referenced by portTASK_FUNCTION(), vEventGroupDelete(), and xTaskIncrementTick().

#define listFIRST_LIST_INTEGRITY_CHECK_VALUE

#define listFIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE

#define listGET_END_MARKER

(

pxList

)

Referenced by xEventGroupSetBits().

#define listGET_HEAD_ENTRY

(

pxList

)

Referenced by xEventGroupSetBits().

#define listGET_ITEM_VALUE_OF_HEAD_ENTRY

(

pxList

)

#define listGET_LIST_ITEM_OWNER

(

pxListItem

)

Referenced by vTaskRemoveFromUnorderedEventList().

#define listGET_LIST_ITEM_VALUE

(

pxListItem

)

Referenced by prvResetNextTaskUnblockTime(), uxTaskResetEventItemValue(), xEventGroupSetBits(), and xTaskIncrementTick().

#define listGET_NEXT

(

pxListItem

)

Referenced by xEventGroupSetBits().

#define listGET_OWNER_OF_HEAD_ENTRY

(

pxList

)

Referenced by prvCheckTasksWaitingTermination(), prvResetNextTaskUnblockTime(), xTaskIncrementTick(), xTaskRemoveFromEventList(), and xTaskResumeAll().

#define listGET_OWNER_OF_NEXT_ENTRY	(		pxTCB,
			pxList
	)

#define listIS_CONTAINED_WITHIN	(		pxList,
			pxListItem
	)

#define listLIST_IS_EMPTY

(

pxList

)

Referenced by prvResetNextTaskUnblockTime(), prvUnlockQueue(), xQueueGenericReset(), xQueueGenericSend(), xQueueGenericSendFromISR(), xQueueGiveFromISR(), xQueuePeek(), xQueueReceive(), xQueueReceiveFromISR(), xQueueSemaphoreTake(), xTaskIncrementTick(), and xTaskResumeAll().

#define listLIST_IS_INITIALISED

(

pxList

)

#define listLIST_ITEM_CONTAINER

(

pxListItem

)

Referenced by xTaskIncrementTick().

#define listSECOND_LIST_INTEGRITY_CHECK_VALUE

#define listSECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE

#define listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE

(

pxItem

)

Referenced by vListInitialiseItem().

#define listSET_LIST_INTEGRITY_CHECK_1_VALUE

(

pxList

)

Referenced by vListInitialise().

#define listSET_LIST_INTEGRITY_CHECK_2_VALUE

(

pxList

)

Referenced by vListInitialise().

#define listSET_LIST_ITEM_OWNER	(		pxListItem,
			pxOwner
	)

#define listSET_LIST_ITEM_VALUE	(		pxListItem,
			xValue
	)

Referenced by prvAddCurrentTaskToDelayedList(), uxTaskResetEventItemValue(), vTaskPlaceOnUnorderedEventList(), and vTaskRemoveFromUnorderedEventList().

#define listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE

(

pxItem

)

Referenced by vListInitialiseItem().

#define listTEST_LIST_INTEGRITY

(

pxList

)

Referenced by vListInsert(), and vListInsertEnd().

#define listTEST_LIST_ITEM_INTEGRITY

(

pxItem

)

Referenced by vListInsert(), and vListInsertEnd().

Function Documentation

UBaseType_t uxListRemove

(

ListItem_t *const

pxItemToRemove

)

References mtCOVERAGE_TEST_DELAY, mtCOVERAGE_TEST_MARKER, List_t::pxIndex, and List_t::uxNumberOfItems.

Referenced by prvAddCurrentTaskToDelayedList(), prvCheckTasksWaitingTermination(), vTaskRemoveFromUnorderedEventList(), xTaskIncrementTick(), xTaskRemoveFromEventList(), and xTaskResumeAll().

void vListInitialise

(

List_t *const

pxList

)

References listSET_LIST_INTEGRITY_CHECK_1_VALUE, listSET_LIST_INTEGRITY_CHECK_2_VALUE, portMAX_DELAY, List_t::pxIndex, List_t::uxNumberOfItems, and List_t::xListEnd.

Referenced by prvInitialiseTaskLists(), and xQueueGenericReset().

void vListInitialiseItem

(

ListItem_t *const

pxItem

)

References listSET_FIRST_LIST_ITEM_INTEGRITY_CHECK_VALUE, and listSET_SECOND_LIST_ITEM_INTEGRITY_CHECK_VALUE.

void vListInsert	(	List_t *const	pxList,
		ListItem_t *const	pxNewListItem
	)

References listTEST_LIST_INTEGRITY, listTEST_LIST_ITEM_INTEGRITY, portMAX_DELAY, List_t::uxNumberOfItems, and List_t::xListEnd.

Referenced by prvAddCurrentTaskToDelayedList(), and vTaskPlaceOnEventList().

void vListInsertEnd	(	List_t *const	pxList,
		ListItem_t *const	pxNewListItem
	)

References listTEST_LIST_INTEGRITY, listTEST_LIST_ITEM_INTEGRITY, mtCOVERAGE_TEST_DELAY, List_t::pxIndex, and List_t::uxNumberOfItems.

Referenced by prvAddCurrentTaskToDelayedList(), vTaskPlaceOnUnorderedEventList(), and xTaskRemoveFromEventList().