-
Notifications
You must be signed in to change notification settings - Fork 1
Fix technical inaccuracies in protocol data rates, type casts, and component descriptions #224
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,7 @@ \subsubsection{Example Const Use Case} | |
| \begin{lstlisting}[caption={Example use case of Const}, label={code:const-use-case}] | ||
| #include <stdint.h> | ||
|
|
||
| volatile const uint8_t* const UART_RECEIVE_REGISTER_READ_ONLY = (uint32_t*)0x12345678; | ||
| volatile const uint8_t* const UART_RECEIVE_REGISTER_READ_ONLY = (uint8_t*)0x12345678; | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. how tf did my very strict compiler warnings not ding this :/ |
||
|
|
||
| int main() { | ||
| uint8_t uart_receive_char = *UART_RECEIVE_REGISTER_READ_ONLY; // Valid C code! | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -32,10 +32,10 @@ \subsection{Digital Signalling} | |||||
| \hline | ||||||
| & Abbreviation & Name & Type & Bus & Duplex & Driver & Synchronicity & Typical Data Rate & Maximum Data Rate \\ \hline | ||||||
| & PWM & Pulse Width Modulation & Single Ended & Point to Point & Half-Duplex / Uni-directional & Push Pull & Asynchronous & 50 Hz & 200 Hz \\ \hline | ||||||
| & UART & Universal Asynchronous Receiver Transmitter & Single Ended & Point to Point & Full-Duplex & Push Pull & Asynchronous & 115.2 kHz & 921.6 kHz \\ \hline | ||||||
| & I2C & Inter-Interconnected Controller & Single Ended & Bus & Half-Duplex & Open Drain & Synchronous & 400 kHz & 1 MHz \\ \hline | ||||||
| & SPI & Serial Peripheral Interface & Single Ended & Bus & Full-Duplex & Push Pull & Synchronous & 24 MHz & 60 MHz \\ \hline | ||||||
| & CAN & Controller Area Network & Differential Pair & Bus & Half-Duplex & Open Drain & Asynchronous & 1 mbps & 8 mbps \\ \hline | ||||||
| & UART & Universal Asynchronous Receiver Transmitter & Single Ended & Point to Point & Full-Duplex & Push Pull & Asynchronous & 115.2 kbps & 921.6 kbps \\ \hline | ||||||
| & I2C & Inter-Integrated Circuit & Single Ended & Bus & Half-Duplex & Open Drain & Synchronous & 400 kbps & 1 Mbps \\ \hline | ||||||
|
||||||
| & I2C & Inter-Integrated Circuit & Single Ended & Bus & Half-Duplex & Open Drain & Synchronous & 400 kbps & 1 Mbps \\ \hline | |
| & I2C & Inter-Integrated Circuit & Single Ended & Bus & Half-Duplex & Open Drain & Synchronous & 400 kHz & 1 MHz \\ \hline |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SPI data rates should be expressed in Hz (clock frequency), not bps (bit rate). SPI is a synchronous protocol that uses a clock signal (SCK/SCLK), and its speed is specified by the clock frequency.
Change "24 Mbps" to "24 MHz" and "60 Mbps" to "60 MHz".
| & SPI & Serial Peripheral Interface & Single Ended & Bus & Full-Duplex & Push Pull & Synchronous & 24 Mbps & 60 Mbps \\ \hline | |
| & SPI & Serial Peripheral Interface & Single Ended & Bus & Full-Duplex & Push Pull & Synchronous & 24 MHz & 60 MHz \\ \hline |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DanielJPuratich is this legit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wow yea copilot is good. might be worth dropping the mention of BJTs at all or even this parenthesized comment entirely, seems like modern LDOs are entirely PMOS FETs? Googling around.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
aight imma yolo merge this for now