fvid2_api.h

Go to the documentation of this file.

/*
 *  Copyright (c) Texas Instruments Incorporated 2023
 *
 *  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 FVID2_API_H_
#define FVID2_API_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <drivers/fvid2/v0/fvid2_dataTypes.h>
#include <drivers/fvid2/v0/fvid2_trace.h>
#include <drivers/fvid2/v0/fvid2_utils.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define FVID2_VERSION_STRING            "FVID_02_02_00_00"
 
#define FVID2_VERSION_NUMBER            (0x02020000U)
 
typedef void *Fvid2_Handle;
 
typedef int32_t (*Fvid2_CbFxn)(Fvid2_Handle handle, void *appData);
 
typedef int32_t (*Fvid2_ErrCbFxn)(Fvid2_Handle handle,
                                  void        *appData,
                                  void        *errList);
 
typedef int32_t (*Fvid2_SubFrameCbFxn)(Fvid2_Handle handle,
                                       Fvid2_Frame *subFrame);
 
typedef uint64_t (*Fvid2_TimeStampFxn)(void *args);
 
typedef void (*Fvid2_PrintFxn)(const char *format, ...);
 
#define FVID2_STREAM_ID_ANY             (0xFFFFFFFFU)
 
/*
 * =========== Command codes for Submit call =============
 */
#define FVID2_CTRL_BASE                 (0x00000000U)
 
#define FVID2_USER_BASE                 (0x10000000U)
 
#define FVID2_SET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 3U)
 
#define FVID2_GET_FORMAT                ((uint32_t) FVID2_CTRL_BASE + 4U)
 
#define FVID2_START                     ((uint32_t) FVID2_CTRL_BASE + 5U)
 
#define FVID2_STOP                      ((uint32_t) FVID2_CTRL_BASE + 6U)
 
#define FVID2_REGISTER_TIMESTAMP_FXN    ((uint32_t) FVID2_CTRL_BASE + 7U)
 
/*
 *  Driver ID Base.
 */
#define FVID2_DSS_DRV_BASE              (0x00001000U)
 
#define FVID2_CAL_DRV_BASE              (0x00002000U)
 
#define FVID2_CSIRX_DRV_BASE            (0x00003000U)
 
#define FVID2_CSITX_DRV_BASE            (0x00004000U)
 
#define FVID2_VHWA_DRV_BASE             (0x00005000U)
 
/*
 *  IOCTLs Base.
 */
#define FVID2_DSS_DRV_IOCTL_BASE        (FVID2_USER_BASE + FVID2_DSS_DRV_BASE)
 
#define FVID2_CAL_DRV_IOCTL_BASE        (FVID2_USER_BASE + FVID2_CAL_DRV_BASE)
 
#define FVID2_CSIRX_DRV_IOCTL_BASE      (FVID2_USER_BASE + FVID2_CSIRX_DRV_BASE)
 
#define FVID2_CSITX_DRV_IOCTL_BASE      (FVID2_USER_BASE + FVID2_CSITX_DRV_BASE)
 
#define FVID2_VHWA_DRV_IOCTL_BASE       (FVID2_USER_BASE + FVID2_VHWA_DRV_BASE)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    Fvid2_CbFxn    cbFxn;
    Fvid2_ErrCbFxn errCbFxn;
    void           *errList;
    void           *appData;
} Fvid2_CbParams;
 
typedef struct
{
    Fvid2_TimeStampFxn  timeStampFxn;
    uint32_t reserved;
} Fvid2_TimeStampParams;
 
typedef struct
{
    Fvid2_PrintFxn      printFxn;
} Fvid2_InitPrms;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
int32_t Fvid2_init(const Fvid2_InitPrms *initPrms);
 
int32_t Fvid2_deInit(void *args);
 
const char *Fvid2_getVersionString(void);
 
uint32_t Fvid2_getVersionNumber(void);
 
Fvid2_Handle Fvid2_create(uint32_t              drvId,
                          uint32_t              instanceId,
                          void                 *createArgs,
                          void                 *createStatusArgs,
                          const Fvid2_CbParams *cbParams);
 
int32_t Fvid2_delete(Fvid2_Handle handle, void *deleteArgs);
 
int32_t Fvid2_control(Fvid2_Handle  handle,
                      uint32_t      cmd,
                      void         *cmdArgs,
                      void         *cmdStatusArgs);
 
int32_t Fvid2_queue(Fvid2_Handle        handle,
                    Fvid2_FrameList    *frameList,
                    uint32_t            streamId);
 
int32_t Fvid2_dequeue(Fvid2_Handle      handle,
                      Fvid2_FrameList  *frameList,
                      uint32_t          streamId,
                      uint32_t          timeout);
 
int32_t Fvid2_processRequest(Fvid2_Handle       handle,
                             Fvid2_FrameList   *inFrameList,
                             Fvid2_FrameList   *outFrameList,
                             uint32_t           timeout);
 
int32_t Fvid2_getProcessedRequest(Fvid2_Handle      handle,
                                  Fvid2_FrameList  *inFrameList,
                                  Fvid2_FrameList  *outFrameList,
                                  uint32_t          timeout);
static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs);
 
static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs);
 
static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
 
static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt);
 
/*
 * Structure Init functions
 */
static inline void Fvid2InitPrms_init(Fvid2_InitPrms *initPrms);
 
static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms);
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
static inline int32_t Fvid2_start(Fvid2_Handle handle, void *cmdArgs)
{
    return Fvid2_control(handle, FVID2_START, cmdArgs, NULL);
}
 
static inline int32_t Fvid2_stop(Fvid2_Handle handle, void *cmdArgs)
{
    return Fvid2_control(handle, FVID2_STOP, cmdArgs, NULL);
}
 
static inline int32_t Fvid2_setFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
{
    return Fvid2_control(handle, FVID2_SET_FORMAT, fmt, NULL);
}
 
static inline int32_t Fvid2_getFormat(Fvid2_Handle handle, Fvid2_Format *fmt)
{
    return Fvid2_control(handle, FVID2_GET_FORMAT, fmt, NULL);
}
 
static inline void Fvid2InitPrms_init(Fvid2_InitPrms *initPrms)
{
    if (NULL != initPrms)
    {
        initPrms->printFxn  = NULL;
    }
 
    return;
}
 
static inline void Fvid2CbParams_init(Fvid2_CbParams *cbPrms)
{
    if (NULL != cbPrms)
    {
        cbPrms->cbFxn    = NULL;
        cbPrms->errCbFxn = NULL;
        cbPrms->errList  = NULL;
        cbPrms->appData  = NULL;
    }
 
    return;
}
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef FVID2_API_H_ */