Reorg TODO into sub-crates.traitify

3 files changed, 39 insertions, 66 deletions

diff --git a/TODO.org b/TODO.org
deleted file mode 100644
index fe8fc26..0000000
--- a/TODO.org
+++ /dev/null
@@ -1,66 +0,0 @@
-* Create trait library.
-We'll need traits for both the USB host driver and USB
-device/interface drivers.
-
-Right now everything's pretty tied together with no clean separation,
-but aside from a couple painful points it shouldn't be *too* hard to
-separate.
-
-So far we've managed to avoid needing an allocator, but that's
-probably gonig to be impossible in the general sense. However, it may
-be possible to limit allocation to just the device driver level, which
-is more pleasing since it's more fungible.
-
-* Use trait library for SAMD21/51 host implementation.
-Add features for max devices/endpoints to save on memory.
-
-* Use trait library for boot protocol keyboard driver.
-This code currently lives in `device.rs` and is also a disaster.
-** Parse configuration descriptors.
-
-
-* control/in/out_transfer probably shouldn't take a `&mut T`.
-This is pretty unsafe for functions that shouldn't be unsafe. Instead
-we should take a `&mut [u8]` and let callers be unsafe if they want
-0-copy. This would also allow us to more easily use variable-length
-responses in the few cases those are used.
-
-* Use channel for interrupt -> task messages.
-Currently we use a static mut which holds the latest event. This was
-done for expediency to try and get somethnig working and this was
-working in Arduino. It's also massively wrong in the general case and
-overflowing with race conditions.
-
-A channel will allow us to deterministically walk events and make sure
-everything's ordered properly.
-
-* Use endpoint packet size on pipe.
-The pipe is just using a max packet size of 8 bytes, regardless of
-what's on the endpoint. pcksize will need a function to take
-max_packet_size and convert it to the variant that is closest without
-going over.
-
-* Clean up pipe descriptor stuff.
-There's a bunch of unsafe functions that can be made safe.
-
-* Some SVD patches needed for SAMD21/51.
-There's a lot of `unsafe` code where there shouldn't be, because the
-SVD files are lacking.
-
-* Stop passing millis function around.
-This is horrible, but currently necessary because there are places
-where we need to loop on a timer at it needs to be
-hardware-independent.
-
-If the USB host library can be made asynchronouse, we could instead
-pass a current timestamp around and use that for delays where
-necessary.
-
-As a last resort, there's a countdown timer trait in embedded-hal that
-may be useful.
-
-* Tighten up timings on requests.
-There are a few timer checks on USB requests, but not necessarily of
-the right duration nor subdivided correctly. For instance, the
-setup-with-data cycle has requirements on total duration as well as
-per-packet duration, but currently we're only using the total.
diff --git a/bootkbd/TODO.org b/bootkbd/TODO.org
new file mode 100644
index 0000000..74636e9
--- /dev/null
+++ b/bootkbd/TODO.org
@@ -0,0 +1,5 @@
+* Parse HID descriptors.
+This driver currently assumes a fair amount of behavior on the part of
+the keyboard, which, for simple keyboards like the Logitech G105 I'm
+testing with, works. More complicated keyboards will probably require
+more in-depth probing and feature selection.
diff --git a/samd21-host/TODO.org b/samd21-host/TODO.org
new file mode 100644
index 0000000..bb8b5b0
--- /dev/null
+++ b/samd21-host/TODO.org
@@ -0,0 +1,34 @@
+* Use channel for interrupt -> task messages.
+Currently we use a static mut which holds the latest event. This was
+done for expediency to try and get somethnig working and this was
+working in Arduino. It's also massively wrong in the general case and
+overflowing with race conditions.
+
+A channel will allow us to deterministically walk events and make sure
+everything's ordered properly.
+
+
+* Clean up pipe descriptor stuff.
+There's a bunch of unsafe functions that can be made safe.
+
+* Some SVD patches needed for SAMD21/51.
+There's a lot of `unsafe` code where there shouldn't be, because the
+SVD files are lacking.
+
+* Stop passing millis function around.
+This is horrible, but currently necessary because there are places
+where we need to loop on a timer at it needs to be
+hardware-independent.
+
+If the USB host library can be made asynchronouse, we could instead
+pass a current timestamp around and use that for delays where
+necessary.
+
+As a last resort, there's a countdown timer trait in embedded-hal that
+may be useful.
+
+* Tighten up timings on requests.
+There are a few timer checks on USB requests, but not necessarily of
+the right duration nor subdivided correctly. For instance, the
+setup-with-data cycle has requirements on total duration as well as
+per-packet duration, but currently we're only using the total.