283 Commits

Author SHA1 Message Date
Jorge Aparicio
a5b5d074d5 new book -> debugonomicon 2018-11-14 13:41:14 +01:00
James Munns
9ddb8543d0 Link fixes, thanks CI! 2018-11-13 19:58:17 +01:00
James Munns
2e39514ee4 Index change, and some re-org 2018-11-13 19:49:35 +01:00
bors[bot]
aea18fb12a Merge #76
76: Re-working registers and peripherals r=japaric a=thejpster

As discussed in https://github.com/rust-embedded/book/issues/46

Co-authored-by: Jonathan 'theJPster' Pallant <github@thejpster.org.uk>
Co-authored-by: Jonathan Pallant <jonathan.pallant@cambridgeconsultants.com>
Co-authored-by: James Munns <james.munns@ferrous-systems.com>
2018-11-13 18:39:02 +00:00
James Munns
6248d8fca1 Remove Rusty chapter, is now covered by src/start/registers.md 2018-11-13 19:31:23 +01:00
Jonathan Pallant
c9465d790b Change reload to be a large value. 2018-11-13 18:01:22 +00:00
Jonathan Pallant
1e5eec0d09 Remove note to self. 2018-11-13 17:55:38 +00:00
Jonathan Pallant
96289d7fca Fix "read() does not take a closure". 2018-11-13 17:54:58 +00:00
bors[bot]
ec90335f16 Merge #74
74: edits to the introduction chapter r=jamesmunns a=japaric

see individual commit messages for details

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2018-11-10 15:06:06 +00:00
bors[bot]
9dc27f523a Merge #77
77: Update comments on heap availability on no_std. r=adamgreig a=thejpster

As per https://github.com/rust-embedded/book/issues/33.

Co-authored-by: Jonathan 'theJPster' Pallant <github@thejpster.org.uk>
2018-11-10 00:10:27 +00:00
Jorge Aparicio
483bf24abd getting started: add semihosting section 2018-11-10 00:33:38 +01:00
Jorge Aparicio
0d3f69dacf add missing word 2018-11-09 23:25:50 +01:00
Jonathan 'theJPster' Pallant
16c8d1f44d Update comments on heap availability on no_std.
As per https://github.com/rust-embedded/book/issues/33.
2018-11-09 21:36:00 +00:00
Jonathan 'theJPster' Pallant
3586910104 Spelling fixes. 2018-11-09 21:20:05 +00:00
Jonathan 'theJPster' Pallant
5f7d0e9416 Add a HAL example. 2018-11-09 21:14:06 +00:00
Jorge Aparicio
9da22bdd21 move sections around
explain the tools before showing the installation steps

cover no_std before the tooling
2018-11-09 21:38:41 +01:00
Jorge Aparicio
15c4b8f60b remove warnings 2018-11-09 21:38:41 +01:00
Jorge Aparicio
6ad3574b43 recommend 1.31-beta 2018-11-09 21:38:41 +01:00
Jorge Aparicio
d6ab8b0f65 s/version/section 2018-11-09 21:38:41 +01:00
Jorge Aparicio
a3b4dcbefd remove link to the second edition of the Rust book
its content is pretty similar to the 2018 edition and we want to reader to be
familiar with the 2018 edition so it's best to direct them to that version of
the Rust book
2018-11-09 21:38:41 +01:00
Jonathan 'theJPster' Pallant
dbadee6975 Added examples of using basic crates. 2018-11-09 16:35:31 +00:00
Jonathan 'theJPster' Pallant
d37a2a4030 Added introduction to arch/pac/hal/board crates in start/registers. 2018-11-09 16:00:27 +00:00
Jonathan 'theJPster' Pallant
fd4d7c5139 Moved the start/registers.md content into peripherals/ 2018-11-09 15:40:05 +00:00
Adam Green
ca53060125 Update doc URLs to new location
Documentation was recently moved to docs.rust-embedded.org and some of
the old links (to bookshelf content) now result in 404 errors.
2018-11-07 00:23:03 -08:00
bors[bot]
dd0760f6cd Merge #71
71: concurrency: small tweaks to the atomics section r=adamgreig a=japaric

r? @adamgreig

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2018-11-05 22:59:53 +00:00
bors[bot]
f0846613f7 Merge #67
67: Attempt to describe OpenOCD r=japaric a=adamgreen

This is my attempt to implement the OpenOCD TODO item in the 'Tooling'
section of Chapter 1.

I did move the OpenOCD section so that it comes after GDB since I
thought it made more sense to describe it after the user has already
been introduced to GDB as a debugger since it is OpenOCD which bridges
the gap between GDB and the ST-Link debugger hardware.

Feedback welcome!

Co-authored-by: Adam Green <adamgreen@users.noreply.github.com>
2018-11-05 01:14:04 +00:00
bors[bot]
b21265138b Merge #73
73: interop: point to the cstr-core and cty r=jamesmunns a=japaric

