Minor graph updates in FVID2
[keystone-rtos/fvid2.git] / include / fvid2_api.h
1 /*
2  *  Copyright (c) Texas Instruments Incorporated 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_api.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_API_H_
183 #define FVID2_API_H_
185 /* ========================================================================== */
186 /*                             Include Files                                  */
187 /* ========================================================================== */
189 #include <ti/csl/csl_fvid2_dataTypes.h>
190 #include <ti/drv/fvid2/include/trace.h>
191 #include <ti/drv/fvid2/include/fvid2_utils.h>
193 #ifdef __cplusplus
194 extern "C" {
195 #endif
197 /* ========================================================================== */
198 /*                           Macros & Typedefs                                */
199 /* ========================================================================== */
201 /**
202  *  \brief FVID2 driver version string.
203  *  Version is of the form mm_nn_xx_yy where,
204  *      mm - Product version (02 for FVID2). This increments for any new FVID2
205  *           versions.
206  *      nn - Major number - Increments if any backward compatibility is broken
207  *           or major change within a product version.
208  *      xx - Minor number - Increments for any minor change or any additions
209  *           done without breaking backward compatibility.
210  *      yy - Build number - Increments for every release.
211  */
212 #define FVID2_VERSION_STRING            "FVID_02_02_00_00"
214 /** \brief FVID2 driver version number. */
215 #define FVID2_VERSION_NUMBER            (0x02020000U)
217 /** \brief FVID2 Driver handle. */
218 typedef void *Fvid2_Handle;
220 /**
221  *  \brief FVID2 driver callback function prototype.
222  *
223  *  This callback is used by the drivers which implement non-blocking
224  *  FVID2 APIs.
225  *
226  *  User should assume that callbacks happen in ISR context and hence should
227  *  apply rules relevant to ISR context when implementing callback functions,
228  *  i.e blocking APIs should not be called from callback. Users should also
229  *  assume that interrupts are enabled when in callback context, i.e other
230  *  interrupt / callbacks can occur when a callback is under execution.
231  *  User callback implementation should not be very long, since callback
232  *  execution may block other drivers from executing. Typically it is
233  *  recommended to set a semaphore or flag when callback happens and do the
234  *  more involved callback handling in task context.
235  *
236  *  This callback is typically called by the driver as mentioned below,
237  *  unless specified otherwise by specific drivers.
238  *
239  *  In case of display drivers, this callback function will be called
240  *  when a frame(s) is/are completed displayed. Then the application can
241  *  dequeue the displayed buffer back from the driver.
242  *
243  *  In case of capture drivers, this callback function will be called
244  *  when a frame(s) is/are captured. Then the application can dequeue the
245  *  captured buffer back from the driver.
246  *
247  *  In case of M2M drivers, this callback function will be called
248  *  when a request from the application is completed by the driver. Then the
249  *  application can dequeue the completed request buffers back from the driver.
250  *
251  *  In case of control drivers, callbacks are typically not used since mostly
252  *  FVID2 APIs implemented by control drivers are of blocking nature.
253  *
254  *  \param handle   [OUT] FVID2 handle for which the callback has occurred.
255  *  \param appData  [OUT] Application data provided to the driver at the
256  *                        time of Fvid2_create().
257  *
258  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
259  */
260 typedef int32_t (*Fvid2_CbFxn)(Fvid2_Handle handle, void *appData);
262 /**
263  *  \brief FVID2 error callback function prototype.
264  *
265  *  Error callback is called by driver when it encounters a error during
266  *  processing of frames in its internal queue.
267  *
268  *  When user submits frames to the driver it does minimal error checks and
269  *  stores the the frames in its internal queues. In case of any error at
270  *  this point the FVID2 API will simply return error and error callback
271  *  will not be called.
272  *
273  *  The driver will later (depending on how its request queue is full) process
274  *  these frames submitted by the user. If driver finds any error in either
275  *  the input frame information or hardware itself then it will call this error
276  *  callback to notify the user about this error. As part of the callback
277  *  information it also returns the frames or request for which error happened
278  *  so that user can take appropriate action.
279  *
280  *  Users should apply same rules as that of Fvid2_CbFxn when implementing
281  *  error callbacks.
282  *
283  *  \param handle   [OUT] FVID2 handle for which the callback has occurred.
284  *  \param appData  [OUT] Application data provided to the driver at the time
285  *                        of Fvid2_create().
286  *  \param errList  [OUT] Pointer to a valid framelist (Fvid2_FrameList)
287  *                        in case of capture and display drivers or a pointer
288  *                        to a valid processlist (Fvid2_ProcessList) in case of
289  *                        M2M drivers. The driver copies the aborted/error
290  *                        frames in this frame list or process list.
291  *
292  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
293  */
294 typedef int32_t (*Fvid2_ErrCbFxn)(Fvid2_Handle handle,
295                                   void        *appData,
296                                   void        *errList);
298 /**
299  *  \brief FVID2 callback that is called by subframe mode Capture driver.
300  *
301  *  This callback is called for every subframe of frame that
302  *  is captured. This function is used by Capture Driver and not meant for M2M
303  *  drivers.
304  *
305  *  Users should apply same rules as that of Fvid2_CbFxn when implementing
306  *  subframe callbacks.
307  *
308  *  \param handle       [OUT] FVID2 handle for which this callback happened.
309  *  \param subFrameInfo [OUT] SubFrame information.
310  *
311  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
312  */
313 typedef int32_t (*Fvid2_SubFrameCbFxn)(Fvid2_Handle handle,
314                                        Fvid2_Frame *subFrame);
316 /**
317  *  \brief Function prototype, to determine the time stamp.
318  *
319  *  \param args  [IN]  Not used as of now.
320  *
321  *  \return An unsigned int 64 value, that represents the current time in usec.
322  */
323 typedef uint64_t (*Fvid2_TimeStampFxn)(void *args);
325 /**
326  *  \name FVID2 Max limits
327  *  @{
328  */
330 /** \brief Decide the streamid based on channel number.  */
331 #define FVID2_STREAM_ID_ANY             (0xFFFFFFFFU)
333 /* @} */
335 /*
336  * =========== Command codes for Submit call =============
337  */
338 /** \brief Control command base address. */
339 #define FVID2_CTRL_BASE                 (0x00000000U)
340 /** \brief User command base address. */
341 #define FVID2_USER_BASE                 (0x10000000U)
343 /**
344  *  \addtogroup BSP_DRV_IOCTL_FVID2
345  *  @{
346  */
348 /**
349  *  \brief Control command used by Fvid2_setFormat()
350  *
351  *  \param cmdArgs       [IN]  const Fvid2_Format *
352  *  \param cmdStatusArgs [OUT] NULL
353  *
354  *  \return FVID2_SOK on success, else failure.
355  */
356 #define FVID2_SET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 3U)
358 /**
359  *  \brief Control command used by Fvid2_getFormat()
360  *
361  *  \param cmdArgs       [IN]  Fvid2_Format *
362  *  \param cmdStatusArgs [OUT] NULL
363  *
364  *  \return FVID2_SOK on success, else failure.
365  */
366 #define FVID2_GET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 4U)
368 /**
369  *  \brief Control command used by Fvid2_start()
370  *
371  *  \param cmdArgs       [IN]  Driver specific
372  *  \param cmdStatusArgs [OUT] NULL
373  *
374  *  \return FVID2_SOK on success, else failure.
375  */
376 #define FVID2_START                     ((uint32_t) FVID2_CTRL_BASE + 5U)
378 /**
379  *  \brief Control command used by Fvid2_stop()
380  *
381  *  \param cmdArgs       [IN]  Driver specific
382  *  \param cmdStatusArgs [OUT] NULL
383  *
384  *  \return FVID2_SOK on success, else failure.
385  */
386 #define FVID2_STOP                      ((uint32_t) FVID2_CTRL_BASE + 6U)
388 /**
389  *  \brief Register an application function (pointer) for getting the
390  *  time stamp value used at the frame completion time.
391  *
392  *  The same IOCTL could be used to un-register the existing time stamp
393  *  function by passing NULL to the function pointer.
394  *
395  *  \param cmdArgs       [IN]  const Fvid2_TimeStampParams *
396  *  \param cmdArgsStatus       NULL
397  *
398  *  \return FVID2_SOK on success, else failure.
399  */
400 #define FVID2_REGISTER_TIMESTAMP_FXN    ((uint32_t) FVID2_CTRL_BASE + 7U)
402 /* @} */
404 /*
405  *  Driver ID Base.
406  */
407 /** \brief Driver ID base for the DSS driver class. */
408 #define FVID2_DSS_DRV_BASE              (0x00001000U)
409 /** \brief Driver ID base for the CAL driver class. */
410 #define FVID2_CAL_DRV_BASE              (0x00002000U)
411 /** \brief Driver ID base for the CSIRX driver class. */
412 #define FVID2_CSIRX_DRV_BASE            (0x00003000U)
413 /** \brief Driver ID base for the CSITX driver class. */
414 #define FVID2_CSITX_DRV_BASE            (0x00004000U)
415 /** \brief Driver ID base for the VHWA driver class. */
416 #define FVID2_VHWA_DRV_BASE             (0x00005000U)
418 /*
419  *  IOCTLs Base.
420  */
421 /** \brief IOCTL base for the DSS driver class. */
422 #define FVID2_DSS_DRV_IOCTL_BASE        (FVID2_USER_BASE + FVID2_DSS_DRV_BASE)
423 /** \brief IOCTL base for the CAL driver class. */
424 #define FVID2_CAL_DRV_IOCTL_BASE        (FVID2_USER_BASE + FVID2_CAL_DRV_BASE)
425 /** \brief IOCTL base for the CSIRX driver class. */
426 #define FVID2_CSIRX_DRV_IOCTL_BASE      (FVID2_USER_BASE + FVID2_CSIRX_DRV_BASE)
427 /** \brief IOCTL base for the CSITX driver class. */
428 #define FVID2_CSITX_DRV_IOCTL_BASE      (FVID2_USER_BASE + FVID2_CSITX_DRV_BASE)
429 /** \brief IOCTL base for the VHWA driver class. */
430 #define FVID2_VHWA_DRV_IOCTL_BASE       (FVID2_USER_BASE + FVID2_VHWA_DRV_BASE)
432 /* ========================================================================== */
433 /*                         Structure Declarations                             */
434 /* ========================================================================== */
436 /**
437  *  \brief FVID2 callback parameters that are setup during Fvid2_create().
438  */
439 typedef struct
441     Fvid2_CbFxn    cbFxn;
442     /**< Application callback function used by the driver to intimate any
443      *   operation has completed or not. This is an optional parameter
444      *   in case application decides to use polling method and so could be
445      *   set to NULL. */
447     Fvid2_ErrCbFxn errCbFxn;
448     /**< Application error callback function used by the driver to intimate
449      *   any error occurs at the time of streaming. This is an optional
450      *   parameter in case application decides not to get any error callback
451      *   and so could be set to NULL. */
453     void           *errList;
454     /**< Pointer to a valid Fvid2_FrameList in case of capture
455      *   and display drivers or a pointer to a valid Fvid2_ProcessList
456      *   in case of M2M drivers where the driver copies
457      *   the aborted/error packet. The memory of this list should be
458      *   allocated by the application and provided to the driver at the time
459      *   of driver creation. When the application gets this callback, it has
460      *   to empty this list and taken necessary action like freeing up memories
461      *   etc. The driver will then reuse the same list for future error
462      *   callback.
463      *   This could be NULL if errCbFxn is NULL. Otherwise this should be
464      *   non-NULL. */
466     void           *appData;
467     /**< Application specific data which is returned in the callback function
468      *   as it is. This could be set to NULL if not used. */
469 } Fvid2_CbParams;
471 /**
472  *  \brief Structure used to configure time stamping of frames.
473  */
474 typedef struct
476     Fvid2_TimeStampFxn timeStampFxn;
477     /**< By default, OSAL (BIOS) API is used to time stamp frames.
478      *
479      *   Applications could over-ride the same, by providing a
480      *   function that would return an unsigned int 64 value representing the
481      *   timestamp in usec.
482      *   The driver would call this function and update the 'timeStamp'
483      *   and 'timeStamp64' member of #Fvid2_Frame with the return
484      *   value of this function.
485      *
486      *   Note: The 64-bit value / 1000 is used to update the 'timeStamp'
487      *   member.
488      *
489      *   Passing a value of NULL un-registers the time stamp function. */
490     uint32_t reserved;
491     /**< Not used now. Set to zero. */
492 } Fvid2_TimeStampParams;
494 /* ========================================================================== */
495 /*                          Function Declarations                             */
496 /* ========================================================================== */
498 /**
499  *  \brief FVID2 init function.
500  *
501  *  Initializes the FVID2 layer.
502  *  This function should be called before calling any of FVID2 API's and
503  *  should be called only once.
504  *
505  *  \param args         [IN] Not used currently. Set to NULL.
506  *
507  *  \return FVID2_SOK on success else appropriate FVID2 error code on failure.
508  */
509 int32_t Fvid2_init(void *args);
511 /**
512  *  \brief FVID2 deinit function.
513  *
514  *  Uninitializes the FVID2 layer and should be called during system shutdown.
515  *  Should not be called if Fvid2_init() is not called.
516  *
517  *  \param args         [IN] Not used currently. Set to NULL.
518  *
519  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
520  */
521 int32_t Fvid2_deInit(void *args);
523 /**
524  *  \brief Get the version string for FVID2 interface.
525  *
526  *  This is the version number for the FVID2 interface. This
527  *  function can be called prior to #Fvid2_init() to get the version number.
528  *
529  *  \return Pointer to FVID2 version string.
530  */
531 const char *Fvid2_getVersionString(void);
533 /**
534  *  \brief Same as #Fvid2_getVersionString() except it returns the version in
535  *  uint32_t form.
536  *
537  *  Example, v1.0.1.17 will be 0x01000117
538  *
539  *  \return FVID2 version number.
540  */
541 uint32_t Fvid2_getVersionNumber(void);
543 /**
544  *  \brief Creates the driver identified by the driver ID.
545  *
546  *  This will allocate HW and/or SW resources and return a Fvid2_Handle
547  *  for this driver. This handle will be used for subsequent FVID2 API calls
548  *
549  *  \param drvId        [IN] Driver to open. Driver ID is driver specific.
550  *
551  *  \param instanceId   [IN] Instance of the driver to open and is used
552  *                      to differentiate multiple instance support on a
553  *                      single driver. Instance ID is driver specific.
554  *
555  *  \param createArgs   [IN] Pointer to the create argument structure. The type
556  *                      of the structure is defined by the specific driver.
557  *                      This parameter could be NULL depending on whether the
558  *                      actual driver forces it or not.
559  *
560  *  \param createStatusArgs [OUT] Pointer to status argument structure where the
561  *                      driver returns any status information. The type
562  *                      of the structure is defined by the specific driver.
563  *                      This parameter could be NULL depending on whether the
564  *                      actual driver forces it or not.
565  *
566  *  \param cbParams     [IN] Application callback parameters.
567  *                      This parameter could be NULL depending on whether the
568  *                      actual driver forces it or not.
569  *
570  *  \return non-NULL Fvid2_Handle object pointer on success else returns NULL
571  *  on error.
572  */
573 Fvid2_Handle Fvid2_create(uint32_t              drvId,
574                           uint32_t              instanceId,
575                           void                 *createArgs,
576                           void                 *createStatusArgs,
577                           const Fvid2_CbParams *cbParams);
579 /**
580  *  \brief Deletes a previously created FVID2 driver handle.
581  *
582  *  This free's the HW/SW resources allocated during create
583  *
584  *  \param handle       [IN] FVID2 handle returned by create call.
585  *
586  *  \param deleteArgs   [IN] Pointer to the delete argument structure. The type
587  *                      of the structure is defined by the specific driver.
588  *                      This parameter could be NULL depending on whether the
589  *                      actual driver forces it or not.
590  *
591  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
592  */
593 int32_t Fvid2_delete(Fvid2_Handle handle, void *deleteArgs);
595 /**
596  *  \brief Send control commands (IOCTLs) to the driver.
597  *
598  *  \param handle       [IN] FVID2 handle returned by create call.
599  *
600  *  \param cmd          [IN] IOCTL command. The type of command supported
601  *                      is defined by the specific driver.
602  *
603  *  \param cmdArgs      [IN] Pointer to the command argument structure. The type
604  *                      of the structure is defined by the specific driver
605  *                      for each of the supported IOCTL.
606  *                      This parameter could be NULL depending on whether the
607  *                      actual driver forces it or not.
608  *
609  *  \param cmdStatusArgs [OUT] Pointer to status argument structure where the
610  *                      driver returns any status information. The type
611  *                      of the structure is defined by the specific driver
612  *                      for each of the supported IOCTL.
613  *                      This parameter could be NULL depending on whether the
614  *                      actual driver forces it or not.
615  *
616  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
617  */
618 int32_t Fvid2_control(Fvid2_Handle  handle,
619                       uint32_t      cmd,
620                       void         *cmdArgs,
621                       void         *cmdStatusArgs);
623 /**
624  *  \brief An application calls Fvid2_queue to submit a video buffer to the
625  *  video device driver.
626  *
627  *  - This is used in capture/display drivers.
628  *  - This function could be called from task or ISR context unless the specific
629  *  driver restricts from doing so.
630  *  - This is a non-blocking API unless the specific driver restricts from
631  *  doing so.
632  *
633  *  \param handle       [IN] FVID2 handle returned by create call.
634  *  \param frameList    [IN] Pointer to the frame list structure containing the
635  *                      information about the FVID2 frames that has to be
636  *                      queued in the driver.
637  *  \param streamId     [IN] Stream ID to which the frames should be queued
638  *                      This is used in drivers where they could support
639  *                      multiple streams for the same handle. Otherwise this
640  *                      should be set to zero.
641  *
642  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
643  */
644 int32_t Fvid2_queue(Fvid2_Handle        handle,
645                     Fvid2_FrameList    *frameList,
646                     uint32_t            streamId);
648 /**
649  *  \brief An application calls Fvid2_dequeue to request the video device
650  *  driver to give ownership of a video buffer.
651  *
652  *  - This is used in capture/display drivers.
653  *  - This is a non-blocking API if timeout is FVID2_TIMEOUT_NONE and could be
654  *  called by task and ISR context unless the specific driver restricts from
655  *  doing so.
656  *  - This is blocking API if timeout is FVID2_TIMEOUT_FOREVER if supported by
657  *  specific driver implementation.
658  *
659  *  \param handle       [IN] FVID2 handle returned by create call.
660  *  \param frameList    [OUT] Pointer to the frame list structure where the
661  *                      dequeued frame pointer will be stored.
662  *  \param streamId     [IN] Stream ID from where frames should be dequeued.
663  *                      This is used in drivers where it could support multiple
664  *                      streams for the same handle. Otherwise this
665  *                      should be set to zero.
666  *  \param timeout      [IN] FVID2 timeout in units of OS ticks. This will
667  *                      determine the timeout value till the driver will block
668  *                      for a free or completed buffer is available.
669  *                      For non-blocking drivers this parameter might be
670  *                      ignored.
671  *
672  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
673  */
674 int32_t Fvid2_dequeue(Fvid2_Handle      handle,
675                       Fvid2_FrameList  *frameList,
676                       uint32_t          streamId,
677                       uint32_t          timeout);
679 /**
680  *  \brief An application calls Fvid2_processRequest to submit a video buffer
681  *  to the video device driver.
682  *
683  *  This API is used for submitting a single channel video processing request
684  *  to the video device driver. It uses framelist to submit multiple
685  *  frames of different stream ids of the same request.
686  *
687  *  - This function could be called from task or ISR context unless the specific
688  *  driver restricts from doing so.
689  *  - This is a non-blocking API unless the specific driver restricts from
690  *  doing so.
691  *
692  *  \param handle       [IN] FVID2 handle returned by create call.
693  *  \param inFrameList  [IN] Pointer to the array of input frames with
694  *                           different stream ids.
695  *  \param outFrameList [IN] Pointer to the array of output frames with
696  *                           different stream ids
697  *
698  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
699  */
700 int32_t Fvid2_processRequest(Fvid2_Handle       handle,
701                              Fvid2_FrameList   *inFrameList,
702                              Fvid2_FrameList   *outFrameList);
704 /**
705  *  \brief An application calls Fvid2_getProcessedRequest to get the
706  *  processed request back from the driver and thus to get the
707  *  ownership of request back from the driver.
708  *
709  *  - This is a non-blocking API if timeout is FVID2_TIMEOUT_NONE and could be
710  *  called by task and ISR context unless the specific driver restricts from
711  *  doing so.
712  *  - This is blocking API if timeout is FVID2_TIMEOUT_FOREVER if supported by
713  *  specific driver implementation.
714  *
715  *  \param handle       [IN] FVID2 handle returned by create call.
716  *  \param inFrameList  [OUT] Pointer to frame list in which input frames with
717  *                            different stream ids will be returned
718  *                            by the driver.
719  *  \param outFrameList [OUT] Pointer to frame list in which output frames with
720  *                            different stream ids will be returned by
721  *                            the driver.
722  *  \param timeout      [IN] FVID2 timeout. This will determine the timeout
723  *                           value till the driver will block for a
724  *                           free or completed buffer is available.
725  *                           For non-blocking drivers this parameter
726  *                           might be ignored.
727  *
728  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
729  */
730 int32_t Fvid2_getProcessedRequest(Fvid2_Handle      handle,
731                                   Fvid2_FrameList  *inFrameList,
732                                   Fvid2_FrameList  *outFrameList,
733                                   uint32_t          timeout);
734 /**
735  *  \brief An application calls Fvid2_start to request the video device
736  *  driver to start the video display or capture operation.
737  *  This function should be called from task context only and should not be
738  *  called from ISR context.
739  *
740  *  \param handle       [IN] FVID2 handle returned by create call.
741  *  \param cmdArgs      [IN] Pointer to the start argument structure. The type
742  *                      of the structure is defined by the specific driver.
743  *                      This parameter could be NULL depending on whether the
744  *                      actual driver forces it or not.
745  *
746  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
747  */
748 static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs);
750 /**
751  *  \brief An application calls Fvid2_stop to request the video device
752  *  driver to stop the video display or capture operation.
753  *  This function should be called from task context only and should not be
754  *  called from ISR context.
755  *
756  *  \param handle       [IN] FVID2 handle returned by create call.
757  *  \param cmdArgs      [IN] Pointer to the stop argument structure. The type
758  *                      of the structure is defined by the specific driver.
759  *                      This parameter could be NULL depending on whether the
760  *                      actual driver forces it or not.
761  *
762  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
763  */
764 static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs);
766 /**
767  *  \brief An application calls Fvid2_setFormat to request the video device
768  *  driver to set the format for a given channel.
769  *  This function should be called from task context only and should not be
770  *  called from ISR context.
771  *
772  *  \param handle       [IN] FVID2 handle returned by create call.
773  *  \param fmt          [IN] Pointer to the FVID2 format structure.
774  *
775  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
776  */
777 static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
779 /**
780  *  \brief An application calls Fvid2_getFormat to request the video device
781  *  driver to get the current format for a given channel.
782  *  This function should be called from task context only and should not be
783  *  called from ISR context.
784  *
785  *  \param handle       [IN] FVID2 handle returned by create call.
786  *  \param fmt          [OUT] Pointer to the FVID2 format structure.
787  *
788  *  \return FVID2_SOK on success, else appropriate FVID2 error code on failure.
789  */
790 static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
792 /**
793  *  \brief Fvid2_CbParams structure init function.
794  *
795  *  \param cbPrms       [IN] Pointer to #Fvid2_CbParams structure.
796  *
797  */
798 static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms);
800 /* ========================================================================== */
801 /*                       Static Function Definitions                          */
802 /* ========================================================================== */
804 static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs)
806     return Fvid2_control(handle, FVID2_START, cmdArgs, NULL);
809 static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs)
811     return Fvid2_control(handle, FVID2_STOP, cmdArgs, NULL);
814 static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
816     return Fvid2_control(handle, FVID2_SET_FORMAT, fmt, NULL);
819 static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
821     return Fvid2_control(handle, FVID2_GET_FORMAT, fmt, NULL);
824 static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms)
826     if (NULL != cbPrms)
827     {
828         cbPrms->cbFxn    = NULL;
829         cbPrms->errCbFxn = NULL;
830         cbPrms->errList  = NULL;
831         cbPrms->appData  = NULL;
832     }
834     return;
837 #ifdef __cplusplus
839 #endif
841 #endif  /* #ifndef FVID2_API_H_ */
843 /* @} */