ra8_board_ek_ra8d2_peripherals.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_board_ek_ra8d2_connectors.h"
#include "ra8_err.h"
#include "ra8_port_constants.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  uint32_t cpuclk0_hz; 
  uint32_t pclka_hz;   
} ra8_board_clock_rates_t;

[[nodiscard]] ra8_err_t ra8_board_clocks_init(ra8_board_clock_rates_t* out_rates);
 
/* =============================================================================
 * 6c. Project SW4 layout (UM Section 4.3 Table 3 p 16 + Table 18 p 26)
 *     -- I/O-expander override functions (the ra8_board_pi4ioe_project_t
 *        enum that names the output bytes lives in the connectors header).
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_board_io_expander_apply_project_sw4_defaults(void);

[[nodiscard]] ra8_err_t ra8_board_io_expander_apply_sw4(uint8_t output_byte);

[[nodiscard]] ra8_err_t ra8_board_io_expander_apply_sw4_mask(uint8_t output_byte,
                                                             uint8_t output_mask);

[[nodiscard]] ra8_err_t ra8_board_io_expander_set_octospi_active(void);
 
/* =============================================================================
 * 7. USB (UM Section 5.4.1 + 6.2, Tables 22 + 28, p 30 + 34)
 * =============================================================================
 */

typedef enum : uint16_t {
  /* The HS D+/D- differential pair (USBH_P/USBH_N) is internal to the chip,
   * so only the two MCU-driven board signals below are port pins: the VBUS
   * sense input and the J7 host-power-switch enable. */
  k_ra8_board_usbhs_pin_vbus =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_8), 
  k_ra8_board_usbhs_pin_pwr = (uint16_t)RA8_PIN(
    k_ra8_port_13,
    k_ra8_pin_7), 
} ra8_board_usbhs_pin_t;

typedef enum : uint16_t {
  k_ra8_board_usbfs_pin_dp =
    (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_14), 
  k_ra8_board_usbfs_pin_dm =
    (uint16_t)RA8_PIN(k_ra8_port_8, k_ra8_pin_15), 
  k_ra8_board_usbfs_pin_vbus =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_7), 
  k_ra8_board_usbfs_pin_vbusen =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_0), 
} ra8_board_usbfs_pin_t;

typedef enum : uint16_t {
  k_ra8_board_i3c0_pin_scl =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_0), 
  k_ra8_board_i3c0_pin_sda =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_1), 
} ra8_board_i3c0_pin_t;

typedef enum : uint32_t {
  k_ra8_board_touch_i3c_channel = 0U,      
  k_ra8_board_touch_target_7b   = 0x5DU,   
  k_ra8_board_touch_bus_hz      = 400000U, 
} ra8_board_touch_wiring_t;

[[nodiscard]] ra8_err_t ra8_board_io_expander_set_usbhs_device_mode(void);

[[nodiscard]] ra8_err_t ra8_board_io_expander_set_usbhs_host_mode(void);

[[nodiscard]] ra8_err_t ra8_board_usbhs_device_init(void);

[[nodiscard]] ra8_err_t ra8_board_usbhs_host_init(void);
 
