ra8_board_ek_ra8d2_connectors.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 (UM Section 5.5.1, Table 24, page 31)
 * =============================================================================
 */

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 (UM Section 5.5.2, Table 25, page 32)
 * =============================================================================
 */

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. Parallel-RGB Graphics Expansion connector J1
 *    (UM Section 8.1, Table 33, page 42)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_glcdc_fmt_rgb888 = 0U, 
  k_ra8_board_glcdc_fmt_rgb666 = 1U, 
  k_ra8_board_glcdc_fmt_rgb565 = 2U, 
} ra8_board_glcdc_fmt_t;

typedef struct {
  const char*    signal; 
  ra8_port_pin_t pin;    
} ra8_board_glcdc_pin_t;

extern const ra8_board_glcdc_pin_t g_ra8_board_glcdc_rgb888_pins[];
extern const ra8_board_glcdc_pin_t g_ra8_board_glcdc_rgb666_pins[];
extern const ra8_board_glcdc_pin_t g_ra8_board_glcdc_rgb565_pins[];

extern const uint32_t g_ra8_board_glcdc_rgb888_pin_count;
extern const uint32_t g_ra8_board_glcdc_rgb666_pin_count;
extern const uint32_t g_ra8_board_glcdc_rgb565_pin_count;

[[nodiscard]] ra8_err_t ra8_board_glcdc_init(ra8_board_glcdc_fmt_t fmt);

typedef enum : uint16_t {
  k_ra8_board_lcd_reset_l = (uint16_t)k_ra8_pin_lcd_reset_l, 
  k_ra8_board_lcd_blen    = (uint16_t)k_ra8_pin_lcd_blen,    
} ra8_board_lcd_gpio_pin_t;

[[nodiscard]] ra8_err_t ra8_board_lcd_panel_power_on(void);

[[nodiscard]] ra8_err_t ra8_board_backlight_set(bool on);
 
/* =============================================================================
 * 4. Audio CODEC (DA7212 U14, SSIE + I2C)
 *    (UM Section 6.6, Table 32, page 38)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_audio_pin_bclk =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_3), 
  k_ra8_board_audio_pin_wclk =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_4), 
  k_ra8_board_audio_pin_datin =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_5), 
  k_ra8_board_audio_pin_datout =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_6), 
  k_ra8_board_audio_pin_mclk =
    (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_6), 
  k_ra8_board_audio_pin_i2c_sda =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_11), 
  k_ra8_board_audio_pin_i2c_scl =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_12), 
} ra8_board_audio_pin_t;

typedef enum : uint8_t {
  k_ra8_board_audio_ssie_channel = 0U, 
} ra8_board_audio_ch_t;

[[nodiscard]] ra8_err_t
ra8_board_audio_init(uint32_t sample_rate_hz, uint8_t bit_depth, uint8_t channels);

[[nodiscard]] ra8_err_t ra8_board_audio_play_sample_block(const int16_t* buf, uint32_t len);
 
/* =============================================================================
 * 5. Arduino Uno header (J18/J19/J23/J24) (UM Section 5.3.4, Table 20, p 27-28)
 * =============================================================================
 */

