| // 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/binding.h> |
| #include <lib/ddk/debug.h> |
| #include <lib/ddk/device.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 <lib/fit/defer.h> |
| #include <lib/zircon-internal/align.h> |
| #include <stdlib.h> |
| |
| #include <bind/fuchsia/amlogic/platform/cpp/bind.h> |
| #include <bind/fuchsia/cpp/bind.h> |
| #include <bind/fuchsia/hardware/registers/cpp/bind.h> |
| #include <bind/fuchsia/hardware/usb/phy/cpp/bind.h> |
| #include <bind/fuchsia/platform/cpp/bind.h> |
| #include <bind/fuchsia/register/cpp/bind.h> |
| #include <soc/aml-common/aml-registers.h> |
| #include <soc/aml-common/aml-usb-phy.h> |
| #include <usb/cdc.h> |
| #include <usb/dwc2/metadata.h> |
| #include <usb/usb.h> |
| |
| #include "sherlock.h" |
| |
| namespace fdf { |
| using namespace fuchsia_driver_framework; |
| } // namespace fdf |
| |
| namespace sherlock { |
| namespace fpbus = fuchsia_hardware_platform_bus; |
| |
| namespace { |
| |
| static const std::vector<fpbus::Mmio> dwc2_mmios{ |
| {{ |
| .base = T931_USB1_BASE, |
| .length = T931_USB1_LENGTH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Irq> dwc2_irqs{ |
| {{ |
| .irq = T931_USB1_IRQ, |
| .mode = ZX_INTERRUPT_MODE_EDGE_HIGH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Bti> dwc2_btis{ |
| {{ |
| .iommu_index = 0, |
| .bti_id = BTI_USB, |
| }}, |
| }; |
| |
| // Metadata for DWC2 driver. |
| constexpr dwc2_metadata_t dwc2_metadata = { |
| .dma_burst_len = DWC2_DMA_BURST_INCR8, |
| .usb_turnaround_time = 9, |
| .rx_fifo_size = 256, // for all OUT endpoints. |
| .nptx_fifo_size = 32, // for endpoint zero IN direction. |
| .tx_fifo_sizes = |
| { |
| 128, // for CDC ethernet bulk IN. |
| 4, // for CDC ethernet interrupt IN. |
| 128, // for test function bulk IN. |
| 16, // for test function interrupt IN. |
| }, |
| }; |
| |
| static std::vector<fpbus::Metadata> usb_metadata{ |
| {{ |
| .type = DEVICE_METADATA_PRIVATE, |
| .data = std::vector<uint8_t>( |
| reinterpret_cast<const uint8_t*>(&dwc2_metadata), |
| reinterpret_cast<const uint8_t*>(&dwc2_metadata) + sizeof(dwc2_metadata)), |
| }}, |
| }; |
| |
| static const std::vector<fpbus::BootMetadata> usb_boot_metadata{ |
| {{ |
| // Use Bluetooth MAC address for USB ethernet as well. |
| .zbi_type = DEVICE_METADATA_MAC_ADDRESS, |
| .zbi_extra = MACADDR_BLUETOOTH, |
| }}, |
| {{ |
| // Advertise serial number over USB |
| .zbi_type = DEVICE_METADATA_SERIAL_NUMBER, |
| .zbi_extra = 0, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Mmio> xhci_mmios{ |
| {{ |
| .base = T931_USB0_BASE, |
| .length = T931_USB0_LENGTH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Irq> xhci_irqs{ |
| {{ |
| .irq = T931_USB0_IRQ, |
| .mode = ZX_INTERRUPT_MODE_EDGE_HIGH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Mmio> usb_phy_mmios{ |
| {{ |
| .base = T931_USBCTRL_BASE, |
| .length = T931_USBCTRL_LENGTH, |
| }}, |
| {{ |
| .base = T931_USBPHY20_BASE, |
| .length = T931_USBPHY20_LENGTH, |
| }}, |
| {{ |
| .base = T931_USBPHY21_BASE, |
| .length = T931_USBPHY21_LENGTH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Irq> usb_phy_irqs{ |
| {{ |
| .irq = T931_USB_IDDIG_IRQ, |
| .mode = ZX_INTERRUPT_MODE_EDGE_HIGH, |
| }}, |
| }; |
| |
| static const std::vector<fpbus::Bti> usb_btis{ |
| {{ |
| .iommu_index = 0, |
| .bti_id = BTI_USB, |
| }}, |
| }; |
| |
| static const fpbus::Node xhci_dev = []() { |
| fpbus::Node dev = {}; |
| dev.name() = "xhci"; |
| dev.vid() = PDEV_VID_GENERIC; |
| dev.pid() = PDEV_PID_GENERIC; |
| dev.did() = PDEV_DID_USB_XHCI_COMPOSITE; |
| dev.mmio() = xhci_mmios; |
| dev.irq() = xhci_irqs; |
| dev.bti() = usb_btis; |
| return dev; |
| }(); |
| |
| static const PhyType type = kG12A; |
| |
| static const std::vector<UsbPhyMode> phy_modes = { |
| {UsbProtocol::Usb2_0, UsbMode::Host, false}, |
| {UsbProtocol::Usb2_0, UsbMode::Peripheral, true}, |
| }; |
| |
| static const std::vector<fpbus::Metadata> usb_phy_metadata{ |
| {{ |
| .type = DEVICE_METADATA_PRIVATE_PHY_TYPE | DEVICE_METADATA_PRIVATE, |
| .data = std::vector<uint8_t>(reinterpret_cast<const uint8_t*>(&type), |
| reinterpret_cast<const uint8_t*>(&type) + sizeof(type)), |
| }}, |
| {{ |
| .type = DEVICE_METADATA_USB_MODE, |
| .data = std::vector<uint8_t>(reinterpret_cast<const uint8_t*>(phy_modes.data()), |
| reinterpret_cast<const uint8_t*>(phy_modes.data()) + |
| phy_modes.size() * sizeof(UsbPhyMode)), |
| }}, |
| }; |
| |
| static const fpbus::Node usb_phy_dev = []() { |
| fpbus::Node dev = {}; |
| dev.name() = "aml-usb-phy"; |
| dev.pid() = bind_fuchsia_amlogic_platform::BIND_PLATFORM_DEV_PID_T931; |
| dev.vid() = bind_fuchsia_amlogic_platform::BIND_PLATFORM_DEV_VID_AMLOGIC; |
| dev.did() = bind_fuchsia_amlogic_platform::BIND_PLATFORM_DEV_DID_USB_PHY_V2; |
| dev.mmio() = usb_phy_mmios; |
| dev.irq() = usb_phy_irqs; |
| dev.bti() = usb_btis; |
| dev.metadata() = usb_phy_metadata; |
| return dev; |
| }(); |
| |
| zx_status_t AddUsbPhyComposite(fdf::WireSyncClient<fpbus::PlatformBus>& pbus, |
| fidl::AnyArena& fidl_arena, fdf::Arena& arena) { |
| const std::vector<fdf::BindRule> kResetRegisterRules = std::vector{ |
| fdf::MakeAcceptBindRule(bind_fuchsia_hardware_registers::SERVICE, |
| bind_fuchsia_hardware_registers::SERVICE_ZIRCONTRANSPORT), |
| fdf::MakeAcceptBindRule(bind_fuchsia_register::NAME, |
| bind_fuchsia_amlogic_platform::NAME_REGISTER_USB_PHY_V2_RESET), |
| }; |
| |
| const std::vector<fdf::NodeProperty> kResetRegisterProperties = std::vector{ |
| fdf::MakeProperty(bind_fuchsia_hardware_registers::SERVICE, |
| bind_fuchsia_hardware_registers::SERVICE_ZIRCONTRANSPORT), |
| fdf::MakeProperty(bind_fuchsia_register::NAME, |
| bind_fuchsia_amlogic_platform::NAME_REGISTER_USB_PHY_V2_RESET), |
| }; |
| |
| std::vector<fdf::ParentSpec> parents{{kResetRegisterRules, kResetRegisterProperties}}; |
| auto result = pbus.buffer(arena)->AddCompositeNodeSpec( |
| fidl::ToWire(fidl_arena, usb_phy_dev), |
| fidl::ToWire(fidl_arena, fuchsia_driver_framework::CompositeNodeSpec{ |
| {.name = "aml_usb_phy", .parents = parents}})); |
| if (!result.ok()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(usb_phy_dev) request failed: %s", |
| result.FormatDescription().data()); |
| return result.status(); |
| } |
| if (result->is_error()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(usb_phy_dev) failed: %s", |
| zx_status_get_string(result->error_value())); |
| return result->error_value(); |
| } |
| return ZX_OK; |
| } |
| |
| zx_status_t AddDwc2Composite(fdf::WireSyncClient<fpbus::PlatformBus>& pbus, |
| fidl::AnyArena& fidl_arena, fdf::Arena& arena) { |
| fpbus::Node dwc2_dev = {}; |
| dwc2_dev.name() = "dwc2"; |
| dwc2_dev.vid() = bind_fuchsia_platform::BIND_PLATFORM_DEV_VID_GENERIC; |
| dwc2_dev.pid() = bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC; |
| dwc2_dev.did() = bind_fuchsia_platform::BIND_PLATFORM_DEV_DID_USB_DWC2; |
| dwc2_dev.mmio() = dwc2_mmios; |
| dwc2_dev.irq() = dwc2_irqs; |
| dwc2_dev.bti() = dwc2_btis; |
| dwc2_dev.metadata() = usb_metadata; |
| dwc2_dev.boot_metadata() = usb_boot_metadata; |
| |
| const std::vector<fdf::BindRule> kDwc2PhyRules = std::vector{ |
| fdf::MakeAcceptBindRule(bind_fuchsia_hardware_usb_phy::SERVICE, |
| bind_fuchsia_hardware_usb_phy::SERVICE_DRIVERTRANSPORT), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_VID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_PID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_DID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_DID_USB_DWC2), |
| }; |
| |
| const std::vector<fdf::NodeProperty> kDwc2PhyProperties = std::vector{ |
| fdf::MakeProperty(bind_fuchsia_hardware_usb_phy::SERVICE, |
| bind_fuchsia_hardware_usb_phy::SERVICE_DRIVERTRANSPORT), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_VID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_PID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_DID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_DID_USB_DWC2), |
| }; |
| |
| std::vector<fdf::ParentSpec> parents{{kDwc2PhyRules, kDwc2PhyProperties}}; |
| auto spec_result = pbus.buffer(arena)->AddCompositeNodeSpec( |
| fidl::ToWire(fidl_arena, dwc2_dev), |
| fidl::ToWire(fidl_arena, fuchsia_driver_framework::CompositeNodeSpec{ |
| {.name = "dwc2_phy", .parents = parents}})); |
| if (!spec_result.ok()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(dwc2_phy) request failed: %s", |
| spec_result.FormatDescription().data()); |
| return spec_result.status(); |
| } |
| if (spec_result->is_error()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(dwc2_phy) failed: %s", |
| zx_status_get_string(spec_result->error_value())); |
| return spec_result->error_value(); |
| } |
| return ZX_OK; |
| } |
| |
| zx_status_t AddXhciComposite(fdf::WireSyncClient<fpbus::PlatformBus>& pbus, |
| fidl::AnyArena& fidl_arena, fdf::Arena& arena) { |
| const std::vector<fuchsia_driver_framework::BindRule> kXhciCompositeRules = { |
| fdf::MakeAcceptBindRule(bind_fuchsia_hardware_usb_phy::SERVICE, |
| bind_fuchsia_hardware_usb_phy::SERVICE_DRIVERTRANSPORT), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_VID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_PID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeAcceptBindRule(bind_fuchsia::PLATFORM_DEV_DID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_DID_XHCI), |
| }; |
| const std::vector<fuchsia_driver_framework::NodeProperty> kXhciCompositeProperties = { |
| fdf::MakeProperty(bind_fuchsia_hardware_usb_phy::SERVICE, |
| bind_fuchsia_hardware_usb_phy::SERVICE_DRIVERTRANSPORT), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_VID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_PID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_PID_GENERIC), |
| fdf::MakeProperty(bind_fuchsia::PLATFORM_DEV_DID, |
| bind_fuchsia_platform::BIND_PLATFORM_DEV_DID_XHCI), |
| }; |
| |
| const std::vector<fuchsia_driver_framework::ParentSpec> kXhciParents = { |
| fuchsia_driver_framework::ParentSpec{ |
| {.bind_rules = kXhciCompositeRules, .properties = kXhciCompositeProperties}}}; |
| auto result = pbus.buffer(arena)->AddCompositeNodeSpec( |
| fidl::ToWire(fidl_arena, xhci_dev), |
| fidl::ToWire(fidl_arena, fuchsia_driver_framework::CompositeNodeSpec{ |
| {.name = "xhci-phy", .parents = kXhciParents}})); |
| if (!result.ok()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(xhci-phy) request failed: %s", |
| result.FormatDescription().data()); |
| return result.status(); |
| } |
| if (result->is_error()) { |
| zxlogf(ERROR, "AddCompositeNodeSpec Usb(xhci-phy) failed: %s", |
| zx_status_get_string(result->error_value())); |
| return result->error_value(); |
| } |
| return ZX_OK; |
| } |
| |
| } // namespace |
| |
| zx_status_t Sherlock::UsbInit() { |
| fidl::Arena<> fidl_arena; |
| fdf::Arena arena('USB_'); |
| |
| auto status = AddUsbPhyComposite(pbus_, fidl_arena, arena); |
| if (status != ZX_OK) { |
| return status; |
| } |
| |
| // Add XHCI and DWC2 to the same driver_host as the aml-usb-phy. |
| status = AddXhciComposite(pbus_, fidl_arena, arena); |
| if (status != ZX_OK) { |
| return status; |
| } |
| |
| status = AddDwc2Composite(pbus_, fidl_arena, arena); |
| if (status != ZX_OK) { |
| return status; |
| } |
| |
| return ZX_OK; |
| } |
| |
| } // namespace sherlock |