/* =============================================================================
 * 8. Camera connector J35 (UM Section 8.3, Tables 35 + 36, p 48 + 49)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_cam_d0 =
    (uint16_t)RA8_PIN(k_ra8_port_4,
                      k_ra8_pin_0), 
  k_ra8_board_cam_d1 =
    (uint16_t)RA8_PIN(k_ra8_port_9,
                      k_ra8_pin_2), 
  k_ra8_board_cam_d2 =
    (uint16_t)RA8_PIN(k_ra8_port_4,
                      k_ra8_pin_5), 
  k_ra8_board_cam_d3 =
    (uint16_t)RA8_PIN(k_ra8_port_4,
                      k_ra8_pin_6), 
  k_ra8_board_cam_d4 =
    (uint16_t)RA8_PIN(k_ra8_port_7,
                      k_ra8_pin_0), 
  k_ra8_board_cam_d5 =
    (uint16_t)RA8_PIN(k_ra8_port_7,
                      k_ra8_pin_1), 
  k_ra8_board_cam_d6 =
    (uint16_t)RA8_PIN(k_ra8_port_7,
                      k_ra8_pin_2), 
  k_ra8_board_cam_d7 =
    (uint16_t)RA8_PIN(k_ra8_port_7,
                      k_ra8_pin_3), 
  k_ra8_board_cam_vsync =
    (uint16_t)RA8_PIN(k_ra8_port_11,
                      k_ra8_pin_2), 
  k_ra8_board_cam_hsync =
    (uint16_t)RA8_PIN(k_ra8_port_11,
                      k_ra8_pin_3), 
  k_ra8_board_cam_pclk =
    (uint16_t)RA8_PIN(k_ra8_port_11,
                      k_ra8_pin_4), 
  k_ra8_board_cam_xclk =
    (uint16_t)RA8_PIN(k_ra8_port_5,
                      k_ra8_pin_1), 
  k_ra8_board_cam_rst =
    (uint16_t)RA8_PIN(k_ra8_port_7,
                      k_ra8_pin_9), 
  k_ra8_board_cam_int =
    (uint16_t)RA8_PIN(k_ra8_port_0,
                      k_ra8_pin_10), 
  k_ra8_board_cam_i2c_sda =
    (uint16_t)RA8_PIN(k_ra8_port_5,
                      k_ra8_pin_11), 
  k_ra8_board_cam_i2c_scl =
    (uint16_t)RA8_PIN(k_ra8_port_5,
                      k_ra8_pin_12), 
} ra8_board_camera_pin_t;

typedef enum : uint8_t {
  k_ra8_board_camera_i2c_channel = 1U, 
} ra8_board_camera_bus_t;

[[nodiscard]] ra8_err_t ra8_board_camera_xclk_start(uint32_t frequency_hz);

[[nodiscard]] ra8_err_t ra8_board_camera_select_parallel(void);

[[nodiscard]] ra8_err_t ra8_board_camera_route_parallel_pins(void);

[[nodiscard]] ra8_err_t ra8_board_camera_reset(void);

[[nodiscard]] ra8_err_t
ra8_board_camera_sccb_read_reg(void* ctx, uint8_t address, uint16_t reg, uint8_t* out_value);

[[nodiscard]] ra8_err_t
ra8_board_camera_sccb_write_reg(void* ctx, uint8_t address, uint16_t reg, uint8_t value);

void ra8_board_camera_delay_ms(void* ctx, uint32_t milliseconds);
 
/* =============================================================================
 * 9. Octo-SPI flash + SDRAM (UM Section 6.3 + 6.4, Tables 29 + 30, p 35 + 36)
 * =============================================================================
 */

typedef enum : uintptr_t {
  k_ra8_board_xspi_flash_base = 0x80000000UL, 
  k_ra8_board_sdram_base =
    0x68000000UL, 
} ra8_board_extmem_base_t;

typedef enum : uint32_t {
  k_ra8_board_xspi_flash_size = 0x04000000UL, 
  k_ra8_board_sdram_size      = 0x04000000UL, 
} ra8_board_extmem_size_t;

typedef enum : uint16_t {
  k_ra8_board_xspi_cs =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_4), 
  k_ra8_board_xspi_clk =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_8), 
  k_ra8_board_xspi_dqs =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_1), 
  k_ra8_board_xspi_reset =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_6), 
  k_ra8_board_xspi_dq0 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_0), 
  k_ra8_board_xspi_dq1 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_3), 
  k_ra8_board_xspi_dq2 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_3), 
  k_ra8_board_xspi_dq3 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_1), 
  k_ra8_board_xspi_dq4 =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_2), 
  k_ra8_board_xspi_dq5 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_0), 
  k_ra8_board_xspi_dq6 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_2), 
  k_ra8_board_xspi_dq7 =
    (uint16_t)RA8_PIN(k_ra8_port_8,
                      k_ra8_pin_4), 
} ra8_board_xspi_pin_t;