typedef enum : uint16_t {
  /* Digital I/O (J23 + J24). */
  k_ra8_board_arduino_d0 =
    (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_8), 
  k_ra8_board_arduino_d1 =
    (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_9), 
  k_ra8_board_arduino_d2 =
    (uint16_t)RA8_PIN(k_ra8_port_0,
                      k_ra8_pin_11), 
  k_ra8_board_arduino_d3 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_11), 
  k_ra8_board_arduino_d4 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_10), 
  k_ra8_board_arduino_d5 =
    (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_4), 
  k_ra8_board_arduino_d6 =
    (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_5), 
  k_ra8_board_arduino_d7 =
    (uint16_t)RA8_PIN(k_ra8_port_3,
                      k_ra8_pin_12), 
  k_ra8_board_arduino_d8 =
    (uint16_t)RA8_PIN(k_ra8_port_13,
                      k_ra8_pin_1), 
  k_ra8_board_arduino_d9 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_10), 
  k_ra8_board_arduino_d10 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_3), 
  k_ra8_board_arduino_d11 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_1), 
  k_ra8_board_arduino_d12 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_0), 
  k_ra8_board_arduino_d13 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_2), 
  k_ra8_board_arduino_d14 = (uint16_t)RA8_PIN(
    k_ra8_port_5,
    k_ra8_pin_11), 
  k_ra8_board_arduino_d15 = (uint16_t)RA8_PIN(
    k_ra8_port_5,
    k_ra8_pin_12), 
 
  /* Analog input block (J19). */
  k_ra8_board_arduino_a0 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_1), 
  k_ra8_board_arduino_a1 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_7), 
  k_ra8_board_arduino_a2 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_3), 
  k_ra8_board_arduino_a3 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_4), 
  k_ra8_board_arduino_a4 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_14), 
  k_ra8_board_arduino_a5 =
    (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_15), 
} ra8_board_arduino_pin_t;

typedef enum : uint8_t {
  k_ra8_board_arduino_mode_input        = 0U, 
  k_ra8_board_arduino_mode_input_pullup = 1U, 
  k_ra8_board_arduino_mode_output       = 2U, 
} ra8_board_arduino_mode_t;

[[nodiscard]] ra8_err_t ra8_board_arduino_pin_init(ra8_board_arduino_pin_t  pin,
                                                   ra8_board_arduino_mode_t mode);

[[nodiscard]] ra8_err_t ra8_board_arduino_gpio_write(ra8_board_arduino_pin_t pin,
                                                     ra8_level_t             level);

[[nodiscard]] ra8_err_t ra8_board_arduino_gpio_read(ra8_board_arduino_pin_t pin,
                                                    ra8_level_t*            out_level);
 
