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

Everything ra8_epd_cal_resolve needs. More...

#include <ra8_epd_cal.h>

Collaboration diagram for ra8_epd_cal_cfg_t:

Data Fields

ra8_epd_cal_limits_mv_t limits
 Panel's documented VCOM window.
ra8_epd_cal_panel_ops_t panel
 Controller access seam.
ra8_epd_cal_store_t store
 Per-device record store seam.
uint16_t provisioned_mv
 Operator value for this boot.
bool has_provisioned
 Whether the field above is set.

Detailed Description

Everything ra8_epd_cal_resolve needs.

Follows the repo's config-struct convention: one struct, passed to the entry point, carrying both the injected seams and the panel's data.

provisioned_mv is the escape hatch for a device whose controller has forgotten and whose record is blank – the operator types in the number printed on the flex cable and the app passes it here, typically together with a ra8_epd_cal_provision call to make it durable. It is deliberately an explicit, caller-supplied field rather than a built-in default: there is no value this module is entitled to invent.

Invariant
limits satisfies ra8_epd_cal_limits_mv_t's invariants.
provisioned_mv is zero when has_provisioned is false.
Example:
const ra8_epd_cal_cfg_t cfg = {
.limits = {.min_mv = 200U, .max_mv = 4000U},
.panel = panel_ops,
.store = nv_store,
.has_provisioned = false,
.provisioned_mv = 0U,
};
Everything ra8_epd_cal_resolve needs.
See also
ra8_epd_cal_resolve

Definition at line 479 of file ra8_epd_cal.h.

Field Documentation

◆ has_provisioned

bool ra8_epd_cal_cfg_t::has_provisioned

Whether the field above is set.

Definition at line 484 of file ra8_epd_cal.h.

Referenced by ra8_epd_cal_resolve().

◆ limits

ra8_epd_cal_limits_mv_t ra8_epd_cal_cfg_t::limits

◆ panel

ra8_epd_cal_panel_ops_t ra8_epd_cal_cfg_t::panel

Controller access seam.

Definition at line 481 of file ra8_epd_cal.h.

Referenced by internal_ra8_epd_cal_try_panel(), and ra8_epd_cal_apply().

◆ provisioned_mv

uint16_t ra8_epd_cal_cfg_t::provisioned_mv

Operator value for this boot.

Definition at line 483 of file ra8_epd_cal.h.

Referenced by ra8_epd_cal_resolve().

◆ store

ra8_epd_cal_store_t ra8_epd_cal_cfg_t::store

Per-device record store seam.

Definition at line 482 of file ra8_epd_cal.h.

Referenced by internal_ra8_epd_cal_try_record(), and ra8_epd_cal_provision().


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