summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBuddy Liong2017-09-29 15:28:05 -0500
committerBuddy Liong2017-09-29 15:47:50 -0500
commitf72096090e3063e85ea77cae66b2d99a48d91727 (patch)
tree09a316491255a3dca4706b13446a2d45220ecf36 /packages/framework_components
parent338ba56b9b9393acf7b54e4d5ab531f710c7360b (diff)
downloadhardware-ti-libdce-f72096090e3063e85ea77cae66b2d99a48d91727.tar.gz
hardware-ti-libdce-f72096090e3063e85ea77cae66b2d99a48d91727.tar.xz
hardware-ti-libdce-f72096090e3063e85ea77cae66b2d99a48d91727.zip
[LIBDCE] Update dependency header files
Update the header files to match with framework_components_3_40_02_07 xdctools_3_50_03_33_core Modify the README on the version as well. The codec header files have been checked to be similar (only spacing different) so no update is needed. Change-Id: Ie0afb59ec58f88fd18d49d688f958cf3aafc3848 Signed-off-by: Buddy Liong <a0270631@ti.com>
Diffstat (limited to 'packages/framework_components')
-rw-r--r--packages/framework_components/ti/sdo/fc/ires/hdvicp/ires_hdvicp2.h242
1 files changed, 116 insertions, 126 deletions
diff --git a/packages/framework_components/ti/sdo/fc/ires/hdvicp/ires_hdvicp2.h b/packages/framework_components/ti/sdo/fc/ires/hdvicp/ires_hdvicp2.h
index c2b0ada..f3e863d 100644
--- a/packages/framework_components/ti/sdo/fc/ires/hdvicp/ires_hdvicp2.h
+++ b/packages/framework_components/ti/sdo/fc/ires/hdvicp/ires_hdvicp2.h
@@ -1,9 +1,4 @@
1/* 1/*
2 * Copyright 2013 by Texas Instruments Incorporated.
3 *
4 */
5
6/*
7 * Copyright (c) 2012 - 2013, Texas Instruments Incorporated 2 * Copyright (c) 2012 - 2013, Texas Instruments Incorporated
8 * All rights reserved. 3 * All rights reserved.
9 * 4 *
@@ -137,7 +132,7 @@ extern "C" {
137/** 132/**
138 * @brief Protocol Revision for this resource 133 * @brief Protocol Revision for this resource
139 */ 134 */
140static IRES_ProtocolRevision IRES_HDVICP2_PROTOCOLREVISION = { 1, 0, 0 }; 135static IRES_ProtocolRevision IRES_HDVICP2_PROTOCOLREVISION = {1, 0, 0};
141 136
142#endif 137#endif
143 138
@@ -151,20 +146,20 @@ typedef struct IRES_HDVICP2_Obj *IRES_HDVICP2_Handle;
151 * @brief Timeout value to be used by implementation of 146 * @brief Timeout value to be used by implementation of
152 * IRES_HDVICP2_Handle:wait function 147 * IRES_HDVICP2_Handle:wait function
153 */ 148 */
154extern unsigned int ti_sdo_fc_ires_hdvicp_HDVICP2_timeoutVal; 149extern unsigned int ti_sdo_fc_ires_hdvicp_HDVICP2_timeoutVal;
155 150
156/** 151/**
157 * @brief 152 * @brief
158 */ 153 */
159typedef IRES_YieldArgs (*ti_sdo_fc_ires_hdvicp_HDVICP2_GetYieldArgsFxn) 154typedef IRES_YieldArgs (* ti_sdo_fc_ires_hdvicp_HDVICP2_GetYieldArgsFxn)
160 (Int scratchId); 155 (Int scratchId);
161 156
162/** 157/**
163 * @brief 158 * @brief
164 */ 159 */
165typedef Void (*ti_sdo_fc_ires_hdvicp_HDVICP2_YieldFxn) 160typedef Void (* ti_sdo_fc_ires_hdvicp_HDVICP2_YieldFxn)
166 (IRES_YieldResourceType resource, IRES_YieldContextHandle ctxt, 161 (IRES_YieldResourceType resource, IRES_YieldContextHandle ctxt,
167 IRES_YieldArgs args); 162 IRES_YieldArgs args);
168 163
169 164
170 165
@@ -174,7 +169,7 @@ typedef Void (*ti_sdo_fc_ires_hdvicp_HDVICP2_YieldFxn)
174typedef struct IRES_HDVICP2_ProtocolArgs { 169typedef struct IRES_HDVICP2_ProtocolArgs {
175 170
176 IRES_ProtocolArgs base; /**< Base protocol Args */ 171 IRES_ProtocolArgs base; /**< Base protocol Args */
177 XDAS_Int32 id; /**< HDVICP2 resource being requested. 172 XDAS_Int32 id; /**< HDVICP2 resource being requested.
178 * 173 *
179 * @remarks Could be 0, 1, 2, 174 * @remarks Could be 0, 1, 2,
180 * IRES_HDVICP2_ID_ANY or 175 * IRES_HDVICP2_ID_ANY or
@@ -186,7 +181,7 @@ typedef struct IRES_HDVICP2_ProtocolArgs {
186 * @brief Callback function signature, used by the IRES_HDVICP2_ 181 * @brief Callback function signature, used by the IRES_HDVICP2_
187 * Handle's configure function 182 * Handle's configure function
188 */ 183 */
189typedef void (*IRES_HDVICP2_CallbackFxn)(IALG_Handle handle, Void *args); 184typedef void (*IRES_HDVICP2_CallbackFxn)(IALG_Handle handle, Void * args);
190 185
191/** 186/**
192 * @brief Describes the status/history of the HDVICP2 unit that is 187 * @brief Describes the status/history of the HDVICP2 unit that is
@@ -211,8 +206,8 @@ typedef enum IRES_HDVICP2_Status {
211 */ 206 */
212typedef struct IRES_HDVICP2_Obj { 207typedef struct IRES_HDVICP2_Obj {
213 208
214 IRES_Obj ires; /**< Base IRES_Obj struct */ 209 IRES_Obj ires; /**< Base IRES_Obj struct */
215 Void *info; /**< Reserved for future use */ 210 Void *info; /**< Reserved for future use */
216 XDAS_Int32 id; /**< HDVICP2 id granted 211 XDAS_Int32 id; /**< HDVICP2 id granted
217 * 212 *
218 * @remark Could be 0, 1, 2, or 213 * @remark Could be 0, 1, 2, or
@@ -230,114 +225,114 @@ typedef struct IRES_HDVICP2_Obj {
230 * bit 1 -> ICONT2 reset 225 * bit 1 -> ICONT2 reset
231 */ 226 */
232 227
233 /** 228/**
234 * @brief Acquire the HDVICP2 resource. 229 * @brief Acquire the HDVICP2 resource.
235 * 230 *
236 * @remarks This call acquires the HDVICP resource which the alg may 231 * @remarks This call acquires the HDVICP resource which the alg may
237 * (or may not) have specifically requested. 232 * (or may not) have specifically requested.
238 * 233 *
239 * @remarks The returned @c hdvicp2Status indicates the status of 234 * @remarks The returned @c hdvicp2Status indicates the status of
240 * the particular HDVICP2 unit that is returned. 235 * the particular HDVICP2 unit that is returned.
241 * @sa IRES_HDVICP2_Status 236 * @sa IRES_HDVICP2_Status
242 * 237 *
243 * @remarks The @c configurationId argument is a codec specified 238 * @remarks The @c configurationId argument is a codec specified
244 * parameter that is both an input and output parameter. It 239 * parameter that is both an input and output parameter. It
245 * specifies the mode in which this particular HDVICP2 was 240 * specifies the mode in which this particular HDVICP2 was
246 * used last time, and the mode in which it will be 241 * used last time, and the mode in which it will be
247 * used this time. 242 * used this time.
248 * 243 *
249 * @remarks This API takes a @c yieldContext as argument, as it may 244 * @remarks This API takes a @c yieldContext as argument, as it may
250 * yield the processor to higher priority codecs in the 245 * yield the processor to higher priority codecs in the
251 * system. 246 * system.
252 * 247 *
253 * @remarks @c lateAcquireId is an optionally framework supplied 248 * @remarks @c lateAcquireId is an optionally framework supplied
254 * parameter (sometimes provided via an XDM control() call 249 * parameter (sometimes provided via an XDM control() call
255 * setting the XDM_SETLATEACQUIREARG. If not supplied, the 250 * setting the XDM_SETLATEACQUIREARG. If not supplied, the
256 * codec should pass the value 251 * codec should pass the value
257 * #IRES_HDVICP2_UNKNOWNLATEACQUIREARG. 252 * #IRES_HDVICP2_UNKNOWNLATEACQUIREARG.
258 * 253 *
259 * @sa IRES_HDVICP2_UNKNOWNLATEACQUIREARG 254 * @sa IRES_HDVICP2_UNKNOWNLATEACQUIREARG
260 */ 255 */
261 XDAS_Void (*acquire)(IALG_Handle algHandle, 256 XDAS_Void (*acquire)(IALG_Handle algHandle,
262 struct IRES_HDVICP2_Obj *hdvicpHandle, 257 struct IRES_HDVICP2_Obj * hdvicpHandle,
263 IRES_YieldContext *yieldCtxt, XDAS_UInt32 *hdvicp2Status, 258 IRES_YieldContext * yieldCtxt, XDAS_UInt32 * hdvicp2Status,
264 XDAS_UInt32 *configurationId, XDAS_Int32 lateAcquireArg); 259 XDAS_UInt32 *configurationId, XDAS_Int32 lateAcquireArg);
265 260
266 /** 261/**
267 * @brief Release the HDVICP2 resource. 262 * @brief Release the HDVICP2 resource.
268 * 263 *
269 * @remarks This makes the resource available for use by other algorithms. 264 * @remarks This makes the resource available for use by other algorithms.
270 */ 265 */
271 XDAS_Void (*release)(IALG_Handle algHandle, 266 XDAS_Void (*release)(IALG_Handle algHandle,
272 struct IRES_HDVICP2_Obj *hdvicpHandle); 267 struct IRES_HDVICP2_Obj * hdvicpHandle);
273 268
274 /** 269/**
275 * @brief Reacquire the HDVICP2 resource recent released. 270 * @brief Reacquire the HDVICP2 resource recent released.
276 * 271 *
277 * @returns XDAS_TRUE The resource was not yet acquired by another 272 * @returns XDAS_TRUE The resource was not yet acquired by another
278 * algorithm, and the resource handle is still 273 * algorithm, and the resource handle is still
279 * valid. 274 * valid.
280 * @returns XDAS_FALSE The resource is no longer available and has been 275 * @returns XDAS_FALSE The resource is no longer available and has been
281 * deactivated. 276 * deactivated.
282 */ 277 */
283 XDAS_UInt32 (*reacquireIfOwner)(IALG_Handle algHandle, 278 XDAS_UInt32 (*reacquireIfOwner)(IALG_Handle algHandle,
284 struct IRES_HDVICP2_Obj *hdvicpHandle); 279 struct IRES_HDVICP2_Obj * hdvicpHandle);
285 280
286 /** 281/**
287 * @brief Register a callback function with a HDVICP2 instance. 282 * @brief Register a callback function with a HDVICP2 instance.
288 * 283 *
289 * @remarks The callback is invoked when an interrupt fires after 284 * @remarks The callback is invoked when an interrupt fires after
290 * processing data. 285 * processing data.
291 * 286 *
292 * @remarks It is the algorithm's responsibility to configure the HDVICP2 287 * @remarks It is the algorithm's responsibility to configure the HDVICP2
293 * to process data and fire the interrupt when done. 288 * to process data and fire the interrupt when done.
294 */ 289 */
295 XDAS_Void (*configure)(IALG_Handle algHandle, 290 XDAS_Void (*configure)(IALG_Handle algHandle,
296 struct IRES_HDVICP2_Obj *hdvicpHandle, 291 struct IRES_HDVICP2_Obj * hdvicpHandle,
297 IRES_HDVICP2_CallbackFxn cbFunctionPtr, XDAS_Void *cbArgs); 292 IRES_HDVICP2_CallbackFxn cbFunctionPtr, XDAS_Void * cbArgs);
298 293
299 /** 294/**
300 * @brief Wait until the HDVICP2 is done processing and then return. 295 * @brief Wait until the HDVICP2 is done processing and then return.
301 * 296 *
302 * @remarks This is a blocking call, unless a positive timeout value 297 * @remarks This is a blocking call, unless a positive timeout value
303 * is configured, inwhich case the call returns after timeout. 298 * is configured, inwhich case the call returns after timeout.
304 * 299 *
305 * @remarks This function is passed a yieldContext, and will relinquish 300 * @remarks This function is passed a yieldContext, and will relinquish
306 * the processor while it waits for the HDVICP2 to finish the 301 * the processor while it waits for the HDVICP2 to finish the
307 * processing and return from wait. 302 * processing and return from wait.
308 * 303 *
309 * @returns XDAS_TRUE Success 304 * @returns XDAS_TRUE Success
310 * @returns XDAS_FALSE Failure/Timeout 305 * @returns XDAS_FALSE Failure/Timeout
311 */ 306 */
312 XDAS_UInt32 (*wait)(IALG_Handle algHandle, 307 XDAS_UInt32 (*wait)(IALG_Handle algHandle,
313 struct IRES_HDVICP2_Obj *hdvicpHandle, 308 struct IRES_HDVICP2_Obj *hdvicpHandle,
314 IRES_YieldContext *yieldCtxt); 309 IRES_YieldContext * yieldCtxt);
315 310
316 /** 311/**
317 * @brief Processing has completed. 312 * @brief Processing has completed.
318 * 313 *
319 * @remarks This is called from within the interrupt handler function when 314 * @remarks This is called from within the interrupt handler function when
320 * processing completes, and is used to unblock the wait() API. 315 * processing completes, and is used to unblock the wait() API.
321 * 316 *
322 * @remarks Typically, this is called from within the algortihm's callback 317 * @remarks Typically, this is called from within the algortihm's callback
323 * function (see acquire() call). 318 * function (see acquire() call).
324 */ 319 */
325 XDAS_Void (*done)(IALG_Handle algHandle, 320 XDAS_Void (*done) (IALG_Handle algHandle,
326 struct IRES_HDVICP2_Obj *hdvicpHandle); 321 struct IRES_HDVICP2_Obj *hdvicpHandle);
327 /** 322/**
328 * @brief Reset the HDVICP2. 323 * @brief Reset the HDVICP2.
329 * 324 *
330 * @remarks This can be called by the algorithm to "reset" the HDVICP2, and 325 * @remarks This can be called by the algorithm to "reset" the HDVICP2, and
331 * is usually called when an acquired HDVICP2 is "dirty", i.e, it 326 * is usually called when an acquired HDVICP2 is "dirty", i.e, it
332 * requires both program/data reload. 327 * requires both program/data reload.
333 * 328 *
334 * @remarks It works off a configured maximum reset cycle delay. 329 * @remarks It works off a configured maximum reset cycle delay.
335 * 330 *
336 * @returns XDAS_TRUE Success 331 * @returns XDAS_TRUE Success
337 * @returns XDAS_FALSE Failure 332 * @returns XDAS_FALSE Failure
338 */ 333 */
339 XDAS_UInt32 (*reset)(IALG_Handle algHandle, 334 XDAS_UInt32 (*reset)(IALG_Handle algHandle,
340 struct IRES_HDVICP2_Obj *hdvicpHandle); 335 struct IRES_HDVICP2_Obj *hdvicpHandle);
341 336
342} IRES_HDVICP2_Obj; 337} IRES_HDVICP2_Obj;
343 338
@@ -356,15 +351,15 @@ typedef struct IRES_HDVICP2_RegisterLayer {
356 */ 351 */
357typedef struct IRES_HDVICP2_Properties { 352typedef struct IRES_HDVICP2_Properties {
358 353
359 int size; 354 int size;
360 IRES_HDVICP2_RegisterLayer *globalRegs; /* Register layer of HDVICP2 */ 355 IRES_HDVICP2_RegisterLayer *globalRegs; /* Register layer of HDVICP2 */
361} IRES_HDVICP2_Properties; 356} IRES_HDVICP2_Properties;
362 357
363typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_GetHdvicp2Fxn) 358typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_GetHdvicp2Fxn)
364 (XDAS_Int32 *Id, IALG_Handle alg, IRES_HDVICP2_Handle handle); 359 (XDAS_Int32 *Id, IALG_Handle alg, IRES_HDVICP2_Handle handle);
365 360
366typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_FreeHdvicp2Fxn) 361typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_FreeHdvicp2Fxn)
367 (XDAS_Int32 Id, IALG_Handle alg, IRES_HDVICP2_Handle handle); 362 (XDAS_Int32 Id, IALG_Handle alg, IRES_HDVICP2_Handle handle);
368 363
369#ifdef __cplusplus 364#ifdef __cplusplus
370} 365}
@@ -373,8 +368,3 @@ typedef IRES_Status (*ti_sdo_fc_ires_hdvicp_HDVICP2_FreeHdvicp2Fxn)
373/*@}*/ 368/*@}*/
374 369
375#endif 370#endif
376/*
377 * @(#) ti.sdo.fc.ires.hdvicp; 1, 0, 1,1; 6-12-2013 19:57:33; /db/atree/library/trees/fc/fc-t09/src/ xlibrary
378
379 */
380