ra8_sci.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_sci_parity_none = 0U, 
  k_ra8_sci_parity_even = 1U, 
  k_ra8_sci_parity_odd  = 2U, 
} ra8_sci_parity_t;

typedef enum : uint8_t {
  k_ra8_sci_stop_1 = 0U, 
  k_ra8_sci_stop_2 = 1U, 
} ra8_sci_stop_bits_t;

typedef enum : uint8_t {
  k_ra8_sci_data_7 = 7U, 
  k_ra8_sci_data_8 = 8U, 
} ra8_sci_data_bits_t;

typedef struct {
  uint32_t            baud;      
  ra8_sci_data_bits_t data_bits; 
  ra8_sci_parity_t    parity;    
  ra8_sci_stop_bits_t stop_bits; 
  uint32_t            pclk_hz;   
} ra8_sci_cfg_t;

typedef enum : uint8_t {
  k_ra8_sci_err_none    = 0x00U, 
  k_ra8_sci_err_overrun = 0x01U, 
  k_ra8_sci_err_framing = 0x02U, 
  k_ra8_sci_err_parity  = 0x04U, 
} ra8_sci_err_mask_t;

typedef void (*ra8_sci_rx_fn_t)(void* ctx, uint8_t byte);

typedef bool (*ra8_sci_tx_fn_t)(void* ctx, uint8_t* byte);

typedef enum : uint8_t {
  k_ra8_sci_dir_tx   = 0x01U, 
  k_ra8_sci_dir_rx   = 0x02U, 
  k_ra8_sci_dir_both = 0x03U, 
} ra8_sci_dir_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_init(uint8_t channel, const ra8_sci_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_sci_deinit(uint8_t channel);
 
/* =============================================================================
 * Polling TX / RX
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_putc_polling(uint8_t channel, uint8_t byte);

[[nodiscard]] ra8_err_t ra8_sci_getc_polling(uint8_t channel, uint8_t* out_byte);

[[nodiscard]] ra8_err_t ra8_sci_write_polling(uint8_t channel, const uint8_t* data, uint32_t len);

[[nodiscard]] ra8_err_t ra8_sci_flush(uint8_t channel);
 
/* =============================================================================
 * Interrupt TX / RX
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_attach_rx_handler(uint8_t channel, ra8_sci_rx_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_sci_attach_tx_handler(uint8_t channel, ra8_sci_tx_fn_t fn, void* ctx);
 
/* =============================================================================
 * Error status
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_sci_clear_errors(uint8_t channel);
 
/* =============================================================================
 * Runtime reconfigure
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_set_baud(uint8_t channel, uint32_t baud, uint32_t pclk_hz);
 
/* =============================================================================
 * Power transition
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_sci_exit_stop(uint8_t channel);
 
/* =============================================================================
 * Async byte-stream TX / RX (FSP r_sci_b_uart Read/Write parity)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_write(uint8_t channel, const uint8_t* data, uint32_t len);

[[nodiscard]] ra8_err_t ra8_sci_read(uint8_t channel, uint8_t* buf, uint32_t len);

[[nodiscard]] ra8_err_t ra8_sci_abort(uint8_t channel, ra8_sci_dir_t direction);

[[nodiscard]] ra8_err_t ra8_sci_read_stop(uint8_t channel, uint32_t* remaining);

[[nodiscard]] ra8_err_t
ra8_sci_baud_calculate(uint32_t baud, uint32_t pclk_hz, uint16_t* brr_out, uint8_t* clk_div_out);

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

[[nodiscard]] ra8_err_t ra8_sci_receive_resume(uint8_t channel);
 
/* =============================================================================
 * DMA TX / RX
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sci_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_sci_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 entry points (called from ra8_sci_irq.c)
 * =============================================================================
 */

void ra8_sci_dispatch_txi(uint8_t channel);

void ra8_sci_dispatch_rxi(uint8_t channel);

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