ra8-firmware/examples_2ek__ra8d2_2hw__validated_2hil_2ereader__link_2src_2main_8c_source.html

#include <stddef.h>

#include <stdint.h>


#include "font_fixture.h"

#include "ra8_board_ek_ra8d2.h"

#include "ra8_boot_entry.h"

#include "ra8_cgc.h"

#include "ra8_err.h"

#include "ra8_isr.h"

#include "ra8_mstp.h"

#include "ra8_time.h"

#include "reflow.h"


typedef enum : uint32_t {

  k_lk_view_w      = 280U,

  k_lk_view_h      = 360U,

  k_lk_font_px     = 16U,

  k_lk_ink         = 0xFF101010U,

  k_lk_link_col    = 0xFF2A52BEU,

  k_lk_uart_baud   = 115200U,

  k_lk_fnv_offset  = 2166136261U,

  k_lk_fnv_prime   = 16777619U,

  k_lk_hex_nibbles = 8U,

  k_lk_nibble_bits = 4U,

  k_lk_nibble_mask = 0x0FU,

  k_lk_dec_ten     = 10U,

} lk_consts_t;


static reflow_t s_engine;


static const char k_lk_chapter[] =

  "<html><body><h1>Chapter One</h1>"

  "<p>Jump to the <a href=\"ch2.xhtml\">next chapter</a> or skip to the "

  "<a href=\"#foot\">footnote</a> below for the citation.</p>"

  "<p>Body paragraph with enough words to occupy a couple of lines so the "

  "layout has real content to paginate around the links.</p>"

  "<p id=\"foot\">Footnote: this is the cited reference text.</p></body></html>";


static const uint8_t k_msg_boot[]  = "ereader-link-hil: boot\r\n";

static const uint8_t k_msg_fail[]  = "ereader-link-hil: FAIL init\r\n";

static const uint8_t k_msg_lerr[]  = "ereader-link-hil: FAIL layout\r\n";

static const uint8_t k_msg_pre[]   = "ereader-link-hil: links=";

static const uint8_t k_msg_cross[] = " cross=";

static const uint8_t k_msg_frag[]  = " frag=";

static const uint8_t k_msg_apage[] = " apage=";

static const uint8_t k_msg_geom[]  = " geom=";

static const uint8_t k_msg_eol[]   = "\r\n";

static const uint8_t k_msg_yes[]   = "Y";

static const uint8_t k_msg_no[]    = "N";


static void lk_print(const uint8_t* msg, uint32_t len)

{

  (void)ra8_board_uart_console_write(msg, (size_t)len);

}


static void lk_panic_halt(const uint8_t* msg, uint32_t len)

{

  lk_print(msg, len);

  __asm__ volatile("bkpt #0");

  while (1) {

    __asm__ volatile("wfi");

  }

}


static void lk_print_hex(uint32_t value)

{

  uint8_t buf[k_lk_hex_nibbles];

  for (uint32_t i = 0U; i < (uint32_t)k_lk_hex_nibbles; i++) {

    const uint32_t shift = ((uint32_t)k_lk_hex_nibbles - 1U - i) * (uint32_t)k_lk_nibble_bits;

    const uint32_t nib   = (value >> shift) & (uint32_t)k_lk_nibble_mask;

    buf[i] = (uint8_t)((nib < (uint32_t)k_lk_dec_ten) ? ('0' + nib) : ('A' + (nib - k_lk_dec_ten)));

  }

  lk_print(buf, (uint32_t)k_lk_hex_nibbles);

}


static void lk_print_uint(uint32_t value)

{

  uint8_t  buf[k_lk_dec_ten];

  uint32_t n = 0U;

  if (value == 0U) {

    buf[n] = '0';

    n++;

  }

  while ((value > 0U) && (n < (uint32_t)k_lk_dec_ten)) {

    buf[n] = (uint8_t)('0' + (value % (uint32_t)k_lk_dec_ten));

    n++;

    value /= (uint32_t)k_lk_dec_ten;

  }

  for (uint32_t i = 0U; i < n; i++) {

    lk_print(&buf[n - 1U - i], 1U);

  }

}


static void lk_print_bool(bool yes)

{

  if (yes) {

    lk_print(k_msg_yes, (uint32_t)sizeof(k_msg_yes) - 1U);

  } else {

    lk_print(k_msg_no, (uint32_t)sizeof(k_msg_no) - 1U);

  }

}


static uint32_t lk_geom_hash(void)

