Documentation/devicetree/bindings/i2c/opencores,i2c-ocores.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/i2c/opencores,i2c-ocores.yaml

File Facts

System
Linux kernel
Corpus path
Documentation/devicetree/bindings/i2c/opencores,i2c-ocores.yaml
Extension
.yaml
Size
3090 bytes
Lines
115
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: configuration, schema, or hardware description
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

# 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:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |
      deprecated, use reg-shift above
    deprecated: true

  opencores,ip-clock-frequency:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |

Annotation

Implementation Notes