// SPDX-FileCopyrightText: Copyright 2022 yuzu Emulator Project // SPDX-License-Identifier: GPL-3.0-or-later #pragma once #include #include "common/swap.h" #include "core/hle/service/mii/types.h" namespace Service::NFP { static constexpr std::size_t amiibo_name_length = 0xA; enum class ServiceType : u32 { User, Debug, System, }; enum class State : u32 { NonInitialized, Initialized, }; enum class DeviceState : u32 { Initialized, SearchingForTag, TagFound, TagRemoved, TagMounted, Unavailable, Finalized, }; enum class ModelType : u32 { Amiibo, }; enum class MountTarget : u32 { None, 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, }; 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 PackedTagType : u8 { 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 }; using UniqueSerialNumber = std::array; using LockBytes = std::array; using HashData = std::array; using ApplicationArea = std::array; using AmiiboName = std::array; struct TagUuid { UniqueSerialNumber uid; u8 nintendo_id; LockBytes lock_bytes; }; static_assert(sizeof(TagUuid) == 10, "TagUuid is an invalid size"); struct WriteDate { u16 year; u8 month; u8 day; }; static_assert(sizeof(WriteDate) == 0x4, "WriteDate is an invalid size"); struct AmiiboDate { u16 raw_date{}; u16 GetValue() const { return Common::swap16(raw_date); } u16 GetYear() const { return static_cast(((GetValue() & 0xFE00) >> 9) + 2000); } u8 GetMonth() const { return static_cast((GetValue() & 0x01E0) >> 5); } u8 GetDay() const { return static_cast(GetValue() & 0x001F); } WriteDate GetWriteDate() const { if (!IsValidDate()) { return { .year = 2000, .month = 1, .day = 1, }; } return { .year = GetYear(), .month = GetMonth(), .day = GetDay(), }; } void SetYear(u16 year) { const u16 year_converted = static_cast((year - 2000) << 9); raw_date = Common::swap16((GetValue() & ~0xFE00) | year_converted); } void SetMonth(u8 month) { const u16 month_converted = static_cast(month << 5); raw_date = Common::swap16((GetValue() & ~0x01E0) | month_converted); } void SetDay(u8 day) { const u16 day_converted = static_cast(day); raw_date = Common::swap16((GetValue() & ~0x001F) | day_converted); } bool IsValidDate() const { const bool is_day_valid = GetDay() > 0 && GetDay() < 32; const bool is_month_valid = GetMonth() > 0 && GetMonth() < 13; const bool is_year_valid = GetYear() >= 2000; return is_year_valid && is_month_valid && is_day_valid; } }; 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; std::array amiibo_name; // UTF-16 text }; static_assert(sizeof(AmiiboSettings) == 0x20, "AmiiboSettings is an invalid size"); struct AmiiboModelInfo { u16 character_id; u8 character_variant; AmiiboType amiibo_type; u16_be model_number; AmiiboSeries series; PackedTagType tag_type; 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 { u8 constant_value; // Must be A5 u16_be write_counter; // Number of times the amiibo has been written? INSERT_PADDING_BYTES(0x1); // Unknown 1 AmiiboSettings settings; // Encrypted amiibo settings HashData hmac_tag; // Hash AmiiboModelInfo model_info; // Encrypted amiibo model info HashData keygen_salt; // Salt HashData hmac_data; // Hash 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 std::array unknown; std::array unknown2; ApplicationArea application_area; // Encrypted Game data }; static_assert(sizeof(EncryptedAmiiboFile) == 0x1F8, "AmiiboFile is an invalid size"); struct NTAG215File { LockBytes lock_bytes; // Tag UUID u16 static_lock; // Set defined pages as read only u32 compability_container; // Defines available memory HashData hmac_data; // Hash u8 constant_value; // Must be A5 u16_be write_counter; // Number of times the amiibo has been written? INSERT_PADDING_BYTES(0x1); // Unknown 1 AmiiboSettings settings; Service::Mii::Ver3StoreData owner_mii; // Encrypted Mii data u64_be title_id; u16_be applicaton_write_counter; // Encrypted Counter u32_be application_area_id; std::array unknown; std::array unknown2; ApplicationArea application_area; // Encrypted Game data HashData hmac_tag; // Hash UniqueSerialNumber uid; // Unique serial number u8 nintendo_id; // Tag UUID 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 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 must be trivially copyable."); struct TagInfo { UniqueSerialNumber uuid; INSERT_PADDING_BYTES(0x3); u8 uuid_length; INSERT_PADDING_BYTES(0x15); TagProtocol protocol; TagType tag_type; INSERT_PADDING_BYTES(0x30); }; static_assert(sizeof(TagInfo) == 0x58, "TagInfo 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"); } // namespace Service::NFP