18 files changed, 141 insertions, 31 deletions
diff --git a/lib/ultralib/src/voice/voicecheckresult.c b/lib/ultralib/src/voice/voicecheckresult.c
index 5318652..625200e 100644
--- a/lib/ultralib/src/voice/voicecheckresult.c
+++ b/lib/ultralib/src/voice/voicecheckresult.c
@@ -1,5 +1,9 @@
+/**
+ * File: voicecheckresult.c
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicecheckword.c b/lib/ultralib/src/voice/voicecheckword.c
index 05c2a59..9d2e3f8 100644
--- a/lib/ultralib/src/voice/voicecheckword.c
+++ b/lib/ultralib/src/voice/voicecheckword.c
@@ -1,12 +1,18 @@
+/**
+ * File: voicecheckwork.c
+ *
+ * Checks whether or not a word can be registered in the dictionary
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 
 s32 osVoiceCheckWord(u8* word) {
     s32 k;
     s32 ret = 0;
     u16 sjis;
-    u16 old = 0;
+    u16 old = '\0';
 
     for (k = 0; word[k] != 0; k += 2) {
         sjis = (word[k] << 8) + word[k + 1];
diff --git a/lib/ultralib/src/voice/voicecleardictionary.c b/lib/ultralib/src/voice/voicecleardictionary.c
index 6ed1464..ed43c1d 100644
--- a/lib/ultralib/src/voice/voicecleardictionary.c
+++ b/lib/ultralib/src/voice/voicecleardictionary.c
@@ -1,5 +1,17 @@
+/**
+ * File: voicecleardictionary.c
+ *
+ * Initializes Voice Recognition System word registration dictionary.
+ *
+ * The dictionary is initialized so that the specified "numWords" can be
+ * registered in the dictionary. 1-255 words can be registered in the dictionary.
+ *
+ * Words cannot be registered with the osVoiceSetWord before the dictionary
+ * is initialized with the osVoiceClearDictionary function
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicecontread2.c b/lib/ultralib/src/voice/voicecontread2.c
index a204ffc..083637a 100644
--- a/lib/ultralib/src/voice/voicecontread2.c
+++ b/lib/ultralib/src/voice/voicecontread2.c
@@ -1,9 +1,14 @@
+/**
+ * File: voicecontread2.c
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/controller_voice.h"
-#include "io/siint.h"
+#include "PRinternal/controller_voice.h"
+#include "PRinternal/siint.h"
 
 #define READ2FORMAT(ptr) ((__OSVoiceRead2Format*)(ptr))
 
diff --git a/lib/ultralib/src/voice/voicecontread36.c b/lib/ultralib/src/voice/voicecontread36.c
index c537aff..249daad 100644
--- a/lib/ultralib/src/voice/voicecontread36.c
+++ b/lib/ultralib/src/voice/voicecontread36.c
@@ -1,9 +1,14 @@
+/**
+ * File: voicecontread36.c
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/controller_voice.h"
-#include "io/siint.h"
+#include "PRinternal/controller_voice.h"
+#include "PRinternal/siint.h"
 
 #define READ36FORMAT(ptr) ((__OSVoiceRead36Format*)(ptr))
 
diff --git a/lib/ultralib/src/voice/voicecontrolgain.c b/lib/ultralib/src/voice/voicecontrolgain.c
index 95e9bb2..102b90f 100644
--- a/lib/ultralib/src/voice/voicecontrolgain.c
+++ b/lib/ultralib/src/voice/voicecontrolgain.c
@@ -1,5 +1,12 @@
+/**
+ * File: voicecontrolgain.c
+ *
+ * Adjusts the input gain of the Voice Recognition System
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicecontwrite20.c b/lib/ultralib/src/voice/voicecontwrite20.c
index d1a7446..bb5a3b2 100644
--- a/lib/ultralib/src/voice/voicecontwrite20.c
+++ b/lib/ultralib/src/voice/voicecontwrite20.c
@@ -1,9 +1,14 @@
+/**
+ * File: voicecontwrite20.c
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/controller_voice.h"
-#include "io/siint.h"
+#include "PRinternal/controller_voice.h"
+#include "PRinternal/siint.h"
 
 #define WRITE20FORMAT(ptr) ((__OSVoiceWrite20Format*)(ptr))
 
diff --git a/lib/ultralib/src/voice/voicecontwrite4.c b/lib/ultralib/src/voice/voicecontwrite4.c
index 6f00586..bcfc1e5 100644
--- a/lib/ultralib/src/voice/voicecontwrite4.c
+++ b/lib/ultralib/src/voice/voicecontwrite4.c
@@ -1,9 +1,14 @@
+/**
+ * File: voicecontwrite4.c
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/controller_voice.h"
-#include "io/siint.h"
+#include "PRinternal/controller_voice.h"
+#include "PRinternal/siint.h"
 
 #define WRITE4FORMAT(ptr) ((__OSVoiceWrite4Format*)(ptr))
 
diff --git a/lib/ultralib/src/voice/voicecountsyllables.c b/lib/ultralib/src/voice/voicecountsyllables.c
index b0112ef..dbe2847 100644
--- a/lib/ultralib/src/voice/voicecountsyllables.c
+++ b/lib/ultralib/src/voice/voicecountsyllables.c
@@ -1,10 +1,14 @@
+/**
+ * File: voicecountsyllables.c
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 
 // The VRU can store only 880 semisyllables of words in its dictionary.
 // Use this function to determine the semisyllable count before adding a word with osVoiceSetWord,
-//  to properly see whether it will fit.
+// to properly see whether it will fit.
 
 void osVoiceCountSyllables(u8* data, u32* syllable) {
     s32 k;
diff --git a/lib/ultralib/src/voice/voicecrc.c b/lib/ultralib/src/voice/voicecrc.c
index 56b4838..308862e 100644
--- a/lib/ultralib/src/voice/voicecrc.c
+++ b/lib/ultralib/src/voice/voicecrc.c
@@ -1,10 +1,20 @@
+/**
+ * File: voicecrc.c
+ * Description: CRC check used by the voice files
+ *
+ * For general information about CRC, see the crc.c file
+ */
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 
 #define VOICE_CRC_LENGTH 8
 #define VOICE_CRC_GENERATOR 0x85
 
