src/devices/board/drivers/astro/astro-rawnand.cc

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

#include <fidl/fuchsia.hardware.platform.bus/cpp/driver/fidl.h>
#include <fidl/fuchsia.hardware.platform.bus/cpp/fidl.h>
#include <lib/ddk/debug.h>
#include <lib/ddk/device.h>
#include <lib/ddk/io-buffer.h>
#include <lib/ddk/metadata.h>
#include <lib/ddk/platform-defs.h>
#include <lib/driver/component/cpp/composite_node_spec.h>
#include <lib/driver/component/cpp/node_add_args.h>
#include <unistd.h>
#include <zircon/hw/gpt.h>

#include <bind/fuchsia/cpp/bind.h>
#include <bind/fuchsia/gpio/cpp/bind.h>
#include <ddk/metadata/nand.h>
#include <soc/aml-common/aml-guid.h>
#include <soc/aml-s905d2/s905d2-gpio.h>
#include <soc/aml-s905d2/s905d2-hw.h>

#include "astro.h"

namespace fdf {
using namespace fuchsia_driver_framework;
}  // namespace fdf

namespace astro {
namespace fpbus = fuchsia_hardware_platform_bus;

static const std::vector<fpbus::Mmio> raw_nand_mmios{
    {{
        /* nandreg : Registers for NAND controller */
        .base = S905D2_RAW_NAND_REG_BASE,
        .length = 0x2000,
    }},
    {{
        /* clockreg : Clock Register for NAND controller */
        .base = S905D2_RAW_NAND_CLOCK_BASE,
        .length = 0x4,
    }},
};

static const std::vector<fpbus::Irq> raw_nand_irqs{
    {{
        .irq = S905D2_RAW_NAND_IRQ,
        .mode = 0,
    }},
};

static const std::vector<fpbus::Bti> raw_nand_btis{
    {{
        .iommu_index = 0,
        .bti_id = BTI_AML_RAW_NAND,
    }},
};

static const nand_config_t config = {
    .bad_block_config =
        {
            .type = kAmlogicUboot,
            .aml_uboot =
                {
                    .table_start_block = 20,
                    .table_end_block = 23,
                },
        },
    .extra_partition_config_count = 3,
    .extra_partition_config =
        {
            {
                .type_guid = GUID_BL2_VALUE,
                .copy_count = 8,
                .copy_byte_offset = 0,
            },
            {
                .type_guid = GUID_BOOTLOADER_VALUE,
                .copy_count = 4,
                .copy_byte_offset = 0,
            },
            {
                .type_guid = GUID_SYS_CONFIG_VALUE,
                .copy_count = 4,
                .copy_byte_offset = 0,
            },

        },
};

static const std::vector<fpbus::Metadata> raw_nand_metadata{
    {{
        .type = DEVICE_METADATA_PRIVATE,
        .data = std::vector<uint8_t>(reinterpret_cast<const uint8_t*>(&config),
                                     reinterpret_cast<const uint8_t*>(&config) + sizeof(config)),
    }},
};

static const std::vector<fpbus::BootMetadata> raw_nand_boot_metadata{
    {{
        .zbi_type = DEVICE_METADATA_PARTITION_MAP,
        .zbi_extra = 0,
    }},
};

static const fpbus::Node raw_nand_dev = []() {
  fpbus::Node dev = {};
  dev.name() = "raw_nand";
  dev.vid() = PDEV_VID_AMLOGIC;
  dev.pid() = PDEV_PID_GENERIC;
  dev.did() = PDEV_DID_AMLOGIC_RAW_NAND;
  dev.mmio() = raw_nand_mmios;
  dev.irq() = raw_nand_irqs;
  dev.bti() = raw_nand_btis;
  dev.metadata() = raw_nand_metadata;
  dev.boot_metadata() = raw_nand_boot_metadata;
  return dev;
}();

static const std::vector<fdf::BindRule> kGpioInitRules = std::vector{
    fdf::MakeAcceptBindRule(bind_fuchsia::INIT_STEP, bind_fuchsia_gpio::BIND_INIT_STEP_GPIO),
};
static const std::vector<fdf::NodeProperty> kGpioInitProps = std::vector{
    fdf::MakeProperty(bind_fuchsia::INIT_STEP, bind_fuchsia_gpio::BIND_INIT_STEP_GPIO),
};

static const std::vector<fdf::ParentSpec> kRawNandParents = std::vector{
    fdf::ParentSpec{{kGpioInitRules, kGpioInitProps}},
};

static const auto kCompositeNodeSpec =
    fdf::CompositeNodeSpec{{.name = "raw_nand", .parents = kRawNandParents}};

zx_status_t Astro::RawNandInit() {
  // Set alternate functions to enable raw_nand.
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(8), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(9), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(10), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(11), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(12), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(14), GpioSetAltFunction(2)});
  gpio_init_steps_.push_back({S905D2_GPIOBOOT(15), GpioSetAltFunction(2)});


  fidl::Arena<> fidl_arena;
  fdf::Arena arena('RAWN');
  fdf::WireUnownedResult result = pbus_.buffer(arena)->AddCompositeNodeSpec(
      fidl::ToWire(fidl_arena, raw_nand_dev), fidl::ToWire(fidl_arena, kCompositeNodeSpec));
  if (!result.ok()) {
    zxlogf(ERROR, "%s: NodeAdd RawNand(raw_nand_dev) request failed: %s", __func__,
           result.FormatDescription().data());
    return result.status();
  }
  if (result->is_error()) {
    zxlogf(ERROR, "%s: NodeAdd RawNand(raw_nand_dev) failed: %s", __func__,
           zx_status_get_string(result->error_value()));
    return result->error_value();
  }

  return ZX_OK;
}

}  // namespace astro