nordic,nrf-twis

Description

These nodes are “i2c” bus nodes.

Nordic nRF family TWIS (TWI slave with EasyDMA).

Note: for Zephyr users, the I2C slave API is not available for
these devices. See this issue for more details and a HAL-based
workaround:

    https://github.com/zephyrproject-rtos/zephyr/issues/21445

This binding can be used for nodes which can represent TWIS
peripherals. A single SoC peripheral ID is often associated with
multiple I2C peripherals, like a TWIM and a TWIS. You can choose
TWIS by setting the node's "compatible" to "nordic,nrf-twis"
and its "status" to "okay", e.g. using an overlay file like this:

    /* This is for TWIS0 -- change to "i2c1" for TWIS1, etc. */
    &i2c0 {
            compatible = "nordic,nrf-twis";
            status = "okay";
            /* other property settings can go here */
    };

This works on any supported SoC, for all TWIS instances.

Properties

Properties not inherited from the base binding file.

Name	Type	Details
`clock-frequency`	`int`	Initial clock frequency in Hz
`sq-size`	`int`	Size of the submission queue for blocking requests Default value: `4`
`cq-size`	`int`	Size of the completion queue for blocking requests Default value: `4`
`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-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.
`pinctrl-names`	`string-array`	Names for the provided states. The number of names needs to match the number of states.
`easydma-maxcnt-bits`	`int`	Maximum number of bits available in the EasyDMA MAXCNT register. This property must be set at SoC level DTS files. This property is required.
`memory-regions`	`phandle-array`	List of memory region phandles
`memory-region-names`	`string-array`	A list of names, one for each corresponding phandle in memory-region
`address-0`	`int`	TWI slave address 0
`address-1`	`int`	TWI slave address 1

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 “nordic,nrf-twis” compatible.

Name	Type	Details
`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.
`power-domain`	`phandle`	Power domain the device belongs to. The device will be notified when the power domain it belongs to is either suspended or resumed.
`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.
`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`	`array`	register space This property is required. See Important properties for more information.
`reg-names`	`string-array`	name of each register space
`interrupts`	`array`	interrupts for device This property is required. 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`	Human readable string describing the device (used as device_get_binding() argument) See Important properties for more information. This property is deprecated.
`clocks`	`phandle-array`	Clock gate information
`clock-names`	`string-array`	name of each clock
`#address-cells`	`int`	number of address cells in reg property This property is required. Constant value: `1`
`#size-cells`	`int`	number of size cells in reg property This property is required.
`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
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().