spiflash 0.0.post11__tar.gz

spiflash-0.0.post11/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.cache/
+.uvcache/
+
+# Coverage artifacts (pytest-cov / coverage.py)
+.coverage
+.coverage.*
+htmlcov/
+
+# hatch-vcs writes this at build/editable-install time; it is derived from git.
+/src/spiflash/_version.py
+
+# tools/update_db.py fetches the upstream sources here.
+/upstream/
+
+# Debian build byproducts. debian/changelog is written by the build
+# (apt-repo-action's scripts/deb-version.py) and never committed.
+debian/changelog
+/built-debs/
+*.deb
+*.buildinfo
+*.changes
+/debian/.debhelper/
+/debian/files
+/debian/*.debhelper
+/debian/*.substvars
+/debian/python3-spiflash/
+/.pybuild/
+/debian/debhelper-build-stamp
+
+# Project-local scratch
+tmp/
+
+# Claude Code local config and subagent-driven-development scratch
+/.claude/
+/.superpowers/
+
+# Git worktrees for branches in flight
+/.worktrees/

spiflash-0.0.post11/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.

spiflash-0.0.post11/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.5
+Name: spiflash
+Version: 0.0.post11
+Summary: A database of SPI flash chips (JEDEC ids, sizes, erase geometry, features), merged from Linux, U-Boot, flashrom, flashprog, OpenOCD and openFPGALoader.
+Project-URL: Homepage, https://github.com/mithro/spiflash
+Project-URL: Issues, https://github.com/mithro/spiflash/issues
+Author-email: Tim Ansell <me@mith.ro>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: flash,flashrom,fpga,jedec,jep106,sfdp,spi,spi-nand,spi-nor
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# spiflash
+
+A database of SPI flash chips — JEDEC ids, part names, sizes, page and sector
+sizes, erase opcodes and block layouts, supply voltages and capabilities —
+merged from the flash tables of every project that keeps one:
+
+| source | what is read | records |
+|---|---|---|
+| [Linux](https://github.com/torvalds/linux) | `drivers/mtd/spi-nor/*.c`, `drivers/mtd/nand/spi/*.c` | 377 (127 SPI NAND) |
+| [U-Boot](https://github.com/u-boot/u-boot) | `drivers/mtd/spi/spi-nor-ids.c` | 334 |
+| [flashrom](https://github.com/flashrom/flashrom) | `flashchips/*.c` (SPI chips only) | 512 |
+| [flashprog](https://review.sourcearcade.org/flashprog.git) | `flashchips.c` (SPI chips only) | 480 |
+| [OpenOCD](https://github.com/openocd-org/openocd) | `src/flash/nor/spi.c`, and `src/helper/jep106.inc` for manufacturer names | 190 |
+| [openFPGALoader](https://github.com/trabucayre/openFPGALoader) | `src/spiFlashdb.hpp` | 53 |
+
+Together that is 778 distinct chip ids (651 SPI NOR, 127 SPI NAND) from 37
+manufacturers, 459 of them described by more than one source, plus the full
+JEP106 manufacturer list. Every entry keeps the upstream file and line it came
+from, and where the sources disagree (60 ids do) both answers are kept.
+
+`spiflash sources` (or `spiflash.sources()`) names the exact upstream commits
+the shipped data was extracted from.
+
+## Install
+
+```sh
+pip install spiflash          # or: uv tool install spiflash
+```
+
+It has no dependencies. Or, as a Debian package, from the signed apt
+repository at https://mith.ro/spiflash/. There is one per suite (bookworm,
+trixie, forky and sid), and the package is `Architecture: all`, so it installs
+on any architecture. 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
+sudo apt update
+sudo apt install python3-spiflash      # provides the spiflash command
+```
+
+The 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).
+
+## The command
+
+What answered `9f` with `ef 40 18`?
+
+```console
+$ spiflash id ef4018
+ef4018  Winbond  W25Q128, W25Q128.V, W25Q128FV, W25Q128JV  (nor)
+    size 16 MiB, page 256 B, sector 64 KiB, 2.7-3.6 V
+    features: dual_read erase_32k erase_4k erase_64k fast_read lock otp quad_read sfdp
+    from: flashrom, flashprog, linux, u-boot, openocd, openfpgaloader
+```
+
+`-v` lists every upstream entry with its file and line, `--json` prints it all
+as JSON. Bytes after the three-byte id narrow the answer: a Spansion
+S25FL128S answers `01 20 18 4d 01 80`, and `spiflash id '01 20 18 4d 01 80'`
+drops the variants with other extended ids. A leading `7f` continuation code is
+optional (`1c7018` and `7f1c7018` are both an Eon EN25QH128).
+
+What does a part answer?
+
+```console
+$ spiflash find gd25q64
+c84017  GigaDevice  GD25Q64, GD25Q64C  (nor)
+    size 8 MiB, page 256 B, sector 64 KiB, 2.7-3.6 V
+    ...
+```
+
+A family (`w25q128`), a part (`W25Q128JV`) or a full order code
+(`S25FL128SAGMFI001`) all work; flashrom's `.` wildcards (`W25Q128.V`) are
+understood.
+
+```sh
+spiflash list --manufacturer winbond     # every Winbond id
+spiflash list --type nand
+spiflash id --method res1 10             # a legacy RES signature byte (M25P10)
+spiflash jep106 7f1c                     # "Eon Silicon Devices"
+spiflash sources                         # the upstream commits
+```
+
+## The library
+
+```python
+import spiflash
+
+(chip,) = spiflash.lookup("ef4018")      # or b"\xef\x40\x18", 0xef4018, [0xef, 0x40, 0x18]
+chip.manufacturer                        # 'Winbond'
+chip.names                               # ('W25Q128', 'W25Q128.V', 'W25Q128FV', 'W25Q128JV')
+chip.size, chip.page_size, chip.sector_size   # (16777216, 256, 65536)
+chip.voltage                             # (2700, 3600), in mV
+"quad_read" in chip.features             # True
+chip.feature_sources("quad_read")        # ('flashprog', 'linux', 'openocd', 'u-boot')
+chip.conflicts                           # {} -- or {"page_size": {256: (...), 512: (...)}}
+
+for r in chip.records:                   # every upstream entry, as extracted
+    print(r.source, r.name, r.url, r.erasers, r.opcodes, r.flags)
+
+spiflash.find("MX25L12835F")             # by part name, best match first
+spiflash.jep106(0xC2)                    # 'Macronix'
+```
+
+A `Flash` is one chip id, and several parts can share one (a W25Q128BV, FV and
+JV all answer `ef4018`), so it lists every name the sources give. Its single
+values (`size`, `page_size`, `sector_size`, `voltage`, `manufacturer`) are what
+most sources agree on, ties going to flashrom, then flashprog, Linux, U-Boot,
+OpenOCD and openFPGALoader; `values("size")` shows who says what. `features`
+is everything any source claims, from this list:
+
+| feature | meaning |
+|---|---|
+| `erase_4k`, `erase_32k`, `erase_64k` | that erase size is supported (0x20, 0x52, 0xd8) |
+| `sfdp` | answers SFDP (JESD216) queries |
+| `fast_read`, `dual_read`, `quad_read`, `octal_read`, `octal_dtr_read` | read modes |
+| `quad_pp`, `octal_dtr_pp` | page program modes |
+| `qpi` | QPI (4-4-4) mode |
+| `4byte_addr`, `4byte_opcodes` | 4-byte addressing; dedicated 4-byte opcodes |
+| `otp`, `lock`, `rww`, `no_erase` | OTP area; status-register block protection; read-while-write; FRAM/MRAM |
+
+The upstream's own flags (`SPI_NOR_HAS_TB`, `FEATURE_WRSR2`, ...) are kept on
+each record's `flags` for anything this list does not capture.
+
+## Updating the data
+
+The data is generated, never edited: `tools/sources.toml` pins each upstream to
+a commit, and
+
+```sh
+uv run tools/update_db.py            # rebuild src/spiflash/data/ from the pins
+uv run tools/update_db.py --latest   # move the pins to each upstream's HEAD first
+```
+
+fetches only the files it reads (a sparse, blobless, depth-1 fetch: about
+15 MB for Linux) and parses the tables as text. A weekly workflow reports when an
+upstream table has changed. See [docs/DEVELOPING.md](docs/DEVELOPING.md) for
+how the extraction works and [docs/SOURCES.md](docs/SOURCES.md) for what is
+taken from where, and under what terms.
+
+## Credits
+
+The extraction follows the approach of LiteSPI's
+[`spi_nor_config_generator`](https://github.com/litex-hub/litespi/tree/feature/module-generator-overrides/tools/spi_nor_config_generator)
+(Antmicro, 2020): the same upstreams, a JSON record per upstream entry, and the
+handling of OpenOCD's `w25q128fv/jv`-style names. The parsers are new, as Linux
+and flashrom have both since changed their table formats. The data itself is
+the work of the people who maintain those tables.
+
+## License
+
+Apache-2.0; see [LICENSE](LICENSE) and, for the data,
+[docs/SOURCES.md](docs/SOURCES.md).

spiflash-0.0.post11/README.md

@@ -0,0 +1,157 @@
+# spiflash
+
+A database of SPI flash chips — JEDEC ids, part names, sizes, page and sector
+sizes, erase opcodes and block layouts, supply voltages and capabilities —
+merged from the flash tables of every project that keeps one:
+
+| source | what is read | records |
+|---|---|---|
+| [Linux](https://github.com/torvalds/linux) | `drivers/mtd/spi-nor/*.c`, `drivers/mtd/nand/spi/*.c` | 377 (127 SPI NAND) |
+| [U-Boot](https://github.com/u-boot/u-boot) | `drivers/mtd/spi/spi-nor-ids.c` | 334 |
+| [flashrom](https://github.com/flashrom/flashrom) | `flashchips/*.c` (SPI chips only) | 512 |
+| [flashprog](https://review.sourcearcade.org/flashprog.git) | `flashchips.c` (SPI chips only) | 480 |
+| [OpenOCD](https://github.com/openocd-org/openocd) | `src/flash/nor/spi.c`, and `src/helper/jep106.inc` for manufacturer names | 190 |
+| [openFPGALoader](https://github.com/trabucayre/openFPGALoader) | `src/spiFlashdb.hpp` | 53 |
+
+Together that is 778 distinct chip ids (651 SPI NOR, 127 SPI NAND) from 37
+manufacturers, 459 of them described by more than one source, plus the full
+JEP106 manufacturer list. Every entry keeps the upstream file and line it came
+from, and where the sources disagree (60 ids do) both answers are kept.
+
+`spiflash sources` (or `spiflash.sources()`) names the exact upstream commits
+the shipped data was extracted from.
+
+## Install
+
+```sh
+pip install spiflash          # or: uv tool install spiflash
+```
+
+It has no dependencies. Or, as a Debian package, from the signed apt
+repository at https://mith.ro/spiflash/. There is one per suite (bookworm,
+trixie, forky and sid), and the package is `Architecture: all`, so it installs
+on any architecture. 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
+sudo apt update
+sudo apt install python3-spiflash      # provides the spiflash command
+```
+
+The 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).
+
+## The command
+
+What answered `9f` with `ef 40 18`?
+
+```console
+$ spiflash id ef4018
+ef4018  Winbond  W25Q128, W25Q128.V, W25Q128FV, W25Q128JV  (nor)
+    size 16 MiB, page 256 B, sector 64 KiB, 2.7-3.6 V
+    features: dual_read erase_32k erase_4k erase_64k fast_read lock otp quad_read sfdp
+    from: flashrom, flashprog, linux, u-boot, openocd, openfpgaloader
+```
+
+`-v` lists every upstream entry with its file and line, `--json` prints it all
+as JSON. Bytes after the three-byte id narrow the answer: a Spansion
+S25FL128S answers `01 20 18 4d 01 80`, and `spiflash id '01 20 18 4d 01 80'`
+drops the variants with other extended ids. A leading `7f` continuation code is
+optional (`1c7018` and `7f1c7018` are both an Eon EN25QH128).
+
+What does a part answer?
+
+```console
+$ spiflash find gd25q64
+c84017  GigaDevice  GD25Q64, GD25Q64C  (nor)
+    size 8 MiB, page 256 B, sector 64 KiB, 2.7-3.6 V
+    ...
+```
+
+A family (`w25q128`), a part (`W25Q128JV`) or a full order code
+(`S25FL128SAGMFI001`) all work; flashrom's `.` wildcards (`W25Q128.V`) are
+understood.
+
+```sh
+spiflash list --manufacturer winbond     # every Winbond id
+spiflash list --type nand
+spiflash id --method res1 10             # a legacy RES signature byte (M25P10)
+spiflash jep106 7f1c                     # "Eon Silicon Devices"
+spiflash sources                         # the upstream commits
+```
+
+## The library
+
+```python
+import spiflash
+
+(chip,) = spiflash.lookup("ef4018")      # or b"\xef\x40\x18", 0xef4018, [0xef, 0x40, 0x18]
+chip.manufacturer                        # 'Winbond'
+chip.names                               # ('W25Q128', 'W25Q128.V', 'W25Q128FV', 'W25Q128JV')
+chip.size, chip.page_size, chip.sector_size   # (16777216, 256, 65536)
+chip.voltage                             # (2700, 3600), in mV
+"quad_read" in chip.features             # True
+chip.feature_sources("quad_read")        # ('flashprog', 'linux', 'openocd', 'u-boot')
+chip.conflicts                           # {} -- or {"page_size": {256: (...), 512: (...)}}
+
+for r in chip.records:                   # every upstream entry, as extracted
+    print(r.source, r.name, r.url, r.erasers, r.opcodes, r.flags)
+
+spiflash.find("MX25L12835F")             # by part name, best match first
+spiflash.jep106(0xC2)                    # 'Macronix'
+```
+
+A `Flash` is one chip id, and several parts can share one (a W25Q128BV, FV and
+JV all answer `ef4018`), so it lists every name the sources give. Its single
+values (`size`, `page_size`, `sector_size`, `voltage`, `manufacturer`) are what
+most sources agree on, ties going to flashrom, then flashprog, Linux, U-Boot,
+OpenOCD and openFPGALoader; `values("size")` shows who says what. `features`
+is everything any source claims, from this list:
+
+| feature | meaning |
+|---|---|
+| `erase_4k`, `erase_32k`, `erase_64k` | that erase size is supported (0x20, 0x52, 0xd8) |
+| `sfdp` | answers SFDP (JESD216) queries |
+| `fast_read`, `dual_read`, `quad_read`, `octal_read`, `octal_dtr_read` | read modes |
+| `quad_pp`, `octal_dtr_pp` | page program modes |
+| `qpi` | QPI (4-4-4) mode |
+| `4byte_addr`, `4byte_opcodes` | 4-byte addressing; dedicated 4-byte opcodes |
+| `otp`, `lock`, `rww`, `no_erase` | OTP area; status-register block protection; read-while-write; FRAM/MRAM |
+
+The upstream's own flags (`SPI_NOR_HAS_TB`, `FEATURE_WRSR2`, ...) are kept on
+each record's `flags` for anything this list does not capture.
+
+## Updating the data
+
+The data is generated, never edited: `tools/sources.toml` pins each upstream to
+a commit, and
+
+```sh
+uv run tools/update_db.py            # rebuild src/spiflash/data/ from the pins
+uv run tools/update_db.py --latest   # move the pins to each upstream's HEAD first
+```
+
+fetches only the files it reads (a sparse, blobless, depth-1 fetch: about
+15 MB for Linux) and parses the tables as text. A weekly workflow reports when an
+upstream table has changed. See [docs/DEVELOPING.md](docs/DEVELOPING.md) for
+how the extraction works and [docs/SOURCES.md](docs/SOURCES.md) for what is
+taken from where, and under what terms.
+
+## Credits
+
+The extraction follows the approach of LiteSPI's
+[`spi_nor_config_generator`](https://github.com/litex-hub/litespi/tree/feature/module-generator-overrides/tools/spi_nor_config_generator)
+(Antmicro, 2020): the same upstreams, a JSON record per upstream entry, and the
+handling of OpenOCD's `w25q128fv/jv`-style names. The parsers are new, as Linux
+and flashrom have both since changed their table formats. The data itself is
+the work of the people who maintain those tables.
+
+## License
+
+Apache-2.0; see [LICENSE](LICENSE) and, for the data,
+[docs/SOURCES.md](docs/SOURCES.md).

spiflash-0.0.post11/docs/DEVELOPING.md

@@ -0,0 +1,87 @@
+# Developing spiflash
+
+Contributor notes. For what the package does, see the [README](../README.md);
+for how versions reach PyPI and apt, see [RELEASING.md](../RELEASING.md).
+
+## Setup and gates
+
+```sh
+uv sync --group dev
+uv run ruff check && uv run mypy && uv run pytest
+```
+
+Those three are what the `test` job of `.github/workflows/deb.yml` runs, on
+Python 3.11 to 3.14. A green run is what "mergeable" means, and on `main` what
+publishes.
+
+## Layout
+
+```
+src/spiflash/          the package: model.py (Record, Flash), db.py (loading,
+                       lookup, find), vendors.py (one name per vendor), cli.py
+src/spiflash/data/     generated: records.json, manufacturers.json, sources.json
+tools/sources.toml     the upstream commits the data is built from
+tools/update_db.py     fetch, extract, write the data
+tools/spiflash_extract/
+    cparse.py          just enough C: find tables, split initialisers,
+                       evaluate integer expressions (SZ_16M, BIT(3), 64 * 1024)
+    record.py          the common record every extractor writes
+    linux.py uboot.py flashrom.py openocd.py openfpgaloader.py
+    fetch.py           sparse, blobless, depth-1 fetch of one commit
+```
+
+The extractors are not in the wheel; the sdist carries them so the data can be
+rebuilt from it.
+
+## Updating the data
+
+```sh
+uv run tools/update_db.py            # rebuild from the pins in tools/sources.toml
+uv run tools/update_db.py --latest   # move the pins to each upstream's HEAD, then rebuild
+uv run tools/update_db.py --check    # fail if the committed data differs
+```
+
+Commit `tools/sources.toml` and `src/spiflash/data/` together. The data files
+hold one record per line, so `git diff` reads chip by chip.
+
+`.github/workflows/upstream.yml` runs `--check` on every change to the data or
+the tools, and `--latest --check` weekly. It is deliberately not part of
+`deb.yml`: a release should not wait on six servers.
+
+## When an upstream changes its format
+
+An extractor that meets something it does not understand raises, naming the
+file and line, rather than guessing: an unknown probe in flashrom, an `.id`
+that is not `SNOR_ID(...)` in Linux, an identifier the expression evaluator has
+no value for. Fix the extractor, and add the new shape to the miniature tree in
+`tests/test_extract.py`, which holds a cut-down copy of each format.
+
+A new vendor spelling fails `test_vendor_spellings_all_canonical`: add it to
+`src/spiflash/vendors.py`.
+
+## Adding a source
+
+1. A `[name]` table in `tools/sources.toml`: `url`, `branch`, `commit`, the
+   `paths` to fetch, and the `license` of those files.
+2. `tools/spiflash_extract/<name>.py` with `extract(root) -> list[Record]`,
+   built with `record.make(...)`, and an entry in `update_db.EXTRACTORS`.
+3. Tests on a miniature tree in `tests/test_extract.py`.
+4. Its place in `SOURCE_PRIORITY` (`src/spiflash/model.py`), and a row in the
+   README and `docs/SOURCES.md`.
+
+## Building the Debian package locally
+
+The CI build is `mithro/apt-repo-action`'s `build-deb`: `dpkg-buildpackage -A`
+in a `debian:<suite>` container, after its `scripts/deb-version.py` writes
+`debian/changelog`. By hand, from a clean clone:
+
+```sh
+docker run --rm -v "$PWD:/work/src" -v /path/to/apt-repo-action:/a:ro -w /work/src debian:trixie bash -ec '
+  apt-get update && apt-get install -y --no-install-recommends build-essential debhelper dpkg-dev fakeroot git python3
+  apt-get build-dep -y ./ && git config --global --add safe.directory "*"
+  python3 /a/scripts/deb-version.py --suite trixie --write-changelog
+  dpkg-buildpackage -us -uc -A'
+```
+
+The package's own tests run during the build (`debian/rules`), and
+`packaging/install-test.sh` is the smoke test CI runs in a clean container.