mirror of
https://github.com/Fishwaldo/Star64_linux.git
synced 2025-06-29 10:01:25 +00:00
dt-bindings: i2c: convert ocores binding to yaml
Convert the open cores i2c controller binding from text to yaml. Reviewed-by: Rob Herring <robh@kernel.org> Signed-off-by: Conor Dooley <conor.dooley@microchip.com> Signed-off-by: Wolfram Sang <wsa@kernel.org>
This commit is contained in:
Conor Dooley
Wolfram Sang
parent
74557cb4e8
commit
8ad69f4905
3 changed files with 114 additions and 79 deletions
|
|
@ -1,78 +0,0 @@
|
||||||
Device tree configuration for i2c-ocores
|
|
||||||
|
|
||||||
Required properties:
|
|
||||||
- compatible : "opencores,i2c-ocores"
|
|
||||||
"aeroflexgaisler,i2cmst"
|
|
||||||
"sifive,fu540-c000-i2c", "sifive,i2c0"
|
|
||||||
For Opencore based I2C IP block reimplemented in
|
|
||||||
FU540-C000 SoC.
|
|
||||||
"sifive,fu740-c000-i2c", "sifive,i2c0"
|
|
||||||
For Opencore based I2C IP block reimplemented in
|
|
||||||
FU740-C000 SoC.
|
|
||||||
Please refer to sifive-blocks-ip-versioning.txt for
|
|
||||||
additional details.
|
|
||||||
- reg : bus address start and address range size of device
|
|
||||||
- clocks : handle to the controller clock; see the note below.
|
|
||||||
Mutually exclusive with opencores,ip-clock-frequency
|
|
||||||
- opencores,ip-clock-frequency: frequency of the controller clock in Hz;
|
|
||||||
see the note below. Mutually exclusive with clocks
|
|
||||||
- #address-cells : should be <1>
|
|
||||||
- #size-cells : should be <0>
|
|
||||||
|
|
||||||
Optional properties:
|
|
||||||
- interrupts : interrupt number.
|
|
||||||
- clock-frequency : frequency of bus clock in Hz; see the note below.
|
|
||||||
Defaults to 100 KHz when the property is not specified
|
|
||||||
- reg-shift : device register offsets are shifted by this value
|
|
||||||
- reg-io-width : io register width in bytes (1, 2 or 4)
|
|
||||||
- regstep : deprecated, use reg-shift above
|
|
||||||
|
|
||||||
Note
|
|
||||||
clock-frequency property is meant to control the bus frequency for i2c bus
|
|
||||||
drivers, but it was incorrectly used to specify i2c controller input clock
|
|
||||||
frequency. So the following rules are set to fix this situation:
|
|
||||||
- if clock-frequency is present and neither opencores,ip-clock-frequency nor
|
|
||||||
clocks are, then clock-frequency specifies i2c controller clock frequency.
|
|
||||||
This is to keep backwards compatibility with setups using old DTB. i2c bus
|
|
||||||
frequency is fixed at 100 KHz.
|
|
||||||
- if clocks is present it specifies i2c controller clock. clock-frequency
|
|
||||||
property specifies i2c bus frequency.
|
|
||||||
- if opencores,ip-clock-frequency is present it specifies i2c controller
|
|
||||||
clock frequency. clock-frequency property specifies i2c bus frequency.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
i2c0: ocores@a0000000 {
|
|
||||||
#address-cells = <1>;
|
|
||||||
#size-cells = <0>;
|
|
||||||
compatible = "opencores,i2c-ocores";
|
|
||||||
reg = <0xa0000000 0x8>;
|
|
||||||
interrupts = <10>;
|
|
||||||
opencores,ip-clock-frequency = <20000000>;
|
|
||||||
|
|
||||||
reg-shift = <0>; /* 8 bit registers */
|
|
||||||
reg-io-width = <1>; /* 8 bit read/write */
|
|
||||||
|
|
||||||
dummy@60 {
|
|
||||||
compatible = "dummy";
|
|
||||||
reg = <0x60>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
or
|
|
||||||
i2c0: ocores@a0000000 {
|
|
||||||
#address-cells = <1>;
|
|
||||||
#size-cells = <0>;
|
|
||||||
compatible = "opencores,i2c-ocores";
|
|
||||||
reg = <0xa0000000 0x8>;
|
|
||||||
interrupts = <10>;
|
|
||||||
clocks = <&osc>;
|
|
||||||
clock-frequency = <400000>; /* i2c bus frequency 400 KHz */
|
|
||||||
|
|
||||||
reg-shift = <0>; /* 8 bit registers */
|
|
||||||
reg-io-width = <1>; /* 8 bit read/write */
|
|
||||||
|
|
||||||
dummy@60 {
|
|
||||||
compatible = "dummy";
|
|
||||||
reg = <0x60>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
113
Documentation/devicetree/bindings/i2c/opencores,i2c-ocores.yaml
Normal file
113
Documentation/devicetree/bindings/i2c/opencores,i2c-ocores.yaml
Normal file
|
|
@ -0,0 +1,113 @@
|
||||||
|
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
|
||||||
|
%YAML 1.2
|
||||||
|
---
|
||||||
|
$id: http://devicetree.org/schemas/i2c/opencores,i2c-ocores.yaml#
|
||||||
|
$schema: http://devicetree.org/meta-schemas/core.yaml#
|
||||||
|
|
||||||
|
title: OpenCores I2C controller
|
||||||
|
|
||||||
|
maintainers:
|
||||||
|
- Peter Korsgaard <peter@korsgaard.com>
|
||||||
|
- Andrew Lunn <andrew@lunn.ch>
|
||||||
|
|
||||||
|
allOf:
|
||||||
|
- $ref: /schemas/i2c/i2c-controller.yaml#
|
||||||
|
|
||||||
|
properties:
|
||||||
|
compatible:
|
||||||
|
oneOf:
|
||||||
|
- items:
|
||||||
|
- enum:
|
||||||
|
- sifive,fu740-c000-i2c # Opencore based IP block FU740-C000 SoC
|
||||||
|
- sifive,fu540-c000-i2c # Opencore based IP block FU540-C000 SoC
|
||||||
|
- const: sifive,i2c0
|
||||||
|
- enum:
|
||||||
|
- opencores,i2c-ocores
|
||||||
|
- aeroflexgaisler,i2cmst
|
||||||
|
|
||||||
|
reg:
|
||||||
|
maxItems: 1
|
||||||
|
|
||||||
|
interrupts:
|
||||||
|
maxItems: 1
|
||||||
|
|
||||||
|
clocks:
|
||||||
|
maxItems: 1
|
||||||
|
|
||||||
|
clock-frequency:
|
||||||
|
description: |
|
||||||
|
clock-frequency property is meant to control the bus frequency for i2c bus
|
||||||
|
drivers, but it was incorrectly used to specify i2c controller input clock
|
||||||
|
frequency. So the following rules are set to fix this situation:
|
||||||
|
- if clock-frequency is present and neither opencores,ip-clock-frequency nor
|
||||||
|
clocks are, then clock-frequency specifies i2c controller clock frequency.
|
||||||
|
This is to keep backwards compatibility with setups using old DTB. i2c bus
|
||||||
|
frequency is fixed at 100 KHz.
|
||||||
|
- if clocks is present it specifies i2c controller clock. clock-frequency
|
||||||
|
property specifies i2c bus frequency.
|
||||||
|
- if opencores,ip-clock-frequency is present it specifies i2c controller
|
||||||
|
clock frequency. clock-frequency property specifies i2c bus frequency.
|
||||||
|
default: 100000
|
||||||
|
|
||||||
|
reg-io-width:
|
||||||
|
description: |
|
||||||
|
io register width in bytes
|
||||||
|
enum: [1, 2, 4]
|
||||||
|
|
||||||
|
reg-shift:
|
||||||
|
description: |
|
||||||
|
device register offsets are shifted by this value
|
||||||
|
default: 0
|
||||||
|
|
||||||
|
regstep:
|
||||||
|
description: |
|
||||||
|
deprecated, use reg-shift above
|
||||||
|
deprecated: true
|
||||||
|
|
||||||
|
opencores,ip-clock-frequency:
|
||||||
|
$ref: /schemas/types.yaml#/definitions/uint32
|
||||||
|
description: |
|
||||||
|
Frequency of the controller clock in Hz. Mutually exclusive with clocks.
|
||||||
|
See the note above.
|
||||||
|
|
||||||
|
required:
|
||||||
|
- compatible
|
||||||
|
- reg
|
||||||
|
- "#address-cells"
|
||||||
|
- "#size-cells"
|
||||||
|
|
||||||
|
oneOf:
|
||||||
|
- required:
|
||||||
|
- opencores,ip-clock-frequency
|
||||||
|
- required:
|
||||||
|
- clocks
|
||||||
|
|
||||||
|
unevaluatedProperties: false
|
||||||
|
|
||||||
|
examples:
|
||||||
|
- |
|
||||||
|
i2c@a0000000 {
|
||||||
|
compatible = "opencores,i2c-ocores";
|
||||||
|
reg = <0xa0000000 0x8>;
|
||||||
|
#address-cells = <1>;
|
||||||
|
#size-cells = <0>;
|
||||||
|
interrupts = <10>;
|
||||||
|
opencores,ip-clock-frequency = <20000000>;
|
||||||
|
|
||||||
|
reg-shift = <0>; /* 8 bit registers */
|
||||||
|
reg-io-width = <1>; /* 8 bit read/write */
|
||||||
|
};
|
||||||
|
|
||||||
|
i2c@b0000000 {
|
||||||
|
compatible = "opencores,i2c-ocores";
|
||||||
|
reg = <0xa0000000 0x8>;
|
||||||
|
#address-cells = <1>;
|
||||||
|
#size-cells = <0>;
|
||||||
|
interrupts = <10>;
|
||||||
|
clocks = <&osc>;
|
||||||
|
clock-frequency = <400000>; /* i2c bus frequency 400 KHz */
|
||||||
|
|
||||||
|
reg-shift = <0>; /* 8 bit registers */
|
||||||
|
reg-io-width = <1>; /* 8 bit read/write */
|
||||||
|
};
|
||||||
|
...
|
||||||
|
|
@ -14869,7 +14869,7 @@ M: Peter Korsgaard <peter@korsgaard.com>
|
||||||
M: Andrew Lunn <andrew@lunn.ch>
|
M: Andrew Lunn <andrew@lunn.ch>
|
||||||
L: linux-i2c@vger.kernel.org
|
L: linux-i2c@vger.kernel.org
|
||||||
S: Maintained
|
S: Maintained
|
||||||
F: Documentation/devicetree/bindings/i2c/i2c-ocores.txt
|
F: Documentation/devicetree/bindings/i2c/i2c-ocores.yaml
|
||||||
F: Documentation/i2c/busses/i2c-ocores.rst
|
F: Documentation/i2c/busses/i2c-ocores.rst
|
||||||
F: drivers/i2c/busses/i2c-ocores.c
|
F: drivers/i2c/busses/i2c-ocores.c
|
||||||
F: include/linux/platform_data/i2c-ocores.h
|
F: include/linux/platform_data/i2c-ocores.h
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue