mirror of
https://github.com/dolphin-emu/dolphin.git
synced 2025-01-11 00:29:11 +01:00
e149ad4f0a
SPDX standardizes how source code conveys its copyright and licensing information. See https://spdx.github.io/spdx-spec/1-rationale/ . SPDX tags are adopted in many large projects, including things like the Linux kernel.
113 lines
3.4 KiB
C++
113 lines
3.4 KiB
C++
// Copyright 2017 Dolphin Emulator Project
|
|
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
#pragma once
|
|
|
|
#include <cstddef>
|
|
#include <functional>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <unordered_set>
|
|
|
|
#include "Common/CommonTypes.h"
|
|
#include "Core/IOS/ES/Formats.h"
|
|
#include "Core/IOS/USB/Bluetooth/BTReal.h"
|
|
|
|
// Small utility functions for common Wii related tasks.
|
|
|
|
namespace DiscIO
|
|
{
|
|
class VolumeWAD;
|
|
}
|
|
|
|
namespace IOS::HLE
|
|
{
|
|
class BluetoothEmuDevice;
|
|
class ESDevice;
|
|
class Kernel;
|
|
} // namespace IOS::HLE
|
|
|
|
namespace IOS::HLE::FS
|
|
{
|
|
class FileSystem;
|
|
}
|
|
|
|
namespace WiiUtils
|
|
{
|
|
enum class InstallType
|
|
{
|
|
Permanent,
|
|
Temporary,
|
|
};
|
|
|
|
bool InstallWAD(IOS::HLE::Kernel& ios, const DiscIO::VolumeWAD& wad, InstallType type);
|
|
// Same as the above, but constructs a temporary IOS and VolumeWAD instance for importing
|
|
// and does a permanent install.
|
|
bool InstallWAD(const std::string& wad_path);
|
|
|
|
bool UninstallTitle(u64 title_id);
|
|
|
|
bool IsTitleInstalled(u64 title_id);
|
|
|
|
// Checks if there's a title.tmd imported for the given title ID.
|
|
bool IsTMDImported(IOS::HLE::FS::FileSystem& fs, u64 title_id);
|
|
|
|
// Searches for a TMD matching the given title ID in /title/00000001/00000002/data/tmds.sys.
|
|
// Returns it if it exists, otherwise returns an empty invalid TMD.
|
|
IOS::ES::TMDReader FindBackupTMD(IOS::HLE::FS::FileSystem& fs, u64 title_id);
|
|
|
|
// Checks if there's a title.tmd imported for the given title ID. If there is not, we attempt to
|
|
// re-import it from the TMDs stored in /title/00000001/00000002/data/tmds.sys.
|
|
// Returns true if, after this function call, we have an imported title.tmd, or false if not.
|
|
bool EnsureTMDIsImported(IOS::HLE::FS::FileSystem& fs, IOS::HLE::ESDevice& es, u64 title_id);
|
|
|
|
enum class UpdateResult
|
|
{
|
|
Succeeded,
|
|
AlreadyUpToDate,
|
|
|
|
// Current region does not match disc region.
|
|
RegionMismatch,
|
|
// Missing update partition on disc.
|
|
MissingUpdatePartition,
|
|
// Missing or invalid files on disc.
|
|
DiscReadFailed,
|
|
|
|
// NUS errors and failures.
|
|
ServerFailed,
|
|
// General download failures.
|
|
DownloadFailed,
|
|
|
|
// Import failures.
|
|
ImportFailed,
|
|
// Update was cancelled.
|
|
Cancelled,
|
|
};
|
|
|
|
// Return false to cancel the update as soon as the current title has finished updating.
|
|
using UpdateCallback = std::function<bool(size_t processed, size_t total, u64 title_id)>;
|
|
// Download and install the latest version of all titles (if missing) from NUS.
|
|
// If no region is specified, the region of the installed System Menu will be used.
|
|
// If no region is specified and no system menu is installed, the update will fail.
|
|
UpdateResult DoOnlineUpdate(UpdateCallback update_callback, const std::string& region);
|
|
|
|
// Perform a disc update with behaviour similar to the System Menu.
|
|
UpdateResult DoDiscUpdate(UpdateCallback update_callback, const std::string& image_path);
|
|
|
|
// Check the emulated NAND for common issues.
|
|
struct NANDCheckResult
|
|
{
|
|
bool bad = false;
|
|
std::unordered_set<u64> titles_to_remove;
|
|
};
|
|
NANDCheckResult CheckNAND(IOS::HLE::Kernel& ios);
|
|
bool RepairNAND(IOS::HLE::Kernel& ios);
|
|
|
|
// Get the BluetoothEmuDevice for an active emulation instance.
|
|
// It is only safe to call this from the CPU thread.
|
|
// Returns nullptr if we're not currently emulating a Wii game or if Bluetooth passthrough is used.
|
|
std::shared_ptr<IOS::HLE::BluetoothEmuDevice> GetBluetoothEmuDevice();
|
|
// Same as GetBluetoothEmuDevice, but for Bluetooth passthrough.
|
|
std::shared_ptr<IOS::HLE::BluetoothRealDevice> GetBluetoothRealDevice();
|
|
} // namespace WiiUtils
|