blob: ce434547b514ac14e7db5f794489700fe2f1b54e [file] [log] [blame]
// Copyright 2020 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.
#include <lib/ddk/binding.h>
#include <lib/inspect/component/cpp/component.h>
#include <lib/zx/channel.h>
#include <lib/zx/result.h>
#include <atomic>
#include <fbl/array.h>
#include <fbl/ref_ptr.h>
#include "src/storage/lib/vfs/cpp/pseudo_dir.h"
namespace driver_manager {
struct ProtocolInfo {
const char* name;
fbl::RefPtr<fs::PseudoDir> devnode;
uint32_t id;
uint32_t flags;
uint32_t seqcount;
static const inline ProtocolInfo kProtoInfos[] = {
#define DDK_PROTOCOL_DEF(tag, val, name, flags) {name, nullptr, val, flags, 0},
#include <lib/ddk/protodefs.h>
class InspectDevfs {
static zx::result<InspectDevfs> Create(async_dispatcher_t* dispatcher);
// Publishes a device. Should be called when there's a new devices.
// This returns a string, `link_name`, representing the device that was just published.
zx::result<std::string> Publish(const char* name, zx::vmo vmo);
explicit InspectDevfs(async_dispatcher_t* dispatcher) : dispatcher_(dispatcher) {}
inline static std::atomic<uint64_t> inspect_dev_counter_{0};
async_dispatcher_t* dispatcher_ = nullptr;
class DeviceInspect;
class InspectManager {
// Information that all devices end up editing.
struct Info : fbl::RefCounted<Info> {
Info(inspect::Node& root_node, InspectDevfs inspect_devfs)
: device_count(root_node.CreateUint("device_count", 0)),
devfs(std::move(inspect_devfs)) {}
// The total count of devices.
inspect::UintProperty device_count;
// The top level node for devices.
inspect::Node devices;
// The inspect nodes for devfs information.
InspectDevfs devfs;
explicit InspectManager(async_dispatcher_t* dispatcher);
InspectManager() = delete;
// Create a new device within inspect.
DeviceInspect CreateDevice(std::string name, zx::vmo vmo, uint32_t protocol_id);
// Accessor methods.
inspect::Node& root_node() { return inspector_.root(); }
InspectDevfs& devfs() { return info_->devfs; }
inspect::ComponentInspector inspector_;
fbl::RefPtr<Info> info_;
class DeviceInspect {
DeviceInspect(DeviceInspect&& other) = default;
DeviceInspect CreateChild(std::string name, zx::vmo vmo, uint32_t protocol_id);
// Publish this Device. The device will be automatically unpublished when it is destructed.
zx::result<> Publish();
// Set the values that should not change during the life of the device.
// This should only be called once, calling it more than once will create duplicate entries.
void SetStaticValues(const std::string& topological_path, uint32_t protocol_id,
const std::string& type,
const cpp20::span<const zx_device_prop_t>& properties,
const std::string& driver_url);
void set_state(const std::string& state) { state_.Set(state); }
void set_local_id(uint64_t local_id) { local_id_.Set(local_id); }
friend InspectManager;
// To get a DeviceInspect object you should call InspectManager::CreateDevice.
DeviceInspect(fbl::RefPtr<InspectManager::Info> info, std::string name, zx::vmo vmo,
uint32_t protocol_id);
fbl::RefPtr<InspectManager::Info> info_;
// The inspect node for this device.
inspect::Node device_node_;
// Reference to nodes with static properties
inspect::ValueList static_values_;
inspect::StringProperty state_;
// Unique id of the device in a driver host
inspect::UintProperty local_id_;
// Inspect VMO returned via devfs's inspect nodes.
std::optional<zx::vmo> dev_vmo_;
uint32_t protocol_id_;
std::string name_;
std::string link_name_;
} // namespace driver_manager