# sidd31082002/usb-3.0-device-driver architecture

> Architecture diagram of the GitHub repository sidd31082002/usb-3.0-device-driver, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sidd31082002/usb-3.0-device-driver
- Repository: https://github.com/sidd31082002/usb-3.0-device-driver

## Overview

This repository contains two experimental Linux USB mass-storage host drivers: root-level Bulk-Only Transport (BBB/BOT) and a separate USB Attached SCSI (UAS) module. In each, USB probe establishes transport state and runs SCSI commands; results are logged, with READ(10) inspecting sector zero. The graph preserves the documented inquiry, readiness, capacity, sense, and read capabilities. Some UAS command and BBB transport internals were not sampled, so their documented links cite the README rather than implying source inspection.

Main entry points: [`UAS_DRIVER_PROJECT/uas_main.c`](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_main.c) (UAS probe), [`UAS_DRIVER_PROJECT/include/uas_scsi.h`](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/uas_scsi.h) (UAS SCSI interface), [`usb3_driver.c`](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/usb3_driver.c) (BBB probe), [`UAS_DRIVER_PROJECT/uas_inquiry.c`](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_inquiry.c) (Inquiry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_bbb["BBB transport"]
  node_bbb_probe["BBB probe<br/>[usb3_driver.c]"]
  node_bbb_state["BBB device state<br/>[my_usb_dev.h]"]
  node_bbb_framing["CBW / CSW transport<br/>[bbb_transport.c]"]
  node_bbb_transport_api["Transport declarations<br/>[bbb_transport.h]"]
end

subgraph group_uas["UAS transport"]
  node_uas_probe["UAS probe<br/>[uas_main.c]"]
end

subgraph group_scsi["SCSI commands"]
  node_bbb_scsi_api["BBB SCSI interface<br/>[scsi_cmds.h]"]
  node_bbb_scsi["BBB SCSI commands<br/>[scsi_cmds.c]"]
  node_uas_tur["Test unit ready<br/>[uas_tur.c]"]
  node_uas_inquiry["Inquiry<br/>[uas_inquiry.c]"]
  node_uas_capacity["Read capacity<br/>[uas_capacity.c]"]
  node_uas_read10["Read sector<br/>[uas_read10.c]"]
end

subgraph group_uas_internal["UAS internals"]
  node_uas_state["UAS device state<br/>[my_uas_dev.h]"]
  node_uas_scsi_api["UAS SCSI interface<br/>[uas_scsi.h]"]
  node_uas_urb_api["URB callback interface<br/>[uas_urb.h]"]
  node_uas_callbacks["URB completion handlers"]
end

node_usb_host(("USB mass-storage device"))

node_usb_host -->|"binds to"| node_bbb_probe
node_bbb_probe -->|"stores state"| node_bbb_state
node_bbb_probe -->|"runs commands"| node_bbb_scsi
node_bbb_scsi -->|"uses transport"| node_bbb_framing
node_bbb_framing -->|"uses endpoints"| node_bbb_state
node_bbb_probe -->|"dispatches via"| node_bbb_scsi_api
node_bbb_scsi_api -->|"declares commands"| node_bbb_scsi
node_usb_host -->|"binds to"| node_uas_probe
node_uas_probe -->|"stores state"| node_uas_state
node_uas_probe -->|"runs readiness"| node_uas_tur
node_uas_probe -->|"runs inquiry"| node_uas_inquiry
node_uas_probe -->|"runs capacity"| node_uas_capacity
node_uas_probe -->|"reads sector"| node_uas_read10
node_uas_probe -->|"dispatches via"| node_uas_scsi_api
node_uas_scsi_api -->|"declares command"| node_uas_inquiry
node_uas_scsi_api -->|"declares command"| node_uas_capacity
node_uas_scsi_api -->|"declares command"| node_uas_read10
node_uas_scsi_api -->|"declares command"| node_uas_tur
node_uas_inquiry -->|"uses device state"| node_uas_state
node_uas_capacity -->|"stores capacity"| node_uas_state
node_uas_read10 -->|"locks and reads"| node_uas_state
node_uas_inquiry -->|"registers callbacks"| node_uas_callbacks
node_uas_capacity -->|"registers callbacks"| node_uas_callbacks
node_uas_read10 -->|"registers callbacks"| node_uas_callbacks
node_uas_callbacks -->|"implements callbacks"| node_uas_urb_api

click node_bbb_probe "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/usb3_driver.c"
click node_bbb_state "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/my_usb_dev.h"
click node_bbb_framing "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/bbb_transport.c"
click node_bbb_transport_api "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/bbb_transport.h"
click node_bbb_scsi_api "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/scsi_cmds.h"
click node_bbb_scsi "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/scsi_cmds.c"
click node_uas_probe "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_main.c"
click node_uas_state "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/my_uas_dev.h"
click node_uas_scsi_api "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/uas_scsi.h"
click node_uas_urb_api "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/uas_urb.h"
click node_uas_callbacks "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_urb_complete_functions.c"
click node_uas_tur "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_tur.c"
click node_uas_inquiry "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_inquiry.c"
click node_uas_capacity "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_capacity.c"
click node_uas_read10 "https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_read10.c"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_bbb_probe,node_bbb_state,node_bbb_framing,node_bbb_transport_api toneBlue
class node_uas_probe,node_usb_host toneAmber
class node_bbb_scsi_api,node_bbb_scsi,node_uas_tur,node_uas_inquiry,node_uas_capacity,node_uas_read10 toneMint
class node_uas_state,node_uas_scsi_api,node_uas_urb_api,node_uas_callbacks toneRose
```

## Components

### BBB transport

- [BBB probe](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/usb3_driver.c): `usb3_driver.c`
- [BBB device state](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/my_usb_dev.h): `include/my_usb_dev.h`
- [CBW / CSW transport](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/bbb_transport.c): `bbb_transport.c`
- [Transport declarations](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/bbb_transport.h): `include/bbb_transport.h`

### UAS transport

- [UAS probe](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_main.c): `UAS_DRIVER_PROJECT/uas_main.c`

### SCSI commands

- [BBB SCSI interface](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/include/scsi_cmds.h): `include/scsi_cmds.h`
- [BBB SCSI commands](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/scsi_cmds.c): `scsi_cmds.c`
- [Test unit ready](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_tur.c): `UAS_DRIVER_PROJECT/uas_tur.c`
- [Inquiry](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_inquiry.c): `UAS_DRIVER_PROJECT/uas_inquiry.c`
- [Read capacity](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_capacity.c): `UAS_DRIVER_PROJECT/uas_capacity.c`
- [Read sector](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_read10.c): `UAS_DRIVER_PROJECT/uas_read10.c`

### UAS internals

- [UAS device state](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/my_uas_dev.h): `UAS_DRIVER_PROJECT/include/my_uas_dev.h`
- [UAS SCSI interface](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/uas_scsi.h): `UAS_DRIVER_PROJECT/include/uas_scsi.h`
- [URB callback interface](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/include/uas_urb.h): `UAS_DRIVER_PROJECT/include/uas_urb.h`
- [URB completion handlers](https://github.com/sidd31082002/usb-3.0-device-driver/blob/main/UAS_DRIVER_PROJECT/uas_urb_complete_functions.c): `UAS_DRIVER_PROJECT/uas_urb_complete_functions.c`

### Other components

- **USB mass-storage device**

## Connections

- USB mass-storage device → BBB probe: binds to (evidence: `README.md`)
- BBB probe → BBB device state: stores state (evidence: `usb3_driver.c`)
- BBB probe → BBB SCSI commands: runs commands (evidence: `usb3_driver.c`)
- BBB SCSI commands → CBW / CSW transport: uses transport (evidence: `scsi_cmds.c`)
- CBW / CSW transport → BBB device state: uses endpoints
- BBB probe → BBB SCSI interface: dispatches via (evidence: `usb3_driver.c`)
- BBB SCSI interface → BBB SCSI commands: declares commands (evidence: `scsi_cmds.c`)
- USB mass-storage device → UAS probe: binds to (evidence: `README.md`)
- UAS probe → UAS device state: stores state (evidence: `UAS_DRIVER_PROJECT/uas_main.c`)
- UAS probe → Test unit ready: runs readiness (evidence: `UAS_DRIVER_PROJECT/uas_main.c`)
- UAS probe → Inquiry: runs inquiry (evidence: `UAS_DRIVER_PROJECT/uas_main.c`)
- UAS probe → Read capacity: runs capacity (evidence: `README.md`)
- UAS probe → Read sector: reads sector (evidence: `UAS_DRIVER_PROJECT/uas_main.c`)
- UAS probe → UAS SCSI interface: dispatches via (evidence: `UAS_DRIVER_PROJECT/uas_main.c`)
- UAS SCSI interface → Inquiry: declares command (evidence: `UAS_DRIVER_PROJECT/uas_inquiry.c`)
- UAS SCSI interface → Read capacity: declares command (evidence: `UAS_DRIVER_PROJECT/uas_capacity.c`)
- UAS SCSI interface → Read sector: declares command (evidence: `UAS_DRIVER_PROJECT/uas_read10.c`)
- UAS SCSI interface → Test unit ready: declares command (evidence: `UAS_DRIVER_PROJECT/uas_tur.c`)
- Inquiry → UAS device state: uses device state (evidence: `UAS_DRIVER_PROJECT/uas_inquiry.c`)
- Read capacity → UAS device state: stores capacity (evidence: `UAS_DRIVER_PROJECT/uas_capacity.c`)
- Read sector → UAS device state: locks and reads (evidence: `UAS_DRIVER_PROJECT/uas_read10.c`)
- Inquiry → URB completion handlers: registers callbacks (evidence: `UAS_DRIVER_PROJECT/uas_inquiry.c`)
- Read capacity → URB completion handlers: registers callbacks (evidence: `UAS_DRIVER_PROJECT/uas_capacity.c`)
- Read sector → URB completion handlers: registers callbacks (evidence: `UAS_DRIVER_PROJECT/uas_read10.c`)
- URB completion handlers → URB callback interface: implements callbacks (evidence: `UAS_DRIVER_PROJECT/uas_urb_complete_functions.c`)
