summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
Diffstat (limited to 'include')
-rw-r--r--include/global.h4
-rw-r--r--include/help_system.h34
-rw-r--r--include/librfu.h33
-rw-r--r--include/link.h2
-rw-r--r--include/link_rfu.h342
-rw-r--r--include/overworld.h2
-rw-r--r--include/union_room.h9
7 files changed, 263 insertions, 163 deletions
diff --git a/include/global.h b/include/global.h
index 2f87a0c29..2ed7476e7 100644
--- a/include/global.h
+++ b/include/global.h
@@ -74,8 +74,8 @@
// GameFreak never ceases to amaze.
// TODO: Propagate use of this macro
#define TEST_BUTTON(field, button) ({(field) & (button);})
-#define JOY_NEW(button) TEST_BUTTON(gMain.newKeys, button)
-#define JOY_HELD(button) TEST_BUTTON(gMain.heldKeys, button)
+#define JOY_NEW(button) TEST_BUTTON(gMain.newKeys, button)
+#define JOY_HELD(button) TEST_BUTTON(gMain.heldKeys, button)
#define JOY_REPT(button) TEST_BUTTON(gMain.newAndRepeatedKeys, button)
extern u8 gStringVar1[];
diff --git a/include/help_system.h b/include/help_system.h
index 59adec912..c5ae5e5fa 100644
--- a/include/help_system.h
+++ b/include/help_system.h
@@ -17,16 +17,16 @@ struct HelpSystemListMenu_sub
struct HelpSystemListMenu
{
struct HelpSystemListMenu_sub sub;
- u8 field_0C;
- u8 field_0D;
- u8 field_0E;
+ u8 itemsAbove;
+ u8 cursorPos;
+ u8 state;
u8 filler_10[0xC];
};
extern struct HelpSystemListMenu gHelpSystemListMenu;
extern struct ListMenuItem gHelpSystemListMenuItems[];
extern bool8 gHelpSystemEnabled;
-extern u8 gUnknown_203F175;
+extern bool8 gHelpSystemToggleWithRButtonDisabled;
// help_system_812B1E0
void HelpSystem_SetSomeVariable(u8);
@@ -35,19 +35,19 @@ bool8 sub_812B40C(void);
bool8 sub_812B45C(void);
void HelpSystem_Disable(void);
void HelpSystem_Enable(void);
-void sub_812B4B8(void);
-bool8 sub_812BB9C(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BC54(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BC80(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BCA8(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BCD0(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BD2C(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BD64(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BD98(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
+void HelpSystem_EnableToggleWithRButton(void);
+bool8 RunHelpMenuSubroutine(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpSystemSubroutine_PrintWelcomeMessage(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpSystemSubroutine_WelcomeWaitButton(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpSystemSubroutine_WelcomeEndGotoMenu(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpSystemSubroutine_MenuInputHandlerMain(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpMenuSubroutine_InitSubmenu(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpMenuSubroutine_ReturnFromSubmenu(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpMenuSubroutine_SubmenuInputHandler(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
void sub_812BDEC(void);
-bool8 sub_812BE10(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BEEC(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
-bool8 sub_812BF18(struct HelpSystemListMenu * a0, struct ListMenuItem * a1);
+bool8 HelpMenuSubroutine_HelpItemPrint(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpMenuSubroutine_ReturnFromHelpItem(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
+bool8 HelpMenuSubroutine_HelpItemWaitButton(struct HelpSystemListMenu * helpListMenu, struct ListMenuItem * listMenuItemsBuffer);
bool8 sub_812BF88(void);
// help_system
@@ -92,6 +92,6 @@ bool8 MoveCursor(u8 by, u8 dirn);
void HelpSystem_BackupSomeVariable(void);
void HelpSystem_RestoreSomeVariable(void);
void HelpSystemRenderText(u8 font, u8 * dest, const u8 * src, u8 x, u8 y, u8 width, u8 height);
-void sub_812B4AC(void);
+void HelpSystem_DisableToggleWithRButton(void);
#endif //GUARD_HELP_SYSTEM_H
diff --git a/include/librfu.h b/include/librfu.h
index 97fd8044e..33f370bf0 100644
--- a/include/librfu.h
+++ b/include/librfu.h
@@ -4,11 +4,8 @@
#include "global.h"
#include "main.h"
-/* TODOs:
- * - split files
+/* TODOs:
* - documentation
- * - decompile librfu_intr.s once arm support is back again
- (for internal structs not documented in SDK)
* - check if any field needs to be volatile
* - check if field names make sense
*/
@@ -71,6 +68,7 @@
#define ID_CPR_POLL_REQ 0x0033
#define ID_CPR_END_REQ 0x0034
#define ID_UNK35_REQ 0x0035 // not defined in SDK header
+#define ID_UNK36_REQ 0x0036 // not defined in SDK header
#define ID_RESUME_RETRANSMIT_AND_CHANGE_REQ 0x0037
#define ID_STOP_MODE_REQ 0x003d
#define ID_CLOCK_SLAVE_MS_CHANGE_ERROR_BY_DMA_REQ 0x00ff // When the AGB is the clock slave, the RFU generates an informational notice, and an automatically started DMA, such as HDMA, is generated at the instant the AGB is being returned as the clock master. This ID is notified by a REQ callback when the exchange of this information (REQ command) fails.
@@ -90,8 +88,9 @@
#define RFU_MBOOT_DOWNLOADER_SERIAL_NO 0x0000 // The game serial number of the multi-boot downloader (programs that boot without a Game Pak)
-#define RFU_API_BUFF_SIZE_RAM 0x0e8c // Necessary size for buffer specified by rfu_initializeAPI (fast communication version that operates the library SIO interrupt routines in RAM)
-#define RFU_API_BUFF_SIZE_ROM 0x052c // Necessary size for buffer specified by rfu_initializeAPI (fast communication version that operates the library SIO interrupt routines in ROM)
+// Sizes are 0x28 larger in v1028
+#define RFU_API_BUFF_SIZE_RAM 0x0e64 // Necessary size for buffer specified by rfu_initializeAPI (fast communication version that operates the library SIO interrupt routines in RAM)
+#define RFU_API_BUFF_SIZE_ROM 0x0504 // Necessary size for buffer specified by rfu_initializeAPI (fast communication version that operates the library SIO interrupt routines in ROM)
#define RFU_CHILD_MAX 4 // Maximum number of slaves that can be connected to one parent device
@@ -314,10 +313,10 @@ struct STWIStatus
u8 unk_17;
void (*callbackM)();
void (*callbackS)(u16);
- void (*unk_20)(void);
+ void (*callbackID)(void);
union RfuPacket *txPacket;
union RfuPacket *rxPacket;
- vu8 unk_2c;
+ vu8 sending;
};
// This struct is used as u8 array in SDK.
@@ -473,16 +472,6 @@ struct RfuSIO32Id
u16 unkA;
};
-struct RfuAPIBuffer
-{
- struct RfuLinkStatus linkStatus;
- struct RfuStatic static_;
- struct RfuFixed fixed;
- struct RfuSlotStatusNI NI[RFU_CHILD_MAX];
- struct RfuSlotStatusUNI UNI[RFU_CHILD_MAX];
- struct RfuIntrStruct intr;
-};
-
extern struct STWIStatus *gSTWIStatus;
extern struct RfuLinkStatus *gRfuLinkStatus;
extern struct RfuStatic *gRfuStatic;
@@ -499,7 +488,7 @@ s32 AgbRFU_checkID(u8);
// librfu_rfu
// API Initialization and Initial Settings
// API Initialization
-u16 rfu_initializeAPI(struct RfuAPIBuffer *APIBuffer, u16 buffByteSize, IntrFunc *sioIntrTable_p, bool8 copyInterruptToRam);
+u16 rfu_initializeAPI(u32 *APIBuffer, u16 buffByteSize, IntrFunc *sioIntrTable_p, bool8 copyInterruptToRam);
// Set Timer Interrupt
void rfu_setTimerInterrupt(u8 timerNo, IntrFunc *timerIntrTable_p);
// Resident Function called from within a V-Blank Interrupt
@@ -600,7 +589,7 @@ u16 rfu_MBOOT_CHILD_inheritanceLinkStatus(void);
// For Debug
// Obtain address of the SWTI-layer receive buffer
-struct RfuIntrStruct *rfu_getSTWIRecvBuffer(void);
+u8 *rfu_getSTWIRecvBuffer(void);
// Obtain RFU state
void rfu_REQ_RFUStatus(void);
u16 rfu_getRFUStatus(u8 *rfuState);
@@ -626,14 +615,14 @@ void STWI_send_DataRxREQ(void);
void STWI_send_MS_ChangeREQ(void);
void STWI_send_StopModeREQ(void);
void STWI_send_SystemStatusREQ(void);
-void STWI_send_GameConfigREQ(const u8 *unk1, const u8 *data);
+void STWI_send_GameConfigREQ(const u8 *serial_uname, const u8 *gname);
void STWI_send_ResetREQ(void);
void STWI_send_LinkStatusREQ(void);
void STWI_send_VersionStatusREQ(void);
void STWI_send_SlotStatusREQ(void);
void STWI_send_ConfigStatusREQ(void);
void STWI_send_ResumeRetransmitAndChangeREQ(void);
-void STWI_send_SystemConfigREQ(u16 unk1, u8 unk2, u8 unk3);
+void STWI_send_SystemConfigREQ(u16 availSlotFlag, u8 maxMFrame, u8 mcTimer);
void STWI_send_SC_StartREQ(void);
void STWI_send_SC_PollingREQ(void);
void STWI_send_SC_EndREQ(void);
diff --git a/include/link.h b/include/link.h
index 770a60f44..e41b89634 100644
--- a/include/link.h
+++ b/include/link.h
@@ -277,7 +277,7 @@ void LinkVSync(void);
bool8 HandleLinkConnection(void);
void sub_800B0B4(void);
void sub_800B110(u32 who);
-void sub_800ACBC(u32 status, u8 lastSendQueueCount, u8 lastRecvQueueCount, u8 unk_06);
+void SetLinkErrorFromRfu(u32 status, u8 lastSendQueueCount, u8 lastRecvQueueCount, u8 unk_06);
u8 sub_800A8D4(void);
#endif // GUARD_LINK_H
diff --git a/include/link_rfu.h b/include/link_rfu.h
index 81dd7fdf0..52fd07f7c 100644
--- a/include/link_rfu.h
+++ b/include/link_rfu.h
@@ -4,6 +4,101 @@
#include "global.h"
#include "librfu.h"
+//-----------------------------------------------------------------
+// Constant definition
+//-----------------------------------------------------------------
+
+// Link Manager operation mode (specified by u8 parent_child argument of rfu_LMAN_establishConnection)
+//#define MODE_CHILD 0 // Start Link Manager in CHILD mode
+//#define MODE_PARENT 1 // Start Link Manager in PARENT mode
+//Note: This value uses the item defined by AgbRFU_LL.h.
+#define MODE_P_C_SWITCH 2 // Start Link Manager in parent-child switching mode.
+
+
+// Error code returned by Link Manager API (rfu_LMAN_...return value of function)
+#define LMAN_ERROR_MANAGER_BUSY 1 // Link Manager is already running.
+#define LMAN_ERROR_AGB_CLK_SLAVE 2 // AGB is clock slave so link manager cannot run.
+#define LMAN_ERROR_PID_NOT_FOUND 3 // Parent device information of the specified PID does not exist in rfuLinkStatus->partner[0-3].
+#define LMAN_ERROR_ILLEGAL_PARAMETER 4 // Specified argument is unusual.
+#define LMAN_ERROR_NOW_LINK_RECOVERY 5 // New settings were ignored because link recovery was under way when current link recovery was ON and new settings turned link recovery OFF.
+#define LMAN_ERROR_NOW_COMMUNICATION 6 // New settings were ignored because currently communicating with NI.
+#define LMAN_ERROR_NOW_SEARCH_PARENT 7 // Parent search currently under way, so ignore new setting.
+
+// Details of messages and the related parameters returned by the u8 msg, u8 param_count, and lman.param[0-1] arguments of the LMAN callback generated by the operation of the Link Manager.
+// msg name msg No. param qty param[0] param[1] Description
+#define LMAN_MSG_INITIALIZE_COMPLETED 0x00 // 0 - - Generated when RFU reset and initial settings are completed
+#define LMAN_MSG_NEW_CHILD_CONNECT_DETECTED 0x10 // 1 Bit indicating slot - Generated when new child device connection was detected at RFU level.
+// with detected connection
+#define LMAN_MSG_NEW_CHILD_CONNECT_ACCEPTED 0x11 // 1 Bit indicating slot - Generated when game identification information from child device connected at RFU level is received and accepted (game serial numbers match).
+// where connection was accepted
+#define LMAN_MSG_NEW_CHILD_CONNECT_REJECTED 0x12 // 1 Bit indicating slot - Generated when the connection from the child device connected at RFU level is rejected (game identification information reception failed or game serial numbers do not match).
+// where connection was rejected
+#define LMAN_MSG_SEARCH_CHILD_PERIOD_EXPIRED 0x13 // 0 - - Generated when SearchChild operation time expires.
+#define LMAN_MSG_END_WAIT_CHILD_NAME 0x14 // 0 - - Generated when reception of game identification information from all child devices completes after the SearchChild operation time expires.
+#define LMAN_MSG_PARENT_FOUND 0x20 // 1 Bit indicating - Generated when valid (game serial numbers match) parent devices are found during SearchParent.
+// rfuLinkStatus->partner[x] index number storing the valid parent devices (game serial number matches) from among the discovered parent devices.
+#define LMAN_MSG_SEARCH_PARENT_PERIOD_EXPIRED 0x21 // 0 - - Generated when SearchParent time expires.
+#define LMAN_MSG_CONNECT_PARENT_SUCCESSED 0x22 // 1 Connected slot number - Generated when connection with parent device at RFU level succeeds.
+#define LMAN_MSG_CONNECT_PARENT_FAILED 0x23 // 1 Connection failure reason - Generated when connection with parent device at RFU level fails.
+#define LMAN_MSG_CHILD_NAME_SEND_COMPLETED 0x24 // 0 - - Generated when transmission of the child's game identification information to the parent device succeeds after connection with parent device at RFU level succeeds.
+#define LMAN_MSG_CHILD_NAME_SEND_FAILED_AND_DISCONNECTED 0x25 // 0 - - Generated when transmission of the child's game identification information to the parent device fails after connection with parent device at RFU level succeeds.
+#define LMAN_MSG_LINK_LOSS_DETECTED_AND_DISCONNECTED 0x30 // 1 Bit indicating slot - Generated when a link cut is detected and that slot disconnects. (Generated only when link recovery is OFF.)
+// that was disconnected and where link cut was detected but link recover not attempted
+#define LMAN_MSG_LINK_LOSS_DETECTED_AND_START_RECOVERY 0x31 // 1 Bit indicating slot - Generated when a link cut is detected and the link recovery process starts. (Generated only when link recovery is ON.)
+// where link cut was detected and link recovery was started
+#define LMAN_MSG_LINK_RECOVERY_SUCCESSED 0x32 // 1 Bit indicating slot - Generated when link recovery succeeds. (Generated only when link recovery is ON.)
+// where link recovery succeeded
+#define LMAN_MSG_LINK_RECOVERY_FAILED_AND_DISCONNECTED 0x33 // 1 Bit indicating slot - Generated when link recovery fails and that slot disconnects. (Generated only when link recovery is ON.)
+// where link recovery failed and that disconnected
+#define LMAN_MSG_LINK_DISCONNECTED_BY_USER 0x40 // 1 Generated on disconnection by execution of rfu_REQ_disconnect by disconnected user.
+// Slot indicated in bits *Note: If rfu_REQ_disconnect is used for disconnection during link recovery in the child device, the link recovery is also suspended, but the only message returned is DISCONNECTED_BY_USER.
+#define LMAN_MSG_CHANGE_AGB_CLOCK_SLAVE 0x41 // 0 - - Generated when the AGB-RFU clock switches to AGB clock slave after a successful connection or link recovery in the child device. (This message is not generated when the AGB switches to a clock slave when an MSC callback completes.)
+#define LMAN_MSG_CHANGE_AGB_CLOCK_MASTER 0x45 // 0 - - Generated when the AGB-RFU intercommunication clock is switched to the AGB clock master in the child device.
+#define LMAN_MSG_RFU_POWER_DOWN 0x42 // 0 - - Generated when the RFU enters power conservation mode with rfu_LMAN_powerDownRFU.
+#define LMAN_MSG_MANAGER_STOPPED 0x43 // 0 - - Generated when the Link Manager is halted by rfu_LMAN_stopLMAN(0). (This message is not generated during SearchChild, SearchParent, ConnectParent, and LinkRecovery. A message (-PERIOD_EXPIRED, -SUCCESSED, -FAILED) corresponding to the operation completion is returned.)
+#define LMAN_MSG_MANAGER_FORCED_STOPPED_AND_RFU_RESET 0x44 // 0 - - Generates when the Link Manager is forcibly halted by rfu_LMAN_stopLMAN(1) and RFU is reset.
+
+#define LMAN_MSG_RECV_DATA_REQ_COMPLETED 0x50 // 0 - - Generated when the execution of rfu_REQ_recvData completes. (This message is not notification of data reception from a RFU.)
+
+#define LMAN_MSG_REQ_API_ERROR 0xf0 // 2 REQ_commandID REQ_result REQ-API resulted in error. This message is also generated by an REQ-API executed by either the link manager or the user.
+#define LMAN_MSG_WATCH_DOG_TIMER_ERROR 0xf1 // 0 - - Generated when a MSC callback does not occur even after 6 seconds pass when the AGB is the clock slave.
+#define LMAN_MSG_CLOCK_SLAVE_MS_CHANGE_ERROR_BY_DMA 0xf2 // 0 - - Generated when an automatic starting DMA, such as HDMA, is issued at the same time the RFU attempts to send notification and to return the AGB to the clock master while the AGB is the clock slave and the exchange of that information (REQ command) fails.
+#define LMAN_MSG_LMAN_API_ERROR_RETURN 0xf3 // 1 Return error code - Generated when LMAN-API execution returns an error.
+#define LMAN_MSG_RFU_FATAL_ERROR 0xff // 0 - - Generated when the Link Manager cannot recongize a RFU because of the execution of rfu_REQBN_softReset_and_checkID.
+
+
+// Value of lman.childClockSlave_flag
+#define RFU_CHILD_CLOCK_SLAVE_OFF 0 // The child device is not operating in AGB clock slave mode. (The child device is in this mode in cases such as when the child has not established a connection or during link recovery.)
+#define RFU_CHILD_CLOCK_SLAVE_ON 1 // The child device is operating in AGB clock slave mode. (Child automatically enters this mode when a connection is established.)
+#define RFU_CHILD_CLOCK_SLAVE_OFF_REQ 2 // The child device has requested that AGB clock slave mode be halted.
+
+// State of Link Manager (values of lman.state, lman.next_state)
+#define LMAN_STATE_READY 0x00 // Waiting
+#define LMAN_STATE_SOFT_RESET_AND_CHECK_ID 0x01 // Requesting execution of rfu_REQBN_softResetAndCheckID (same as below)
+#define LMAN_STATE_RESET 0x02 // rfu_REQ_reset
+#define LMAN_STATE_CONFIG_SYSTEM 0x03 // rfu_REQ_configSystem
+#define LMAN_STATE_CONFIG_GAME_DATA 0x04 // rfu_REQ_configGameData
+#define LMAN_STATE_START_SEARCH_CHILD 0x05 // rfu_REQ_startSearchChild
+#define LMAN_STATE_POLL_SEARCH_CHILD 0x06 // rfu_REQ_pollSearchChild
+#define LMAN_STATE_END_SEARCH_CHILD 0x07 // rfu_REQ_endSearchChild
+#define LMAN_STATE_WAIT_RECV_CHILD_NAME 0x08 // Awaiting reception of game name from connected child device.
+#define LMAN_STATE_START_SEARCH_PARENT 0x09 // rfu_REQ_startSearchParent
+#define LMAN_STATE_POLL_SEARCH_PARENT 0x0a // rfu_REQ_pollSearchParent
+#define LMAN_STATE_END_SEARCH_PARENT 0x0b // rfu_REQ_endSearchParent
+#define LMAN_STATE_START_CONNECT_PARENT 0x0c // rfu_REQ_startConnectParent
+#define LMAN_STATE_POLL_CONNECT_PARENT 0x0d // rfu_REQ_pollConnectParent
+#define LMAN_STATE_END_CONNECT_PARENT 0x0e // rfu_REQ_endConnectParent
+#define LMAN_STATE_SEND_CHILD_NAME 0x0f // Sending child game name.
+#define LMAN_STATE_START_LINK_RECOVERY 0x10 // rfu_REQ_CHILD_startConnectRecovery
+#define LMAN_STATE_POLL_LINK_RECOVERY 0x11 // rfu_REQ_CHILD_pollConnectRecovery
+#define LMAN_STATE_END_LINK_RECOVERY 0x12 // rfu_REQ_CHILD_endConnectRecovery
+#define LMAN_STATE_MS_CHANGE 0x13 // rfu_REQ_changeMasterSlave
+#define LMAN_STATE_WAIT_CLOCK_MASTER 0x14 // Waiting for AGB-RFU intercommunication clock to become AGB clock master.
+#define LMAN_STATE_STOP_MODE 0x15 // rfu_REQ_stopMode
+#define LMAN_STATE_BACK_STATE 0x16 // Following the completion of link-recovery processing, return the Link Manager state to the state present before link-recovery processing was initiated.
+#define LMAN_FORCED_STOP_AND_RFU_RESET 0x17 // Attempt to forcibly stop Link Manager using rfu_LMAN_stopLMAN(1).
+#define LMAN_STATE_WAIT_CHANGE_CLOCK_MASTER 0x18 // Attempt to return to AGB clock master after child fails in sending game name.
+
// RfuTgtData.gname is read as these structs.
struct GFtgtGnameSub
{
@@ -25,7 +120,7 @@ struct __attribute__((packed, aligned(2))) GFtgtGname
u8 unk_04[4];
u16 species:10;
u16 type:6;
- u8 unk_0a_0:7;
+ u8 activity:7;
u8 unk_0a_7:1;
u8 playerGender:1;
u8 level:7;
@@ -37,20 +132,37 @@ struct Padded_U8
u8 value;
};
-struct UnkLinkRfuStruct_02022B2C
-{
- u8 maxMFrame;
- u8 mcTimer;
- u16 availSlotFlag;
- u8 mbootFlag;
- u16 serialNo;
- struct GFtgtGname *gname;
- u8 *uname;
- u8 unk_10;
- u8 unk_11;
- u16 unk_12;
- u16 unk_14;
-};
+// Parameter group used in initial setting run of the link manager (rfu_LMAN_initializeRFU)
+typedef struct InitializeParametersTag {
+ // rfu_REQ_configSystem argument
+ u8 maxMFrame; // Maximum number of times to re-transmit of RFU level
+ u8 MC_TimerCount; // MC_Timer count (x16.7ms)
+ u16 availSlot_flag; // Use RFU-API constant "AVAIL_SLOT1-4" to specify the maximum number of child devices (1 - 4) that can be connected to a parent device.
+
+ // rfu_REQB_configGameData argument
+ u8 mboot_flag; // Multiplayer boot flag
+ u16 serialNo; // Game serial number
+ u8 *gameName; // Game name
+ u8 *userName; // User name
+
+ // ON/OFF flag for parent fast search operation by child.
+ u8 fastSearchParent_flag; // Flag indicating whether parent fast search operation to be performed by child.
+
+ // Link recovery settings
+ u8 linkRecovery_enable; // Determines whether or not to execute the link recovery process when a link cut occurs
+ u16 linkRecovery_period; // Time to spend on the link recovery process (x 16.7 ms) Note: Runs for unlimited time when specifying 0.
+
+ // Setting for NI-type data transmit/receive period
+ u16 NI_failCounter_limit; // Limit for failCounter during NI type data transmit/receive (x 16.7 ms) Note: Runs for unlimited time when specifying 0.
+}INIT_PARAM;
+
+
+// Timer that counts with the V-Blank cycle
+typedef struct VblankTimerTag {
+ u8 active; // Timer ON/OFF (bits 0 - 3 indicate ON/OFF for each connected slot)
+ u16 count_max; // Maximum count value (x16.7ms)
+ u16 count[RFU_CHILD_MAX]; // Current count value (x 16.7 ms) for each connected slot
+}VBL_TIMER;
struct UnkLinkRfuStruct_02022B44
{
@@ -66,106 +178,97 @@ struct UnkLinkRfuStruct_02022B44
u8 fill_84[0x58];
};
-struct UnkRfuStruct_1
+typedef struct linkManagerTag
{
- /* 0x000 */ u8 unk_00;
- /* 0x001 */ u8 unk_01;
- /* 0x002 */ vu8 unk_02;
- /* 0x003 */ vu8 unk_03;
- /* 0x004 */ u8 unk_04;
- /* 0x005 */ u8 unk_05;
- /* 0x006 */ u8 unk_06;
- /* 0x007 */ u8 unk_07;
- /* 0x008 */ u8 unk_08;
- /* 0x009 */ u8 unk_09;
- /* 0x00a */ u8 unk_0a;
- /* 0x00b */ u8 unk_0b;
- /* 0x00c */ u8 unk_0c;
- /* 0x00d */ u8 unk_0d;
- /* 0x00e */ u8 unk_0e;
- /* 0x00f */ u8 unk_0f;
- /* 0x010 */ u8 unk_10;
- /* 0x011 */ u8 unk_11;
- /* 0x012 */ u8 unk_12;
- // aligned
- /* 0x014 */ u16 unk_14;
- /* 0x016 */ u16 unk_16;
- /* 0x018 */ u16 unk_18;
- /* 0x01a */ u16 unk_1a;
- /* 0x01c */ u16 unk_1c;
- /* 0x01e */ u16 unk_1e;
- /* 0x020 */ const u16 *unk_20;
- /* 0x024 */ u8 unk_24;
- /* 0x026 */ u16 unk_26;
- /* 0x028 */ u16 unk_28[RFU_CHILD_MAX];
- /* 0x030 */ u8 unk_30;
- // aligned
- /* 0x032 */ u16 unk_32;
- /* 0x034 */ u16 unk_34[RFU_CHILD_MAX];
- /* 0x03c */ const struct UnkLinkRfuStruct_02022B2C *unk_3c;
- /* 0x040 */ void (*unk_40)(u8, u8);
- /* 0x044 */ void (*unk_44)(u16);
-};
+ /* 0x000 */ u8 acceptSlot_flag;
+ /* 0x001 */ u8 acceptCount;
+ /* 0x002 */ vu8 childClockSlave_flag;
+ /* 0x003 */ vu8 parentAck_flag;
+ /* 0x004 */ u8 state;
+ /* 0x005 */ u8 next_state;
+ /* 0x006 */ u8 parent_child;
+ /* 0x007 */ u8 pcswitch_flag;
+ /* 0x008 */ u8 RFU_powerOn_flag;
+ /* 0x009 */ u8 linkRecovery_enable;
+ /* 0x00a */ u8 linkRecovery_start_flag;
+ /* 0x00b */ u8 fastSearchParent_flag;
+ /* 0x00c */ u8 connectSlot_flag_old;
+ /* 0x00d */ u8 reserveDisconnectSlot_flag;
+ /* 0x00e */ u8 active;
+ /* 0x00f */ u8 msc_exe_flag;
+ /* 0x010 */ u8 child_slot;
+ /* 0x011 */ u8 state_bak[2];
+ /* 0x014 */ u16 param[2];
+ /* 0x018 */ u16 NI_failCounter_limit;
+ /* 0x01a */ u16 connect_period;
+ /* 0x01c */ u16 pcswitch_period_bak;
+ /* 0x01e */ u16 work;
+ /* 0x020 */ u16 *acceptable_serialNo_list;
+ /* 0x024 */ VBL_TIMER nameAcceptTimer;
+ /* 0x030 */ VBL_TIMER linkRecoveryTimer;
+ /* 0x03c */ INIT_PARAM *init_param;
+ /* 0x040 */ void (*LMAN_callback)(u8, u8);
+ /* 0x044 */ void (*MSC_callback)(u16);
+} LINK_MANAGER;
struct UnkRfuStruct_2_Sub_6c
{
/* 0x00 */ u16 unk_00;
- /* 0x02 */ u16 unk_02;
- /* 0x04 */ const u8 *unk_04;
+ /* 0x02 */ u16 count;
+ /* 0x04 */ const u8 *payload;
/* 0x08 */ u32 unk_08;
/* 0x0c */ u32 unk_0c;
/* 0x10 */ u8 unk_10;
- /* 0x11 */ u8 unk_11;
+ /* 0x11 */ u8 owner;
/* 0x12 */ u8 unk_12;
};
struct UnkRfuStruct_2_Sub_124
{
- /* 0x000 */ u8 unk_00[20][70];
- /* 0x578 */ vu8 unk_8c0;
- /* 0x579 */ vu8 unk_8c1;
- /* 0x57a */ vu8 unk_8c2;
- /* 0x57b */ vu8 unk_8c3;
+ /* 0x000 */ u8 slots[20][70];
+ /* 0x578 */ vu8 recv_slot;
+ /* 0x579 */ vu8 send_slot;
+ /* 0x57a */ vu8 count;
+ /* 0x57b */ vu8 full;
};
struct UnkRfuStruct_2_Sub_9e8
{
- /* 0x000 */ u8 unk_00[40][14];
- /* 0x230 */ vu8 unk_230;
- /* 0x231 */ vu8 unk_231;
- /* 0x232 */ vu8 unk_232;
- /* 0x233 */ vu8 unk_233;
+ /* 0x000 */ u8 slots[40][14];
+ /* 0x230 */ vu8 recv_slot;
+ /* 0x231 */ vu8 send_slot;
+ /* 0x232 */ vu8 count;
+ /* 0x233 */ vu8 full;
};
struct UnkRfuStruct_2_Sub_c1c
{
- /* 0x00 */ u8 unk_00[2][14];
- /* 0x1c */ vu8 unk_1c;
- /* 0x1d */ vu8 unk_1d;
- /* 0x1e */ vu8 unk_1e;
+ /* 0x00 */ u8 slots[2][14];
+ /* 0x1c */ vu8 recv_slot;
+ /* 0x1d */ vu8 send_slot;
+ /* 0x1e */ vu8 count;
};
struct UnkRfuStruct_Sub_Unused
{
- /* 0x000 */ u8 unk_00[2][256];
- /* 0x200 */ vu8 unk_200;
- /* 0x201 */ vu8 unk_201;
- /* 0x202 */ vu8 unk_202;
- /* 0x203 */ vu8 unk_203;
+ /* 0x000 */ u8 slots[2][256];
+ /* 0x200 */ vu8 recv_slot;
+ /* 0x201 */ vu8 send_slot;
+ /* 0x202 */ vu8 count;
+ /* 0x203 */ vu8 full;
};
-struct UnkRfuStruct_2
+typedef struct UnkRfuStruct_2
{
/* 0x000 */ void (*RfuFunc)(void);
/* 0x004 */ u16 unk_04;
/* 0x006 */ u8 filler_06[4];
- /* 0x00a */ u16 unk_0a;
+ /* 0x00a */ u16 linkman_msg;
/* 0x00c */ u8 unk_0c; // parentChildMode?
/* 0x00d */ u8 playerCount;
/* 0x00e */ u8 unk_0e;
/* 0x00f */ u8 unk_0f;
- /* 0x010 */ u16 unk_10;
- /* 0x012 */ u16 unk_12;
+ /* 0x010 */ u16 linkman_param[2];
/* 0x014 */ u8 unk_14[RFU_CHILD_MAX][14];
/* 0x04c */ u8 unk_4c[14];
/* 0x05a */ u8 unk_5a;
@@ -179,9 +282,9 @@ struct UnkRfuStruct_2
/* 0x080 */ struct UnkRfuStruct_2_Sub_6c unk_80[5];
/* 0x0e4 */ u8 unk_e4[5];
/* 0x0e9 */ u8 unk_e9[5];
- /* 0x0ee */ vu8 unk_ee;
+ /* 0x0ee */ vu8 errorState;
/* 0x0ef */ u8 unk_ef;
- /* 0x0f0 */ u8 unk_f0;
+ /* 0x0f0 */ u8 linkLossRecoveryState;
/* 0x0f1 */ u8 unk_f1;
/* 0x0f2 */ u16 unk_f2[6];
/* 0x0fe */ u16 unk_fe;
@@ -193,11 +296,11 @@ struct UnkRfuStruct_2
/* 0x8d4 */ struct UnkRfuStruct_2_Sub_c1c unk_c1c;
/* 0x8f4 */ vu8 unk_c3c;
/* 0x8f5 */ u8 unk_c3d;
- /* 0x8f6 */ vu8 unk_c3e;
+ /* 0x8f6 */ vu8 child_slot;
/* 0x8f7 */ u8 unk_c3f[70];
/* 0x93d */ u8 unk_c85;
/* 0x93e */ u8 unk_c86;
- /* 0x93f */ u8 unk_c87[5][7][2];
+ /* 0x93f */ u8 recvCmds[5][7][2];
/* 0x985 */ u8 unk_ccd;
/* 0x986 */ u8 unk_cce; // childId
/* 0x987 */ u8 unk_ccf;
@@ -210,8 +313,8 @@ struct UnkRfuStruct_2
/* 0x994 */ vu8 unk_cdc;
/* 0x995 */ u8 unk_cdd;
/* 0x996 */ u8 unk_cde[RFU_CHILD_MAX];
- /* 0x99a */ u8 unk_ce2;
- /* 0x99b */ u8 unk_ce3;
+ /* 0x99a */ u8 bm_PartnerFlags;
+ /* 0x99b */ u8 bm_DisconnectSlot;
/* 0x99c */ u8 unk_ce4;
/* 0x99d */ u8 unk_ce5;
/* 0x99e */ u8 unk_ce6;
@@ -220,12 +323,29 @@ struct UnkRfuStruct_2
/* 0x9a1 */ u8 unk_ce9;
/* 0x9a2 */ u8 unk_cea[RFU_CHILD_MAX];
/* 0x9a6 */ u8 unk_cee[RFU_CHILD_MAX];
-}; // size: 0x9AC
+} GF_RFU_MANAGER; // size: 0x9AC
-extern struct UnkRfuStruct_1 gUnknown_3005E10;
+extern struct linkManagerTag lman;
extern struct GFtgtGname gHostRFUtgtGnameBuffer;
extern u8 gHostRFUtgtUnameBuffer[];
+// Official signatures
+u32 rfu_LMAN_REQBN_softReset_and_checkID(void);
+void rfu_LMAN_requestChangeAgbClockMaster(void);
+void rfu_LMAN_initializeRFU(INIT_PARAM *init_params);
+u8 rfu_LMAN_establishConnection(u8 parent_child, u16 connect_period, u16 name_accept_period, u16 *acceptable_serialNo_list);
+void rfu_LMAN_stopManager(bool8 forced_stop_and_RFU_reset_flag);
+void rfu_LMAN_setMSCCallback(void (*MSC_callback_p)(u16));
+void rfu_LMAN_REQ_sendData(bool8 clockChangeFlag);
+void rfu_LMAN_powerDownRFU(void);
+u8 rfu_LMAN_CHILD_connectParent(u16 parentId, u16 connect_period);
+u8 rfu_LMAN_setLinkRecovery(u8 enable_flag, u16 recovery_period);
+void rfu_LMAN_manager_entity(u32 rand);
+void rfu_LMAN_syncVBlank(void);
+u8 rfu_LMAN_initializeManager(void (*LMAN_callback_p)(u8, u8), void (*MSC_callback_p)(u16));
+void rfu_LMAN_forceChangeSP(void);
+
+// GameFreak signatures
void AddTextPrinterToWindow1(const u8 *str);
bool32 MG_PrintTextOnWindow1AndWaitButton(u8 * cmdPtr, const u8 * src);
void LinkRfu_FatalError(void);
@@ -241,11 +361,10 @@ u8 sub_8116DE0(void);
void sub_80FBB4C(void);
void sub_80F86F4(void);
void sub_80FB128(bool32 a0);
-u32 sub_80FD3A4(void);
bool32 IsSendingKeysToRfu(void);
void Rfu_set_zero(void);
u8 GetRfuPlayerCount(void);
-void sub_80F9828(void);
+void StartSendingKeysToRfu(void);
u8 LinkRfu_GetMultiplayerId(void);
bool32 Rfu_InitBlockSend(const u8 * src, size_t size);
bool8 sub_80FA0F8(u8 a0);
@@ -254,58 +373,45 @@ void Rfu_SetBlockReceivedFlag(u8 who);
void Rfu_ResetBlockReceivedFlag(u8 who);
bool8 Rfu_IsMaster(void);
void sub_80F85F8(void);
-bool32 sub_80FAE94(void);
-bool32 sub_80FAEF0(void);
+bool32 LinkRfuMain1(void);
+bool32 LinkRfuMain2(void);
bool32 IsRfuRecvQueueEmpty(void);
u32 GetRfuRecvQueueLength(void);
void sub_80F8DC0(void);
void sub_80FBB20(void);
bool8 sub_80FA484(bool32 a0);
void var_800D_set_xB(void);
-struct GFtgtGname *sub_80F9800(void);
+struct GFtgtGname *GetHostRFUtgtGname(void);
void UpdateWirelessStatusIndicatorSprite(void);
void InitRFU(void);
-void sub_80FEB14(void);
bool32 sub_80FBA00(void);
-void sub_80FC478(struct UnkRfuStruct_2_Sub_124 *ptr);
-void sub_80FC4D4(struct UnkRfuStruct_2_Sub_9e8 *ptr);
+void RFU_queue_20_70_reset(struct UnkRfuStruct_2_Sub_124 *ptr);
+void RFU_queue_40_14_reset(struct UnkRfuStruct_2_Sub_9e8 *ptr);
-void sub_80FD4B0(const struct UnkLinkRfuStruct_02022B2C *unk0);
-u8 sub_80FD538(u8 r5, u16 r7, u16 r8, const u16 *r6);
-void sub_80FD760(bool8 a0);
-void sub_80FEA10(void (*func)(u16));
-void sub_80FB9E4(u8 a0, u16 a1);
+void sub_80FB9E4(u8 a0, u16 msg);
u8 sub_80FB9F4(void);
-void LinkRfu_REQ_SendData_HandleParentRelationship(bool8 clockChangeFlag);
-void sub_80FC588(struct UnkRfuStruct_2_Sub_124 *q1, u8 *q2);
-void sub_80FD52C(void);
-u8 sub_80FD610(u16 parentId, u16 unk_1a);
-bool8 sub_80FC79C(struct UnkRfuStruct_2_Sub_9e8 *q1, u8 *q2);
-bool8 sub_80FC888(struct UnkRfuStruct_2_Sub_c1c *q1, u8 *q2);
-void sub_80FC828(struct UnkRfuStruct_2_Sub_c1c *q1, const u8 *q2);
-bool8 sub_80FC6E8(struct UnkRfuStruct_2_Sub_124 * a0, u8 *a1);
-void sub_80FC63C(struct UnkRfuStruct_2_Sub_9e8 * a0, u8 *a1);
-u8 sub_80FEA34(u8 a0, u16 a1);
-void sub_80FDA30(u32 a0);
+void RFU_queue_20_70_recv(struct UnkRfuStruct_2_Sub_124 *q1, u8 *q2);
+bool8 RFU_queue_40_14_send(struct UnkRfuStruct_2_Sub_9e8 *q1, u8 *q2);
+bool8 RFU_queue_2_14_send(struct UnkRfuStruct_2_Sub_c1c *q1, u8 *q2);
+void RFU_queue_2_14_recv(struct UnkRfuStruct_2_Sub_c1c *q1, const u8 *q2);
+bool8 RFU_queue_20_70_send(struct UnkRfuStruct_2_Sub_124 * a0, u8 *a1);
+void RFU_queue_40_14_recv(struct UnkRfuStruct_2_Sub_9e8 * a0, u8 *a1);
void InitHostRFUtgtGname(struct GFtgtGname *data, u8 activity, bool32 r2, s32 r3);
-void LinkRfu_syncVBlank_(void);
-s32 sub_80FD430(void (*func1)(u8, u8), void (*func2)(u16));
-void sub_80FEB3C(void);
void sub_80FAFE0(u8 a0);
-bool32 sub_80FA44C(u32 a0);
+bool32 RfuSerialNumberIsValid(u32 a0);
bool8 sub_80FC1B0(void);
bool8 sub_80F8F40(void);
void sub_80F8F5C(void);
bool32 sub_80FA5D4(void);
bool32 sub_80FC1CC(void);
bool32 sub_80F8F7C(bool32 a0);
-bool32 sub_80FA634(u16 a0, const u8 *a1);
+bool32 sub_80FA634(u16 trainerId, const u8 *trainerName);
void sub_80FA670(u8 a0, u16 a1, const u8 *a2);
u32 sub_80FA6FC(u16 a0, const u8 *a1);
void SetHostRFUtgtGname(u8 a0, u32 a1, u32 a2);
void sub_80FBB8C(u32 a0);
-void sub_80FBD4C(const u8 *ptr, u16 a1);
+void sub_80FBD4C(const u8 *trainerName, u16 trainerId);
void LinkRfu3_SetGnameUnameFromStaticBuffers(struct GFtgtGname *gname, u8 *uname);
void sub_80FBBD8(void);
void sub_80FA6BC(void);
diff --git a/include/overworld.h b/include/overworld.h
index a7031e56d..b783248ce 100644
--- a/include/overworld.h
+++ b/include/overworld.h
@@ -147,7 +147,7 @@ void Overworld_ResetStateAfterTeleport(void);
void Overworld_FadeOutMapMusic(void);
void CB2_LoadMap(void);
bool8 BGMusicStopped(void);
-bool8 is_light_level_8_or_9(u8 mapType);
+bool8 IsMapTypeIndoors(u8 mapType);
bool32 sub_8055C9C(void);
void Overworld_ResetStateAfterDigEscRope(void);
bool32 sub_8058244(void);
diff --git a/include/union_room.h b/include/union_room.h
index 7e48b3e6e..0600d9cc0 100644
--- a/include/union_room.h
+++ b/include/union_room.h
@@ -4,6 +4,11 @@
#include "global.h"
#include "link_rfu.h"
+// Return value of IsRequestedTypeAndSpeciesInPlayerParty
+#define UR_TRADE_MATCH 0
+#define UR_TRADE_NOTYPE 1
+#define UR_TRADE_NOEGG 2
+
struct UnkStruct_Shared
{
struct GFtgtGname gname;
@@ -20,7 +25,7 @@ struct UnkStruct_x20
{
struct UnkStruct_Shared unk;
u16 field_18;
- u8 field_1A_0:2;
+ u8 tradeStatus:2;
u8 field_1A_1:1;
u8 field_1B;
u8 field_1D;
@@ -56,7 +61,7 @@ struct UnkStruct_Leader
u8 field_10;
u8 field_11;
u8 listTaskId;
- u8 field_13;
+ u8 playerCount;
u8 field_14;
u8 field_15;
u8 field_16;
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-05 03:44:05 +0000