qdf/linux/src/i_qdf_list.h

/*
 * Copyright (c) 2014-2016, 2018 The Linux Foundation. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/**
 * DOC: i_qdf_list.h
 * This file provides OS dependent list API's.
 */

#if !defined(__I_QDF_LIST_H)
#define __I_QDF_LIST_H

#include <linux/list.h>

/* Type declarations */
typedef struct list_head __qdf_list_node_t;

/* Preprocessor definitions and constants */

typedef struct qdf_list_s {
	__qdf_list_node_t anchor;
	uint32_t count;
	uint32_t max_size;
} __qdf_list_t;

/**
 * __qdf_list_create() - Create qdf list and initialize list head
 * @list: object of list
 * @max_size: max size of the list
 *
 * Return: none
 */
static inline void __qdf_list_create(__qdf_list_t *list, uint32_t max_size)
{
	INIT_LIST_HEAD(&list->anchor);
	list->count = 0;
	list->max_size = max_size;
}

/**
 * __qdf_list_size() - gives the size of the list
 * @list: object of list
 * Return: size of the list
 */
static inline uint32_t __qdf_list_size(__qdf_list_t *list)
{
	return list->count;
}

/**
 * __qdf_list_max_size() - gives the max size of the list
 * @list: object of list
 * Return: max size of the list
 */
static inline uint32_t __qdf_list_max_size(__qdf_list_t *list)
{
	return list->max_size;
}

#define __QDF_LIST_ANCHOR(list) ((list).anchor)

#define __QDF_LIST_NODE_INIT(prev_node, next_node) \
	{ .prev = &(prev_node), .next = &(next_node), }

#define __QDF_LIST_NODE_INIT_SINGLE(node) \
	__QDF_LIST_NODE_INIT(node, node)

#define __QDF_LIST_INIT(tail, head) \
	{ .anchor = __QDF_LIST_NODE_INIT(tail, head), }

#define __QDF_LIST_INIT_SINGLE(node) \
	__QDF_LIST_INIT(node, node)

#define __QDF_LIST_INIT_EMPTY(list) \
	__QDF_LIST_INIT_SINGLE(list.anchor)

#define __qdf_list_for_each(list_ptr, cursor, node_field) \
	list_for_each_entry(cursor, &(list_ptr)->anchor, node_field)

#define __qdf_list_for_each_del(list_ptr, cursor, next, node_field) \
	list_for_each_entry_safe(cursor, next, &(list_ptr)->anchor, node_field)

/**
 * __qdf_init_list_head() - initialize list head
 * @list_head: pointer to list head
 *
 * Return: none
 */
static inline void __qdf_init_list_head(__qdf_list_node_t *list_head)
{
	INIT_LIST_HEAD(list_head);
}
#endif