Skip to content

Commit

Permalink
dt-bindings: clock: document the fsl-sai driver
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Walle <michael@walle.cc>
Reviewed-by: Rob Herring <robh@kernel.org>
Link: https://lkml.kernel.org/r/20200102231101.11834-2-michael@walle.cc
Signed-off-by: Stephen Boyd <sboyd@kernel.org>
  • Loading branch information
Michael Walle authored and Stephen Boyd committed Jan 28, 2020
1 parent 73ef657 commit 8798e8f
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions Documentation/devicetree/bindings/clock/fsl,sai-clock.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/bindings/clock/fsl,sai-clock.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Freescale SAI bitclock-as-a-clock binding

maintainers:
- Michael Walle <michael@walle.cc>

description: |
It is possible to use the BCLK pin of a SAI module as a generic clock
output. Some SoC are very constrained in their pin multiplexer
configuration. Eg. pins can only be changed groups. For example, on the
LS1028A SoC you can only enable SAIs in pairs. If you use only one SAI,
the second pins are wasted. Using this binding it is possible to use the
clock of the second SAI as a MCLK clock for an audio codec, for example.
This is a composite of a gated clock and a divider clock.
properties:
compatible:
const: fsl,vf610-sai-clock

reg:
maxItems: 1

clocks:
maxItems: 1

'#clock-cells':
const: 0

required:
- compatible
- reg
- clocks
- '#clock-cells'

additionalProperties: false

examples:
- |
soc {
#address-cells = <2>;
#size-cells = <2>;
mclk: clock-mclk@f130080 {
compatible = "fsl,vf610-sai-clock";
reg = <0x0 0xf130080 0x0 0x80>;
#clock-cells = <0>;
clocks = <&parentclk>;
};
};

0 comments on commit 8798e8f

Please sign in to comment.