src/devices/board/drivers/machina/machina.c

// Copyright 2017 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 "machina.h"

#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <threads.h>
#include <unistd.h>
#include <zircon/assert.h>
#include <zircon/process.h>
#include <zircon/syscalls.h>
#include <zircon/threads.h>

#include <ddk/binding.h>
#include <ddk/debug.h>
#include <ddk/device.h>
#include <ddk/driver.h>
#include <ddk/platform-defs.h>
#include <ddk/protocol/platform/bus.h>

static zx_status_t machina_pci_init(void) {
  zx_status_t status;

  zx_pci_init_arg_t* arg;
  // Room for one addr window.
  size_t arg_size = sizeof(*arg) + sizeof(arg->addr_windows[0]);
  arg = calloc(1, arg_size);
  if (!arg) {
    return ZX_ERR_NO_MEMORY;
  }

  // Please do not use get_root_resource() in new code. See ZX-1467.
  status = zx_pci_add_subtract_io_range(get_root_resource(), true /* mmio */, PCIE_MMIO_BASE_PHYS,
                                        PCIE_MMIO_SIZE, true /* add */);
  if (status != ZX_OK) {
    goto fail;
  }

  // Initialize our swizzle table
  zx_pci_irq_swizzle_lut_t* lut = &arg->dev_pin_to_global_irq;
  for (unsigned dev_id = 0; dev_id < ZX_PCI_MAX_DEVICES_PER_BUS; dev_id++) {
    for (unsigned func_id = 0; func_id < ZX_PCI_MAX_FUNCTIONS_PER_DEVICE; func_id++) {
      for (unsigned pin = 0; pin < ZX_PCI_MAX_LEGACY_IRQ_PINS; pin++) {
        (*lut)[dev_id][func_id][pin] = PCIE_INT_BASE + dev_id;
      }
    }
  }
  arg->num_irqs = 0;
  arg->addr_window_count = 1;
  arg->addr_windows[0].cfg_space_type = PCI_CFG_SPACE_TYPE_MMIO;
  arg->addr_windows[0].has_ecam = true;
  arg->addr_windows[0].base = PCIE_ECAM_BASE_PHYS;
  arg->addr_windows[0].size = PCIE_ECAM_SIZE;
  arg->addr_windows[0].bus_start = 0;
  arg->addr_windows[0].bus_end = (PCIE_ECAM_SIZE / ZX_PCI_ECAM_BYTE_PER_BUS) - 1;

  // Please do not use get_root_resource() in new code. See ZX-1467.
  status = zx_pci_init(get_root_resource(), arg, arg_size);
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s: error %d in zx_pci_init", __FUNCTION__, status);
    goto fail;
  }

fail:
  free(arg);
  return status;
}

static void machina_board_release(void* ctx) {
  machina_board_t* bus = ctx;
  free(bus);
}

static zx_protocol_device_t machina_board_device_protocol = {
    .version = DEVICE_OPS_VERSION,
    .release = machina_board_release,
};

static const pbus_mmio_t pl031_mmios[] = {
    {
        .base = RTC_BASE_PHYS,
        .length = RTC_SIZE,
    },
};

static const pbus_dev_t pl031_dev = {
    .name = "pl031",
    .vid = PDEV_VID_GENERIC,
    .pid = PDEV_PID_GENERIC,
    .did = PDEV_DID_RTC_PL031,
    .mmio_list = pl031_mmios,
    .mmio_count = countof(pl031_mmios),
};

static int machina_start_thread(void* arg) {
  machina_board_t* bus = arg;
  zx_status_t status;

  status = machina_sysmem_init(bus);
  if (status != ZX_OK) {
    zxlogf(ERROR, "machina_board_bind machina_sysmem_init failed: %d", status);
    goto fail;
  }

  pbus_bti_t pci_btis[] = {
      {
          .iommu_index = 0,
          .bti_id = 0,
      },
  };

  pbus_dev_t pci_dev = {
      .name = "pci",
      .vid = PDEV_VID_GENERIC,
      .pid = PDEV_PID_GENERIC,
      .did = PDEV_DID_KPCI,
      .bti_list = pci_btis,
      .bti_count = countof(pci_btis),
  };

  status = pbus_device_add(&bus->pbus, &pci_dev);
  if (status != ZX_OK) {
    zxlogf(ERROR, "machina_board_bind could not add pci_dev: %d", status);
  }

  status = pbus_device_add(&bus->pbus, &pl031_dev);
  if (status != ZX_OK) {
    zxlogf(ERROR, "machina_board_bind could not add pl031: %d", status);
  }

  return ZX_OK;

fail:
  zxlogf(ERROR, "machina_start_thread failed, not all devices have been initialized");
  return status;
}

static zx_status_t machina_board_bind(void* ctx, zx_device_t* parent) {
  machina_board_t* bus = calloc(1, sizeof(machina_board_t));
  if (!bus) {
    return ZX_ERR_NO_MEMORY;
  }

  if (device_get_protocol(parent, ZX_PROTOCOL_PBUS, &bus->pbus) != ZX_OK) {
    free(bus);
    return ZX_ERR_NOT_SUPPORTED;
  }

  zx_status_t status = machina_pci_init();
  if (status != ZX_OK) {
    zxlogf(ERROR, "machina_pci_init failed: %d", status);
  }

  device_add_args_t args = {
      .version = DEVICE_ADD_ARGS_VERSION,
      .name = "machina",
      .ops = &machina_board_device_protocol,
      .flags = DEVICE_ADD_NON_BINDABLE,
  };

  status = device_add(parent, &args, NULL);
  if (status != ZX_OK) {
    goto fail;
  }

  thrd_t t;
  int thrd_rc = thrd_create_with_name(&t, machina_start_thread, bus, "machina_start_thread");
  if (thrd_rc != thrd_success) {
    status = thrd_status_to_zx_status(thrd_rc);
    goto fail;
  }

  return status;

fail:
  printf("machina_board_bind failed %d\n", status);
  machina_board_release(bus);
  return status;
}

static zx_driver_ops_t machina_board_driver_ops = {
    .version = DRIVER_OPS_VERSION,
    .bind = machina_board_bind,
};

ZIRCON_DRIVER_BEGIN(machina_board, machina_board_driver_ops, "zircon", "0.1", 3)
BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_PBUS),
    BI_ABORT_IF(NE, BIND_PLATFORM_DEV_VID, PDEV_VID_GOOGLE),
    BI_MATCH_IF(EQ, BIND_PLATFORM_DEV_PID, PDEV_PID_MACHINA), ZIRCON_DRIVER_END(machina_board)