neorv32_slink.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_slink_h
#define neorv32_slink_h
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL;      
  uint32_t ROUTE;     
  uint32_t DATA;      
  uint32_t DATA_LAST; 
} neorv32_slink_t;
 
#define NEORV32_SLINK ((neorv32_slink_t*) (NEORV32_SLINK_BASE))
 
enum NEORV32_SLINK_CTRL_enum {
  SLINK_CTRL_EN            =  0, 
  SLINK_CTRL_RX_CLR        =  1, 
  SLINK_CTRL_TX_CLR        =  2, 
  SLINK_CTRL_RX_LAST       =  4, 
  SLINK_CTRL_RX_EMPTY      =  8, 
  SLINK_CTRL_RX_HALF       =  9, 
  SLINK_CTRL_RX_FULL       = 10, 
  SLINK_CTRL_TX_EMPTY      = 11, 
  SLINK_CTRL_TX_HALF       = 12, 
  SLINK_CTRL_TX_FULL       = 13, 
  SLINK_CTRL_IRQ_RX_NEMPTY = 16, 
  SLINK_CTRL_IRQ_RX_HALF   = 17, 
  SLINK_CTRL_IRQ_RX_FULL   = 18, 
  SLINK_CTRL_IRQ_TX_EMPTY  = 19, 
  SLINK_CTRL_IRQ_TX_NHALF  = 20, 
  SLINK_CTRL_IRQ_TX_NFULL  = 21, 
  SLINK_CTRL_RX_FIFO_LSB   = 24, 
  SLINK_CTRL_RX_FIFO_MSB   = 27, 
  SLINK_CTRL_TX_FIFO_LSB   = 28, 
  SLINK_CTRL_TX_FIFO_MSB   = 31  
};
 
enum NEORV32_SLINK_ROUTE_enum {
  SLINK_ROUTE_DST_LSB = 0, 
  SLINK_ROUTE_DST_MSB = 3, 
  SLINK_ROUTE_SRC_LSB = 4, 
  SLINK_ROUTE_SRC_MSB = 7  
};
 
enum NEORV32_SLINK_STATUS_enum {
  SLINK_FIFO_EMPTY = 0, 
  SLINK_FIFO_HALF  = 1, 
  SLINK_FIFO_FULL  = 2  
};
/**********************************************************************/
int      neorv32_slink_available(void);
void     neorv32_slink_setup(uint32_t rx_irq, uint32_t tx_irq);
void     neorv32_slink_rx_clear(void);
void     neorv32_slink_tx_clear(void);
int      neorv32_slink_get_rx_fifo_depth(void);
int      neorv32_slink_get_tx_fifo_depth(void);
uint32_t neorv32_slink_get(void);
uint32_t neorv32_slink_check_last(void);
void     neorv32_slink_set_dst(uint32_t dst);
uint32_t neorv32_slink_get_src(void);
void     neorv32_slink_put(uint32_t tx_data);
void     neorv32_slink_put_last(uint32_t tx_data);
int      neorv32_slink_rx_status(void);
int      neorv32_slink_tx_status(void);
#endif // neorv32_slink_h