AR Utility List - Qualcomm Dragonwing Documentation

Header: ar_util/api/ar_util_list.h

Structures

`ar_list_node_t`

Members

ar_list_t *

Indicates the last known list for which this node belonged.

ar_list_node_t *

The next node.

ar_list_node_t *

`ar_list_t`

Members

ar_list_node_t

A special dummy node to implement the NULL object pattern.

uint32_t

Optional, the user supplied lock implementation function.

ar_list_lock_enter_fn_t

optional, the user supplied unlock implementation function.

ar_list_lock_leave_fn_t

Enable secure linked list flag.

bool_t

Functions

`ar_list_init`

ar_list_init: initialize a list to itself.

int32_t ar_list_init(ar_list_t *list, ar_list_lock_enter_fn_t lock_fn, ar_list_lock_leave_fn_t unlock_fn)

Parameters

ar_list_t *

pointer to ar_list_t.

lock_fn: lock function pointer.

unlock_fn: unlock function pointer.

Returns 0 Success Nonzero Failure

`ar_list_init_node`

ar_list_init_node

int32_t ar_list_init_node(ar_list_node_t *node)

Parameters

ar_list_node_t *

pointer to ar_list_node_t.

Returns 0 Success Nonzero Failure

`ar_list_add_tail`

ar_list_add_tail

int32_t ar_list_add_tail(ar_list_t *list, ar_list_node_t *node)

Parameters

ar_list_t *

pointer to ar_list_t.

ar_list_node_t *

node to be added to the list.

Returns 0 Success Nonzero Failure

`ar_list_remove_head`

ar_list_remove_head

int32_t ar_list_remove_head(ar_list_t *list, ar_list_node_t **ret_node)

Parameters

ar_list_t *

pointer to ar_list_t.

Returns 0 Success Nonzero Failure

`ar_list_delete`

ar_list_delete

int32_t ar_list_delete(ar_list_t *list, ar_list_node_t *node)

Parameters

ar_list_t *

pointer to ar_list_t.

ar_list_node_t *

pointer to node to be deleted.

Returns 0 Success Nonzero Failure

`ar_list_clear`

ar_list_clear

int32_t ar_list_clear(ar_list_t *list)

Parameters

ar_list_t *

pointer to ar_list_t.

Returns 0 Success Nonzero Failure

`ar_list_is_empty`

ar_list_is_empty: check if the list is empty.

int32_t ar_list_is_empty(ar_list_t *list)

Parameters

ar_list_t *

pointer to ar_list_t.

Returns 1 if the list is empty 0 otherwise

`ar_list_get_head`

ar_list_get_head: return the head node from list.

ar_list_node_t * ar_list_get_head(ar_list_t *list)

Parameters

ar_list_t *

pointer to ar_list_t.

Returns address of head node

`ar_list_get_tail`

ar_list_get_tail: return the tail node from list.

ar_list_node_t * ar_list_get_tail(ar_list_t *list)

Parameters

ar_list_t *

pointer to ar_list_t.

Returns address of tail node

Type Definitions

`ar_list_node_t`

typedef struct ar_list_node_t ar_list_node_t

`ar_list_t`

typedef struct ar_list_t ar_list_t

`ar_list_lock_enter_fn_t`

typedef void(* ar_list_lock_enter_fn_t

`ar_list_lock_leave_fn_t`

typedef void(* ar_list_lock_leave_fn_t

Macros

`ar_list_for_each_entry`

ar_list_for_each_entry: iterate over list

#define ar_list_for_each_entry for (iter = (list)->dummy.next; \
	iter != &((list)->dummy); iter = iter->next)

​Structures

​ar_list_node_t

​ar_list_t

​Functions

​ar_list_init

​ar_list_init_node

​ar_list_add_tail

​ar_list_remove_head

​ar_list_delete

​ar_list_clear

​ar_list_is_empty

​ar_list_get_head

​ar_list_get_tail

​Type Definitions

​ar_list_node_t

​ar_list_t

​ar_list_lock_enter_fn_t

​ar_list_lock_leave_fn_t

​Macros

​ar_list_for_each_entry

Structures

`ar_list_node_t`

`ar_list_t`

Functions

`ar_list_init`

`ar_list_init_node`

`ar_list_add_tail`

`ar_list_remove_head`

`ar_list_delete`

`ar_list_clear`

`ar_list_is_empty`

`ar_list_get_head`

`ar_list_get_tail`

Type Definitions

`ar_list_node_t`

`ar_list_t`

`ar_list_lock_enter_fn_t`

`ar_list_lock_leave_fn_t`

Macros

`ar_list_for_each_entry`