ra8-firmware 0.1.0
Bare-metal firmware for the Renesas RA8 family (RA8D2 / RA8P1)
Loading...
Searching...
No Matches
ra8_io_stream_uart.c
Go to the documentation of this file.
1
16
17#include "ra8_io_stream_uart.h"
18
19#include <stdint.h>
20
21#include "ra8_attributes.h"
22#include "ra8_check.h"
23#include "ra8_err.h"
25#include "ra8_sci.h"
26
28static const char* const s_tag = "ra8_io_stream_uart";
29
57internal_uart_write(void* ctx, const uint8_t* buf, uint32_t len, uint32_t* out_written)
58{
59 RA8_CHECK_NULL_PTR(ctx, s_tag, "ctx must not be nullptr");
60 RA8_CHECK_NULL_PTR(buf, s_tag, "buf must not be nullptr");
62 const ra8_err_t e = ra8_sci_write_polling(st->channel, buf, len);
63 if (e != k_ra8_ok) {
64 return e;
65 }
66 if (out_written != nullptr) {
67 *out_written = len;
68 }
69 return k_ra8_ok;
70}
71
96{
97 RA8_CHECK_NULL_PTR(ctx, s_tag, "ctx must not be nullptr");
99 return ra8_sci_flush(st->channel);
100}
101
104 .write = internal_uart_write,
105 .flush = internal_uart_flush,
106};
107
110{
111 RA8_CHECK_NULL_PTR(s, s_tag, "s must not be nullptr");
112 RA8_CHECK_NULL_PTR(state, s_tag, "state must not be nullptr");
113 state->channel = channel;
114 return ra8_io_stream_bind(s, &s_uart_iface, state);
115}
static const char * s_tag
Logging / check tag.
Definition ra8_app.c:17
Annotation-attribute framework macros for ra8-firmware.
#define RA8_INTERNAL
Marker that a function is intended to be static (file-local).
Validation and Error-Checking Macros for ra8-firmware.
#define RA8_CHECK_NULL_PTR(ptr, tag, message)
Reject nullptr pointer, returning k_ra8_err_null_ptr.
Definition ra8_check.h:243
Error Code Definitions for ra8-firmware.
@ k_ra8_ok
Success – operation completed with all postconditions satisfied.
Definition ra8_err.h:119
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546
struct ra8_io_stream_iface ra8_io_stream_iface_t
Public implementer contract for ra8_io byte-stream backends.
ra8_err_t ra8_io_stream_bind(ra8_io_stream_t *stream, const ra8_io_stream_iface_t *iface, void *context)
Bind a backend vtable and caller-owned state into a stream handle.
static const ra8_io_stream_iface_t s_uart_iface
UART stream sink vtable.
ra8_err_t ra8_io_stream_uart_init(ra8_io_stream_t *s, ra8_io_stream_uart_state_t *state, uint8_t channel)
Bind a UART stream sink into a caller-owned stream handle.
static ra8_err_t internal_uart_flush(void *ctx)
UART sink: drain the SCI transmit shift register.
static ra8_err_t internal_uart_write(void *ctx, const uint8_t *buf, uint32_t len, uint32_t *out_written)
UART sink: write all bytes out of the SCI channel by polling.
ra8_io byte-stream sink over a UART/SCI channel.
Full-featured Serial Communications Interface driver.
ra8_err_t ra8_sci_write_polling(uint8_t channel, const uint8_t *data, uint32_t len)
Send len bytes by polling (convenience wrapper).
Definition ra8_sci.c:516
ra8_err_t ra8_sci_flush(uint8_t channel)
Block until the channel's transmit shift register is empty.
Definition ra8_sci.c:543
Caller-allocated byte-stream handle binding a sink to its context.
Caller-owned private state for a UART stream sink.
uint8_t channel
SCI channel index (private).