src/devices/bin/driver_manager/devfs/class_names.h

// Copyright 2025 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVICES_BIN_DRIVER_MANAGER_DEVFS_CLASS_NAMES_H_
#define SRC_DEVICES_BIN_DRIVER_MANAGER_DEVFS_CLASS_NAMES_H_

#include <string>
#include <unordered_map>
#include <unordered_set>

namespace driver_manager {

// Specifies the service and member protocol that will map to a class name
struct ServiceEntry {
  using AdvertiseState = uint8_t;
  static constexpr AdvertiseState kNone = 0;
  static constexpr AdvertiseState kDevfs = 1;
  static constexpr AdvertiseState kService = 2;
  static constexpr AdvertiseState kDevfsAndService = kDevfs | kService;
  // Indicates for a given class name whether the service should be advertised,
  // and whether a devfs entry should be advertised.
  AdvertiseState state;
  // The name of the service that should be advertised for a class name.
  // The format is: "the.fidl.namespace.ServiceName"
  std::string service_name;
  // The name of the member of the service that corresponds to the protocol
  // that is normally advertised through dev/class/class_name
  std::string member_name;
};

// The key values in this map represent class names that devfs recognizes.
// Each class name has a folder automatically created under /dev/class when devfs
// first starts up.
// The ServiceEntry that corresponds to each class name specifies how devfs should
// map the offered protocol to the member protocol of a service.
// As an example,
// For a fidl protocol and service defined as:
//   library fidl.examples.echo;
//   protocol DriverEcho {...}
//   service DriverEchoService {
//       echo_device client_end:DriverEcho;
//   };
//  imagine that /dev/class/driver_test gave access to a fidl.examples.echo::DriverEcho
// protocol.  To automatically advertise that protocol as a service, you would
// update the driver_test entry in kClassNameToService to:
// {"driver_test", {ServiceEntry::kDevfsAndService,
//                        "fidl.examples.echo.DriverEchoService", "echo_device"}},
const std::unordered_map<std::string_view, ServiceEntry> kClassNameToService = {
    {"acpi", {ServiceEntry::kDevfs, "", ""}},
    {"adc", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.adc.Service", "device"}},
    {"audio-composite",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.audio.CompositeConnectorService",
      "composite_connector"}},
    {"audio-input",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.audio.StreamConfigConnectorInputService",
      "stream_config_connector"}},
    {"audio-output",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.audio.StreamConfigConnectorOutputService",
      "stream_config_connector"}},
    {"backlight",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.backlight.Service", "backlight"}},
    {"battery", {ServiceEntry::kDevfsAndService, "fuchsia.power.battery.InfoService", "device"}},
    {"block-partition", {ServiceEntry::kDevfs, "", ""}},
    {"block", {ServiceEntry::kDevfs, "", ""}},
    {"block-volume", {ServiceEntry::kDevfs, "", ""}},
    {"bt-emulator",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.bluetooth.EmulatorService", "device"}},
    {"bt-hci", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.bluetooth.Service", "vendor"}},
    {"clock-impl",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.clock.measure.Service", "measurer"}},
    {"codec",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.audio.CodecConnectorService",
      "codec_connector"}},
    {"cpu-ctrl", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.cpu.ctrl.Service", "device"}},
    {"dai",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.audio.DaiConnectorService",
      "dai_connector"}},
    {"devfs_service_test",
     {ServiceEntry::kDevfsAndService, "fuchsia.services.test.Device", "control"}},
    {"display-coordinator",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.display.Service", "provider"}},
    {"goldfish-address-space",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.goldfish.AddressSpaceService", "device"}},
    {"goldfish-control",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.goldfish.ControlService", "device"}},
    {"goldfish-pipe",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.goldfish.ControllerService", "device"}},
    {"goldfish-sync",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.goldfish.SyncService", "device"}},
    {"gpio", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.pin.DebugService", "device"}},
    {"gpu-dependency-injection",
     {ServiceEntry::kDevfsAndService, "fuchsia.gpu.magma.DependencyInjectionService", "device"}},
    {"gpu-performance-counters",
     {ServiceEntry::kDevfsAndService, "fuchsia.gpu.magma.PerformanceCounterService", "access"}},
    {"gpu", {ServiceEntry::kDevfs, "fuchsia.gpu.magma.Service", "device"}},
    {"hrtimer", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.hrtimer.Service", "device"}},
    {"i2c", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.i2c.Service", "device"}},
    {"input-report",
     {ServiceEntry::kDevfsAndService, "fuchsia.input.report.Service", "input_device"}},
    {"input", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.input.Service", "controller"}},
    {"light", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.light.LightService", "light"}},
    {"media-codec",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.mediacodec.Service", "device"}},
    {"midi", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.midi.Service", "controller"}},
    {"nand", {ServiceEntry::kDevfs, "", ""}},
    {"network", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.network.Service", "device"}},
    {"ot-radio", {ServiceEntry::kDevfsAndService, "fuchsia.lowpan.spinel.Service", "device_setup"}},
    {"power-sensor",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.power.sensor.Service", "device"}},
    {"power", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.powersource.Service", "source"}},
    {"radar", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.radar.Service", "device"}},
    {"registers", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.registers.Service", "device"}},
    {"rtc", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.rtc.Service", "device"}},
    {"sdio", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.sdio.DriverService", "device"}},
    {"securemem", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.securemem.Service", "device"}},
    // Note: serial is being migrated directly to fuchsia.hardware.serial.Service,
    // which the serial driver already advertises.
    {"serial", {ServiceEntry::kDevfs, "", ""}},
    {"skip-block",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.skipblock.Service", "skipblock"}},
    {"spi", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.spi.ControllerService", "device"}},
    {"tee", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.tee.Service", "device_connector"}},
    {"temperature",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.temperature.Service", "device"}},
    {"test", {ServiceEntry::kDevfs, "", ""}},
    {"test-asix-function",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.ax88179.Service", "hooks"}},
    {"thermal", {ServiceEntry::kDevfsAndService, "fuchsia.hardware.thermal.Service", "device"}},
    {"tpm", {ServiceEntry::kDevfsAndService, "fuchsia.tpm.Service", "device"}},
    {"trippoint",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.trippoint.TripPointService", "trippoint"}},
    {"usb-device",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.usb.device.Service", "device"}},
    {"usb-tester",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.usb.tester.Service", "device"}},
    {"virtual-bus-test",
     {ServiceEntry::kDevfsAndService, "fuchsia.hardware.usb.virtualbustest.Service", "device"}},
    {"wlanphy", {ServiceEntry::kDevfsAndService, "fuchsia.wlan.device.Service", "device"}},
};

// TODO(https://fxbug.dev/42064970): shrink this list to zero.
//
// Do not add to this list.
//
// These classes have clients that rely on the numbering scheme starting at
// 000 and increasing sequentially. This list was generated using:
//
// rg -IoN --no-ignore -g '!out/' -g '!*.md' '\bclass/[^/]+/[0-9]{3}\b' | \
// sed -E 's|class/(.*)/[0-9]{3}|"\1",|g' | sort | uniq
// The uint8_t that the class name maps to tracks the next available device number.
std::unordered_map<std::string_view, uint8_t> classes_that_assume_ordering({
    // TODO(https://fxbug.dev/42065012): Remove.
    {"adc", 0},

    // TODO(https://fxbug.dev/42065014): Remove.
    // TODO(https://fxbug.dev/42065080): Remove.
    {"backlight", 0},

    // TODO(https://fxbug.dev/42068339): Remove.
    {"block", 0},

    // TODO(https://fxbug.dev/42065067): Remove.
    {"goldfish-address-space", 0},
    {"goldfish-control", 0},
    {"goldfish-pipe", 0},

    // TODO(https://fxbug.dev/42065072): Remove.
    {"ot-radio", 0},

    // TODO(https://fxbug.dev/42065009): Remove.
    // TODO(https://fxbug.dev/42065080): Remove.
    {"temperature", 0},

    // TODO(https://fxbug.dev/42065080): Remove.
    {"thermal", 0},
});

// The list of devfs classes that offer an additional device_topology protocol.
//
// Do not add to this list except if you are migrating a client off
// of fuchsia_device::Controller, or from using dev-topological
// to access driver directly through topological paths.
//
// Please do not connect to the 'device_topology' directory directly.  Instead, use the library
// for accessing topological paths at /src/devices/lib/client
//
const std::unordered_set<std::string> kClassesThatAllowTopologicalPath({
    "block",
    "devfs_service_test",
    "network",
});

}  // namespace driver_manager

#endif  // SRC_DEVICES_BIN_DRIVER_MANAGER_DEVFS_CLASS_NAMES_H_