max96793_diag.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   max96793_diag.h
 *   @brief  Header file of Diagnostics Driver Implementation of MAX96793 Serializer.
 *   @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 MAX96793_DIAG_H
#define MAX96793_DIAG_H
 
#include "max96793.h"
#include "gmsl_common.h"
#define MAX96793_CSI_DIAG_NUM_OF_MIPI_PKT_READ              (4U)    
#define MAX96793_CSI_DIAG_MIPI_PKT_READ_DELAY               (10U)   
#define MAX96793_MAX_LANE_COUNT                             (4U)    
#define MAX96793_MAX_VIDEO_STREAMS                          (16U)   
#define MAX96793_MAX_VIRTUAL_CHANNEL                        (16U)   

enum max96793_link_diag_lmn_status {
    MAX96793_LINK_DIAG_LMN_SHORT_TO_BAT = 0u,        
    MAX96793_LINK_DIAG_LMN_SHORT_TO_GND = 1u,        
    MAX96793_LINK_DIAG_LMN_NORMAL = 2u,              
    MAX96793_LINK_DIAG_LMN_LINE_OPEN = 3u,           
    MAX96793_LINK_DIAG_LMN_LINE_TO_LINE_SHORT = 4u   
};

enum max96793_link_diag_lmn {
    MAX96793_LINK_LMN_0 = 0u,             
    MAX96793_LINK_LMN_1 = 1u,             
};

enum max96793_sensor_lane {
    MAX96793_SENSOR_LANE_0 = 0u,          
    MAX96793_SENSOR_LANE_1 = 1u,          
    MAX96793_SENSOR_LANE_2 = 2u,          
    MAX96793_SENSOR_LANE_3 = 3u           
};

enum max96793_serializer_lane {
    MAX96793_SERIALIZER_LANE_0 = 0u,      
    MAX96793_SERIALIZER_LANE_1 = 1u,      
    MAX96793_SERIALIZER_LANE_2 = 2u,      
    MAX96793_SERIALIZER_LANE_3 = 3u       
};

enum max96793_lane_polarity {
    MAX96793_LANE_POLARITY_NORMAL = 0u,   
    MAX96793_LANE_POLARITY_INVERSE = 1u   
};

enum max96793_data_type {
    MAX96793_DATA_TYPE_DEFAULT      = 0x0u,           
    MAX96793_DATA_TYPE_GENERIC8_A   = 0x10u,          
    MAX96793_DATA_TYPE_GENERIC8_B   = 0x11u,          
    MAX96793_DATA_TYPE_EMB8         = 0x12u,          
    MAX96793_DATA_TYPE_YUV422_8BIT  = 0x1Eu,          
    MAX96793_DATA_TYPE_YUV422_10BIT = 0x1Fu,          
    MAX96793_DATA_TYPE_RGB565       = 0x22u,          
    MAX96793_DATA_TYPE_RGB666       = 0x23u,          
    MAX96793_DATA_TYPE_RGB888       = 0x24u,          
    MAX96793_DATA_TYPE_RAW8         = 0x2Au,          
    MAX96793_DATA_TYPE_RAW10        = 0x2Bu,          
    MAX96793_DATA_TYPE_RAW12        = 0x2Cu,          
    MAX96793_DATA_TYPE_RAW14        = 0x2Du,          
    MAX96793_DATA_TYPE_RAW16        = 0x2Eu,          
    MAX96793_DATA_TYPE_RAW20        = 0x2Fu,          
    MAX96793_DATA_TYPE_YUV422_12BIT = 0x30u,          
    MAX96793_DATA_TYPE_UDP8_A       = 0x31u,          
    MAX96793_DATA_TYPE_UDP8_B       = 0x32u,          
    MAX96793_DATA_TYPE_UDP8_C       = 0x33u,          
    MAX96793_DATA_TYPE_UDP8_D       = 0x34u,          
    MAX96793_DATA_TYPE_UDP8_E       = 0x35u,          
    MAX96793_DATA_TYPE_UDP8_F       = 0x36u,          
    MAX96793_DATA_TYPE_UDP8_G       = 0x37u           
};

enum max96793_video_stream {
    MAX96793_VID_STREAM_0 = 0u,                    
    MAX96793_VID_STREAM_1 = 1u,                    
    MAX96793_VID_STREAM_2 = 2u,                    
    MAX96793_VID_STREAM_3 = 3u,                    
    MAX96793_VID_STREAM_4 = 4u,                    
    MAX96793_VID_STREAM_5 = 5u,                    
    MAX96793_VID_STREAM_6 = 6u,                    
    MAX96793_VID_STREAM_7 = 7u,                    
    MAX96793_VID_STREAM_8 = 8u,                    
    MAX96793_VID_STREAM_9 = 9u,                    
    MAX96793_VID_STREAM_10 = 10u,                  
    MAX96793_VID_STREAM_11 = 11u,                  
    MAX96793_VID_STREAM_12 = 12u,                  
    MAX96793_VID_STREAM_13 = 13u,                  
    MAX96793_VID_STREAM_14 = 14u,                  
    MAX96793_VID_STREAM_15 = 15u                   
};

