-
Notifications
You must be signed in to change notification settings - Fork 87
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
Update pico usb serial interrupt #37
base: main
Are you sure you want to change the base?
Conversation
fb5b54a
to
9b68598
Compare
The changes look good, but I wonder why the CI actions did not run for this branch? |
It migth have been because it PR was initially targetting another branch (hal-0.9). |
9b68598
to
f46db13
Compare
// The USB Bus Driver (shared with the interrupt). | ||
static mut USB_BUS: Option<UsbBusAllocator<hal::usb::UsbBus>> = None; |
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.
Is the last part of the comment "(shared with the interrupt)" not incorrect? The interrupt function (fn USBCTRL_IRQ()
) shouldn't be able to reference the USB_BUS
, because USB_BUS
is out of scope.
// Grab a reference to the USB Bus allocator. We are promising to the | ||
// compiler not to take mutable access to this global variable whilst this | ||
// reference exists! | ||
let bus_ref = unsafe { USB_BUS.as_ref().unwrap() }; | ||
let bus_ref = USB_BUS.as_mut().unwrap(); |
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.
Is this part of the comment "We are promising to the compiler not to take mutable access to this global variable whilst this reference exists!" not incorrect too? The compiler will stop you from taking a second mutable reference and the USB_BUS
is local to the #[entry]
function.
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.
Indeed, this comment is no longer relevant thanks to the #[entry]
trick, the compiler is able to check we're not doing anything silly there.
// Trait required to use `writeln!(…)` | ||
use core::fmt::Write; | ||
|
||
// A system wide mutex synchrinising IRQ & cores |
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.
There is a typo (synchrinising -> synchronising or synchronizing).
#[allow(non_snake_case)] | ||
#[exception] | ||
fn SysTick() { | ||
do_with_usb(|usb| usb.usb_device.poll(&mut [&mut usb.usb_serial])); |
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.
A comment like "Keeps the usb_device updated in case the usb interrupt is not called often." or a better explanation why this is advisable might be useful here for people like me who only have a superficial understanding of embedded software development.
/// infinite loop. | ||
#[entry] | ||
fn main() -> ! { |
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.
Wouldn't a comment like "never ending function, except when the pico is reset to usb boot." not be more appropriate?
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.
Good spot, this text is actually inconsistent with the example.
@Agent59 thank you for your reviews! This last push should address your comments. Let me know if you see anything else :) |
2bf2c0c
to
37a124c
Compare
Preceding PR: