Documentation/devicetree/bindings/usb/maxim,max3420-udc.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/usb/maxim,max3420-udc.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: MAXIM MAX3420/1 USB Peripheral Controller
   8
   9 maintainers:
  10   - Jassi Brar <jaswinder.singh@linaro.org>
  11
  12 description: |
  13   The controller provices USB2.0 compliant FullSpeed peripheral
  14   implementation over the SPI interface.
  15
  16   Specifications about the part can be found at:
  17     http://datasheets.maximintegrated.com/en/ds/MAX3420E.pdf
  18
  19 properties:
  20   compatible:
  21     enum:
  22       - maxim,max3420-udc
  23       - maxim,max3421-udc
  24
  25   reg:
  26     maxItems: 1
  27
  28   interrupts:
  29     items:
  30       - description: usb irq from max3420
  31       - description: vbus detection irq
  32     minItems: 1
  33
  34   interrupt-names:
  35     items:
  36       - const: udc
  37       - const: vbus
  38     minItems: 1
  39
  40   spi-max-frequency:
  41     maximum: 26000000
  42
  43 required:
  44   - compatible
  45   - reg
  46   - interrupts
  47   - interrupt-names
  48
  49 additionalProperties: false
  50
  51 examples:
  52   - |
  53       #include <dt-bindings/gpio/gpio.h>
  54       #include <dt-bindings/interrupt-controller/irq.h>
  55       spi0 {
  56             #address-cells = <1>;
  57             #size-cells = <0>;
  58
  59             udc@0 {
  60                   compatible = "maxim,max3420-udc";
  61                   reg = <0>;
  62                   interrupt-parent = <&gpio>;
  63                   interrupts = <0 IRQ_TYPE_EDGE_FALLING>, <10 IRQ_TYPE_EDGE_BOTH>;
  64                   interrupt-names = "udc", "vbus";
  65                   spi-max-frequency = <12500000>;
  66             };
  67       };