From 8e8b90736323580c8f3e596925e26f8aa48eac9f Mon Sep 17 00:00:00 2001 From: Niklas Hauser Date: Sun, 12 Nov 2023 22:47:25 +0100 Subject: [PATCH] Setup update script --- .github/workflows/update.yml | 34 ++++++ .gitignore | 1 + LICENSE.md | 202 +++++++++++++++++++++++++++++++++++ README.md | 17 +++ update.py | 83 ++++++++++++++ 5 files changed, 337 insertions(+) create mode 100644 .github/workflows/update.yml create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 update.py diff --git a/.github/workflows/update.yml b/.github/workflows/update.yml new file mode 100644 index 0000000..9043838 --- /dev/null +++ b/.github/workflows/update.yml @@ -0,0 +1,34 @@ +name: Update + +on: + schedule: + - cron: '30 7 * * *' + workflow_dispatch: + +jobs: + update: + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v4 + - name: Configure Git + run: | + git config --global user.email "bot@modm.io" + git config --global user.name "modm update bot" + + - name: Run update.py script + run: | + python3 update.py -d -c + - name: Git push + run: | + git push origin main + + - name: Switch to dummy branch + run: | + git checkout -b keep-alive + - name: Keep Alive + if: always() + uses: gautamkrishnar/keepalive-workflow@v1 + with: + committer_username: modm update bot + committer_email: bot@modm.io diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..480dcf6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +raw/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..007a5d5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright STMicroelectronics + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..509de46 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# CMSIS SVD files for STM32 + +Archive of SVD files for all STM32 families licensed as Apache-2.0. +[Downloaded from the ST homepage][url] and then modified by converting all line +endings from Windows to Unix style and removing all trailing whitespace. + +If you prefer zipped SVD files, check out the [modm-ext/cmsis-svd-stm32-zip][repo] repo. + +Here is the list of the SVD file versions for each STM32 family: + + + + +This repository is updated periodically by GitHub Actions. + +[url]: https://www.st.com/en/microcontrollers-microprocessors/stm32-32-bit-arm-cortex-mcus.html#cad-resources +[repo]: https://github.com/modm-ext/cmsis-svd-stm32-zip diff --git a/update.py b/update.py new file mode 100644 index 0000000..e67a05e --- /dev/null +++ b/update.py @@ -0,0 +1,83 @@ +import zipfile +import logging +import json +import os, re, sys +import tempfile +import shutil +import subprocess +from urllib.request import urlopen, Request +from pathlib import Path + +_hdr = { + 'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.3 Safari/605.1.15', + 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', + 'Accept-Charset': 'ISO-8859-1,utf-8;q=0.7,*;q=0.3', + 'Accept-Encoding': 'none', + 'Accept-Language': 'en-US,en;q=0.8', + 'Connection': 'keep-alive' +} + +def download_svd_data(): + url = "https://www.st.com/content/st_com/en/products/microcontrollers-microprocessors/" + url += "stm32-32-bit-arm-cortex-mcus.cxst-rs-grid.html/CL1734.cad_models_and_symbols.svd.json" + with urlopen(Request(url, headers=_hdr)) as data: + json_data = data.read().decode(encoding="utf-8", errors="ignore") + rows = json.loads(json_data)["rows"] + return [(row["localizedDescriptions"]["en"].split(" ")[0], row["version"], + "https://www.st.com" + row["localizedLinks"]["en"]) for row in rows] + +def download_zip(url, path): + if path.exists(): path.unlink() + with tempfile.NamedTemporaryFile() as outfile: + os.system(f'wget -q --user-agent="{_hdr["User-Agent"]}" "{url}" -O {outfile.name}') + shutil.copy(outfile.name, str(path)) + + +def download_families(download = True): + families = [] + if download: + shutil.rmtree("raw", ignore_errors=True) + Path("raw").mkdir(exist_ok=True) + for family, version, url in sorted(download_svd_data()): + print(family, version, url) + if download: + download_zip(url, Path(f"raw/{family.lower()}.zip")) + families.append((family, version)) + return families + +def format_readme(families): + readme = Path("README.md") + readme_families = "\n".join(f"- {f}: v{v}" for f, v in families) + readme_families = f"\n{readme_families}\n" + readme.write_text(re.sub(".*?", readme_families, + readme.read_text(), flags=re.DOTALL | re.MULTILINE)) + +def unzip_families(families): + for family, _ in families: + family = family.lower() + pfam = Path(family) + shutil.rmtree(pfam, ignore_errors=True) + pfam.mkdir() + with zipfile.ZipFile(Path(f"raw/{family}.zip")) as fzip: + print(f"Unzipping raw/{family}.zip ...") + rawpath = Path(f"raw/{family}") + fzip.extractall(rawpath) + for filename in fzip.namelist(): + if filename.endswith(".svd"): + # Copy, normalize newline and remove trailing whitespace + with (rawpath / filename).open("r", newline=None, encoding="utf-8", errors="ignore") as rfile, \ + (pfam / Path(filename).name).open("w", encoding="utf-8") as wfile: + wfile.writelines(l.rstrip()+"\n" for l in rfile.readlines()) + + +def commit_changes(): + subprocess.run("git add README.md stm32*", shell=True) + if subprocess.call("git diff-index --quiet HEAD --", shell=True): + subprocess.run('git commit -m "Update STM32 SVD files"', shell=True) + + +families = download_families("-d" in sys.argv) +format_readme(families) +unzip_families(families) +if "-c" in sys.argv: + commit_changes()