ra8_board_ra8p1.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_port_constants.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* =============================================================================
 * Board identity
 * =============================================================================
 */

extern const char* const k_ra8_board_name;    
extern const char* const k_ra8_board_doc_rev; 
extern const char* const k_ra8_board_mcu;     

typedef struct {
  const char* name;    
  const char* doc_rev; 
  const char* mcu;     
} ra8_board_info_t;

[[nodiscard]] ra8_err_t ra8_board_get_info(ra8_board_info_t* out);
 
/* =============================================================================
 * 1. User LEDs -- provisional, TODO(EK-RA8P1 UM / ra8p1_kicad)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_led1 = 0U, 
  k_ra8_board_led2 = 1U, 
  k_ra8_board_led3 = 2U, 

  k_ra8_board_led_blue  = k_ra8_board_led1,
  k_ra8_board_led_green = k_ra8_board_led2, 
  k_ra8_board_led_red   = k_ra8_board_led3, 
 
  k_ra8_board_led_count = 3U, 
} ra8_board_led_id_t;

[[nodiscard]] ra8_err_t ra8_board_led_init(ra8_board_led_id_t led);

[[nodiscard]] ra8_err_t ra8_board_led_on(ra8_board_led_id_t led);

[[nodiscard]] ra8_err_t ra8_board_led_off(ra8_board_led_id_t led);

[[nodiscard]] ra8_err_t ra8_board_led_toggle(ra8_board_led_id_t led);

[[nodiscard]] ra8_err_t ra8_board_led_pin(ra8_board_led_id_t led, ra8_port_pin_t* out_pin);
 
/* =============================================================================
 * 2. User switches -- provisional, TODO(EK-RA8P1 UM / ra8p1_kicad)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_sw1      = 0U, 
  k_ra8_board_sw2      = 1U, 
  k_ra8_board_sw_count = 2U, 
} ra8_board_sw_id_t;

typedef enum : uint8_t {
  k_ra8_board_sw1_irq = 13U, 
  k_ra8_board_sw2_irq = 12U, 
} ra8_board_sw_irq_t;

typedef enum : uint8_t {
  k_ra8_board_sw_released = 0U, 
  k_ra8_board_sw_pressed  = 1U, 
} ra8_board_sw_state_t;

[[nodiscard]] ra8_err_t ra8_board_sw_init(ra8_board_sw_id_t sw);

[[nodiscard]] ra8_err_t ra8_board_sw_read(ra8_board_sw_id_t sw, ra8_board_sw_state_t* out_pressed);

typedef void (*ra8_board_sw_irq_cb_t)(void* ctx);

[[nodiscard]] ra8_err_t
ra8_board_sw_attach_irq(ra8_board_sw_id_t sw, ra8_board_sw_irq_cb_t cb, void* ctx);

[[nodiscard]] ra8_err_t ra8_board_sw_pin(ra8_board_sw_id_t sw, ra8_port_pin_t* out_pin);
 
/* =============================================================================
 * 3. Debug UART console -- provisional, TODO(EK-RA8P1 UM / ra8p1_kicad)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_uart_console = 0U, 
} ra8_board_uart_t;

typedef enum : uint8_t {
  k_ra8_board_uart_console_sci_channel = 8U, 
} ra8_board_uart_sci_channel_t;

typedef enum : uint16_t {
  k_ra8_board_uart_console_pin_txd =
    (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_2), 
  k_ra8_board_uart_console_pin_rxd =
    (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_3), 
  k_ra8_board_uart_console_pin_rts =
    (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_4), 
  k_ra8_board_uart_console_pin_cts =
    (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_5), 
} ra8_board_uart_console_pin_t;

[[nodiscard]] ra8_err_t ra8_board_uart_console_init(uint32_t baud);

[[nodiscard]] ra8_err_t ra8_board_uart_console_write(const uint8_t* data, size_t len);

[[nodiscard]] ra8_err_t ra8_board_uart_console_read(uint8_t* out, size_t cap, size_t* out_len);

[[nodiscard]] ra8_err_t ra8_board_uart_console_flush(void);
 
#ifdef __cplusplus
}
#endif