Added git ignore
[keystone-rtos/fvid2.git] / fvid2.h
1 /*
2  * Copyright (c) Texas Instruments Incorporated 2012-2018
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  */
33 /**
34  *  \file fvid2.h
35  *
36  *  \brief FVID2 API
37  *
38  *  FVID2 API is an interface which is used to create, control and use different
39  *  video drivers. FVID2 API is used not only for on-chip
40  *  peripherals drivers like capture, display but also for external off-chip
41  *  video device peripherals like video decoders, video encoders and
42  *  video sensors.
43  *
44  *  All video drivers and external video peripherals implement the FVID2
45  *  API.
46  *  Many drivers also extend the FVID2 interface by defining their own driver
47  *  specific IOCTLs.
48  *
49  *  <b> All FVID2 API must be called from task context </b>. Some examples
50  *  in the package maybe calling FVID2 APIs from callback and/or
51  *  interrupt context. Such examples will be modified in subsequent releases
52  *  and in order that user application do not have to do special migration it
53  *  is strongly recommended to use FVID2 APIs only from task context.
54  *
55  *  A FVID2 API can be of two kinds,
56  *
57  *  - <b> Blocking API </b> <br>
58  *    Here the FVID2 API call returns only after completing the request or
59  *    functionality or if timed out or if some other error occurs.
60  *    The below APIs are always blocking, unless specified otherwise by
61  *    specific driver.
62  *    - Fvid2_create()
63  *    - Fvid2_delete()
64  *    - Fvid2_start()
65  *    - Fvid2_stop()
66  *    - Fvid2_control()
67  *    - Fvid2_setFormat()
68  *    - Fvid2_getFormat()
69  *
70  *  - <b> Non-blocking API </b> <br>
71  *    Here FVID2 API call queues the request to the driver and returns
72  *    immediately before the request is processed or completed.
73  *    Application should use the completion callback to wait for request
74  *    completion.
75  *    The below APIs are always non-blocking, unless specified otherwise by
76  *    specific driver.
77  *    - Fvid2_queue()
78  *    - Fvid2_dequeue()
79  *    - Fvid2_processFrames()
80  *    - Fvid2_getProcessedFrames()
81  *
82  *  A FVID2 Driver can belong to one the below categories. The FVID2 APIs
83  *  applicable to driver in a category are also listed below. The below is
84  *  true for most driver unless specified otherwise by a specific driver.
85  *  - <b> Streaming interface drivers </b> <br>
86  *  Examples include, capture, display, graphics.
87  *  Below FVID2 APIs are implemented by such drivers.
88  *    - Fvid2_create()
89  *    - Fvid2_delete()
90  *    - Fvid2_start()
91  *    - Fvid2_stop()
92  *    - Fvid2_queue()
93  *    - Fvid2_dequeue()
94  *    - Fvid2_control()
95  *    - Fvid2_setFormat() - OPTIONAL
96  *    - Fvid2_getFormat() - OPTIONAL
97  *
98  *  - <b> Memory to memory processing interface drivers </b> <br>
99  *   Examples include, M2M VPE.
100  *   Below FVID2 APIs are implemented by such drivers.
101  *    - Fvid2_create()
102  *    - Fvid2_delete()
103  *    - Fvid2_processFrames()
104  *    - Fvid2_getProcessedFrames()
105  *    - Fvid2_control()
106  *    - Fvid2_setFormat() - OPTIONAL
107  *    - Fvid2_getFormat() - OPTIONAL
108  *
109  *  - <b> Control interface drivers </b> <br>
110  *   Examples include, display controller, external video devices.
111  *   Below FVID2 APIs are implemented by such drivers.
112  *    - Fvid2_create()
113  *    - Fvid2_delete()
114  *    - Fvid2_control()
115  *    - Fvid2_start()
116  *    - Fvid2_stop()
117  *    - Fvid2_setFormat() - OPTIONAL
118  *    - Fvid2_getFormat() - OPTIONAL
119  *
120  *  Before making any FVID2 API calls, Fvid2_init() must be called.
121  *  Fvid2_deInit() must be called during system shutdown.
122  *
123  *  Fvid2_getVersionString() and Fvid2_getVersionNumber() can be used to get
124  *  information about current driver version number.
125  *
126  *  All FVID2 drivers are of type Fvid2_Handle, which gets created when
127  *  Fvid2_create() is called. This handle is used for all subsequent FVID2
128  *  API calls. This handle and its associated resources are free'ed when
129  *  Fvid2_delete() is called.
130  *
131  *  All FVID2 APIs make use of Fvid2_Frame, Fvid2_FrameList and/or
132  *  Fvid2_ProcessList for exchanging and processing video frames via a driver.
133  *  Further all drivers use a common user callback mechanism via Fvid2_CbParams
134  *  to indicate to the user that a frame is ready. Many drivers, but not all,
135  *  use the Fvid2_Format data structure to describe video input, output data
136  *  formats.
137  *
138  *  All drivers use the constants, enum's, error codes defined in this file to
139  *  control and configure a driver.
140  *
141  *  In addition, most drivers define driver specific create time parameters
142  *  and IOCTLs to allow the user to control and configure the driver in driver
143  *  specific ways. Further a driver may define driver specific run-time
144  *  parameters which are passed by user to the driver via
145  *  Fvid2_Frame.perFrameCfg and/or Fvid2_FrameList.perListCfg.
146  *
147  *  Also user application can associate user specific app data with a
148  *  driver handle via Fvid2_CbParams.appData or with every frame via
149  *  FIVD2_Frame.appData. The app data set as part of Fvid2_CbParams returned
150  *  back to user when callback occurs. The app data set as part of Fvid2_Frame
151  *  is returned back to the user when the Fvid2_Frame itself is returned back to
152  *  user via Fvid2_dequeue() or Fvid2_getProcessedFrames(). The driver will not
153  *  modify this app data. This could be used by the application to store any
154  *  application specific data like application object info and so on.
155  *
156  */
158 /*
159  *  \version 0.1    Created.
160  *           0.2    Changes for BIOS 6 and new FVID2 interface.
161  *           0.2.1  Merged color and data format enums to data format enums.
162  *                  Added process list structure to support M2M
163  *                  (memory to memory) drivers.
164  *                  Removed FVID2_Buf structure and directly used address array
165  *                  in Fvid2_Frame structure.
166  *                  Defined proper signature for FVID2 APIs.
167  *           0.2.2  Added proper comments.
168  *           0.3    Added subframe callback and added reserved fields in all the
169  *                  structures.
170  *           0.4    Made frames pointer to pointer to array of frame pointer in
171  *                  framelist to simplify application allocation and ease of
172  *                  use.
173  *           0.5    Added FVID2 standard enums.
174  *           0.6    Split into two files. fvid2.h will contain only FVID2 driver
175  *                  specific defintions/declarations. It will include
176  *                  fvid2_dataTypes.h for data type defintions
177  *           1.0    Removed reserved fields as this is not used anywhere and
178  *                  changed Ptr to void*, changed types to stdint.h types.
179  *
180  */
182 #ifndef FVID2_H_
183 #define FVID2_H_
185 /* ========================================================================== */
186 /*                             Include Files                                  */
187 /* ========================================================================== */
189 #include <ti/csl/csl_fvid2_dataTypes.h>
191 #ifdef __cplusplus
192 extern "C" {
193 #endif
195 /* ========================================================================== */
196 /*                           Macros & Typedefs                                */
197 /* ========================================================================== */
199 /**
200  *  \brief FVID2 driver version string.
201  *  Version is of the form mm_nn_xx_yy where,
202  *      mm - Product version (02 for FVID2). This increments for any new FVID2
203  *           versions.
204  *      nn - Major number - Increments if any backward compatibility is broken
205  *           or major change within a product version.
206  *      xx - Minor number - Increments for any minor change or any additions
207  *           done without breaking backward compatibility.
208  *      yy - Build number - Increments for every release.
209  */
210 #define FVID2_VERSION_STRING            "FVID_02_02_00_00"
212 /** \brief FVID2 driver version number. */
213 #define FVID2_VERSION_NUMBER            (0x02020000U)
215 /** \brief FVID2 Driver handle. */
216 typedef void *Fvid2_Handle;
218 /**
219  *  \brief FVID2 driver callback function prototype.
220  *
221  *  This callback is used by the drivers which implement non-blocking
222  *  FVID2 APIs.
223  *
224  *  User should assume that callbacks happen in ISR context and hence should
225  *  apply rules relevant to ISR context when implementing callback functions,
226  *  i.e blocking APIs should not be called from callback. Users should also
227  *  assume that interrupts are enabled when in callback context, i.e other
228  *  interrupt / callbacks can occur when a callback is under execution.
229  *  User callback implementation should not be very long, since callback
230  *  execution may block other drivers from executing. Typically it is
231  *  recommended to set a semaphore or flag when callback happens and do the
232  *  more involved callback handling in task context.
233  *
234  *  This callback is typically called by the driver as mentioned below,
235  *  unless specified otherwise by specific drivers.
236  *
237  *  In case of display drivers, this callback function will be called
238  *  when a frame(s) is/are completed displayed. Then the application can
239  *  dequeue the displayed buffer back from the driver.
240  *
241  *  In case of capture drivers, this callback function will be called
242  *  when a frame(s) is/are captured. Then the application can dequeue the
243  *  captured buffer back from the driver.
244  *
245  *  In case of M2M drivers, this callback function will be called
246  *  when a request from the application is completed by the driver. Then the
247  *  application can dequeue the completed request buffers back from the driver.
248  *
249  *  In case of control drivers, callbacks are typically not used since mostly
250  *  FVID2 APIs implemented by control drivers are of blocking nature.
251  *
252  *  \param handle   [OUT] FVID2 handle for which the callback has occurred.
253  *  \param appData  [OUT] Application data provided to the driver at the
254  *                        time of Fvid2_create().
255  *
256  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
257  */
258 typedef int32_t (*Fvid2_CbFxn)(Fvid2_Handle handle, void *appData);
260 /**
261  *  \brief FVID2 error callback function prototype.
262  *
263  *  Error callback is called by driver when it encounters a error during
264  *  processing of frames in its internal queue.
265  *
266  *  When user submits frames to the driver it does minimal error checks and
267  *  stores the the frames in its internal queues. In case of any error at
268  *  this point the FVID2 API will simply return error and error callback
269  *  will not be called.
270  *
271  *  The driver will later (depending on how its request queue is full) process
272  *  these frames submitted by the user. If driver finds any error in either
273  *  the input frame information or hardware itself then it will call this error
274  *  callback to notify the user about this error. As part of the callback
275  *  information it also returns the frames or request for which error happened
276  *  so that user can take appropriate action.
277  *
278  *  Users should apply same rules as that of Fvid2_CbFxn when implementing
279  *  error callbacks.
280  *
281  *  \param handle   [OUT] FVID2 handle for which the callback has occurred.
282  *  \param appData  [OUT] Application data provided to the driver at the time
283  *                        of Fvid2_create().
284  *  \param errList  [OUT] Pointer to a valid framelist (Fvid2_FrameList)
285  *                        in case of capture and display drivers or a pointer
286  *                        to a valid processlist (Fvid2_ProcessList) in case of
287  *                        M2M drivers. The driver copies the aborted/error
288  *                        frames in this frame list or process list.
289  *
290  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
291  */
292 typedef int32_t (*Fvid2_ErrCbFxn)(Fvid2_Handle handle,
293                                   void        *appData,
294                                   void        *errList);
296 /**
297  *  \brief FVID2 callback that is called by subframe mode Capture driver.
298  *
299  *  This callback is called for every subframe of frame that
300  *  is captured. This function is used by Capture Driver and not meant for M2M
301  *  drivers.
302  *
303  *  Users should apply same rules as that of Fvid2_CbFxn when implementing
304  *  subframe callbacks.
305  *
306  *  \param handle       [OUT] FVID2 handle for which this callback happened.
307  *  \param subFrameInfo [OUT] SubFrame information.
308  *
309  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
310  */
311 typedef int32_t (*Fvid2_SubFrameCbFxn)(Fvid2_Handle handle,
312                                        Fvid2_Frame *subFrame);
314 /**
315  *  \name FVID2 Max limits
316  *  @{
317  */
319 /** \brief Decide the streamid based on channel number.  */
320 #define FVID2_STREAM_ID_ANY             (0xFFFFFFFFU)
322 /* @} */
324 /*
325  * =========== Command codes for Submit call =============
326  */
327 /** \brief Control command base address. */
328 #define FVID2_CTRL_BASE                 (0x00000000U)
329 /** \brief User command base address. */
330 #define FVID2_USER_BASE                 (0x10000000U)
332 /**
333  *  \addtogroup BSP_DRV_IOCTL_FVID2
334  *  @{
335  */
337 /**
338  *  \brief Control command used by Fvid2_setFormat()
339  *
340  *  \param cmdArgs       [IN]  const Fvid2_Format *
341  *  \param cmdStatusArgs [OUT] NULL
342  *
343  *  \return FVID2_SOK on success, else failure.
344  */
345 #define FVID2_SET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 3U)
347 /**
348  *  \brief Control command used by Fvid2_getFormat()
349  *
350  *  \param cmdArgs       [IN]  Fvid2_Format *
351  *  \param cmdStatusArgs [OUT] NULL
352  *
353  *  \return FVID2_SOK on success, else failure.
354  */
355 #define FVID2_GET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 4U)
357 /**
358  *  \brief Control command used by Fvid2_start()
359  *
360  *  \param cmdArgs       [IN]  Driver specific
361  *  \param cmdStatusArgs [OUT] NULL
362  *
363  *  \return FVID2_SOK on success, else failure.
364  */
365 #define FVID2_START                     ((uint32_t) FVID2_CTRL_BASE + 5U)
367 /**
368  *  \brief Control command used by Fvid2_stop()
369  *
370  *  \param cmdArgs       [IN]  Driver specific
371  *  \param cmdStatusArgs [OUT] NULL
372  *
373  *  \return FVID2_SOK on success, else failure.
374  */
375 #define FVID2_STOP                      ((uint32_t) FVID2_CTRL_BASE + 6U)
377 /* @} */
379 /* ========================================================================== */
380 /*                         Structure Declarations                             */
381 /* ========================================================================== */
383 /**
384  *  \brief FVID2 callback parameters that are setup during Fvid2_create().
385  */
386 typedef struct
388     Fvid2_CbFxn    cbFxn;
389     /**< Application callback function used by the driver to intimate any
390      *   operation has completed or not. This is an optional parameter
391      *   in case application decides to use polling method and so could be
392      *   set to NULL. */
394     Fvid2_ErrCbFxn errCbFxn;
395     /**< Application error callback function used by the driver to intimate
396      *   any error occurs at the time of streaming. This is an optional
397      *   parameter in case application decides not to get any error callback
398      *   and so could be set to NULL. */
400     void           *errList;
401     /**< Pointer to a valid Fvid2_FrameList in case of capture
402      *   and display drivers or a pointer to a valid Fvid2_ProcessList
403      *   in case of M2M drivers where the driver copies
404      *   the aborted/error packet. The memory of this list should be
405      *   allocated by the application and provided to the driver at the time
406      *   of driver creation. When the application gets this callback, it has
407      *   to empty this list and taken necessary action like freeing up memories
408      *   etc. The driver will then reuse the same list for future error
409      *   callback.
410      *   This could be NULL if errCbFxn is NULL. Otherwise this should be
411      *   non-NULL. */
413     void           *appData;
414     /**< Application specific data which is returned in the callback function
415      *   as it is. This could be set to NULL if not used. */
416 } Fvid2_CbParams;
418 /* ========================================================================== */
419 /*                          Function Declarations                             */
420 /* ========================================================================== */
422 /**
423  *  \brief FVID2 init function.
424  *
425  *  Initializes the FVID2 layer.
426  *  This function should be called before calling any of FVID2 API's and
427  *  should be called only once.
428  *
429  *  \param args         [IN] Not used currently. Set to NULL.
430  *
431  *  \return FVID2_SOK on success else appropriate FVID2 error code on failure.
432  */
433 int32_t Fvid2_init(void *args);
435 /**
436  *  \brief FVID2 deinit function.
437  *
438  *  Uninitializes the FVID2 layer and should be called during system shutdown.
439  *  Should not be called if Fvid2_init() is not called.
440  *
441  *  \param args         [IN] Not used currently. Set to NULL.
442  *
443  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
444  */
445 int32_t Fvid2_deInit(void *args);
447 /**
448  *  \brief Get the version string for FVID2 interface.
449  *
450  *  This is the version number for the FVID2 interface. This
451  *  function can be called prior to #Fvid2_init() to get the version number.
452  *
453  *  \return Pointer to FVID2 version string.
454  */
455 const char *Fvid2_getVersionString(void);
457 /**
458  *  \brief Same as #Fvid2_getVersionString() except it returns the version in
459  *  uint32_t form.
460  *
461  *  Example, v1.0.1.17 will be 0x01000117
462  *
463  *  \return FVID2 version number.
464  */
465 uint32_t Fvid2_getVersionNumber(void);
467 /**
468  *  \brief Creates the driver identified by the driver ID.
469  *
470  *  This will allocate HW and/or SW resources and return a Fvid2_Handle
471  *  for this driver. This handle will be used for subsequent FVID2 API calls
472  *
473  *  \param drvId        [IN] Driver to open. Driver ID is driver specific.
474  *
475  *  \param instanceId   [IN] Instance of the driver to open and is used
476  *                      to differentiate multiple instance support on a
477  *                      single driver. Instance ID is driver specific.
478  *
479  *  \param createArgs   [IN] Pointer to the create argument structure. The type
480  *                      of the structure is defined by the specific driver.
481  *                      This parameter could be NULL depending on whether the
482  *                      actual driver forces it or not.
483  *
484  *  \param createStatusArgs [OUT] Pointer to status argument structure where the
485  *                      driver returns any status information. The type
486  *                      of the structure is defined by the specific driver.
487  *                      This parameter could be NULL depending on whether the
488  *                      actual driver forces it or not.
489  *
490  *  \param cbParams     [IN] Application callback parameters.
491  *                      This parameter could be NULL depending on whether the
492  *                      actual driver forces it or not.
493  *
494  *  \return non-NULL Fvid2_Handle object pointer on success else returns NULL
495  *  on error.
496  */
497 Fvid2_Handle Fvid2_create(uint32_t              drvId,
498                           uint32_t              instanceId,
499                           void                 *createArgs,
500                           void                 *createStatusArgs,
501                           const Fvid2_CbParams *cbParams);
503 /**
504  *  \brief Deletes a previously created FVID2 driver handle.
505  *
506  *  This free's the HW/SW resources allocated during create
507  *
508  *  \param handle       [IN] FVID2 handle returned by create call.
509  *
510  *  \param deleteArgs   [IN] Pointer to the delete argument structure. The type
511  *                      of the structure is defined by the specific driver.
512  *                      This parameter could be NULL depending on whether the
513  *                      actual driver forces it or not.
514  *
515  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
516  */
517 int32_t Fvid2_delete(Fvid2_Handle handle, void *deleteArgs);
519 /**
520  *  \brief Send control commands (IOCTLs) to the driver.
521  *
522  *  \param handle       [IN] FVID2 handle returned by create call.
523  *
524  *  \param cmd          [IN] IOCTL command. The type of command supported
525  *                      is defined by the specific driver.
526  *
527  *  \param cmdArgs      [IN] Pointer to the command argument structure. The type
528  *                      of the structure is defined by the specific driver
529  *                      for each of the supported IOCTL.
530  *                      This parameter could be NULL depending on whether the
531  *                      actual driver forces it or not.
532  *
533  *  \param cmdStatusArgs [OUT] Pointer to status argument structure where the
534  *                      driver returns any status information. The type
535  *                      of the structure is defined by the specific driver
536  *                      for each of the supported IOCTL.
537  *                      This parameter could be NULL depending on whether the
538  *                      actual driver forces it or not.
539  *
540  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
541  */
542 int32_t Fvid2_control(Fvid2_Handle  handle,
543                       uint32_t      cmd,
544                       void         *cmdArgs,
545                       void         *cmdStatusArgs);
547 /**
548  *  \brief An application calls Fvid2_queue to submit a video buffer to the
549  *  video device driver.
550  *
551  *  - This is used in capture/display drivers.
552  *  - This function could be called from task or ISR context unless the specific
553  *  driver restricts from doing so.
554  *  - This is a non-blocking API unless the specific driver restricts from
555  *  doing so.
556  *
557  *  \param handle       [IN] FVID2 handle returned by create call.
558  *  \param frameList    [IN] Pointer to the frame list structure containing the
559  *                      information about the FVID2 frames that has to be
560  *                      queued in the driver.
561  *  \param streamId     [IN] Stream ID to which the frames should be queued
562  *                      This is used in drivers where they could support
563  *                      multiple streams for the same handle. Otherwise this
564  *                      should be set to zero.
565  *
566  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
567  */
568 int32_t Fvid2_queue(Fvid2_Handle        handle,
569                     Fvid2_FrameList    *frameList,
570                     uint32_t            streamId);
572 /**
573  *  \brief An application calls Fvid2_dequeue to request the video device
574  *  driver to give ownership of a video buffer.
575  *
576  *  - This is used in capture/display drivers.
577  *  - This is a non-blocking API if timeout is FVID2_TIMEOUT_NONE and could be
578  *  called by task and ISR context unless the specific driver restricts from
579  *  doing so.
580  *  - This is blocking API if timeout is FVID2_TIMEOUT_FOREVER if supported by
581  *  specific driver implementation.
582  *
583  *  \param handle       [IN] FVID2 handle returned by create call.
584  *  \param frameList    [OUT] Pointer to the frame list structure where the
585  *                      dequeued frame pointer will be stored.
586  *  \param streamId     [IN] Stream ID from where frames should be dequeued.
587  *                      This is used in drivers where it could support multiple
588  *                      streams for the same handle. Otherwise this
589  *                      should be set to zero.
590  *  \param timeout      [IN] FVID2 timeout in units of OS ticks. This will
591  *                      determine the timeout value till the driver will block
592  *                      for a free or completed buffer is available.
593  *                      For non-blocking drivers this parameter might be
594  *                      ignored.
595  *
596  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
597  */
598 int32_t Fvid2_dequeue(Fvid2_Handle      handle,
599                       Fvid2_FrameList  *frameList,
600                       uint32_t          streamId,
601                       uint32_t          timeout);
603 /**
604  *  \brief An application calls Fvid2_processRequest to submit a video buffer
605  *  to the video device driver.
606  *
607  *  This API is used for submitting a single channel video processing request
608  *  to the video device driver. It uses framelist to submit multiple
609  *  frames of different stream ids of the same request.
610  *
611  *  - This function could be called from task or ISR context unless the specific
612  *  driver restricts from doing so.
613  *  - This is a non-blocking API unless the specific driver restricts from
614  *  doing so.
615  *
616  *  \param handle       [IN] FVID2 handle returned by create call.
617  *  \param inFrameList  [IN] Pointer to the array of input frames with
618  *                           different stream ids.
619  *  \param outFrameList [IN] Pointer to the array of output frames with
620  *                           different stream ids
621  *
622  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
623  */
624 int32_t Fvid2_processRequest(Fvid2_Handle       handle,
625                              Fvid2_FrameList   *inFrameList,
626                              Fvid2_FrameList   *outFrameList);
628 /**
629  *  \brief An application calls Fvid2_getProcessedRequest to get the
630  *  processed request back from the driver and thus to get the
631  *  ownership of request back from the driver.
632  *
633  *  - This is a non-blocking API if timeout is FVID2_TIMEOUT_NONE and could be
634  *  called by task and ISR context unless the specific driver restricts from
635  *  doing so.
636  *  - This is blocking API if timeout is FVID2_TIMEOUT_FOREVER if supported by
637  *  specific driver implementation.
638  *
639  *  \param handle       [IN] FVID2 handle returned by create call.
640  *  \param inFrameList  [OUT] Pointer to frame list in which input frames with
641  *                            different stream ids will be returned
642  *                            by the driver.
643  *  \param outFrameList [OUT] Pointer to frame list in which output frames with
644  *                            different stream ids will be returned by
645  *                            the driver.
646  *  \param timeout      [IN] FVID2 timeout. This will determine the timeout
647  *                           value till the driver will block for a
648  *                           free or completed buffer is available.
649  *                           For non-blocking drivers this parameter
650  *                           might be ignored.
651  *
652  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
653  */
654 int32_t Fvid2_getProcessedRequest(Fvid2_Handle      handle,
655                                   Fvid2_FrameList  *inFrameList,
656                                   Fvid2_FrameList  *outFrameList,
657                                   uint32_t          timeout);
658 /**
659  *  \brief An application calls Fvid2_start to request the video device
660  *  driver to start the video display or capture operation.
661  *  This function should be called from task context only and should not be
662  *  called from ISR context.
663  *
664  *  \param handle       [IN] FVID2 handle returned by create call.
665  *  \param cmdArgs      [IN] Pointer to the start argument structure. The type
666  *                      of the structure is defined by the specific driver.
667  *                      This parameter could be NULL depending on whether the
668  *                      actual driver forces it or not.
669  *
670  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
671  */
672 static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs);
674 /**
675  *  \brief An application calls Fvid2_stop to request the video device
676  *  driver to stop the video display or capture operation.
677  *  This function should be called from task context only and should not be
678  *  called from ISR context.
679  *
680  *  \param handle       [IN] FVID2 handle returned by create call.
681  *  \param cmdArgs      [IN] Pointer to the stop argument structure. The type
682  *                      of the structure is defined by the specific driver.
683  *                      This parameter could be NULL depending on whether the
684  *                      actual driver forces it or not.
685  *
686  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
687  */
688 static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs);
690 /**
691  *  \brief An application calls Fvid2_setFormat to request the video device
692  *  driver to set the format for a given channel.
693  *  This function should be called from task context only and should not be
694  *  called from ISR context.
695  *
696  *  \param handle       [IN] FVID2 handle returned by create call.
697  *  \param fmt          [IN] Pointer to the FVID2 format structure.
698  *
699  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
700  */
701 static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
703 /**
704  *  \brief An application calls Fvid2_getFormat to request the video device
705  *  driver to get the current format for a given channel.
706  *  This function should be called from task context only and should not be
707  *  called from ISR context.
708  *
709  *  \param handle       [IN] FVID2 handle returned by create call.
710  *  \param fmt          [OUT] Pointer to the FVID2 format structure.
711  *
712  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
713  */
714 static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
716 /**
717  *  \brief Fvid2_CbParams structure init function.
718  *
719  *  \param cbPrms       [IN] Pointer to #Fvid2_CbParams structure.
720  *
721  */
722 static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms);
724 /* ========================================================================== */
725 /*                       Static Function Definitions                          */
726 /* ========================================================================== */
728 static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs)
730     return Fvid2_control(handle, FVID2_START, cmdArgs, NULL);
733 static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs)
735     return Fvid2_control(handle, FVID2_STOP, cmdArgs, NULL);
738 static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
740     return Fvid2_control(handle, FVID2_SET_FORMAT, fmt, NULL);
743 static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
745     return Fvid2_control(handle, FVID2_GET_FORMAT, fmt, NULL);
748 static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms)
750     if (NULL != cbPrms)
751     {
752         cbPrms->cbFxn    = NULL;
753         cbPrms->errCbFxn = NULL;
754         cbPrms->errList  = NULL;
755         cbPrms->appData  = NULL;
756     }
758     return;
761 #ifdef __cplusplus
763 #endif
765 #endif  /* #ifndef FVID2_H_ */
767 /* @} */