spi.h

#pragma once
 
/************************************************************************************************
 * @file   spi.h
 *
 * @brief  SPI Library Header file
 *
 * @date   2024-11-02
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stddef.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "gpio.h"
#include "status.h"
 
#define SPI_TIMEOUT_MS 100U
#define SPI_MAX_NUM_DATA 32U
 
typedef enum {
  SPI_PORT_1 = 0, 
  SPI_PORT_2,     
  SPI_PORT_3,     
  NUM_SPI_PORTS,  
} SpiPort;
 
typedef enum {
  SPI_BAUDRATE_312_5KHZ = 0, 
  SPI_BAUDRATE_625KHZ,       
  SPI_BAUDRATE_1_25MHZ,      
  SPI_BAUDRATE_2_5MHZ,       
  SPI_BAUDRATE_5MHZ,         
  SPI_BAUDRATE_10MHZ,        
  SPI_BAUDRATE_20MHZ,        
  SPI_BAUDRATE_40MHZ,        
  NUM_SPI_BAUDRATE           
} SpiBaudrate;
 
typedef enum {
  SPI_MODE_0 = 0, 
  SPI_MODE_1,     
  SPI_MODE_2,     
  SPI_MODE_3,     
  NUM_SPI_MODES,  
} SpiMode;
 
typedef struct {
  SpiBaudrate baudrate;
  SpiMode mode;
  GpioAddress sdo;
  GpioAddress sdi;
  GpioAddress sclk;
  GpioAddress cs;
} SpiSettings;
 
StatusCode spi_init(SpiPort spi, const SpiSettings *settings);
 
StatusCode spi_exchange(SpiPort spi, uint8_t *tx_data, size_t tx_len, uint8_t *rx_data, size_t rx_len);
 
#define spi_tx(spi, tx_data, tx_len) spi_exchange(spi, tx_data, tx_len, NULL, 0U)
 
#define spi_rx(spi, rx_data, rx_len) spi_exchange(spi, NULL, 0U, rx_data, rx_len)
 
#ifdef MS_PLATFORM_X86
 
StatusCode spi_get_tx_data(SpiPort spi, uint8_t *data, uint8_t len);
 
StatusCode spi_set_rx(SpiPort spi, uint8_t *data, uint8_t len);
 
#endif