neorv32_spi.h

Go to the documentation of this file.

// ================================================================================ //
// The NEORV32 RISC-V Processor - https://github.com/stnolting/neorv32              //
// Copyright (c) NEORV32 contributors.                                              //
// Copyright (c) 2020 - 2025 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //

 
#ifndef NEORV32_SPI_H
#define NEORV32_SPI_H
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;  
  uint32_t DATA;  
} neorv32_spi_t;

#define NEORV32_SPI ((neorv32_spi_t*) (NEORV32_SPI_BASE))

enum NEORV32_SPI_CTRL_enum {
  SPI_CTRL_EN           =  0, 
  SPI_CTRL_CPHA         =  1, 
  SPI_CTRL_CPOL         =  2, 
  SPI_CTRL_PRSC0        =  3, 
  SPI_CTRL_PRSC1        =  4, 
  SPI_CTRL_PRSC2        =  5, 
  SPI_CTRL_CDIV0        =  6, 
  SPI_CTRL_CDIV1        =  7, 
  SPI_CTRL_CDIV2        =  8, 
  SPI_CTRL_CDIV3        =  9, 
 
  SPI_CTRL_RX_AVAIL     = 16, 
  SPI_CTRL_TX_EMPTY     = 17, 
  SPI_CTRL_TX_FULL      = 18, 
 
  SPI_CTRL_FIFO_LSB     = 24, 
  SPI_CTRL_FIFO_MSB     = 27, 
 
  SPI_CS_ACTIVE         = 30, 
  SPI_CTRL_BUSY         = 31  
};

enum NEORV32_SPI_DATA_enum {
  SPI_DATA_LSB  =  0, 
  SPI_DATA_CSEN =  3, 
  SPI_DATA_MSB  =  7, 
  SPI_DATA_CMD  = 31  
};

 
 
/**********************************************************************/
int      neorv32_spi_available(void);
void     neorv32_spi_setup(int prsc, int cdiv, int clk_phase, int clk_polarity);
uint32_t neorv32_spi_get_clock_speed(void);
void     neorv32_spi_disable(void);
void     neorv32_spi_enable(void);
int      neorv32_spi_get_fifo_depth(void);
void     neorv32_spi_cs_en(int cs);
void     neorv32_spi_cs_dis(void);
uint8_t  neorv32_spi_transfer(uint8_t tx_data);
void     neorv32_spi_put_nonblocking(uint8_t tx_data);
uint8_t  neorv32_spi_get_nonblocking(void);
void     neorv32_spi_cs_en_nonblocking(int cs);
void     neorv32_spi_cs_dis_nonblocking(void);
int      neorv32_spi_check_cs(void);
int      neorv32_spi_busy(void);
 
#endif // NEORV32_SPI_H