svd-generator 0.4.1

Converts device information from flattened device tree into an SVD description
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
use crate::svd::register::{
    create_bit_range, create_field, create_register, create_register_properties,
};
use crate::Result;

pub mod stg_syscfg_0;
pub mod stg_syscfg_1;
pub mod stg_syscfg_10;
pub mod stg_syscfg_11;
pub mod stg_syscfg_12;
pub mod stg_syscfg_123;
pub mod stg_syscfg_124;
pub mod stg_syscfg_125;
pub mod stg_syscfg_13;
pub mod stg_syscfg_134;
pub mod stg_syscfg_135;
pub mod stg_syscfg_136;
pub mod stg_syscfg_137;
pub mod stg_syscfg_138;
pub mod stg_syscfg_139;
pub mod stg_syscfg_14;
pub mod stg_syscfg_140;
pub mod stg_syscfg_141;
pub mod stg_syscfg_15;
pub mod stg_syscfg_150;
pub mod stg_syscfg_151;
pub mod stg_syscfg_152;
pub mod stg_syscfg_153;
pub mod stg_syscfg_154;
pub mod stg_syscfg_155;
pub mod stg_syscfg_156;
pub mod stg_syscfg_157;
pub mod stg_syscfg_16;
pub mod stg_syscfg_17;
pub mod stg_syscfg_184;
pub mod stg_syscfg_185;
pub mod stg_syscfg_186;
pub mod stg_syscfg_190;
pub mod stg_syscfg_191;
pub mod stg_syscfg_196;
pub mod stg_syscfg_2;
pub mod stg_syscfg_231;
pub mod stg_syscfg_232;
pub mod stg_syscfg_233;
pub mod stg_syscfg_26;
pub mod stg_syscfg_27;
pub mod stg_syscfg_28;
pub mod stg_syscfg_29;
pub mod stg_syscfg_3;
pub mod stg_syscfg_30;
pub mod stg_syscfg_31;
pub mod stg_syscfg_32;
pub mod stg_syscfg_33;
pub mod stg_syscfg_4;
pub mod stg_syscfg_42;
pub mod stg_syscfg_43;
pub mod stg_syscfg_44;
pub mod stg_syscfg_45;
pub mod stg_syscfg_46;
pub mod stg_syscfg_47;
pub mod stg_syscfg_48;
pub mod stg_syscfg_49;
pub mod stg_syscfg_5;
pub mod stg_syscfg_6;
pub mod stg_syscfg_7;
pub mod stg_syscfg_76;
pub mod stg_syscfg_77;
pub mod stg_syscfg_78;
pub mod stg_syscfg_8;
pub mod stg_syscfg_82;
pub mod stg_syscfg_83;
pub mod stg_syscfg_88;
pub mod stg_syscfg_9;

