ra8_ov5640.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum : uint16_t {
  k_ra8_ov5640_chip_id = 0x5640U, 
} ra8_ov5640_id_t;
 
typedef enum : uint8_t {
  k_ra8_ov5640_addr_primary   = 0x3CU, 
  k_ra8_ov5640_addr_secondary = 0x3DU, 
} ra8_ov5640_addr_t;

typedef enum : uint8_t {
  k_ra8_ov5640_mode_vga_uyvy = 0U, 
  k_ra8_ov5640_mode_vga_jpeg = 1U, 
} ra8_ov5640_mode_t;

typedef enum : uint8_t {
  k_ra8_ov5640_jpeg_quant_scale_min     = 0x00U, 
  k_ra8_ov5640_jpeg_quant_scale_default = 0x0CU, 
  k_ra8_ov5640_jpeg_quant_scale_max     = 0x3FU, 
} ra8_ov5640_jpeg_quant_scale_t;
 
typedef ra8_err_t (*ra8_ov5640_read_fn_t)(void*    ctx,
                                          uint8_t  address,
                                          uint16_t reg,
                                          uint8_t* out_value);
typedef ra8_err_t (*ra8_ov5640_write_fn_t)(void* ctx, uint8_t address, uint16_t reg, uint8_t value);
typedef void (*ra8_ov5640_delay_fn_t)(void* ctx, uint32_t milliseconds);

typedef struct {
  ra8_ov5640_read_fn_t  read_reg;  
  ra8_ov5640_write_fn_t write_reg; 
  ra8_ov5640_delay_fn_t delay_ms;  
  void*                 ctx;       
} ra8_ov5640_bus_t;

typedef struct {
  ra8_ov5640_bus_t bus;         
  uint8_t          address;     
  bool             initialized; 
} ra8_ov5640_t;

typedef struct {
  uint32_t encoded_bytes;         
  uint16_t compression_width;     
  uint16_t compression_height;    
  uint8_t  jpeg_ctrl01;           
  uint8_t  vfifo_ctrl00;          
  uint8_t  href_minimum_blanking; 
  bool     fifo_overflow;         
  bool     input_is_yuv422;       
  bool     header_output;         
  bool     compression_enabled;   
} ra8_ov5640_jpeg_status_t;

[[nodiscard]] ra8_err_t ra8_ov5640_init(ra8_ov5640_t* dev, const ra8_ov5640_bus_t* bus);

[[nodiscard]] ra8_err_t ra8_ov5640_probe(ra8_ov5640_t* dev, uint16_t* out_id);

[[nodiscard]] ra8_err_t ra8_ov5640_configure(ra8_ov5640_t* dev, ra8_ov5640_mode_t mode);

[[nodiscard]] ra8_err_t ra8_ov5640_set_jpeg_quantization_scale(ra8_ov5640_t* dev,
                                                               uint8_t       quant_scale);

[[nodiscard]] ra8_err_t ra8_ov5640_jpeg_status_get(ra8_ov5640_t*             dev,
                                                   ra8_ov5640_jpeg_status_t* out_status);

[[nodiscard]] ra8_err_t ra8_ov5640_stream_set(ra8_ov5640_t* dev, bool enabled);

[[nodiscard]] ra8_err_t ra8_ov5640_read_reg(ra8_ov5640_t* dev, uint16_t reg, uint8_t* out_value);

[[nodiscard]] ra8_err_t ra8_ov5640_write_reg(ra8_ov5640_t* dev, uint16_t reg, uint8_t value);
 
#ifdef __cplusplus
}
#endif