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) 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 <neorv32.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_EMPTY      =  8, 
  SLINK_CTRL_RX_FULL       =  9, 
  SLINK_CTRL_TX_EMPTY      = 10, 
  SLINK_CTRL_TX_FULL       = 11, 
  SLINK_CTRL_RX_LAST       = 12, 
 
  SLINK_CTRL_IRQ_RX_NEMPTY = 16, 
  SLINK_CTRL_IRQ_RX_FULL   = 17, 
  SLINK_CTRL_IRQ_TX_EMPTY  = 18, 
  SLINK_CTRL_IRQ_TX_NFULL  = 19, 
 
  SLINK_CTRL_RX_FIFO_LSB   = 24, 
  SLINK_CTRL_RX_FIFO_MSB   = 27, 
  SLINK_CTRL_TX_FIFO_LSB   = 28, 
  SLINK_CTRL_TX_FIFO_MSB   = 31  
};

 
/**********************************************************************/
int  neorv32_slink_available(void);
void neorv32_slink_setup(uint32_t irq_mask);
int  neorv32_slink_get_rx_fifo_depth(void);
int  neorv32_slink_get_tx_fifo_depth(void);
int  neorv32_slink_rx_empty(void);
int  neorv32_slink_rx_full(void);
int  neorv32_slink_tx_empty(void);
int  neorv32_slink_tx_full(void);
 
/**********************************************************************/
static inline uint32_t __attribute__((always_inline)) neorv32_slink_get(void) {
  return NEORV32_SLINK->DATA;
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_check_last(void) {
  return (int)(NEORV32_SLINK->CTRL & (1U << SLINK_CTRL_RX_LAST));
}
 
/**********************************************************************/
static inline void __attribute__((always_inline)) neorv32_slink_set_dst(uint32_t dst) {
  NEORV32_SLINK->ROUTE = dst;
}
 
/**********************************************************************/
static inline uint32_t __attribute__((always_inline)) neorv32_slink_get_src(void) {
  return NEORV32_SLINK->ROUTE;
}
 
/**********************************************************************/
static inline void __attribute__((always_inline)) neorv32_slink_put(uint32_t tx_data) {
  NEORV32_SLINK->DATA = tx_data;
}
 
/**********************************************************************/
static inline void __attribute__((always_inline)) neorv32_slink_put_last(uint32_t tx_data) {
  NEORV32_SLINK->DATA_LAST = tx_data;
}
 
#endif // NEORV32_SLINK_H