neorv32_xip.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 - 2024 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //
 
#ifndef neorv32_xip_h
#define neorv32_xip_h
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;           
  const uint32_t reserved; 
  uint32_t DATA_LO;        
  uint32_t DATA_HI;        
} neorv32_xip_t;
 
#define NEORV32_XIP ((neorv32_xip_t*) (NEORV32_XIP_BASE))
 
enum NEORV32_XIP_CTRL_enum {
  XIP_CTRL_EN             =  0, 
  XIP_CTRL_PRSC0          =  1, 
  XIP_CTRL_PRSC1          =  2, 
  XIP_CTRL_PRSC2          =  3, 
  XIP_CTRL_CPOL           =  4, 
  XIP_CTRL_CPHA           =  5, 
  XIP_CTRL_SPI_NBYTES_LSB =  6, 
  XIP_CTRL_SPI_NBYTES_MSB =  9, 
  XIP_CTRL_XIP_EN         = 10, 
  XIP_CTRL_XIP_ABYTES_LSB = 11, 
  XIP_CTRL_XIP_ABYTES_MSB = 12, 
  XIP_CTRL_RD_CMD_LSB     = 13, 
  XIP_CTRL_RD_CMD_MSB     = 20, 
  XIP_CTRL_SPI_CSEN       = 21, 
  XIP_CTRL_HIGHSPEED      = 22, 
  XIP_CTRL_CDIV0          = 23, 
  XIP_CTRL_CDIV1          = 24, 
  XIP_CTRL_CDIV2          = 25, 
  XIP_CTRL_CDIV3          = 26, 
  XIP_CTRL_BURST_EN       = 29, 
  XIP_CTRL_PHY_BUSY       = 30, 
  XIP_CTRL_XIP_BUSY       = 31  
};
/**********************************************************************/
int  neorv32_xip_available(void);
void neorv32_xip_setup(int prsc, int cdiv, int cpol, int cpha, uint8_t rd_cmd);
int  neorv32_xip_start(int abytes);
void neorv32_xip_highspeed_enable(void);
void neorv32_xip_highspeed_disable(void);
uint32_t neorv32_xip_get_clock_speed(void);
void neorv32_xip_spi_trans(int nbytes, uint64_t *rtx_data);
#endif // neorv32_xip_h