You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
299: Make glossary more linkable and add more detail r=eldruin a=robyoung
While writing a blog post I found that I wanted to be able to link to a common definition of certain terms but I was not able to find one.
This change makes the glossary up from sub-headings so that each item can be linked to directly. I have also filled out some more detail on the areas I'm particularly interested in (BSP, HAL and PAC).
Things I'm not sure about:
- I am very new to embedded development so please review what I've written carefully, it may not be correct.
- I'm not sure how much detail to put here as there seems to be a bit of overlap with the [registers page](https://docs.rust-embedded.org/book/start/registers.html). I've gone with more detail here because I would like to link to these definitions from outside this book.
Co-authored-by: Rob Young <rob@robyoung.digital>
Co-authored-by: Rob Young <bubblenut@gmail.com>
Copy file name to clipboardExpand all lines: src/appendix/glossary.md
+58-10Lines changed: 58 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,61 @@ The embedded ecosystem is full of different protocols, hardware components and
4
4
vendor-specific things that use their own terms and abbreviations. This Glossary
5
5
attempts to list them with pointers for understanding them better.
6
6
7
-
Term | Meaning
8
-
-------------|--------
9
-
I2C | Sometimes referred to as `I² C` or Inter-IC. It is a protocol meant for hardware communication within a single integrated circuit. See [i2c.info] for more details
10
-
SPI | Serial Peripheral Interface
11
-
USART | Universal synchronous and asynchronous receiver-transmitter
0 commit comments