microchip,ptc-controller
Description
Microchip Peripheral Touch Controller
Microchip Peripheral Touch Driver
Base binding for Microchip Peripheral Touch Controller.
This defines common properties shared across all PTC versions.
- module name="PTC"
Properties
Top level properties
These property descriptions apply to “microchip,ptc-controller” nodes themselves. This page also describes child node properties in the following sections.
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
|
|
|
Measurement Period
Measurement period is the total time required to acquire (including oversampling)
and process touch signals of all active buttons.
By default, the system has been configured with a measurement period of 20 milliseconds
Default value: |
|
|
PTC Calibration Option
Set sensor calibration mode for charge share delay, Prescaler or series resistor.
By default, the system has been configured with a calibration option of CAL_AUTO_TUNE_NONE
Default value: Legal values: |
|
|
PTC Tau Target
Calibration option to ensure full charge transfer.
Legal values: |
|
|
Startup Acquisition Frequency
By default, the system has been configured with a Startup frequency of FREQ_SEL_0
Default value: Legal values: |
|
|
Define Number Of Channels
Defines the number of sensor nodes in the acquisition set
By default, the system has been configured with a value of 1
Default value: |
|
|
Define Number Of Key Sensors
Defines the number of sensor nodes in the key module
By default, the system has been configured with a value of 1
Default value: |
|
|
Detect Integration
De-bounce counter for additional measurements to confirm touch detection
By default, the system has been configured with a value of 4
Default value: |
|
|
Anti-touch Detect Integration
De-bounce counter for additional measurements to confirm away from touch signal
to initiate Away from touch re-calibration
By default, the system has been configured with a value of 5
Default value: |
|
|
Anti-touch Recalibration Threshold
Threshold beyond with automatic sensor recalibration is initiated.
List of available values
+===================+================================+
| Type | Description |
+===================+================================+
| RECAL_100 | 100% of the threshold value |
+-------------------+--------------------------------+
| RECAL_50 | 50% of the threshold value |
+-------------------+--------------------------------+
| RECAL_25 | 25% of the threshold value |
+-------------------+--------------------------------+
| RECAL_12_5 | 12.5% of the threshold value |
+-------------------+--------------------------------+
| RECAL_6_25 | 6.25% of the threshold value |
+-------------------+--------------------------------+
| MAX_RECAL | - |
+-------------------+--------------------------------+
By default, the system has been configured with a value of RECAL_100
Default value: Legal values: |
|
|
Touch Drift Rate
Rate at which sensor reference value is adjusted towards sensor signal value
when signal value is greater than reference.
Basetime is 200ms
Formula to compute the drift period
--------------------
| value x Basetime |
--------------------
By default, the system has been configured with a value of 20
which means 20 x 200ms = 4 seconds
Default value: |
|
|
Anti-touch Drift Rate
Rate at which sensor reference value is adjusted towards sensor signal value
when signal value is less than reference.
Basetime is 200ms
Formula to compute the anti-touch drift period
--------------------
| value x Basetime |
--------------------
By default, the system has been configured with a value of 5
which means 5 x 200ms = 1 second
Default value: |
|
|
Drift Hold Time
Time to restrict drift on all sensor when one or more sensors are activated.
Basetime is 200ms
Formula to compute the drift hold Time
--------------------
| value x Basetime |
--------------------
By default, the system has been configured with a value of 20
which means 20 x 200ms = 4 seconds
Default value: |
|
|
Reburst Mode
Set mode for additional sensor measurements based on touch activity.
List Of Reburst Modes
+===========================+===========================+
| Mode | Description |
+===========================+===========================+
| | Reburst is never set, |
| REBURST_NONE | measurements according to |
| | application schedule |
+---------------------------+---------------------------+
| | Reburst is set, all |
| REBURST_UNRESOLVED | sensors suspended |
| | but those in same AKS |
| | as the target sensor |
+---------------------------+---------------------------+
| REBURST_ALL | Reburst is set, |
| | no sensors are suspended |
+---------------------------+---------------------------+
By default, the system has been configured with a value of REBURST_UNRESOLVED
Default value: Legal values: |
|
|
Max-On Duration
Number of repeat measurements to
confirm anti-touch recalibration required
Basetime is 200ms
Formula to compute the Max-On Duration
--------------------
| value x Basetime |
--------------------
|
|
|
Datastreamer
Add a communication port node to visualize the touch run-time data
using Microchip Data Visualizer Software
|
|
|
Number Of Frequency Steps for Frequency Hop Operation
Default value: |
|
|
Median Filter Frequencies
It is for Frequency Hop Operation.
PTC Sampling Delay Selection
The user must select the frequencies based on the noisy condition.
The frequencies should be selected based on the configured
num-freq-steps value. By default, the system is configured
with a num-freq-steps value of 3; therefore, def-median-filter-frequencies
is defined using the following three frequency values.
By default, the system has been configured with a frequencies of
FREQ_SEL_0, FREQ_SEL_3 and FREQ_SEL_7
Default value: Legal values: |
|
|
Frequency Hop Auto-tune
The frequency hop auto-tune module is the super set of frequency hop module
with additionally providing noise monitoring and tuning the frequency
according to the measured noise factor.
Frequency Hop + Noise monitoring = Frequency Hop Auto-Tune
List of available options
+===========+===========================+
| value | Frequency Hop Auto-tune |
+===========+===========================+
| 0 | DISABLE |
+-----------+---------------------------+
| 1 | ENABLE |
+-----------+---------------------------+
Default value: Legal values: |
|
|
Frequency Hop Auto-tune Max variance
sets the maximum variance for Frequency Hop Auto tune.
Default value: |
|
|
Frequency Hop Auto-tune Count In
sets the Tune in count for Frequency Hop Auto tune.
Default value: |
|
|
Define Number Of scrollers
Defines the number of scrollers (sliders or wheels).
|
|
|
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 properties not inherited from the base binding file.
(None)
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,ptc-controller” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
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. |
|
|
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. |
|
|
Optional names given to each clock provider in the "clocks" property.
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.
This property is required. 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. |
|
|
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.
|
Child node properties
Name |
Type |
Details |
|---|---|---|
|
|
Node X Mask
It could be shield for self-cap measurement (or)
drive line for mutual-cap measurement.
|
|
|
X Mask Names
Define X-Mask Names
|
|
|
Node Y Mask
y-mask is the sensing electrode connected directly to touch sensor.
|
|
|
y-mask names.
|
|
|
Charge Share Delay (CSD)
Number of delay cycles to ensure charging of sensor node capacitances.
|
|
|
Channel Threshold
The Detect Threshold parameter of a sensor defines
how much its Signal must increase above its Reference level
to be qualified as a potential touch event.
|
|
|
Channel Hysteresis
Sensor detection hysteresis value and is expressed
as a percentage of the sensor detection threshold setting.
List of available Channel Hysteresis options
+===================+================================+
| Type | Description |
+===================+================================+
| HYST_50 | 50% of the threshold value |
+-------------------+--------------------------------+
| HYST_25 | 25% of the threshold value |
+-------------------+--------------------------------+
| HYST_12_5 | 12.5% of the threshold value |
+-------------------+--------------------------------+
| HYST_6_25 | 6.25% of the threshold value |
+-------------------+--------------------------------+
| MAX_HYST | |
+-------------------+--------------------------------+
Default value: Legal values: |
|
|
Channel AKS (Adjacent Key Suppression) Group
Grouping of key sensors controlling
simultaneous touch detect
Default value: Legal values: |