ladybird/Userland/Utilities/lsusb.cpp

/*
 * Copyright (c) 2021, Jesse Buhagiar <jooster669@gmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <AK/ByteBuffer.h>
#include <AK/FixedArray.h>
#include <AK/JsonArray.h>
#include <AK/JsonObject.h>
#include <AK/LexicalPath.h>
#include <LibCore/ArgsParser.h>
#include <LibCore/DirIterator.h>
#include <LibCore/File.h>
#include <LibCore/System.h>
#include <LibMain/Main.h>
#include <LibUSBDB/Database.h>
#include <stdio.h>
#include <unistd.h>

ErrorOr<int> serenity_main(Main::Arguments arguments)
{
    bool print_verbose = false;
    bool flag_show_numerical = false;
    Core::ArgsParser args;
    args.set_general_help("List USB devices.");
    args.add_option(print_verbose, "Print all device descriptors", "verbose", 'v');
    args.add_option(flag_show_numerical, "Show numerical IDs", "numerical", 'n');
    args.parse(arguments);

    if (!flag_show_numerical)
        TRY(Core::System::unveil("/res/usb.ids", "r"));
    TRY(Core::System::pledge("stdio rpath"));
    TRY(Core::System::unveil("/sys/bus/usb", "r"));
    TRY(Core::System::unveil(nullptr, nullptr));

    Core::DirIterator usb_devices("/sys/bus/usb", Core::DirIterator::SkipDots);

    RefPtr<USBDB::Database> usb_db;
    if (!flag_show_numerical) {
        usb_db = USBDB::Database::open();
        if (!usb_db) {
            warnln("Failed to open usb.ids");
        }
    }

    while (usb_devices.has_next()) {
        auto full_path = LexicalPath(usb_devices.next_full_path());

        auto proc_usb_device = Core::File::open(full_path.string(), Core::File::OpenMode::Read);
        if (proc_usb_device.is_error()) {
            warnln("Failed to open {}: {}", full_path.string(), proc_usb_device.error());
            continue;
        }

        auto contents = proc_usb_device.value()->read_until_eof();
        if (contents.is_error()) {
            warnln("Failed to read {}: {}", full_path.string(), contents.error());
            continue;
        }

        auto json_or_error = JsonValue::from_string(contents.value());
        if (json_or_error.is_error()) {
            warnln("Failed to decode JSON: {}", json_or_error.error());
            continue;
        }
        auto json = json_or_error.release_value();

        json.as_array().for_each([usb_db, print_verbose](auto& value) {
            auto& device_descriptor = value.as_object();

            auto device_address = device_descriptor.get_u32("device_address"sv).value_or(0);
            auto vendor_id = device_descriptor.get_u32("vendor_id"sv).value_or(0);
            auto product_id = device_descriptor.get_u32("product_id"sv).value_or(0);

            if (usb_db) {
                StringView vendor_string = usb_db->get_vendor(vendor_id);
                StringView device_string = usb_db->get_device(vendor_id, product_id);
                if (device_string.is_empty())
                    device_string = "Unknown Device"sv;

                outln("Device {}: ID {:04x}:{:04x} {} {}", device_address, vendor_id, product_id, vendor_string, device_string);
            } else {
                outln("Device {}: ID {:04x}:{:04x}", device_address, vendor_id, product_id);
            }

            if (print_verbose) {
                outln("Device Descriptor");
                outln("  bLength            {}", device_descriptor.get_u32("length"sv).value_or(0));
                outln("  bDescriptorType    {}", device_descriptor.get_u32("descriptor_type"sv).value_or(0));
                outln("  bcdUSB             {}", device_descriptor.get_u32("usb_spec_compliance_bcd"sv).value_or(0));
                outln("  bDeviceClass       {}", device_descriptor.get_u32("device_class"sv).value_or(0));
                outln("  bDeviceSubClass    {}", device_descriptor.get_u32("device_sub_class"sv).value_or(0));
                outln("  bDeviceProtocol    {}", device_descriptor.get_u32("device_protocol"sv).value_or(0));
                outln("  bMaxPacketSize     {}", device_descriptor.get_u32("max_packet_size"sv).value_or(0));
                if (usb_db) {
                    StringView vendor_string = usb_db->get_vendor(vendor_id);
                    StringView device_string = usb_db->get_device(vendor_id, product_id);
                    outln("  idVendor           {:#04x} {}", device_descriptor.get_u32("vendor_id"sv).value_or(0), vendor_string);
                    outln("  idProduct          {:#04x} {}", device_descriptor.get_u32("product_id"sv).value_or(0), device_string);
                } else {
                    outln("  idVendor           {:#04x}", device_descriptor.get_u32("vendor_id"sv).value_or(0));
                    outln("  idProduct          {:#04x}", device_descriptor.get_u32("product_id"sv).value_or(0));
                }
                outln("  bcdDevice          {}", device_descriptor.get_u32("device_release_bcd"sv).value_or(0));
                outln("  iManufacturer      {}", device_descriptor.get_u32("manufacturer_id_descriptor_index"sv).value_or(0));
                outln("  iProduct           {}", device_descriptor.get_u32("product_string_descriptor_index"sv).value_or(0));
                outln("  iSerial            {}", device_descriptor.get_u32("serial_number_descriptor_index"sv).value_or(0));
                outln("  bNumConfigurations {}", device_descriptor.get_u32("num_configurations"sv).value_or(0));

                auto const& configuration_descriptors = value.as_object().get_array("configurations"sv).value();
                configuration_descriptors.for_each([&](auto& config_value) {
                    auto const& configuration_descriptor = config_value.as_object();
                    outln("  Configuration Descriptor:");
                    outln("    bLength          {}", configuration_descriptor.get_u32("length"sv).value_or(0));
                    outln("    bDescriptorType  {}", configuration_descriptor.get_u32("descriptor_type"sv).value_or(0));
                    outln("    wTotalLength     {}", configuration_descriptor.get_u32("total_length"sv).value_or(0));
                    outln("    bNumInterfaces   {}", configuration_descriptor.get_u32("number_of_interfaces"sv).value_or(0));
                    outln("    bmAttributes     {:#02x}", configuration_descriptor.get_u32("attributes_bitmap"sv).value_or(0));
                    outln("    MaxPower         {}mA", configuration_descriptor.get_u32("max_power"sv).value_or(0) * 2u);

                    auto const& interface_descriptors = config_value.as_object().get_array("interfaces"sv).value();
                    interface_descriptors.for_each([&](auto& interface_value) {
                        auto const& interface_descriptor = interface_value.as_object();
                        auto const interface_class_code = interface_descriptor.get_u32("interface_class_code"sv).value_or(0);
                        auto const interface_subclass_code = interface_descriptor.get_u32("interface_sub_class_code"sv).value_or(0);
                        auto const interface_protocol_code = interface_descriptor.get_u32("interface_protocol"sv).value_or(0);

                        outln("    Interface Descriptor:");
                        outln("      bLength            {}", interface_descriptor.get_u32("length"sv).value_or(0));
                        outln("      bDescriptorType    {}", interface_descriptor.get_u32("descriptor_type"sv).value_or(0));
                        outln("      bInterfaceNumber   {}", interface_descriptor.get_u32("interface_number"sv).value_or(0));
                        outln("      bAlternateSetting  {}", interface_descriptor.get_u32("alternate_setting"sv).value_or(0));
                        outln("      bNumEndpoints      {}", interface_descriptor.get_u32("num_endpoints"sv).value_or(0));
                        if (usb_db) {
                            auto const interface_class = usb_db->get_class(interface_class_code);
                            auto const interface_subclass = usb_db->get_subclass(interface_class_code, interface_subclass_code);
                            auto const interface_protocol = usb_db->get_protocol(interface_class_code, interface_subclass_code, interface_protocol_code);
                            outln("      bInterfaceClass    {} {}", interface_class_code, interface_class);
                            outln("      bInterfaceSubClass {} {}", interface_subclass_code, interface_subclass);
                            outln("      bInterfaceProtocol {} {}", interface_protocol_code, interface_protocol);
                        } else {
                            outln("      bInterfaceClass    {}", interface_class_code);
                            outln("      bInterfaceSubClass {}", interface_subclass_code);
                            outln("      bInterfaceProtocol {}", interface_protocol_code);
                        }
                        outln("      iInterface         {}", interface_descriptor.get_u32("interface_string_desc_index"sv).value_or(0));

                        auto const& endpoint_descriptors = interface_value.as_object().get_array("endpoints"sv).value();
                        endpoint_descriptors.for_each([&](auto& endpoint_value) {
                            auto const& endpoint_descriptor = endpoint_value.as_object();
                            auto const endpoint_address = endpoint_descriptor.get_u32("endpoint_address"sv).value_or(0);
                            outln("      Endpoint Descriptor:");
                            outln("        bLength            {}", endpoint_descriptor.get_u32("length"sv).value_or(0));
                            outln("        bDescriptorType    {}", endpoint_descriptor.get_u32("descriptor_type"sv).value_or(0));
                            outln("        bEndpointAddress   {:#02x} EP {} {}", endpoint_address, (endpoint_address & 0xFu), ((endpoint_address & 0x80u) ? "IN" : "OUT"));
                            outln("        bmAttributes       {:#02x}", endpoint_descriptor.get_u32("attribute_bitmap"sv).value_or(0));
                            outln("        wMaxPacketSize     {:#04x}", endpoint_descriptor.get_u32("max_packet_size"sv).value_or(0));
                            outln("        bInterval          {}", endpoint_descriptor.get_u32("polling_interval"sv).value_or(0));
                        });
                    });
                });
            }
        });
    }

    return 0;
}