1
0
mirror of https://github.com/google/comprehensive-rust.git synced 2025-03-25 07:32:40 +02:00

53 Commits

Author SHA1 Message Date
dependabot[bot]
4b7a874263
cargo: bump the patch group in /src/exercises/bare-metal/rtc with 1 update ()
Bumps the patch group in /src/exercises/bare-metal/rtc with 1 update:
[chrono](https://github.com/chronotope/chrono).

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-29 10:29:40 +00:00
dependabot[bot]
bc12c3820c
cargo: bump embedded-hal from 0.2.7 to 1.0.0 in /src/exercises/bare-metal/compass ()
Bumps [embedded-hal](https://github.com/rust-embedded/embedded-hal) from
0.2.7 to 1.0.0.

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-22 11:01:45 -08:00
dependabot[bot]
b4164e44a3
cargo: bump the minor group in /src/exercises/bare-metal/compass with 1 update ()
Bumps the minor group in /src/exercises/bare-metal/compass with 1
update: [lsm303agr](https://github.com/eldruin/lsm303agr-rs).

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-18 12:08:15 +00:00
dependabot[bot]
d7d3c9c6c1
cargo: bump the patch group in /src/exercises/bare-metal/rtc with 1 update ()
Bumps the patch group in /src/exercises/bare-metal/rtc with 1 update:
[bitflags](https://github.com/bitflags/bitflags).

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-18 11:09:51 +00:00
Martin Geisler
c9f66fd425
Format all Markdown files with dprint ()
This is the result of running `dprint fmt` after removing `src/` from
the list of excluded directories.

This also reformats the Rust code: we might want to tweak this a bit in
the future since some of the changes removes the hand-formatting. Of
course, this formatting can be seen as a mis-feature, so maybe this is
good overall.

Thanks to mdbook-i18n-helpers 0.2, the POT file is nearly unchanged
after this, meaning that all existing translations remain valid! A few
messages were changed because of stray whitespace characters:

     msgid ""
     "Slices always borrow from another object. In this example, `a` has to remain "
    -"'alive' (in scope) for at least as long as our slice. "
    +"'alive' (in scope) for at least as long as our slice."
     msgstr ""

The formatting is enforced in CI and we will have to see how annoying
this is in practice for the many contributors. If it becomes annoying,
we should look into fixing  so that `dprint` can annotate
the lines that need fixing directly, then I think we can consider more
strict formatting checks.

I added more customization to `rustfmt.toml`. This is to better emulate
the dense style used in the course:

- `max_width = 85` allows lines to take up the full width available in
our code blocks (when taking margins and the line numbers into account).
- `wrap_comments = true` ensures that we don't show very long comments
in the code examples. I edited some comments to shorten them and avoid
unnecessary line breaks — please trim other unnecessarily long comments
when you see them! Remember we're writing code for slides 😄
- `use_small_heuristics = "Max"` allows for things like struct literals
and if-statements to take up the full line width configured above.

The formatting settings apply to all our Rust code right now — I think
we could improve this with https://github.com/dprint/dprint/issues/711
which lets us add per-directory `dprint` configuration files. However,
the `inherit: true` setting is not yet implemented (as far as I can
tell), so a nested configuration file will have to copy most or all of
the top-level file.
2023-12-31 00:15:07 +01:00
Oscar
b037548923
Add mdbook-xgettext skip for untranslatable codeblocks in Bare Metal ()
See 

Removes 280 lines from `messages.pot`.

Signed-off-by: 0scvr <71343264+0scvr@users.noreply.github.com>
2023-10-11 09:32:12 +00:00
Martin Geisler
9f079f173b
Update all Cargo.lock files ()
This is the result of running `cargo update` in every directory.

It fixes a alert: https://github.com/advisories/GHSA-9mcr-873m-xcxp. We
don’t run any HTTP server directly, so this is not super important for
us. However, it will remove the alert from my dashboard.
2023-10-03 14:18:44 +02:00
Matthew
1c43db108b
Fix inconsistent filename styling ()
Addresses https://github.com/google/comprehensive-rust/issues/625

Pages with inconsistent styling:
[Bare Metal Rust Afternoon
Solutions](https://google.github.io/comprehensive-rust/exercises/bare-metal/solutions-afternoon.html)
[Concurrency Afternoon
Solutions](https://google.github.io/comprehensive-rust/exercises/concurrency/solutions-afternoon.html)
[Microcontroller > Debugging
Page](https://google.github.io/comprehensive-rust/bare-metal/microcontrollers/debugging.html)
2023-09-29 08:38:42 +02:00
Matthew
a492b2f1b2
Italic filenames formatted accordingly ()
**Task** Addresses:
https://github.com/google/comprehensive-rust/issues/625
Certain pages in the mdbook that display filenames have inconsistent
styling.

The style we want to follow: [the interop
section](https://google.github.io/comprehensive-rust/android/interoperability/java.html)

The current problem: [the RTC
driver](https://google.github.io/comprehensive-rust/exercises/bare-metal/rtc.html)
excercise page.

--
@mgeisler I checked this feature by looking through every page


![work](https://github.com/google/comprehensive-rust/assets/38759997/8affd0c2-71f2-4708-88f6-f63cf3c24efa)
2023-09-26 15:15:41 +02:00
Martin Geisler
991c437986
Trim off licenses when showing solutions ()
The licenses end up in the PO files, causing extra unnecessary for work
our translators. We save about 300 lines from each PO file with this.

This also solves another small problem: when a file is included with an
anchor, other anchors are automatically stripped away. This removes some
confusing `// ANCHOR: foo` and `// ANCHOR_END: foo` lines in the
solutions.
2023-09-18 11:56:55 +02:00
Martin Geisler
c7240f604f
Expand "iff" to "if and only if" in pl031.rs ()
* Expand "if" to "if and only if" in pl031.rs

Similar to .
2023-08-04 11:04:02 +01:00
Andrew Walbran
5a495a508e
Update Cargo.lock. ()
This was missed in .
2023-05-05 11:25:45 +01:00
Andrew Walbran
9cff14ca31
Link arm-gic to main documentation page rather than crate page () 2023-05-04 14:42:08 +00:00
Andrew Walbran
226aa21f3c
Use hyphen rather than underscore for gic-version ()
Older versions of QEMU seem to only accept a hyphen, while new versions accept either.
2023-05-04 15:41:15 +01:00
Andrew Walbran
93c1c814c3
Improve phrasing of comment ()
Some people interpreted the previous comment as meaning the RTC itself needed to be initialised or started somehow, but this is not the case.
2023-05-04 15:08:44 +01:00
Andrew Walbran
9d4a34c501
Use smccc crate rather than psci in examples and exercise. ()
It was renamed.
2023-04-27 10:54:48 +01:00
Eric Ye
9187bf0b5e
Add some more hints to the bare-metal RTC exercise ()
* Add some more hints to the bare-metal RTC exercise

I and several others had some difficulties with this part of the problem, especially with regards to knowing where the RTC was wired up and how to fully enable the GIC / interrupts, so add this information to the exercise.

* Remove extra semicolon.

---------

Co-authored-by: Andrew Walbran <qwandor@google.com>
2023-04-25 09:46:37 +01:00
Andrew Walbran
c5863f6642
Add optional extension to RTC exercise ()
* Add methods to mask and clear interrupts.

* Start on GICv3 driver.

* Enable and use RTC interrupt.

* WFI

* Add newtype for interrupt ID.

* Add extension to use interrupt.

* Add method to send an SGI.

* Silence warnings about unused methods in provided drivers.

* Implement Debug manually for IntId.

It's useful to say what kind of interrupt it is.

* Acknowledge and log interrupt.

We should end it as well, but doing so results in a loop unless we first
clear the match.

* cargo fmt with imports_granularity = "module"

* Use arm-gic crate rather than including driver in the example.
2023-04-17 15:38:51 +01:00
Andrew Walbran
87f1976589
cargo fmt with imports_granularity = "module" () 2023-04-16 20:57:59 +02:00
Andrew Walbran
d8e442b9cb
Extend bare metal afternoon exercise ()
* Add methods to set match register and check whether it matches.

* Add first extension to RTC exercise, using match register.

* No need for constants to be public.
2023-04-13 10:58:06 +01:00
Yuri Astrakhan
5cdb73387f
Inline format vars to make the format str simpler () 2023-04-06 12:00:10 +02:00
Andrew Walbran
86d8c4ae54 Rename exercise template directory and archive. 2023-04-05 16:28:07 +01:00
Andrew Walbran
9375126b3c Use comment rather than inline code to find filename. 2023-04-05 16:28:07 +01:00
Andrew Walbran
c17e8abbd7 Add links to exercise template archive. 2023-04-05 16:28:07 +01:00
dependabot[bot]
4338cd5744
Bump spin from 0.9.6 to 0.9.8 in /src/exercises/bare-metal/rtc ()
Bumps [spin](https://github.com/mvdnes/spin-rs) from 0.9.6 to 0.9.8.
- [Release notes](https://github.com/mvdnes/spin-rs/releases)
- [Changelog](https://github.com/mvdnes/spin-rs/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mvdnes/spin-rs/commits)

---
updated-dependencies:
- dependency-name: spin
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-04 08:54:30 +02:00
Andrew Walbran
aa1036af66 Add more hints for bare metal morning exercise. 2023-03-27 17:20:31 +01:00
Andrew Walbran
956c137e51 Format hints as bullet-points. 2023-03-27 17:20:31 +01:00
Andrew Walbran
d513109b92 Add Mac OS instructions for picocom too. 2023-03-27 17:20:31 +01:00
Andrew Walbran
6f83b97e69 Fix Markdown formatting. 2023-03-27 17:20:31 +01:00
Andrew Walbran
357f62e137 A compass doesn't tell us the temperature. 2023-03-27 17:20:31 +01:00
Andrew Walbran
8ed300d620 Fix Linux build of bare metal AP code. 2023-03-27 17:20:31 +01:00
Andrew Walbran
ae83778173 Show actual driver code on solution page. 2023-03-27 17:20:31 +01:00
Andrew Walbran
9c166d4e97 Set publish = false in examples and exercises. 2023-03-23 15:12:23 +00:00
Andrew Walbran
fa56c70dcb Get AP examples working on Mac OS too. 2023-03-23 15:06:23 +00:00
Andrew Walbran
fc36e40eef Make base address constants a pointer rather than a usize. 2023-03-23 15:06:23 +00:00
Andrew Walbran
fb3fd3979c Add RTC exercise. 2023-03-23 15:06:23 +00:00
dependabot[bot]
259dfcb1eb
Bump cortex-m-rt from 0.7.2 to 0.7.3 in /src/exercises/bare-metal/compass ()
Bump cortex-m-rt in /src/exercises/bare-metal/compass

Bumps [cortex-m-rt](https://github.com/rust-embedded/cortex-m) from 0.7.2 to 0.7.3.
- [Release notes](https://github.com/rust-embedded/cortex-m/releases)
- [Changelog](https://github.com/rust-embedded/cortex-m/blob/master/CHANGELOG.md)
- [Commits](https://github.com/rust-embedded/cortex-m/compare/v0.7.2...v0.7.3)

---
updated-dependencies:
- dependency-name: cortex-m-rt
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-03-20 14:44:56 +00:00
Andrew Walbran
e2d7bc56ec Add other files for compass exercise to exercise page. 2023-03-20 14:26:57 +00:00
Andrew Walbran
8513adfd3c Add more hints for compass exercise. 2023-03-20 14:26:57 +00:00
Andrew Walbran
a070573867 Expand IMU acronym first time. 2023-03-20 14:26:57 +00:00
Andrew Walbran
52f0c9ef64 Rename Day 5A to Bare Metal Rust. 2023-03-20 14:26:57 +00:00
Andrew Walbran
f40261646c Add option to display accelerometer rather than compass. 2023-03-20 14:26:57 +00:00
Andrew Walbran
8f2a851e95 Display accelerometer rather than compass. 2023-03-20 14:26:57 +00:00
Andrew Walbran
44a4b4b234 Display compass values on LEDs. 2023-03-20 14:26:57 +00:00
Andrew Walbran
82f4dab523 Get compass solution working and add more information. 2023-03-20 14:26:57 +00:00
Andrew Walbran
af0d97d1a7 Fix mdbook test. 2023-03-20 14:26:57 +00:00
Andrew Walbran
354834c711 Template, hint and extension for compass exercise. 2023-03-20 14:26:57 +00:00
Andrew Walbran
062129546a Temperature logger is no more. 2023-03-20 14:26:57 +00:00
Andrew Walbran
deff63f9a5 cargo-embed config 2023-03-20 14:26:57 +00:00
Andrew Walbran
78d1fc2836 Fill in solution for compass exercise. 2023-03-20 14:26:57 +00:00