/* =============================================================================
 * 6. Pmod connectors (UM Section 5.3.3.1 + 5.3.3.2, Tables 17 + 19, p 26-27)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_pmod1      = 0U, 
  k_ra8_board_pmod2      = 1U, 
  k_ra8_board_pmod_count = 2U, 
} ra8_board_pmod_id_t;

typedef enum : uint16_t {
  k_ra8_board_pmod1_spi_cs = (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_4),
  k_ra8_board_pmod1_spi_copi =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_1), 
  k_ra8_board_pmod1_spi_cipo =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_2), 
  k_ra8_board_pmod1_spi_sck =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_3), 
} ra8_board_pmod1_spi_pin_t;

typedef enum : uint16_t {
  k_ra8_board_pmod1_uart_txd =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_1), 
  k_ra8_board_pmod1_uart_rxd =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_2), 
  k_ra8_board_pmod1_uart_cts =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_0), 
  k_ra8_board_pmod1_uart_rts =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_4), 
} ra8_board_pmod1_uart_pin_t;

typedef enum : uint16_t {
  k_ra8_board_pmod1_i2c_sda =
    (uint16_t)RA8_PIN(k_ra8_port_5,
                      k_ra8_pin_11), 
  k_ra8_board_pmod1_i2c_scl =
    (uint16_t)RA8_PIN(k_ra8_port_5,
                      k_ra8_pin_12), 
} ra8_board_pmod1_i2c_pin_t;

typedef enum : uint16_t {
  k_ra8_board_pmod1_irq =
    (uint16_t)RA8_PIN(k_ra8_port_0,
                      k_ra8_pin_6), 
  k_ra8_board_pmod1_reset =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_2), 
  k_ra8_board_pmod1_gpio_a =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_12), 
  k_ra8_board_pmod1_gpio_b =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_13), 
} ra8_board_pmod1_gpio_pin_t;

typedef enum : uint8_t {
  k_ra8_board_pmod1_sci_channel = 2U, 
  k_ra8_board_pmod2_sci_channel = 0U, 
} ra8_board_pmod_sci_channel_t;

typedef enum : uint16_t {
  k_ra8_board_pmod2_spi_cs = (uint16_t)RA8_PIN(k_ra8_port_6, k_ra8_pin_4),
  k_ra8_board_pmod2_spi_copi =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_3), 
  k_ra8_board_pmod2_spi_cipo =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_2), 
  k_ra8_board_pmod2_spi_sck =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_1), 
} ra8_board_pmod2_spi_pin_t;

typedef enum : uint16_t {
  k_ra8_board_pmod2_uart_txd =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_3), 
  k_ra8_board_pmod2_uart_rxd =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_2), 
  k_ra8_board_pmod2_uart_cts =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_5), 
  k_ra8_board_pmod2_uart_rts =
    (uint16_t)RA8_PIN(k_ra8_port_6,
                      k_ra8_pin_4), 
} ra8_board_pmod2_uart_pin_t;

typedef enum : uint16_t {
  k_ra8_board_pmod2_irq =
    (uint16_t)RA8_PIN(k_ra8_port_0,
                      k_ra8_pin_12), 
  k_ra8_board_pmod2_reset =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_10), 
  k_ra8_board_pmod2_gpio_a =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_9), 
  k_ra8_board_pmod2_gpio_b =
    (uint16_t)RA8_PIN(k_ra8_port_7, k_ra8_pin_4), 
} ra8_board_pmod2_gpio_pin_t;
 
/* =============================================================================
 * 6b. MikroBUS connector (J21/J22, UM Section 5.3.5 + Table 21 p 29)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_mikrobus_an = (uint16_t)RA8_PIN(k_ra8_port_0, k_ra8_pin_4),
  k_ra8_board_mikrobus_rst = (uint16_t)RA8_PIN(k_ra8_port_2, k_ra8_pin_1),
  k_ra8_board_mikrobus_cs = (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_3),
  k_ra8_board_mikrobus_sck = (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_2),
  k_ra8_board_mikrobus_cipo = (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_0),
  k_ra8_board_mikrobus_copi = (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_1),
  k_ra8_board_mikrobus_pwm = (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_10),
  k_ra8_board_mikrobus_int = (uint16_t)RA8_PIN(k_ra8_port_13, k_ra8_pin_1),
  k_ra8_board_mikrobus_rx = (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_8),
  k_ra8_board_mikrobus_tx = (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_9),
} ra8_board_mikrobus_pin_t;

typedef enum : uint16_t {
  k_ra8_board_mikrobus_i2c_sda = (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_11),
  k_ra8_board_mikrobus_i2c_scl = (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_12),
} ra8_board_mikrobus_i2c_pin_t;

typedef enum : uint8_t {
  k_ra8_board_mikrobus_iic_b_channel = 0U, 
} ra8_board_mikrobus_iic_channel_t;

typedef enum : uint8_t {
  k_ra8_board_mikrobus_uart_sci_channel = 7U, 
} ra8_board_mikrobus_uart_channel_t;
 
/* =============================================================================
 * 6c. Project SW4 layout (UM Section 4.3 Table 3 p 16 + Table 18 p 26)
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_board_pi4ioe_output_project_default = 0xF2U,
  k_ra8_board_pi4ioe_output_octospi_active = 0xF8U,
  k_ra8_board_pi4ioe_output_usbhs_host = 0x72U,
} ra8_board_pi4ioe_project_t;
 
/* =============================================================================
 * 6d. Native SDHI bus (SDHI0, port 4 pins 0..7)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_sdhi_cmd =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_0), 
  k_ra8_board_sdhi_clk =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_1), 
  k_ra8_board_sdhi_dat0 =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_2), 
  k_ra8_board_sdhi_dat1 =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_3), 
  k_ra8_board_sdhi_dat2 =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_4), 
  k_ra8_board_sdhi_dat3 =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_5), 
  k_ra8_board_sdhi_wp =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_6), 
  k_ra8_board_sdhi_cd =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_7), 
} ra8_board_sdhi_pin_t;

typedef enum : uint8_t {
  k_ra8_board_sdhi_instance = 0U, 
} ra8_board_sdhi_instance_t;

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