Documentation/devicetree/bindings/serial/serial-peripheral-props.yaml

Source file repositories/reference/linux-study-clean/Documentation/devicetree/bindings/serial/serial-peripheral-props.yaml

File Facts

System: Linux kernel
Corpus path: Documentation/devicetree/bindings/serial/serial-peripheral-props.yaml
Extension: .yaml
Size: 1438 bytes
Lines: 42
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/serial/serial-peripheral-props.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Common Properties for Serial-attached Devices

maintainers:
  - Rob Herring <robh@kernel.org>
  - Greg Kroah-Hartman <gregkh@linuxfoundation.org>

description:
  Devices connected over serial/UART, expressed as children of a serial
  controller, might need similar properties, e.g. for configuring the baud
  rate.

properties:
  max-speed:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      The maximum baud rate the device operates at.
      This should only be present if the maximum is less than the slave
      device can support.  For example, a particular board has some
      signal quality issue or the host processor can't support higher
      baud rates.

  current-speed:
    $ref: /schemas/types.yaml#/definitions/uint32
    description: |
      The current baud rate the device operates at.
      This should only be present in case a driver has no chance to know
      the baud rate of the slave device.
      Examples:
        * device supports auto-baud
        * the rate is setup by a bootloader and there is no way to reset
          the device
        * device baud rate is configured by its firmware but there is no
          way to request the actual settings

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.