ra8_nsc_comms.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_i3c.h"
#include "ra8_nsc_veneer.h"
#include "ra8_sci.h"
#include "ra8_spi.h"
#include "ra8_usb.h"
 
/* =============================================================================
 * SCI veneers
 * =============================================================================
 */

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

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_sci_putc(uint8_t channel, uint8_t byte);

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_sci_getc(uint8_t channel, uint8_t* out_byte);
 
/* =============================================================================
 * IIC veneers
 * =============================================================================
 */

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_iic_init(uint8_t channel, const ra8_i3c_cfg_t* cfg);

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_iic_write(uint8_t        channel,
                                                         uint8_t        target_7b,
                                                         const uint8_t* data,
                                                         uint32_t       len);

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_iic_read(uint8_t  channel,
                                                        uint8_t  target_7b,
                                                        uint8_t* out_buf,
                                                        uint32_t len);
 
/* =============================================================================
 * SPI veneers
 * =============================================================================
 */

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

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_spi_xfer8(uint8_t channel, uint8_t tx, uint8_t* rx);

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

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

typedef enum : uint32_t {
  k_ra8_nsc_spi_byte_msk = 0x000000FFU, 
  k_ra8_nsc_spi_bw_shift = 8U,          
} ra8_nsc_spi_pack_const_t;

static inline uint32_t ra8_nsc_spi_ch_bw(uint8_t channel, ra8_spi_bit_width_t bit_width)
{
  return ((uint32_t)channel & (uint32_t)k_ra8_nsc_spi_byte_msk) |
         ((uint32_t)bit_width << (uint32_t)k_ra8_nsc_spi_bw_shift);
}

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_spi_write_read(uint32_t    ch_bw,
                                                              const void* tx,
                                                              void*       rx,
                                                              uint32_t    len);
 
/* =============================================================================
 * USB veneers
 * =============================================================================
 */

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_usb_init(ra8_usb_speed_t speed);

[[nodiscard]] RA8_NSC_VENEER ra8_err_t ra8_nsc_usb_attach(ra8_usb_speed_t speed, bool attached);
 
#ifdef __cplusplus
}
#endif