Update docs in rp2040-hal/src/pio.rs

Co-authored-by: Wilfried Chauveau <wilfried.chauveau@ithinuel.me>
This commit is contained in:
Jan Niehusmann 2021-11-25 17:38:18 +01:00 committed by GitHub
parent aafa3dd587
commit 15c162757f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -525,13 +525,13 @@ impl<SM: ValidStateMachine, State> StateMachine<SM, State> {
self.exec_instruction(instruction); self.exec_instruction(instruction);
} }
///Execute the instruction immediately. /// Execute the instruction immediately.
///
/// While this is allowed even when the state machine is running, the datasheet says:
/// > If EXEC instructions are used, instructions written to INSTR must not stall.
/// It's unclear what happens if this is violated.
pub fn exec_instruction(&mut self, instruction: u16) { pub fn exec_instruction(&mut self, instruction: u16) {
// This is allowed even if the state machine is running. // TODO: clarify what happens if the instruction stalls.
//
// However, the datasheet says:
// "If EXEC instructions are used, instructions written to INSTR must not stall"
// It's unclear what happens if this is violated.
self.sm.exec_instruction(instruction); self.sm.exec_instruction(instruction);
} }