+/**
+ * This function is essentially the same as __osContDataCrc, but allows for a variable message length, specified by
+ * `numBytes`.
+ */
 u8 __osVoiceContDataCrc(u8* data, u32 length) {
     s32 temp = 0;
     u32 i;
diff --git a/lib/ultralib/src/voice/voicegetreaddata.c b/lib/ultralib/src/voice/voicegetreaddata.c
index d2f5063..c4f8f1b 100644
--- a/lib/ultralib/src/voice/voicegetreaddata.c
+++ b/lib/ultralib/src/voice/voicegetreaddata.c
@@ -1,5 +1,11 @@
+/**
+ * File: voicegetreaddata.c
+ *
+ * Gets voice recognition result from the Voice Recognition System
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicegetstatus.c b/lib/ultralib/src/voice/voicegetstatus.c
index e7328c1..bafa4dd 100644
--- a/lib/ultralib/src/voice/voicegetstatus.c
+++ b/lib/ultralib/src/voice/voicegetstatus.c
@@ -1,8 +1,12 @@
+/**
+ * File: voicegetstatus.c
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/siint.h"
+#include "PRinternal/siint.h"
 
 s32 __osVoiceGetStatus(OSMesgQueue* mq, s32 port, u8* status) {
     __OSContRequesFormatShort header;
diff --git a/lib/ultralib/src/voice/voiceinit.c b/lib/ultralib/src/voice/voiceinit.c
index 5074a84..8aacf85 100644
--- a/lib/ultralib/src/voice/voiceinit.c
+++ b/lib/ultralib/src/voice/voiceinit.c
@@ -1,5 +1,12 @@
+/**
+ * File: voiceinit.c
+ *
+ * Initializes Voice Recognition System control structure and hardware
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicemaskdictionary.c b/lib/ultralib/src/voice/voicemaskdictionary.c
index 39db7ac..60d8b18 100644
--- a/lib/ultralib/src/voice/voicemaskdictionary.c
+++ b/lib/ultralib/src/voice/voicemaskdictionary.c
@@ -1,5 +1,12 @@
+/**
+ * File: voicemaskdictionary.c
+ *
+ * Mask words registered in the voice recognition system
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicesetadconverter.c b/lib/ultralib/src/voice/voicesetadconverter.c
index d1c5eb2..f3f8591 100644
--- a/lib/ultralib/src/voice/voicesetadconverter.c
+++ b/lib/ultralib/src/voice/voicesetadconverter.c
@@ -1,9 +1,13 @@
+/**
+ * File: voicesetadconverter.c
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
-#include "io/controller_voice.h"
-#include "io/siint.h"
+#include "PRinternal/controller_voice.h"
+#include "PRinternal/siint.h"
 
 #define SWRITEFORMAT(ptr) ((__OSVoiceSWriteFormat*)(ptr))
 
diff --git a/lib/ultralib/src/voice/voicesetword.c b/lib/ultralib/src/voice/voicesetword.c
index 7969fae..fb116de 100644
--- a/lib/ultralib/src/voice/voicesetword.c
+++ b/lib/ultralib/src/voice/voicesetword.c
@@ -1,5 +1,12 @@
+/**
+ * File: voicesetword.c
+ *
+ * Registers words to the Voice Recognition System dictionary
+ */
+
+#include "PRinternal/macros.h"
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicestartreaddata.c b/lib/ultralib/src/voice/voicestartreaddata.c
index ea83da0..4381e5b 100644
--- a/lib/ultralib/src/voice/voicestartreaddata.c
+++ b/lib/ultralib/src/voice/voicestartreaddata.c
@@ -1,5 +1,11 @@
+/**
+ * File: voicestartreaddata.c
+ *
+ * Start voice recognition by the Voice Recognition System
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 
diff --git a/lib/ultralib/src/voice/voicestopreaddata.c b/lib/ultralib/src/voice/voicestopreaddata.c
index b43eb81..b28143f 100644
--- a/lib/ultralib/src/voice/voicestopreaddata.c
+++ b/lib/ultralib/src/voice/voicestopreaddata.c
@@ -1,5 +1,11 @@
+/**
+ * File: voicestopreaddata.c
+ *
+ * Forcibly stops voice recognition processing by the Voice Recognition System
+ */
+
 #include "PR/os_internal.h"
-#include "io/controller.h"
+#include "PRinternal/controller.h"
 #include "PR/os_voice.h"
 #include "voiceinternal.h"
 #include "os_version.h"