ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
ra8_epd_cal_result_t Struct Reference

Outcome of ra8_epd_cal_resolve. More...

#include <ra8_epd_cal.h>

Data Fields

uint16_t vcom_mv
 Resolved VCOM magnitude, millivolts.
ra8_epd_cal_source_t source
 Which authority supplied it.

Detailed Description

Outcome of ra8_epd_cal_resolve.

Invariant
source == k_ra8_epd_cal_src_none if and only if vcom_mv == 0 and resolution failed.
When source is not none, vcom_mv lies inside the configured limits.
Example:
ra8_epd_cal_result_t r = {};
if (ra8_epd_cal_resolve(&cfg, &r) != k_ra8_ok) { return; } // do NOT drive
ra8_epd_cal_resolve
ra8_err_t ra8_epd_cal_resolve(const ra8_epd_cal_cfg_t *cfg, ra8_epd_cal_result_t *out_result)
Resolve the VCOM to drive this panel at, or fail safe.
Definition ra8_epd_cal.c:464
k_ra8_ok
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119
ra8_epd_cal_result_t
Outcome of ra8_epd_cal_resolve.
Definition ra8_epd_cal.h:504
See also
ra8_epd_cal_resolve

Definition at line 504 of file ra8_epd_cal.h.

Field Documentation

◆ source

ra8_epd_cal_source_t ra8_epd_cal_result_t::source

Which authority supplied it.

Definition at line 506 of file ra8_epd_cal.h.

Referenced by internal_ra8_epd_cal_try_panel(), internal_ra8_epd_cal_try_record(), ra8_epd_cal_apply(), and ra8_epd_cal_resolve().

◆ vcom_mv

uint16_t ra8_epd_cal_result_t::vcom_mv

Resolved VCOM magnitude, millivolts.

Definition at line 505 of file ra8_epd_cal.h.

Referenced by internal_ra8_epd_cal_try_panel(), internal_ra8_epd_cal_try_record(), ra8_epd_cal_apply(), and ra8_epd_cal_resolve().

The documentation for this struct was generated from the following file: