microchip,tc-g1-pwm
Description
Microchip PWM TC g1 driver.
Microchip PWM TC g1 driver.
This driver is responsible for configuring
and managing the TC peripheral in Microchip microcontrollers for PWM configuration.
The supported devices :
- tc-u2249 (3.0.0)
Example usage in a Device Tree Source (DTS) file:
pwm_led0: pwm_led_0 {
status = "okay";
pwms = <&tc0 1 PWM_MSEC(20) 0>;
};
Explanation:
- 'pwm_led0' is a node representing a device (e.g., an LED) controlled by PWM.
- The 'pwms' property uses the phandle to the PWM controller (here, 'tc0'),
specifies channel 2, sets the PWM period to 20 milliseconds,
and uses a polarity of 0 (normal).
- The order of the 'pwms' arguments matches the 'pwm-cells' definition:
<&controller channel period polarity>
- This allows the device to be driven with a specific PWM configuration using
the Microchip PWM TC driver.
Properties
Node specific properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Number of items to expect in a pwm specifier
This property is required. Constant value: |
|
|
Timer prescaler values.
The prescaler divides the input clock frequency to
achieve the desired timer frequency.
Legal values: |
|
|
This property indicates the maximum available channels in a peripheral instance
This property is required. |
|
|
Maximum bit width supported by the PWM counter.
This property specifies the resolution of the counter. The value provided
in the device tree should reflect the maximum supported by the hardware
instance. It should only be overridden after consulting the relevant family
datasheet to ensure compatibility.
This property is required. Legal values: |
|
|
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.
|
|
|
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.
|
|
|
Names for the provided states. The number of names needs to match the
number of states.
|
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,tc-g1-pwm” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Specifies the base address and size of the register set for the timer counter peripheral.
This property is required. See Important properties for more information. |
|
|
Defines the interrupt lines used by the timer counter peripheral.
This property specifies the interrupt number and priority.
This property is required. See Important properties for more information. |
|
|
Specifies the clock sources and their configurations for the timer counter peripheral.
This property ensures the peripheral is provided with the necessary clock signals.
The following are the clock names applicable to this property.
- mclk
- gclk
- client_mclk : This is the clock subsystem of the client with
which the instance can be paired. This is an optional clock name.
It is only applicable to those peripherals which can be paired with another
instance for achieving a higher max bit width. In this particular case,
32-bit max-bit-width is attained by pairing two such instances. The ability for
an instance to pair with another instance attain higher max-bit-width will be
specified in their respective datasheets.It is not available for all the instances.
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.
|
|
|
DMA channel specifiers relevant to the device.
|
|
|
Optional names given to the DMA channel specifiers in the "dmas" property.
|
|
|
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.
|
Specifier cell names
pwm cells: channel, period, polarity