Commit e62ebf62 authored by Aswath Govindraju's avatar Aswath Govindraju Committed by Rob Herring
Browse files

dt-bindings: eeprom-93xx46: Convert to json schema



Convert eeprom-93xx46 binding documentation from txt to yaml format

Signed-off-by: default avatarAswath Govindraju <a-govindraju@ti.com>
Link: https://lore.kernel.org/r/20210818105626.31800-1-a-govindraju@ti.com


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent a083fadf
Loading
Loading
Loading
Loading
+0 −29
Original line number Diff line number Diff line
EEPROMs (SPI) compatible with Microchip Technology 93xx46 family.

Required properties:
- compatible : shall be one of:
    "atmel,at93c46"
    "atmel,at93c46d"
    "atmel,at93c56"
    "atmel,at93c66"
    "eeprom-93xx46"
    "microchip,93lc46b"
- data-size : number of data bits per word (either 8 or 16)

Optional properties:
- read-only : parameter-less property which disables writes to the EEPROM
- select-gpios : if present, specifies the GPIO that will be asserted prior to
  each access to the EEPROM (e.g. for SPI bus multiplexing)

Property rules described in Documentation/devicetree/bindings/spi/spi-bus.txt
apply.  In particular, "reg" and "spi-max-frequency" properties must be given.

Example:
	eeprom@0 {
		compatible = "eeprom-93xx46";
		reg = <0>;
		spi-max-frequency = <1000000>;
		spi-cs-high;
		data-size = <8>;
		select-gpios = <&gpio4 4 GPIO_ACTIVE_HIGH>;
	};
+70 −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/misc/eeprom-93xx46.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Microchip 93xx46 SPI compatible EEPROM family dt bindings

maintainers:
  - Cory Tusar <cory.tusar@pid1solutions.com>

properties:
  compatible:
    enum:
      - atmel,at93c46
      - atmel,at93c46d
      - atmel,at93c56
      - atmel,at93c66
      - eeprom-93xx46
      - microchip,93lc46b

  data-size:
    description: number of data bits per word
    $ref: /schemas/types.yaml#/definitions/uint32
    enum: [8, 16]

  reg:
    description: chip select of EEPROM
    maxItems: 1

  spi-max-frequency: true
  spi-cs-high: true

  read-only:
    description:
      parameter-less property which disables writes to the EEPROM
    type: boolean

  select-gpios:
    description:
      specifies the GPIO that needs to be asserted prior to each access
      of EEPROM (e.g. for SPI bus multiplexing)
    maxItems: 1


required:
  - compatible
  - reg
  - data-size
  - spi-max-frequency

additionalProperties: false

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

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

      eeprom@0 {
        compatible = "eeprom-93xx46";
        reg = <0>;
        spi-max-frequency = <1000000>;
        spi-cs-high;
        data-size = <8>;
        select-gpios = <&gpio4 4 GPIO_ACTIVE_HIGH>;
      };
    };