xref: /freebsd/sys/contrib/device-tree/Bindings/sound/microchip,pdmc.yaml (revision 734e82fe33aa764367791a7d603b383996c6b40b) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/sound/microchip,pdmc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Microchip Pulse Density Microphone Controller
8
9maintainers:
10  - Codrin Ciubotariu <codrin.ciubotariu@microchip.com>
11
12description:
13  The Microchip Pulse Density Microphone Controller (PDMC) interfaces up to 4
14  digital microphones having Pulse Density Modulated (PDM) outputs.
15
16allOf:
17  - $ref: dai-common.yaml#
18
19properties:
20  compatible:
21    const: microchip,sama7g5-pdmc
22
23  reg:
24    maxItems: 1
25
26  "#sound-dai-cells":
27    const: 0
28
29  interrupts:
30    maxItems: 1
31
32  clocks:
33    items:
34      - description: Peripheral Bus Clock
35      - description: Generic Clock
36
37  clock-names:
38    items:
39      - const: pclk
40      - const: gclk
41
42  dmas:
43    description: RX DMA Channel
44    maxItems: 1
45
46  dma-names:
47    const: rx
48
49  microchip,mic-pos:
50    description: |
51      Position of PDM microphones on the DS line and the sampling edge (rising
52      or falling) of the CLK line. A microphone is represented as a pair of DS
53      line and the sampling edge. The first microphone is mapped to channel 0,
54      the second to channel 1, etc.
55    $ref: /schemas/types.yaml#/definitions/uint32-matrix
56    items:
57      items:
58        - description: value for DS line
59        - description: value for sampling edge
60      anyOf:
61        - enum:
62            - [0, 0]
63            - [0, 1]
64            - [1, 0]
65            - [1, 1]
66    minItems: 1
67    maxItems: 4
68    uniqueItems: true
69
70required:
71  - compatible
72  - reg
73  - "#sound-dai-cells"
74  - interrupts
75  - clocks
76  - clock-names
77  - dmas
78  - dma-names
79  - microchip,mic-pos
80
81unevaluatedProperties: false
82
83examples:
84  - |
85    #include <dt-bindings/clock/at91.h>
86    #include <dt-bindings/dma/at91.h>
87    #include <dt-bindings/interrupt-controller/arm-gic.h>
88    #include <dt-bindings/sound/microchip,pdmc.h>
89
90    pdmc: sound@e1608000 {
91        compatible = "microchip,sama7g5-pdmc";
92        reg = <0xe1608000 0x4000>;
93        #sound-dai-cells = <0>;
94        interrupts = <GIC_SPI 68 IRQ_TYPE_LEVEL_HIGH>;
95        dmas = <&dma0 AT91_XDMAC_DT_PERID(37)>;
96        dma-names = "rx";
97        clocks = <&pmc PMC_TYPE_PERIPHERAL 68>, <&pmc PMC_TYPE_GCK 68>;
98        clock-names = "pclk", "gclk";
99        microchip,mic-pos = <MCHP_PDMC_DS0 MCHP_PDMC_CLK_POSITIVE>,
100                            <MCHP_PDMC_DS0 MCHP_PDMC_CLK_NEGATIVE>,
101                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_POSITIVE>,
102                            <MCHP_PDMC_DS1 MCHP_PDMC_CLK_NEGATIVE>;
103    };
104