ra8_mipi_phy_api.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"
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_phy_init(const ra8_mipi_phy_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_mipi_phy_deinit(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_reset(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_recover_from_error(const ra8_mipi_phy_config_t* cfg);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_phy_get_status(uint32_t* out_mask);

bool ra8_mipi_phy_is_ldo_stable(void);

bool ra8_mipi_phy_is_pll_locked(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_wait_ready(void);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_phy_attach_handler(ra8_mipi_phy_event_fn_t fn, void* ctx);

void ra8_mipi_phy_dispatch(void);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_phy_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_exit_stop(const ra8_mipi_phy_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_mipi_phy_ldo_enable(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_ldo_disable(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_pll_start(void);

[[nodiscard]] ra8_err_t ra8_mipi_phy_pll_stop(void);
 
#ifdef __cplusplus
}
#endif