Skip to content

chore: align USB crate boundaries #1695

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.

Sign up for GitHub

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

Draft
Benoît Cortier (CBenoit) wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

chore: align USB crate boundaries #1695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e05f4fb
chore: align USB crate manifest policy
CBenoit Aug 18, 2026
7003997
docs(rdpeusb): document USB adapter boundaries
CBenoit Aug 18, 2026
9e254aa
docs: clarify USB allocation boundary
CBenoit Aug 18, 2026
40552c7
docs(rdpeusb): clarify USB translation invariant
CBenoit Aug 18, 2026
cfc8c48
.
CBenoit Aug 18, 2026
b97f50b
Apply suggestion from @CBenoit
CBenoit Aug 18, 2026
6059e36
chore: align USB publication and ownership
CBenoit Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,16 @@ PDU encoding and decoding.

_TODO_: clean up the dependencies

#### [`crates/ironrdp-usb`](./crates/ironrdp-usb)

@CBenoit Benoît Cortier (CBenoit) Aug 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct. However, I’ll not add fuzzing as part of this PR.

uchouT (@uchouT) is this a follow up you intended to do in the future?

@uchouT uchouT (uchouT) Aug 18, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, in my future plan, and #1690 seems to help.

@CBenoit Benoît Cortier (CBenoit) Aug 18, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right! I’ll go check it


Protocol-independent USB data structures, descriptor parsing, validation, and transfer semantics.

**Architectural Invariant**: the crate does not allocate.
Descriptor views borrow caller data, and transfer types are generic over caller-owned buffer and packet storage.

**Architectural Invariant**: parsing is limited to byte layouts defined by USB itself.
RDPEUSB, usbredir, and other transport framing belong in their corresponding protocol crates.

#### [`crates/ironrdp-graphics`](./crates/ironrdp-graphics)

Image processing primitives.
Expand Down Expand Up @@ -115,6 +125,13 @@ AUDIO_INPUT dynamic channel for client microphone capture implemented as describ
URBDRC dynamic channel state machines, PDU codecs, and USB device backend interfaces implemented as described in MS-RDPEUSB.
The crate performs no USB I/O; host device access belongs to a backend.

**Architectural Invariant**: the `usb` module translates protocol-independent `ironrdp-usb` operations and descriptor semantics into complete backend-facing RDPEUSB packets and maps USBD completions back.
The generated packet keeps its `TS_URB` payload, URB function code, transfer envelope, flags, and buffer shape consistent.
Selecting `TS_URB` forms and applying Windows USBD conventions remain in this crate.

**Architectural Invariant**: the `usb` module does not allocate request IDs, track device state, or manage pending-request lifetimes.
The channel state machines (`client` and `server`) and their backends own those responsibilities outside the translation module.

#### [`crates/ironrdp-rdpecam`](./crates/ironrdp-rdpecam)

Video capture dynamic channel client and backend boundary implemented as described in MS-RDPECAM.
Expand Down
4 changes: 4 additions & 0 deletions crates/ironrdp-usb/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,9 @@ authors.workspace = true
keywords.workspace = true
categories.workspace = true

[lib]
doctest = false
test = false

[lints]
workspace = true
Loading