If you need urgent consulting help click here

nordic,nrf-twim

Vendor: Nordic Semiconductor

Description

These nodes are “i2c” bus nodes.

Nordic nRF family TWIM (TWI master with EasyDMA).

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

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

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

Note: on nRF51 SoCs, use the "nordic,nrf-twi" binding instead.

Properties

Node specific properties

Deprecated node specific properties

Base properties

Properties not inherited from the base binding file.

Name	Type	Details
zephyr,concat-buf-size	int	Size of a concatenation buffer that the driver is to use for merging multiple same direction I2C messages that have no RESTART or STOP flag between them (see e.g. the i2c_burst_write() function) into one transfer on the bus. This property must be provided when interacting with devices like the SSD1306 display that cannot tolerate a repeated start and address appearing on the bus between message fragments. For many devices a concatenation buffer is not necessary. Default value: 16
zephyr,flash-buf-max-size	int	TWIM peripherals cannot perform write transactions from buffers located in flash. If such buffers are expected to be used with a given instance of the TWIM peripheral, this property must be set to the maximum possible size of those buffers, so that the driver can reserve enough space in RAM to copy there the contents of particular buffers before requesting the actual transfers. If this property is not set to a value adequate for a given application, write transactions may fail for buffers that are located in flash, what in turn may cause certain components, like the DPS310 sensor driver, to not work. It is recommended to use the same value for this property and for the zephyr,concat-buf-size one, as both these buffering mechanisms can utilize the same space in RAM. Default value: 16
sda-pin	int	IMPORTANT: This option will only be used if the new pin control driver is not enabled. It will be deprecated in the future. The SDA pin to use. For pins P0.0 through P0.31, use the pin number. For example, to use P0.16 for SDA, set: sda-pin = <16>; For pins P1.0 through P1.31, add 32 to the pin number. For example, to use P1.2 for SDA, set: sda-pin = <34>; /* 32 + 2 */
scl-pin	int	IMPORTANT: This option will only be used if the new pin control driver is not enabled. It will be deprecated in the future. The SCL pin to use. The pin numbering scheme is the same as the sda-pin property's.
clock-frequency	int	Initial clock frequency in Hz
pinctrl-0	phandles	Pin configuration/s for the first state. Content is specific to the selected pin controller driver implementation.
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.

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

Name	Type	Details
reg	array	register space This property is required. See Important properties for more information.
interrupts	array	interrupts for device This property is required. See Important properties for more information.
#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.
label	string	Human readable string describing the device (used as device_get_binding() argument) 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-extended	compound	extended interrupt specifier for device
interrupt-names	string-array	name of each interrupt
interrupt-parent	phandle	phandle to interrupt controller node
clocks	phandle-array	Clock gate information
clock-names	string-array	name of each clock
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
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.