[sw] SPI host loopback smoketest

Author: marnovandermaas

sw/device/lib/hal/CMakeLists.txt

@@ -2,6 +2,6 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
-set(SRCS clkmgr.c gpio.c i2c.c mailbox.c mocha.c plic.c rstmgr.c spi_device.c timer.c uart.c)
+set(SRCS clkmgr.c gpio.c i2c.c mailbox.c mocha.c plic.c rstmgr.c spi_device.c spi_host.c timer.c uart.c)
 
 mocha_add_library(NAME hal LIBRARIES SOURCES ${SRCS})

sw/device/lib/hal/mocha.c

@@ -20,6 +20,7 @@ static const uintptr_t uart_base = 0x41000000ul;
 static const uintptr_t i2c_base = 0x42000000ul;
 static const uintptr_t spi_device_base = 0x43000000ul;
 static const uintptr_t timer_base = 0x44000000ul;
+static const uintptr_t spi_host_base = 0x45000000ul;
 static const uintptr_t plic_base = 0x48000000ul;
 
 #if defined(__riscv_zcherihybrid)
@@ -114,6 +115,15 @@ timer_t mocha_system_timer(void)
 #endif /* defined(__riscv_zcherihybrid) */
 }
 
+spi_host_t mocha_system_spi_host(void)
+{
+#if defined(__riscv_zcherihybrid)
+    return (spi_host_t)create_mmio_capability(spi_host_base, 0x38u);
+#else /* !defined(__riscv_zcherihybrid) */
+    return (spi_host_t)spi_host_base;
+#endif /* defined(__riscv_zcherihybrid) */
+}
+
 plic_t mocha_system_plic(void)
 {
 #if defined(__riscv_zcherihybrid)

sw/device/lib/hal/mocha.h

@@ -13,6 +13,7 @@
 #include "hal/plic.h"
 #include "hal/rstmgr.h"
 #include "hal/spi_device.h"
+#include "hal/spi_host.h"
 #include "hal/timer.h"
 #include "hal/uart.h"
 
@@ -37,6 +38,7 @@ uart_t mocha_system_uart(void);
 i2c_t mocha_system_i2c(void);
 spi_device_t mocha_system_spi_device(void);
 timer_t mocha_system_timer(void);
+spi_host_t mocha_system_spi_host(void);
 plic_t mocha_system_plic(void);
 void *mocha_system_dram(void);
 

sw/device/lib/hal/spi_host.c

@@ -0,0 +1,27 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "hal/spi_host.h"
+#include "hal/mmio.h"
+#include <stdbool.h>
+#include <stdint.h>
+
+void spi_host_init(spi_host_t spi_host)
+{
+    DEV_WRITE(spi_host + SPI_HOST_CONTROL_REG,
+              SPI_HOST_CONTROL_SPIEN_MASK | SPI_HOST_CONTROL_OUTPUTEN_MASK);
+}
+
+void spi_host_write(spi_host_t spi_host, uint32_t data)
+{
+    DEV_WRITE(spi_host + SPI_HOST_TXDATA_REG, data);
+    DEV_WRITE(spi_host + SPI_HOST_COMMAND_REG,
+              SPI_HOST_COMMAND_DIRECTION_BIDIRECTIONAL |
+                  ((3 << SPI_HOST_COMMAND_LEN_OFF) & SPI_HOST_COMMAND_LEN_MASK));
+}
+
+uint32_t spi_host_read(spi_host_t spi_host)
+{
+    return DEV_READ(spi_host + SPI_HOST_RXDATA_REG);
+}

sw/device/lib/hal/spi_host.h

@@ -0,0 +1,34 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "hal/mmio.h"
+#include <stdbool.h>
+#include <stdint.h>
+
+#define SPI_HOST_INTR_STATE_REG                  (0x0)
+#define SPI_HOST_INTR_ENABLE_REG                 (0x4)
+#define SPI_HOST_INTR_TEST_REG                   (0x8)
+#define SPI_HOST_CONTROL_REG                     (0x10)
+#define SPI_HOST_CONTROL_SPIEN_MASK              (1u << 31)
+#define SPI_HOST_CONTROL_OUTPUTEN_MASK           (1u << 29)
+#define SPI_HOST_STATUS_REG                      (0x14)
+#define SPI_HOST_CONFIGOPTS_REG                  (0x18)
+#define SPI_HOST_CSID_REG                        (0x1C)
+#define SPI_HOST_COMMAND_REG                     (0x20)
+#define SPI_HOST_COMMAND_DIRECTION_OFFSET        (3)
+#define SPI_HOST_COMMAND_DIRECTION_RECEIVE       (1 << SPI_HOST_COMMAND_DIRECTION_OFFSET)
+#define SPI_HOST_COMMAND_DIRECTION_TRANSMIT      (2 << SPI_HOST_COMMAND_DIRECTION_OFFSET)
+#define SPI_HOST_COMMAND_DIRECTION_BIDIRECTIONAL (3 << SPI_HOST_COMMAND_DIRECTION_OFFSET)
+#define SPI_HOST_COMMAND_LEN_OFF                 (5)
+#define SPI_HOST_COMMAND_LEN_MASK                (0xFFFFF << SPI_HOST_COMMAND_LEN_OFF)
+#define SPI_HOST_RXDATA_REG                      (0x24)
+#define SPI_HOST_TXDATA_REG                      (0x28)
+
+typedef void *spi_host_t;
+
+void spi_host_init(spi_host_t spi_host);
+void spi_host_write(spi_host_t spi_host, uint32_t data);
+uint32_t spi_host_read(spi_host_t spi_host);

sw/device/tests/CMakeLists.txt

@@ -13,6 +13,7 @@ mocha_add_test(NAME plic_smoketest SOURCES plic/smoketest.c LIBRARIES ${LIBS} FP
 # Cannot currently run this on FPGA because the boot ROM expects the test to be provided on the SPI again.
 mocha_add_test(NAME rstmgr_software_reset SOURCES rstmgr/software_reset.c LIBRARIES ${LIBS})
 mocha_add_test(NAME spi_device_smoketest SOURCES spi_device/smoketest.c LIBRARIES ${LIBS} FPGA)
+mocha_add_test(NAME spi_host_smoketest SOURCES spi_host/smoketest.c LIBRARIES ${LIBS} FPGA)
 mocha_add_test(NAME tag_controller_smoketest SOURCES tag_controller/smoketest.c LIBRARIES ${LIBS} FPGA)
 mocha_add_test(NAME tag_controller_tag_test SOURCES tag_controller/tag_test.c LIBRARIES ${LIBS} FPGA)
 mocha_add_test(NAME timer_smoketest SOURCES timer/smoketest.c LIBRARIES ${LIBS} FPGA)

sw/device/tests/spi_host/smoketest.c

@@ -0,0 +1,21 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "hal/mocha.h"
+#include "hal/spi_host.h"
+#include <stdbool.h>
+#include <stdint.h>
+
+bool test_main()
+{
+    uint32_t tx_data = 0xDEADC0DE;
+    uint32_t rx_data;
+    spi_host_t spi_host;
+
+    spi_host = mocha_system_spi_host();
+    spi_host_init(spi_host);
+    spi_host_write(spi_host, tx_data);
+    rx_data = spi_host_read(spi_host);
+    return tx_data == rx_data;
+}