Compare commits
1 commit
main
...
tuning-bar
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
87a9415c61 |
770 changed files with 6903 additions and 842661 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -6,4 +6,3 @@ fab
|
|||
venv
|
||||
gerber
|
||||
gerber.zip
|
||||
.ipynb_checkpoints
|
||||
|
|
|
|||
4
.gitmodules
vendored
4
.gitmodules
vendored
|
|
@ -1,7 +1,7 @@
|
|||
[submodule "fw/upstream/PyCortexMDebug"]
|
||||
path = firmware/upstream/PyCortexMDebug
|
||||
path = fw/upstream/PyCortexMDebug
|
||||
url = https://github.com/bnahill/PyCortexMDebug
|
||||
[submodule "fw/upstream/stm32square"]
|
||||
path = firmware/upstream/stm32square
|
||||
path = fw/upstream/stm32square
|
||||
url = https://gitlab.com/neinseg/stm32square
|
||||
branch = release
|
||||
|
|
|
|||
170
LICENSE.txt
170
LICENSE.txt
|
|
@ -1,170 +0,0 @@
|
|||
Creative Commons Attribution-ShareAlike 4.0 International
|
||||
|
||||
Creative Commons Corporation (“Creative Commons”) is not a law firm and does not provide legal services or legal advice. Distribution of Creative Commons public licenses does not create a lawyer-client or other relationship. Creative Commons makes its licenses and related information available on an “as-is” basis. Creative Commons gives no warranties regarding its licenses, any material licensed under their terms and conditions, or any related information. Creative Commons disclaims all liability for damages resulting from their use to the fullest extent possible.
|
||||
|
||||
Using Creative Commons Public Licenses
|
||||
|
||||
Creative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses.
|
||||
|
||||
Considerations for licensors: Our public licenses are intended for use by those authorized to give the public permission to use material in ways otherwise restricted by copyright and certain other rights. Our licenses are irrevocable. Licensors should read and understand the terms and conditions of the license they choose before applying it. Licensors should also secure all rights necessary before applying our licenses so that the public can reuse the material as expected. Licensors should clearly mark any material not subject to the license. This includes other CC-licensed material, or material used under an exception or limitation to copyright. More considerations for licensors.
|
||||
|
||||
Considerations for the public: By using one of our public licenses, a licensor grants the public permission to use the licensed material under specified terms and conditions. If the licensor’s permission is not necessary for any reason–for example, because of any applicable exception or limitation to copyright–then that use is not regulated by the license. Our licenses grant only permissions under copyright and certain other rights that a licensor has authority to grant. Use of the licensed material may still be restricted for other reasons, including because others have copyright or other rights in the material. A licensor may make special requests, such as asking that all changes be marked or described.
|
||||
|
||||
Although not required by our licenses, you are encouraged to respect those requests where reasonable. More considerations for the public.
|
||||
|
||||
Creative Commons Attribution-ShareAlike 4.0 International Public License
|
||||
|
||||
By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
|
||||
|
||||
Section 1 – Definitions.
|
||||
|
||||
a. Adapted Material means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
|
||||
|
||||
b. Adapter's License means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
|
||||
|
||||
c. BY-SA Compatible License means a license listed at creativecommons.org/compatiblelicenses, approved by Creative Commons as essentially the equivalent of this Public License.
|
||||
|
||||
d. Copyright and Similar Rights means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||
|
||||
e. Effective Technological Measures means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
|
||||
|
||||
f. Exceptions and Limitations means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
|
||||
|
||||
g. License Elements means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution and ShareAlike.
|
||||
|
||||
h. Licensed Material means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
|
||||
|
||||
i. Licensed Rights means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
|
||||
|
||||
j. Licensor means the individual(s) or entity(ies) granting rights under this Public License.
|
||||
|
||||
k. Share means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
|
||||
|
||||
l. Sui Generis Database Rights means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
|
||||
|
||||
m. You means the individual or entity exercising the Licensed Rights under this Public License. Your has a corresponding meaning.
|
||||
|
||||
Section 2 – Scope.
|
||||
|
||||
a. License grant.
|
||||
|
||||
1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
|
||||
|
||||
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||
|
||||
B. produce, reproduce, and Share Adapted Material.
|
||||
|
||||
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
|
||||
|
||||
3. Term. The term of this Public License is specified in Section 6(a).
|
||||
|
||||
4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
|
||||
|
||||
5. Downstream recipients.
|
||||
|
||||
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
|
||||
|
||||
B. Additional offer from the Licensor – Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter’s License You apply.
|
||||
|
||||
C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
|
||||
|
||||
6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
|
||||
|
||||
b. Other rights.
|
||||
|
||||
1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
|
||||
|
||||
2. Patent and trademark rights are not licensed under this Public License.
|
||||
|
||||
3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties.
|
||||
|
||||
Section 3 – License Conditions.
|
||||
|
||||
Your exercise of the Licensed Rights is expressly made subject to the following conditions.
|
||||
|
||||
a. Attribution.
|
||||
|
||||
1. If You Share the Licensed Material (including in modified form), You must:
|
||||
|
||||
A. retain the following if it is supplied by the Licensor with the Licensed Material:
|
||||
|
||||
i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
|
||||
|
||||
ii. a copyright notice;
|
||||
|
||||
iii. a notice that refers to this Public License;
|
||||
|
||||
iv. a notice that refers to the disclaimer of warranties;
|
||||
|
||||
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||
|
||||
B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
|
||||
|
||||
C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
|
||||
|
||||
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
|
||||
|
||||
3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||
|
||||
b. ShareAlike.In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
|
||||
|
||||
1. The Adapter’s License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-SA Compatible License.
|
||||
|
||||
2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
|
||||
|
||||
3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
|
||||
|
||||
Section 4 – Sui Generis Database Rights.
|
||||
|
||||
Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
|
||||
|
||||
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database;
|
||||
|
||||
b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
|
||||
|
||||
c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
|
||||
For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
|
||||
|
||||
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||
|
||||
a. Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.
|
||||
|
||||
b. To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.
|
||||
|
||||
c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
|
||||
|
||||
Section 6 – Term and Termination.
|
||||
|
||||
a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
|
||||
|
||||
b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
|
||||
|
||||
1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
|
||||
|
||||
2. upon express reinstatement by the Licensor.
|
||||
|
||||
c. For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
|
||||
|
||||
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
|
||||
|
||||
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||
|
||||
Section 7 – Other Terms and Conditions.
|
||||
|
||||
a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
|
||||
|
||||
b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
|
||||
|
||||
Section 8 – Interpretation.
|
||||
|
||||
a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
|
||||
|
||||
b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
|
||||
|
||||
c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
|
||||
|
||||
d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
|
||||
|
||||
Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances will be considered the “Licensor.” Except for the limited purpose of indicating that material is shared under a Creative Commons public license or as otherwise permitted by the Creative Commons policies published at creativecommons.org/policies, Creative Commons does not authorize the use of the trademark “Creative Commons” or any other trademark or logo of Creative Commons without its prior written consent including, without limitation, in connection with any unauthorized modifications to any of its public licenses or any other arrangements, understandings, or agreements concerning use of licensed material. For the avoidance of doubt, this paragraph does not form part of the public licenses.
|
||||
|
||||
Creative Commons may be contacted at creativecommons.org.
|
||||
207
README.rst
207
README.rst
|
|
@ -1,207 +0,0 @@
|
|||
|
||||
High Fidelity Security Mesh Monitoring using Low-Cost, Embedded Time Domain Reflectometry
|
||||
=========================================================================================
|
||||
|
||||
This repository contains all sources for our paper "High Fidelity Security Mesh Monitoring using Low-Cost, Embedded Time
|
||||
Domain Reflectometry" to be published in CHES 2026/1 (`preprint on eprint <https://eprint.iacr.org/2025/1962>`__). You
|
||||
can find a brief overview of the project `on Jan's blog <https://jaseg.de/blog/paper-sampling-mesh-monitor/>`__.
|
||||
|
||||
The canonical hosting location for this repo is https://git.jaseg.de/sampling-mesh-monitor.git . For comments or
|
||||
questions, please reach out to Jan via `email <mailto:research@jaseg.de>`__ or `on mastodon
|
||||
<https://chaos.social/@jaseg>`__.
|
||||
|
||||
.. figure:: paper/pic_board_setup_2_small.jpg
|
||||
:align: center
|
||||
:width: 400px
|
||||
:alt: A PCB with several chips sitting on a table with another PCB with only traces on it plugged in through a
|
||||
board-edge connector. The first PCB looks not very complex.
|
||||
|
||||
The final setup. On the right is the measurement board, and on the left is the mesh test specimen plugged in. In a
|
||||
real application, you would integrate both into your target circuit.
|
||||
|
||||
Paper abstract
|
||||
--------------
|
||||
|
||||
Security Meshes are patterns of sensing traces covering an area that are used in Hardware Security Modules (HSMs)
|
||||
and other systems to detect attempts to physically intrude into the device's protective shell. State-of-the-art
|
||||
solutions manufacture meshes in bespoke processes from carefully chosen materials, which is expensive and makes
|
||||
replication challenging. Additionally, state-of-the-art monitoring circuits sacrifice either monitoring precision or
|
||||
cost efficiency. In this paper, we present an embeddable security mesh monitoring circuit constructed from low-cost,
|
||||
standard components that utilizes Time Domain Reflectometry (TDR) to create a unique fingerprint of a mesh. Our
|
||||
approach is both low-cost and precise, and enables the use of inexpensive standard Printed Circuit Boards (PCBs) as
|
||||
security mesh material. We demonstrate a working prototype of our TDR circuit costing less than 10 € in components
|
||||
that achieves both time resolution and rise time better than 200 ps—a 25 × improvement over previous work. We
|
||||
demonstrate a simple classifier that detects several types of advanced attacks such as probing using an oscilloscope
|
||||
probe or micro-soldering attacks with no false negatives.
|
||||
|
||||
Repo structure
|
||||
--------------
|
||||
|
||||
``main_pcb``
|
||||
KiCad design files, exports and manufacturing files for the main circuit board. This board contains the measurement
|
||||
circuit, and has a connector for test coupons to be inserted. Data is read out throught the SWD interface using an
|
||||
SWD adapter. The board is a 6-layer PCB. The circuit is described in detail in the paper. It is based around a
|
||||
``STM32G474RE`` ARM microcontroller.
|
||||
|
||||
``test_coupons``
|
||||
KiCad design files, exports and manufacturing files for the test coupon PCBs. The coupons are four-layer boards.
|
||||
Each coupon contains four test meshes, two on each side, that can be connected through four SFP form factor board
|
||||
edge connectors at the coupon's corners.
|
||||
|
||||
``firmware``
|
||||
Source code for the board firmware as well as tooling for running the experiments. The firmware is written in C, and
|
||||
you'll need a standard ARM GCC/binutils toolchain to build it. The experiment tool is a python script that connects
|
||||
to the board through GDB and exposes a local web server for controlling the board, monitoring the measurements in
|
||||
real time, and capturing data.
|
||||
|
||||
``analysis``
|
||||
All raw data, as well as the Jupyter notebooks used for analysis and plotting. By running these notebooks, you can
|
||||
re-run the analysis, and re-export all plots in the paper. The raw data is contained in JSON files, one per
|
||||
measurement series. Each JSON file contains some metadata describing the experiment and the settings used during the
|
||||
experiment, a set of calibration runs with the target specimen disconnected using the board's routing switches, and
|
||||
a full set of 12 measurement arrays consisting of a mean and standard deviation for each data point. To save space,
|
||||
batches of these JSON files are aggregated into zip archives. The analysis Jupyter notebooks will automatically load
|
||||
and decode the data from these zip archives when run.
|
||||
|
||||
``paper``
|
||||
The source of the paper, as well as exports of all plots.
|
||||
|
||||
Running the analysis
|
||||
--------------------
|
||||
|
||||
To re-run the analysis, first install `Jupyter Lab <https://jupyter.org/>`__ and the `numpy <https://numpy.org/>`__ and
|
||||
`scipy <https://scipy.org/>`__ python packages. If you're running in a virtualenv or on a weird platform like Windows or
|
||||
MacOS, make sure that jupyter and pip agree where your python lives and the packages get installed in the right place.
|
||||
|
||||
Afterwards, just run ``jupyter lab`` in the ``analysis/jupyter_notebooks`` directory. You can then open any of the
|
||||
notebooks through the left side panel and re-run the analysis within. Make sure you run all of the setup code at the top
|
||||
of the notebook once before trying to run the analaysis code in the cells below. The analysis code only uses standard
|
||||
scientific python packages that you probably already have installed. If you get an ``ImportError``, make sure the
|
||||
packages listed in the file ``analysis/jupyter_notebooks/requirements.txt`` are installed.
|
||||
|
||||
The notebooks will display the plots and results inside Jupyter Lab and will also automatically export the plots to the
|
||||
``paper`` directory of your clone of the git repository.
|
||||
|
||||
PCB Designs
|
||||
-----------
|
||||
|
||||
This repo includes both the raw CAD files of the PCBs, as well as exported manufacturing data for easier viewing if you
|
||||
don't have KiCad installed. The schematics are included as PDF exports.
|
||||
|
||||
The PCB designs were prepared in the open source KiCad_ EDA tool. Note that for some files you might need to download a
|
||||
KiCad nightly build depending on how new your KiCad version is.
|
||||
|
||||
PCB design folder structure
|
||||
...........................
|
||||
|
||||
``foobar.{kicad_pro,kicad_sch,kicad_pcb,etc.}``
|
||||
The KiCad source files of the PCB. Open the ``.kicad_pro`` file in KiCad, then you can open the schematics and board
|
||||
layout from there.
|
||||
|
||||
``fab/gerbers.zip``
|
||||
Gerber exports of the board layouts. You can open these in any Gerber viewer such as gerbv_. These files are
|
||||
essentially vector graphics exports of the board layout. They show what copper, silkscreen etc. you see on the
|
||||
board, but they don't include any semantic information such as component values. You can send this zip directly to a
|
||||
PCB manufacturer and they will be able to manufacture these boards for you. The order parameters are included in the
|
||||
gerber files on the ``User.Comments`` layer.
|
||||
|
||||
``fab/{bom.csv,pos.csv}``
|
||||
Bill of materials and component placement coordinate files for board manufacturing. If you want a contract
|
||||
manufacturer to solder these boards for you, you need to give them these two files in addition to the gerbers. The
|
||||
BOM tells them what exact parts and how many of them you need, the position file tells them where to put them on the
|
||||
board. We had JLCPCB make the PCBs, and we also had them solder most of the parts. Some parts we soldered after the
|
||||
fact by hand because JLC didn't have them in stock, and getting them to order and solder them for us would have been
|
||||
pretty expensive.
|
||||
|
||||
If you want to solder the main PCB yourself, you need some prior experience in fine SMD work and a decently setup
|
||||
electronics lab with a microscope, a hot air reworks station, etc.
|
||||
|
||||
Note: **The PCB revision here does not have a functional driver IC!** For our lab experiments we microsoldered
|
||||
the four different driver ICs by hand to avoid having to spin multiple copies of this expensive PCB. For some basic
|
||||
measurements, you can just omit the driver IC included in the design and bridge it. This will drive the mesh
|
||||
directly from the ``74LVC2G157`` gates, which is enough for some basic measurements.
|
||||
|
||||
``schematics/*.pdf``
|
||||
PDF export of the schematics of the board.
|
||||
|
||||
Firmware
|
||||
--------
|
||||
|
||||
The firmware and associated scripts are contained in the ``firmware`` directory.
|
||||
|
||||
Building the firmware
|
||||
.....................
|
||||
|
||||
If you have an ARM GCC toolchain installed, you can build the firmware by running ``make`` in this directory. During
|
||||
build, the makefile exports some diagnostic information about the build artifacts. For that to work, you have to have
|
||||
the `cxxfilt python package <https://pypi.org/project/cxxfilt/>`__ installed. If the package can't be found, the
|
||||
firmware will still be built, but you will get a crash in the makefile during the analysis step that runs after the
|
||||
build was successful.
|
||||
|
||||
Running experiments
|
||||
...................
|
||||
|
||||
To run an experiment, you need a measurement board and a test coupon. You also need the following software installed on
|
||||
your machine:
|
||||
|
||||
* ``openocd``
|
||||
* ``arm-none-eabi-gdb`` (another ABI arm gdb should work too)
|
||||
* The python packages listed in ``firmware/requirements.txt``
|
||||
|
||||
To build the firmware, you additionally need a ARM toolchain installed. By default, the makefile assumes gcc/gnu
|
||||
binutils, but you can override that if you prefer to use LLVM.
|
||||
|
||||
To run an experiment, connect the board to power via USB, and to your computer through an SWD debug adapter. We used
|
||||
cheap STLinkV2 clones, if you have a different adapter you'll have to modify the ``.gdbinit`` script accordingly. After
|
||||
connecting the board, open three terminal windows running the following three commands one per window, in this order.
|
||||
|
||||
1. ``openocd -f openocd.cfg``
|
||||
2. ``arm-none-eabi-gdb build/main.elf``
|
||||
3. ``python adc_serve.py``
|
||||
|
||||
This will connect to the board and start the realtime control and measurement web interface. You can open the web
|
||||
interface at the location printed by ``adc_serve.py`` on startup.
|
||||
|
||||
If you're cheap like us and use a STLinkV2 clone SWD adapter, it may be that openocd takes a few (maybe up to five or
|
||||
so) attempts to start up and connect to the microcontroller. After starting, the GDB terminal should start printing a
|
||||
few lines of output every 30 seconds or so when it saves a measurement series. If GDB starts to hang, it might be that
|
||||
you bumped a cable or accidentially shorted something on the board. To re-start, you first kill gdb (Ctrl+C, then
|
||||
Ctrl+D, then Ctrl+D again), then you stop openocd (Ctrl+C, kill it if it doesn't stop in a few seconds), then you
|
||||
restart them in the order above. You don't have to restart the web interface, just adjust any of the knobs to overwrite
|
||||
the default control settings again.
|
||||
|
||||
Firmware Folder Structure
|
||||
.........................
|
||||
|
||||
``src/main.c``
|
||||
The source code of the mainboard firmware. This firmware captures data into internal buffers, which are read out
|
||||
from the host through SWD.
|
||||
|
||||
``openocd.cfg``
|
||||
OpenOCD script for connecting to the debug adapter. We used cheap STLinkV2 clones from aliexpress. If you use a
|
||||
different debug adapter, you will have to modify this file accordingly to tell OpenOCD how to connect to the board.
|
||||
The port numbers given here and in the ``.gdbinit`` must match up.
|
||||
|
||||
``.gdbinit``
|
||||
GDB script running the data extraction. This script will continuously dump the measurement data into ``/tmp`` every
|
||||
time a measurement series has been completed. Note that this file will be hidden on unixes. Also note that you will
|
||||
have to explicitly allowlist this file's absolute path on your computer in your ``$HOME/.gdbinit`` the first time
|
||||
you run it because gdb refuses to run unknown ``.gdbinit`` files for security.
|
||||
|
||||
``adc_serve.py``
|
||||
Real-time monitoring and data capture tool. Before running this, first make sure you have gdb attached to the board
|
||||
using the ``.gdbinit``. The tool communicates with the gdb script through files in ``/tmp``. It exposes a web
|
||||
interface that displays the captured data in real time, allows you to change the board's measurement settings, and
|
||||
allows you to export measurement series.
|
||||
|
||||
``make_barcodes.py``
|
||||
This is a helper script we used to create barcode labels for all ~120 test specimens to simplify the measurement
|
||||
workflow. We had a barcode reader hooked up to the computer running the measurements, so you could just scan a
|
||||
specimen's barcode to capture a data series registered to that board in the web interface.
|
||||
|
||||
other files:
|
||||
Build files for the firmware. These are mostly generic to this type of microcontroller and are included here so the
|
||||
firmware source is self-contained.
|
||||
|
||||
.. _KiCad: https://www.kicad.org/
|
||||
.. _gerbv: https://gerbv.github.io/
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue