summaryrefslogtreecommitdiffstats
blob: f17422e5457403d0a70f2565a307caf9a812dd95 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/*
 * Copyright (c) 2013, Texas Instruments Incorporated
 * 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.
 */

#ifndef __LIBDCE_H__
#define __LIBDCE_H__

#define xdc_target_types__ gnu/targets/std.h
#include <xdc/std.h>
#include <ti/sdo/ce/Engine.h>
#include <ti/sdo/ce/video3/viddec3.h>
#include <ti/sdo/ce/video2/videnc2.h>
#include <ti/sdo/ce/video2/viddec2.h>

#if defined(BUILDOS_LINUX)
/* avoid some messy stuff in xdc/std.h which leads to gcc issues */
#define xdc__ARGTOPTR
#define xdc__ARGTOFXN
#endif /* BUILDOS_LINUX */

/********************************** DCE Error Types **********************************/
typedef enum dce_error_status {
    DCE_EOK = 0,
    DCE_EXDM_FAIL = -1,
    DCE_EOUT_OF_MEMORY = -2,
    DCE_EXDM_UNSUPPORTED = -3,
    DCE_EIPC_CREATE_FAIL = -4,
    DCE_EIPC_CALL_FAIL = -5,
    DCE_EINVALID_INPUT = -6,
    DCE_EOMAPDRM_FAIL = -7
} dce_error_status;


typedef enum rproc_info_type {
    RPROC_CPU_LOAD = 0,
    RPROC_TOTAL_HEAP_SIZE = 1,
    RPROC_AVAILABLE_HEAP_SIZE = 2
} rproc_info_type;

/***************************** Memory Allocation/Free APIs *****************************/
/*=====================================================================================*/
/** dce_alloc               : Allocate the Data structures passed to codec-engine APIs
 *                            except Input/Output buffers. This should be used for all
 *                            Parameter allocation needed for IPU remote proc.
 *
 * @ param sz    [in]       : Size of memory to be allocated.
 * @ return                 : Pointer to allocated memory.
 */
void *dce_alloc(int sz);

/*=====================================================================================*/
/** dsp_dce_alloc            : Allocate the Data structures passed to codec-engine APIs
 *                             except Input/Output buffers. This should be used for all
 *                             Parameter allocation needed for DSP remote proc.
 *
 * @ param sz    [in]       : Size of memory to be allocated.
 * @ return                 : Pointer to allocated memory.
 */
void *dsp_dce_alloc(int sz);

/*=====================================================================================*/
/** dce_free                : Free the Data structures passed to codec-engine APIs
 *                             except Input/Output buffers.
 *
 * @ param ptr   [in]       : Memory allocated by dce_alloc.
 */
void dce_free(void *ptr);

/*=====================================================================================*/
/** dsp_dce_free            : Free the memory
 *
 * @ param ptr   [in]       : memory allocated by dsp_dce_alloc .
 */
void dsp_dce_free(void *ptr);


/*********************************** APIs for Linux ***********************************/
/************************ Initialization/Deinitialization APIs ************************/
/*=====================================================================================*/
/** dce_init                : Initialize DCE. Only Linux applications are expected to call.
 *
 * @ return                 : Pointer to omap_device structure.
 */
void *dce_init(void);

/*===============================================================*/
/** dce_deinit          : Deinitialize DCE . Only Linux applications are expected to call.
 *
 * @ param dev    [in]      : Pointer to omap_device structure.
 */
void dce_deinit(void *dev);


/** dce_ipc_init            : Initialize DCE IPC. this is required to setup mmRpc link.
 *
 * @ return                 : Error code.
 */
int dce_ipc_init(int core);

/*===============================================================*/
/** dce_ipc_deinit          : Deinitialize DCE IPC.
 *
 * @ param dev    [in]      : Core ID and engine Table Idx, or -1 if no engine exists
 */
void dce_ipc_deinit(int core, int tableIdx);

/************************ Input/Output Buffer Lock/Unlock APIs ************************/
/*=====================================================================================*/
/** dce_buf_lock            : Pin or lock Tiler Buffers which would be used by the IVAHD codec
 *                            as reference buffers. API is specific to GLP.
 *
 * @ param num    [in]      : Number of buffers to be locked.
 * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
 * @ return                 : DCE error status is returned.
 */
int dce_buf_lock(int num, size_t *handle);

/*=====================================================================================*/
/** dce_buf_unlock          : Unpin or unlock Tiler Buffers which were locked to be used
 *                            by the IVAHD codec as reference buffers. API is specific to GLP.
 *
 * @ param num    [in]      : Number of buffers to be locked.
 * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
 * @ return                 : DCE error status is returned.
 */
int dce_buf_unlock(int num, size_t *handle);
/************************ Input/Output Buffer Lock/Unlock APIs ************************/
/*=====================================================================================*/
/** dsp_dce_buf_lock            : Pin or lock Tiler Buffers which would be used by the DSP codec
 *                            as reference buffers. API is specific to GLP.
 *
 * @ param num    [in]      : Number of buffers to be locked.
 * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
 * @ return                 : DCE error status is returned.
 */
int dsp_dce_buf_lock(int num, size_t *handle);

/*=====================================================================================*/
/** dsp_dce_buf_unlock          : Unpin or unlock Tiler Buffers which were locked to be used
 *                            by the DSP codec as reference buffers. API is specific to GLP.
 *
 * @ param num    [in]      : Number of buffers to be locked.
 * @ param handle [in]      : Pointer to array of DMA Buf FDs of the buffers to be locked.
 * @ return                 : DCE error status is returned.
 */
int dsp_dce_buf_unlock(int num, size_t *handle);


/******************************* OMAPDRM Get/Set FD APIs *******************************/
/*=====================================================================================*/
/** dce_get_fd              : Get OMAP DRM File Descriptor.
 *
 * @ return                 : OMAP DRM File Descriptor.
 */
int dce_get_fd();

/*=====================================================================================*/
/** dce_set_fd              : Set OMAP DRM File Descriptor.
 *
 * @ param fd     [in]      : OMAP DRM File Descriptor.
 */
void dce_set_fd(int fd);


 /*===============================================================*/
/** get_rproc_info : Get Information from the Remote proc.
 *
 * @ param engine    [in]    : Engine Handle obtained in Engine_open() call.
 * @ param info_type [in]    : Information type as defined in the rproc_info_type
+ */
int32_t get_rproc_info(Engine_Handle engine, rproc_info_type info_type);

#endif /* __LIBDCE_H__ */