[deliverable/linux.git] / Documentation / devicetree / bindings / i2c / i2c-st.txt

ST SSC binding, for I2C mode operation

Required properties :
- compatible : Must be "st,comms-ssc-i2c" or "st,comms-ssc4-i2c"
- reg : Offset and length of the register set for the device
- interrupts : the interrupt specifier
- clock-names: Must contain "ssc".
- clocks: Must contain an entry for each name in clock-names. See the common
  clock bindings.
- A pinctrl state named "default" must be defined to set pins in mode of
  operation for I2C transfer.

Optional properties :
- clock-frequency : Desired I2C bus clock frequency in Hz. If not specified,
  the default 100 kHz frequency will be used. As only Normal and Fast modes
  are supported, possible values are 100000 and 400000.
- st,i2c-min-scl-pulse-width-us : The minimum valid SCL pulse width that is
  allowed through the deglitch circuit. In units of us.
- st,i2c-min-sda-pulse-width-us : The minimum valid SDA pulse width that is
  allowed through the deglitch circuit. In units of us.
- A pinctrl state named "idle" could be defined to set pins in idle state
  when I2C instance is not performing a transfer.
- A pinctrl state named "sleep" could be defined to set pins in sleep state
  when driver enters in suspend.


Example :

i2c0: i2c@fed40000 {
	compatible	= "st,comms-ssc4-i2c";
	reg		= <0xfed40000 0x110>;
	interrupts	=  <GIC_SPI 187 IRQ_TYPE_LEVEL_HIGH>;
	clocks		= <&clk_s_a0_ls CLK_ICN_REG>;
	clock-names	= "ssc";
	clock-frequency = <400000>;
	pinctrl-names	= "default";
	pinctrl-0	= <&pinctrl_i2c0_default>;
	st,i2c-min-scl-pulse-width-us = <0>;
	st,i2c-min-sda-pulse-width-us = <5>;
};
Commit	Line	Data
85b4fab2 MC	1	ST SSC binding, for I2C mode operation
	2
	3	Required properties :
	4	- compatible : Must be "st,comms-ssc-i2c" or "st,comms-ssc4-i2c"
	5	- reg : Offset and length of the register set for the device
	6	- interrupts : the interrupt specifier
	7	- clock-names: Must contain "ssc".
	8	- clocks: Must contain an entry for each name in clock-names. See the common
	9	clock bindings.
	10	- A pinctrl state named "default" must be defined to set pins in mode of
	11	operation for I2C transfer.
	12
	13	Optional properties :
	14	- clock-frequency : Desired I2C bus clock frequency in Hz. If not specified,
	15	the default 100 kHz frequency will be used. As only Normal and Fast modes
	16	are supported, possible values are 100000 and 400000.
	17	- st,i2c-min-scl-pulse-width-us : The minimum valid SCL pulse width that is
	18	allowed through the deglitch circuit. In units of us.
	19	- st,i2c-min-sda-pulse-width-us : The minimum valid SDA pulse width that is
	20	allowed through the deglitch circuit. In units of us.
	21	- A pinctrl state named "idle" could be defined to set pins in idle state
	22	when I2C instance is not performing a transfer.
	23	- A pinctrl state named "sleep" could be defined to set pins in sleep state
	24	when driver enters in suspend.
	25
	26
	27
	28	Example :
	29
	30	i2c0: i2c@fed40000 {
	31	compatible = "st,comms-ssc4-i2c";
	32	reg = <0xfed40000 0x110>;
	33	interrupts = <GIC_SPI 187 IRQ_TYPE_LEVEL_HIGH>;
8edba330	34	clocks = <&clk_s_a0_ls CLK_ICN_REG>;
85b4fab2 MC	35	clock-names = "ssc";
	36	clock-frequency = <400000>;
	37	pinctrl-names = "default";
	38	pinctrl-0 = <&pinctrl_i2c0_default>;
	39	st,i2c-min-scl-pulse-width-us = <0>;
	40	st,i2c-min-sda-pulse-width-us = <5>;
	41	};