Documentation/devicetree/bindings/fpga/lattice,ice40-fpga-mgr.yaml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/fpga/lattice,ice40-fpga-mgr.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Lattice iCE40 FPGA Manager

maintainers:
  - Joel Holdsworth <joel@airwebreathe.org.uk>

properties:
  compatible:
    const: lattice,ice40-fpga-mgr

  reg:
    maxItems: 1

  spi-max-frequency:
    minimum: 1000000
    maximum: 25000000

  cdone-gpios:
    maxItems: 1
    description: GPIO input connected to CDONE pin

  reset-gpios:
    maxItems: 1
    description:
      Active-low GPIO output connected to CRESET_B pin. Note that unless the
      GPIO is held low during startup, the FPGA will enter Master SPI mode and
      drive SCK with a clock signal potentially jamming other devices on the bus
      until the firmware is loaded.

required:
  - compatible
  - reg
  - spi-max-frequency
  - cdone-gpios
  - reset-gpios

additionalProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>

    spi {
        #address-cells = <1>;
        #size-cells = <0>;

        fpga@0 {
            compatible = "lattice,ice40-fpga-mgr";
            reg = <0>;
            spi-max-frequency = <1000000>;
            cdone-gpios = <&gpio 24 GPIO_ACTIVE_HIGH>;
            reset-gpios = <&gpio 22 GPIO_ACTIVE_LOW>;
        };
    };