Merge pull request #719 from uyjulian/regdesc_20250111

Improve register descriptions 20250111

Author: fjtrujy

common/include/dev5_mmio_hwport.h

@@ -22,61 +22,61 @@ typedef struct dev5_mmio_hwport_ /* base -> 0xBF402000 */
 	vu8 m_dev5_reg_001;
 	vu8 m_dev5_reg_002;
 	vu8 m_dev5_reg_003;
-	vu8 m_dev5_reg_004;
-	vu8 m_dev5_reg_005;
-	vu8 m_dev5_reg_006;
-	vu8 m_dev5_reg_007;
-	vu8 m_dev5_reg_008;
-	vu8 m_dev5_reg_009;
-	vu8 m_dev5_reg_00A;
-	vu8 m_dev5_reg_00B;
-	vu8 m_dev5_reg_00C;
-	vu8 m_dev5_reg_00D;
-	vu8 m_dev5_reg_00E;
-	vu8 m_dev5_reg_00F;
+	vu8 m_dev5_reg_004; /**< CDVDreg_NCOMMAND; Current N command (R/W) */
+	vu8 m_dev5_reg_005; /**< CDVDreg_READY / CDVDreg_NDATAIN; N command status (R) / N command param (W) */
+	vu8 m_dev5_reg_006; /**< CDVDreg_ERROR / CDVDreg_HOWTO; CDVD error (R) */
+	vu8 m_dev5_reg_007; /**< CDVDreg_ABORT; BREAK */
+	vu8 m_dev5_reg_008; /**< CDVDreg_PWOFF; CDVD I_STAT (R=Status, W=Acknowledge) */
+	vu8 m_dev5_reg_009; /* Accessed */
+	vu8 m_dev5_reg_00A; /**< CDVDreg_STATUS; CDVD drive status (R) */
+	vu8 m_dev5_reg_00B; /**< CDVDreg_STICKY_STATUS; Sticky drive status (R) */
+	vu8 m_dev5_reg_00C; /* Accessed */
+	vu8 m_dev5_reg_00D; /* Accessed */
+	vu8 m_dev5_reg_00E; /* Accessed */
+	vu8 m_dev5_reg_00F; /**< CDVDreg_TYPE; CDVD disk type (R) */
 	vu8 m_dev5_reg_010;
 	vu8 m_dev5_reg_011;
 	vu8 m_dev5_reg_012;
-	vu8 m_dev5_reg_013;
+	vu8 m_dev5_reg_013; /* Accessed */
 	vu8 m_dev5_reg_014;
-	vu8 m_dev5_reg_015;
-	vu8 m_dev5_reg_016;
-	vu8 m_dev5_reg_017;
-	vu8 m_dev5_reg_018;
+	vu8 m_dev5_reg_015; /* Accessed */
+	vu8 m_dev5_reg_016; /**< CDVDreg_SCOMMAND; Current S command (R/W) */
+	vu8 m_dev5_reg_017; /**< CDVDreg_SDATAIN; S command status (R), S command params (W) */
+	vu8 m_dev5_reg_018; /**< CDVDreg_SDATAOUT; S command result (R) */
 	vu8 m_dev5_reg_019;
 	vu8 m_dev5_reg_01A;
 	vu8 m_dev5_reg_01B;
 	vu8 m_dev5_reg_01C;
 	vu8 m_dev5_reg_01D;
 	vu8 m_dev5_reg_01E;
 	vu8 m_dev5_reg_01F;
-	vu8 m_dev5_reg_020;
-	vu8 m_dev5_reg_021;
-	vu8 m_dev5_reg_022;
-	vu8 m_dev5_reg_023;
-	vu8 m_dev5_reg_024;
+	vu8 m_dev5_reg_020; /* Accessed; Key block 0 data 0 */
+	vu8 m_dev5_reg_021; /* Accessed; Key block 0 data 1 */
+	vu8 m_dev5_reg_022; /* Accessed; Key block 0 data 2 */
+	vu8 m_dev5_reg_023; /* Accessed; Key block 0 data 3 */
+	vu8 m_dev5_reg_024; /* Accessed; Key block 0 data 4; used as the XOR key when enabled in CDVDreg_DEC */
 	vu8 m_dev5_reg_025;
 	vu8 m_dev5_reg_026;
 	vu8 m_dev5_reg_027;
