/
makecrates.py
249 lines (202 loc) · 7.7 KB
/
makecrates.py
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
"""
makecrates.py
Copyright 2017-2019 Adam Greig
Licensed under the MIT and Apache 2.0 licenses.
Autogenerate the crate Cargo.toml, build.rs, README.md and src/lib.rs files
based on available YAML files for each STM32 family.
Usage: python3 scripts/makecrates.py devices/
"""
import os
import glob
import os.path
import argparse
import yaml
VERSION = "0.11.0"
SVD2RUST_VERSION = "0.17.0"
CRATE_DOC_FEATURES = {
"stm32f0": ["rt", "stm32f0x0", "stm32f0x1", "stm32f0x2", "stm32f0x8"],
"stm32f1": ["rt", "stm32f100", "stm32f101", "stm32f102", "stm32f103",
"stm32f107"],
"stm32f2": ["rt", "stm32f215", "stm32f217"],
"stm32f3": ["rt", "stm32f303", "stm32f373", "stm32f3x8"],
"stm32f4": ["rt", "stm32f401", "stm32f407", "stm32f413", "stm32f469"],
"stm32f7": ["rt", "stm32f7x3", "stm32f7x9"],
"stm32h7": ["rt", "stm32h743", "stm32h743v", "stm32h747cm7"],
"stm32l0": ["rt", "stm32l0x1", "stm32l0x2", "stm32l0x3"],
"stm32l1": ["rt", "stm32l100", "stm32l151", "stm32l162"],
"stm32l4": ["rt", "stm32l4x1", "stm32l4x5"],
"stm32g0": ["rt", "stm32g07x", "stm32g030", "stm32g031", "stm32g041", "stm32g081"],
"stm32g4": ["rt", "stm32g431", "stm32g441", "stm32g474", "stm32g484"]
}
CARGO_TOML_TPL = """\
[package]
edition = "2018"
name = "{crate}"
version = "{version}"
authors = ["Adam Greig <adam@adamgreig.com>", "stm32-rs Contributors"]
description = "Device support crates for {family} devices"
repository = "https://github.com/stm32-rs/stm32-rs"
readme = "README.md"
keywords = ["stm32", "svd2rust", "no_std", "embedded"]
categories = ["embedded", "no-std"]
license = "MIT/Apache-2.0"
[dependencies]
bare-metal = "0.2.4"
vcell = "0.1.0"
cortex-m = ">=0.5.8,<0.7"
[dependencies.cortex-m-rt]
optional = true
version = "0.6.10"
[package.metadata.docs.rs]
features = {docs_features}
targets = []
[features]
default = []
rt = ["cortex-m-rt/device"]
{features}
"""
SRC_LIB_RS_TPL = """\
//! Peripheral access API for {family} microcontrollers
//! (generated using [svd2rust](https://github.com/rust-embedded/svd2rust)
//! {svd2rust_version})
//!
//! You can find an overview of the API here:
//! [svd2rust/#peripheral-api](https://docs.rs/svd2rust/{svd2rust_version}/svd2rust/#peripheral-api)
//!
//! For more details see the README here:
//! [stm32-rs](https://github.com/stm32-rs/stm32-rs)
//!
//! This crate supports all {family} devices; for the complete list please
//! see:
//! [{crate}](https://github.com/stm32-rs/stm32-rs/tree/master/{crate})
//!
//! Due to doc build limitations, not all devices may be shown on docs.rs;
//! a representative few have been selected instead. For a complete list of
//! available registers and fields see: [stm32-rs Device Coverage](https://stm32.agg.io/rs)
#![allow(non_camel_case_types)]
#![no_std]
mod generic;
pub use self::generic::*;
{mods}
"""
README_TPL = """\
# {crate}
This crate provides an autogenerated API for access to {family} peripherals.
The API is generated using [svd2rust] with patched svd files containing
extensive type-safe support. For more information please see the [main repo].
Refer to the [documentation] for full details.
[svd2rust]: https://github.com/japaric/svd2rust
[main repo]: https://github.com/stm32-rs/stm32-rs
[documentation]: https://docs.rs/{crate}/latest/{crate}/
## Usage
Each device supported by this crate is behind a feature gate so that you only
compile the device(s) you want. To use, in your Cargo.toml:
```toml
[dependencies.{crate}]
version = "{version}"
features = ["{device}", "rt"]
```
The `rt` feature is optional and brings in support for `cortex-m-rt`.
In your code:
```rust
use {crate}::{device};
let mut peripherals = {device}::Peripherals::take().unwrap();
let gpioa = &peripherals.GPIOA;
gpioa.odr.modify(|_, w| w.odr0().set_bit());
```
For full details on the autogenerated API, please see:
https://docs.rs/svd2rust/{svd2rust_version}/svd2rust/#peripheral-api
## Supported Devices
| Module | Devices | Links |
|:------:|:-------:|:-----:|
{devices}
"""
BUILD_TPL = """\
use std::env;
use std::fs;
use std::path::PathBuf;
fn main() {{
if env::var_os("CARGO_FEATURE_RT").is_some() {{
let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
println!("cargo:rustc-link-search={{}}", out.display());
let device_file = {device_clauses};
fs::copy(device_file, out.join("device.x")).unwrap();
println!("cargo:rerun-if-changed={{}}", device_file);
}}
println!("cargo:rerun-if-changed=build.rs");
}}
"""
def read_device_table():
path = os.path.join(
os.path.abspath(os.path.split(__file__)[0]), os.pardir,
"stm32_part_table.yaml")
with open(path, encoding='utf-8') as f:
table = yaml.safe_load(f)
return table
def make_device_rows(table, family):
rows = []
for device, dt in table[family].items():
links = "[{}]({}), [st.com]({})".format(
dt['rm'], dt['rm_url'], dt['url'])
members = ", ".join(m for m in dt['members'])
rows.append("| {} | {} | {} |".format(device, members, links))
return "\n".join(sorted(rows))
def make_features(devices):
return "\n".join("{} = []".format(d) for d in sorted(devices))
def make_mods(devices):
return "\n".join('#[cfg(feature = "{0}")]\npub mod {0};\n'.format(d)
for d in sorted(devices))
def make_device_clauses(devices):
return " else ".join("""\
if env::var_os("CARGO_FEATURE_{}").is_some() {{
"src/{}/device.x"
}}""".strip().format(d.upper(), d) for d in sorted(devices)) + \
" else { panic!(\"No device features selected\"); }"
def main(devices_path, yes):
devices = {}
for path in glob.glob(os.path.join(devices_path, "*.yaml")):
yamlfile = os.path.basename(path)
family = yamlfile[:7]
device = os.path.splitext(yamlfile)[0].lower()
if family not in devices:
devices[family] = []
devices[family].append(device)
table = read_device_table()
dirs = ", ".join(x.lower()+"/" for x in devices)
print("Going to create/update the following directories:")
print(dirs)
if not yes:
input("Enter to continue, ctrl-C to cancel")
for family in devices:
devices[family] = sorted(devices[family])
crate = family.lower()
features = make_features(devices[family])
clauses = make_device_clauses(devices[family])
mods = make_mods(devices[family])
ufamily = family.upper()
cargo_toml = CARGO_TOML_TPL.format(
family=ufamily, crate=crate, version=VERSION, features=features,
docs_features=str(CRATE_DOC_FEATURES[crate]))
readme = README_TPL.format(
family=ufamily, crate=crate, device=devices[family][0],
version=VERSION, svd2rust_version=SVD2RUST_VERSION,
devices=make_device_rows(table, family))
lib_rs = SRC_LIB_RS_TPL.format(family=ufamily, mods=mods, crate=crate,
svd2rust_version=SVD2RUST_VERSION)
build_rs = BUILD_TPL.format(device_clauses=clauses)
os.makedirs(os.path.join(crate, "src"), exist_ok=True)
with open(os.path.join(crate, "Cargo.toml"), "w") as f:
f.write(cargo_toml)
with open(os.path.join(crate, "README.md"), "w") as f:
f.write(readme)
with open(os.path.join(crate, "src", "lib.rs"), "w") as f:
f.write(lib_rs)
with open(os.path.join(crate, "build.rs"), "w") as f:
f.write(build_rs)
if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument("-y", help="Assume 'yes' to prompt",
action="store_true")
parser.add_argument("devices", help="Path to device YAML files")
args = parser.parse_args()
main(args.devices, args.y)