enum max96793_port {
    MAX96793_PORT_B = 1u            
};

enum max96793_data_type_size {
    MAX96793_DT_SIZE_0      = 0U,   
    MAX96793_DT_SIZE_8      = 8U,   
    MAX96793_DT_SIZE_10     = 10U,  
    MAX96793_DT_SIZE_12     = 12U,  
    MAX96793_DT_SIZE_14     = 14U,  
    MAX96793_DT_SIZE_16     = 16U,  
    MAX96793_DT_SIZE_18     = 18U,  
    MAX96793_DT_SIZE_20     = 20U,  
    MAX96793_DT_SIZE_24     = 24U,  
};

struct max96793_dev_diag_device_id_status {
    uint8_t dev_id;             
};

struct max96793_dev_diag_device_revision_status {
    uint8_t dev_rev;            
};

struct max96793_pipe_diag_decode_error_status {
    bool decode_err_link;        
    uint8_t decode_err_cnt;      
};

struct max96793_pipe_diag_idle_error_status {
    bool idle_err_detected;      
    uint8_t idle_err_cnt;        
};

struct max96793_link_diag_link_lock_status {
    bool link_locked;           
};

struct max96793_pipe_max_retrans_data {
    bool spi_chnl_retrans_err_detected;         
    uint8_t spi_chnl_retrans_count;             
    bool gpio_chnl_retrans_err_detected;        
    uint8_t gpio_chnl_retrans_count;            
    bool pass_thru_chnl1_retrans_err_detected;  
    uint8_t pass_thru_chnl1_retrans_count;      
    bool pass_thru_chnl2_retrans_err_detected;  
    uint8_t pass_thru_chnl2_retrans_count;      
};

struct max96793_pipe_diag_max_retransmission_error_status {
    bool max_retrans_err_detected;                                        
    struct max96793_pipe_max_retrans_data
        max_retrans_data;               
};

struct max96793_link_diag_line_fault_status {
    bool lf_int;                                                           
    enum max96793_link_diag_lmn_status
    lmn_err_status[MAX96793_LMN_COUNT]; 
};

struct max96793_csi_diag_pclkdet_status {
    bool pclk_detected;                               
};

struct max96793_pipe_diag_vid_tx_overflow_status {
    bool vid_tx_overflowed;                           
};

struct max96793_pipe_diag_vid_tx_pclk_drift_err_status {
    bool vid_tx_pclk_drift_err_detected;              
};

struct max96793_mem_diag_uncorrectable_2b_mem_ecc_err_status {
    bool uncorrectable_2b_mem_ecc_err_detected;       
};

struct max96793_csi_diag_mipi_phy_err_details {
    bool phy_hsync_lane0_1b_err_detected;               
    bool phy_hsync_lane1_1b_err_detected;               
    bool phy_hsync_lane0_2b_err_detected;               
    bool phy_hsync_lane1_2b_err_detected;               
    bool phy_hispeed_rx_skew_calib_lane0_err_detected;  
    bool phy_hispeed_rx_skew_calib_lane1_err_detected;  
};

struct max96793_csi_diag_mipi_ctrl_err_details {
    bool csi_ctrl_1b_ecc_err_detected;                   
    bool csi_ctrl_2b_ecc_err_detected;                   
    bool csi_ctrl_crc_err_detected;                      
    bool csi_ctrl_pkt_terminated_early_err_detected;     
    bool csi_ctrl_frame_cnt_err_detected;                
};

struct max96793_csi_diag_mipi_rx_err_status {
    bool mipi_rx_err_detected;                                                                   
    struct max96793_csi_diag_mipi_phy_err_details
        mipi_phy_err_details[MAX96793_MIPI_PHY_COUNT]; 
    struct max96793_csi_diag_mipi_ctrl_err_details
        mipi_ctrl_err_details;                        
};

struct max96793_link_diag_phy_low_power_err_status_details {
    bool unrecgnizd_esc_cmd_rcvd_on_d0;     
    bool unrecgnizd_esc_cmd_rcvd_on_clk;    
    bool invalid_line_seq_on_d0;            
    bool invalid_line_seq_on_d1;            
    bool invalid_line_seq_on_clk;           
};

struct max96793_link_diag_phy_low_power_err_status {
    struct max96793_link_diag_phy_low_power_err_status_details
        lp_err_sts_details[MAX96793_MIPI_PHY_COUNT]; 
};

struct max96793_csi_diag_mipi_pkt_cnt_status {
    bool mipi_pkt_cnt_err_detected;                                 
    bool tunnel_mode_enabled;                                       
    uint8_t phy_pkt_cnt[MAX96793_CSI_DIAG_NUM_OF_MIPI_PKT_READ];    
    uint8_t csi1_pkt_cnt[MAX96793_CSI_DIAG_NUM_OF_MIPI_PKT_READ];   
    uint8_t tun_pkt_cnt[MAX96793_CSI_DIAG_NUM_OF_MIPI_PKT_READ];    
    uint8_t phy_clk_cnt[MAX96793_CSI_DIAG_NUM_OF_MIPI_PKT_READ];    
};

