Files
AnyPS5/core/libs/tests/GuestUsbd.cpp
T

313 lines
20 KiB
C++

#include "prx/libSceUsbd/include/Api.hpp"
#include "prx/libc/include/general/VabiMacros.hpp"
#include <chrono>
#include <cstdint>
#include <cstdio>
#include <atomic>
#include <cstdlib>
#include <cstring>
#include <string>
#include <thread>
#include <stdexcept>
namespace {
}
namespace {
constexpr std::int32_t invalidArgument = static_cast<std::int32_t>(0x80240002);
void Require(bool condition, const char* message) {
if (!condition) {
std::fprintf(stderr, "USBD: %s\n", message);
std::abort();
}
}
template<typename TCall>
bool Throws(TCall call) {
try {
call();
} catch (const std::runtime_error&) {
return true;
}
return false;
}
void APS5_VABI MarkDone(UsbdTransfer* transfer) {
*static_cast<int*>(transfer->userData) += 1;
}
void APS5_VABI MarkDoneThenSignal(UsbdTransfer* transfer) {
auto* notified = static_cast<std::atomic<bool>*>(transfer->userData);
notified->store(true, std::memory_order_release);
}
void Pump(const int& done) {
const UsbdTimeval slice{0, 100000};
for (int round = 0; round < 50 && done == 0; ++round) Require(sceUsbdHandleEventsTimeout(&slice) == 0, "event handling failed while a transfer was in flight");
}
void Device() {
const char* wanted = std::getenv("APS5_USBD_DEVICE");
Require(wanted != nullptr, "APS5_USBD_DEVICE is not set to vendor:product in hex");
const unsigned long vendor = std::strtoul(wanted, nullptr, 16);
const char* separator = std::strchr(wanted, ':');
Require(separator != nullptr, "APS5_USBD_DEVICE has no ':'");
const unsigned long product = std::strtoul(separator + 1, nullptr, 16);
void** list = nullptr;
const std::int64_t count = sceUsbdGetDeviceList(&list);
void* device = nullptr;
std::uint8_t descriptor[18] = {};
for (std::int64_t index = 0; index < count && device == nullptr; ++index) {
Require(sceUsbdGetDeviceDescriptor(list[index], descriptor) == 0, "device descriptor failed");
if ((descriptor[8] | descriptor[9] << 8) == vendor && (descriptor[10] | descriptor[11] << 8) == product) device = sceUsbdRefDevice(list[index]);
}
sceUsbdFreeDeviceList(list, 1);
Require(device != nullptr, "the APS5_USBD_DEVICE device was not listed");
std::printf("device bus %u address %u\n", sceUsbdGetBusNumber(device), sceUsbdGetDeviceAddress(device));
void* config = nullptr;
Require(sceUsbdGetActiveConfigDescriptor(device, &config) == 0 && config != nullptr, "active config descriptor failed");
const auto* raw = static_cast<const std::uint8_t*>(config);
Require(raw[1] == 2 && raw[4] > 0, "active config descriptor is not a configuration with interfaces");
const std::uint8_t interfaces = raw[4];
const std::uint8_t activeValue = raw[5];
sceUsbdFreeConfigDescriptor(config);
Require(Throws([&] { sceUsbdFreeConfigDescriptor(config); }), "a config descriptor was freed twice");
Require(sceUsbdGetConfigDescriptor(device, 0, &config) == 0, "config descriptor 0 failed");
sceUsbdFreeConfigDescriptor(config);
Require(sceUsbdGetConfigDescriptorByValue(device, activeValue, &config) == 0 && config != nullptr, "config descriptor by value failed");
Require(static_cast<const std::uint8_t*>(config)[5] == activeValue, "config descriptor by value has another configuration value");
sceUsbdFreeConfigDescriptor(config);
Require(sceUsbdGetConfigDescriptorByValue(device, 0, &config) == static_cast<std::int32_t>(0x80240005) && config == nullptr, "configuration value 0 was found");
void* handle = nullptr;
Require(sceUsbdOpen(device, &handle) == 0 && handle != nullptr, "opening the device failed");
Require(sceUsbdCheckConnected(handle) == 0, "an open device was reported disconnected");
std::int32_t configuration = -1;
Require(sceUsbdGetConfiguration(handle, &configuration) == 0 && configuration == activeValue, "configuration differs from the active config descriptor");
std::uint8_t text[256] = {};
if (descriptor[15] != 0) {
const std::int32_t length = sceUsbdGetStringDescriptor(handle, descriptor[15], 0x409, text, sizeof(text));
Require(length >= 2 && text[1] == 3, "product string descriptor failed");
std::string product_name;
for (std::int32_t index = 2; index + 1 < length; index += 2) product_name += static_cast<char>(text[index]);
std::printf("product \"%s\"\n", product_name.c_str());
char ascii[256] = {};
const std::int32_t asciiLength = sceUsbdGetStringDescriptorAscii(handle, descriptor[15], reinterpret_cast<std::uint8_t*>(ascii), sizeof(ascii));
Require(asciiLength >= 0 && std::strlen(ascii) == static_cast<std::size_t>(asciiLength), "ASCII product string length differs from its terminated length");
std::printf("ASCII product \"%s\"\n", ascii);
std::uint8_t languages[4] = {};
Require(sceUsbdGetStringDescriptor(handle, 0, 0, languages, sizeof(languages)) == 4, "language ID string descriptor failed");
std::uint8_t first[256] = {};
const std::int32_t firstLength = sceUsbdGetStringDescriptor(handle, descriptor[15], static_cast<std::uint16_t>(languages[2] | languages[3] << 8), first, sizeof(first));
Require(firstLength >= 2 && first[1] == 3, "product string descriptor in the first language failed");
const std::int32_t end = first[0] < firstLength ? first[0] : firstLength;
std::string printable;
for (std::int32_t index = 2; index + 1 < end; index += 2) {
if (first[index + 1] == 0 && first[index] >= 0x20 && first[index] <= 0x7E && first[index] != '<' && first[index] != '>') printable += static_cast<char>(first[index]);
}
Require(printable == ascii, "ASCII product string differs from the printable characters of the product string");
char shortAscii[4] = {'x', 'x', 'x', 'x'};
const std::int32_t shortLength = sceUsbdGetStringDescriptorAscii(handle, descriptor[15], reinterpret_cast<std::uint8_t*>(shortAscii), sizeof(shortAscii));
Require(shortLength >= 0 && shortLength <= 3 && shortAscii[shortLength] == 0 && std::strncmp(shortAscii, ascii, static_cast<std::size_t>(shortLength)) == 0, "a short ASCII buffer was not filled with a terminated prefix");
}
std::uint8_t again[18] = {};
Require(sceUsbdControlTransfer(handle, 0x80, 6, 0x0100, 0, again, sizeof(again), 1000) == 18, "synchronous device descriptor request failed");
Require(std::memcmp(again, descriptor, sizeof(again)) == 0, "device descriptor read over the wire differs from the cached one");
std::uint8_t wire[18] = {};
Require(sceUsbdGetDescriptor(handle, 1, 0, wire, sizeof(wire)) == 18, "device descriptor request through sceUsbdGetDescriptor failed");
Require(std::memcmp(wire, descriptor, sizeof(wire)) == 0, "device descriptor read through sceUsbdGetDescriptor differs from the cached one");
for (std::int32_t interfaceNumber = 0; interfaceNumber < interfaces; ++interfaceNumber) {
Require(sceUsbdClaimInterface(handle, interfaceNumber) == 0, "claiming an interface failed");
Require(sceUsbdReleaseInterface(handle, interfaceNumber) == 0, "releasing an interface failed");
}
Require(sceUsbdReleaseInterface(handle, 0) == static_cast<std::int32_t>(0x80240005), "releasing an unclaimed interface did not report not found");
Require(sceUsbdGetConfigDescriptor(device, 0, &config) == 0, "config descriptor 0 for the endpoint scan failed");
const std::uint8_t* config0 = static_cast<const std::uint8_t*>(config);
const std::uint8_t* interfaceArray = *reinterpret_cast<const std::uint8_t* const*>(config0 + 16);
std::uint8_t interruptAddress = 0;
std::uint16_t interruptMax = 0;
if (interfaceArray == nullptr) {
Require(false, "the active config descriptor has no interface array");
}
for (std::uint8_t index = 0; index < interfaces && interruptAddress == 0; ++index) {
const std::uint8_t* alternate = *reinterpret_cast<const std::uint8_t* const*>(interfaceArray + index * 16);
if (alternate == nullptr) continue;
const std::uint8_t* endpoints = *reinterpret_cast<const std::uint8_t* const*>(alternate + 16);
if (endpoints == nullptr) continue;
for (std::uint8_t endpoint = 0; endpoint < alternate[4]; ++endpoint) {
const std::uint8_t* item = endpoints + endpoint * 32;
if ((item[2] & 0x80) != 0 && (item[3] & 3) == 3) {
interruptAddress = item[2];
interruptMax = static_cast<std::uint16_t>(item[4] | item[5] << 8);
}
}
}
Require(interruptAddress != 0 && interruptMax != 0, "the device has no interrupt IN endpoint");
sceUsbdFreeConfigDescriptor(config);
auto* transfer = reinterpret_cast<UsbdTransfer*>(sceUsbdAllocTransfer(0));
std::uint8_t setup[8 + 18] = {0x80, 6, 0x00, 0x01, 0x00, 0x00, 18, 0};
int done = 0;
transfer->deviceHandle = handle;
transfer->type = 0;
transfer->timeout = 1000;
transfer->buffer = setup;
transfer->length = sizeof(setup);
transfer->callback = MarkDone;
transfer->userData = &done;
Require(sceUsbdSubmitTransfer(reinterpret_cast<UsbdTransfer*>(transfer)) == 0, "submitting an asynchronous control transfer failed");
Require(Throws([&] { sceUsbdFreeTransfer(reinterpret_cast<UsbdTransfer*>(transfer)); }), "an in-flight transfer was freed");
Pump(done);
Require(done == 1 && transfer->status == 0 && transfer->actualLength == 18, "asynchronous control transfer did not complete");
Require(std::memcmp(setup + 8, descriptor, 18) == 0, "asynchronous device descriptor differs from the cached one");
bool broken = false;
{
const UsbdTimeval slice{0, 200};
for (int round = 0; round < 300 && !broken; ++round) {
std::atomic<bool> notified{false};
std::uint8_t blink[64] = {};
sceUsbdFillInterruptTransfer(reinterpret_cast<UsbdTransfer*>(transfer), handle, interruptAddress, blink, interruptMax, &MarkDoneThenSignal, &notified, 0);
const int submitResult = sceUsbdSubmitTransfer(reinterpret_cast<UsbdTransfer*>(transfer));
if (submitResult != 0) {
broken = true;
break;
}
std::thread canceller([&] {
const int outcome = sceUsbdCancelTransfer(reinterpret_cast<UsbdTransfer*>(transfer));
if (outcome != 0 && outcome != static_cast<std::int32_t>(0x80240005)) broken = true;
});
while (!notified.load(std::memory_order_acquire)) {
if (sceUsbdHandleEventsTimeout(&slice) != 0) broken = true;
}
canceller.join();
if (transfer->status != 0 && transfer->status != 2 && transfer->status != 3) broken = true;
}
}
Require(!broken, "the cancel race failed");
Require(sceUsbdCancelTransfer(reinterpret_cast<UsbdTransfer*>(transfer)) == static_cast<std::int32_t>(0x80240005), "cancelling a completed transfer did not report not found");
sceUsbdFreeTransfer(reinterpret_cast<UsbdTransfer*>(transfer));
sceUsbdClose(handle);
Require(Throws([&] { sceUsbdClose(handle); }), "a handle was closed twice");
sceUsbdUnrefDevice(device);
std::puts("USBD device tests passed");
}
}
int main(int argc, char** argv) {
Require(sceUsbdInit() == 0, "initialization failed");
void** list = nullptr;
const std::int64_t count = sceUsbdGetDeviceList(&list);
Require(count >= 0 && list != nullptr && list[count] == nullptr, "device list is not a null-terminated array of the reported length");
for (std::int64_t index = 0; index < count; ++index) {
std::uint8_t deviceDescriptor[18] = {};
Require(sceUsbdGetDeviceDescriptor(list[index], deviceDescriptor) == 0 && deviceDescriptor[0] == 18 && deviceDescriptor[1] == 1, "listed device has no device descriptor");
Require(sceUsbdRefDevice(list[index]) == list[index], "listed device was not referenced");
sceUsbdUnrefDevice(list[index]);
}
sceUsbdFreeDeviceList(list, 1);
Require(Throws([&] { sceUsbdFreeDeviceList(list, 1); }), "a device list was freed twice");
Require(sceUsbdGetDeviceList(nullptr) == invalidArgument, "null list accepted");
Require(sceUsbdHandleEventsTimeout(nullptr) == invalidArgument, "null timeout accepted");
const UsbdTimeval invalid{0, 1000000};
Require(sceUsbdHandleEventsTimeout(&invalid) == invalidArgument, "out-of-range microseconds accepted");
const UsbdTimeval timeout{0, 50000};
const auto start = std::chrono::steady_clock::now();
Require(sceUsbdHandleEventsTimeout(&timeout) == 0, "event handling failed");
Require(std::chrono::steady_clock::now() - start >= std::chrono::milliseconds(45), "event handling returned before the timeout");
int foreign = 0;
void* handle = &foreign;
Require(sceUsbdOpen(&foreign, nullptr) == invalidArgument, "null handle output accepted");
Require(Throws([&] { sceUsbdOpen(nullptr, &handle); }), "opening a null device did not throw");
Require(Throws([&] { sceUsbdOpen(&foreign, &handle); }), "opening a device that was never listed did not throw");
sceUsbdClose(nullptr);
Require(Throws([&] { sceUsbdClose(&foreign); }), "closing a handle that was never opened did not throw");
Require(sceUsbdRefDevice(nullptr) == nullptr, "null device was referenced");
sceUsbdUnrefDevice(nullptr);
Require(Throws([&] { sceUsbdRefDevice(&foreign); }), "referencing a device that was never listed did not throw");
Require(Throws([&] { sceUsbdUnrefDevice(&foreign); }), "unreferencing a device that was never listed did not throw");
Require(sceUsbdGetBusNumber(nullptr) == 0 && sceUsbdGetDeviceAddress(nullptr) == 0, "null device reported a bus or address");
Require(Throws([&] { sceUsbdGetBusNumber(&foreign); }), "bus number of a device that was never listed did not throw");
std::uint8_t descriptor[18] = {};
void* config = &foreign;
Require(sceUsbdGetDeviceDescriptor(nullptr, descriptor) == invalidArgument, "null device descriptor accepted");
Require(sceUsbdGetDeviceDescriptor(&foreign, nullptr) == invalidArgument, "null descriptor output accepted");
Require(sceUsbdGetConfigDescriptor(nullptr, 0, &config) == invalidArgument, "null config device accepted");
Require(sceUsbdGetConfigDescriptor(&foreign, 0, nullptr) == invalidArgument, "null config output accepted");
Require(Throws([&] { sceUsbdGetConfigDescriptor(&foreign, 0, &config); }), "config of a device that was never listed did not throw");
Require(Throws([&] { sceUsbdGetActiveConfigDescriptor(nullptr, &config); }), "active config of a null device did not throw");
Require(sceUsbdClaimInterface(nullptr, 0) == invalidArgument && sceUsbdReleaseInterface(nullptr, 0) == invalidArgument, "null handle interface call accepted");
Require(sceUsbdSetConfiguration(nullptr, 1) == invalidArgument && sceUsbdResetDevice(nullptr) == invalidArgument, "null handle configuration or reset accepted");
Require(sceUsbdCheckConnected(nullptr) == invalidArgument, "null handle connection check accepted");
Require(sceUsbdKernelDriverActive(nullptr, 0) == invalidArgument && sceUsbdAttachKernelDriver(nullptr, 0) == invalidArgument, "null handle kernel driver call accepted");
Require(sceUsbdControlTransfer(nullptr, 0x80, 6, 0x100, 0, descriptor, 18, 1000) == invalidArgument, "null handle control transfer accepted");
Require(sceUsbdControlTransfer(&foreign, 0x80, 6, 0x100, 0, nullptr, 18, 1000) == invalidArgument, "control transfer without data accepted");
Require(Throws([&] { sceUsbdControlTransfer(&foreign, 0x80, 6, 0x100, 0, descriptor, 18, 1000); }), "control transfer on a handle that was never opened did not throw");
Require(sceUsbdGetStringDescriptor(nullptr, 1, 0x409, descriptor, 18) == invalidArgument, "null handle string descriptor accepted");
Require(sceUsbdGetStringDescriptor(&foreign, 1, 0x409, descriptor, 0) == invalidArgument, "empty string descriptor buffer accepted");
descriptor[0] = 0x55;
Require(sceUsbdGetStringDescriptorAscii(nullptr, 1, descriptor, 18) == invalidArgument, "null handle ASCII string descriptor accepted");
Require(sceUsbdGetStringDescriptorAscii(&foreign, 1, nullptr, 18) == invalidArgument && sceUsbdGetStringDescriptorAscii(&foreign, 1, descriptor, 0) == invalidArgument, "missing ASCII string buffer accepted");
Require(descriptor[0] == 0x55, "a rejected ASCII string request wrote the buffer");
Require(Throws([&] { sceUsbdGetStringDescriptorAscii(&foreign, 1, descriptor, 18); }), "ASCII string request on a handle that was never opened did not throw");
Require(sceUsbdGetDescriptor(nullptr, 1, 0, descriptor, 18) == invalidArgument, "null handle descriptor request accepted");
Require(sceUsbdGetDescriptor(&foreign, 1, 0, nullptr, 18) == invalidArgument && sceUsbdGetDescriptor(&foreign, 1, 0, descriptor, 0) == invalidArgument, "missing descriptor buffer accepted");
Require(Throws([&] { sceUsbdGetDescriptor(&foreign, 1, 0, descriptor, 18); }), "descriptor request on a handle that was never opened did not throw");
std::int32_t configuration = -1;
Require(sceUsbdGetConfiguration(nullptr, &configuration) == invalidArgument && sceUsbdGetConfiguration(&foreign, nullptr) == invalidArgument, "null configuration query accepted");
Require(configuration == -1, "a rejected configuration query wrote the output");
Require(Throws([&] { sceUsbdGetConfiguration(&foreign, &configuration); }), "configuration of a handle that was never opened did not throw");
Require(sceUsbdGetConfigDescriptorByValue(nullptr, 1, &config) == invalidArgument && sceUsbdGetConfigDescriptorByValue(&foreign, 1, nullptr) == invalidArgument, "null config by value argument accepted");
Require(Throws([&] { sceUsbdGetConfigDescriptorByValue(&foreign, 1, &config); }), "config by value of a device that was never listed did not throw");
Require(Throws([&] { sceUsbdClaimInterface(&foreign, 0); }), "claiming on a handle that was never opened did not throw");
auto* transfer = reinterpret_cast<std::uint8_t*>(sceUsbdAllocTransfer(2));
Require(transfer != nullptr, "transfer allocation failed");
Require(*reinterpret_cast<std::int32_t*>(transfer + 56) == 2, "iso packet count not stored");
Require(sceUsbdAllocTransfer(-1) == nullptr, "negative iso packet count accepted");
std::uint8_t buffer[8] = {};
int user = 0;
sceUsbdFillInterruptTransfer(reinterpret_cast<UsbdTransfer*>(transfer), nullptr, 0x81, buffer, 8, reinterpret_cast<UsbdTransferCallback>(&Require), &user, 250);
Require(transfer[9] == 0x81 && transfer[10] == 3, "endpoint or interrupt type not filled");
Require(*reinterpret_cast<std::uint32_t*>(transfer + 12) == 250 && *reinterpret_cast<std::int32_t*>(transfer + 20) == 8, "timeout or length not filled");
Require(*reinterpret_cast<void**>(transfer + 40) == &user && *reinterpret_cast<std::uint8_t**>(transfer + 48) == buffer, "user data or buffer not filled");
Require(sceUsbdCancelTransfer(reinterpret_cast<UsbdTransfer*>(transfer)) == static_cast<std::int32_t>(0x80240005), "cancelling an unsubmitted transfer did not report not found");
Require(sceUsbdSubmitTransfer(nullptr) == invalidArgument, "null transfer submitted");
Require(sceUsbdSubmitTransfer(reinterpret_cast<UsbdTransfer*>(transfer)) == invalidArgument, "transfer without a handle submitted");
sceUsbdFillInterruptTransfer(reinterpret_cast<UsbdTransfer*>(transfer), &foreign, 0x81, buffer, 8, reinterpret_cast<UsbdTransferCallback>(&Require), &user, 250);
Require(Throws([&] { sceUsbdSubmitTransfer(reinterpret_cast<UsbdTransfer*>(transfer)); }), "submitting on a handle that was never opened did not throw");
sceUsbdFreeTransfer(reinterpret_cast<UsbdTransfer*>(transfer));
sceUsbdFreeTransfer(nullptr);
Require(sceUsbdEventHandlingOk() == 1, "event handling not allowed");
sceUsbdFreeConfigDescriptor(nullptr);
Require(Throws([] { sceUsbdFillControlSetup(nullptr, 0x80, 6, 0x0100, 0, 18); }), "null control setup buffer accepted");
std::uint8_t setupBuffer[8] = {};
sceUsbdFillControlSetup(setupBuffer, 0x80, 6, 0x0100, 0x0409, 18);
Require(setupBuffer[0] == 0x80 && setupBuffer[1] == 6, "request type or request not filled");
Require(setupBuffer[2] == 0x00 && setupBuffer[3] == 0x01, "value not filled little-endian");
Require(setupBuffer[4] == 0x09 && setupBuffer[5] == 0x04, "index not filled little-endian");
Require(setupBuffer[6] == 18 && setupBuffer[7] == 0, "length not filled little-endian");
if (argc == 2 && std::strcmp(argv[1], "device") == 0) Device();
sceUsbdExit();
std::puts("USBD tests passed");
return 0;
}