max96792.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   max96792.h
 *   @brief  Header file of MAX96792 Driver.
 *   @author Automotive Software and Systems team, Bangalore, India
********************************************************************************
 * Copyright 2025(c) Analog Devices, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of Analog Devices, Inc. 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 ANALOG DEVICES, INC. "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 ANALOG DEVICES, INC. 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 MAX96792_H
#define MAX96792_H
 
#include <stdint.h>
#include "gmsl_common.h"
#include "gmsl_dbg.h"
#include "no_os_error.h"
#include "no_os_alloc.h"
#include "gmsl_cam_des.h"
 
#define MAX96792_DEV_STATE_MEM_SIZE         (sizeof(struct max96792_state))
#define MAX96792_MAX_DATA_LANES              (4U)

enum max96792_link {
    MAX96792_LINK_A = 0u, 
    MAX96792_LINK_B = 1u, 
};

enum max96792_video_pipes {
    MAX96792_VIDEO_PIPE_Y = 0u, 
    MAX96792_VIDEO_PIPE_Z = 1u, 
};
 
enum max96792_data_lanes {
    MAX96792_DATA_LANE_0    = 0,
    MAX96792_DATA_LANE_1    = 1,
    MAX96792_DATA_LANE_2    = 2,
    MAX96792_DATA_LANE_3    = 3,
};

enum max96792_data_type {
    MAX96792_DATA_TYPE_DEFAULT      = 0x0u,           
    MAX96792_DATA_TYPE_GENERIC8_A   = 0x10u,          
    MAX96792_DATA_TYPE_GENERIC8_B   = 0x11u,          
    MAX96792_DATA_TYPE_EMB8         = 0x12u,          
    MAX96792_DATA_TYPE_YUV422_8BIT  = 0x1Eu,          
    MAX96792_DATA_TYPE_YUV422_10BIT = 0x1Fu,          
    MAX96792_DATA_TYPE_RGB565       = 0x22u,          
    MAX96792_DATA_TYPE_RGB666       = 0x23u,          
    MAX96792_DATA_TYPE_RGB888       = 0x24u,          
    MAX96792_DATA_TYPE_RAW8         = 0x2Au,          
    MAX96792_DATA_TYPE_RAW10        = 0x2Bu,          
    MAX96792_DATA_TYPE_RAW12        = 0x2Cu,          
    MAX96792_DATA_TYPE_RAW14        = 0x2Du,          
    MAX96792_DATA_TYPE_RAW16        = 0x2Eu,          
    MAX96792_DATA_TYPE_RAW20        = 0x2Fu,          
    MAX96792_DATA_TYPE_YUV422_12BIT = 0x30u,          
    MAX96792_DATA_TYPE_UDP8_A       = 0x31u,          
    MAX96792_DATA_TYPE_UDP8_B       = 0x32u,          
    MAX96792_DATA_TYPE_UDP8_C       = 0x33u,          
    MAX96792_DATA_TYPE_UDP8_D       = 0x34u,          
    MAX96792_DATA_TYPE_UDP8_E       = 0x35u,          
    MAX96792_DATA_TYPE_UDP8_F       = 0x36u,          
    MAX96792_DATA_TYPE_UDP8_G       = 0x37u           
};

struct max96792_dev_capabilities {
    uint8_t max_links_count; 
    uint8_t max_lmn_count;   
    uint8_t max_phy_ctrlr;   
};

struct max96792_state {
    uint8_t dummy;          
};
 
int32_t max96792_init(struct gmsl_dev **device, struct no_os_i2c_desc *i2c_desc,
              void *init_param);
int32_t max96792_remove(struct gmsl_dev *dev);
 
#endif /* MAX96792_H */