src/devices/bus/drivers/platform/proxy-protocol.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.

#ifndef SRC_DEVICES_BUS_DRIVERS_PLATFORM_PROXY_PROTOCOL_H_
#define SRC_DEVICES_BUS_DRIVERS_PLATFORM_PROXY_PROTOCOL_H_

#include <ddk/protocol/platform/device.h>

namespace platform_bus {

// Maximum transfer size we can proxy.
static constexpr size_t PROXY_MAX_TRANSFER_SIZE = 4096;

// ZX_PROTOCOL_PDEV proxy support.
enum {
  PDEV_GET_MMIO,
  PDEV_GET_INTERRUPT,
  PDEV_GET_BTI,
  PDEV_GET_SMC,
  PDEV_GET_DEVICE_INFO,
  PDEV_GET_BOARD_INFO,
  PDEV_GET_METADATA,
};

/// Header for RPC requests.
struct platform_proxy_req_t {
  uint32_t txid;
  uint32_t op;
};

/// Header for RPC responses.
struct platform_proxy_rsp_t {
  uint32_t txid;
  zx_status_t status;
};

struct rpc_pdev_req_t {
  platform_proxy_req_t header;
  uint32_t index;
  uint32_t flags;
};

struct rpc_pdev_rsp_t {
  platform_proxy_rsp_t header;
  zx_paddr_t paddr;
  size_t length;
  uint32_t irq;
  uint32_t mode;
  pdev_device_info_t device_info;
  pdev_board_info_t board_info;
  uint32_t metadata_type;
  uint32_t metadata_length;
};

// Maximum metadata size that can be returned via PDEV_DEVICE_GET_METADATA.
static constexpr uint32_t PROXY_MAX_METADATA_SIZE =
    (PROXY_MAX_TRANSFER_SIZE - sizeof(rpc_pdev_rsp_t));

struct rpc_pdev_metadata_rsp_t {
  rpc_pdev_rsp_t pdev;
  uint8_t metadata[PROXY_MAX_METADATA_SIZE];
};

}  // namespace platform_bus

#endif  // SRC_DEVICES_BUS_DRIVERS_PLATFORM_PROXY_PROTOCOL_H_