/// Creates StarFive JH7110 STG Syscon (compatible) register definitions.
pub fn create() -> Result<Vec<svd::RegisterCluster>> {
    let mut regs = Vec::with_capacity(233);

    regs.extend_from_slice(&[
        stg_syscfg_0::create()?,
        stg_syscfg_1::create()?,
        stg_syscfg_2::create()?,
        stg_syscfg_3::create()?,
        stg_syscfg_4::create()?,
        stg_syscfg_5::create()?,
        stg_syscfg_6::create()?,
        stg_syscfg_7::create()?,
        stg_syscfg_8::create()?,
        stg_syscfg_9::create()?,
        stg_syscfg_10::create()?,
        stg_syscfg_11::create()?,
        stg_syscfg_12::create()?,
        stg_syscfg_13::create()?,
        stg_syscfg_14::create()?,
        stg_syscfg_15::create()?,
        stg_syscfg_16::create()?,
        stg_syscfg_17::create()?,
    ]);

    for idx in 0..8 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            72 + (idx * 4),
            format!("u0_pcie_axi4_mst0_aratomop_{bit_off_end}_{bit_off}").as_str(),
            "PCIE AXI4 ARATOMOP MST0 (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_26::create()?,
        stg_syscfg_27::create()?,
        stg_syscfg_28::create()?,
        stg_syscfg_29::create()?,
        stg_syscfg_30::create()?,
        stg_syscfg_31::create()?,
        stg_syscfg_32::create()?,
        stg_syscfg_33::create()?,
    ]);

    for idx in 0..8 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            136 + (idx * 4),
            format!("u0_pcie_axi4_slv0_aratomop_{bit_off_end}_{bit_off}").as_str(),
            "PCIE AXI4 ARATOMOP SLV0 (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_42::create()?,
        stg_syscfg_43::create()?,
        stg_syscfg_44::create()?,
        stg_syscfg_45::create()?,
        stg_syscfg_46::create()?,
        stg_syscfg_47::create()?,
        stg_syscfg_48::create()?,
        stg_syscfg_49::create()?,
    ]);

    for idx in 0..26 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            200 + (idx * 4),
            format!("u0_pcie_k_phyparam_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PHY Parameter (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_76::create()?,
        stg_syscfg_77::create()?,
        stg_syscfg_78::create()?,
    ]);

    for idx in 0..3 {
        regs.push(create_register_stg_syscfg(
            316 + (idx * 4),
            format!("u0_pcie_pf{idx}_offset").as_str(),
            "PCIE PF Offset",
            "[19:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[stg_syscfg_82::create()?, stg_syscfg_83::create()?]);

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            336 + (idx * 4),
            format!("u0_pcie_pl_sideband_in_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PL Sideband IN (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            344 + (idx * 4),
            format!("u0_pcie_pl_sideband_out_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PL Sideband OUT (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.push(stg_syscfg_88::create()?);

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            356 + (idx * 4),
            format!("u0_pcie_test_in_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test IN (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    for idx in 0..16 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            364 + (idx * 4),
            format!("u0_pcie_test_out_bridge_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test OUT Bridge (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    for idx in 0..16 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            428 + (idx * 4),
            format!("u0_pcie_test_out_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test OUT (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_123::create()?,
        stg_syscfg_124::create()?,
        stg_syscfg_125::create()?,
    ]);

    for idx in 0..8 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            504 + (idx * 4),
            format!("u1_pcie_axi4_mst0_aratomap_{bit_off_end}_{bit_off}").as_str(),
            "PCIE AXI4 MST0 ARATOMAP (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_134::create()?,
        stg_syscfg_135::create()?,
        stg_syscfg_136::create()?,
        stg_syscfg_137::create()?,
        stg_syscfg_138::create()?,
        stg_syscfg_139::create()?,
        stg_syscfg_140::create()?,
        stg_syscfg_141::create()?,
    ]);

    for idx in 0..8 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            568 + (idx * 4),
            format!("u1_pcie_axi4_slv0_aratomop_{bit_off_end}_{bit_off}").as_str(),
            "PCIE AXI4 ARATOMOP SLV0 (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_150::create()?,
        stg_syscfg_151::create()?,
        stg_syscfg_152::create()?,
        stg_syscfg_153::create()?,
        stg_syscfg_154::create()?,
        stg_syscfg_155::create()?,
        stg_syscfg_156::create()?,
        stg_syscfg_157::create()?,
    ]);

    for idx in 0..26 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            632 + (idx * 4),
            format!("u1_pcie_k_phyparam_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PHY Parameter (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[
        stg_syscfg_184::create()?,
        stg_syscfg_185::create()?,
        stg_syscfg_186::create()?,
    ]);

    for idx in 0..3 {
        regs.push(create_register_stg_syscfg(
            748 + (idx * 4),
            format!("u1_pcie_pf{idx}_offset").as_str(),
            "PCIE PF Offset",
            "[19:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    regs.extend_from_slice(&[stg_syscfg_190::create()?, stg_syscfg_191::create()?]);

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            768 + (idx * 4),
            format!("u1_pcie_pl_sideband_in_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PL Sideband IN (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            776 + (idx * 4),
            format!("u1_pcie_pl_sideband_out_{bit_off_end}_{bit_off}").as_str(),
            "PCIE PL Sideband OUT (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.push(stg_syscfg_196::create()?);

    for idx in 0..2 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            788 + (idx * 4),
            format!("u1_pcie_test_in_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test IN (little-endian)",
            "[31:0]",
            svd::Access::ReadWrite,
            None,
        )?);
    }

    for idx in 0..16 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            796 + (idx * 4),
            format!("u1_pcie_test_out_bridge_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test OUT Bridge (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    for idx in 0..16 {
        let bit_off = idx * 32;
        let bit_off_end = bit_off + 31;

        regs.push(create_register_stg_syscfg(
            860 + (idx * 4),
            format!("u1_pcie_test_out_{bit_off_end}_{bit_off}").as_str(),
            "PCIE Test OUT (little-endian)",
            "[31:0]",
            svd::Access::ReadOnly,
            None,
        )?);
    }

    regs.push(stg_syscfg_231::create()?);
    regs.push(stg_syscfg_232::create()?);
    regs.push(stg_syscfg_233::create()?);

    Ok(regs)
}

/// Creates a StarFive JH7110 STG Syscon SYSCFG register.
pub fn create_register_stg_syscfg(
    addr_offset: u32,
    field_name: &str,
    field_desc: &str,
    bit_range: &str,
    access: svd::Access,
    default: Option<u64>,
) -> Result<svd::RegisterCluster> {
    Ok(svd::RegisterCluster::Register(create_register(
        format!("stg_syscfg_{}", addr_offset / 4).as_str(),
        format!("STG SYSCONSAIF SYSCFG {addr_offset}").as_str(),
        addr_offset,
        create_register_properties(32, default.unwrap_or(0))?,
        Some(&[create_field(
            field_name,
            field_desc,
            create_bit_range(bit_range)?,
            access,
            None,
        )?]),
        None,
    )?))
}