AM263Px MCU+ SDK: QueueP.h Source File

| AM263Px MCU+ SDK 26.00.00 |

QueueP.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2018-2021 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef QUEUEP_H
34 #define QUEUEP_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include <stdint.h>
41 #include <kernel/dpl/SystemP.h>
42
58 #define QueueP_OBJECT_SIZE_MAX (8u)
59 #define QueueP_NOTEMPTY (0U)
60 #define QueueP_EMPTY (1U)
61
70 typedef struct QueueP_Elem_s{
72 struct QueueP_Elem_s *next;
73
75 struct QueueP_Elem_s *prev;
76 } QueueP_Elem;
77
81 typedef struct QueueP_Object_ {
82 QueueP_Elem queueHndl;
83 } QueueP_Object;
84
85
92 typedef QueueP_Object *QueueP_Handle;
93
101 QueueP_Handle QueueP_create(QueueP_Object *obj);
102
112 int32_t QueueP_delete(QueueP_Handle handle);
113
123 void * QueueP_get(QueueP_Handle handle);
124
136 int32_t QueueP_put(QueueP_Handle handle,
137 void *elem);
138
148 uint32_t QueueP_isEmpty(QueueP_Handle handle);
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif /* ti_osal_QueueP__include */
155
QueueP_Object::queueHndl
QueueP_Elem queueHndl
Definition: QueueP.h:82
QueueP_Elem
Opaque QueueP element.
Definition: QueueP.h:70
QueueP_create
QueueP_Handle QueueP_create(QueueP_Object *obj)
Function to create a queue.
SystemP.h
QueueP_Handle
QueueP_Object * QueueP_Handle
Opaque client reference to an instance of a QueueP.
Definition: QueueP.h:92
QueueP_Elem::prev
struct QueueP_Elem_s * prev
Definition: QueueP.h:75
QueueP_isEmpty
uint32_t QueueP_isEmpty(QueueP_Handle handle)
Function to perform queue empty check.
QueueP_put
int32_t QueueP_put(QueueP_Handle handle, void *elem)
Function to Put an element at end of queue.
QueueP_Elem::next
struct QueueP_Elem_s * next
Definition: QueueP.h:72
QueueP_Object
Opaque task object used with the task APIs.
Definition: QueueP.h:81
QueueP_delete
int32_t QueueP_delete(QueueP_Handle handle)
Function to delete a queue.
QueueP_get
void * QueueP_get(QueueP_Handle handle)
Function to Get the element at the front of the queue. This function removes an element from the fron...