comment clean up

design/sd/crc_gen.sv

@@ -1,5 +1,11 @@
-// parameterizable sequential crc generator
-// This probably could be combinational logic too, though it would be way slow
+/***
+ * crc_gen.sv - paramerizable sequential crc generator. This could probably be
+ *              combinational logic too (but it would be way slower)
+ *
+ * @author: Waylon Cude, Dilanthi Prentice
+ * @date: 6/12/2025
+ *
+ * */
 module crc_gen #(
     parameter CRCBITS=7,
     parameter COMMANDLEN=40,

design/sd/read_command.sv

@@ -1,3 +1,11 @@
+/****
+ * read_command.sv - reads the sd command line and listens for sd command
+ *                   responses.
+ * 
+ * @author: Waylon Cude, Dilanthi Prentice
+ * @date: 6/12/2025
+ *
+ * **/
 module read_command(
     input logic clk,
     input logic reset,
@@ -19,8 +27,8 @@ logic received_reg;
 
 logic [2:0] response_type_reg;
 
-// oops this was set a cycle before the data was actually ready
-// and if it's just a reg it holds for too long
+// recevied was set a cycle before the data was actually ready
+// and if it's just a register it holds for too long
 // use both for maximum reactivity
 assign received = received_reg && !listen;
 

design/sd/read_data.sv

@@ -1,6 +1,12 @@
-// Whenever we receive a data block, start spitting bytes out into the audio
-// buffer bram. This could always be clocked at the 25MHz default speed clock,
-// or it could switch over like the writer has to
+/***
+ * read_data.sv - whenever we receive a data block, start spitting bytes out
+ *                into the audio buffer block ram. This could be clocked at
+ *                25MHz default speed clock, or it could swtich over like the
+ *                writer has to.
+ * @author: Waylon Cude, Dilanthi Prentice
+ * @date: 6/12/2025
+ *
+ ***/
 module read_data(
     input clk,
     input reset,

design/sd/send_command.sv

@@ -1,3 +1,11 @@
+/***
+ * send_command.sv - sends sd card commands. It takes in a command and an
+ *                   argument and will figure out the necessary crc. 
+ *
+ * @author: Waylon Cude, Dilanthi Prentice
+ * @date: 6/12/2025
+ *
+ * */
 module send_command(
     input clk, 
     // The crc should be clocked way faster than the sender