gmsl_cam_des.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   gmsl_cam_des.h
 *   @brief  Header file of gmsl camera deserializer common interface
 *   @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 GMSL_CAM_DES_H
#define GMSL_CAM_DES_H
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_i2c.h"
#include "gmsl_common.h"
 
#define GMSL_CAM_DES_CSI2_MAX_DATA_LANES           (4)
#define GMSL_CAM_DES_CSI2_MAX_DES_REMAPS_NUM       (16)
#define GMSL_CAM_DES_DT_VC(dt, vc)                 (((vc) & 0x3) << 6 | ((dt) & 0x3f))
#define MAX_NUM_LINKS                              (4)
enum gmsl_cc_port {
    GMSL_CC_PORTA = 0U,               
    GMSL_CC_PORTB = 1U,               
};

enum gmsl_csi_des_port {
    GMSL_CSI_DES_PORTA = 0U,                 
    GMSL_CSI_DES_PORTB = 1U,                 
};

enum gmsl_dev_des_mipi_lane_cnt {
    GMSL_DEV_DES_MIPI_LANE_CNT_1 = 0U,            
    GMSL_DEV_DES_MIPI_LANE_CNT_2 = 1U,            
    GMSL_DEV_DES_MIPI_LANE_CNT_3 = 2U,            
    GMSL_DEV_DES_MIPI_LANE_CNT_4 = 3U,            
};

enum gmsl_link_des_rx_phy_rate {
    GMSL_LINK_DES_RX_PHY_RATE_3G  = 1U,      
    GMSL_LINK_DES_RX_PHY_RATE_6G  = 2U,      
    GMSL_LINK_DES_RX_PHY_RATE_12G = 3U,      
};

enum gmsl_pipe_des_vc_remap_mode {
    GMSL_PIPE_DES_VC_REMAP_SRC_DST_MODE = 0U,       
    GMSL_PIPE_DES_VC_REMAP_PIPE_ID_MODE = 1U,       
    GMSL_PIPE_DES_VC_REMAP_LINK_ID_MODE = 2U,       
};

struct gmsl_csi_mipi_cfg {
    unsigned int
    flags;                                           
    unsigned char
    data_lanes[GMSL_CAM_DES_CSI2_MAX_DATA_LANES];   
    unsigned char
    clock_lane;                                     
    unsigned char
    num_data_lanes;                                 
    bool lane_polarities[GMSL_CAM_DES_CSI2_MAX_DATA_LANES];       
};

struct gmsl_pipe_des_dt_vc_remap {
    unsigned char
    from_dt;          
    unsigned char
    from_vc;          
    unsigned char
    to_dt;            
    unsigned char
    to_vc;            
    unsigned char
    phy;              
};

struct gmsl_pipe_des_pipe_cfg {
    enum gmsl_pipe
    index;                                                           
    unsigned int
    phy_id;                                                               
    unsigned int
    stream_id;                                                         
    uint8_t link_id;                                                                 
    struct gmsl_pipe_des_dt_vc_remap
        remaps[GMSL_CAM_DES_CSI2_MAX_DES_REMAPS_NUM];  
    unsigned int
    num_remaps;                                                           
    unsigned int
    con_dest;                                                           
    enum gmsl_pipe
    input_pipe;                                                       
    enum gmsl_pipe_des_vc_remap_mode
    vc_remap_mode;                                 
    unsigned int
    ser_cphy_lane_cnt;                                                 
    bool ser_cphy_mode;                                                                
    bool dbl8;                                                                      
    bool dbl10;                                                                        
    bool dbl12;                                                                        
    bool dbl8mode;                                                                  
    bool dbl10mode;                                                                    
    bool enabled;                                                                    
};

struct gmsl_link_des_phy_cfg {
    unsigned int
    index;                                         
    unsigned long long
    link_frequency;                       
    unsigned int
    mipi_clk;                                   
    struct gmsl_csi_mipi_cfg
        mipi;                           
    enum gmsl_link_des_rx_phy_rate
    phy_rate;               
    bool alt_mem_map8;                                      
    bool alt2_mem_map8;                                        
    bool alt_mem_map10;                                        
    bool alt_mem_map12;                                        
    bool enabled;                                            
    bool cphy_enabled;                                      
};

struct gmsl_dev_csi_des_init_param {
    char *dev_name;                                     
    uint8_t index;                                     
    bool tunnel_mode;                                    
    struct gmsl_cam_des_phy *phys;                      
    struct gmsl_cam_des_pipe *pipes;                   
    struct gmsl_cam_des_link *links;                   
    enum gmsl_link_des_rx_phy_rate
    link_rx_rate[MAX_NUM_LINKS]; 

    void *dev_instance_mem;                             
    void *dev_state_mem;                               
};
 
#endif // GMSL_CAM_DES_H