Documentation/devicetree/bindings/i2c/i2c-atr.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/i2c/i2c-atr.yaml

File Facts

System: Linux kernel
Corpus path: Documentation/devicetree/bindings/i2c/i2c-atr.yaml
Extension: .yaml
Size: 1414 bytes
Lines: 35
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.

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

Dependency Surface

No C-style include directives detected by the generator.

Detected Declarations

No top-level syscall, struct, function, initcall, or export declaration detected by the generator.

Annotated Snippet

# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
%YAML 1.2
---
$id: http://devicetree.org/schemas/i2c/i2c-atr.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Common i2c address translator properties

maintainers:
  - Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>

description:
  An I2C Address Translator (ATR) is a device with an I2C slave parent
  ("upstream") port and N I2C master child ("downstream") ports, and
  forwards transactions from upstream to the appropriate downstream port
  with a modified slave address. The address used on the parent bus is
  called the "alias" and is (potentially) different from the physical
  slave address of the child bus. Address translation is done by the
  hardware.

properties:
  i2c-alias-pool:
    $ref: /schemas/types.yaml#/definitions/uint32-array
    description:
      I2C alias pool is a pool of I2C addresses on the main I2C bus that can be
      used to access the remote peripherals on the serializer's I2C bus. The
      addresses must be available, not used by any other peripheral. Each
      remote peripheral is assigned an alias from the pool, and transactions to
      that address will be forwarded to the remote peripheral, with the address
      translated to the remote peripheral's real address. This property is not
      needed if there are no I2C addressable remote peripherals.

additionalProperties: true
...

Annotation

Atlas domain: Support Tooling And Documentation / Documentation.
Implementation status: atlas-only.

Implementation Notes

This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.