TIOVX User Guide
tivx_obj_desc_queue.h
Go to the documentation of this file.
1 /*
2 *
3 * Copyright (c) 2018 Texas Instruments Incorporated
4 *
5 * All rights reserved not granted herein.
6 *
7 * Limited License.
8 *
9 * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10 * license under copyrights and patents it now or hereafter owns or controls to make,
11 * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12 * terms herein. With respect to the foregoing patent license, such license is granted
13 * solely to the extent that any such patent is necessary to Utilize the software alone.
14 * The patent license shall not apply to any combinations which include this software,
15 * other than combinations with devices manufactured by or for TI ("TI Devices").
16 * No hardware patent is licensed hereunder.
17 *
18 * Redistributions must preserve existing copyright notices and reproduce this license
19 * (including the above copyright notice and the disclaimer and (if applicable) source
20 * code license limitations below) in the documentation and/or other materials provided
21 * with the distribution
22 *
23 * Redistribution and use in binary form, without modification, are permitted provided
24 * that the following conditions are met:
25 *
26 * * No reverse engineering, decompilation, or disassembly of this software is
27 * permitted with respect to any software provided in binary form.
28 *
29 * * any redistribution and use are licensed by TI for use only with TI Devices.
30 *
31 * * Nothing shall obligate TI to provide you with source code for the software
32 * licensed and provided to you in object code.
33 *
34 * If software source code is provided to you, modification and redistribution of the
35 * source code are permitted provided that the following conditions are met:
36 *
37 * * any redistribution and use of the source code, including any resulting derivative
38 * works, are licensed by TI for use only with TI Devices.
39 *
40 * * any redistribution and use of any object code compiled from the source code
41 * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42 *
43 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44 *
45 * may be used to endorse or promote products derived from this software without
46 * specific prior written permission.
47 *
48 * DISCLAIMER.
49 *
50 * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53 * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59 * OF THE POSSIBILITY OF SUCH DAMAGE.
60 *
61 */
62 
63 
64 
65 
66 #ifndef TIVX_OBJ_DESC_QUEUE_H_
67 #define TIVX_OBJ_DESC_QUEUE_H_
68 
69 
70 #ifdef __cplusplus
71 extern "C" {
72 #endif
73 
87 vx_status ownObjDescQueueCreate(uint16_t *obj_desc_id);
88 
94 vx_status ownObjDescQueueRelease(uint16_t *obj_desc_id);
95 
96 
102 vx_status ownObjDescQueueEnqueue(uint16_t obj_desc_q_id, uint16_t obj_desc_id);
103 
109 vx_status ownObjDescQueueGetCount(uint16_t obj_desc_q_id, uint32_t *count);
110 
116 vx_status ownObjDescQueueDequeue(uint16_t obj_desc_q_id, uint16_t *obj_desc_id);
117 
123 vx_status ownObjDescQueueAddBlockedNode(uint16_t obj_desc_q_id, uint16_t node_id);
124 
133 vx_status ownObjDescQueueExtractBlockedNodes(uint16_t obj_desc_q_id,
134  tivx_obj_desc_queue_blocked_nodes_t *out_blocked_nodes);
135 
136 #ifdef __cplusplus
137 }
138 #endif
139 
140 #endif
vx_status ownObjDescQueueEnqueue(uint16_t obj_desc_q_id, uint16_t obj_desc_id)
Enqueue a obj_desc_id into a object descriptor queue.
vx_enum vx_status
vx_status ownObjDescQueueGetCount(uint16_t obj_desc_q_id, uint32_t *count)
Get number of elements in a object descriptor queue.
vx_status ownObjDescQueueAddBlockedNode(uint16_t obj_desc_q_id, uint16_t node_id)
Add 'node_id' to a list of blocked nodes associated with this object descriptor ID.
vx_status ownObjDescQueueExtractBlockedNodes(uint16_t obj_desc_q_id, tivx_obj_desc_queue_blocked_nodes_t *out_blocked_nodes)
Extract nodes blocked on this object descriptor queue ID.
Data structure to get information about node blocked on this object descriptor to be ready...
vx_status ownObjDescQueueCreate(uint16_t *obj_desc_id)
Create a object descriptor queue and return its obj_desc_id.
vx_status ownObjDescQueueDequeue(uint16_t obj_desc_q_id, uint16_t *obj_desc_id)
Dequeue a obj_desc_id from a object descriptor queue.
vx_status ownObjDescQueueRelease(uint16_t *obj_desc_id)
Release a object descriptor queue.