infineon,pdm
Description
Infineon PDM (Pulse Density Modulation) Controller
Properties
Top level properties
These property descriptions apply to “infineon,pdm” nodes themselves. This page also describes child node properties in the following sections.
Node specific properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Peripheral clock destination ID for this PDM instance
This property is required. |
|
|
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.
This property is required. |
|
|
Names for the provided states. The number of names needs to match the
number of states.
This property is required. |
|
|
FIR filter coefficients for the PDM. This array has 8 elements.
|
|
|
FIR filter coefficients for the PDM. This array has 14 elements.
|
|
|
Pin configuration/s for the second state. See pinctrl-0.
|
|
|
Pin configuration/s for the third state. See pinctrl-0.
|
|
|
Pin configuration/s for the fourth state. See pinctrl-0.
|
|
|
Pin configuration/s for the fifth state. See pinctrl-0.
|
Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
Base properties
Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “infineon,pdm” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
This property is required. |
|
|
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
DMA specifier which includes the phandle reference to the
DMA controller and the channel number.
Example:
dmas = <&dma0 0>;
This property is required. |
|
|
Required if the dmas property exists. This should be "rx".
Example:
dma-names = "rx";
This property is required. |
|
|
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: See Important properties for more information. |
|
|
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
|
|
|
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
|
|
|
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See Important properties for more information. |
|
|
Optional names given to each clock provider in the "clocks" property.
|
|
|
This property encodes the number of <u32> cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
This property encodes the number of <u32> cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
|
|
|
IO channel specifiers relevant to the device.
|
|
|
Optional names given to the IO channel specifiers in the "io-channels" property.
|
|
|
Mailbox / IPM channel specifiers relevant to the device.
|
|
|
Optional names given to the mbox specifiers in the "mboxes" property.
|
|
|
Power domain specifiers relevant to the device.
|
|
|
Optional names given to the power domain specifiers in the "power-domains" property.
|
|
|
Number of cells in power-domains property
|
|
|
HW spinlock id relevant to the device.
|
|
|
Optional names given to the hwlock specifiers in the "hwlocks" property.
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
Property to identify that a device can be used as wake up source.
When this property is provided a specific flag is set into the
device that tells the system that the device is capable of
wake up the system.
Wake up capable devices are disabled (interruptions will not wake up
the system) by default but they can be enabled at runtime if necessary.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|
Child node properties
Name |
Type |
Details |
|---|---|---|
|
|
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
Channel number for this PDM channel.
This property is required. |
|
|
If true, use the pdm data pin from the alternate channel
as specified in the ROUTE_CTL register.
|
|
|
The CIC filter decimation code should be set according to the
relative frequency of the PDM and PCM frequencies.
0: DECIM_2
1: DECIM_4
2: DECIM_8
3: DECIM_16
4: DECIM_32 (default)
Legal values: |
|
|
Disable the DC blocker filter. For debug purposes.
|
|
|
Specifies the DC blocker coefficient:
0: alpha = 0.999755859
1: alpha = 0.999511719 (default)
2: alpha = 0.999023438
3: alpha = 0.998046875
4: alpha = 0.99609375
5: alpha = 0.9921875
6: alpha = 0.984375
7: alpha = 0.96875
Legal values: |
|
|
Enable FIR0 filter for the channel. Disabled by default
and typically only used for sample frequencies of 8 and 16 kHz.
|
|
|
FIR0 filter PCM scaling. FIR0 filter PCM values are scaled
(right shifted, rounded and clipped) to 26bit signed PCM
values. This parameter specifies the right shift amount:
0: no shift
1: shift right by 1
...
31: shift right by 31
|
|
|
Sets the FIR0 filter PCM frequency relative to the CIC filter PCM frequency:
0: PCM frequency is the same as CIC frequency (default)
1: PCM frequency is 1/2 of CIC frequency
2: PCM frequency is 1/3 of CIC frequency
3: PCM frequency is 1/4 of CIC frequency
4: PCM frequency is 1/5 of CIC frequency
Legal values: |
|
|
FIR1 filter PCM scaling. FIR1 filter PCM values are scaled
(right shifted, rounded and clipped) to 26bit signed PCM
values. This parameter specifies the right shift amount:
0: no shift
1: shift right by 1
...
31: shift right by 31
|
|
|
Sets the FIR1 filter PCM frequency relative to the CIC filter PCM frequency:
0: PCM frequency is the same as CIC frequency (default)
1: PCM frequency is 1/2 of CIC frequency
2: PCM frequency is 1/3 of CIC frequency
3: PCM frequency is 1/4 of CIC frequency
4: PCM frequency is 1/5 of CIC frequency
Legal values: |