generic_list.h

Go to the documentation of this file.

/*
 * Copyright 2018-2020 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _GENERIC_LIST_H_
#define _GENERIC_LIST_H_
 
#include "fsl_common.h"
/*!*********************************************************************************
*************************************************************************************
* Include
*************************************************************************************
********************************************************************************** */
 
#ifndef GENERIC_LIST_LIGHT
#define GENERIC_LIST_LIGHT (0)
#endif
 
typedef enum _list_status
{
    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), 
    kLIST_NotSupport     = MAKE_STATUS(kStatusGroup_LIST, 5), 
} list_status_t;
 
typedef struct list_label
{
    struct list_element_tag *head; 
    struct list_element_tag *tail; 
    uint16_t size;                 
    uint16_t max;                  
} list_label_t, *list_handle_t;
#if (defined(GENERIC_LIST_LIGHT) && (GENERIC_LIST_LIGHT > 0U))
 
typedef struct list_element_tag
{
    struct list_element_tag *next; 
    struct list_label *list;       
} list_element_t, *list_element_handle_t;
#else
 
typedef struct list_element_tag
{
    struct list_element_tag *next; 
    struct list_element_tag *prev; 
    struct list_label *list;       
} list_element_t, *list_element_handle_t;
#endif
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif /* _cplusplus */
 
void LIST_Init(list_handle_t list, uint32_t max);
 
list_handle_t LIST_GetList(list_element_handle_t element);
 
list_status_t LIST_AddHead(list_handle_t list, list_element_handle_t element);
 
list_status_t LIST_AddTail(list_handle_t list, list_element_handle_t element);
 
list_element_handle_t LIST_RemoveHead(list_handle_t list);
 
list_element_handle_t LIST_GetHead(list_handle_t list);
 
list_element_handle_t LIST_GetNext(list_element_handle_t element);
 
list_element_handle_t LIST_GetPrev(list_element_handle_t element);
 
list_status_t LIST_RemoveElement(list_element_handle_t element);
 
list_status_t LIST_AddPrevElement(list_element_handle_t element, list_element_handle_t newElement);
 
uint32_t LIST_GetSize(list_handle_t list);
 
uint32_t LIST_GetAvailableSize(list_handle_t list);
 
/* @} */
 
#if defined(__cplusplus)
}
#endif
 
#endif /*_GENERIC_LIST_H_*/