neorv32_sdi.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32_sdi.h - Serial Data Interface Controller (SDI) HW Driver >>               #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2024, 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_sdi_h
#define neorv32_sdi_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_FIFO_LSB     =  4, 
  SDI_CTRL_FIFO_MSB     =  7, 
  SDI_CTRL_IRQ_RX_AVAIL = 15, 
  SDI_CTRL_IRQ_RX_HALF  = 16, 
  SDI_CTRL_IRQ_RX_FULL  = 17, 
  SDI_CTRL_IRQ_TX_EMPTY = 18, 
  SDI_CTRL_IRQ_TX_NHALF = 19, 
  SDI_CTRL_RX_AVAIL     = 23, 
  SDI_CTRL_RX_HALF      = 24, 
  SDI_CTRL_RX_FULL      = 25, 
  SDI_CTRL_TX_EMPTY     = 26, 
  SDI_CTRL_TX_NHALF     = 27, 
  SDI_CTRL_TX_FULL      = 28  
};
/**********************************************************************/
int     neorv32_sdi_available(void);
void    neorv32_sdi_setup(uint32_t irq_mask);
void    neorv32_sdi_rx_clear(void);
void    neorv32_sdi_disable(void);
void    neorv32_sdi_enable(void);
int     neorv32_sdi_get_fifo_depth(void);
int     neorv32_sdi_put(uint8_t data);
void    neorv32_sdi_put_nonblocking(uint8_t data);
int     neorv32_sdi_get(uint8_t* data);
uint8_t neorv32_sdi_get_nonblocking(void);
#endif // neorv32_sdi_h