mcu/interface/service/kal/llist.h

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2012
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*******************************************************************************
 * Filename:
 * ---------
 *   llist.h
 *
 * Project:
 * --------
 *   MOLY
 *
 * Description:
 * ------------
 *
 *
 * Author:
 * -------
 * -------
 *   
 *
 * ==========================================================================
 * $Log$
 *
 * 07 26 2018 hubert.wang
 * [MOLY00342443] [KAL] Coding convention
 * 	
 * 	[KAL] Coding Convention
 *
 * 05 02 2018 hubert.wang
 * [MOLY00323821] [UMOLYE][LLIST] Add a new macro List_ForEachPrevSafe() for llist
 * 	
 * 	[UMOLYE][LLIST] Request by Aric Chiu
 *
 * 09 29 2017 tee-yuen.chun
 * [MOLY00281026] [Gen93][Mlib_dll] Remove llist.c and use Mlib_dll to implement llist
 * . Remove list.c and replace it with Mlib_dll
 ****************************************************************************/
/**
 *	@file  llist.h
 *	@brief high efficient doubly "embedded" linked-list implementation
 *
 *	@author Howard Chen, Moja Hsu ,HR Hsu
 *
 *	@date   2006 , 7
 *
 **/
#ifndef LLIST0630
#define LLIST0630

#include "mlib_dll.h"

/**
 *	@brief the embedded linked list
 */
typedef list_node llist_t;

#define LIST_Empty(ptr) ((ptr)->next == (ptr))

/**
 * @brief the llist_t initializator
 */
#define LIST_VALUE(name) \
    {                    \
        &(name), &(name) \
    }

/**
 * @brief the llist_t constructor
 */
#define LIST_Init(ptr) mlib_dll_insert_at_end(NULL, ptr)

/**
 * @brief Insert a _new entry after the specified head.
 * @param _new  _new entry to be added
 * @param head list head to add it after
 *
 */
#define LIST_Add(new_ptr, head_ptr) mlib_dll_insert_at_start(head_ptr, new_ptr)

/**
 * @brief Insert a _new entry before the specified head.
 * @param _new: _new entry to be added
 * @param head: list head to add it before
 *
 */
#define LIST_AddTail(new_ptr, head_ptr) mlib_dll_insert_at_end(head_ptr, new_ptr)

/**
* @brief deletes entry from list.
* @param entry: the element to delete from the list.
* @note: list_empty on entry does not return true after this, the entry is in an undefined state.
*/
#define LIST_Del(entry) mlib_dll_delete(NULL, entry)

/**
* @brief deletes entry from list and reinitialize it.
* @param entry: the element to delete from the list.
*/
#define LIST_DelInit(entry) \
    do {                    \
        LIST_Del(entry);    \
        LIST_Init(entry);   \
    } while (0)

/**
 * @brief get the struct for this entry
 * @param ptr		the &struct list_head pointer.
 * @param type 		the type of the struct this is embedded in.
 * @param member	the name of the list_struct within the struct.
 */
#define LIST_Entry(ptr, type, member) List2Container(ptr, type, member)

/**
 * @brief iterate over a list
 * @param pos	the &struct list_head to use as a loop counter.
 * @param head  the head for your list.
 */
#define LIST_ForEach(pos, head) \
    for (pos = (head)->next; pos != (head); pos = pos->next)

/**
 * @brief iterate over a list safe against removal of list entry
 * @param pos    	the &struct list_head to use as a loop counter.
 * @param n         another &struct list_head to use as temporary storage
 * @param head      the head for your list.
 */
#define LIST_ForEachSafe(pos, n, head) \
    for (pos = (head)->next, n = pos->next; pos != (head); pos = n, n = pos->next)

/**
 * @brief LIST_for_each_prev   -       iterate over a list in reverse order
 * @param pos	the &struct list_head to use as a loop counter.
 * @param head	the head for your list.
 */
#define LIST_ForEachPrev(pos, head) \
    for (pos = (head)->prev; pos != (head); pos = pos->prev)

/**
* @brief iterate over a list safe against removal of list entry
* @param pos     the &struct list_head to use as a loop counter.
* @param n         another &struct list_head to use as temporary storage
* @param head      the head for your list.
*/
#define LIST_ForEachPrevSafe(pos, n, head) \
    for (pos = (head)->prev, n = pos->prev; pos != (head); pos = n, n = pos->prev)

/**
 *  @brief Get the first of the linked list
 */
#define LIST_GetFirst(head, type, member) \
    (((head)->next != (head)) ? (LIST_Entry((head)->next, type, member)) : (NULL))


#endif