microchip,sam-d5x-e5x-dfll

Description

SAM_D5x_E5x Internal Oscillator (OSC48M)

Digital Frequency-Locked Loop (DFLL48M) configuration.

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

dfll-on-demand-en

int

0: The oscillator is always on
1: The oscillator is running when a peripheral is requesting the oscillator to be used as a
clock source. The oscillator is not running if no peripheral is requesting the clock source.
Important: Initializing it with 1, along with clock enabled, can lead to indefinite wait for
the clock to be on, if there is no peripheral request for the clock in the sequence of clock
Initialization. If required, better to turn on the clock using API, instead of enabling both
during startup.

Legal values: 0, 1

dfll-run-in-standby-en

int

0: The DFLL is not running in standby sleep mode if no peripheral requests the clock.
1: The DFLL is running in standby sleep mode.
If ONDEMAND is one, the DFLL will be running when a peripheral is requesting the clock. If
ONDEMAND is false, the clock source will always be running in standby sleep mode.

Legal values: 0, 1

dfll-en

int

Oscillator Enable
0: to disable, 1: to enable

Default value: 1

Legal values: 0, 1

dfll-wait-lock-en

int

If enabled, clock available only after DFLL is locked (Fine lock)
0: to disable, 1: to enable

Legal values: 0, 1

dfll-bypass-coarse-lock-en

int

To bypass coarse lock procedure
0: to disable, 1: to enable

Legal values: 0, 1

dfll-quick-lock-dis

int

Disable quick lock
1: to disable, 0: to enable

Legal values: 0, 1

dfll-chill-cycle-dis

int

Disable chill cycle
1: to disable, 0: to enable

The time from selecting a new CLK_DFLL48M frequency until this frequency is output
by the DFLL48M can be up to several microseconds. If the value of dfll-multiply-factor
is small, this can lead to instability in the DFLL48M locking mechanism, which can prevent
the DFLL48M from achieving locks. To avoid this, a chill cycle, during which the CLK_DFLL48M
frequency is not measured, can be enabled. Enabling chill cycles might double the lock time.

Legal values: 0, 1

dfll-usb-recovery-en

int

Enable USB Clock Recovery Mode
0: to disable, 1: to enable

Legal values: 0, 1

dfll-lose-lock-en

int

If enabled, locks will be lost after waking up from sleep modes,
if the DFLL clock has been stopped
0: Locks will not be lost after waking up from sleep modes
1: Locks will be lost after waking up from sleep modes

Legal values: 0, 1

dfll-stable-freq-en

int

0: FINE calibration tracks changes in output frequency.
1: FINE calibration register value will be fixed after a fine lock.

Legal values: 0, 1

dfll-closed-loop-en

int

0: The DFLL operates in open-loop operation.
1: The DFLL operates in closed-loop operation.

Legal values: 0, 1

dfll-coarse-max-step

int

Indicates the maximum step size allowed during coarse adjustment in closed-loop mode (0 - 31)

dfll-fine-max-step

int

Indicates the maximum step size allowed during fine adjustment in closed-loop mode (0 - 255)

dfll-multiply-factor

int

Determines the ratio of the CLK_DFLL output frequency to the CLK_DFLL_REF input frequency (0
- 65535)

dfll-src-gclk

string

Reference source clock selection from gclk generator

Default value: gclk0

Legal values: 'gclk0', 'gclk1', 'gclk2', 'gclk3', 'gclk4', 'gclk5', 'gclk6', 'gclk7', 'gclk8', 'gclk9', 'gclk10', 'gclk11'

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 “microchip,sam-d5x-e5x-dfll” compatible.

Name

Type

Details

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

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.

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"

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.

See Important properties for more information.

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.

clocks

phandle-array

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

clock-names

string-array

Optional names given to each clock provider in the "clocks" property.

#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.

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.

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.