2022-02-13 18:54:39 +01:00
|
|
|
// SPDX-FileCopyrightText: Copyright 2022 yuzu Emulator Project
|
|
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <array>
|
|
|
|
|
2022-09-25 05:52:33 +02:00
|
|
|
#include "common/swap.h"
|
2022-08-30 07:33:47 +02:00
|
|
|
#include "core/hle/service/mii/types.h"
|
|
|
|
|
2022-02-13 18:54:39 +01:00
|
|
|
namespace Service::NFP {
|
2022-08-31 02:28:37 +02:00
|
|
|
static constexpr std::size_t amiibo_name_length = 0xA;
|
|
|
|
|
2022-02-13 18:54:39 +01:00
|
|
|
enum class ServiceType : u32 {
|
|
|
|
User,
|
|
|
|
Debug,
|
|
|
|
System,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class State : u32 {
|
|
|
|
NonInitialized,
|
|
|
|
Initialized,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class DeviceState : u32 {
|
|
|
|
Initialized,
|
|
|
|
SearchingForTag,
|
|
|
|
TagFound,
|
|
|
|
TagRemoved,
|
|
|
|
TagMounted,
|
2022-09-25 04:28:06 +02:00
|
|
|
Unavailable,
|
2022-02-13 18:54:39 +01:00
|
|
|
Finalized,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class ModelType : u32 {
|
|
|
|
Amiibo,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class MountTarget : u32 {
|
2022-09-25 04:28:06 +02:00
|
|
|
None,
|
2022-02-13 18:54:39 +01:00
|
|
|
Rom,
|
|
|
|
Ram,
|
|
|
|
All,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class AmiiboType : u8 {
|
|
|
|
Figure,
|
|
|
|
Card,
|
|
|
|
Yarn,
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class AmiiboSeries : u8 {
|
|
|
|
SuperSmashBros,
|
|
|
|
SuperMario,
|
|
|
|
ChibiRobo,
|
|
|
|
YoshiWoollyWorld,
|
|
|
|
Splatoon,
|
|
|
|
AnimalCrossing,
|
|
|
|
EightBitMario,
|
|
|
|
Skylanders,
|
|
|
|
Unknown8,
|
|
|
|
TheLegendOfZelda,
|
|
|
|
ShovelKnight,
|
|
|
|
Unknown11,
|
|
|
|
Kiby,
|
|
|
|
Pokemon,
|
|
|
|
MarioSportsSuperstars,
|
|
|
|
MonsterHunter,
|
|
|
|
BoxBoy,
|
|
|
|
Pikmin,
|
|
|
|
FireEmblem,
|
|
|
|
Metroid,
|
|
|
|
Others,
|
|
|
|
MegaMan,
|
|
|
|
Diablo,
|
|
|
|
};
|
|
|
|
|
2022-09-28 07:47:51 +02:00
|
|
|
enum class TagType : u32 {
|
|
|
|
None,
|
|
|
|
Type1, // ISO14443A RW 96-2k bytes 106kbit/s
|
|
|
|
Type2, // ISO14443A RW/RO 540 bytes 106kbit/s
|
|
|
|
Type3, // Sony Felica RW/RO 2k bytes 212kbit/s
|
|
|
|
Type4, // ISO14443A RW/RO 4k-32k bytes 424kbit/s
|
|
|
|
Type5, // ISO15693 RW/RO 540 bytes 106kbit/s
|
|
|
|
};
|
|
|
|
|
|
|
|
enum class TagProtocol : u32 {
|
|
|
|
None,
|
|
|
|
TypeA, // ISO14443A
|
|
|
|
TypeB, // ISO14443B
|
|
|
|
TypeF, // Sony Felica
|
|
|
|
};
|
|
|
|
|
2022-09-26 07:58:36 +02:00
|
|
|
using UniqueSerialNumber = std::array<u8, 7>;
|
|
|
|
using LockBytes = std::array<u8, 2>;
|
2022-02-13 18:54:39 +01:00
|
|
|
using HashData = std::array<u8, 0x20>;
|
|
|
|
using ApplicationArea = std::array<u8, 0xD8>;
|
2022-09-25 04:28:06 +02:00
|
|
|
using AmiiboName = std::array<char, (amiibo_name_length * 4) + 1>;
|
2022-02-13 18:54:39 +01:00
|
|
|
|
2022-09-26 07:58:36 +02:00
|
|
|
struct TagUuid {
|
|
|
|
UniqueSerialNumber uid;
|
|
|
|
u8 nintendo_id;
|
|
|
|
LockBytes lock_bytes;
|
|
|
|
};
|
|
|
|
static_assert(sizeof(TagUuid) == 10, "TagUuid is an invalid size");
|
|
|
|
|
2022-02-13 18:54:39 +01:00
|
|
|
struct AmiiboDate {
|
2022-09-25 05:52:33 +02:00
|
|
|
u16 raw_date{};
|
2022-09-25 04:28:06 +02:00
|
|
|
|
2022-09-25 05:52:33 +02:00
|
|
|
u16 GetValue() const {
|
|
|
|
return Common::swap16(raw_date);
|
2022-09-25 04:28:06 +02:00
|
|
|
}
|
2022-08-30 07:33:47 +02:00
|
|
|
|
|
|
|
u16 GetYear() const {
|
2022-09-25 05:52:33 +02:00
|
|
|
return static_cast<u16>(((GetValue() & 0xFE00) >> 9) + 2000);
|
2022-08-30 07:33:47 +02:00
|
|
|
}
|
|
|
|
u8 GetMonth() const {
|
2022-09-26 07:58:36 +02:00
|
|
|
return static_cast<u8>((GetValue() & 0x01E0) >> 5);
|
2022-08-30 07:33:47 +02:00
|
|
|
}
|
|
|
|
u8 GetDay() const {
|
2022-09-25 05:52:33 +02:00
|
|
|
return static_cast<u8>(GetValue() & 0x001F);
|
2022-09-25 04:28:06 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void SetYear(u16 year) {
|
2022-09-25 05:52:33 +02:00
|
|
|
const u16 year_converted = static_cast<u16>((year - 2000) << 9);
|
|
|
|
raw_date = Common::swap16((GetValue() & ~0xFE00) | year_converted);
|
2022-09-25 04:28:06 +02:00
|
|
|
}
|
|
|
|
void SetMonth(u8 month) {
|
2022-09-26 07:58:36 +02:00
|
|
|
const u16 month_converted = static_cast<u16>(month << 5);
|
2022-09-25 05:52:33 +02:00
|
|
|
raw_date = Common::swap16((GetValue() & ~0x01E0) | month_converted);
|
2022-09-25 04:28:06 +02:00
|
|
|
}
|
|
|
|
void SetDay(u8 day) {
|
2022-09-25 05:52:33 +02:00
|
|
|
const u16 day_converted = static_cast<u16>(day);
|
|
|
|
raw_date = Common::swap16((GetValue() & ~0x001F) | day_converted);
|
2022-08-30 07:33:47 +02:00
|
|
|
}
|
2022-02-13 18:54:39 +01:00
|
|
|
};
|
|
|
|
static_assert(sizeof(AmiiboDate) == 2, "AmiiboDate is an invalid size");
|
|
|
|
|
|
|
|
struct Settings {
|
|
|
|
union {
|
|
|
|
u8 raw{};
|
|
|
|
|
|
|
|
BitField<4, 1, u8> amiibo_initialized;
|
|
|
|
BitField<5, 1, u8> appdata_initialized;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
static_assert(sizeof(Settings) == 1, "AmiiboDate is an invalid size");
|
|
|
|
|
|
|
|
struct AmiiboSettings {
|
|
|
|
Settings settings;
|
|
|
|
u8 country_code_id;
|
|
|
|
u16_be crc_counter; // Incremented each time crc is changed
|
|
|
|
AmiiboDate init_date;
|
|
|
|
AmiiboDate write_date;
|
|
|
|
u32_be crc;
|
2022-08-31 02:28:37 +02:00
|
|
|
std::array<u16_be, amiibo_name_length> amiibo_name; // UTF-16 text
|
2022-02-13 18:54:39 +01:00
|
|
|
};
|
|
|
|
static_assert(sizeof(AmiiboSettings) == 0x20, "AmiiboSettings is an invalid size");
|
|
|
|
|
|
|
|
struct AmiiboModelInfo {
|
|
|
|
u16 character_id;
|
|
|
|
u8 character_variant;
|
|
|
|
AmiiboType amiibo_type;
|
2022-09-26 07:58:36 +02:00
|
|
|
u16_be model_number;
|
2022-02-13 18:54:39 +01:00
|
|
|
AmiiboSeries series;
|
|
|
|
u8 constant_value; // Must be 02
|
|
|
|
INSERT_PADDING_BYTES(0x4); // Unknown
|
|
|
|
};
|
|
|
|
static_assert(sizeof(AmiiboModelInfo) == 0xC, "AmiiboModelInfo is an invalid size");
|
|
|
|
|
|
|
|
struct NTAG215Password {
|
|
|
|
u32 PWD; // Password to allow write access
|
|
|
|
u16 PACK; // Password acknowledge reply
|
|
|
|
u16 RFUI; // Reserved for future use
|
|
|
|
};
|
|
|
|
static_assert(sizeof(NTAG215Password) == 0x8, "NTAG215Password is an invalid size");
|
|
|
|
|
|
|
|
#pragma pack(1)
|
|
|
|
struct EncryptedAmiiboFile {
|
2022-08-30 07:33:47 +02:00
|
|
|
u8 constant_value; // Must be A5
|
2022-09-25 04:28:06 +02:00
|
|
|
u16_be write_counter; // Number of times the amiibo has been written?
|
2022-08-30 07:33:47 +02:00
|
|
|
INSERT_PADDING_BYTES(0x1); // Unknown 1
|
|
|
|
AmiiboSettings settings; // Encrypted amiibo settings
|
2022-09-07 08:03:02 +02:00
|
|
|
HashData hmac_tag; // Hash
|
2022-08-30 07:33:47 +02:00
|
|
|
AmiiboModelInfo model_info; // Encrypted amiibo model info
|
|
|
|
HashData keygen_salt; // Salt
|
2022-09-07 08:03:02 +02:00
|
|
|
HashData hmac_data; // Hash
|
2022-08-30 07:33:47 +02:00
|
|
|
Service::Mii::Ver3StoreData owner_mii; // Encrypted Mii data
|
|
|
|
u64_be title_id; // Encrypted Game id
|
|
|
|
u16_be applicaton_write_counter; // Encrypted Counter
|
|
|
|
u32_be application_area_id; // Encrypted Game id
|
2022-02-13 18:54:39 +01:00
|
|
|
std::array<u8, 0x2> unknown;
|
2022-09-28 07:47:51 +02:00
|
|
|
std::array<u32, 0x8> unknown2;
|
2022-02-13 18:54:39 +01:00
|
|
|
ApplicationArea application_area; // Encrypted Game data
|
|
|
|
};
|
|
|
|
static_assert(sizeof(EncryptedAmiiboFile) == 0x1F8, "AmiiboFile is an invalid size");
|
|
|
|
|
|
|
|
struct NTAG215File {
|
2022-09-26 07:58:36 +02:00
|
|
|
LockBytes lock_bytes; // Tag UUID
|
2022-02-13 18:54:39 +01:00
|
|
|
u16 static_lock; // Set defined pages as read only
|
|
|
|
u32 compability_container; // Defines available memory
|
2022-09-07 08:03:02 +02:00
|
|
|
HashData hmac_data; // Hash
|
2022-02-13 18:54:39 +01:00
|
|
|
u8 constant_value; // Must be A5
|
2022-09-25 04:28:06 +02:00
|
|
|
u16_be write_counter; // Number of times the amiibo has been written?
|
2022-02-13 18:54:39 +01:00
|
|
|
INSERT_PADDING_BYTES(0x1); // Unknown 1
|
|
|
|
AmiiboSettings settings;
|
2022-08-30 07:33:47 +02:00
|
|
|
Service::Mii::Ver3StoreData owner_mii; // Encrypted Mii data
|
2022-02-13 18:54:39 +01:00
|
|
|
u64_be title_id;
|
|
|
|
u16_be applicaton_write_counter; // Encrypted Counter
|
|
|
|
u32_be application_area_id;
|
|
|
|
std::array<u8, 0x2> unknown;
|
2022-09-28 07:47:51 +02:00
|
|
|
std::array<u32, 0x8> unknown2;
|
2022-02-13 18:54:39 +01:00
|
|
|
ApplicationArea application_area; // Encrypted Game data
|
2022-09-07 08:03:02 +02:00
|
|
|
HashData hmac_tag; // Hash
|
2022-09-26 07:58:36 +02:00
|
|
|
UniqueSerialNumber uid; // Unique serial number
|
|
|
|
u8 nintendo_id; // Tag UUID
|
2022-02-13 18:54:39 +01:00
|
|
|
AmiiboModelInfo model_info;
|
|
|
|
HashData keygen_salt; // Salt
|
|
|
|
u32 dynamic_lock; // Dynamic lock
|
|
|
|
u32 CFG0; // Defines memory protected by password
|
|
|
|
u32 CFG1; // Defines number of verification attempts
|
|
|
|
NTAG215Password password; // Password data
|
|
|
|
};
|
|
|
|
static_assert(sizeof(NTAG215File) == 0x21C, "NTAG215File is an invalid size");
|
|
|
|
static_assert(std::is_trivially_copyable_v<NTAG215File>, "NTAG215File must be trivially copyable.");
|
|
|
|
#pragma pack()
|
|
|
|
|
|
|
|
struct EncryptedNTAG215File {
|
|
|
|
TagUuid uuid; // Unique serial number
|
|
|
|
u16 static_lock; // Set defined pages as read only
|
|
|
|
u32 compability_container; // Defines available memory
|
|
|
|
EncryptedAmiiboFile user_memory; // Writable data
|
|
|
|
u32 dynamic_lock; // Dynamic lock
|
|
|
|
u32 CFG0; // Defines memory protected by password
|
|
|
|
u32 CFG1; // Defines number of verification attempts
|
|
|
|
NTAG215Password password; // Password data
|
|
|
|
};
|
|
|
|
static_assert(sizeof(EncryptedNTAG215File) == 0x21C, "EncryptedNTAG215File is an invalid size");
|
|
|
|
static_assert(std::is_trivially_copyable_v<EncryptedNTAG215File>,
|
|
|
|
"EncryptedNTAG215File must be trivially copyable.");
|
|
|
|
|
2022-09-25 04:28:06 +02:00
|
|
|
struct TagInfo {
|
2022-09-26 07:58:36 +02:00
|
|
|
UniqueSerialNumber uuid;
|
|
|
|
INSERT_PADDING_BYTES(0x3);
|
2022-09-25 04:28:06 +02:00
|
|
|
u8 uuid_length;
|
|
|
|
INSERT_PADDING_BYTES(0x15);
|
2022-09-28 07:47:51 +02:00
|
|
|
TagProtocol protocol;
|
|
|
|
TagType tag_type;
|
2022-09-25 04:28:06 +02:00
|
|
|
INSERT_PADDING_BYTES(0x30);
|
|
|
|
};
|
|
|
|
static_assert(sizeof(TagInfo) == 0x58, "TagInfo is an invalid size");
|
|
|
|
|
|
|
|
struct WriteDate {
|
|
|
|
u16 year;
|
|
|
|
u8 month;
|
|
|
|
u8 day;
|
|
|
|
};
|
|
|
|
static_assert(sizeof(WriteDate) == 0x4, "WriteDate is an invalid size");
|
|
|
|
|
|
|
|
struct CommonInfo {
|
|
|
|
WriteDate last_write_date;
|
|
|
|
u16 write_counter;
|
|
|
|
u8 version;
|
|
|
|
INSERT_PADDING_BYTES(0x1);
|
|
|
|
u32 application_area_size;
|
|
|
|
INSERT_PADDING_BYTES(0x34);
|
|
|
|
};
|
|
|
|
static_assert(sizeof(CommonInfo) == 0x40, "CommonInfo is an invalid size");
|
|
|
|
|
|
|
|
struct ModelInfo {
|
|
|
|
u16 character_id;
|
|
|
|
u8 character_variant;
|
|
|
|
AmiiboType amiibo_type;
|
|
|
|
u16 model_number;
|
|
|
|
AmiiboSeries series;
|
|
|
|
INSERT_PADDING_BYTES(0x39); // Unknown
|
|
|
|
};
|
|
|
|
static_assert(sizeof(ModelInfo) == 0x40, "ModelInfo is an invalid size");
|
|
|
|
|
|
|
|
struct RegisterInfo {
|
|
|
|
Service::Mii::CharInfo mii_char_info;
|
|
|
|
WriteDate creation_date;
|
|
|
|
AmiiboName amiibo_name;
|
|
|
|
u8 font_region;
|
|
|
|
INSERT_PADDING_BYTES(0x7A);
|
|
|
|
};
|
|
|
|
static_assert(sizeof(RegisterInfo) == 0x100, "RegisterInfo is an invalid size");
|
|
|
|
|
2022-02-13 18:54:39 +01:00
|
|
|
} // namespace Service::NFP
|