ra8_spi.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_dma.h"
#include "ra8_err.h"
 
/* =============================================================================
 * Types
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_spi_mode_0 = 0U, 
  k_ra8_spi_mode_1 = 1U, 
  k_ra8_spi_mode_2 = 2U, 
  k_ra8_spi_mode_3 = 3U, 
} ra8_spi_mode_t;

typedef enum : uint8_t {
  k_ra8_spi_width_8  = 7U,  
  k_ra8_spi_width_16 = 15U, 
  k_ra8_spi_width_32 = 31U, 
} ra8_spi_bit_width_t;

typedef struct {
  uint32_t       baud_hz;   
  uint32_t       pclka_hz;  
  ra8_spi_mode_t mode;      
  bool           lsb_first; 
  bool           loopback;  
} ra8_spi_cfg_t;

typedef enum : uint8_t {
  k_ra8_spi_err_none     = 0x00U, 
  k_ra8_spi_err_overrun  = 0x01U, 
  k_ra8_spi_err_mode     = 0x02U, 
  k_ra8_spi_err_parity   = 0x04U, 
  k_ra8_spi_err_underrun = 0x08U, 
} ra8_spi_err_mask_t;

typedef void (*ra8_spi_complete_fn_t)(void* ctx, uint8_t err_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_init(uint8_t channel, const ra8_spi_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_spi_deinit(uint8_t channel);
 
/* =============================================================================
 * Legacy polling API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_controller_init(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_spi_xfer8(uint8_t channel, uint8_t tx, uint8_t* rx);
 
/* =============================================================================
 * Multi-byte / multi-width polling transfers (FSP r_spi_b parity)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_spi_write(uint8_t channel, const void* tx, uint32_t len, ra8_spi_bit_width_t bit_width);

[[nodiscard]] ra8_err_t
ra8_spi_read(uint8_t channel, void* rx, uint32_t len, ra8_spi_bit_width_t bit_width);

[[nodiscard]] ra8_err_t ra8_spi_write_read(uint8_t             channel,
                                           const void*         tx,
                                           void*               rx,
                                           uint32_t            len,
                                           ra8_spi_bit_width_t bit_width);
 
/* =============================================================================
 * Runtime reconfigure
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_set_clock(uint8_t channel, uint32_t baud_hz, uint32_t pclka_hz);
 
/* =============================================================================
 * Error status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_get_errors(uint8_t channel, uint8_t* out_mask);

[[nodiscard]] ra8_err_t ra8_spi_clear_errors(uint8_t channel);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_spi_attach_transfer_handler(uint8_t channel, ra8_spi_complete_fn_t fn, void* ctx);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_enter_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_spi_exit_stop(uint8_t channel);
 
/* =============================================================================
 * Target (peripheral) mode -- SPI_B as an SPI peripheral
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_b_target_init(uint8_t channel, const ra8_spi_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_spi_b_target_xfer(uint8_t channel, uint8_t tx, uint8_t* rx);
 
/* =============================================================================
 * DMA TX / RX
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_spi_write_dma(uint8_t               channel,
                                          const uint8_t*        data,
                                          uint16_t              len,
                                          ra8_dma_complete_fn_t on_complete,
                                          void*                 ctx,
                                          uint8_t*              out_dma_channel);

[[nodiscard]] ra8_err_t ra8_spi_read_dma(uint8_t               channel,
                                         uint8_t*              out_buf,
                                         uint16_t              len,
                                         ra8_dma_complete_fn_t on_complete,
                                         void*                 ctx,
                                         uint8_t*              out_dma_channel);
 
/* =============================================================================
 * ISR dispatch
 * =============================================================================
 */

void ra8_spi_dispatch_spti(uint8_t channel);

void ra8_spi_dispatch_spri(uint8_t channel);

void ra8_spi_dispatch_spei(uint8_t channel);
 
#ifdef __cplusplus
}
#endif