Merge pull request #323 from PikalaxALT/various_documentation

Document various parts of the source tree

1 files changed, 17 insertions, 19 deletions

diff --git a/src/link_rfu_2.c b/src/link_rfu_2.c
index 15ffb4813..f3e7ce274 100644
--- a/src/link_rfu_2.c
+++ b/src/link_rfu_2.c
@@ -1,15 +1,13 @@
 #include "global.h"
-#include "battle.h"
-#include "gpu_regs.h"
+#include "gflib.h"
 #include "librfu.h"
+#include "battle.h"
 #include "link.h"
 #include "link_rfu.h"
 #include "mystery_gift_menu.h"
 #include "overworld.h"
-#include "palette.h"
 #include "quest_log.h"
 #include "random.h"
-#include "string_util.h"
 #include "task.h"
 #include "constants/species.h"
 #include "constants/union_room.h"
@@ -499,7 +497,7 @@ void LinkRfu_Shutdown(void)
 {
     u8 i;
 
-    if (gQuestLogState == 2 || gQuestLogState == 3)
+    if (QL_IS_PLAYBACK_STATE)
         return;
 
     rfu_LMAN_powerDownRFU();
@@ -538,7 +536,7 @@ void LinkRfu_Shutdown(void)
 
 static void CreateTask_LinkLeaderSearchForChildren(void)
 {
-    if (gQuestLogState == 2 || gQuestLogState == 3)
+    if (QL_IS_PLAYBACK_STATE)
         return;
     Rfu.unk_67 = CreateTask(Task_LinkLeaderSearchForChildren, 1);
 }
@@ -564,7 +562,7 @@ static bool32 IsParentSuccessfullyReconnected(void)
 
 static void CreateTask_JoinGroupSearchForParent(void)
 {
-    if (gQuestLogState == 2 || gQuestLogState == 3)
+    if (QL_IS_PLAYBACK_STATE)
         return;
     Rfu.unk_67 = CreateTask(Task_JoinGroupSearchForParent, 1);
 }
@@ -1147,7 +1145,7 @@ static void RfuPrepareSendBuffer(u16 command)
         break;
     case RFU_COMMAND_0xa100:
         if (Cmd8000recvIsFinished())
-            gSendCmd[1] = Rfu.unk_5a;
+            gSendCmd[1] = Rfu.cmdA100_blockRequestType;
         break;
     case RFU_COMMAND_0x7700:
     case RFU_COMMAND_0x7800:
@@ -1274,9 +1272,9 @@ static void RfuFunc_SendLastBlock(void)
         Rfu.RfuFunc = NULL;
 }
 
-bool8 sub_80FA0F8(u8 a0)
+bool8 LinkRfu_PrepareCmd0xA100(u8 blockRequestType)
 {
-    Rfu.unk_5a = a0;
+    Rfu.cmdA100_blockRequestType = blockRequestType;
     RfuPrepareSendBuffer(RFU_COMMAND_0xa100);
     return TRUE;
 }
@@ -1286,7 +1284,7 @@ static void RfuFunc_End5F00_PowerDownRfu(void)
     rfu_clearAllSlot();
     rfu_LMAN_powerDownRFU();
     gReceivedRemoteLinkPlayers = 0;
-    Rfu.unk_ef = 1;
+    Rfu.isShuttingDown = TRUE;
     Rfu.RfuFunc = NULL;
 }
 
@@ -1454,7 +1452,7 @@ bool32 RfuSerialNumberIsValid(u32 serialNo)
     return TRUE;
 }
 
-u8 sub_80FA484(bool32 a0)
+u8 ToggleLMANlinkRecovery(bool32 a0)
 {
     if (!a0)
         return rfu_LMAN_setLinkRecovery(0, 0);
@@ -1662,7 +1660,7 @@ static void sub_80FA834(u8 taskId)
         {
             if (Cmd8000recvIsFinished())
             {
-                Rfu.unk_5a = 0;
+                Rfu.cmdA100_blockRequestType = 0;
                 RfuPrepareSendBuffer(RFU_COMMAND_0xa100);
                 gTasks[taskId].data[0]++;
             }
@@ -1881,7 +1879,7 @@ bool32 LinkRfuMain1(void)
     bool32 retval = FALSE;
     Rfu.parentId = 0;
     rfu_LMAN_manager_entity(Random());
-    if (Rfu.unk_ef == 0)
+    if (!Rfu.isShuttingDown)
     {
         switch (Rfu.parent_child)
         {
@@ -1902,7 +1900,7 @@ bool32 LinkRfuMain1(void)
 bool32 LinkRfuMain2(void)
 {
     bool32 retval = FALSE;
-    if (Rfu.unk_ef == 0)
+    if (!Rfu.isShuttingDown)
     {
         if (Rfu.parent_child == MODE_PARENT)
             retval = sub_80F9204();
@@ -2093,7 +2091,7 @@ static void LmanCallback_Parent2(u8 msg, u8 param_count)
     case LMAN_MSG_LMAN_API_ERROR_RETURN:
         RfuSetErrorStatus(1, msg);
         GetLinkmanErrorParams(msg);
-        Rfu.unk_ef = 1;
+        Rfu.isShuttingDown = TRUE;
         break;
     case LMAN_MSG_REQ_API_ERROR:
     case LMAN_MSG_WATCH_DOG_TIMER_ERROR:
@@ -2166,7 +2164,7 @@ static void LmanCallback_Child(u8 msg, u8 param_count)
     case LMAN_MSG_LMAN_API_ERROR_RETURN:
         RfuSetErrorStatus(1, msg);
         GetLinkmanErrorParams(msg);
-        Rfu.unk_ef = 1;
+        Rfu.isShuttingDown = TRUE;
         break;
     case LMAN_MSG_REQ_API_ERROR:
     case LMAN_MSG_WATCH_DOG_TIMER_ERROR:
@@ -2343,7 +2341,7 @@ static void LmanCallback_Parent(u8 msg, u8 param_count)
     case LMAN_MSG_LMAN_API_ERROR_RETURN:
         RfuSetErrorStatus(1, msg);
         GetLinkmanErrorParams(msg);
-        Rfu.unk_ef = 1;
+        Rfu.isShuttingDown = TRUE;
         break;
     case LMAN_MSG_REQ_API_ERROR:
     case LMAN_MSG_WATCH_DOG_TIMER_ERROR:
@@ -2481,7 +2479,7 @@ void InitializeRfuLinkManager_JoinGroup(void)
 
 void InitializeRfuLinkManager_EnterUnionRoom(void)
 {
-    if (gQuestLogState == 2 || gQuestLogState == 3)
+    if (QL_IS_PLAYBACK_STATE)
         return;
     Rfu.parent_child = 2;
     CopyPlayerNameToUnameBuffer();