mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-23 20:22:51 +01:00
Code Issues Projects Releases Packages Wiki Activity
1685 commits 46 branches 47 tags 189 MiB
Commit graph

252 commits

Author SHA1 Message Date
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
628c668988 Remove note about SLEEPONEXIT in Russian book 2021-12-14 22:19:16 +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
Andrey Zgarbul
9134f7d36a update russian book 2021-08-03 22:40:33 +03: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
Andrey Zgarbul
05bda2b1bd update russian translation of the book 2021-04-08 12:22:43 +03: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
Daniel Carosone
f386cb63cb Merge branch 'master' 
of https://github.com/rtic-rs/cortex-m-rtic
 2020-10-07 09:22:38 +11:00
bors[bot]
b1e1abae29
Merge #173 
173: add sandbox example r=AfoHT a=etrombly

Added a real world example for my sandbox project.

Co-authored-by: Eric Trombly <etrombly@yahoo.com>
 2020-10-06 18:37:33 +00:00
Emil Fresk
71a279f6d0 Split up migration guides into its own sections 2020-10-05 20:44:25 +02:00
bors[bot]
dbf9a7f298
Merge #368 
368: Mod over const r=korken89 a=AfoHT

Related [RFC](https://github.com/rtic-rs/rfcs/pull/34)

Dependent on [rtic-syntax-PR30](https://github.com/rtic-rs/rtic-syntax/pull/30)

~~Currently using my own dev-branch~~

Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
 2020-10-05 08:40:19 +00:00
Emil Fresk
f0f982faca Updated documentation to include the critical section token in init 2020-10-03 15:30:15 +02:00
Henrik Tjäder
40c7119d7a Prepare the book for v0.6 2020-10-02 12:36:34 +00:00
bors[bot]
97eae45fa5
Merge #375 
375: close console text blocks on a new line r=AfoHT a=dcarosone

fixes #369

Co-authored-by: Daniel Carosone <Daniel.Carosone@gmail.com>
 2020-10-02 11:17:56 +00:00
Daniel Carosone
3d6a0ea64f minor markdownlints 2020-10-02 20:43:52 +10:00
Daniel Carosone
91c2d4850e Shared access is useful with interior mutability 2020-10-02 19:56:17 +10:00
Henrik Tjäder
1482a25186 Describe the resource struct attribute migration steps 2020-10-02 09:55:25 +00:00
Henrik Tjäder
755bb191b6 Merge branch 'mod_const' of github.com:AfoHT/cortex-m-rtic into mod_const 2020-10-02 09:43:03 +00:00
Henrik Tjäder
e6bc673621 Clarify the need for resources-attribute 2020-10-02 09:42:50 +00:00
Daniel Carosone
baa2edfe72 close console text blocks on a new line 
fixes #369
 2020-10-02 19:38:00 +10:00
Henrik Tjäder
1e46ffdfbc
Merge branch 'master' into mod_const 2020-10-02 11:36:28 +02:00
Henrik Tjäder
9ca10b0d8c Add migration to 0.6 along with updated documentation 2020-10-02 09:33:28 +00:00
Henrik Tjäder
0cc556a75a Remove all of heterogeneous and homogeneous from the book 2020-10-01 19:12:54 +00:00
Henrik Tjäder
163edd7579 Start updating the book 2020-10-01 16:59:27 +00:00
Emil Fresk
e487b235eb Improved loop example docs to highlight that one cannot have empty loops in idle 2020-09-15 15:41:14 +02:00
bors[bot]
027b11f6b4
Merge #343 
343: Updated URL for example 'init.rs' file r=AfoHT a=regexident

(the file at tag '0.5.0' still uses `rtfm`, rather than `rtic` from tag '0.5.3' or later)

Co-authored-by: Vincent Esche <regexident@gmail.com>
 2020-07-15 06:55:05 +00:00
Vincent Esche
0616435ba6 Updated URL for example 'init.rs' file 
(the file at tag '0.5.0' still uses `rtfm`, rather than `rtic` from tag '0.5.3' or later)
 2020-07-14 16:26:03 +02:00
Vincent Esche
e9fa71c065 Fixed some more spelling 2020-07-14 16:01:14 +02:00
Vincent Esche
3b48447934 Unified spelling of "real-time" (vs. "real time") 
(This spelling is consistent with the one provided by Merriam Webster for use an an adjective)
 2020-07-14 16:00:42 +02:00
Emil Fresk
cfd5f4785e
Merge pull request #329 from rtic-rs/v0.5.3_release 
Preparing for v0.5.3
 2020-06-12 10:03:26 +02:00
Emil Fresk
5f860dcdf5 Updated book with migration guide for RTFM -> RTIC 2020-06-12 09:50:12 +02:00
Nicolas Stalder
ae5f2bc796 Link to GitHub from book 2020-06-11 21:27:57 +02:00
Henrik Tjäder
ff4370944f Small renaming fixes 2020-06-11 18:29:25 +00:00
Henrik Tjäder
602a5b4374 Rename RTFM to RTIC 2020-06-11 17:18:29 +00:00
KENTARO OKUDA
d44f5582d9 Update resources.md 2020-06-11 09:45:53 -04:00
KENTARO OKUDA
6e59dacdc3 Update app.md 2020-05-13 07:35:51 -04:00
Peter Taylor
a49d51c4d2
fix SLEEPONEXIT reference link in Russian version 2020-04-13 09:39:03 -06:00
Peter Taylor
02f965ef09
correct SLEEPONEXIT reference link 2020-04-13 09:32:49 -06:00
Henrik Tjäder
1a1a1e2167 Reference the correct example 2020-01-24 15:34:41 +00:00
Konstantin Mochalov
2be654116b
book, Russian lang: fix "idle not defined" typo 
Fix typo in Russian translation of book, was "When idle function is declared", should be "When no idle function is declared"
 2019-12-04 20:08:14 +03:00
Scott Mabin
864ec2ebc9 Update migration guide to include the enabling of the the DWT peripheral. Also makes note of enable trace with the DCB to allow the DWT to work without a debugger connected. 2019-12-03 11:33:24 +00:00
Jorge Aparicio
73d5fa31c2 remove references to 'beta' from the docs 2019-11-14 18:19:57 -05:00
Emil Fresk
76e234599f Added struct de-structure-ing example in tips & tricks 2019-11-07 14:12:16 +01:00
Emil Fresk
1ba2b5abbe Fixed peripherals -> device typo 2019-10-23 20:31:33 +02:00
Jorge Aparicio
1fe9767eba version v0.5 is still beta 2019-10-17 12:00:45 -05:00
bors[bot]
e82fb497f0
Merge #256 
256: add migration guide r=korken89 a=japaric



Co-authored-by: Jorge Aparicio <jorge@japaric.io>
 2019-10-17 06:16:43 +00:00
Jorge Aparicio
4b61c345eb ARMv7-M+ 2019-10-16 16:36:06 -05:00
Jorge Aparicio
66a1993f5d add migration guide 2019-10-16 14:39:02 -05:00
bors[bot]
47e4d99907
Merge #255 
255: more monotonic timer docs r=nils-grepit a=japaric

covers

- initialization and configuration of the timer; this is now a responsibility of
  the application author
- correctness of `Monotonic::now()` in `#[init]`
- safety of `Monotonic::reset()`

closes #251
cc @jonas-schievink

(EDIT: yay, pull request number 0xFF)

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
 2019-10-16 19:07:28 +00:00
Jorge Aparicio
1ccacf2102
Update book/en/src/by-example/timer-queue.md 
Co-Authored-By: Jonas Schievink <jonasschievink@gmail.com>
 2019-10-16 17:04:42 +00:00
Jorge Aparicio
eef4e7bf79 more monotonic timer docs 
covers

- initialization and configuration of the timer; this is now a responsibility of
  the application author
- correctness of `Monotonic::now()` in `#[init]`
- safety of `Monotonic::reset()`

closes #251
 2019-10-15 18:44:49 -05:00
bors[bot]
8a1f009c34
Merge #252 
252: critical sections book: each task gets its own context r=japaric a=chrysn

Fixing what was probably a copy-paste error; different tasks each have different types for their context.

Co-authored-by: chrysn <chrysn@fsfe.org>
 2019-10-15 22:43:59 +00:00
Jorge Aparicio
eb2ec7a4c8 v0.5.0 beta release 2019-10-15 16:35:00 -05:00
chrysn
bbd47e20ee
critical sections: each task gets its own context 
Fixing what was probably a copy-paste error; different tasks each have different types for their context argument.
 2019-10-10 16:42:26 +02:00
Jorge Aparicio
d08f965080 fix linkchecker warning 2019-09-17 20:40:34 +02:00
Jorge Aparicio
1e0cfa19ba fix more links 2019-09-17 19:55:55 +02:00
Jorge Aparicio
fa3872a7f6 update the CHANGELOG 
also fix link to the older documentation
 2019-09-17 19:47:29 +02:00
bors[bot]
f1a9d0bb29
Merge #241 
241: One more place links updated r=japaric a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
 2019-09-15 20:50:03 +00:00
Emil Fresk
c818a31058 Book fix 2019-09-15 22:08:28 +02:00
Jorge Aparicio
b410f309b7 link to older docs from the book 2019-09-15 21:00:49 +02:00
Jorge Aparicio
996bdf8f0c doc tweaks 2019-08-21 12:33:04 +02:00
Jorge Aparicio
7ca5bbf404 fix preempt example 2019-08-21 10:53:13 +02:00
Jorge Aparicio
009ca9a0be fix link 2019-08-21 10:28:07 +02:00
Jorge Aparicio
07b2b4d830 doc up 2019-08-21 10:17:27 +02:00
bors[bot]
6acb156482 Merge #189 
189: write generated code to disk for easier inspection r=japaric a=japaric

now that the generated code is actually readable let's make it easier to access

this commit also documents how to inspect the generated code via
`rtfm-expansion.rs` and `cargo-expand`

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
 2019-05-09 19:53:56 +00:00
Jorge Aparicio
ea02405ef0 document resolution and range of Instant and Duration 2019-05-08 19:48:12 +02:00
Jorge Aparicio
d1d2aff34b fix typo 2019-05-08 14:12:07 +02:00
Jorge Aparicio
d4eb4d2c47 write generated code to disk for easier inspection 
now that the generated code is actually readable let's make it easier to access

this commit also documents how to inspect the generated code via
`rtfm-expansion.rs` and `cargo-expand`
 2019-05-08 14:08:09 +02:00
Jorge Aparicio
09ec5a7a41 document internals 
note that this assumes that RFC #155 has been implemented
 2019-05-01 22:36:54 +02:00
Jorge Aparicio
ccd7f4586b book: indirection for faster message passing 2019-05-01 21:32:00 +02:00
Jorge Aparicio
3adc9c31f3 update the book 2019-05-01 20:49:25 +02:00
Jorge Aparicio
e865cbb2e5 book: resources shared with init must also be Send 2019-04-21 18:00:22 +02:00
Jorge Aparicio
c4bad51deb note that late resources must be Send 2019-04-21 18:00:22 +02:00
Eric Trombly
19212a9f70 update commit for example link and specify RTFM version 2019-04-21 09:21:33 -05:00
Eric Trombly
21db4d1df4 add sandbox example 2019-04-19 10:50:43 -05:00
Jorge Aparicio
aa7eec0299 check task priority at compile time 
before we were checking the priority at runtime. The compile time error message
when the priority is too high is kind of awful though.
 2019-04-16 23:04:24 +02:00
Andrey Zgarbul
028d5325ae (ru) binds 2019-02-27 00:27:05 +01:00
Jorge Aparicio
e167af01f0 document the binds feature 
cc @burrbull
 2019-02-26 23:22:34 +01:00
Zgarbul Andrey
3a03fd06d8
(ru) late resources 
According to 1e9058cab2
 2019-02-12 19:12:08 +03:00
Jorge Aparicio
1e9058cab2 (en) update the text related to late resources 
cc @burrbull
 2019-02-12 15:13:41 +01:00
Jorge Aparicio
91962d21fe (ru) fix includes in the preface 2019-02-12 11:04:54 +01:00
Jorge Aparicio
0007a35a27 change layout of books 2019-02-11 21:40:53 +01:00
Jorge Aparicio
45659fdbbc skeleton for the Russian translation of the book 2019-02-08 19:58:55 +01:00
Matt Kraai
17459b8f7d
Fix grammar 2018-12-21 12:52:57 -08:00
Matt Kraai
c61eb46149
Fix misspelling of "capacity" 2018-12-21 09:15:16 -08:00
Jorge Aparicio
5b032243e6 book: add some notes about the timer queue 2018-12-16 21:24:10 +01:00
Jorge Aparicio
d98f6c9a61 v0.4.0 2018-12-16 21:19:19 +01:00
Jorge Aparicio
34e74f4bb3 book: add an example of conditional compilation of resources and tasks 2018-12-16 20:57:04 +01:00
Jorge Aparicio
06c1e2f9b4 note that the timer queue is not supported on ARMv6-M 2018-12-16 19:38:22 +01:00