Skip to content

Commit

Permalink
Docs edits
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinmehall committed Mar 3, 2024
1 parent 0a9b493 commit 3a26de9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ A new pure-Rust library for cross-platform low-level access to USB devices.
that is started when opening the first device.
* Thinner layer over OS APIs, with less internal state.

### :construction: Current status
### Current status

* Support for Linux, Windows, and macOS
* Control, bulk and interrupt transfers work
* Minimally tested: please test with your device and report issues
* Device listing and descriptor parsing
* Transfers on control, bulk and interrupt endpoints
* Used in production by [probe-rs](https://github.com/probe-rs/probe-rs) and others, but still relatively new. Please test with your device and report issues.

### License
MIT or Apache 2.0, at your option
5 changes: 3 additions & 2 deletions src/transfer/queue.rs
Original file line number Diff line number Diff line change
Expand Up @@ -216,8 +216,9 @@ where
/// device to reset the endpoint's data toggle and clear the halt / stall
/// condition, and resets the host-side data toggle.
///
/// Use this after receiving [`TransferError::Stall`] to clear the error and
/// resume use of the endpoint.
/// Use this after receiving
/// [`TransferError::Stall`][crate::transfer::TransferError::Stall] to clear
/// the error and resume use of the endpoint.
///
/// This should not be called when transfers are pending on the endpoint.
pub fn clear_halt(&mut self) -> Result<(), Error> {
Expand Down

0 comments on commit 3a26de9

Please sign in to comment.