ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
main.c
Go to the documentation of this file.
1
27
28#include <stddef.h>
29#include <stdint.h>
30
31#include "font_fixture.h"
32#include "ra8_board_ek_ra8d2.h"
33#include "ra8_boot_entry.h"
34#include "ra8_cgc.h"
35#include "ra8_err.h"
36#include "ra8_isr.h"
37#include "ra8_mstp.h"
38#include "ra8_time.h"
39#include "reflow.h"
40
42typedef enum : uint32_t {
43 k_tb_view_w = 280U,
44 k_tb_view_h = 360U,
45 k_tb_font_px = 16U,
46 k_tb_ink = 0xFF101010U,
47 k_tb_link_col = 0xFF2A52BEU,
48 k_tb_uart_baud = 115200U,
49 k_tb_fnv_offset = 2166136261U,
50 k_tb_fnv_prime = 16777619U,
51 k_tb_hex_nibbles = 8U,
52 k_tb_nibble_bits = 4U,
53 k_tb_nibble_mask = 0x0FU,
54 k_tb_dec_ten = 10U,
55} tb_consts_t;
56
58static reflow_t s_engine;
59
61static const char k_tb_chapter[] =
62 "<html><body><h1>Schedule</h1>"
63 "<table>"
64 "<tr><th>Day</th><th>Activity for the morning</th></tr>"
65 "<tr><td>Monday</td><td>Read the first three chapters</td></tr>"
66 "<tr><td>Tuesday</td><td>Notes and a short summary</td></tr>"
67 "<tr><td>Wednesday</td><td>Review and discuss</td></tr>"
68 "</table>"
69 "<p>Text after the table resumes the normal flow.</p></body></html>";
70
71static const uint8_t k_msg_boot[] = "ereader-table-hil: boot\r\n";
72static const uint8_t k_msg_fail[] = "ereader-table-hil: FAIL init\r\n";
73static const uint8_t k_msg_lerr[] = "ereader-table-hil: FAIL layout\r\n";
74static const uint8_t k_msg_pre[] = "ereader-table-hil: glyphs=";
75static const uint8_t k_msg_geom[] = " geom=";
76static const uint8_t k_msg_eol[] = "\r\n";
77
79static void tb_print(const uint8_t* msg, uint32_t len)
80{
81 (void)ra8_board_uart_console_write(msg, (size_t)len);
82}
83
85static void tb_panic_halt(const uint8_t* msg, uint32_t len)
86{
87 tb_print(msg, len);
88 __asm__ volatile("bkpt #0");
89 while (1) {
90 __asm__ volatile("wfi");
91 }
92}
93
95static void tb_print_hex(uint32_t value)
96{
97 uint8_t buf[k_tb_hex_nibbles];
98 for (uint32_t i = 0U; i < (uint32_t)k_tb_hex_nibbles; i++) {
99 const uint32_t shift = ((uint32_t)k_tb_hex_nibbles - 1U - i) * (uint32_t)k_tb_nibble_bits;
100 const uint32_t nib = (value >> shift) & (uint32_t)k_tb_nibble_mask;
101 buf[i] = (uint8_t)((nib < (uint32_t)k_tb_dec_ten) ? ('0' + nib) : ('A' + (nib - k_tb_dec_ten)));
102 }
103 tb_print(buf, (uint32_t)k_tb_hex_nibbles);
104}
105
107static void tb_print_uint(uint32_t value)
108{
109 uint8_t buf[k_tb_dec_ten];
110 uint32_t n = 0U;
111 if (value == 0U) {
112 buf[n] = '0';
113 n++;
114 }
115 while ((value > 0U) && (n < (uint32_t)k_tb_dec_ten)) {
116 buf[n] = (uint8_t)('0' + (value % (uint32_t)k_tb_dec_ten));
117 n++;
118 value /= (uint32_t)k_tb_dec_ten;
119 }
120 for (uint32_t i = 0U; i < n; i++) {
121 tb_print(&buf[n - 1U - i], 1U);
122 }
123}
124
126static uint32_t tb_geom_hash(void)
127{
128 uint32_t hsh = (uint32_t)k_tb_fnv_offset;
129 const size_t nbytes = sizeof(int32_t) * 2U; /* x + y per glyph */
130 for (uint32_t g = 0U; g < s_engine.glyph_count; g++) {
131 const int32_t coords[2] = {s_engine.glyphs[g].x, s_engine.glyphs[g].y};
132 const uint8_t* p = (const uint8_t*)coords;
133 for (size_t i = 0U; i < nbytes; i++) {
134 hsh = (hsh ^ (uint32_t)p[i]) * (uint32_t)k_tb_fnv_prime;
135 }
136 }
137 return hsh;
138}
139
141static void tb_setup_or_halt(void)
142{
143 uint32_t cpuclk0_hz = 0U;
144 if ((ra8_cgc_init() != k_ra8_ok) || (ra8_mstp_init() != k_ra8_ok)) {
145 tb_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);
146 }
147 if (ra8_cgc_get_clock_hz(k_ra8_clock_id_cpuclk0, &cpuclk0_hz) != k_ra8_ok) {
148 tb_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);
149 }
150 if (ra8_time_init(cpuclk0_hz) != k_ra8_ok) {
151 tb_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);
152 }
153 if (ra8_board_uart_console_init((uint32_t)k_tb_uart_baud) != k_ra8_ok) {
154 tb_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);
155 }
156}
157
166void main(void)
167{
168 tb_setup_or_halt();
169 ra8_isr_globals_enable();
170 tb_print(k_msg_boot, (uint32_t)sizeof(k_msg_boot) - 1U);
171
172 if (reflow_init((uint16_t)k_tb_view_w,
173 (uint16_t)k_tb_view_h,
174 k_ahem_ttf,
175 (size_t)k_ahem_ttf_len,
176 (uint16_t)k_tb_font_px,
177 (uint32_t)k_tb_ink,
178 (uint32_t)k_tb_link_col,
179 &s_engine) != k_ra8_ok) {
180 tb_panic_halt(k_msg_fail, (uint32_t)sizeof(k_msg_fail) - 1U);
181 }
182 uint32_t pages = 0U;
183 if (reflow_layout_chapter(&s_engine,
184 (const uint8_t*)k_tb_chapter,
185 (uint32_t)(sizeof(k_tb_chapter) - 1U),
186 &pages) != k_ra8_ok) {
187 tb_panic_halt(k_msg_lerr, (uint32_t)sizeof(k_msg_lerr) - 1U);
188 }
189
190 tb_print(k_msg_pre, (uint32_t)sizeof(k_msg_pre) - 1U);
191 tb_print_uint(s_engine.glyph_count);
192 tb_print(k_msg_geom, (uint32_t)sizeof(k_msg_geom) - 1U);
193 tb_print_hex(tb_geom_hash());
194 tb_print(k_msg_eol, (uint32_t)sizeof(k_msg_eol) - 1U);
195
196 while (1) {
197 __asm__ volatile("wfi");
198 }
199}
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
tb_consts_t
tb_consts_t
Viewport / console / hash knobs (no magic numbers).
Definition main.c:42
k_tb_font_px
@ k_tb_font_px
Body font size, pixels.
Definition main.c:45
k_tb_view_h
@ k_tb_view_h
Layout viewport height, pixels.
Definition main.c:44
k_tb_nibble_bits
@ k_tb_nibble_bits
Bits per hex nibble.
Definition main.c:52
k_tb_fnv_prime
@ k_tb_fnv_prime
FNV-1a-32 prime.
Definition main.c:50
k_tb_hex_nibbles
@ k_tb_hex_nibbles
Hex digits in a 32-bit value.
Definition main.c:51
k_tb_view_w
@ k_tb_view_w
Layout viewport width, pixels.
Definition main.c:43
k_tb_fnv_offset
@ k_tb_fnv_offset
FNV-1a-32 offset basis.
Definition main.c:49
k_tb_uart_baud
@ k_tb_uart_baud
Console baud.
Definition main.c:48
k_tb_dec_ten
@ k_tb_dec_ten
Hex digit / decimal split.
Definition main.c:54
k_tb_nibble_mask
@ k_tb_nibble_mask
Low-nibble mask.
Definition main.c:53
k_tb_link_col
@ k_tb_link_col
Anchor colour (ARGB).
Definition main.c:47
k_tb_ink
@ k_tb_ink
Body ink colour (ARGB).
Definition main.c:46
tb_print_uint
static void tb_print_uint(uint32_t value)
Print a small unsigned integer in decimal.
Definition main.c:107
tb_setup_or_halt
static void tb_setup_or_halt(void)
Bring up clocks/MSTP/time + the SCI8 console; halt on failure.
Definition main.c:141
tb_geom_hash
static uint32_t tb_geom_hash(void)
FNV-1a-32 over every laid-out glyph's (x, y) position.
Definition main.c:126
tb_print_hex
static void tb_print_hex(uint32_t value)
Print a 32-bit value as 8 upper-case hex digits.
Definition main.c:95
k_tb_chapter
static const char k_tb_chapter[]
Baked chapter: a heading, a 2-column table, and a trailing paragraph.
Definition main.c:61
tb_print
static void tb_print(const uint8_t *msg, uint32_t len)
Emit a byte run on the SCI8 console.
Definition main.c:79
tb_panic_halt
static void tb_panic_halt(const uint8_t *msg, uint32_t len)
Print the fail banner and trap (ra8_emulator halts on the BKPT).
Definition main.c:85
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_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_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_t
Reflow / pagination engine state.
Definition reflow_types.h:448