ra8_vin_api.h

Go to the documentation of this file.

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

[[nodiscard]] ra8_err_t ra8_vin_init(const ra8_vin_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_vin_deinit(void);

[[nodiscard]] ra8_err_t ra8_vin_reset(void);
 
/* =============================================================================
 * Capture control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_capture_arm(ra8_vin_capture_mode_t mode);

[[nodiscard]] ra8_err_t ra8_vin_capture_disarm(void);
 
/* =============================================================================
 * Geometry / pre-clip / scaling
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_set_preclip(const ra8_vin_preclip_t* window);

[[nodiscard]] ra8_err_t ra8_vin_set_uds_scale(const ra8_vin_uds_scale_t* scale);

[[nodiscard]] ra8_err_t ra8_vin_set_uds_passband(uint8_t v_bwidth, uint8_t h_bwidth);

[[nodiscard]] ra8_err_t ra8_vin_set_uds_clip(uint16_t v_size, uint16_t h_size);

[[nodiscard]] ra8_err_t ra8_vin_set_uds_ctrl(const ra8_vin_uds_ctrl_t* ctrl);

[[nodiscard]] ra8_err_t ra8_vin_enable_scaling(bool enable);
 
/* =============================================================================
 * LUT (10-to-8-bit conversion)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_lut_program(const uint8_t* y_table,
                                            const uint8_t* cb_table,
                                            const uint8_t* cr_table,
                                            bool           enable);
 
/* =============================================================================
 * Colour-space conversion
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_set_yc_to_rgb(const ra8_vin_yc_to_rgb_t* coeffs);

[[nodiscard]] ra8_err_t ra8_vin_set_rgb_to_yc(uint8_t channel, const ra8_vin_rgb_to_yc_chan_t* row);
 
/* =============================================================================
 * Dithering / YUV-444 / DMR
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_set_dithering(uint8_t mode, bool direction);

[[nodiscard]] ra8_err_t ra8_vin_set_yuv444_mode(uint8_t mode);

[[nodiscard]] ra8_err_t ra8_vin_set_interlace_mode(uint8_t mode);

[[nodiscard]] ra8_err_t ra8_vin_set_data_mode(const ra8_vin_data_mode_t* mode);
 
/* =============================================================================
 * CSI-2 / framebuffers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_vin_set_csi_input(const ra8_vin_csi_input_t* input);

[[nodiscard]] ra8_err_t ra8_vin_set_field_detect(const ra8_vin_field_detect_t* detect);

[[nodiscard]] ra8_err_t ra8_vin_set_framebuffers(uint32_t mb1, uint32_t mb2, uint32_t mb3);

[[nodiscard]] ra8_err_t ra8_vin_set_uv_offset(uint32_t uv_addr);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

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

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

[[nodiscard]] ra8_err_t ra8_vin_get_module_status(ra8_vin_module_status_t* out_status);

[[nodiscard]] ra8_err_t ra8_vin_get_line_count(uint16_t* out_count);

[[nodiscard]] ra8_err_t ra8_vin_get_active_buffer(uint8_t* out_id);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_vin_set_scanline_compare(uint16_t line);

[[nodiscard]] ra8_err_t ra8_vin_attach_handler(ra8_vin_event_fn_t fn, void* ctx);

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

[[nodiscard]] ra8_err_t ra8_vin_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_vin_exit_stop(void);
 
/* =============================================================================
 * Sweep 17: dynamic capture window + frame-end IRQ
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_vin_capture_start(void* buf, uint16_t w, uint16_t h, ra8_vin_input_fmt_t format);

[[nodiscard]] ra8_err_t ra8_vin_capture_stop(void);

[[nodiscard]] ra8_err_t ra8_vin_set_window(uint16_t x, uint16_t y, uint16_t w, uint16_t h);

[[nodiscard]] ra8_err_t ra8_vin_attach_frame_handler(ra8_vin_frame_fn_t fn, void* ctx);
 
#ifdef __cplusplus
}
#endif