neorv32/sw/example/demo_slink/main.c

207 lines
7.9 KiB
C
Raw Permalink Normal View History

2024-02-24 08:25:27 +00:00
// #################################################################################################
// # << NEORV32 - SLINK Demo Program >> #
// # ********************************************************************************************* #
// # 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 #
// #################################################################################################
/**********************************************************************//**
* @file demo_slink/main.c
* @author Stephan Nolting
* @brief SLINK demo program.
**************************************************************************/
#include <neorv32.h>
#include <string.h>
/**********************************************************************//**
* @name User configuration
**************************************************************************/
/**@{*/
/** UART BAUD rate */
#define BAUD_RATE 19200
/**@}*/
// Prototypes
void slink_firq_handler(void);
uint32_t xorshift32(void);
/**********************************************************************//**
* Simple SLINK demo program.
*
* @note This program requires the UART0 and the SLINK to be synthesized.
*
* @return =! 0 if execution failed.
**************************************************************************/
int main() {
int i, slink_rc;
uint32_t slink_data;
// capture all exceptions and give debug info via UART0
neorv32_rte_setup();
// setup UART at default baud rate, no interrupts
neorv32_uart0_setup(BAUD_RATE, 0);
// check if UART0 unit is implemented at all
if (neorv32_uart0_available() == 0) {
return -1; // abort if not implemented
}
// intro
neorv32_uart0_printf("\n<<< SLINK Demo Program >>>\n\n");
// check if SLINK is implemented at all
if (neorv32_slink_available() == 0) {
neorv32_uart0_printf("ERROR! SLINK module not implemented.");
return -1;
}
// show SLINK FIFO configuration
int rx_depth = neorv32_slink_get_rx_fifo_depth();
int tx_depth = neorv32_slink_get_tx_fifo_depth();
neorv32_uart0_printf("RX FIFO depth: %u\n"
"TX FIFO depth: %u\n\n",
rx_depth, tx_depth);
// setup SLINK module
neorv32_slink_setup(0);
// TX demo
neorv32_uart0_printf("-------- TX Demo --------\n");
for (i=0; i<(rx_depth+tx_depth); i++) {
slink_data = xorshift32();
neorv32_uart0_printf("[%i] Sending 0x%x... ", i, slink_data);
slink_rc = neorv32_slink_tx_status();
if (slink_rc == SLINK_FIFO_FULL) {
neorv32_uart0_printf("ERROR! TX FIFO full!\n");
break;
}
else {
if (i == ((rx_depth+tx_depth)-1)) { // very last transmission?
neorv32_slink_put_last(slink_data); // set tlast
neorv32_uart0_printf("(last) ");
}
else {
neorv32_slink_put(slink_data);
}
neorv32_uart0_printf("ok\n");
}
}
// RX demo
neorv32_uart0_printf("\n-------- RX Demo --------\n");
for (i=0; i<(rx_depth+tx_depth+1); i++) {
neorv32_uart0_printf("[%i] Reading RX data... ", i);
slink_rc = neorv32_slink_rx_status();
if (slink_rc == SLINK_FIFO_EMPTY) {
neorv32_uart0_printf("ERROR! RX FIFO empty!\n");
break;
}
else {
neorv32_uart0_printf("0x%x", neorv32_slink_get());
if (neorv32_slink_check_last()) {
neorv32_uart0_printf(" (LAST)");
}
neorv32_uart0_printf("\n");
}
}
// IRQ demo
neorv32_uart0_printf("\n------ RX IRQ Demo -------\n");
// reconfigure SLINK module
neorv32_slink_setup(1 << SLINK_CTRL_IRQ_RX_NEMPTY); // interrupt if RX data available
neorv32_slink_rx_clear();
neorv32_slink_tx_clear();
// NEORV32 runtime environment: install SLINK FIRQ handler
neorv32_rte_handler_install(SLINK_RTE_ID, slink_firq_handler);
neorv32_cpu_csr_set(CSR_MIE, 1 << SLINK_FIRQ_ENABLE); // enable SLINK FIRQ
neorv32_cpu_csr_set(CSR_MSTATUS, 1 << CSR_MSTATUS_MIE); // enable machine-mode interrupts
for (i=0; i<4; i++) {
slink_data = xorshift32();
neorv32_uart0_printf("[%i] Sending 0x%x... ", i, slink_data);
slink_rc = neorv32_slink_tx_status();
if (slink_rc == SLINK_FIFO_FULL) {
neorv32_uart0_printf("FAILED! TX FIFO full!\n");
break;
}
else {
neorv32_slink_put(slink_data);
neorv32_uart0_printf("ok\n");
}
}
neorv32_uart0_printf("\nProgram execution completed.\n");
return 0;
}
/**********************************************************************//**
* SLINK interrupt handler.
**************************************************************************/
void slink_firq_handler(void) {
neorv32_uart0_printf(" <<RX data: 0x%x>> ", neorv32_slink_get());
neorv32_cpu_csr_clr(CSR_MIP, 1 << SLINK_FIRQ_PENDING); // ack/clear FIRQ *after* reading RX data
}
/**********************************************************************//**
* Simple pseudo random number generator.
*
* @return Random number.
**************************************************************************/
uint32_t xorshift32(void) {
static uint32_t x32 = 314159265;
x32 ^= x32 << 13;
x32 ^= x32 >> 17;
x32 ^= x32 << 5;
return x32;
}