diff --git a/README.md b/README.md index c3d4c95a6..ab4b8a299 100644 --- a/README.md +++ b/README.md @@ -105,10 +105,13 @@ Generally, one can create an image for hardware using the following command: cargo xtask app-image ``` -And it will pull from the default soc.svd configuration. The default config -can be seen in the [utralib/Cargo.tom](./utralib/Cargo.toml) file, in the -`default = [...]` arguments seen at the bottom of the file. If you have -built your own custom soc.svd file, the most convenient way to update +And it will pull from the default soc.svd configuration. + +The currently selected config is set by the constant `PRECURSOR_SOC_VERSION` +in [xtask/src/main.rs](./xtask/src/main.rs); it is one of the first constants +near the top. + +If you have built your own custom soc.svd file, the most convenient way to update to this is to simply replace the file referenced in the default with yours, and then run `cargo build` inside the `utralib` directory (not in the Xous root -- the `build` command must happen inside the directory to force a @@ -118,6 +121,10 @@ is checked into `git`; if you are building from your own configuration, that is correct, and thus you should add `--no-verify` to your `xtask` command to suppress the check. +Note that adding a full extra custom gitrev is more involved, it involves +editing the [utralib/Cargo.toml](./utralib/Cargo.toml) and [utralib/build.rs](./utralib/build.rs) +to reference your new artifact as a brand new feature flag. + The resulting images are in your target directory (typically `target/riscv32imac-unknown-xous-elf/release/`) with the names `xous.img` (for the kernel) and `loader.bin` (for its bootloader). The corresponding gateware is in `precursors/soc_csr-.bin`. These can be written to your diff --git a/RELEASE-v0.9.md b/RELEASE-v0.9.md index 582414aa3..39c4fe1c8 100644 --- a/RELEASE-v0.9.md +++ b/RELEASE-v0.9.md @@ -285,6 +285,11 @@ perform the Xous firmware upgrade. This requires running manual update commands, - Fix bug in device auto-shutdown; COM/LLIO method deprecated as susres method does the correct sequencing. This should help with some of the "insert paperclip" scenarios after updating SoC, hopefully. - Updated VexRiscv core to the latest version. STATIC branch prediction enabled and slightly faster I$ gives a small performance bump. Also fixes a bug with cache flushing that was causing coherence problems with the PDDB. - Fix tricky loader bug that was causing subtle issues with various build configurations +- Suppress main menu from popping up before the PDDB is mounted (resolves race conditions based on PDDB-stored keys) +- Optimize PDDB bulk key listing performance +- Add French language locale (thanks @tmarble!) +- Add `mtxcli` application, a basic Matrix chat interface (currently just https-secured, not E2EE). Thanks again @tmarble for the contribution! +- Several infrastructure changes/improvements to how utralib and crating works ## Roadmap - Lots of testing and bug fixes