{

  const uint8_t* p   = (const uint8_t*)s_engine.link_rects;

  const size_t   n   = (size_t)s_engine.link_rect_count * sizeof(s_engine.link_rects[0]);

  uint32_t       hsh = (uint32_t)k_lk_fnv_offset;

  for (size_t i = 0U; i < n; i++) {

    hsh = (hsh ^ (uint32_t)p[i]) * (uint32_t)k_lk_fnv_prime;

  }

  return hsh;

}


static void lk_probe_rect(uint32_t idx, bool* out_cross, bool* out_frag)

{

  const reflow_link_rect_t* rect = &s_engine.link_rects[idx];

  const int32_t             cx   = rect->x + (rect->w / 2);

  const int32_t             cy   = rect->y + (rect->h / 2);

  uint32_t                  off  = 0U;

  uint32_t                  len  = 0U;

  if (reflow_hit_test_link(&s_engine, rect->page_index, cx, cy, &off, &len) != k_ra8_ok) {

    return;

  }

  reflow_href_kind_t kind = k_reflow_href_empty;

  uint32_t           pl   = 0U;

  uint32_t           fo   = 0U;

  uint32_t           fl   = 0U;

  if (reflow_href_split((const char*)&s_engine.text_pool[off], len, &kind, &pl, &fo, &fl) !=

      k_ra8_ok) {

    return;

  }

  if ((kind == k_reflow_href_chapter) || (kind == k_reflow_href_chapter_fragment)) {

    *out_cross = true;

  }

  if (kind == k_reflow_href_fragment) {

    *out_frag = true;

  }

}


static void lk_setup_or_halt(void)

{

  uint32_t cpuclk0_hz = 0U;

  if ((ra8_cgc_init() != k_ra8_ok) || (ra8_mstp_init() != k_ra8_ok)) {

    lk_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);

  }

  if (ra8_cgc_get_clock_hz(k_ra8_clock_id_cpuclk0, &cpuclk0_hz) != k_ra8_ok) {

    lk_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);

  }

  if (ra8_time_init(cpuclk0_hz) != k_ra8_ok) {

    lk_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);

  }

  if (ra8_board_uart_console_init((uint32_t)k_lk_uart_baud) != k_ra8_ok) {

    lk_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);

  }

}


void main(void)

{

  lk_setup_or_halt();

  ra8_isr_globals_enable();

  lk_print(k_msg_boot, (uint32_t)sizeof(k_msg_boot) - 1U);


  if (reflow_init((uint16_t)k_lk_view_w,

                  (uint16_t)k_lk_view_h,

                  k_ahem_ttf,

                  (size_t)k_ahem_ttf_len,

                  (uint16_t)k_lk_font_px,

                  (uint32_t)k_lk_ink,

                  (uint32_t)k_lk_link_col,

                  &s_engine) != k_ra8_ok) {

    lk_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);

  }

  uint32_t pages = 0U;

  if (reflow_layout_chapter(&s_engine,

                            (const uint8_t*)k_lk_chapter,

                            (uint32_t)(sizeof(k_lk_chapter) - 1U),

                            &pages) != k_ra8_ok) {

    lk_panic_halt(k_msg_lerr, (uint32_t)sizeof(k_msg_lerr) - 1U);

  }


  /* Synthesise a tap at the centre of every link rect; classify each. */

  bool cross = false;

  bool frag  = false;

  for (uint32_t i = 0U; i < s_engine.link_rect_count; ++i) {

    lk_probe_rect(i, &cross, &frag);

  }


  /* Resolve the same-chapter "#foot" fragment to its page. */

  uint32_t apage = 0U;

  if (reflow_find_anchor(&s_engine, "foot", (uint32_t)(sizeof("foot") - 1U), &apage) != k_ra8_ok) {

    apage = (uint32_t)k_lk_view_h; /* sentinel: not found */

  }


  lk_print(k_msg_pre, (uint32_t)sizeof(k_msg_pre) - 1U);

  lk_print_uint(s_engine.link_target_count);

  lk_print(k_msg_cross, (uint32_t)sizeof(k_msg_cross) - 1U);

  lk_print_bool(cross);

  lk_print(k_msg_frag, (uint32_t)sizeof(k_msg_frag) - 1U);

  lk_print_bool(frag);

  lk_print(k_msg_apage, (uint32_t)sizeof(k_msg_apage) - 1U);

  lk_print_uint(apage);

  lk_print(k_msg_geom, (uint32_t)sizeof(k_msg_geom) - 1U);

  lk_print_hex(lk_geom_hash());

  lk_print(k_msg_eol, (uint32_t)sizeof(k_msg_eol) - 1U);


  while (1) {

    __asm__ volatile("wfi");

  }

}


main
void main(void)
Secure fallback main entry point.
Definition main.c:37

k_msg_pre
static const uint8_t k_msg_pre[]
Definition main.c:151

