ra8_mipi_csi_ctrl.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_mipi_csi_regs.h"
#include "ra8_mipi_csi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_init(const ra8_mipi_csi_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_mipi_csi_deinit(void);

[[nodiscard]] ra8_err_t ra8_mipi_csi_reset(void);
 
/* =============================================================================
 * Reception control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_start_receive(void);

[[nodiscard]] ra8_err_t ra8_mipi_csi_stop_receive(void);
 
/* =============================================================================
 * Module-level status
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_mipi_csi_clear_status(uint32_t mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_set_rx_irq_enable(uint32_t mask);

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

[[nodiscard]] ra8_err_t ra8_mipi_csi_get_module_info(ra8_mipi_csi_module_info_t* out);
 
/* =============================================================================
 * Data-type filter
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_set_data_type_filter(uint32_t low_mask, uint32_t high_mask);
 
/* =============================================================================
 * ECC / scrambling / frame-error knobs
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_set_ecc_mode(bool eccv13, bool lfsren);

[[nodiscard]] ra8_err_t ra8_mipi_csi_set_frame_error_mode(bool zlmd, bool edmd, bool rvmd);
 
/* =============================================================================
 * EPD / LRTE tuning
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_mipi_csi_set_epd(bool enable, bool option_2, uint16_t long_spacer, uint16_t short_spacer);

[[nodiscard]] ra8_err_t ra8_mipi_csi_set_lrte(ra8_mipi_csi_vlsien_t vlsien, bool eotp_enable);
 
/* =============================================================================
 * Per-data-lane status / IRQ
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_dl_get_status(uint8_t lane, uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_dl_clear_status(uint8_t lane, uint32_t mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_dl_set_irq_enable(uint8_t lane, uint32_t mask);
 
/* =============================================================================
 * Per-virtual-channel status / IRQ
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_csi_vc_get_status(uint8_t vc, uint32_t* out_mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_vc_clear_status(uint8_t vc, uint32_t mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_vc_set_irq_enable(uint8_t vc, uint32_t mask);
 
/* =============================================================================
 * Power-management status / IRQ
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_mipi_csi_pm_clear_status(uint32_t mask);

[[nodiscard]] ra8_err_t ra8_mipi_csi_pm_set_irq_enable(uint32_t mask);
 
#ifdef __cplusplus
}
#endif