# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/usb/atmel,at91rm9200-udc.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Atmel AT91 USB Device Controller (UDC)

maintainers:
  - Nicolas Ferre <nicolas.ferre@microchip.com>
  - Alexandre Belloni <alexandre.belloni@bootlin.com>

description:
  The Atmel AT91 USB Device Controller provides USB gadget (device-mode)
  functionality on AT91 SoCs. It requires a peripheral clock and an AHB
  clock for operation and may optionally control VBUS power through a GPIO.

properties:
  compatible:
    enum:
      - atmel,at91rm9200-udc
      - atmel,at91sam9260-udc
      - atmel,at91sam9261-udc
      - atmel,at91sam9263-udc

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  clocks:
    maxItems: 2

  clock-names:
    items:
      - const: pclk
      - const: hclk

  atmel,vbus-gpio:
    description: GPIO used to enable or control VBUS power for the USB bus.
    maxItems: 1

  atmel,matrix:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: Phandle to the Atmel bus matrix controller.

  atmel,pullup-gpio:
    description:
      GPIO controlling the USB D+ pull-up resistor used to signal device
      connection to the host.
    maxItems: 1

required:
  - compatible
  - reg
  - interrupts
  - clocks
  - clock-names

additionalProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/clock/at91.h>
    #include <dt-bindings/gpio/gpio.h>
    gadget@fffa4000 {
        compatible = "atmel,at91rm9200-udc";
        reg = <0xfffa4000 0x4000>;
        interrupts = <11 IRQ_TYPE_LEVEL_HIGH 2>;
        clocks = <&udc_clk>, <&udpck>;
        clock-names = "pclk", "hclk";
        atmel,vbus-gpio = <&pioC 5 GPIO_ACTIVE_HIGH>;
    };
...