Documentation/devicetree/bindings/clock/ti/ti,autoidle.yaml

File Facts

System

Linux kernel

Corpus path

Documentation/devicetree/bindings/clock/ti/ti,autoidle.yaml

Extension

.yaml

Size

1054 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/clock/ti/ti,autoidle.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: TI autoidle clock

maintainers:
  - Tero Kristo <kristo@kernel.org>
  - Sukrut Bellary <sbellary@baylibre.com>

description:
  Some clocks in TI SoC support the autoidle feature. These properties are
  applicable only if the clock supports autoidle feature. It assumes a register
  mapped clock which can be put to idle automatically by hardware based on
  usage and configuration bit setting. Autoidle clock is never an individual
  clock, it is always a derivative of some basic clock like a gate, divider, or
  fixed-factor.

properties:
  ti,autoidle-shift:
    $ref: /schemas/types.yaml#/definitions/uint32
    description:
      bit shift of the autoidle enable bit for the clock
    maximum: 31
    default: 0

  ti,invert-autoidle-bit:
    type: boolean
    description:
      autoidle is enabled by setting the bit to 0

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.