ra8-firmware/examples_2ek__ra8d2_2hil__needs__revalidation_2reflow__content_2src_2main_8c_source.html

#include <stddef.h>

#include <stdint.h>


#include "font_fixture.h"

#include "ra8_attributes.h"

#include "ra8_board_ek_ra8d2.h"

#include "ra8_boot_entry.h"

#include "ra8_cgc.h"

#include "ra8_err.h"

#include "ra8_gfx.h"

#include "ra8_isr.h"

#include "ra8_mstp.h"

#include "ra8_time.h"

#include "reflow.h"


typedef enum : uint32_t {

  k_rc_fb_w        = 160U,

  k_rc_fb_h        = 192U,

  k_rc_font_px     = 16U,

  k_rc_reflow_px   = 24U,

  k_rc_ink         = 0xFF101010U,

  k_rc_link_col    = 0xFF2A52BEU,

  k_rc_bg          = 0xF4F0E8U,

  k_rc_uart_baud   = 115200U,

  k_rc_fnv_offset  = 2166136261U,

  k_rc_fnv_prime   = 16777619U,

  k_rc_hex_nibbles = 8U,

  k_rc_nibble_bits = 4U,

  k_rc_nibble_mask = 0x0FU,

  k_rc_dec_ten     = 10U,

} rc_consts_t;


static uint16_t s_framebuffer[(size_t)k_rc_fb_h * (size_t)k_rc_fb_w];


static reflow_t s_engine;


static const char s_rc_chapter[] =

  "<html><body><h1>The Machine</h1>"

  "<p>The Time Traveller was expounding a recondite matter to us. His pale grey "

  "eyes shone and twinkled, and his usually pale face was flushed and animated.</p>"

  "<p>The fire burnt brightly, and the soft radiance of the incandescent lights "

  "caught the bubbles that flashed and passed in our glasses.</p>"

  "<p>Our chairs, being his patents, embraced and caressed us rather than "

  "submitted to be sat upon, and there was that luxurious after-dinner "

  "atmosphere when thought runs gracefully free of the trammels of precision.</p>"

  "<p>And he put it to us in this way, marking the points with a lean forefinger, "

  "as we sat and lazily admired his earnestness over this new paradox.</p>"

  "</body></html>";


static const uint8_t s_msg_boot[] = "reflow-content-hil: boot\r\n";

static const uint8_t s_msg_fail[] = "reflow-content-hil: FAIL init\r\n";

static const uint8_t s_msg_lerr[] = "reflow-content-hil: FAIL layout\r\n";

static const uint8_t s_msg_pre[] = "reflow-content-hil: pages=";

static const uint8_t s_msg_crc[] = " crc=";

static const uint8_t s_msg_rpages[] = " rpages=";

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


RA8_INTERNAL static void internal_rc_print(const uint8_t* msg, uint32_t len)

{

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

}


[[noreturn]] RA8_INTERNAL static void internal_rc_panic_halt(const uint8_t* msg, uint32_t len)

{

  internal_rc_print(msg, len);

  __asm__ volatile("bkpt #0");

  while (1) {

    __asm__ volatile("wfi");

  }

}


RA8_INTERNAL static void internal_rc_print_hex(uint32_t value)

{

  uint8_t buf[k_rc_hex_nibbles];

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

    const uint32_t shift = ((uint32_t)k_rc_hex_nibbles - 1U - i) * (uint32_t)k_rc_nibble_bits;

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

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

  }

  internal_rc_print(buf, (uint32_t)k_rc_hex_nibbles);

}


RA8_INTERNAL static void internal_rc_print_uint(uint32_t value)

{

  uint8_t  buf[k_rc_dec_ten];

  uint32_t n = 0U;

  if (value == 0U) {

    buf[n] = '0';

    n++;

  }

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

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

    n++;

    value /= (uint32_t)k_rc_dec_ten;

  }

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

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

  }

}


RA8_INTERNAL static uint32_t internal_rc_render_all(uint32_t* out_hash)

{

  uint32_t pages = 0U;

  (void)reflow_get_page_count(&s_engine, &pages);

  uint32_t     hsh    = (uint32_t)k_rc_fnv_offset;

  const size_t nbytes = (size_t)k_rc_fb_w * (size_t)k_rc_fb_h * sizeof(uint16_t);

  for (uint32_t p = 0U; p < pages; p++) {

    (void)ra8_gfx_clear((uint32_t)k_rc_bg);

    (void)reflow_render_page(&s_engine, p, s_framebuffer);

    const uint8_t* fb = (const uint8_t*)s_framebuffer;

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

      hsh = (hsh ^ (uint32_t)fb[i]) * (uint32_t)k_rc_fnv_prime;

    }

  }

  *out_hash = hsh;

  return pages;

}


