MCUXpresso SDK API Reference Manual
Rev. 0
NXP Semiconductors
|
Data Structures | |
struct | list_handle_t |
The list structure. More... | |
struct | list_element_handle_t |
The list element. More... | |
Enumerations | |
enum | list_status_t { kLIST_Ok = kStatus_Success, kLIST_DuplicateError = MAKE_STATUS(kStatusGroup_LIST, 1), kLIST_Full = MAKE_STATUS(kStatusGroup_LIST, 2), kLIST_Empty = MAKE_STATUS(kStatusGroup_LIST, 3), kLIST_OrphanElement = MAKE_STATUS(kStatusGroup_LIST, 4) } |
More... | |
Functions | |
void | LIST_Init (list_handle_t list, uint32_t max) |
More... | |
list_handle_t | LIST_GetList (list_element_handle_t element) |
Gets the list that contains the given element. More... | |
list_status_t | LIST_AddHead (list_handle_t list, list_element_handle_t element) |
Links element to the head of the list. More... | |
list_status_t | LIST_AddTail (list_handle_t list, list_element_handle_t element) |
Links element to the tail of the list. More... | |
list_element_handle_t | LIST_RemoveHead (list_handle_t list) |
Unlinks element from the head of the list. More... | |
list_element_handle_t | LIST_GetHead (list_handle_t list) |
Gets head element handle. More... | |
list_element_handle_t | LIST_GetNext (list_element_handle_t element) |
Gets next element handle for given element handle. More... | |
list_element_handle_t | LIST_GetPrev (list_element_handle_t element) |
Gets previous element handle for given element handle. More... | |
list_status_t | LIST_RemoveElement (list_element_handle_t element) |
Unlinks an element from its list. More... | |
list_status_t | LIST_AddPrevElement (list_element_handle_t element, list_element_handle_t newElement) |
Links an element in the previous position relative to a given member of a list. More... | |
uint32_t | LIST_GetSize (list_handle_t list) |
Gets the current size of a list. More... | |
uint32_t | LIST_GetAvailableSize (list_handle_t list) |
Gets the number of free places in the list. More... | |
struct list_label_t |
struct list_element_t |
enum list_status_t |
void LIST_Init | ( | list_handle_t | list, |
uint32_t | max | ||
) |
Public prototypes
Initialize the list.
This function initialize the list.
list | - List handle to initialize. |
max | - Maximum number of elements in list. 0 for unlimited. |
list_handle_t LIST_GetList | ( | list_element_handle_t | element | ) |
element | - Handle of the element. |
NULL | if element is orphan, Handle of the list the element is inserted into. |
list_status_t LIST_AddHead | ( | list_handle_t | list, |
list_element_handle_t | element | ||
) |
list | - Handle of the list. |
element | - Handle of the element. |
kLIST_Full | if list is full, kLIST_Ok if insertion was successful. |
list_status_t LIST_AddTail | ( | list_handle_t | list, |
list_element_handle_t | element | ||
) |
list | - Handle of the list. |
element | - Handle of the element. |
kLIST_Full | if list is full, kLIST_Ok if insertion was successful. |
list_element_handle_t LIST_RemoveHead | ( | list_handle_t | list | ) |
list | - Handle of the list. |
NULL | if list is empty, handle of removed element(pointer) if removal was successful. |
list_element_handle_t LIST_GetHead | ( | list_handle_t | list | ) |
list | - Handle of the list. |
NULL | if list is empty, handle of removed element(pointer) if removal was successful. |
list_element_handle_t LIST_GetNext | ( | list_element_handle_t | element | ) |
element | - Handle of the element. |
NULL | if list is empty, handle of removed element(pointer) if removal was successful. |
list_element_handle_t LIST_GetPrev | ( | list_element_handle_t | element | ) |
element | - Handle of the element. |
NULL | if list is empty, handle of removed element(pointer) if removal was successful. |
list_status_t LIST_RemoveElement | ( | list_element_handle_t | element | ) |
element | - Handle of the element. |
kLIST_OrphanElement | if element is not part of any list. |
kLIST_Ok | if removal was successful. |
list_status_t LIST_AddPrevElement | ( | list_element_handle_t | element, |
list_element_handle_t | newElement | ||
) |
element | - Handle of the element. |
newElement | - New element to insert before the given member. |
kLIST_OrphanElement | if element is not part of any list. |
kLIST_Ok | if removal was successful. |
uint32_t LIST_GetSize | ( | list_handle_t | list | ) |
list | - Handle of the list. |
Current | size of the list. |
uint32_t LIST_GetAvailableSize | ( | list_handle_t | list | ) |
list | - Handle of the list. |
Available | size of the list. |