Software APIs
spi_host.c
Go to the documentation of this file.
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// Device table API auto-generated by `dtgen`
6
7/**
8 * @file
9 * @brief Device Tables (DT) for IP spi_host and top earlgrey.
10 */
11
12#include "hw/top/dt/spi_host.h"
13
14
15
16/**
17 * Description of instances.
18 */
19typedef struct dt_desc_spi_host {
20 dt_instance_id_t inst_id; /**< Instance ID */
21 uint32_t reg_addr[kDtSpiHostRegBlockCount]; /**< Base address of each register block */
22 /**
23 * PLIC ID of the first IRQ of this instance
24 *
25 * This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
26 */
28 /**
29 * Alert ID of the first Alert of this instance.
30 *
31 * This value is undefined if the block is not connected to the Alert Handler.
32 */
34 dt_clock_t clock[kDtSpiHostClockCount]; /**< Clock signal connected to each clock port */
35 dt_reset_t reset[kDtSpiHostResetCount]; /**< Reset signal connected to each reset port */
36 dt_periph_io_t periph_io[kDtSpiHostPeriphIoCount]; /**< Description of each peripheral I/O */
38
39
40
41
42static const dt_desc_spi_host_t spi_host_desc[kDtSpiHostCount] = {
43 [kDtSpiHost0] = {
44 .inst_id = kDtInstanceIdSpiHost0,
45 .reg_addr = {
46 [kDtSpiHostRegBlockCore] = 0x40300000,
47 },
50 .clock = {
52 },
53 .reset = {
55 },
56 .periph_io = {
57 [kDtSpiHostPeriphIoSck] = {
58 .__internal = {
59 .type = kDtPeriphIoTypeDio,
60 .dir = kDtPeriphIoDirOut,
61 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Sck,
62 .outsel_or_dt_pad = kDtPadSpiHost0Sck,
63 },
64 },
65 [kDtSpiHostPeriphIoCsb0] = {
66 .__internal = {
67 .type = kDtPeriphIoTypeDio,
68 .dir = kDtPeriphIoDirOut,
69 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Csb0,
70 .outsel_or_dt_pad = kDtPadSpiHost0Csb0,
71 },
72 },
73 [kDtSpiHostPeriphIoCsb1] = {
74 .__internal = {
75 .type = kDtPeriphIoTypeMio,
76 .dir = kDtPeriphIoDirOut,
77 .periph_input_or_direct_pad = 0,
78 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost0Csb1,
79 },
80 },
81 [kDtSpiHostPeriphIoCsb2] = {
82 .__internal = {
83 .type = kDtPeriphIoTypeMio,
84 .dir = kDtPeriphIoDirOut,
85 .periph_input_or_direct_pad = 0,
86 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost0Csb2,
87 },
88 },
89 [kDtSpiHostPeriphIoSd0] = {
90 .__internal = {
91 .type = kDtPeriphIoTypeDio,
93 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Sd0,
94 .outsel_or_dt_pad = kDtPadSpiHost0Sd0,
95 },
96 },
97 [kDtSpiHostPeriphIoSd1] = {
98 .__internal = {
99 .type = kDtPeriphIoTypeDio,
100 .dir = kDtPeriphIoDirInout,
101 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Sd1,
102 .outsel_or_dt_pad = kDtPadSpiHost0Sd1,
103 },
104 },
105 [kDtSpiHostPeriphIoSd2] = {
106 .__internal = {
107 .type = kDtPeriphIoTypeDio,
108 .dir = kDtPeriphIoDirInout,
109 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Sd2,
110 .outsel_or_dt_pad = kDtPadSpiHost0Sd2,
111 },
112 },
113 [kDtSpiHostPeriphIoSd3] = {
114 .__internal = {
115 .type = kDtPeriphIoTypeDio,
116 .dir = kDtPeriphIoDirInout,
117 .periph_input_or_direct_pad = kTopEarlgreyDirectPadsSpiHost0Sd3,
118 .outsel_or_dt_pad = kDtPadSpiHost0Sd3,
119 },
120 },
121 },
122 },
123 [kDtSpiHost1] = {
124 .inst_id = kDtInstanceIdSpiHost1,
125 .reg_addr = {
126 [kDtSpiHostRegBlockCore] = 0x40310000,
127 },
130 .clock = {
132 },
133 .reset = {
135 },
136 .periph_io = {
137 [kDtSpiHostPeriphIoSck] = {
138 .__internal = {
139 .type = kDtPeriphIoTypeMio,
140 .dir = kDtPeriphIoDirOut,
141 .periph_input_or_direct_pad = 0,
142 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Sck,
143 },
144 },
145 [kDtSpiHostPeriphIoCsb0] = {
146 .__internal = {
147 .type = kDtPeriphIoTypeMio,
148 .dir = kDtPeriphIoDirOut,
149 .periph_input_or_direct_pad = 0,
150 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Csb0,
151 },
152 },
153 [kDtSpiHostPeriphIoCsb1] = {
154 .__internal = {
155 .type = kDtPeriphIoTypeMio,
156 .dir = kDtPeriphIoDirOut,
157 .periph_input_or_direct_pad = 0,
158 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Csb1,
159 },
160 },
161 [kDtSpiHostPeriphIoCsb2] = {
162 .__internal = {
163 .type = kDtPeriphIoTypeMio,
164 .dir = kDtPeriphIoDirOut,
165 .periph_input_or_direct_pad = 0,
166 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Csb2,
167 },
168 },
169 [kDtSpiHostPeriphIoSd0] = {
170 .__internal = {
171 .type = kDtPeriphIoTypeMio,
172 .dir = kDtPeriphIoDirInout,
173 .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInSpiHost1Sd0,
174 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Sd0,
175 },
176 },
177 [kDtSpiHostPeriphIoSd1] = {
178 .__internal = {
179 .type = kDtPeriphIoTypeMio,
180 .dir = kDtPeriphIoDirInout,
181 .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInSpiHost1Sd1,
182 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Sd1,
183 },
184 },
185 [kDtSpiHostPeriphIoSd2] = {
186 .__internal = {
187 .type = kDtPeriphIoTypeMio,
188 .dir = kDtPeriphIoDirInout,
189 .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInSpiHost1Sd2,
190 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Sd2,
191 },
192 },
193 [kDtSpiHostPeriphIoSd3] = {
194 .__internal = {
195 .type = kDtPeriphIoTypeMio,
196 .dir = kDtPeriphIoDirInout,
197 .periph_input_or_direct_pad = kTopEarlgreyPinmuxPeripheralInSpiHost1Sd3,
198 .outsel_or_dt_pad = kTopEarlgreyPinmuxOutselSpiHost1Sd3,
199 },
200 },
201 },
202 },
203};
204
205/**
206 * Return a pointer to the `dt_spi_host_desc_t` structure of the requested
207 * `dt` if it's a valid index. Otherwise, this macro will `return` (i.e. exit
208 * the function) with the provided default value.
209 */
210#define TRY_GET_DT(dt, default) ({ if ((dt) < (dt_spi_host_t)0 || (int)(dt) >= kDtSpiHostCount) return (default); &spi_host_desc[dt]; })
211
213 if (inst_id >= kDtInstanceIdSpiHost0 && inst_id <= kDtInstanceIdSpiHost1) {
214 return (dt_spi_host_t)(inst_id - kDtInstanceIdSpiHost0);
215 }
216 return (dt_spi_host_t)0;
217}
218
223
225 dt_spi_host_t dt,
226 dt_spi_host_reg_block_t reg_block) {
227 // Return a recognizable address in case of wrong argument.
228 return TRY_GET_DT(dt, 0xdeadbeef)->reg_addr[reg_block];
229}
230
232 dt_spi_host_t dt,
233 dt_spi_host_irq_t irq) {
234 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, kDtPlicIrqIdNone)->first_irq;
235 if (first_irq == kDtPlicIrqIdNone) {
236 return kDtPlicIrqIdNone;
237 }
238 return (dt_plic_irq_id_t)((uint32_t)first_irq + (uint32_t)irq);
239}
240
242 dt_spi_host_t dt,
243 dt_plic_irq_id_t irq) {
245 dt_plic_irq_id_t first_irq = TRY_GET_DT(dt, count)->first_irq;
246 if (first_irq == kDtPlicIrqIdNone) {
247 return count;
248 }
249 if (irq < first_irq || irq >= first_irq + (dt_plic_irq_id_t)count) {
250 return count;
251 }
252 return (dt_spi_host_irq_t)(irq - first_irq);
253}
254
255
257 dt_spi_host_t dt,
258 dt_spi_host_alert_t alert) {
259 return (dt_alert_id_t)((uint32_t)spi_host_desc[dt].first_alert + (uint32_t)alert);
260}
261
263 dt_spi_host_t dt,
264 dt_alert_id_t alert) {
266 if (alert < spi_host_desc[dt].first_alert || alert >= spi_host_desc[dt].first_alert + (dt_alert_id_t)count) {
267 return count;
268 }
269 return (dt_spi_host_alert_t)(alert - spi_host_desc[dt].first_alert);
270}
271
272
274 dt_spi_host_t dt,
276 // Return a harmless value in case of wrong argument.
277 return TRY_GET_DT(dt, kDtPeriphIoConstantHighZ)->periph_io[sig];
278}
279
281 dt_spi_host_t dt,
283 // Return the first clock in case of invalid argument.
284 return TRY_GET_DT(dt, (dt_clock_t)0)->clock[clk];
285}
286
288 dt_spi_host_t dt,
291 if (rst >= count) {
292 return kDtResetUnknown;
293 }
294 return TRY_GET_DT(dt, kDtResetUnknown)->reset[rst];
295}
296
297