these are the no_std versions of std::ffi and std::os::raw

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
Co-authored-by: James Munns <james.munns@gmail.com>
2018-11-05 00:55:35 +00:00
James Munns
8d795dba74 fix typo
Co-Authored-By: japaric <jorge@japaric.io>
2018-11-05 01:54:09 +01:00
Jorge Aparicio
e8e8862dec fix paths 2018-11-05 01:41:06 +01:00
Jorge Aparicio
acf1670892 interop: point to the cstr-core and cty
these are the no_std versions of std::ffi and std::os::raw
2018-11-05 01:39:59 +01:00
Jorge Aparicio
cee9f35b03 concurrency: update RTFM description and link to documentation 2018-11-05 01:03:19 +01:00
Jorge Aparicio
691206d763 Relaxed is OK if the target is a single-core device
for a multi-core device AcqRel ordering for the fetch-add operation and Release
ordering for the store operation would have been required for correctness
2018-11-05 00:50:19 +01:00
bors[bot]
e31407284c Merge #68
68: canonicalize URLs r=therealprof a=japaric

as per #55

closes #55

this PR also ignores print.html when `linkcheck`-ing as done in
rust-embedded/discovery#142

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2018-11-04 23:34:24 +00:00
Jorge Aparicio
5abb337651 concurrency: AtomicUsize doesn't need be in a static mut variable 2018-11-05 00:29:16 +01:00
bors[bot]
a405849d1c Merge #69
69: collections: add `-Z emit-stack-sizes` link r=adamgreig a=japaric

also add a link to the `stack-sizes` tool

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2018-11-04 23:23:27 +00:00
Nathan
467740ea9f Fix typos 2018-11-04 15:13:18 -08:00
Jorge Aparicio
3cb10fec4b collections: add -Z emit-stack-sizes link
also add a link to the `stack-sizes` tool
2018-11-04 23:54:10 +01:00
Jorge Aparicio
e310669d0e canonicalize URLs
as per #55

closes #55
2018-11-04 23:44:15 +01:00
Adam Green
0865c5cc21 Attempt to describe OpenOCD
This is my attempt to implement the OpenOCD TODO item in the 'Tooling'
section of Chapter 1.

I did move the OpenOCD section so that it comes after GDB since I
thought it made more sense to describe it after the user has already
been introduced to GDB as a debugger since it is OpenOCD which bridges
the gap between GDB and the ST-Link debugger hardware.

Feedback welcome!
2018-10-31 17:43:47 -07:00
Adam Green
b4f3bcd971 Minor Chapter 1 updates
Mostly just fixing minor typos in chapter 1.

I did make a few changes to the table in the 'Other Resources' section
of the introduction:
* I added a brief description for the 'Embedded Rust Bookshelf' row.
* I added a period to the end of the FAQ description to keep it
  consistent with the other row descriptions.
2018-10-31 16:58:40 -07:00
bors[bot]
d7ee482fad Merge #40
40: Rework introduction r=jamesmunns a=Nicoretti

* Add "Who Embedded Rust is For" section
* Rework "Who This Book is for section" to be more inclusive
  but still state what knowlege is important to get more out of the book

References:
* https://github.com/rust-embedded/book/issues/3

Co-authored-by: Nicola Coretti <nico.coretti@gmail.com>
Co-authored-by: James Munns <james.munns@gmail.com>
2018-10-30 12:46:09 +00:00
James Munns
b2429ccc53 Update src/intro/introduction.md
Co-Authored-By: Nicoretti <nico.coretti@gmail.com>
2018-10-30 12:45:46 +01:00
James Munns
36216fe50d Update src/intro/introduction.md
Co-Authored-By: Nicoretti <nico.coretti@gmail.com>
2018-10-30 12:43:45 +01:00
bors[bot]
7656fbbd2b Merge #60
60: intro: replace use of 0666 permission by an ACL r=jamesmunns a=vincentbernat

With a modern installation, it is possible to give access to the
"current" user (the one physically in front of the machine) by tagging
a device with `uaccess`. This is better than using the 0666 permission,
which opens the device to the world.

Co-authored-by: Vincent Bernat <vincent@bernat.ch>
2018-10-30 10:07:43 +00:00
James Munns
1d45351f5e Update src/portability/portability.md
Co-Authored-By: therealprof <daniel@eggers-club.de>
2018-10-30 10:46:39 +01:00
James Munns
2c339bfa24 Update src/portability/portability.md
Co-Authored-By: therealprof <daniel@eggers-club.de>
2018-10-30 10:46:10 +01:00
James Munns
32173c42a0 Update src/portability/portability.md
Co-Authored-By: therealprof <daniel@eggers-club.de>
2018-10-30 10:45:46 +01:00
James Munns
59b7cf9e3c Update src/portability/portability.md
Co-Authored-By: therealprof <daniel@eggers-club.de>
2018-10-30 10:45:30 +01:00
Daniel Egger
e28351dc68 Draft of a portability chapter explaining the HAL 2018-10-30 00:31:13 +01:00
Nicola Coretti
524f523980 Update "Who This Book is For" section
Make sure reader won't be taken aback by stating a solid
embedded/rust knowlege is a prerequisite.
2018-10-26 15:35:54 +02:00