summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2021-04-16 23:56:40 +0300
committerYuval Adam <_@yuv.al>2021-04-17 10:33:57 +0300
commitc430b4b2f5467a0b86d2312f742e5b4ece4f4bad (patch)
treefab4ed16477ee94a3527f131bfe9c521345427de /README.md
parentcc3a300afcba8fffaee5feb5f56792cfd697bf28 (diff)
Cleanup deinit and document lifecyclev0.2
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index 94e1af1..c114db7 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,22 @@ Since there isn't (?) any good USB device mocking setup, for tests to pass an RT
## Design
-Similarly to the original rtl-sdr driver, we use libusb via the `rusb` bindings as the main interface to issue commands to the rtl-sdr USB dongle.
+### Overview
+
+RusTL-SDR is very similar to the original rtl-sdr driver. It uses libusb, via the [rusb](https://github.com/a1ien/rusb/) bindings, as the main interface to issue commands to the rtl-sdr USB dongle.
+
+### Lifecycle
+
+Devices generally go through the following lifecycle:
+
+1. Get a libusb context/handle, and find a compatible and supported RTL-SDR device
+2. Initialize the device baseband
+3. Probe the device for known tuners via the I2C interface
+4. Run any special initialization required for the detected tuner
+5. Interact with the device, usually this is where samples are read
+6. Deinitialize the tuner
+7. Deinitialize the baseband
+8. Close the USB handle
## License