HomeCore 0.1.3 (07b5544)
Bare-metal personal computer firmware for Cortex-M
Loading...
Searching...
No Matches
board.h
Go to the documentation of this file.
1/*
2 * MIT License
3 *
4 * Copyright (c) 2026 Grzegorz Grzęda
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 */
24/*---------------------------------------------------------------------------*/
30/*---------------------------------------------------------------------------*/
31#ifndef HOME_CORE_BOARD_H
32#define HOME_CORE_BOARD_H
33/*---------------------------------------------------------------------------*/
34#if defined(__cplusplus)
35extern "C" {
36#endif
37/*---------------------------------------------------------------------------*/
38#include <stdint.h>
39#include "homecore/devicetree.h"
40/*---------------------------------------------------------------------------*/
52/*---------------------------------------------------------------------------*/
54#define BOARD_STRINGIFY(x) #x
56#define BOARD DT_BOARD_NAME
57/*---------------------------------------------------------------------------*/
64void board_init(void);
65/*---------------------------------------------------------------------------*/
72uint32_t board_cpu_clock_hz(void);
73/*---------------------------------------------------------------------------*/
81void board_uart_putc(char c);
82/*---------------------------------------------------------------------------*/
90int board_uart_getc(void);
91/*---------------------------------------------------------------------------*/
99int board_uart_has_data(void);
100/*---------------------------------------------------------------------------*/
109void board_panic(const char *msg);
110/*---------------------------------------------------------------------------*/
112/*---------------------------------------------------------------------------*/
113#if defined(__cplusplus)
114}
115#endif
116/*---------------------------------------------------------------------------*/
117#endif // HOME_CORE_BOARD_H
118/*---------------------------------------------------------------------------*/
board_uart_putc
void board_uart_putc(char c)
Write one byte to the console UART by polling.
board_uart_has_data
int board_uart_has_data(void)
Check without blocking whether the console UART has received data.
board_init
void board_init(void)
Initialize board clocks, pins, and the console UART.
board_cpu_clock_hz
uint32_t board_cpu_clock_hz(void)
Report the core clock frequency.
board_uart_getc
int board_uart_getc(void)
Read one byte from the console UART, blocking until one arrives.
board_panic
void board_panic(const char *msg)
Report a fatal error and halt.