k_msg_boot
static const uint8_t k_msg_boot[]
Definition main.c:140

k_msg_fail
static const uint8_t k_msg_fail[]
Definition main.c:63

s_engine
static reflow_t s_engine
Reflow engine (glyph / page / token / text pools live inside).
Definition main.c:199

k_msg_eol
static const uint8_t k_msg_eol[]
Definition main.c:328

k_msg_geom
static const uint8_t k_msg_geom[]
Definition main.c:73

k_msg_lerr
static const uint8_t k_msg_lerr[]
Definition main.c:71

lk_print
static void lk_print(const uint8_t *msg, uint32_t len)
Emit a byte run on the SCI8 console.
Definition main.c:88

lk_print_bool
static void lk_print_bool(bool yes)
Print "Y" or "N".
Definition main.c:135

lk_setup_or_halt
static void lk_setup_or_halt(void)
Bring up clocks/MSTP/time + the SCI8 console; halt on failure.
Definition main.c:191

k_msg_yes
static const uint8_t k_msg_yes[]
Definition main.c:84

lk_panic_halt
static void lk_panic_halt(const uint8_t *msg, uint32_t len)
Print the fail banner and trap (ra8_emulator halts on the BKPT).
Definition main.c:94

k_msg_no
static const uint8_t k_msg_no[]
Definition main.c:85

lk_print_hex
static void lk_print_hex(uint32_t value)
Print a 32-bit value as 8 upper-case hex digits.
Definition main.c:104

k_msg_cross
static const uint8_t k_msg_cross[]
Definition main.c:79

lk_probe_rect
static void lk_probe_rect(uint32_t idx, bool *out_cross, bool *out_frag)
Classify the href at a link rect's centre via the public nav API.
Definition main.c:164

lk_geom_hash
static uint32_t lk_geom_hash(void)
FNV-1a-32 over the laid-out link-rectangle geometry.
Definition main.c:145

k_msg_frag
static const uint8_t k_msg_frag[]
Definition main.c:80

lk_consts_t
lk_consts_t
Viewport / console / hash knobs (no magic numbers).
Definition main.c:48

k_lk_link_col
@ k_lk_link_col
Anchor colour (ARGB).
Definition main.c:53

k_lk_view_h
@ k_lk_view_h
Layout viewport height, pixels.
Definition main.c:50

k_lk_font_px
@ k_lk_font_px
Body font size, pixels.
Definition main.c:51

k_lk_nibble_mask
@ k_lk_nibble_mask
Low-nibble mask.
Definition main.c:59

k_lk_dec_ten
@ k_lk_dec_ten
Hex digit / decimal split.
Definition main.c:60

k_lk_ink
@ k_lk_ink
Body ink colour (ARGB).
Definition main.c:52

k_lk_hex_nibbles
@ k_lk_hex_nibbles
Hex digits in a 32-bit value.
Definition main.c:57

k_lk_fnv_offset
@ k_lk_fnv_offset
FNV-1a-32 offset basis.
Definition main.c:55

k_lk_view_w
@ k_lk_view_w
Layout viewport width, pixels.
Definition main.c:49

k_lk_uart_baud
@ k_lk_uart_baud
Console baud.
Definition main.c:54

k_lk_nibble_bits
@ k_lk_nibble_bits
Bits per hex nibble.
Definition main.c:58

k_lk_fnv_prime
@ k_lk_fnv_prime
FNV-1a-32 prime.
Definition main.c:56

k_lk_chapter
static const char k_lk_chapter[]
Baked chapter: two links (cross-chapter + fragment) and an anchor.
Definition main.c:67

lk_print_uint
static void lk_print_uint(uint32_t value)
Print a small unsigned integer in decimal.
Definition main.c:116

k_msg_apage
static const uint8_t k_msg_apage[]
Definition main.c:81

k_ahem_ttf
static const uint8_t k_ahem_ttf[]
Ahem TTF bytes.
Definition font_fixture.h:17

k_ahem_ttf_len
static const uint32_t k_ahem_ttf_len
Length of k_ahem_ttf in bytes.
Definition font_fixture.h:889

ra8_board_ek_ra8d2.h
Board-support layer for the Renesas EK-RA8D2 v1 evaluation kit.

ra8_board_uart_console_write
ra8_err_t ra8_board_uart_console_write(const uint8_t *data, size_t len)
Polled blocking write to the J-Link OB VCOM console.
Definition ra8_board_ek_ra8d2_comms.c:294

ra8_board_uart_console_init
ra8_err_t ra8_board_uart_console_init(uint32_t baud)
Configure SCI8 + PD02/PD03 as the debug-console UART.
Definition ra8_board_ek_ra8d2_comms.c:240

