st,stm32-tsc

Note

An implementation of a driver matching this compatible is available in drivers/input/input_tsc_keys.c.

Description

STM32 Tocuh Sensing Controller (TSC) driver

Properties

Top level properties

These property descriptions apply to “st,stm32-tsc” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name	Type	Details
`resets`	`phandle-array`	Reset information This property is required.
`pinctrl-0`	`phandles`	Pin configuration/s for the first state. Content is specific to the selected pin controller driver implementation. This property is required.
`pinctrl-names`	`string-array`	Names for the provided states. The number of names needs to match the number of states. This property is required.
`st,pulse-generator-prescaler`	`int`	Prescaler for the pulse generator clock (t_pgclk=f_hclk/prescaler). The prescaler is used to generate the charge transfer pulse. The final prescaled value is 2^N where N is the value of this property. This property is required. Legal values: `1`, `2`, `4`, `8`, `16`, `32`, `64`, `128`
`st,charge-transfer-pulse-high`	`int`	Number of cycles for the high state of the charge transfer pulse (1 to 16 cycles of t_pgclk). This property is required. Legal values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`st,charge-transfer-pulse-low`	`int`	Number of cycles for the low state of the charge transfer pulse (1 to 16 cycles of t_pgclk). This property is required. Legal values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`st,spread-spectrum`	`boolean`	Spread spectrum enable
`st,spread-spectrum-prescaler`	`int`	Spread spectrum clock prescaler (t_ssclk) This property is required. Legal values: `1`, `2`
`st,spread-spectrum-deviation`	`int`	Spread spectrum deviation (1 to 128 cycles of t_ssclk) This property is required.
`st,max-count-value`	`int`	Max number of charge transfer pulses before max count error is generated. The value of the counter is calculated as 256 * 2^max_count_value. This property is required. Legal values: `255`, `511`, `1023`, `2047`, `4095`, `8191`, `16383`, `32767`
`st,synced-acquisition`	`boolean`	Synchronized acquisition enable. Acquisition starts when START bit and signal on sync pin. You have to provide a pinctrl for the sync pin.
`st,syncpol-rising`	`boolean`	Rising synchronization pin polarity, instead of falling
`st,iodef-float`	`boolean`	Set default state (not acqusition) of all channel I/Os to floating. push-pull down by default.
`pinctrl-1`	`phandles`	Pin configuration/s for the second state. See pinctrl-0.
`pinctrl-2`	`phandles`	Pin configuration/s for the third state. See pinctrl-0.
`pinctrl-3`	`phandles`	Pin configuration/s for the fourth state. See pinctrl-0.
`pinctrl-4`	`phandles`	Pin configuration/s for the fifth state. See pinctrl-0.
`reset-names`	`string-array`	Name of each reset

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 “st,stm32-tsc” 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.
`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 This property is required.
`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.
`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: `'ok'`, `'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"
`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.
`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
`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.

Child node properties

Name	Type	Details
`group`	`int`	Group number (0 to 7) This property is required. Legal values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`
`channel-ios`	`int`	Channel I/Os to be enabled This property is required. Legal values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`
`sampling-io`	`int`	Channel to be selected for sampling This property is required. Legal values: `1`, `2`, `4`, `8`
`st,use-as-shield`	`boolean`	Use channel as shield. This configures group but does not enable it for acqusition. channel-io is used as shield pin and can only have values 1, 2, 4 or 8.