diff options
Diffstat (limited to 'zephyr/shim/include/i2c/i2c.h')
| -rw-r--r-- | zephyr/shim/include/i2c/i2c.h | 184 |
1 files changed, 159 insertions, 25 deletions
diff --git a/zephyr/shim/include/i2c/i2c.h b/zephyr/shim/include/i2c/i2c.h index c7e29e79e5..3e95fbc9d3 100644 --- a/zephyr/shim/include/i2c/i2c.h +++ b/zephyr/shim/include/i2c/i2c.h @@ -1,4 +1,4 @@ -/* Copyright 2020 The Chromium OS Authors. All rights reserved. +/* Copyright 2020 The ChromiumOS Authors * Use of this source code is governed by a BSD-style license that can be * found in the LICENSE file. */ @@ -12,36 +12,170 @@ #ifdef CONFIG_PLATFORM_EC_I2C #if DT_NODE_EXISTS(DT_PATH(named_i2c_ports)) -#define I2C_PORT(id) DT_STRING_UPPER_TOKEN(id, enum_name) -#define I2C_PORT_WITH_COMMA(id) I2C_PORT(id), +#define NPCX_PORT_COMPAT nuvoton_npcx_i2c_port +#define ITE_IT8XXX2_PORT_COMPAT ite_it8xxx2_i2c +#define ITE_ENHANCE_PORT_COMPAT ite_enhance_i2c +#define MICROCHIP_XEC_COMPAT microchip_xec_i2c_v2 +#define I2C_EMUL_COMPAT zephyr_i2c_emul_controller +#define I2C_FOREACH_PORT(fn) \ + DT_FOREACH_STATUS_OKAY(NPCX_PORT_COMPAT, fn) \ + DT_FOREACH_STATUS_OKAY(ITE_IT8XXX2_PORT_COMPAT, fn) \ + DT_FOREACH_STATUS_OKAY(ITE_ENHANCE_PORT_COMPAT, fn) \ + DT_FOREACH_STATUS_OKAY(MICROCHIP_XEC_COMPAT, fn) \ + DT_FOREACH_STATUS_OKAY(I2C_EMUL_COMPAT, fn) +/* + * Get the legacy I2C port enum value from the I2C bus node identifier. + * The value returned by this macro is passed as the 'int port' parameter to all + * the legacy APIs provided by i2c_controller.h + * + * Example devicetree fragment: + * + * / { + * soc-if { + * i2c2_0: io_i2c_ctrl2_port0 { + * compatible = "nuvoton,npcx-i2c-port"; + * #address-cells = <1>; + * #size-cells = <0>; + * port = <0x20>; + * controller = <&i2c_ctrl2>; + * label = "I2C_2_PORT_0"; + * status = "disabled"; + * }; + * }. + * }; + * + * Example usage to get the I2C port enum value for i2c2_0: + * + * I2C_PORT_BUS(DT_NODELABEL(i2c2_0)) + * // I2C_BUS_DT_N_S_soc_if_S_io_i2c_ctrl2_port0 + * + * @param i2c_port_id: node id of a I2C port device + */ +#define I2C_PORT_BUS(i2c_port_id) DT_CAT(I2C_BUS_, i2c_port_id) +#define I2C_PORT_BUS_WITH_COMMA(i2c_port_id) I2C_PORT_BUS(i2c_port_id), + +/* + * Get the legacy I2C port enum value from a named-i2c-ports child node. + * + * Example devicetree fragment: + * + * i2c0_0: io_i2c_ctrl0_port0 { + * compatible = "nuvoton,npcx-i2c-port"; + * #address-cells = <1>; + * #size-cells = <0>; + * port = <0x00>; + * controller = <&i2c_ctrl0>; + * label = "I2C_0_PORT_0"; + * status = "disabled"; + * }; + * + * named-i2c-ports { + * compatible = "named-i2c-ports"; + * i2c_sensor: sensor { + * i2c-port = <&i2c0_0>; + * enum-names = "I2C_PORT_SENSOR"; + * }; + * }; + * + * Example usage to get the I2C port enum value for i2c_sensor: + * + * I2C_PORT(DT_NODELABEL(i2c_sensor)) + * + * which equals: + * + * I2C_PORT_BUS(DT_NODELABEL(i2c0_0)) + * + * @param i2c_named_id: node id of a child of the named-i2c-ports node + */ +#define I2C_PORT(i2c_named_id) I2C_PORT_BUS(DT_PHANDLE(i2c_named_id, i2c_port)) + +/* + * Get the legacy I2C port enum from the I2C bus nodelabel. This macro should be + * used with the I2C port device node, not the named-i2c-port child node. + * + * / { + * soc-if { + * i2c2_0: io_i2c_ctrl2_port0 { + * compatible = "nuvoton,npcx-i2c-port"; + * #address-cells = <1>; + * #size-cells = <0>; + * port = <0x20>; + * controller = <&i2c_ctrl2>; + * label = "I2C_2_PORT_0"; + * status = "disabled"; + * }; + * }. + * }; + * + * Example usage to get the I2C port enum value for i2c2_0: + * + * I2C_PORT_NODELABEL(i2c2_0) + * // I2C_BUS_DT_N_S_soc_if_S_io_i2c_ctrl2_port0 + * + * @param label: nodelabel of a I2C port device + */ +#define I2C_PORT_NODELABEL(label) I2C_PORT_BUS(DT_NODELABEL(label)) + +/* + * Get the legacy I2C port enum for a child device on an I2C bus. + * + * Example devicetree fragment: + * + * i2c2_0: io_i2c_ctrl2_port0 { + * compatible = "nuvoton,npcx-i2c-port"; + * #address-cells = <1>; + * #size-cells = <0>; + * port = <0x20>; + * controller = <&i2c_ctrl2>; + * label = "I2C_2_PORT_0"; + * status = "disabled"; + * }; + * + * &i2c2_0 { + * bc12_port0: pi3usb9201@5f { + * compatible = "pericom,pi3usb9201"; + * status = "okay"; + * reg = <0x5f>; + * irq = <&int_usb_c0_bc12>; + * }; + * }; + * + * Example usage to get the I2C port enum value for bc12_port0: + * + * I2C_PORT_BY_DEV(DT_NODELABEL(bc12_port0)) + * + * * which equals: + * + * I2C_PORT_BUS(DT_NODELABEL(i2c2_0)) + * + * @param dev_id: node id of a device on the I2C bus + */ +#define I2C_PORT_BY_DEV(dev_id) I2C_PORT_BUS(DT_BUS(dev_id)) + +enum i2c_ports_chip { + I2C_FOREACH_PORT(I2C_PORT_BUS_WITH_COMMA) I2C_PORT_COUNT +}; + +BUILD_ASSERT(I2C_PORT_COUNT != 0, "No I2C devices defined"); + +#define I2C_PORT_ENUM_IDX_COMMA(i2c_named_id, prop, idx) \ + DT_STRING_UPPER_TOKEN_BY_IDX(i2c_named_id, prop, idx) = \ + I2C_PORT(i2c_named_id), +#define NAMED_I2C_PORT_COMMA(i2c_named_id) \ + DT_FOREACH_PROP_ELEM(i2c_named_id, enum_names, I2C_PORT_ENUM_IDX_COMMA) + +/* + * The enum i2c_ports maps the hard-coded I2C port names (such as + * I2C_PORT_BATTERY or I2C_PORT_SENSOR) to the unique port numbers created by + * enum i2c_ports_chip above for every I2C port devicetree node. + */ enum i2c_ports { - DT_FOREACH_CHILD(DT_PATH(named_i2c_ports), I2C_PORT_WITH_COMMA) - I2C_PORT_COUNT + DT_FOREACH_CHILD(DT_PATH(named_i2c_ports), NAMED_I2C_PORT_COMMA) }; -#define NAMED_I2C(name) I2C_PORT(DT_PATH(named_i2c_ports, name)) #endif /* named_i2c_ports */ #endif /* CONFIG_PLATFORM_EC_I2C */ -#ifdef CONFIG_I2C_NPCX -#define I2C_COMPAT nuvoton_npcx_i2c_port -#elif CONFIG_I2C_ITE_IT8XXX2 -#define I2C_COMPAT ite_it8xxx2_i2c -#elif CONFIG_I2C_XEC_V2 -#define I2C_COMPAT microchip_xec_i2c_v2 -#elif CONFIG_I2C_EMUL -#define I2C_COMPAT zephyr_i2c_emul_controller -#else -#error An undefined I2C driver is used. -#endif - -#if defined(CONFIG_I2C_ITE_IT8XXX2) && defined(CONFIG_I2C_ITE_ENHANCE) -#define I2C_DEVICE_COUNT DT_NUM_INST_STATUS_OKAY(ite_it8xxx2_i2c) + \ - DT_NUM_INST_STATUS_OKAY(ite_enhance_i2c) -#else -#define I2C_DEVICE_COUNT DT_NUM_INST_STATUS_OKAY(I2C_COMPAT) -#endif - /** * @brief Adaptation of platform/ec's port IDs which map a port/bus to a device. * |