Henrik Tjäder
8d46fb9cf9
Book: Add mermaid files
2023-03-01 00:33:40 +01:00
Henrik Tjäder
d3cadac90b
Book: Enable mermaid for mdbook
2023-03-01 00:33:39 +01:00
Per Lindgren
1f51b10297
Book: Major rework for RTIC v2
2023-03-01 00:33:39 +01:00
John van der Koijk
04189cc684
Mostly editorial review.
2023-01-25 21:07:38 +01:00
Nathan
baffeaca22
Fix Unicode ✓
2023-01-04 17:18:48 -06:00
Henrik Tjäder
9c68b876f1
Enable the targets chapter
2023-01-04 21:20:24 +01:00
Nathan
80b81ef122
Update example with SRP priority ceiling
2022-12-29 10:21:54 -06:00
n8tlarsen
27d41c1a38
Revert recommended starting template
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-21 17:02:11 -06:00
n8tlarsen
dd1fb68f42
Possessive its
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-19 18:18:04 -06:00
n8tlarsen
c688b601f1
typo
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-19 18:17:06 -06:00
n8tlarsen
70ebcc409f
Clarify BASEPRI and NVIC interaction
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-19 18:16:25 -06:00
n8tlarsen
60132495d9
Expand lock explanation
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-19 17:48:52 -06:00
n8tlarsen
c8d60d2910
Improve basepri explanation
...
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2022-12-19 17:45:53 -06:00
Nathan
f52b5fd1c4
Add documentation for different targets
2022-12-16 11:39:28 -06:00
Emil Fresk
9afb1f888f
Docs on RTOS
2022-12-14 21:04:31 +01:00
Jonas Jacobsson
ccbaea82aa
.toml and note aboute target
2022-09-27 15:29:03 +00:00
Emil Fresk
a7a8f9f4ed
Fix error in book, shared resource need only Send
2022-03-20 12:40:30 +01:00
Riccardo Casatta
750b1853ad
Update software_tasks.md
2022-03-07 21:05:34 +01:00
bors[bot]
5a186feb16
Merge #603
...
603: Add a remark about `Sync` and `Send` traits requirement for resources r=AfoHT a=Glaeqen
Co-authored-by: Gabriel Górski <glaeqen@gmail.com>
2022-02-11 08:41:53 +00:00
Henrik Tjäder
a8a55a3913
Docs: Fix dated migration docs for spawn
2022-02-10 10:25:50 +01:00
Gabriel Górski
44f994dea2
Add a remark about Sync and Send traits requirement for resources
2022-02-08 19:25:24 +01:00
Henrik Tjäder
7af09cb126
book: Restore accidentally removed files
2022-02-08 19:08:29 +01:00
Henrik Tjäder
a39d306649
Docs: SW and HW tasks
2022-02-05 13:38:01 +01:00
Robert Jördens
c83a69599a
use permalinks for (currently broken) mono links
2022-02-04 11:25:34 +01:00
Robert Jördens
c7f6e924dc
Update tips_monotonic_impl.md
...
* There is no RTIC 0.6, only several RCs.
* Timers without interrupts (like the DWT cycle counter alone) will not be useful for `Monotonic` impls.
* Clarified some of the descriptions of the various implementations.
2022-02-03 12:58:50 +01:00
Erik
2b07e3e0dc
Fix running command examples in chapter 1.5.5 Monotonic
2022-01-24 12:27:42 +01:00
Henrik Tjäder
a34f0205b3
Highlight how to run examples locally
2022-01-21 13:28:14 +01:00
Mareq Balint
ce6e014cf0
Correct grammar in 1.5.2 Software tasks & spawn
2022-01-07 22:33:23 +00:00
Mareq Balint
3da25c75cf
Correct wording in 1.2 Resource usage
2022-01-07 22:31:30 +00:00
Emil Fresk
68fb811a11
Added nRF52 RTC based monotonic to the book
2021-12-26 10:19:04 +01:00
Henrik Tjäder
2d8252f3e5
Promote v1.0 in docs
2021-12-25 16:18:28 +01:00
perlindgren
e249813ad7
Update preface.md
...
polish
2021-12-21 19:55:05 +01:00
perlindgren
d3d650b2c7
Update tips_monotonic_impl.md
...
text polishing
2021-12-21 19:49:09 +01:00
perlindgren
278207e2ec
Update monotonic.md
...
high granularity -> fine grained
2021-12-21 19:43:45 +01:00
Henrik Tjäder
1b1b077961
Review fixup
2021-12-19 10:03:18 +01:00
Henrik Tjäder
e232d7e9df
Docs: New project touchup
2021-12-19 01:33:16 +01:00
Henrik Tjäder
56822dd3b8
Docs: Tips touchup
2021-12-19 01:33:16 +01:00
Henrik Tjäder
a2caef394c
Docs: Point to rtic-examples repo
2021-12-19 01:33:16 +01:00
Henrik Tjäder
8e68c52721
Docs: Migration docs
2021-12-19 01:33:15 +01:00
Henrik Tjäder
833e22da51
Docs: By-example Monotonics
2021-12-19 01:33:15 +01:00
Henrik Tjäder
c55016f4b2
Docs: By-example App priorities and message passing
2021-12-19 01:33:15 +01:00
Henrik Tjäder
2ac0e1b29d
Docs: By-example Software tasks
2021-12-19 01:33:14 +01:00
Henrik Tjäder
4357d8be15
Docs: By-example
2021-12-19 01:33:14 +01:00
Henrik Tjäder
8c8f7f12c3
Idle: Switch to NOP instead of WFI
...
Add example how to get old WFI behaviour
2021-12-14 22:18:17 +01:00
Emil Fresk
c060b5a15c
Example monotonic for nRF52
2021-11-10 13:46:34 +01:00
Emil Fresk
1a949b5fd4
Remove example impl and have a list of example impls instead
2021-11-10 10:25:09 +01:00
Emil Fresk
3b00a2bdb8
Updated the monotonic impl chapter
2021-11-10 09:51:45 +01:00
Emil Fresk
f37a928c36
Fixing bad english
2021-09-27 13:42:44 +02:00
Emil Fresk
63c6a6afc0
More docs updates
2021-09-27 10:20:19 +02:00
Emil Fresk
b71df58f2f
The great docs update
2021-09-23 16:11:04 +02:00
Alex Martens
81a7722ab6
Fix link for SLEEPONEXIT
2021-08-26 14:29:18 -07:00
bors[bot]
8ddfcf8efc
Merge #504
...
504: Add links to RTIC book dev version and rtic-examples r=japaric a=AfoHT
Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2021-08-03 15:32:52 +00:00
CuriouslyCurious
f6f61f95a6
book: Properly update the note with a link
2021-07-30 12:44:35 +02:00
CuriouslyCurious
ae7b444f3d
Revert "book: Add link to new.md"
...
This reverts commit 7a977f3fa9
2021-07-30 12:43:35 +02:00
CuriouslyCurious
7a977f3fa9
book: Add link to new.md
2021-07-29 13:58:21 +02:00
CuriouslyCurious
e90e6332f6
book: Clarify target notice
2021-07-29 00:29:34 +02:00
CuriouslyCurious
007665eeee
book: Add note to remember to choose target
2021-07-28 13:55:12 +02:00
Henrik Tjäder
5477ae288f
Also link to rtic-examples in the tips section of the book
2021-07-27 20:04:56 +02:00
bors[bot]
adb4bc4c4e
Merge #502
...
502: book/resources: highlight that `#[lock_free]` includes a compile-time check r=AfoHT a=japaric
for the "same priority requirement"; this prevents data races
Co-authored-by: Jorge Aparicio <jorge.aparicio@ferrous-systems.com>
2021-07-22 10:51:16 +00:00
bors[bot]
b6e8e37c3c
Merge #500
...
500: migration/0.5: cover #[lock_free] r=AfoHT a=japaric
I think this completes #488
Co-authored-by: Jorge Aparicio <jorge.aparicio@ferrous-systems.com>
2021-07-22 10:45:46 +00:00
Jorge Aparicio
3eac8b91cf
book/resources: highlight that #[lock_free] includes a compile-time check
...
for the "same priority requirement"; this prevents data races
2021-07-22 10:35:09 +02:00
Jorge Aparicio
a7ed040799
migration/0.5: cover #[lock_free]
...
I think this completes #488
2021-07-22 09:27:42 +02:00
Jorge Aparicio
5805a05fac
book/resources: rm #[task_local] mention; add #[lock_free] example
...
the #[task_local] attribute was removed
2021-07-22 09:17:39 +02:00
Jorge Aparicio
cd4e8183f6
book/resources: remove mentions of the field attribute #[init(<expr>)]
...
it no longer exists. all resources are now late resources
2021-07-21 15:59:08 +02:00
Jorge Aparicio
6bf1c76d84
book/resources: do not use the lock API in the very first example
...
instead stick to `#[local]` resources
2021-07-21 15:55:14 +02:00
Jorge Aparicio
18880406cb
use tuple struct syntax for Monotonics everywhere
2021-07-21 10:14:00 +02:00
Jorge Aparicio
5f7dc0b903
update the 0.5.x -> 0.6.0 migration guide
...
to use the new resources syntax
I also reordered the sections to cover all the resource API first before covering the spawn API
I've also added a section about the old `static mut` variable transform
2021-07-21 10:11:43 +02:00
Valentin Ochs
c4c964de7b
Change misleading documentation left over by PR #464
2021-07-20 14:37:13 +02:00
Andrey Zgarbul
e4319de3d5
const generics
2021-07-09 18:44:19 +03:00
Alex Martens
1beeebd797
Fix syntax error in migration guide
2021-07-01 17:09:07 -07:00
bors[bot]
e6a22aa48e
Merge #479
...
479: book: detail import resolving for 0.6 migration r=korken89 a=tmplt
That is, answering the question of why imports are no longer resolving during compilation.
Co-authored-by: Viktor Sonesten <v@tmplt.dev>
2021-04-22 13:05:43 +00:00
Viktor Sonesten
1d5f129544
book/migration/v5: update init signature, fix example syntax
...
The example now migrates from v5 to v6 instead of an incorrect v6 syntax
to a another incorrect v6 syntax.
2021-04-21 15:38:00 +02:00
Viktor Sonesten
cfc97488db
book: detail import resolving for 0.6 migration
2021-04-21 15:25:58 +02:00
Viktor Sonesten
374a1c2add
book: update outdated required init signature
2021-04-21 15:00:53 +02:00
Barnaby Walters
f7767aabea
Minor grammar correction
...
you -> your
2021-02-05 23:09:06 +01:00
Emil Fresk
d36410a272
New logo, new text
2020-11-19 19:20:20 +01:00
Henrik Tjäder
d1517e436e
Use SVG logo instead
2020-11-17 15:07:48 +00:00
Henrik Tjäder
3aeb91bad6
Add the logo to the book preface
2020-11-16 22:46:19 +01:00
Emil Fresk
d079949139
Add multilock to the book
2020-11-14 16:13:00 +01:00
Henrik Tjäder
b5ff671f89
Disable things which needs more work to be complete
2020-11-12 20:08:11 +00:00
bors[bot]
ebfabd7b30
Merge #411
...
411: Add section about task_local and lock_free r=perlindgren a=AfoHT
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2020-11-12 18:34:05 +00:00
bors[bot]
65d0ee1f8e
Merge #408
...
408: Fixup app/new r=perlindgren a=AfoHT
Reference the current example
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2020-11-12 18:29:58 +00:00
Henrik Tjäder
b0f6d60c3d
Add static mut
2020-11-12 18:24:57 +00:00
bors[bot]
445730756e
Merge #410
...
410: resources r=AfoHT a=perlindgren
resources
Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2020-11-12 18:23:24 +00:00
Henrik Tjäder
29b81a23d6
Add section about task_local and lock_free
2020-11-12 18:15:42 +00:00
Per Lindgren
15bd129161
resources fix
2020-11-12 19:06:56 +01:00
Per Lindgren
0cb7cb0ba8
resources
2020-11-12 18:55:11 +01:00
bors[bot]
98f0a96104
Merge #409
...
409: Updated send/sync docs r=AfoHT a=korken89
Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2020-11-12 17:53:18 +00:00
Emil Fresk
0a578c76ca
Updated send/sync docs
2020-11-12 18:46:24 +01:00
Henrik Tjäder
95a020c8af
Fixup app/new
2020-11-12 17:45:12 +00:00
Emil Fresk
d25017a59c
Fixed spawn and timer queue docs
2020-11-12 18:42:07 +01:00
bors[bot]
5b8b2383e1
Merge #405 #406
...
405: Updated migration guide with symmetric locks and new spawn r=AfoHT a=korken89
406: book.toml/by-example/app r=korken89 a=perlindgren
Book update
Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2020-11-12 17:24:44 +00:00
Per Lindgren
91ea1e428b
book.toml/by-example/app
2020-11-12 18:20:16 +01:00
Emil Fresk
5e3bbada63
Updated migration guide with symmetric locks and new spawn
2020-11-12 18:19:00 +01:00
Henrik Tjäder
1709d1c9c6
Fixup app/tips
2020-11-12 17:15:33 +00:00
Per Lindgren
96cd625223
extern task
2020-10-29 19:29:46 +01:00
Per Lindgren
1c244a995d
move dispatchers to app argument
2020-10-23 23:58:09 +02:00
Dion Dokter
7a57f16860
Made relation between priority and number explicit
...
When quickly reading through the priorities chapter, I couldn't find in which order the priorities were, so I assumed it was the same as in the hardware.
In the cortex-m hardware, interrupts with the **lower** priority number will preempt the other interrupts.
RTIC does the reverse, so I think it's good to be more explicit about it.
2020-10-15 17:45:34 +02:00
Daniel Carosone
efe6b516fb
device path must be absolute; clarify
2020-10-13 10:45:03 +11:00
Daniel Carosone
987332b831
minor md lints and wording clarification
2020-10-07 09:31:30 +11:00
