Camera.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef ti_drivers_Camera__include
#define ti_drivers_Camera__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stddef.h>

#define CAMERA_CMD_RESERVED          32

#define CAMERA_STATUS_RESERVED      -32

#define CAMERA_STATUS_SUCCESS       0

#define CAMERA_STATUS_ERROR        -1

#define CAMERA_STATUS_UNDEFINEDCMD -2

/* Add Camera_CMD_<commands> here */

#define Camera_WAIT_FOREVER ~(0)

typedef struct Camera_Config      *Camera_Handle;

typedef void        (*Camera_Callback)    (Camera_Handle, void *buf,
                                           size_t bufferLength);

typedef enum Camera_CaptureMode {
    Camera_MODE_BLOCKING,

    Camera_MODE_CALLBACK
} Camera_CaptureMode;

typedef enum Camera_HSyncPolarity {
    Camera_HSYNC_POLARITY_HIGH = 0,
    Camera_HSYNC_POLARITY_LOW
} Camera_HSyncPolarity;

typedef enum Camera_VSyncPolarity {
    Camera_VSYNC_POLARITY_HIGH = 0,
    Camera_VSYNC_POLARITY_LOW
} Camera_VSyncPolarity;

typedef enum Camera_PixelClkConfig {
    Camera_PCLK_CONFIG_RISING_EDGE = 0,
    Camera_PCLK_CONFIG_FALLING_EDGE
} Camera_PixelClkConfig;

typedef enum Camera_ByteOrder {
    Camera_BYTE_ORDER_NORMAL = 0,
    Camera_BYTE_ORDER_SWAP
} Camera_ByteOrder;

typedef enum Camera_IfSynchoronisation {
    Camera_INTERFACE_SYNC_OFF = 0,
    Camera_INTERFACE_SYNC_ON
} Camera_IfSynchoronisation;

typedef enum Camera_StopCaptureConfig {
    Camera_STOP_CAPTURE_IMMEDIATE = 0,
    Camera_STOP_CAPTURE_FRAME_END
} Camera_StopCaptureConfig;

typedef enum Camera_StartCaptureConfig {
    Camera_START_CAPTURE_IMMEDIATE = 0,
    Camera_START_CAPTURE_FRAME_START
} Camera_StartCaptureConfig;

typedef struct Camera_Params {
    Camera_CaptureMode         captureMode;

    uint32_t                    outputClock;

    Camera_HSyncPolarity       hsyncPolarity;

    Camera_VSyncPolarity       vsyncPolarity;

    Camera_PixelClkConfig      pixelClkConfig;

    Camera_ByteOrder           byteOrder;

    Camera_IfSynchoronisation  interfaceSync;

    Camera_StopCaptureConfig   stopConfig;

    Camera_StartCaptureConfig  startConfig;

    uint32_t                   captureTimeout;

    Camera_Callback            captureCallback;

    uintptr_t                  custom;
} Camera_Params;

typedef void        (*Camera_CloseFxn)    (Camera_Handle handle);

typedef int         (*Camera_ControlFxn)  (Camera_Handle handle,
                                           unsigned int cmd,
                                           void *arg);

typedef void        (*Camera_InitFxn)     (Camera_Handle handle);

typedef Camera_Handle  (*Camera_OpenFxn)   (Camera_Handle handle,
                                            Camera_Params *params);

typedef int        (*Camera_CaptureFxn) (Camera_Handle handle,
                                          void *buffer, size_t bufferlen);

typedef struct Camera_FxnTable {
    Camera_CloseFxn        closeFxn;

    Camera_ControlFxn      controlFxn;

    Camera_InitFxn         initFxn;

    Camera_OpenFxn         openFxn;

    Camera_CaptureFxn     captureFxn;
} Camera_FxnTable;

typedef struct Camera_Config {
    Camera_FxnTable const *fxnTablePtr;

    void                  *object;

    void            const *hwAttrs;
} Camera_Config;

extern void Camera_close(Camera_Handle handle);

extern int Camera_control(Camera_Handle handle, uint32_t cmd, void *arg);

extern void Camera_init(void);

extern Camera_Handle Camera_open(uint32_t index, Camera_Params *params);

extern void Camera_Params_init(Camera_Params *params);

extern int Camera_capture(Camera_Handle handle, void *buffer, size_t bufferlen);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_Camera__include */