AM65x MCU+ SDK  09.01.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_NOTEMPTY (0U)
59 #define QueueP_EMPTY (1U)
60 
68 typedef void *QueueP_Handle;
69 
77 typedef struct QueueP_Elem_s{
79  struct QueueP_Elem_s *next;
80 
82  struct QueueP_Elem_s *prev;
83 } QueueP_Elem;
84 
88 #define QueueP_OBJECT_SIZE_MAX (8u)
89 
92 typedef struct QueueP_Object_ {
93 
94  /* uintptr_t translates to uint64_t for A53 and uint32_t for R5 and M4 */
95  /* This accounts for the 64bit pointer in A53 and 32bit pointer in R5 and M4 */
96  uintptr_t rsv[QueueP_OBJECT_SIZE_MAX/sizeof(uint32_t)];
99 
108 
118 int32_t QueueP_delete(QueueP_Handle handle);
119 
129 void * QueueP_get(QueueP_Handle handle);
130 
142 int32_t QueueP_put(QueueP_Handle handle,
143  void *elem);
144 
154 uint32_t QueueP_isEmpty(QueueP_Handle handle);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* ti_osal_QueueP__include */
161 
QueueP_Elem
Opaque QueueP element.
Definition: QueueP.h:77
QueueP_create
QueueP_Handle QueueP_create(QueueP_Object *obj)
Function to create a queue.
SystemP.h
QueueP_Elem::prev
struct QueueP_Elem_s * prev
Definition: QueueP.h:82
QueueP_OBJECT_SIZE_MAX
#define QueueP_OBJECT_SIZE_MAX
Max size of task object across all OS's.
Definition: QueueP.h:88
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:79
QueueP_Object
Opaque task object used with the task APIs.
Definition: QueueP.h:92
QueueP_delete
int32_t QueueP_delete(QueueP_Handle handle)
Function to delete a queue.
QueueP_Handle
void * QueueP_Handle
Opaque client reference to an instance of a QueueP.
Definition: QueueP.h:68
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...