Commit 90541270 authored by Akhila YS's avatar Akhila YS Committed by Miquel Raynal
Browse files

dt-bindings: mtd: st,spi-fsm: convert to DT schema



Convert STMicroelectronics SPI FSM Serial NOR Flash Controller binding
to DT Schema.

Signed-off-by: default avatarAkhila YS <akhilayalmati@gmail.com>
Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
parent 2372fe1c
Loading
Loading
Loading
Loading
+68 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/mtd/st,spi-fsm.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: STMicroelectronics SPI FSM Serial NOR Flash Controller

maintainers:
  - Angus Clark <angus.clark@st.com>

description:
  The STMicroelectronics Fast Sequence Mode (FSM) controller is a dedicated
  hardware accelerator integrated in older STiH4xx/STiDxxx set-top box SoCs
  (such as STiH407, STiH416, STiD127). It connects directly to a single
  external serial flash device used as the primary boot device. The FSM
  executes hard-coded or configurable instruction sequences in hardware,
  providing low-latency reads suitable for execute-in-place (XIP) boot
  and high read bandwidth.

properties:
  compatible:
    const: st,spi-fsm

  reg:
    maxItems: 1

  reg-names:
    const: spi-fsm

  interrupts:
    maxItems: 1

  st,syscfg:
    $ref: /schemas/types.yaml#/definitions/phandle
    description: Phandle to the system configuration registers used for boot-device selection.

  st,boot-device-reg:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Offset of the boot-device register within the st,syscfg node.

  st,boot-device-spi:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: Expected boot-device value when booting from this SPI controller.

required:
  - compatible
  - reg
  - reg-names
  - interrupts
  - pinctrl-0

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/interrupt-controller/arm-gic.h>
    spifsm@fe902000 {
        compatible = "st,spi-fsm";
        reg = <0xfe902000 0x1000>;
        reg-names = "spi-fsm";
        interrupts = <GIC_SPI 64 IRQ_TYPE_LEVEL_HIGH>;
        pinctrl-0 = <&pinctrl_fsm>;
        st,syscfg = <&syscfg_rear>;
        st,boot-device-reg = <0x958>;
        st,boot-device-spi = <0x1a>;
    };
...
+0 −25
Original line number Diff line number Diff line
* ST-Microelectronics SPI FSM Serial (NOR) Flash Controller

Required properties:
  - compatible : Should be "st,spi-fsm"
  - reg        : Contains register's location and length.
  - reg-names  : Should contain the reg names "spi-fsm"
  - interrupts : The interrupt number
  - pinctrl-0  : Standard Pinctrl phandle (see: pinctrl/pinctrl-bindings.txt)

Optional properties:
  - st,syscfg          : Phandle to boot-device system configuration registers
  - st,boot-device-reg : Address of the aforementioned boot-device register(s)
  - st,boot-device-spi : Expected boot-device value if booted via this device

Example:
	spifsm: spifsm@fe902000{
	        compatible         = "st,spi-fsm";
	        reg                =  <0xfe902000 0x1000>;
	        reg-names          = "spi-fsm";
	        pinctrl-0          = <&pinctrl_fsm>;
		st,syscfg	   = <&syscfg_rear>;
	        st,boot-device-reg = <0x958>;
	        st,boot-device-spi = <0x1a>;
	};