uspiflash 0.0.post30__tar.gz

uspiflash-0.0.post30/.gitignore

@@ -0,0 +1,26 @@
+# Git worktrees for feature branches.
+.worktrees/
+
+# Scratch space; never committed.
+tmp/
+
+# The controller's scratch area.
+.superpowers/
+
+# Python.
+__pycache__/
+*.py[cod]
+.venv/
+build/
+dist/
+*.egg-info/
+.coverage
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+src/uspiflash/_version.py
+
+# Docs build output.
+docs/_build/
+docs/_generated/
+docs/_autosummary/

uspiflash-0.0.post30/LICENSE

@@ -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 [yyyy] [name of copyright owner]
+
+   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.

uspiflash-0.0.post30/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.5
+Name: uspiflash
+Version: 0.0.post30
+Summary: Generates tiny single-file C libraries that detect SPI flash chips and report their capabilities, from the spiflash database.
+Project-URL: Homepage, https://github.com/mithro/uspiflash
+Project-URL: Documentation, https://uspiflash.readthedocs.io/
+Project-URL: Issues, https://github.com/mithro/uspiflash/issues
+Author-email: Tim Ansell <me@mith.ro>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: code-generator,embedded,flash,jedec,litex,micropython,sfdp,spi,spi-nand,spi-nor,zephyr
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: C
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.11
+Requires-Dist: spiflash>=0.0.post38
+Description-Content-Type: text/markdown
+
+# uspiflash
+
+A generator of tiny, single-file C libraries that detect SPI flash chips and
+report their capabilities, built from the
+[spiflash](https://github.com/mithro/spiflash) database, for early-boot and
+embedded code: Zephyr, MicroPython, the LiteX BIOS, bare-metal Cortex-M and
+RISC-V (down to WCH's CH32V003), and Linux spidev.
+
+Every byte the library puts on a device is measured, across a wide range of
+GCC, LLVM and SDCC versions.
+
+## Install
+
+```sh
+pip install uspiflash          # or: uv tool install uspiflash
+```
+
+Or, as a Debian package, from the signed apt repository at
+<https://mith.ro/uspiflash/>. There is one per suite (bookworm, trixie, forky
+and sid), and the package is `Architecture: all`, so it installs on any
+architecture. `python3-uspiflash` depends on `python3-spiflash`, which is not
+in this repository, so add spiflash's own apt repository first, then
+uspiflash's. Put your suite's name in place of `trixie` below (Raspberry Pi
+OS uses Debian's codenames):
+
+```sh
+sudo install -d -m0755 /etc/apt/keyrings
+curl -fsSL https://mith.ro/spiflash/spiflash.gpg | sudo tee /etc/apt/keyrings/spiflash.gpg > /dev/null
+echo "deb [signed-by=/etc/apt/keyrings/spiflash.gpg] https://mith.ro/spiflash/trixie/ ./" \
+  | sudo tee /etc/apt/sources.list.d/spiflash.list
+```
+
+spiflash's repository's signing key is
+`B528 6C61 A99A 9E6A 5B8A  8E5B 6B2D 7683 DE01 081D`
+(`gpg --show-keys /etc/apt/keyrings/spiflash.gpg` shows it).
+
+```sh
+curl -fsSL https://mith.ro/uspiflash/uspiflash.gpg | sudo tee /etc/apt/keyrings/uspiflash.gpg > /dev/null
+echo "deb [signed-by=/etc/apt/keyrings/uspiflash.gpg] https://mith.ro/uspiflash/trixie/ ./" \
+  | sudo tee /etc/apt/sources.list.d/uspiflash.list
+```
+
+uspiflash's repository's signing key is
+`2E19 5D58 706D 44E8 5704  1566 04FA D17C 2A3B 8344`
+(`gpg --show-keys /etc/apt/keyrings/uspiflash.gpg` shows it).
+
+```sh
+sudo apt update
+sudo apt install python3-uspiflash      # provides the uspiflash command
+```
+
+Work in progress: the design is in
+[`docs/superpowers/specs/`](https://github.com/mithro/uspiflash/tree/main/docs/superpowers/specs/).
+
+## License
+
+Apache-2.0; see [LICENSE](https://github.com/mithro/uspiflash/blob/main/LICENSE).

uspiflash-0.0.post30/README.md

@@ -0,0 +1,57 @@
+# uspiflash
+
+A generator of tiny, single-file C libraries that detect SPI flash chips and
+report their capabilities, built from the
+[spiflash](https://github.com/mithro/spiflash) database, for early-boot and
+embedded code: Zephyr, MicroPython, the LiteX BIOS, bare-metal Cortex-M and
+RISC-V (down to WCH's CH32V003), and Linux spidev.
+
+Every byte the library puts on a device is measured, across a wide range of
+GCC, LLVM and SDCC versions.
+
+## Install
+
+```sh
+pip install uspiflash          # or: uv tool install uspiflash
+```
+
+Or, as a Debian package, from the signed apt repository at
+<https://mith.ro/uspiflash/>. There is one per suite (bookworm, trixie, forky
+and sid), and the package is `Architecture: all`, so it installs on any
+architecture. `python3-uspiflash` depends on `python3-spiflash`, which is not
+in this repository, so add spiflash's own apt repository first, then
+uspiflash's. Put your suite's name in place of `trixie` below (Raspberry Pi
+OS uses Debian's codenames):
+
+```sh
+sudo install -d -m0755 /etc/apt/keyrings
+curl -fsSL https://mith.ro/spiflash/spiflash.gpg | sudo tee /etc/apt/keyrings/spiflash.gpg > /dev/null
+echo "deb [signed-by=/etc/apt/keyrings/spiflash.gpg] https://mith.ro/spiflash/trixie/ ./" \
+  | sudo tee /etc/apt/sources.list.d/spiflash.list
+```
+
+spiflash's repository's signing key is
+`B528 6C61 A99A 9E6A 5B8A  8E5B 6B2D 7683 DE01 081D`
+(`gpg --show-keys /etc/apt/keyrings/spiflash.gpg` shows it).
+
+```sh
+curl -fsSL https://mith.ro/uspiflash/uspiflash.gpg | sudo tee /etc/apt/keyrings/uspiflash.gpg > /dev/null
+echo "deb [signed-by=/etc/apt/keyrings/uspiflash.gpg] https://mith.ro/uspiflash/trixie/ ./" \
+  | sudo tee /etc/apt/sources.list.d/uspiflash.list
+```
+
+uspiflash's repository's signing key is
+`2E19 5D58 706D 44E8 5704  1566 04FA D17C 2A3B 8344`
+(`gpg --show-keys /etc/apt/keyrings/uspiflash.gpg` shows it).
+
+```sh
+sudo apt update
+sudo apt install python3-uspiflash      # provides the uspiflash command
+```
+
+Work in progress: the design is in
+[`docs/superpowers/specs/`](https://github.com/mithro/uspiflash/tree/main/docs/superpowers/specs/).
+
+## License
+
+Apache-2.0; see [LICENSE](https://github.com/mithro/uspiflash/blob/main/LICENSE).

uspiflash-0.0.post30/docs/api.md

@@ -0,0 +1,9 @@
+# Python API
+
+```{eval-rst}
+.. autosummary::
+   :toctree: _autosummary
+   :recursive:
+
+   uspiflash
+```

uspiflash-0.0.post30/docs/conf.py

@@ -0,0 +1,36 @@
+"""Sphinx configuration for https://uspiflash.readthedocs.io/."""
+
+from __future__ import annotations
+
+import uspiflash
+
+project = "uspiflash"
+author = "Tim Ansell"
+project_copyright = "2026, Tim Ansell"
+release = uspiflash.__version__
+version = release
+
+extensions = [
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+]
+source_suffix = {".md": "markdown", ".rst": "restructuredtext"}
+exclude_patterns = ["_build", "superpowers", "Thumbs.db", ".DS_Store"]
+myst_enable_extensions = ["colon_fence", "deflist", "attrs_inline"]
+myst_heading_anchors = 3
+autosummary_generate = True
+autodoc_default_options = {"members": True, "undoc-members": True, "member-order": "bysource"}
+autodoc_typehints = "description"
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
+html_theme = "furo"
+html_title = "uspiflash"
+html_static_path = ["_static"]
+html_theme_options = {
+    "source_repository": "https://github.com/mithro/uspiflash/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+}

uspiflash-0.0.post30/docs/design.md

@@ -0,0 +1,5 @@
+# Design
+
+```{include} superpowers/specs/2026-09-28-uspiflash-design.md
+:start-line: 1
+```

uspiflash-0.0.post30/docs/developing.md

@@ -0,0 +1,48 @@
+# Developing
+
+## Setup
+
+```console
+uv sync --group dev --group docs
+```
+
+The `dev` group brings in `pytest`, `ruff`, `mypy` and friends; `docs`
+brings in Sphinx and its extensions, so both mypy (it checks
+`docs/conf.py` too) and the documentation build work locally.
+
+## Gates
+
+The same four gates run in CI (`.github/workflows/deb.yml`, job `test`)
+and must all be green before a commit lands:
+
+```console
+uv run ruff check
+uv run ruff format --check
+uv run mypy
+uv run pytest
+```
+
+`pytest` carries a coverage gate (`--cov-fail-under=85`); a change that
+drops coverage below that fails the same way CI does.
+
+## Heavy test runs
+
+Anything heavier than the default suite (parallel workers, the full C
+matrix once it exists, etc.) goes through the sandbox
+(`uspiflash.sandbox`), which sizes memory and CPU limits from the
+machine's current load rather than assuming a dedicated CI runner:
+
+```console
+uv run python -m uspiflash.sandbox -- uv run pytest -n {jobs}
+```
+
+Leave `{jobs}` literally; the sandbox replaces it with the CPU count the
+current limits allow.
+
+## Workflow
+
+- Feature work happens in a git worktree under `.worktrees/`, not in the
+  main checkout, so several tasks can be worked on in isolation at once.
+- Commits are small, one logical change each.
+- Branches land on `main` through merge commits, never a rebase or a
+  squash, so the branch's own commit history is kept.

uspiflash-0.0.post30/docs/index.md

@@ -0,0 +1,13 @@
+# uspiflash
+
+```{include} ../README.md
+:start-line: 1
+```
+
+```{toctree}
+:maxdepth: 2
+
+design
+developing
+api
+```