Queue.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, Texas Instruments Incorporated - http://www.ti.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
/*
 * ======== Queue.h ========
 */

#ifndef ti_sysbios_knl_Queue__include
#define ti_sysbios_knl_Queue__include

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/runtime/Error.h>

/* @cond NODOC */
#define ti_sysbios_knl_Queue_long_names
#include "Queue_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

typedef struct Queue_Elem {
    struct Queue_Elem *volatile next;
    struct Queue_Elem *volatile prev;
} Queue_Elem;

typedef Queue_Elem Queue_Struct;
typedef Queue_Struct Queue_Object;
typedef Queue_Struct *Queue_Handle;

typedef struct {
    uint32_t dummy;    /* to make IAR happy */
} Queue_Params;

extern void Queue_Instance_init(Queue_Object *obj, const Queue_Params *prms);
extern Queue_Handle Queue_create(const Queue_Params *prms, Error_Block *eb);

extern Queue_Handle Queue_construct(Queue_Struct *obj, const Queue_Params *prms);

extern void Queue_delete(Queue_Handle *queue);

extern void Queue_destruct(Queue_Struct *obj);

extern void Queue_Params_init(Queue_Params *prms);

extern void Queue_elemClear(Queue_Elem *qelem);
extern void Queue_insert(Queue_Elem *qelem, Queue_Elem *elem);

extern void * Queue_next(Queue_Elem *qelem);

extern void * Queue_prev(Queue_Elem *qelem);

extern void Queue_remove(Queue_Elem *qelem);

extern bool Queue_isQueued(Queue_Elem *qelem);
extern void * Queue_dequeue(Queue_Handle queue);

extern bool Queue_empty(Queue_Handle queue);

extern void Queue_enqueue(Queue_Handle queue, Queue_Elem *elem);

extern void * Queue_get(Queue_Handle queue);

extern void * Queue_getTail(Queue_Handle queue);

extern void * Queue_head(Queue_Handle queue);

extern void Queue_put(Queue_Handle queue, Queue_Elem *elem);

extern void Queue_putHead(Queue_Handle queue, Queue_Elem *elem);

static inline Queue_Handle Queue_handle(Queue_Struct *str)
{  
    return ((Queue_Handle)str);
}

static inline Queue_Struct * Queue_struct(Queue_Handle handle)
{  
    return ((Queue_Struct *)handle);
}
#ifdef __cplusplus
}
#endif
#endif /* ti_sysbios_knl_Queue__include */

/* @cond NODOC */
#undef ti_sysbios_knl_Queue_long_names
#include "Queue_defs.h"