nxp,lpacmp

Description

NXP Low-Power Analog Comparator (LPACMP)

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

positive-input

string

Positive input selection for channel 0 (SEL0[INP_SEL]).

The list is ordered by the register encoding, not by input number: the
hardware encodes 0 as comp_in4 and 1 as comp_in5 before continuing with
comp_in0 through comp_in3. The driver writes the enum index straight into
SEL0[INP_SEL], so entries must stay in this order and must not be sorted.

This property is required.

Legal values: comp_in4, comp_in5, comp_in0, comp_in1, comp_in2, comp_in3

negative-input

int

Negative (reference) input selection for channel 0 (SEL0[INN_SEL]).
Values 0-13 select an internal reference of (value + 1) x AVDD / 15.
Value 14 selects external input comp_in4 and value 15 selects external
input comp_in5.

This property is required.

Value range: 0 to 15

sample-delay

int

Channel 0 sample delay counter value (DELAY0[DEL]) in AON_CLK cycles.
The comparator output is sampled every time this counter reaches zero,
so the value sets the sampling period and must give the output enough
time to become steady. The default is the register reset value; in the
Continuous mode used by this driver the comparator is always powered,
so sampling at every AON_CLK cycle is functional, but a non-zero value
adds settling margin between samples.

Default value: 0

Value range: 0 to 65535

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 “nxp,lpacmp” compatible.

Name

Type

Details

reg

array

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.

interrupts

array

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.

clocks

phandle-array

Entry 0 is required and is the AON clock the sampling counter runs on. It
must resolve to a node carrying a clock-frequency property: the driver
reads that frequency to derive how long a fresh sample takes, and waits
that long whenever it resamples the comparator output.

Entry 1 is optional and is the peripheral clock gate, reached through
syscon. Where the SoC gates the block (on MCXL255 the CGU
PER_CLK_EN[COMP_CLK_EN] gate resets to disabled) this entry has to be
present, or no register in the block responds. Where the block has no
separate gate, leave it out.

This property is required.

clock-names

string-array

Optional names for the clocks entries, for readability. When present, use
"aon-clk" for the sampling clock and "gate" for the peripheral clock gate.
The driver addresses both entries by index, so the names are
documentation only.

status

string

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: okay, disabled, reserved, fail, fail-sss

See Important properties for more information.

compatible

string-array

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.

reg-names

string-array

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"

ranges

compound

Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").

The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).

If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.

If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.

For details, see "2.3.8 ranges" in Devicetree Specification v0.4.

interrupts-extended

compound

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.

interrupt-names

string-array

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.

interrupt-parent

phandle

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.

label

string

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.

#address-cells

int

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.

#size-cells

int

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.

dma-coherent

boolean

Indicates that the device is capable of coherent DMA operations.

For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.

dmas

phandle-array

DMA channel specifiers relevant to the device.

dma-names

string-array

Optional names given to the DMA channel specifiers in the "dmas" property.

dma-ranges

compound

The dma-ranges provides a means of defining a mapping or translation between the
physical address space of the bus and the physical address space of the parent of the bus.

For details, see "2.3.9 dma-ranges" in Devicetree Specification v0.4.

io-channels

phandle-array

IO channel specifiers relevant to the device.

io-channel-names

string-array

Optional names given to the IO channel specifiers in the "io-channels" property.

mboxes

phandle-array

Mailbox / IPM channel specifiers relevant to the device.

mbox-names

string-array

Optional names given to the mbox specifiers in the "mboxes" property.

power-domains

phandle-array

Power domain specifiers relevant to the device.

power-domain-names

string-array

Optional names given to the power domain specifiers in the "power-domains" property.

#power-domain-cells

int

Number of cells in power-domains property

hwlocks

phandle-array

HW spinlock id relevant to the device.

hwlock-names

string-array

Optional names given to the hwlock specifiers in the "hwlocks" property.

zephyr,deferred-init

boolean

Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

wakeup-source

boolean

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.

zephyr,pm-device-runtime-auto

boolean

Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

List of power states that will disable this device power.