system/ulib/ddktl/include/ddktl/protocol/platform-bus.h

// Copyright 2018 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.

#pragma once

#include <ddk/protocol/platform-bus.h>
#include <ddktl/device-internal.h>
#include <zircon/assert.h>

#include "platform-bus-internal.h"

// DDK platform bus protocol support.
//
// :: Proxies ::
//
// ddk::PlatformBusProtocolProxy is a simple wrappers around platform_bus_protocol_t. It does
// not own the pointers passed to it.
//
// :: Mixins ::
//
// ddk::PlatformBusProtocol is a mixin class that simplifies writing DDK drivers that
// implement the platform bus protocol.
//
// :: Examples ::
//
// // A driver that implements a ZX_PROTOCOL_PLATFORM_BUS device.
// class PlatformBusDevice;
// using PlatformBusDeviceType = ddk::Device<PlatformBusDevice, /* ddk mixins */>;
//
// class PlatformBusDevice : public PlatformBusDeviceType,
//                           public ddk::PlatformBusProtocol<PlatformBusDevice> {
//   public:
//     PlatformBusDevice(zx_device_t* parent)
//       : PlatformBusDeviceType("my-platform-bus", parent) {}
//
//    zx_status_t SetProtocol(uint32_t proto_id, void* protocol);
//    zx_status_t WaitProtocol(uint32_t proto_id);
//    zx_status_t DeviceAdd(const pbus_dev_t* dev, uint32_t flags);
//    zx_status_t DeviceEnable(uint32_t vid, uint32_t pid, uint32_t did, bool enable);
//    const char* GetBoardName();
//    zx_status_t SetBoardInfo(const pbus_board_info_t* info);
//     ...
// };

namespace ddk {

template <typename D>
class PlatformBusProtocol : public internal::base_protocol {
public:
    PlatformBusProtocol() {
        internal::CheckPlatformBusProtocolSubclass<D>();
        pbus_proto_ops_.set_protocol = SetProtocol;
        pbus_proto_ops_.wait_protocol = WaitProtocol;
        pbus_proto_ops_.device_add = DeviceAdd;
        pbus_proto_ops_.device_enable = DeviceEnable;
        pbus_proto_ops_.get_board_name = GetBoardName;
        pbus_proto_ops_.set_board_info = SetBoardInfo;

        // Can only inherit from one base_protocol implementation.
        ZX_ASSERT(ddk_proto_id_ == 0);
        ddk_proto_id_ = ZX_PROTOCOL_PLATFORM_BUS;
        ddk_proto_ops_ = &pbus_proto_ops_;
    }

protected:
    platform_bus_protocol_ops_t pbus_proto_ops_ = {};

private:
    static zx_status_t SetProtocol(void* ctx, uint32_t proto_id, void* protocol) {
        return static_cast<D*>(ctx)->SetProtocol(proto_id, protocol);
    }

    static zx_status_t WaitProtocol(void* ctx, uint32_t proto_id) {
        return static_cast<D*>(ctx)->WaitProtocol(proto_id);
    }

    static zx_status_t DeviceAdd(void* ctx, const pbus_dev_t* dev, uint32_t flags) {
        return static_cast<D*>(ctx)->DeviceAdd(dev, flags);
    }

    static zx_status_t DeviceEnable(void* ctx, uint32_t vid, uint32_t pid, uint32_t did,
                                    bool enable) {
        return static_cast<D*>(ctx)->DeviceEnable(vid, pid, did, enable);
    }

    static const char* GetBoardName(void* ctx) {
        return static_cast<D*>(ctx)->GetBoardName();
    }

    static zx_status_t SetBoardInfo(void* ctx, const pbus_board_info_t* info) {
        return static_cast<D*>(ctx)->SetBoardInfo(info);
    }

};

class PlatformBusProtocolProxy {
public:
    PlatformBusProtocolProxy(platform_bus_protocol_t* proto)
        : ops_(proto->ops), ctx_(proto->ctx) {}

    zx_status_t SetProtocol(uint32_t proto_id, void* protocol) {
        return ops_->set_protocol(ctx_, proto_id, protocol);
    }

    zx_status_t WaitProtocol(uint32_t proto_id) {
        return ops_->wait_protocol(ctx_, proto_id);
    }

    zx_status_t DeviceAdd(const pbus_dev_t* dev, uint32_t flags) {
        return ops_->device_add(ctx_, dev, flags);
    }

    zx_status_t DeviceEnable(uint32_t vid, uint32_t pid, uint32_t did, bool enable) {
        return ops_->device_enable(ctx_, vid, pid, did, enable);
    }

    const char* GetBoardName() {
        return ops_->get_board_name(ctx_);
    }

    zx_status_t SetBoardInfo(const pbus_board_info_t* info) {
        return ops_->set_board_info(ctx_, info);
    }

private:
    platform_bus_protocol_ops_t* ops_;
    void* ctx_;
};

} // namespace ddk