ra8_mipi_phy_ops.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"
#include "ra8_mipi_phy_types.h"
 
/* =============================================================================
 * Operations
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_lane_speed(const ra8_mipi_phy_pll_t* pll);

[[nodiscard]] ra8_err_t ra8_mipi_phy_switch_mode(ra8_mipi_phy_mode_t mode);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_lane_count(ra8_mipi_phy_lane_count_t count);

ra8_mipi_phy_lane_count_t ra8_mipi_phy_get_lane_count(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_lane_enable(ra8_mipi_phy_lane_id_t lane, bool enable);

bool ra8_mipi_phy_is_lane_enabled(ra8_mipi_phy_lane_id_t lane);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_clock_mode(ra8_mipi_phy_clk_mode_t mode);

ra8_mipi_phy_clk_mode_t ra8_mipi_phy_get_clock_mode(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_eotp(ra8_mipi_phy_eotp_t eotp);

ra8_mipi_phy_eotp_t ra8_mipi_phy_get_eotp(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_pclka_freq(uint8_t mhz);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_escape_divisor(uint8_t escdiv);

[[nodiscard]] ra8_err_t ra8_mipi_phy_select_timing(ra8_mipi_phy_mode_t    mode,
                                                   uint8_t                pclka_mhz,
                                                   uint16_t               rate_mbps,
                                                   ra8_mipi_phy_timing_t* out_timing);

[[nodiscard]] ra8_err_t ra8_mipi_phy_validate_pll_band(const ra8_mipi_phy_pll_t* pll,
                                                       uint8_t                   mosc_mhz);

[[nodiscard]] ra8_err_t
ra8_mipi_phy_compute_pll_freq(const ra8_mipi_phy_pll_t* pll, uint8_t mosc_mhz, uint32_t* out_mhz);

[[nodiscard]] ra8_err_t ra8_mipi_phy_lookup_timing(ra8_mipi_phy_mode_t    mode,
                                                   uint8_t                pclka_mhz,
                                                   uint16_t               rate_mbps,
                                                   ra8_mipi_phy_timing_t* out_timing);

[[nodiscard]] ra8_err_t ra8_mipi_phy_get_status_decoded(ra8_mipi_phy_status_decoded_t* out);

ra8_mipi_phy_state_t ra8_mipi_phy_get_state(void);

ra8_mipi_phy_mode_t ra8_mipi_phy_get_active_mode(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_dual_mode(ra8_mipi_phy_dual_mode_t mode);

ra8_mipi_phy_dual_mode_t ra8_mipi_phy_get_dual_mode(void);

bool ra8_mipi_phy_dual_mode_can_acquire(ra8_mipi_phy_mode_t requestor);

[[nodiscard]] ra8_err_t ra8_mipi_phy_set_pclka_freq_hz(uint32_t hz);

[[nodiscard]] ra8_err_t ra8_mipi_phy_compute_lane_rate_mbps(const ra8_mipi_phy_pll_t* pll,
                                                            uint8_t                   mosc_mhz,
                                                            uint32_t*                 out_mbps);
 
#ifdef __cplusplus
}
#endif