pokeemerald/include/link_rfu.h

287 lines
9.4 KiB
C
Raw Normal View History

2017-11-11 04:08:17 +01:00
#ifndef GUARD_LINK_RFU_H
#define GUARD_LINK_RFU_H
2018-12-02 11:58:50 +01:00
#include "librfu.h"
2018-12-13 04:55:39 +01:00
#include "link.h"
2020-02-16 19:49:36 +01:00
#include "AgbRfu_LinkManager.h"
2018-12-02 11:58:50 +01:00
2020-08-24 20:52:33 +02:00
#define RFUCMD_SEND_PACKET 0x2F00
#define RFUCMD_BLENDER_SEND_KEYS 0x4400
#define RFUCMD_READY_CLOSE_LINK 0x5F00
#define RFUCMD_READY_EXIT_STANDBY 0x6600
#define RFUCMD_0x7700 0x7700
#define RFUCMD_0x7800 0x7800
#define RFUCMD_0x8800 0x8800
#define RFUCMD_0x8900 0x8900
#define RFUCMD_SEND_BLOCK_REQ 0xA100
#define RFUCMD_SEND_HELD_KEYS 0xBE00
#define RFUCMD_0xED00 0xED00
#define RFUCMD_0xEE00 0xEE00
2017-11-11 04:08:17 +01:00
#define RFU_SERIAL_7F7D 0x7F7D
#define RECV_QUEUE_NUM_SLOTS 32
#define RECV_QUEUE_SLOT_LENGTH (14 * MAX_RFU_PLAYERS)
#define SEND_QUEUE_NUM_SLOTS 40
#define SEND_QUEUE_SLOT_LENGTH 14
#define BACKUP_QUEUE_NUM_SLOTS 2
#define BACKUP_QUEUE_SLOT_LENGTH 14
2020-08-24 20:52:33 +02:00
#define RFU_PACKET_SIZE 6
2020-06-09 00:16:57 +02:00
#define RFU_STATUS_OK 0
#define RFU_STATUS_FATAL_ERROR 1
#define RFU_STATUS_CONNECTION_ERROR 2
#define RFU_STATUS_CHILD_SEND_COMPLETE 3
#define RFU_STATUS_NEW_CHILD_DETECTED 4
#define RFU_STATUS_JOIN_GROUP_OK 5
#define RFU_STATUS_JOIN_GROUP_NO 6
#define RFU_STATUS_WAIT_ACK_JOIN_GROUP 7
#define RFU_STATUS_LEAVE_GROUP_NOTICE 8
#define RFU_STATUS_LEAVE_GROUP 9
#define RFU_STATUS_10 10
#define RFU_STATUS_11 11
#define RFU_STATUS_ACK_JOIN_GROUP 12
2020-02-16 19:49:36 +01:00
// RfuTgtData.gname is read as these structs.
struct GFtgtGnameSub
2020-01-15 21:46:17 +01:00
{
2020-02-16 19:49:36 +01:00
u16 language:4;
u16 hasNews:1;
u16 hasCard:1;
2020-06-07 23:37:09 +02:00
u16 unknown:1; // Never read
2020-01-15 21:46:17 +01:00
u16 isChampion:1;
u16 hasNationalDex:1;
2020-02-16 19:49:36 +01:00
u16 gameClear:1;
u16 version:4;
2020-01-15 21:46:17 +01:00
u8 playerTrainerId[2];
};
2020-02-16 19:49:36 +01:00
struct __attribute__((packed, aligned(2))) GFtgtGname
2020-01-15 21:46:17 +01:00
{
2020-02-16 19:49:36 +01:00
struct GFtgtGnameSub unk_00;
u8 child_sprite_gender[RFU_CHILD_MAX]; // u8 sprite_idx:3;
// u8 gender:1;
// u8 unk_4:3
// u8 active:1
u16 species;
2020-02-16 19:49:36 +01:00
u8 activity:7;
u8 started:1;
2020-01-15 21:46:17 +01:00
u8 playerGender:1;
u8 level:7;
u8 type:6;
u8 padding:2;
2020-02-16 19:49:36 +01:00
}; // size: RFU_GNAME_SIZE
2020-01-15 21:46:17 +01:00
2020-06-06 22:46:19 +02:00
struct RfuBlockSend
2018-12-01 18:54:59 +01:00
{
2020-06-06 22:46:19 +02:00
/* 0x00 */ u16 next;
/* 0x02 */ u16 count;
/* 0x04 */ const u8 *payload;
/* 0x08 */ u32 receivedFlags;
/* 0x0c */ u32 failedFlags;
/* 0x10 */ bool8 sending;
/* 0x11 */ u8 owner;
/* 0x12 */ u8 receiving;
2017-12-05 01:51:26 +01:00
};
2020-06-06 22:46:19 +02:00
struct RfuRecvQueue
2018-12-01 18:54:59 +01:00
{
/* 0x000 */ u8 slots[RECV_QUEUE_NUM_SLOTS][RECV_QUEUE_SLOT_LENGTH];
2020-06-07 23:37:09 +02:00
/* 0x8c0 */ vu8 recvSlot;
/* 0x8c1 */ vu8 sendSlot;
2020-06-06 22:46:19 +02:00
/* 0x8c2 */ vu8 count;
/* 0x8c3 */ vu8 full;
2017-12-01 04:56:56 +01:00
};
2020-06-06 22:46:19 +02:00
struct RfuSendQueue
2018-12-01 18:54:59 +01:00
{
/* 0x000 */ u8 slots[SEND_QUEUE_NUM_SLOTS][SEND_QUEUE_SLOT_LENGTH];
2020-06-07 23:37:09 +02:00
/* 0x230 */ vu8 recvSlot;
/* 0x231 */ vu8 sendSlot;
2020-06-06 22:46:19 +02:00
/* 0x232 */ vu8 count;
/* 0x233 */ vu8 full;
2017-12-01 04:56:56 +01:00
};
2020-06-07 23:37:09 +02:00
struct RfuBackupQueue
2018-12-01 18:54:59 +01:00
{
/* 0x00 */ u8 slots[BACKUP_QUEUE_NUM_SLOTS][BACKUP_QUEUE_SLOT_LENGTH];
2020-06-07 23:37:09 +02:00
/* 0x1c */ vu8 recvSlot;
/* 0x1d */ vu8 sendSlot;
2020-06-06 22:46:19 +02:00
/* 0x1e */ vu8 count;
2017-12-02 03:51:06 +01:00
};
2020-06-06 22:46:19 +02:00
struct GFRfuManager
2018-12-01 18:54:59 +01:00
{
2020-06-06 22:46:19 +02:00
/* 0x000 */ void (*callback)(void);
/* 0x004 */ u16 state;
2018-01-21 00:43:58 +01:00
/* 0x006 */ u8 filler_06[4];
2020-06-06 22:46:19 +02:00
/* 0x00a */ u16 linkmanMsg;
/* 0x00c */ u8 parentChild;
2017-11-19 06:02:15 +01:00
/* 0x00d */ u8 playerCount;
/* 0x00e */ bool8 unk_0e;
2018-01-21 00:43:58 +01:00
/* 0x00f */ u8 unk_0f;
/* 0x010 */ u16 unk_10;
/* 0x012 */ u16 unk_12;
/* 0x014 */ u8 unk_14[RFU_CHILD_MAX][14];
2017-12-08 14:24:54 +01:00
/* 0x04c */ u8 unk_4c[14];
2020-08-13 09:09:47 +02:00
/* 0x05a */ u8 blockRequestType;
2018-01-20 16:16:09 +01:00
/* 0x05b */ u8 unk_5b;
2020-06-07 23:37:09 +02:00
/* 0x05c */ bool8 blockReceived[MAX_RFU_PLAYERS];
/* 0x061 */ bool8 numBlocksReceived[MAX_RFU_PLAYERS];
2020-06-06 22:46:19 +02:00
/* 0x066 */ u8 idleTaskId;
/* 0x067 */ u8 searchTaskId;
2017-12-07 06:28:12 +01:00
/* 0x068 */ u8 filler_68[4];
/* 0x06c */ struct RfuBlockSend sendBlock;
/* 0x080 */ struct RfuBlockSend recvBlock[MAX_RFU_PLAYERS];
2020-08-13 09:09:47 +02:00
/* 0x0e4 */ bool8 readyCloseLink[MAX_RFU_PLAYERS];
/* 0x0e9 */ bool8 readyExitStandby[MAX_RFU_PLAYERS];
2020-06-06 22:46:19 +02:00
/* 0x0ee */ vu8 errorState;
/* 0x0ef */ bool8 isShuttingDown;
/* 0x0f0 */ u8 linkLossRecoveryState;
2020-06-09 00:16:57 +02:00
/* 0x0f1 */ u8 status;
2020-08-24 20:52:33 +02:00
/* 0x0f2 */ u16 packet[RFU_PACKET_SIZE];
2020-08-13 09:09:47 +02:00
/* 0x0fe */ u16 resendExitStandbyTimer;
2018-01-20 03:50:30 +01:00
/* 0x100 */ u16 unk_100;
2018-01-18 19:18:24 +01:00
/* 0x102 */ u8 unk_102;
2018-12-01 18:54:59 +01:00
/* 0x103 */ u8 filler_103[0x10A - 0x103];
2020-02-16 19:49:36 +01:00
/* 0x10A */ struct GFtgtGname unk_10A;
2018-12-02 11:58:50 +01:00
u8 filler_;
u8 playerName[PLAYER_NAME_LENGTH + 1];
2020-06-06 22:46:19 +02:00
/* 0x124 */ struct RfuRecvQueue recvQueue;
/* 0x9e8 */ struct RfuSendQueue sendQueue;
2020-06-07 23:37:09 +02:00
/* 0xc1c */ struct RfuBackupQueue backupQueue;
/* 0xc3c */ vu8 linkRecovered;
2017-12-10 16:23:43 +01:00
/* 0xc3d */ u8 unk_c3d;
2020-06-06 22:46:19 +02:00
/* 0xc3e */ vu8 childSlot;
2017-12-07 14:48:49 +01:00
/* 0xc3f */ u8 unk_c3f[70];
2018-01-20 21:50:45 +01:00
/* 0xc85 */ u8 unk_c85;
2020-06-09 00:16:57 +02:00
/* 0xc86 */ u8 recvStatus;
2020-06-06 22:46:19 +02:00
/* 0xc87 */ u8 recvCmds[5][7][2];
/* 0xccd */ u8 parentId;
/* 0xcce */ u8 multiplayerId;
2018-01-20 03:50:30 +01:00
/* 0xccf */ u8 unk_ccf;
2017-12-08 02:21:30 +01:00
/* 0xcd0 */ vu8 unk_cd0;
2020-06-09 00:16:57 +02:00
/* 0xcd1 */ u8 partnerSendStatuses[RFU_CHILD_MAX];
/* 0xcd5 */ u8 partnerRecvStatuses[RFU_CHILD_MAX];
2018-01-18 14:46:17 +01:00
/* 0xcd9 */ u8 unk_cd9;
2017-12-08 02:21:30 +01:00
/* 0xcda */ u8 unk_cda;
/* 0xcdb */ vbool8 unk_cdb;
/* 0xcdc */ vbool8 unk_cdc;
2017-12-16 18:07:20 +01:00
/* 0xcdd */ u8 unk_cdd;
2020-06-06 22:46:19 +02:00
/* 0xcde */ u8 linkPlayerIdx[RFU_CHILD_MAX];
2017-12-07 14:48:49 +01:00
/* 0xce2 */ u8 unk_ce2;
/* 0xce2 */ u8 unk_ce3;
2017-12-07 06:28:12 +01:00
/* 0xce4 */ u8 unk_ce4;
2018-01-18 14:46:17 +01:00
/* 0xce5 */ u8 unk_ce5;
/* 0xce5 */ u8 unk_ce6;
2020-06-06 22:46:19 +02:00
/* 0xce7 */ u8 acceptSlot_flag;
2017-12-08 02:04:07 +01:00
/* 0xce8 */ u8 unk_ce8;
2018-01-18 14:46:17 +01:00
/* 0xce9 */ u8 unk_ce9;
/* 0xcea */ u8 unk_cea[4];
/* 0xcee */ u8 unk_cee[4];
2017-12-05 01:51:26 +01:00
}; // size = 0xcf4
2017-11-17 05:37:09 +01:00
2017-11-11 04:08:17 +01:00
// Exported RAM declarations
2020-06-06 22:46:19 +02:00
extern struct GFtgtGname gHostRFUtgtGnameBuffer;
extern u8 gHostRFUtgtUnameBuffer[];
extern struct GFRfuManager Rfu;
extern u8 gWirelessStatusIndicatorSpriteId;
2017-11-17 05:37:09 +01:00
2017-11-11 04:08:17 +01:00
// Exported ROM declarations
void WipeTrainerNameRecords(void);
void InitRFUAPI(void);
2020-05-30 10:09:21 +02:00
void LinkRfu_Shutdown(void);
2020-06-06 22:46:19 +02:00
void Rfu_SetBlockReceivedFlag(u8 who);
void Rfu_ResetBlockReceivedFlag(u8 who);
bool32 IsSendingKeysToRfu(void);
2020-06-06 22:46:19 +02:00
void StartSendingKeysToRfu(void);
2020-08-24 20:52:33 +02:00
void Rfu_SetBerryBlenderLinkCallback(void);
2020-06-06 22:46:19 +02:00
u8 Rfu_GetBlockReceivedStatus(void);
bool32 Rfu_InitBlockSend(const u8 *src, size_t size);
2019-10-05 16:41:37 +02:00
void ClearLinkRfuCallback(void);
2020-06-06 22:46:19 +02:00
u8 Rfu_GetLinkPlayerCount(void);
u8 Rfu_GetMultiplayerId(void);
2020-08-13 09:09:47 +02:00
bool8 Rfu_SendBlockRequest(u8 type);
2019-10-09 11:56:44 +02:00
bool8 IsLinkRfuTaskFinished(void);
2017-11-13 04:09:11 +01:00
bool8 Rfu_IsMaster(void);
2020-08-13 09:09:47 +02:00
void Rfu_SetCloseLinkCallback(void);
void Rfu_SetLinkStandbyCallback(void);
2020-06-06 22:46:19 +02:00
void ResetLinkRfuGFLayer(void);
2020-06-07 23:37:09 +02:00
void UpdateWirelessStatusIndicatorSprite(void);
2020-06-06 22:46:19 +02:00
void InitRFU(void);
2017-11-13 07:01:27 +01:00
bool32 sub_8010EC0(void);
bool32 sub_8010F1C(void);
2020-06-09 00:16:57 +02:00
bool32 RfuHasErrored(void);
bool32 IsRfuRecvQueueEmpty(void);
u32 GetRfuRecvQueueLength(void);
2017-11-14 14:44:32 +01:00
void RfuVSync(void);
2017-12-05 03:05:41 +01:00
void sub_80111B0(bool32 a0);
2020-06-09 00:16:57 +02:00
u8 RfuGetStatus(void);
2020-05-30 10:09:21 +02:00
struct GFtgtGname *GetHostRFUtgtGname(void);
void UpdateGameData_GroupLockedIn(u8 a0);
2020-06-06 22:46:19 +02:00
void GetLinkmanErrorParams(u32 a0);
2020-06-09 00:16:57 +02:00
void RfuSetStatus(u8 a0, u16 a1);
2018-05-20 10:51:09 +02:00
u8 sub_801048C(bool32 a0);
2020-05-30 10:09:21 +02:00
void LinkRfu3_SetGnameUnameFromStaticBuffers(struct GFtgtGname *buff1, u8 *buff2);
2020-06-09 00:16:57 +02:00
void SetHostRFUtgtGname(u8 activity, u32 child_sprite_genders, bool32 started);
2020-05-30 10:09:21 +02:00
void InitializeRfuLinkManager_LinkLeader(u32 a0);
2018-06-03 09:37:01 +02:00
bool32 sub_8012240(void);
2020-05-30 10:09:21 +02:00
void LinkRfu_StopManagerAndFinalizeSlots(void);
2018-06-03 09:37:01 +02:00
bool32 sub_80105EC(void);
2020-06-09 00:16:57 +02:00
bool32 HasTrainerLeftPartnersList(u16 trainerId, const u8 *name);
void SendRfuStatusToPartner(u8 status, u16 trainerId, const u8 *name);
u32 WaitSendRfuStatusToPartner(u16 trainerId, const u8 *name);
2020-05-30 10:09:21 +02:00
void RequestDisconnectSlotByTrainerNameAndId(const u8 *a0, u16 a1);
bool8 LmanAcceptSlotFlagIsNotZero(void);
bool32 WaitRfuState(bool32 a0);
2018-06-03 09:37:01 +02:00
void sub_801103C(void);
2020-05-30 10:09:21 +02:00
void InitializeRfuLinkManager_JoinGroup(void);
2020-06-09 00:16:57 +02:00
void SendLeaveGroupNotice(void);
void RecordMixTrainerNames(void);
2020-05-30 10:09:21 +02:00
void LinkRfu_CreateConnectionAsParent(void);
void LinkRfu_StopManagerBeforeEnteringChat(void);
2020-06-09 00:16:57 +02:00
void UpdateGameData_SetActivity(u8 activity, u32 flags, bool32 started);
2020-05-30 10:09:21 +02:00
void CreateTask_RfuReconnectWithParent(const u8 *src, u16 trainerId);
void SetGnameBufferWonderFlags(bool32 a0, bool32 a1);
void ClearAndInitHostRFUtgtGname(void);
2020-06-06 22:46:19 +02:00
void SetTradeBoardRegisteredMonInfo(u32 type, u32 species, u32 level);
2020-05-30 10:09:21 +02:00
void InitializeRfuLinkManager_EnterUnionRoom(void);
2020-02-16 19:49:36 +01:00
void sub_8012188(const u8 *name, struct GFtgtGname *structPtr, u8 a2);
2020-05-30 10:09:21 +02:00
bool32 IsUnionRoomListenTaskActive(void);
2020-08-24 20:52:33 +02:00
void Rfu_SendPacket(void *data);
2020-05-30 10:09:21 +02:00
bool32 PlayerHasMetTrainerBefore(u16 id, u8 *name);
2018-06-09 22:14:52 +02:00
void sub_8011DE0(u32 arg0);
2019-06-29 04:26:11 +02:00
u8 sub_801100C(s32 a0);
2018-06-10 18:28:37 +02:00
void sub_800EF7C(void);
2020-05-30 10:09:21 +02:00
bool8 LinkRfu_GetNameIfCompatible(struct GFtgtGname *buff1, u8 *buff2, u8 idx);
bool8 LinkRfu_GetNameIfSerial7F7D(struct GFtgtGname *buff1, u8 *buff2, u8 idx);
2018-12-19 02:29:41 +01:00
s32 sub_800E87C(u8 idx);
2020-06-06 22:46:19 +02:00
void CreateTask_RfuIdle(void);
void DestroyTask_RfuIdle(void);
2021-03-01 07:54:51 +01:00
void ClearRecvCommands(void);
void LinkRfu_FatalError(void);
2019-03-27 01:03:46 +01:00
bool32 sub_8011A9C(void);
void sub_80104B0(void);
void sub_8011A50(void);
void sub_80110B8(u32 a0);
2020-06-07 23:37:09 +02:00
bool32 IsRfuSerialNumberValid(u32 serialNo);
bool8 IsRfuRecoveringFromLinkLoss(void);
void RfuRecvQueue_Reset(struct RfuRecvQueue *queue);
void RfuSendQueue_Reset(struct RfuSendQueue *queue);
void RfuRecvQueue_Enqueue(struct RfuRecvQueue *queue, u8 *data);
void RfuSendQueue_Enqueue(struct RfuSendQueue *queue, u8 *data);
bool8 RfuRecvQueue_Dequeue(struct RfuRecvQueue *queue, u8 *dest);
bool8 RfuSendQueue_Dequeue(struct RfuSendQueue *queue, u8 *dest);
void RfuBackupQueue_Enqueue(struct RfuBackupQueue *queue, const u8 *q2);
bool8 RfuBackupQueue_Dequeue(struct RfuBackupQueue *queue, u8 *q2);
void InitHostRFUtgtGname(struct GFtgtGname *data, u8 activity, bool32 started, s32 child_sprite_genders);
2020-02-16 19:49:36 +01:00
void CreateWirelessStatusIndicatorSprite(u8 x, u8 y);
void DestroyWirelessStatusIndicatorSprite(void);
void LoadWirelessStatusIndicatorSpriteGfx(void);
2017-11-11 04:08:17 +01:00
#endif //GUARD_LINK_RFU_H