neorv32_xip.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32_xip.h - Execute In Place (XIP) Module HW Driver (Header) >>               #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2023, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
// #    conditions and the following disclaimer in the documentation and/or other materials        #
// #    provided with the distribution.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************/
#ifndef neorv32_xip_h
#define neorv32_xip_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_PAGE_LSB       = 21, 
  XIP_CTRL_PAGE_MSB       = 24, 
  XIP_CTRL_SPI_CSEN       = 25, 
  XIP_CTRL_HIGHSPEED      = 26, 
  XIP_CTRL_BURST_EN       = 27, 
  XIP_CTRL_PHY_BUSY       = 30, 
  XIP_CTRL_XIP_BUSY       = 31  
};
/**********************************************************************/
int  neorv32_xip_available(void);
int  neorv32_xip_setup(uint8_t prsc, uint8_t cpol, uint8_t cpha, uint8_t rd_cmd);
int  neorv32_xip_start(uint8_t abytes, uint32_t page_base);
void neorv32_xip_highspeed_enable(void);
void neorv32_xip_highspeed_disable(void);
void neorv32_xip_burst_mode_enable(void);
void neorv32_xip_burst_mode_disable(void);
int  neorv32_xip_spi_trans(uint8_t nbytes, uint64_t *rtx_data);
#endif // neorv32_xip_h