neorv32_sdi.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 - 2026 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //

 
#ifndef NEORV32_SDI_H
#define NEORV32_SDI_H
 
#include <neorv32.h>
#include <stdint.h>
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t CTRL; 
  uint32_t DATA; 
} neorv32_sdi_t;

#define NEORV32_SDI ((neorv32_sdi_t*) (NEORV32_SDI_BASE))

enum NEORV32_SDI_CTRL_enum {
  SDI_CTRL_EN            =  0, 
  SDI_CTRL_CLR_RX        =  1, 
  SDI_CTRL_CLR_TX        =  2, 
 
  SDI_CTRL_FIFO_LSB      =  4, 
  SDI_CTRL_FIFO_MSB      =  7, 
 
  SDI_CTRL_IRQ_RX_NEMPTY = 16, 
  SDI_CTRL_IRQ_RX_FULL   = 17, 
  SDI_CTRL_IRQ_TX_EMPTY  = 18, 
 
  SDI_CTRL_RX_EMPTY      = 24, 
  SDI_CTRL_RX_FULL       = 25, 
  SDI_CTRL_TX_EMPTY      = 26, 
  SDI_CTRL_TX_FULL       = 27, 
 
  SDI_CTRL_CS_ACTIVE     = 31  
};

 
/**********************************************************************/
int     neorv32_sdi_available(void);
void    neorv32_sdi_setup(uint32_t irq_mask);
void    neorv32_sdi_disable(void);
void    neorv32_sdi_enable(void);
int     neorv32_sdi_get_fifo_depth(void);
void    neorv32_sdi_put(uint8_t data);
uint8_t neorv32_sdi_get(void);
void    neorv32_sdi_put_nonblocking(uint8_t data);
uint8_t neorv32_sdi_get_nonblocking(void);
int     neorv32_sdi_rx_empty(void);
int     neorv32_sdi_rx_full(void);
int     neorv32_sdi_tx_empty(void);
int     neorv32_sdi_tx_full(void);
void    neorv32_sdi_rx_clear(void);
void    neorv32_sdi_tx_clear(void);
int     neorv32_sdi_check_cs(void);
 
#endif // NEORV32_SDI_H