LIFO APIs

Macros
#define	k_lifo_init(lifo)
	Initialize a LIFO queue.
#define	k_lifo_put(lifo, data)
	Add an element to a LIFO queue.
#define	k_lifo_alloc_put(lifo, data)
	Add an element to a LIFO queue.
#define	k_lifo_get(lifo, timeout)
	Get an element from a LIFO queue.
#define	K_LIFO_DEFINE(name)
	Statically define and initialize a LIFO queue.

Detailed Description

Macro Definition Documentation

k_lifo_alloc_put

#define k_lifo_alloc_put	(		lifo,
			data
	)

#include <zephyr/kernel.h>

Value:

        ({ \
        SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, data); \
        int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, data); \
        SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, data, lap_ret); \
        lap_ret; \
        })

Add an element to a LIFO queue.

This routine adds a data item to lifo. There is an implicit memory allocation to create an additional temporary bookkeeping data structure from the calling thread's resource pool, which is automatically freed when the item is removed. The data itself is not copied.

Function properties (list may not be complete)

isr-ok

Parameters

lifo	Address of the LIFO.
data	Address of the data item.

Return values

0	on success
-ENOMEM	if there isn't sufficient RAM in the caller's resource pool

K_LIFO_DEFINE

#define K_LIFO_DEFINE

(

name

)

#include <zephyr/kernel.h>

Value:

        STRUCT_SECTION_ITERABLE(k_lifo, name) = \
                Z_LIFO_INITIALIZER(name)

Statically define and initialize a LIFO queue.

The LIFO queue can be accessed outside the module where it is defined using:

extern struct k_lifo <name>; 

Parameters

name	Name of the fifo.

k_lifo_get

#define k_lifo_get	(		lifo,
			timeout
	)

#include <zephyr/kernel.h>

Value:

        ({ \
        SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
        void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
        SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
        lg_ret; \
        })

Get an element from a LIFO queue.

This routine removes a data item from LIFO in a "last in, first out" manner. The first word of the data item is reserved for the kernel's use.

Note

timeout must be set to K_NO_WAIT if called from ISR.

Function properties (list may not be complete)

isr-ok

Parameters

lifo	Address of the LIFO queue.
timeout	Waiting period to obtain a data item, or one of the special values K_NO_WAIT and K_FOREVER.

Returns

Address of the data item if successful; NULL if returned without waiting, or waiting period timed out.

k_lifo_init

#define k_lifo_init

(

lifo

)

#include <zephyr/kernel.h>

Value:

        ({                                                   \
        SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
        k_queue_init(&(lifo)->_queue);                       \
        K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo);   \
        K_OBJ_CORE_LINK(K_OBJ_CORE(lifo));                   \
        SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo);  \
        })

Initialize a LIFO queue.

This routine initializes a LIFO queue object, prior to its first use.

Parameters

lifo	Address of the LIFO queue.

k_lifo_put

#define k_lifo_put	(		lifo,
			data
	)

#include <zephyr/kernel.h>

Value:

        ({ \
        SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, data); \
        k_queue_prepend(&(lifo)->_queue, data); \
        SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, data); \
        })

Add an element to a LIFO queue.

This routine adds a data item to lifo. A LIFO queue data item must be aligned on a word boundary, and the first word of the item is reserved for the kernel's use.

Function properties (list may not be complete)

isr-ok

Parameters

lifo	Address of the LIFO queue.
data	Address of the data item.