ra8_boot_entry.h
Boot entry points shared between a vector table and its startup code.

ra8_cgc.h
High-level Clock Generation Circuit driver.

ra8_cgc_get_clock_hz
ra8_err_t ra8_cgc_get_clock_hz(ra8_clock_id_t id, uint32_t *out_hz)
Query the current frequency of a clock-tree domain.
Definition ra8_cgc.c:132

k_ra8_clock_id_cpuclk0
@ k_ra8_clock_id_cpuclk0
Cortex-M85 CPUCLK0.
Definition ra8_cgc.h:70

ra8_cgc_init
ra8_err_t ra8_cgc_init(void)
Configure the clock tree to a safe default.
Definition ra8_cgc.c:727

ra8_err.h
Error Code Definitions for ra8-firmware.

k_ra8_ok
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119

ra8_isr.h
NVIC + ICU IELSR allocator.

ra8_isr_globals_enable
void ra8_isr_globals_enable(void)
Globally enable maskable interrupts (PRIMASK = 0).
Definition ra8_isr.c:439

ra8_mstp.h
Ref-counted Module Stop Control wrapper for the RA8D2.

ra8_mstp_init
ra8_err_t ra8_mstp_init(void)
Re-establish the ra8_mstp ref-count table from current hardware state.
Definition ra8_mstp.c:291

ra8_time.h
SysTick-based tick counter, delay and timestamp helpers.

ra8_time_init
ra8_err_t ra8_time_init(uint32_t cpu_hz)
Initialise SysTick for a 1 kHz tick interrupt.
Definition ra8_time.c:59

reflow.h
HTML / CSS reflow + paginate engine for the ra8d2 ereader.

reflow_hit_test_link
ra8_err_t reflow_hit_test_link(const reflow_t *engine, uint32_t page_idx, int32_t x, int32_t y, uint32_t *out_href_off, uint32_t *out_href_len)
Hit-test a point on a page against the laid-out <a> link rectangles.
Definition reflow_link.c:36

reflow_layout_chapter
ra8_err_t reflow_layout_chapter(reflow_t *engine, const uint8_t *xhtml_buf, size_t xhtml_len, uint32_t *out_total_pages)
Parse + lay out one chapter of XHTML.
Definition reflow_layout_driver.c:233

reflow_find_anchor
ra8_err_t reflow_find_anchor(const reflow_t *engine, const char *id, uint32_t id_len, uint32_t *out_page)
Find the page of a same-chapter id anchor (for #fragment jumps).
Definition reflow_link.c:88

reflow_href_split
ra8_err_t reflow_href_split(const char *href, uint32_t len, reflow_href_kind_t *out_kind, uint32_t *out_path_len, uint32_t *out_frag_off, uint32_t *out_frag_len)
Split + classify an <a href> into a path part and a #fragment.
Definition reflow_link.c:218

reflow_init
ra8_err_t reflow_init(uint16_t viewport_w, uint16_t viewport_h, const uint8_t *font_data, size_t font_len, uint16_t font_px, uint32_t body_color, uint32_t link_color, reflow_t *out_engine)
Initialise a reflow engine for a given viewport / font.
Definition reflow_layout_driver.c:149

reflow_href_kind_t
reflow_href_kind_t
Classification of an in-content <a href> target.
Definition reflow_types.h:388

k_reflow_href_fragment
@ k_reflow_href_fragment
"#id" – same-chapter anchor.
Definition reflow_types.h:390

k_reflow_href_chapter_fragment
@ k_reflow_href_chapter_fragment
"path#id" – chapter + anchor.
Definition reflow_types.h:392

k_reflow_href_empty
@ k_reflow_href_empty
Empty / whitespace-only href.
Definition reflow_types.h:389

k_reflow_href_chapter
@ k_reflow_href_chapter
"path" – another chapter, no frag.
Definition reflow_types.h:391

reflow_link_rect_t
One tappable rectangle covering a run of <a> glyphs on a page.
Definition reflow_types.h:361

reflow_link_rect_t::w
int32_t w
Rect width, pixels.
Definition reflow_types.h:364

reflow_link_rect_t::page_index
uint32_t page_index
Page this rect belongs to.
Definition reflow_types.h:367

reflow_link_rect_t::x
int32_t x
Page-local left edge, pixels.
Definition reflow_types.h:362

reflow_link_rect_t::h
int32_t h
Rect height, pixels.
Definition reflow_types.h:365

reflow_link_rect_t::y
int32_t y
Page-local top edge, pixels.
Definition reflow_types.h:363

reflow_t
Reflow / pagination engine state.
Definition reflow_types.h:448