Software APIs
spi_host_testutils.c
1// Copyright lowRISC contributors (OpenTitan project).
2// Licensed under the Apache License, Version 2.0, see LICENSE for details.
3// SPDX-License-Identifier: Apache-2.0
4
5#include "sw/device/lib/testing/spi_host_testutils.h"
6
8#include "sw/device/lib/testing/pinmux_testutils.h"
9#include "sw/device/lib/testing/test_framework/check.h"
10
11status_t spi_host_testutils_configure_host0_pad_attrs(dif_pinmux_t *pinmux) {
12 // Set fast slew rate and strong drive strength for the dedicated SPI host0
13 // pads.
14 dif_pinmux_pad_attr_t out_attr;
15 dif_pinmux_pad_attr_t in_attr = {
16 .slew_rate = 1,
17 .drive_strength = 3,
18 // Set weak pull-ups for all the pads.
19 .flags = kDifPinmuxPadAttrPullResistorEnable |
20 kDifPinmuxPadAttrPullResistorUp};
21 dif_result_t res;
22 for (uint32_t i = 0; i < kDtSpiHostPeriphIoCount; ++i) {
23 dt_periph_io_t periph_io =
25 // Some chip select lines of SPI host0 may be muxed instead of dedicated.
26 if (dt_periph_io_type(periph_io) != kDtPeriphIoTypeDio) {
27 continue;
28 }
29 dt_pad_t pad = dt_periph_io_dio_pad(periph_io);
30 res = dif_pinmux_pad_write_attrs_dt(pinmux, pad, in_attr, &out_attr);
31 if (res == kDifError) {
32 // Some target platforms may not support the specified value for slew rate
33 // and drive strength. If that's the case, use the values actually
34 // supported.
35 if (out_attr.slew_rate != in_attr.slew_rate) {
37 "Specified slew rate not supported, trying supported slew rate");
38 in_attr.slew_rate = out_attr.slew_rate;
39 }
40 if (out_attr.drive_strength != in_attr.drive_strength) {
42 "Specified drive strength not supported, trying supported drive "
43 "strength");
44 in_attr.drive_strength = out_attr.drive_strength;
45 }
46 CHECK_DIF_OK(
47 dif_pinmux_pad_write_attrs_dt(pinmux, pad, in_attr, &out_attr));
48 // Note: fallthrough with the modified `in_attr` so that the same
49 // attributes are used for all pads.
50 }
51 }
52 return OK_STATUS();
53}
54
55// `extern` declarations to give the inline functions in the
56// corresponding header a link location.
57extern status_t spi_host_testutils_is_active(dif_spi_host_t *spi_host);
58
59status_t spi_host_testutils_flush(dif_spi_host_t *spi_host) {
60 dif_spi_host_status_t status;
61 uint8_t dummy[sizeof(uint32_t)];
62 TRY(dif_spi_host_get_status(spi_host, &status));
63 while (!status.rx_empty) {
64 TRY(dif_spi_host_fifo_read(spi_host, &dummy, sizeof(dummy)));
65 TRY(dif_spi_host_get_status(spi_host, &status));
66 }
67 return OK_STATUS();
68}
69
70#if defined(OPENTITAN_IS_EARLGREY)
71/**
72 * Define a spi pinmux configuration.
73 */
74typedef struct spi_host1_pinmux_pads {
75 dt_pad_t clk;
76 dt_pad_t sd0;
77 dt_pad_t sd1;
78 dt_pad_t sd2;
79 dt_pad_t sd3;
80} spi_host1_pinmux_pads_t;
81
82/**
83 * This table stores spi host 1 pin mappings of different platforms.
84 * This is used to connect spi host 1 to mio pins based on the platform.
85 */
86static const spi_host1_pinmux_pads_t kSpiHost1PinmuxMap[] = {
87 [kSpiPinmuxPlatformIdCw310] =
88 {
89 .clk = kDtPadIoa3,
90 .sd0 = kDtPadIoa5,
91 .sd1 = kDtPadIoa4,
92 .sd2 = kDtPadIoa8,
93 .sd3 = kDtPadIoa7,
94 },
95 [kSpiPinmuxPlatformIdCw340] =
96 {
97 .clk = kDtPadIoa3,
98 .sd0 = kDtPadIoa5,
99 .sd1 = kDtPadIoa4,
100 .sd2 = kDtPadIoa8,
101 .sd3 = kDtPadIoa7,
102 },
103 [kSpiPinmuxPlatformIdTeacup] =
104 {
105 .clk = kDtPadIoa3,
106 .sd0 = kDtPadIoa4,
107 .sd1 = kDtPadIoa5,
108 .sd2 = kDtPadIoa8,
109 .sd3 = kDtPadIoa7,
110 },
111};
112
113status_t spi_host1_pinmux_connect_to_bob(const dif_pinmux_t *pinmux,
114 dt_pad_t csb_outsel,
115 spi_pinmux_platform_id_t platform_id) {
116 TRY_CHECK(platform_id < kSpiPinmuxPlatformIdCount);
117 const spi_host1_pinmux_pads_t *platform = &kSpiHost1PinmuxMap[platform_id];
118
119 // CSB.
120 dt_periph_io_t csb =
121 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoCsb0);
122 TRY(dif_pinmux_mio_select_output(pinmux, csb_outsel, csb));
123 // SCK.
124 dt_periph_io_t sck =
125 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoSck);
126 TRY(dif_pinmux_mio_select_output(pinmux, platform->clk, sck));
127 // SD0.
128 dt_periph_io_t sd0 =
129 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoSd0);
130 TRY(dif_pinmux_mio_select_input(pinmux, sd0, platform->sd0));
131 TRY(dif_pinmux_mio_select_output(pinmux, platform->sd0, sd0));
132 // SD1.
133 dt_periph_io_t sd1 =
134 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoSd1);
135 TRY(dif_pinmux_mio_select_input(pinmux, sd1, platform->sd1));
136 TRY(dif_pinmux_mio_select_output(pinmux, platform->sd1, sd1));
137 // SD2.
138 dt_periph_io_t sd2 =
139 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoSd2);
140 TRY(dif_pinmux_mio_select_input(pinmux, sd2, platform->sd2));
141 TRY(dif_pinmux_mio_select_output(pinmux, platform->sd2, sd2));
142 // SD3.
143 dt_periph_io_t sd3 =
144 dt_spi_host_periph_io(kDtSpiHost1, kDtSpiHostPeriphIoSd3);
145 TRY(dif_pinmux_mio_select_input(pinmux, sd3, platform->sd3));
146 TRY(dif_pinmux_mio_select_output(pinmux, platform->sd3, sd3));
147 return OK_STATUS();
148}
149#elif defined(OPENTITAN_IS_DARJEELING)
150// Darjeeling only has a single SPI host
151#else
152#error "spi_host_testutils does not support this top"
153#endif