atmel,sam-pmc

Note

An implementation of a driver matching this compatible is available in drivers/clock_control/clock_control_sam_pmc.c.

Description

Atmel Power Management Controller (PMC)

The Power Management Controller (PMC) optimizes power consumption by
controlling all system and user peripheral clocks. The PMC enables/disables
the clock inputs to many of the peripherals and the processor.

To specify the clocks in a peripheral, the standard clocks property needs
to be used, e.g.:

  uart: uart@xxx {
    ...
    clocks = <&pmc PMC_TYPE_PERIPHERAL p-id>;
    ...
  };

In this example the clock-type was defined as PMC_TYPE_PERIPHERAL and the
peripheral-id was defined as p-id. The p-id number should be consulted on
datasheet, usually it is available at Product Mapping figure.

NOTE: The predefined clock type cell is defined at
include/zephyr/drivers/clock_clontrol/atmel_sam_pmc.h header file.

The clock-type constants are:
  PMC_TYPE_CORE
  PMC_TYPE_SYSTEM
  PMC_TYPE_PERIPHERAL
  PMC_TYPE_GCK
  PMC_TYPE_PROGRAMMABLE

Properties

Properties not inherited from the base binding file.

Name

Type

Details

#clock-cells

int

from common clock binding; shall be set to 2. The first entry is the type
of the clock (core, system, peripheral or generated) and the second entry
it's the peripheral identification index as provided by the datasheet.

This property is required.

Constant value: 2

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 “atmel,sam-pmc” compatible.

Name	Type	Details
`reg`	`array`	register space This property is required. See Important properties for more information.
`status`	`string`	indicates the operational status of a device Legal values: `'ok'`, `'okay'`, `'disabled'`, `'reserved'`, `'fail'`, `'fail-sss'` See Important properties for more information.
`compatible`	`string-array`	compatible strings This property is required. See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device See Important properties for more information.
`interrupts-extended`	`compound`	extended interrupt specifier for device
`interrupt-names`	`string-array`	name of each interrupt
`interrupt-parent`	`phandle`	phandle to interrupt controller node
`label`	`string`	No description provided for this label See Important properties for more information.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property
`#size-cells`	`int`	number of size cells in reg property
`dmas`	`phandle-array`	DMA channels specifiers
`dma-names`	`string-array`	Provided names of DMA channel specifiers
`io-channels`	`phandle-array`	IO channels specifiers
`io-channel-names`	`string-array`	Provided names of IO channel specifiers
`mboxes`	`phandle-array`	mailbox / IPM channels specifiers
`mbox-names`	`string-array`	Provided names of mailbox / IPM channel specifiers
`power-domains`	`phandle-array`	Power domain specifiers
`power-domain-names`	`string-array`	Provided names of power domain specifiers
`#power-domain-cells`	`int`	Number of cells in power-domains 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.

Specifier cell names

clock cells: clock-type, peripheral-id