ra8_mipi_dsi_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_dsi_regs.h"
#include "ra8_mipi_dsi_types.h"
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_dsi_init(const ra8_mipi_dsi_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_deinit(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_enter_stop(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_exit_stop(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_soft_reset(void);
 
/* =============================================================================
 * HS clock control
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_dsi_hs_clock_start(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_hs_clock_stop(void);
 
/* =============================================================================
 * Sequence-channel commands
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_dsi_send_short_packet(ra8_mipi_dsi_dt_t cmd_id,
                                                       ra8_mipi_dsi_vc_t vc,
                                                       uint8_t           param0,
                                                       uint8_t           param1);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_send_long_packet(ra8_mipi_dsi_dt_t cmd_id,
                                                      ra8_mipi_dsi_vc_t vc,
                                                      const uint8_t*    data,
                                                      uint16_t          tx_len,
                                                      bool              low_power);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_send_command(const ra8_mipi_dsi_command_t* cmd);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_read_packet(ra8_mipi_dsi_dt_t cmd_id,
                                                 ra8_mipi_dsi_vc_t vc,
                                                 uint8_t           param0,
                                                 uint8_t           param1,
                                                 uint8_t*          p_rx_buffer,
                                                 uint16_t          rx_len);
 
/* =============================================================================
 * ULPS
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_dsi_ulps_enter(uint8_t lanes);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_ulps_exit(uint8_t lanes);
 
/* =============================================================================
 * Video mode
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_mipi_dsi_video_configure(const ra8_mipi_dsi_video_cfg_t* vcfg);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_video_start(const ra8_mipi_dsi_video_cfg_t* vcfg);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_video_stop(void);
 
/* =============================================================================
 * Status / IRQ
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_mipi_dsi_link_status_get(ra8_mipi_dsi_link_status_t* out_status);

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

[[nodiscard]] ra8_err_t ra8_mipi_dsi_ack_error_get(ra8_mipi_dsi_ack_error_t* out_err);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_rx_result_get(uint8_t                   slot,
                                                   ra8_mipi_dsi_rx_result_t* out_result);

[[nodiscard]] ra8_err_t
ra8_mipi_dsi_rx_payload_read(uint8_t* dest, uint16_t max_len, uint16_t* out_len);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_te_event_pending(bool* out_pending);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_te_event_clear(void);

[[nodiscard]] ra8_err_t
ra8_mipi_dsi_irq_enable(ra8_mipi_dsi_event_t event, uint32_t mask, bool enable);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_attach_handler(ra8_mipi_dsi_event_fn_t fn, void* ctx);

void ra8_mipi_dsi_dispatch(void);

void ra8_mipi_dsi_dispatch_seq0(void);

void ra8_mipi_dsi_dispatch_seq1(void);

void ra8_mipi_dsi_dispatch_video(void);

void ra8_mipi_dsi_dispatch_receive(void);

void ra8_mipi_dsi_dispatch_fatal(void);

void ra8_mipi_dsi_dispatch_phy(void);
 
/* =============================================================================
 * Sweep 6 convenience surfaces
 * =============================================================================
 */

typedef struct {
  uint16_t horizontal_sync;        
  uint16_t horizontal_back_porch;  
  uint16_t horizontal_active;      
  uint16_t horizontal_front_porch; 
  uint16_t vertical_sync;          
  uint16_t vertical_back_porch;    
  uint16_t vertical_active;        
  uint16_t vertical_front_porch;   
} ra8_mipi_dsi_video_timing_t;

[[nodiscard]] ra8_err_t ra8_mipi_dsi_set_video_timing(const ra8_mipi_dsi_video_timing_t* timing);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_send_command_short(ra8_mipi_dsi_dt_t dt,
                                                        const uint8_t     params[2]);

[[nodiscard]] ra8_err_t
ra8_mipi_dsi_send_command_long(ra8_mipi_dsi_dt_t dt, const uint8_t* payload, uint16_t len);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_send_command_payload(ra8_mipi_dsi_dt_t packet_type,
                                                          const uint8_t*    payload,
                                                          uint16_t          len);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_enter_ulps(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_exit_ulps(void);

[[nodiscard]] ra8_err_t ra8_mipi_dsi_get_link_status(ra8_mipi_dsi_link_status_t* out);
 
#ifdef __cplusplus
}
#endif