[[nodiscard]] ra8_err_t ra8_board_xspi_pins_init(void);
 
/* =============================================================================
 * 10. MIPI-DSI graphics expansion port J32
 *     (UM Section 8.2, Table 34, page 45)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_mipi_dsi_te =
    (uint16_t)RA8_PIN(k_ra8_port_4,
                      k_ra8_pin_11), 
  k_ra8_board_mipi_dsi_reset_n =
    (uint16_t)RA8_PIN(k_ra8_port_6, k_ra8_pin_6), 
  k_ra8_board_mipi_dsi_backlight =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_14), 
  k_ra8_board_mipi_dsi_touch_int =
    (uint16_t)RA8_PIN(k_ra8_port_1,
                      k_ra8_pin_11), 
  k_ra8_board_mipi_dsi_i2c_sda =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_11), 
  k_ra8_board_mipi_dsi_i2c_scl =
    (uint16_t)RA8_PIN(k_ra8_port_5, k_ra8_pin_12), 
} ra8_board_mipi_dsi_pin_t;

[[nodiscard]] ra8_err_t ra8_board_mipi_dsi_init(void);
 
/* =============================================================================
 * 11. J-Link OB VCOM serial bridge (UM Section 5.2.4, Table 13, page 24)
 * =============================================================================
 */

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);
 
/* =============================================================================
 * 12. On-board RGMII Ethernet PHY (UM Section 6.1, Tables 26 + 27, p 33-34)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_board_eth_pin_mdint =
    (uint16_t)RA8_PIN(k_ra8_port_1, k_ra8_pin_7), 
  k_ra8_board_eth_pin_mdc =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_15), 
  k_ra8_board_eth_pin_mdio =
    (uint16_t)RA8_PIN(k_ra8_port_4, k_ra8_pin_14), 
  k_ra8_board_eth_pin_txd0 =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_7), 
  k_ra8_board_eth_pin_txd1 =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_6), 
  k_ra8_board_eth_pin_txd2 =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_5), 
  k_ra8_board_eth_pin_txd3 =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_4), 
  k_ra8_board_eth_pin_tx_ctl =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_10), 
  k_ra8_board_eth_pin_tx_clk =
    (uint16_t)RA8_PIN(k_ra8_port_3, k_ra8_pin_9), 
  k_ra8_board_eth_pin_rxd0 =
    (uint16_t)RA8_PIN(k_ra8_port_9, k_ra8_pin_6), 
  k_ra8_board_eth_pin_rxd1 =
    (uint16_t)RA8_PIN(k_ra8_port_9, k_ra8_pin_7), 
  k_ra8_board_eth_pin_rxd2 =
    (uint16_t)RA8_PIN(k_ra8_port_9, k_ra8_pin_8), 
  k_ra8_board_eth_pin_rxd3 =
    (uint16_t)RA8_PIN(k_ra8_port_9, k_ra8_pin_9), 
  k_ra8_board_eth_pin_rx_ctl =
    (uint16_t)RA8_PIN(k_ra8_port_2, k_ra8_pin_6), 
  k_ra8_board_eth_pin_rx_clk =
    (uint16_t)RA8_PIN(k_ra8_port_9, k_ra8_pin_5), 
  k_ra8_board_eth_pin_rstn =
    (uint16_t)RA8_PIN(k_ra8_port_7, k_ra8_pin_8), 
} ra8_board_eth_pin_t;

typedef enum : uint8_t {
  k_ra8_board_eth_etha_port = 1U, 
  k_ra8_board_eth_rmac_port = 1U, 
  k_ra8_board_eth_phy_addr  = 0U, 
} ra8_board_eth_index_t;

RA8_NODISCARD ra8_err_t ra8_board_ethernet_init(void);
 
#ifdef __cplusplus
}
#endif