struct max96793_pipe_diag_stream_id_status {
    bool pipe_enabled;        
    uint8_t stream_id;        
};

struct max96793_link_diag_eom_status {
    bool eom_error;         
};

struct max96793_dev_diag_rem_err_flg_status {
    bool is_remote_cc_disabled;                            
    bool remote_error;                                     
};

struct max96793_csi_diag_fec_active_status {
    bool is_remote_cc_disabled;                            
    bool is_fec_enabled;                                   
    bool is_fec_active;                                    
};

struct max96793_csi_video_stream_config {
    bool is_virtual_channel_enabled;        
    bool is_data_type_enabled;              
    enum max96793_data_type
    data_type;      
};

struct max96793_lane_config_status {
    uint8_t lane_count;                     
    enum max96793_sensor_lane
    sensor_lane[MAX96793_MAX_LANE_COUNT];               
    enum max96793_lane_polarity
    data_lane_polarity[MAX96793_MAX_LANE_COUNT];      
    enum max96793_lane_polarity
    clk_lane_polarity;                                
};

struct max96793_pipe_diag_config_status {
    uint8_t phy_config;                                                  
    enum max96793_port
    port_selected;                                    
    bool is_port_enabled;                                                
    bool is_video_started_in_port;                                       
    struct max96793_lane_config_status
        lane_config_status;               
};

struct max96793_csi_diag_part_config_status {
    bool tunnel_mode_enabled;                                                                    
    enum max96793_data_type_size
    soft_bpp_override;                                              
    bool is_soft_bpp_enabled;                                                                    
    bool is_pipe_enabled;                                                                        
    struct max96793_csi_video_stream_config
        video_stream_config[MAX96793_MAX_VIDEO_STREAMS];     
    struct max96793_pipe_diag_stream_id_status
        stream_id_status;                                 
    bool is_independent_mode_enabled;                                                            
    bool is_pixel_doubling_enabled;                                                              
};

struct max96793_dev_diag_part_config_status {
    struct max96793_pipe_diag_config_status
        pipe_config_status;                          
    struct max96793_csi_diag_part_config_status
        csi_config_status;                       
};
 
extern int max96793_dev_diag_get_device_id(struct gmsl_dev *dev,
        void *dev_id_status, bool *diag_err);
extern int max96793_dev_diag_check_device_rev(struct gmsl_dev *dev,
        void *dev_revision_status, bool *diag_err);
extern int max96793_dev_diag_check_part_config_status(struct gmsl_dev *dev,
        void *part_config_status, bool *diag_err);
extern int max96793_link_diag_check_decode_error_status(struct gmsl_dev *dev,
        void *decode_err_status, bool *diag_err);
extern int max96793_link_diag_check_idle_error_status(struct gmsl_dev *dev,
        void *idle_err_status, bool *diag_err);
extern int max96793_link_diag_check_link_lock_status(struct gmsl_dev *dev,
        void *link_lock_status, bool *diag_err);
extern int max96793_link_diag_check_max_retransmission_error_status(
    struct gmsl_dev *dev, void *max_retransmission_status, bool *diag_err);
extern int max96793_csi_diag_check_mipi_rx_err_status(struct gmsl_dev *dev,
        void *mipi_rx_err_status, bool *diag_err);
extern int max96793_csi_diag_check_vid_tx_pclk_drift_err_status(
    struct gmsl_dev *dev, void *vid_tx_pclk_drift_status, bool *diag_err);
extern int max96793_link_diag_check_line_fault_status(struct gmsl_dev *dev,
        void *line_fault_status, bool *diag_err);
extern int max96793_csi_diag_check_pclk_detect_status(struct gmsl_dev *dev,
        void *pclk_detect_status, bool *diag_err);
extern int max96793_pipe_diag_check_vid_tx_overflow_status(struct gmsl_dev *dev,
        void *vid_tx_ovrflw_status, bool *diag_err);
extern int max96793_mem_diag_check_uncorrectable_2b_mem_ecc_err_status(
    struct gmsl_dev *dev, void *uncorrectable_2b_mem_ecc_err_status,
    bool *diag_err);
extern int max96793_link_diag_check_phy_low_power_state_error_status(
    struct gmsl_dev *dev, void *lp_err_status, bool *diag_err);
extern int max96793_csi_diag_check_mipi_phy_pkt_cnt_status(struct gmsl_dev *dev,
        void *mipi_pkt_cnt_err_status, bool *diag_err);
extern int max96793_pipe_diag_check_stream_id(struct gmsl_dev *dev,
        void *stream_id_status, bool *diag_err);
extern int max96793_link_diag_check_eye_open_monitor_status(
    struct gmsl_dev *dev, void* eom_status, bool *diag_err);
extern int max96793_csi_diag_check_fec_status(struct gmsl_dev *dev,
        void *fec_active_status, bool *diag_err);
extern int max96793_dev_diag_check_remote_error_status(struct gmsl_dev *dev,
        void* rem_err_status, bool *diag_err);
extern int max96793_link_diag_get_link_lock_status(struct gmsl_dev *dev,
        bool *locked);
extern int max96793_dev_diag_get_errb_status(struct gmsl_dev *dev, bool *errb);
#endif