ra8_mipi_phy_types.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_mipi_phy_regs.h"

typedef enum : uint8_t {
  k_ra8_mipi_phy_mode_csi_device = 0U, 
  k_ra8_mipi_phy_mode_dsi_host   = 1U, 
} ra8_mipi_phy_mode_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_lane_count_1 = 1U, 
  k_ra8_mipi_phy_lane_count_2 = 2U, 
  k_ra8_mipi_phy_lane_count_3 = 3U, 
  k_ra8_mipi_phy_lane_count_4 = 4U, 
} ra8_mipi_phy_lane_count_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_lane_clk = 0U, 
  k_ra8_mipi_phy_lane_d0  = 1U, 
  k_ra8_mipi_phy_lane_d1  = 2U, 
  k_ra8_mipi_phy_lane_d2  = 3U, 
  k_ra8_mipi_phy_lane_d3  = 4U, 
} ra8_mipi_phy_lane_id_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_clk_noncontinuous = 0U, 
  k_ra8_mipi_phy_clk_continuous    = 1U, 
} ra8_mipi_phy_clk_mode_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_eotp_disabled = 0U, 
  k_ra8_mipi_phy_eotp_enabled  = 1U, 
} ra8_mipi_phy_eotp_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_idiv_1 = 0U, 
  k_ra8_mipi_phy_idiv_2 = 1U, 
  k_ra8_mipi_phy_idiv_3 = 2U, 
  k_ra8_mipi_phy_idiv_4 = 3U, 
} ra8_mipi_phy_pll_idiv_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_pmul_1 = 0U, 
  k_ra8_mipi_phy_pmul_2 = 1U, 
  k_ra8_mipi_phy_pmul_4 = 2U, 
  k_ra8_mipi_phy_pmul_8 = 3U, 
} ra8_mipi_phy_pll_pmul_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_nfmul_0_00 = 0U, 
  k_ra8_mipi_phy_nfmul_0_33 = 1U, 
  k_ra8_mipi_phy_nfmul_0_66 = 2U, 
  k_ra8_mipi_phy_nfmul_0_50 = 3U, 
} ra8_mipi_phy_pll_nfmul_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_event_ldo_ready  = 0U, 
  k_ra8_mipi_phy_event_ldo_lost   = 1U, 
  k_ra8_mipi_phy_event_pll_locked = 2U, 
  k_ra8_mipi_phy_event_pll_lost   = 3U, 
  k_ra8_mipi_phy_event_status_chg = 4U, 
} ra8_mipi_phy_event_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_state_off     = 0U, 
  k_ra8_mipi_phy_state_idle    = 1U, 
  k_ra8_mipi_phy_state_ldo_up  = 2U, 
  k_ra8_mipi_phy_state_pll_run = 3U, 
  k_ra8_mipi_phy_state_run     = 4U, 
  k_ra8_mipi_phy_state_error   = 5U, 
} ra8_mipi_phy_state_t;

typedef enum : uint8_t {
  k_ra8_mipi_phy_dual_off          = 0U, 
  k_ra8_mipi_phy_dual_alternate    = 1U, 
  k_ra8_mipi_phy_dual_dsi_priority = 2U, 
  k_ra8_mipi_phy_dual_csi_priority = 3U, 
} ra8_mipi_phy_dual_mode_t;

typedef struct {
  bool     ldo_ready;  
  bool     pll_locked; 
  bool     phy_ready;  
  uint32_t raw;        
} ra8_mipi_phy_status_decoded_t;

typedef struct {
  ra8_mipi_phy_pll_idiv_t  idiv;     
  ra8_mipi_phy_pll_pmul_t  pmul;     
  ra8_mipi_phy_pll_nfmul_t nfmul;    
  uint16_t                 nmul_int; 
} ra8_mipi_phy_pll_t;

typedef struct {
  uint32_t tinit;    
  uint8_t  tclkprep; 
  uint8_t  tclksett; 
  uint8_t  tclkmiss; 
  uint8_t  thsprep;  
  uint8_t  thssett;  
  uint8_t  tclkzero; 
  uint8_t  tclkpre;  
  uint8_t  tclkpost; 
  uint8_t  tclktrl;  
  uint8_t  thszero;  
  uint8_t  thstrl;   
  uint8_t  thsexit;  
  uint8_t  tlpx;     
} ra8_mipi_phy_timing_t;

typedef struct {
  ra8_mipi_phy_mode_t          mode;           
  uint8_t                      pclka_mhz;      
  uint16_t                     line_rate_mbps; 
  ra8_mipi_phy_lane_count_t    lane_count;     
  ra8_mipi_phy_clk_mode_t      clk_mode;       
  ra8_mipi_phy_eotp_t          eotp;           
  ra8_mipi_phy_pll_t           pll;            
  uint8_t                      escdiv;         
  const ra8_mipi_phy_timing_t* p_timing;       
} ra8_mipi_phy_config_t;

typedef void (*ra8_mipi_phy_event_fn_t)(void* ctx, ra8_mipi_phy_event_t event, uint32_t sfr);
 
#ifdef __cplusplus
}
#endif