Documentation: Fix sphinx configuration
[coreboot.git] / src / include / reg_script.h
blob59da0cb2edabb4694f53cecc0df28cbba89683a5
1 /* SPDX-License-Identifier: GPL-2.0-only */
3 #ifndef REG_SCRIPT_H
4 #define REG_SCRIPT_H
6 #include <stdint.h>
7 #include <device/device.h>
8 #include <device/pci_type.h>
9 #include <device/resource.h>
12 * The reg script library is a way to provide data-driven I/O accesses for
13 * initializing devices. It currently supports PCI, legacy I/O,
14 * memory-mapped I/O, and IOSF accesses.
16 * In order to simplify things for the developer the following features
17 * are employed:
18 * - Chaining of tables that allow runtime tables to chain to compile-time
19 * tables.
21 * Note that when using REG_SCRIPT_COMMAND_NEXT there is an implicit push
22 * and pop of the context. A chained reg_script inherits the previous
23 * context (such as current device), but it does not impact the previous
24 * context in any way.
27 enum {
28 REG_SCRIPT_COMMAND_READ,
29 REG_SCRIPT_COMMAND_WRITE,
30 REG_SCRIPT_COMMAND_RMW,
31 REG_SCRIPT_COMMAND_RXW,
32 REG_SCRIPT_COMMAND_POLL,
33 REG_SCRIPT_COMMAND_SET_DEV,
34 REG_SCRIPT_COMMAND_NEXT,
35 REG_SCRIPT_COMMAND_DISPLAY,
37 /* Insert new types above this comment */
39 REG_SCRIPT_COMMAND_END,
42 enum {
43 REG_SCRIPT_TYPE_PCI,
44 REG_SCRIPT_TYPE_IO,
45 REG_SCRIPT_TYPE_MMIO,
46 REG_SCRIPT_TYPE_RES,
47 REG_SCRIPT_TYPE_IOSF,
48 REG_SCRIPT_TYPE_MSR,
50 /* Insert other platform independent values above this comment */
52 REG_SCRIPT_TYPE_PLATFORM_BASE = 0x10000,
53 REG_SCRIPT_TYPE_SOC_BASE = REG_SCRIPT_TYPE_PLATFORM_BASE,
54 REG_SCRIPT_TYPE_MAINBOARD_BASE = 0x20000
57 enum {
58 REG_SCRIPT_SIZE_8,
59 REG_SCRIPT_SIZE_16,
60 REG_SCRIPT_SIZE_32,
61 REG_SCRIPT_SIZE_64,
64 struct reg_script {
65 uint32_t command;
66 uint32_t type;
67 uint32_t size;
68 uint32_t reg;
69 uint64_t mask;
70 uint64_t value;
71 uint32_t timeout;
72 union {
73 uint32_t id;
74 const struct reg_script *next;
75 #ifdef __SIMPLE_DEVICE__
76 pci_devfn_t dev;
77 #else
78 struct device *dev;
79 #endif
80 unsigned int res_index;
84 struct reg_script_context {
85 #ifdef __SIMPLE_DEVICE__
86 pci_devfn_t dev;
87 #else
88 struct device *dev;
89 #endif
90 struct resource *res;
91 const struct reg_script *step;
92 uint8_t display_state; /* Only modified by reg_script_run_step */
93 uint8_t display_features; /* Step routine modifies to control display */
94 const char *display_prefix; /* Prefix tag to display */
97 struct reg_script_bus_entry {
98 uint32_t type;
99 uint64_t (*reg_script_read)(struct reg_script_context *ctx);
100 void (*reg_script_write)(struct reg_script_context *ctx);
103 #define REG_SCRIPT_TABLE_ATTRIBUTE __attribute__((used, section(".rsbe_init")))
105 #define REG_SCRIPT_BUS_ENTRY(bus_entry_) \
106 const struct reg_script_bus_entry *rsbe_ ## bus_entry_ \
107 REG_SCRIPT_TABLE_ATTRIBUTE = &bus_entry_;
109 /* Internal helper Macros. */
111 #define _REG_SCRIPT_ENCODE_RAW(cmd_, type_, size_, reg_, \
112 mask_, value_, timeout_, id_) \
113 { .command = cmd_, \
114 .type = type_, \
115 .size = size_, \
116 .reg = reg_, \
117 .mask = mask_, \
118 .value = value_, \
119 .timeout = timeout_, \
120 .id = id_, \
123 #define _REG_SCRIPT_ENCODE_RES(cmd_, type_, res_index_, size_, reg_, \
124 mask_, value_, timeout_) \
125 { .command = cmd_, \
126 .type = type_, \
127 .size = size_, \
128 .reg = reg_, \
129 .mask = mask_, \
130 .value = value_, \
131 .timeout = timeout_, \
132 .res_index = res_index_, \
135 /* Display control */
136 #define REG_SCRIPT_DISPLAY_ALL 0xff
137 #define REG_SCRIPT_DISPLAY_REGISTER 0x02
138 #define REG_SCRIPT_DISPLAY_VALUE 0x01
139 #define REG_SCRIPT_DISPLAY_NOTHING 0
141 #define REG_SCRIPT_DISPLAY_OFF \
142 { .command = REG_SCRIPT_COMMAND_DISPLAY, \
143 .value = REG_SCRIPT_DISPLAY_NOTHING, \
145 #define REG_SCRIPT_DISPLAY_ON \
146 { .command = REG_SCRIPT_COMMAND_DISPLAY, \
147 .value = REG_SCRIPT_DISPLAY_ALL, \
151 * PCI
154 #define REG_SCRIPT_PCI(cmd_, bits_, reg_, mask_, value_, timeout_) \
155 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_##cmd_, \
156 REG_SCRIPT_TYPE_PCI, \
157 REG_SCRIPT_SIZE_##bits_, \
158 reg_, mask_, value_, timeout_, 0)
159 #define REG_PCI_READ8(reg_) \
160 REG_SCRIPT_PCI(READ, 8, reg_, 0, 0, 0)
161 #define REG_PCI_READ16(reg_) \
162 REG_SCRIPT_PCI(READ, 16, reg_, 0, 0, 0)
163 #define REG_PCI_READ32(reg_) \
164 REG_SCRIPT_PCI(READ, 32, reg_, 0, 0, 0)
165 #define REG_PCI_WRITE8(reg_, value_) \
166 REG_SCRIPT_PCI(WRITE, 8, reg_, 0, value_, 0)
167 #define REG_PCI_WRITE16(reg_, value_) \
168 REG_SCRIPT_PCI(WRITE, 16, reg_, 0, value_, 0)
169 #define REG_PCI_WRITE32(reg_, value_) \
170 REG_SCRIPT_PCI(WRITE, 32, reg_, 0, value_, 0)
171 #define REG_PCI_RMW8(reg_, mask_, value_) \
172 REG_SCRIPT_PCI(RMW, 8, reg_, mask_, value_, 0)
173 #define REG_PCI_RMW16(reg_, mask_, value_) \
174 REG_SCRIPT_PCI(RMW, 16, reg_, mask_, value_, 0)
175 #define REG_PCI_RMW32(reg_, mask_, value_) \
176 REG_SCRIPT_PCI(RMW, 32, reg_, mask_, value_, 0)
177 #define REG_PCI_RXW8(reg_, mask_, value_) \
178 REG_SCRIPT_PCI(RXW, 8, reg_, mask_, value_, 0)
179 #define REG_PCI_RXW16(reg_, mask_, value_) \
180 REG_SCRIPT_PCI(RXW, 16, reg_, mask_, value_, 0)
181 #define REG_PCI_RXW32(reg_, mask_, value_) \
182 REG_SCRIPT_PCI(RXW, 32, reg_, mask_, value_, 0)
183 #define REG_PCI_OR8(reg_, value_) \
184 REG_SCRIPT_PCI(RMW, 8, reg_, 0xff, value_, 0)
185 #define REG_PCI_OR16(reg_, value_) \
186 REG_SCRIPT_PCI(RMW, 16, reg_, 0xffff, value_, 0)
187 #define REG_PCI_OR32(reg_, value_) \
188 REG_SCRIPT_PCI(RMW, 32, reg_, 0xffffffff, value_, 0)
189 #define REG_PCI_POLL8(reg_, mask_, value_, timeout_) \
190 REG_SCRIPT_PCI(POLL, 8, reg_, mask_, value_, timeout_)
191 #define REG_PCI_POLL16(reg_, mask_, value_, timeout_) \
192 REG_SCRIPT_PCI(POLL, 16, reg_, mask_, value_, timeout_)
193 #define REG_PCI_POLL32(reg_, mask_, value_, timeout_) \
194 REG_SCRIPT_PCI(POLL, 32, reg_, mask_, value_, timeout_)
195 #define REG_PCI_XOR8(reg_, value_) \
196 REG_SCRIPT_PCI(RXW, 8, reg_, 0xff, value_, 0)
197 #define REG_PCI_XOR16(reg_, value_) \
198 REG_SCRIPT_PCI(RXW, 16, reg_, 0xffff, value_, 0)
199 #define REG_PCI_XOR32(reg_, value_) \
200 REG_SCRIPT_PCI(RXW, 32, reg_, 0xffffffff, value_, 0)
203 * Legacy IO
206 #define REG_SCRIPT_IO(cmd_, bits_, reg_, mask_, value_, timeout_) \
207 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_##cmd_, \
208 REG_SCRIPT_TYPE_IO, \
209 REG_SCRIPT_SIZE_##bits_, \
210 reg_, mask_, value_, timeout_, 0)
211 #define REG_IO_READ8(reg_) \
212 REG_SCRIPT_IO(READ, 8, reg_, 0, 0, 0)
213 #define REG_IO_READ16(reg_) \
214 REG_SCRIPT_IO(READ, 16, reg_, 0, 0, 0)
215 #define REG_IO_READ32(reg_) \
216 REG_SCRIPT_IO(READ, 32, reg_, 0, 0, 0)
217 #define REG_IO_WRITE8(reg_, value_) \
218 REG_SCRIPT_IO(WRITE, 8, reg_, 0, value_, 0)
219 #define REG_IO_WRITE16(reg_, value_) \
220 REG_SCRIPT_IO(WRITE, 16, reg_, 0, value_, 0)
221 #define REG_IO_WRITE32(reg_, value_) \
222 REG_SCRIPT_IO(WRITE, 32, reg_, 0, value_, 0)
223 #define REG_IO_RMW8(reg_, mask_, value_) \
224 REG_SCRIPT_IO(RMW, 8, reg_, mask_, value_, 0)
225 #define REG_IO_RMW16(reg_, mask_, value_) \
226 REG_SCRIPT_IO(RMW, 16, reg_, mask_, value_, 0)
227 #define REG_IO_RMW32(reg_, mask_, value_) \
228 REG_SCRIPT_IO(RMW, 32, reg_, mask_, value_, 0)
229 #define REG_IO_RXW8(reg_, mask_, value_) \
230 REG_SCRIPT_IO(RXW, 8, reg_, mask_, value_, 0)
231 #define REG_IO_RXW16(reg_, mask_, value_) \
232 REG_SCRIPT_IO(RXW, 16, reg_, mask_, value_, 0)
233 #define REG_IO_RXW32(reg_, mask_, value_) \
234 REG_SCRIPT_IO(RXW, 32, reg_, mask_, value_, 0)
235 #define REG_IO_OR8(reg_, value_) \
236 REG_IO_RMW8(reg_, 0xff, value_)
237 #define REG_IO_OR16(reg_, value_) \
238 REG_IO_RMW16(reg_, 0xffff, value_)
239 #define REG_IO_OR32(reg_, value_) \
240 REG_IO_RMW32(reg_, 0xffffffff, value_)
241 #define REG_IO_POLL8(reg_, mask_, value_, timeout_) \
242 REG_SCRIPT_IO(POLL, 8, reg_, mask_, value_, timeout_)
243 #define REG_IO_POLL16(reg_, mask_, value_, timeout_) \
244 REG_SCRIPT_IO(POLL, 16, reg_, mask_, value_, timeout_)
245 #define REG_IO_POLL32(reg_, mask_, value_, timeout_) \
246 REG_SCRIPT_IO(POLL, 32, reg_, mask_, value_, timeout_)
247 #define REG_IO_XOR8(reg_, value_) \
248 REG_IO_RXW8(reg_, 0xff, value_)
249 #define REG_IO_XOR16(reg_, value_) \
250 REG_IO_RXW16(reg_, 0xffff, value_)
251 #define REG_IO_XOR32(reg_, value_) \
252 REG_IO_RXW32(reg_, 0xffffffff, value_)
255 * Memory Mapped IO
258 #define REG_SCRIPT_MMIO(cmd_, bits_, reg_, mask_, value_, timeout_) \
259 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_##cmd_, \
260 REG_SCRIPT_TYPE_MMIO, \
261 REG_SCRIPT_SIZE_##bits_, \
262 reg_, mask_, value_, timeout_, 0)
263 #define REG_MMIO_READ8(reg_) \
264 REG_SCRIPT_MMIO(READ, 8, reg_, 0, 0, 0)
265 #define REG_MMIO_READ16(reg_) \
266 REG_SCRIPT_MMIO(READ, 16, reg_, 0, 0, 0)
267 #define REG_MMIO_READ32(reg_) \
268 REG_SCRIPT_MMIO(READ, 32, reg_, 0, 0, 0)
269 #define REG_MMIO_WRITE8(reg_, value_) \
270 REG_SCRIPT_MMIO(WRITE, 8, reg_, 0, value_, 0)
271 #define REG_MMIO_WRITE16(reg_, value_) \
272 REG_SCRIPT_MMIO(WRITE, 16, reg_, 0, value_, 0)
273 #define REG_MMIO_WRITE32(reg_, value_) \
274 REG_SCRIPT_MMIO(WRITE, 32, reg_, 0, value_, 0)
275 #define REG_MMIO_RMW8(reg_, mask_, value_) \
276 REG_SCRIPT_MMIO(RMW, 8, reg_, mask_, value_, 0)
277 #define REG_MMIO_RMW16(reg_, mask_, value_) \
278 REG_SCRIPT_MMIO(RMW, 16, reg_, mask_, value_, 0)
279 #define REG_MMIO_RMW32(reg_, mask_, value_) \
280 REG_SCRIPT_MMIO(RMW, 32, reg_, mask_, value_, 0)
281 #define REG_MMIO_RXW8(reg_, mask_, value_) \
282 REG_SCRIPT_MMIO(RXW, 8, reg_, mask_, value_, 0)
283 #define REG_MMIO_RXW16(reg_, mask_, value_) \
284 REG_SCRIPT_MMIO(RXW, 16, reg_, mask_, value_, 0)
285 #define REG_MMIO_RXW32(reg_, mask_, value_) \
286 REG_SCRIPT_MMIO(RXW, 32, reg_, mask_, value_, 0)
287 #define REG_MMIO_OR8(reg_, value_) \
288 REG_MMIO_RMW8(reg_, 0xff, value_)
289 #define REG_MMIO_OR16(reg_, value_) \
290 REG_MMIO_RMW16(reg_, 0xffff, value_)
291 #define REG_MMIO_OR32(reg_, value_) \
292 REG_MMIO_RMW32(reg_, 0xffffffff, value_)
293 #define REG_MMIO_POLL8(reg_, mask_, value_, timeout_) \
294 REG_SCRIPT_MMIO(POLL, 8, reg_, mask_, value_, timeout_)
295 #define REG_MMIO_POLL16(reg_, mask_, value_, timeout_) \
296 REG_SCRIPT_MMIO(POLL, 16, reg_, mask_, value_, timeout_)
297 #define REG_MMIO_POLL32(reg_, mask_, value_, timeout_) \
298 REG_SCRIPT_MMIO(POLL, 32, reg_, mask_, value_, timeout_)
299 #define REG_MMIO_XOR8(reg_, value_) \
300 REG_MMIO_RXW8(reg_, 0xff, value_)
301 #define REG_MMIO_XOR16(reg_, value_) \
302 REG_MMIO_RXW16(reg_, 0xffff, value_)
303 #define REG_MMIO_XOR32(reg_, value_) \
304 REG_MMIO_RXW32(reg_, 0xffffffff, value_)
307 * Access through a device's resource such as a Base Address Register (BAR)
310 #define REG_SCRIPT_RES(cmd_, bits_, bar_, reg_, mask_, value_, timeout_) \
311 _REG_SCRIPT_ENCODE_RES(REG_SCRIPT_COMMAND_##cmd_, \
312 REG_SCRIPT_TYPE_RES, bar_, \
313 REG_SCRIPT_SIZE_##bits_, \
314 reg_, mask_, value_, timeout_)
315 #define REG_RES_READ8(bar_, reg_) \
316 REG_SCRIPT_RES(READ, 8, bar_, reg_, 0, 0, 0)
317 #define REG_RES_READ16(bar_, reg_) \
318 REG_SCRIPT_RES(READ, 16, bar_, reg_, 0, 0, 0)
319 #define REG_RES_READ32(bar_, reg_) \
320 REG_SCRIPT_RES(READ, 32, bar_, reg_, 0, 0, 0)
321 #define REG_RES_WRITE8(bar_, reg_, value_) \
322 REG_SCRIPT_RES(WRITE, 8, bar_, reg_, 0, value_, 0)
323 #define REG_RES_WRITE16(bar_, reg_, value_) \
324 REG_SCRIPT_RES(WRITE, 16, bar_, reg_, 0, value_, 0)
325 #define REG_RES_WRITE32(bar_, reg_, value_) \
326 REG_SCRIPT_RES(WRITE, 32, bar_, reg_, 0, value_, 0)
327 #define REG_RES_RMW8(bar_, reg_, mask_, value_) \
328 REG_SCRIPT_RES(RMW, 8, bar_, reg_, mask_, value_, 0)
329 #define REG_RES_RMW16(bar_, reg_, mask_, value_) \
330 REG_SCRIPT_RES(RMW, 16, bar_, reg_, mask_, value_, 0)
331 #define REG_RES_RMW32(bar_, reg_, mask_, value_) \
332 REG_SCRIPT_RES(RMW, 32, bar_, reg_, mask_, value_, 0)
333 #define REG_RES_RXW8(bar_, reg_, mask_, value_) \
334 REG_SCRIPT_RES(RXW, 8, bar_, reg_, mask_, value_, 0)
335 #define REG_RES_RXW16(bar_, reg_, mask_, value_) \
336 REG_SCRIPT_RES(RXW, 16, bar_, reg_, mask_, value_, 0)
337 #define REG_RES_RXW32(bar_, reg_, mask_, value_) \
338 REG_SCRIPT_RES(RXW, 32, bar_, reg_, mask_, value_, 0)
339 #define REG_RES_OR8(bar_, reg_, value_) \
340 REG_RES_RMW8(bar_, reg_, 0xff, value_)
341 #define REG_RES_OR16(bar_, reg_, value_) \
342 REG_RES_RMW16(bar_, reg_, 0xffff, value_)
343 #define REG_RES_OR32(bar_, reg_, value_) \
344 REG_RES_RMW32(bar_, reg_, 0xffffffff, value_)
345 #define REG_RES_POLL8(bar_, reg_, mask_, value_, timeout_) \
346 REG_SCRIPT_RES(POLL, 8, bar_, reg_, mask_, value_, timeout_)
347 #define REG_RES_POLL16(bar_, reg_, mask_, value_, timeout_) \
348 REG_SCRIPT_RES(POLL, 16, bar_, reg_, mask_, value_, timeout_)
349 #define REG_RES_POLL32(bar_, reg_, mask_, value_, timeout_) \
350 REG_SCRIPT_RES(POLL, 32, bar_, reg_, mask_, value_, timeout_)
351 #define REG_RES_XOR8(bar_, reg_, value_) \
352 REG_RES_RXW8(bar_, reg_, 0xff, value_)
353 #define REG_RES_XOR16(bar_, reg_, value_) \
354 REG_RES_RXW16(bar_, reg_, 0xffff, value_)
355 #define REG_RES_XOR32(bar_, reg_, value_) \
356 REG_RES_RXW32(bar_, reg_, 0xffffffff, value_)
359 #if CONFIG(SOC_INTEL_BAYTRAIL)
361 * IO Sideband Function
364 #define REG_SCRIPT_IOSF(cmd_, unit_, reg_, mask_, value_, timeout_) \
365 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_##cmd_, \
366 REG_SCRIPT_TYPE_IOSF, \
367 REG_SCRIPT_SIZE_32, \
368 reg_, mask_, value_, timeout_, unit_)
369 #define REG_IOSF_READ(unit_, reg_) \
370 REG_SCRIPT_IOSF(READ, unit_, reg_, 0, 0, 0)
371 #define REG_IOSF_WRITE(unit_, reg_, value_) \
372 REG_SCRIPT_IOSF(WRITE, unit_, reg_, 0, value_, 0)
373 #define REG_IOSF_RMW(unit_, reg_, mask_, value_) \
374 REG_SCRIPT_IOSF(RMW, unit_, reg_, mask_, value_, 0)
375 #define REG_IOSF_RXW(unit_, reg_, mask_, value_) \
376 REG_SCRIPT_IOSF(RXW, unit_, reg_, mask_, value_, 0)
377 #define REG_IOSF_OR(unit_, reg_, value_) \
378 REG_IOSF_RMW(unit_, reg_, 0xffffffff, value_)
379 #define REG_IOSF_POLL(unit_, reg_, mask_, value_, timeout_) \
380 REG_SCRIPT_IOSF(POLL, unit_, reg_, mask_, value_, timeout_)
381 #define REG_IOSF_XOR(unit_, reg_, value_) \
382 REG_IOSF_RXW(unit_, reg_, 0xffffffff, value_)
383 #endif /* CONFIG_SOC_INTEL_BAYTRAIL */
386 * CPU Model Specific Register
389 #define REG_SCRIPT_MSR(cmd_, reg_, mask_, value_, timeout_) \
390 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_##cmd_, \
391 REG_SCRIPT_TYPE_MSR, \
392 REG_SCRIPT_SIZE_64, \
393 reg_, mask_, value_, timeout_, 0)
394 #define REG_MSR_READ(reg_) \
395 REG_SCRIPT_MSR(READ, reg_, 0, 0, 0)
396 #define REG_MSR_WRITE(reg_, value_) \
397 REG_SCRIPT_MSR(WRITE, reg_, 0, value_, 0)
398 #define REG_MSR_RMW(reg_, mask_, value_) \
399 REG_SCRIPT_MSR(RMW, reg_, mask_, value_, 0)
400 #define REG_MSR_RXW(reg_, mask_, value_) \
401 REG_SCRIPT_MSR(RXW, reg_, mask_, value_, 0)
402 #define REG_MSR_OR(reg_, value_) \
403 REG_MSR_RMW(reg_, -1ULL, value_)
404 #define REG_MSR_POLL(reg_, mask_, value_, timeout_) \
405 REG_SCRIPT_MSR(POLL, reg_, mask_, value_, timeout_)
406 #define REG_MSR_XOR(reg_, value_) \
407 REG_MSR_RXW(reg_, -1ULL, value_)
410 * Chain to another table.
412 #define REG_SCRIPT_NEXT(next_) \
413 { .command = REG_SCRIPT_COMMAND_NEXT, \
414 .next = next_, \
418 * Set current device
420 #define REG_SCRIPT_SET_DEV(dev_) \
421 { .command = REG_SCRIPT_COMMAND_SET_DEV, \
422 .dev = dev_, \
426 * Last script entry. All tables need to end with REG_SCRIPT_END.
428 #define REG_SCRIPT_END \
429 _REG_SCRIPT_ENCODE_RAW(REG_SCRIPT_COMMAND_END, 0, 0, 0, 0, 0, 0, 0)
431 void reg_script_run(const struct reg_script *script);
432 #ifdef __SIMPLE_DEVICE__
433 void reg_script_run_on_dev(pci_devfn_t dev, const struct reg_script *step);
434 #else
435 void reg_script_run_on_dev(struct device *dev, const struct reg_script *step);
436 #endif
438 #endif /* REG_SCRIPT_H */