-	vu8 m_dev5_reg_028;
-	vu8 m_dev5_reg_029;
-	vu8 m_dev5_reg_02A;
-	vu8 m_dev5_reg_02B;
-	vu8 m_dev5_reg_02C;
+	vu8 m_dev5_reg_028; /* Accessed; Key block 1 data 5 */
+	vu8 m_dev5_reg_029; /* Accessed; Key block 1 data 6 */
+	vu8 m_dev5_reg_02A; /* Accessed; Key block 1 data 7 */
+	vu8 m_dev5_reg_02B; /* Accessed; Key block 1 data 8 */
+	vu8 m_dev5_reg_02C; /* Accessed; Key block 1 data 9 */
 	vu8 m_dev5_reg_02D;
 	vu8 m_dev5_reg_02E;
 	vu8 m_dev5_reg_02F;
-	vu8 m_dev5_reg_030;
-	vu8 m_dev5_reg_031;
-	vu8 m_dev5_reg_032;
-	vu8 m_dev5_reg_033;
-	vu8 m_dev5_reg_034;
+	vu8 m_dev5_reg_030; /* Accessed; Key block 2 data A */
+	vu8 m_dev5_reg_031; /* Accessed; Key block 2 data B */
+	vu8 m_dev5_reg_032; /* Accessed; Key block 2 data C */
+	vu8 m_dev5_reg_033; /* Accessed; Key block 2 data D */
+	vu8 m_dev5_reg_034; /* Accessed; Key block 2 data E */
 	vu8 m_dev5_reg_035;
 	vu8 m_dev5_reg_036;
 	vu8 m_dev5_reg_037;
-	vu8 m_dev5_reg_038;
-	vu8 m_dev5_reg_039;
-	vu8 m_dev5_reg_03A;
+	vu8 m_dev5_reg_038; /**< CDVDreg_KEYSTATE */
+	vu8 m_dev5_reg_039; /**< CDVDreg_KEYXOR */
+	vu8 m_dev5_reg_03A; /**< CDVDreg_DEC */
 } dev5_mmio_hwport_t;
 
 #if !defined(USE_DEV5_MMIO_HWPORT) && defined(_IOP)

iop/network/spduart/src/spduart.c

@@ -23,25 +23,25 @@ extern struct irx_export_table _exp_spduart;
 // Reference: https://www.freebsd.org/doc/en_US.ISO8859-1/articles/serial-uart/index.html
 typedef struct uart16550_regs_
 {
-	u8 r_wrthr_rdrbr;
+	u8 r_wrthr_rdrbr; /**< write=transmit holding register (THR) / read=receive buffer register (RBR) */
 	u8 pad01;
-	u8 r_wrfcr_rdiir;
+	u8 r_wrfcr_rdiir; /**< write=fifo control register (FCR) / read=interrupt identification register */
 	u8 pad03;
-	u8 r_lcr;
+	u8 r_lcr; /**< line control register (LCR) */
 	u8 pad05;
-	u8 r_mcr;
+	u8 r_mcr; /**< modem control register (MCR) */
 	u8 pad07;
-	u8 r_lsr;
+	u8 r_lsr; /**< line status register (LSR) */
 	u8 pad09;
-	u8 r_msr;
+	u8 r_msr; /**< modem status register (MSR) */
 	u8 pad0B;
-	u8 r_scr;
+	u8 r_scr; /**< scratch register (SCR) */
 	u8 pad0D;
 	u8 pad0E;
 	u8 pad0F;
-	u8 r_cr1;
+	u8 r_cr1; /**< control register 1 (CR1) */
 	u8 pad11;
-	u8 r_cr2;
+	u8 r_cr2; /**< control register 2 (CR2) */
 	u8 pad13;
 } uart16550_regs_t;