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;       
  const uint32_t _res; 
  uint32_t DATA;       
  uint32_t DATA2;      
} neorv32_slink_t;

#define NEORV32_SLINK ((neorv32_slink_t*) (NEORV32_SLINK_BASE))

enum NEORV32_SLINK_CTRL_enum {
  SLINK_CTRL_RX_EN       =  0, 
  SLINK_CTRL_TX_EN       =  1, 
 
  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_RX_IRQ_SEL0 = 16, 
  SLINK_CTRL_RX_IRQ_SEL1 = 17, 
  SLINK_CTRL_TX_IRQ_SEL0 = 18, 
  SLINK_CTRL_TX_IRQ_SEL1 = 19, 
  SLINK_CTRL_RX_IRQ_PEND = 20, 
  SLINK_CTRL_TX_IRQ_PEND = 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_RX_IRQ_enum {
  SLINK_RX_IRQ_NONE  = 0, 
  SLINK_RX_IRQ_AVAIL = 1, 
  SLINK_RX_IRQ_HALF  = 2, 
  SLINK_RX_IRQ_FULL  = 3  
};

enum NEORV32_SLINK_TX_IRQ_enum {
  SLINK_TX_IRQ_NONE  = 0, 
  SLINK_TX_IRQ_EMPTY = 1, 
  SLINK_TX_IRQ_NHALF = 2, 
  SLINK_TX_IRQ_FREE  = 3  
};

 
/**********************************************************************/
int  neorv32_slink_available(void);
void neorv32_slink_setup(int rx_irq_sel, int tx_irq_sel);
int  neorv32_slink_get_rx_fifo_depth(void);
int  neorv32_slink_get_tx_fifo_depth(void);
 
/**********************************************************************/
static inline uint32_t __attribute__((always_inline)) neorv32_slink_rx_get(void) {
  return NEORV32_SLINK->DATA;
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_rx_last(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_RX_LAST) & 1U);
}
 
/**********************************************************************/
static inline void __attribute__((always_inline)) neorv32_slink_tx_put(uint32_t tx_data) {
  NEORV32_SLINK->DATA = tx_data;
}
 
/**********************************************************************/
static inline void __attribute__((always_inline)) neorv32_slink_tx_put_last(uint32_t tx_data) {
  NEORV32_SLINK->DATA2 = tx_data;
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_rx_empty(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_RX_EMPTY) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_rx_half(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_RX_HALF) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_rx_full(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_RX_FULL) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_tx_empty(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_TX_EMPTY) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_tx_half(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_TX_HALF) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_tx_full(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_TX_FULL) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_rx_irq_pending(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_RX_IRQ_PEND) & 1U);
}
 
/**********************************************************************/
static inline int __attribute__((always_inline)) neorv32_slink_tx_irq_pending(void) {
  return (int)((NEORV32_SLINK->CTRL >> SLINK_CTRL_TX_IRQ_PEND) & 1U);
}
 
#endif // NEORV32_SLINK_H