gmsl_cam_ser.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   gmsl_cam_ser.h
 *   @brief  Header file of gmsl camera serializer 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_SER_H
#define GMSL_CAM_SER_H
 
#include <stdint.h>
#include <stdbool.h>
#include "no_os_i2c.h"
 
#define GMSL_CAM_SER_CSI2_MAX_MIPI_PHY_PER_PORT                 (2)
#define GMSL_CAM_SER_CSI2_MAX_SENSOR_LANES                      (4)
#define GMSL_CAM_SER_CSI2_MAX_DATA_LANES                        (4)
#define GMSL_CAM_SER_CSI2_MAX_DATA_LANES_PER_MIPI_PHY           (2)

struct gmsl_csi_ser_mipi_cfg {
    unsigned int
    lane[GMSL_CAM_SER_CSI2_MAX_DATA_LANES_PER_MIPI_PHY];         
 
    bool lane_polarities[GMSL_CAM_SER_CSI2_MAX_DATA_LANES_PER_MIPI_PHY +
                                       1];  
};

struct gmsl_pipe_ser_pipe_cfg {
    unsigned int index;                 
    unsigned int
    phy_id;                
    unsigned int stream_id;             
    unsigned int
    *dts;                  
    unsigned int
    num_dts;               
    unsigned int
    vcs;                   
    unsigned int
    soft_bpp;              
    unsigned int
    bpp;                   
    bool dbl8;                          
    bool dbl10;                         
    bool dbl12;                         
    bool enabled;                       
    bool active;                        
};

struct gmsl_link_ser_phy_cfg {
    unsigned int
    id;                              
    struct gmsl_csi_ser_mipi_cfg
        mipi;             
    bool enabled;                                 
    bool is_master;                               
};

struct gmsl_csi_ser_port_cfg {
    unsigned int
    index;                                                    
    unsigned int
    ctlr_idx;                                                 
    unsigned int
    lane_count;                                               
    bool en_deskew;                                                        
    bool en_cphy;                                                          
    bool enabled;                                                          
    struct gmsl_link_ser_phy_cfg
        phy[GMSL_CAM_SER_CSI2_MAX_MIPI_PHY_PER_PORT];  
};

struct gmsl_dev_csi_ser_init_param {
    char *dev_name;                                          
    uint8_t index;                                              
    void *dev_instance_mem;                                      
    void *dev_state_mem;                                        
};
 
#endif /* GMSL_CAM_SER_H */