add sd/README.md

2026-08-03 06:27:47 +00:00 · 2024-01-23 20:21:27 -03:00
parent 4d0d8e9c14
commit e14fbf6d3d
2 changed files with 9 additions and 0 deletions
@@ -1,2 +1,11 @@
 ## `sd` package

+File map:
+* `blockdevice.go`: Contains logic for creating an `io.WriterAt` and `io.ReaderAt` with the `sd.BlockDevice` concrete type
+     from the `sd.Card` interface which is intrinsically a blocked reader and writer. 
+
+* `spicard.go`: Contains the `sd.SpiCard` driver for controlling an SD card over SPI using the most commonly available circuit boards. 
+
+* `responses.go`: Contains a currently unused SD response implementations as per the latest specification.
+
+* `definitions.go`: Contains SD Card specification definitions such as the CSD and CID types as well as encoding/decoding logic, as well as CRC logic.