RA8_INTERNAL static void internal_rc_setup_or_halt(void)

{

  uint32_t cpuclk0_hz = 0U;

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

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

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

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

  if (ra8_time_init(cpuclk0_hz) != k_ra8_ok) {

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

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

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

}


void main(void)

{

  internal_rc_setup_or_halt();

  ra8_isr_globals_enable();

  internal_rc_print(s_msg_boot, (uint32_t)sizeof(s_msg_boot) - 1U);


  if (ra8_gfx_init(s_framebuffer,

                   (uint16_t)k_rc_fb_w,

                   (uint16_t)k_rc_fb_h,

                   k_ra8_gfx_format_rgb565) != k_ra8_ok) {

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

  if (reflow_init((uint16_t)k_rc_fb_w,

                  (uint16_t)k_rc_fb_h,

                  s_ahem_ttf,

                  (size_t)s_ahem_ttf_len,

                  (uint16_t)k_rc_font_px,

                  (uint32_t)k_rc_ink,

                  (uint32_t)k_rc_link_col,

                  &s_engine) != k_ra8_ok) {

    internal_rc_panic_halt(s_msg_fail, (uint32_t)sizeof(s_msg_fail) - 1U);

  }

  uint32_t pages = 0U;

  if (reflow_layout_chapter(&s_engine,

                            (const uint8_t*)s_rc_chapter,

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

                            &pages) != k_ra8_ok) {

    internal_rc_panic_halt(s_msg_lerr, (uint32_t)sizeof(s_msg_lerr) - 1U);

  }


  uint32_t       crc1   = 0U;

  const uint32_t pages1 = internal_rc_render_all(&crc1);


  /* Re-flow at a larger size on the cached chapter; render again. */

  if (reflow_set_font_size(&s_engine, (uint16_t)k_rc_reflow_px) != k_ra8_ok) {

    internal_rc_panic_halt(s_msg_lerr, (uint32_t)sizeof(s_msg_lerr) - 1U);

  }

  uint32_t       crc2   = 0U;

  const uint32_t pages2 = internal_rc_render_all(&crc2);


  internal_rc_print(s_msg_pre, (uint32_t)sizeof(s_msg_pre) - 1U);

  internal_rc_print_uint(pages1);

  internal_rc_print(s_msg_crc, (uint32_t)sizeof(s_msg_crc) - 1U);

  internal_rc_print_hex(crc1);

  internal_rc_print(s_msg_rpages, (uint32_t)sizeof(s_msg_rpages) - 1U);

  internal_rc_print_uint(pages2);

  internal_rc_print(s_msg_crc, (uint32_t)sizeof(s_msg_crc) - 1U);

  internal_rc_print_hex(crc2);

  internal_rc_print(s_msg_eol, (uint32_t)sizeof(s_msg_eol) - 1U);


  while (1) {

    __asm__ volatile("wfi");

  }

}


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

s_framebuffer
static uint16_t s_framebuffer[(size_t) k_panel_height_px *(size_t) k_panel_width_px]
1024x600 RGB565 framebuffer in external SDRAM (GLCDC scans this).
Definition main.c:67

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

s_msg_boot
static const uint8_t s_msg_boot[]
Console marker emitted after core and peripheral setup.
Definition main.c:216

s_msg_fail
static const uint8_t s_msg_fail[]
Diagnostic emitted when the VFS round-trip fails.
Definition main.c:104

internal_rc_print_hex
static void internal_rc_print_hex(uint32_t value)
Print a 32-bit value as eight uppercase hexadecimal digits.
Definition main.c:197

internal_rc_panic_halt
static void internal_rc_panic_halt(const uint8_t *msg, uint32_t len)
Emit a failure banner, break into the debugger, and halt.
Definition main.c:176

s_msg_crc
static const uint8_t s_msg_crc[]
Separator introducing a rendered-framebuffer hash.
Definition main.c:127

s_rc_chapter
static const char s_rc_chapter[]
Fixed multi-paragraph HTML chapter used by both layout passes.
Definition main.c:75

internal_rc_render_all
static uint32_t internal_rc_render_all(uint32_t *out_hash)
Render every page of the laid-out chapter; fold an FNV over the output.
Definition main.c:253

s_msg_pre
static const uint8_t s_msg_pre[]
Prefix for the original page-count diagnostic.
Definition main.c:119

s_msg_rpages
static const uint8_t s_msg_rpages[]
Separator introducing the larger-font page count.
Definition main.c:135

internal_rc_print
static void internal_rc_print(const uint8_t *msg, uint32_t len)
Emit a byte run on the board UART console.
Definition main.c:158

internal_rc_print_uint
static void internal_rc_print_uint(uint32_t value)
Print an unsigned 32-bit integer in decimal.
Definition main.c:220

s_msg_lerr
static const uint8_t s_msg_lerr[]
Fatal chapter layout or font-size reflow diagnostic.
Definition main.c:111

internal_rc_setup_or_halt
static void internal_rc_setup_or_halt(void)
Bring up clocks, module-stop control, timekeeping, and the console.
Definition main.c:282

rc_consts_t
rc_consts_t
Framebuffer / console / hash / type-size knobs.
Definition main.c:44

k_rc_fb_w
@ k_rc_fb_w
Framebuffer width, pixels.
Definition main.c:45

k_rc_ink
@ k_rc_ink
Body ink colour (ARGB).
Definition main.c:49

k_rc_bg
@ k_rc_bg
Page background (0x00RRGGBB).
Definition main.c:51

k_rc_nibble_bits
@ k_rc_nibble_bits
Bits per hex nibble.
Definition main.c:56

k_rc_fnv_offset
@ k_rc_fnv_offset
FNV-1a-32 offset basis.
Definition main.c:53

k_rc_dec_ten
@ k_rc_dec_ten
Hex digit / decimal split.
Definition main.c:58

k_rc_reflow_px
@ k_rc_reflow_px
Re-flow font size, pixels.
Definition main.c:48

k_rc_fnv_prime
@ k_rc_fnv_prime
FNV-1a-32 prime.
Definition main.c:54

k_rc_link_col
@ k_rc_link_col
Anchor colour (ARGB).
Definition main.c:50

k_rc_hex_nibbles
@ k_rc_hex_nibbles
Hex digits in a 32-bit value.
Definition main.c:55

k_rc_font_px
@ k_rc_font_px
Body font size, pixels.
Definition main.c:47

k_rc_nibble_mask
@ k_rc_nibble_mask
Low-nibble mask.
Definition main.c:57

k_rc_fb_h
@ k_rc_fb_h
Framebuffer height, pixels.
Definition main.c:46

k_rc_uart_baud
@ k_rc_uart_baud
Console baud.
Definition main.c:52

s_msg_eol
static const uint8_t s_msg_eol[]
Console line terminator for the result banner.
Definition main.c:143

s_ahem_ttf
static const uint8_t s_ahem_ttf[]
Embedded Ahem TrueType font bytes.
Definition font_fixture.h:24

s_ahem_ttf_len
static const uint32_t s_ahem_ttf_len
Exact byte length of s_ahem_ttf.
Definition font_fixture.h:902

ra8_attributes.h
Annotation-attribute framework macros for ra8-firmware.

RA8_INTERNAL
#define RA8_INTERNAL
Marker that a function is intended to be static (file-local).
Definition ra8_attributes.h:190

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_gfx.h
Software 2D graphics primitives layered on top of a caller-ownedframebuffer (DRW / D/AVE 2D / GLCDC r...

k_ra8_gfx_format_rgb565
@ k_ra8_gfx_format_rgb565
16-bit RGB565, little-endian in memory.
Definition ra8_gfx.h:40

ra8_gfx_clear
ra8_err_t ra8_gfx_clear(uint32_t color)
Fill the bound framebuffer's clip region with a single colour.
Definition ra8_gfx_text.c:549

ra8_gfx_init
ra8_err_t ra8_gfx_init(void *fb, uint16_t width, uint16_t height, ra8_gfx_format_t format)
Bind ra8_gfx to a caller-owned framebuffer.
Definition ra8_gfx_text.c:522

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_render_page
ra8_err_t reflow_render_page(const reflow_t *engine, uint32_t page_idx, void *framebuffer)
Render one page into the active ra8_gfx framebuffer.
Definition reflow_render.c:724

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_set_font_size
ra8_err_t reflow_set_font_size(reflow_t *engine, uint16_t new_font_px)
Change the body font size and re-flow the cached chapter.
Definition reflow_layout_driver.c:279

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_get_page_count
ra8_err_t reflow_get_page_count(const reflow_t *engine, uint32_t *out_count)
Report the laid-out page count.
Definition reflow_layout_driver.c:267

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