| Message ID | 20190723203723.11730-3-luca@lucaceresoli.net (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | TI camera serdes and I2C address translation | expand |
Hi Luca, thanks for keep pushing this series! I hope we can use part of this for the (long time) on-going GMSL work... I hope you will be patient enough to provide (another :) overview of this work during the BoF Wolfram has organized at LPC for the next week. In the meantime I would have some comments after having a read at the series and trying to apply its concept to GMSL On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: > An ATR is a device that looks similar to an i2c-mux: it has an I2C > slave "upstream" port and N master "downstream" ports, and forwards > transactions from upstream to the appropriate downstream port. But is > is different in that the forwarded transaction has a different slave > address. The address used on the upstream bus is called the "alias" > and is (potentially) different from the physical slave address of the > downstream chip. > > Add a helper file (just like i2c-mux.c for a mux or switch) to allow > implementing ATR features in a device driver. The helper takes care or > adapter creation/destruction and translates addresses at each transaction. > > Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> > > --- > > Changes RFCv1 -> RFCv2: > > RFCv1 was implemented inside i2c-mux.c and added yet more complexity > there. RFCv2 creates a new file on its own, i2c-atr.c. Since many ATR > features are not in a MUX and vice versa, the overlapping is low. This was > almost a complete rewrite, but for the records here are the main > differences from the old implementation: I'm not an i2c expert, but this looks very similar to me to an augmented i2c-mux with the following additional features: - automatic selection of the i2c address to use for the children behind the mux - automatic translation of the addresses the logical aliases to the actual physical addresses of the slaves (with the help of the deserializer address translation feature in this case). In the GMSL perspective we have similar needs but limited to the selection of the i2c addresses to assign to the children behind our mux. The maxims's chips work by reprogramming the remote devices and do not support address translations on the deserializer side, unlike what the TI chips do. So I wonder if we could somehow split the here proposed solution in two, one part to perform the address selection, the other one to support address reprogramming. One thing I have noticed is that it's up to the driver using the ATR (the DS90UB954 deserializer in this case) picking into the alias pool and assign aliases. I would have expected this to be a feature of the ATR itself, if you aim to have the i2c-alias-pool as a standard construct. I understand the pool of free aliases 'belongs' to the base board device, but the ATR could be provided with a pointer to it and the routines to select and assign addresses generalized. Is there a reason why you decided otherwise that I'm not seeing? > > - change bus description > - remove I2C_ATR_ARBITRATOR and I2C_ATR_GATE support > - select() optional > - rename i2c_atr_alloc -> i2c_atr_new, add i2c_atr_delete, move to bottom > - lock the ATR, not the adapter or the muxes on the adapter > - remove parent-locked code > - remove I2C_MUX_LOCKED flag, now unused > - remove I2C_ATR_ATR flag (always true) > - translation in i2c_atr_smbus_xfer too > - i2c_atr_map_msgs: don't ignore mapping errors > - always require the "i2c-atr" DT node, no magic > - remove ACPI support > - one algo in the atrc, not one per adapter > - remove unneeded i2c_atr_root_adapter > - ditch force_nr > - don't allocate private user memory, just provide a plain userdata pointer > - consolidate all ops in a single struct, simplify naming > - remove adapters individually, allocate in atrc->adapter[chan_id] > --- > drivers/i2c/Kconfig | 9 + > drivers/i2c/Makefile | 1 + > drivers/i2c/i2c-atr.c | 557 ++++++++++++++++++++++++++++++++++++++++ > include/linux/i2c-atr.h | 82 ++++++ > 4 files changed, 649 insertions(+) > create mode 100644 drivers/i2c/i2c-atr.c > create mode 100644 include/linux/i2c-atr.h > > diff --git a/drivers/i2c/Kconfig b/drivers/i2c/Kconfig > index abedd55a1264..5df088b1d9de 100644 > --- a/drivers/i2c/Kconfig > +++ b/drivers/i2c/Kconfig > @@ -71,6 +71,15 @@ config I2C_MUX > > source "drivers/i2c/muxes/Kconfig" > > +config I2C_ATR > + tristate "I2C Address Translator (ATR) support" > + help > + Enable support for I2C Address Translator (ATR) chips. > + > + An ATR allows accessing multiple I2C busses from a single > + physical bus via address translation instead of bus selection as > + i2c-muxes do. > + > config I2C_HELPER_AUTO > bool "Autoselect pertinent helper modules" > default y > diff --git a/drivers/i2c/Makefile b/drivers/i2c/Makefile > index bed6ba63c983..81849ea393c7 100644 > --- a/drivers/i2c/Makefile > +++ b/drivers/i2c/Makefile > @@ -13,6 +13,7 @@ i2c-core-$(CONFIG_OF) += i2c-core-of.o > obj-$(CONFIG_I2C_SMBUS) += i2c-smbus.o > obj-$(CONFIG_I2C_CHARDEV) += i2c-dev.o > obj-$(CONFIG_I2C_MUX) += i2c-mux.o > +obj-$(CONFIG_I2C_ATR) += i2c-atr.o > obj-y += algos/ busses/ muxes/ > obj-$(CONFIG_I2C_STUB) += i2c-stub.o > obj-$(CONFIG_I2C_SLAVE_EEPROM) += i2c-slave-eeprom.o > diff --git a/drivers/i2c/i2c-atr.c b/drivers/i2c/i2c-atr.c > new file mode 100644 > index 000000000000..2b61c10a8ff6 > --- /dev/null > +++ b/drivers/i2c/i2c-atr.c > @@ -0,0 +1,557 @@ > +// SPDX-License-Identifier: GPL-2.0 > +/** > + * drivers/i2c/i2c-atr.c -- I2C Address Translator > + * > + * Copyright (c) 2019 Luca Ceresoli <luca@lucaceresoli.net> > + * > + * An I2C Address Translator (ATR) is a device with an I2C slave parent > + * ("upstream") port and N I2C master child ("downstream") ports, and > + * forwards transactions from upstream to the appropriate downstream port > + * with a modified slave address. The address used on the parent bus is > + * called the "alias" and is (potentially) different from the physical > + * slave address of the child bus. Address translation is done by the > + * hardware. > + * > + * An ATR looks similar to an i2c-mux except: > + * - the address on the parent and child busses can be different > + * - there is normally no need to select the child port; the alias used on > + * the parent bus implies it > + * > + * The ATR functionality can be provided by a chip with many other > + * features. This file provides a helper to implement an ATR within your > + * driver. > + * > + * The ATR creates a new I2C "child" adapter on each child bus. Adding > + * devices on the child bus ends up in invoking the driver code to select > + * an available alias. Maintaining an appropriate pool of available aliases > + * and picking one for each new device is up to the driver implementer. The > + * ATR maintains an table of currently assigned alias and uses it > to modify > + * all I2C transactions directed to devices on the child buses. > + * > + * A typical example follows. > + * > + * Topology: > + * > + * Slave X @ 0x10 > + * .-----. | > + * .-----. | |---+---- B > + * | CPU |--A--| ATR | > + * `-----' | |---+---- C > + * `-----' | > + * Slave Y @ 0x10 > + * > + * Alias table: > + * > + * Client Alias > + * ------------- > + * X 0x20 > + * Y 0x30 > + * > + * Transaction: > + * > + * - Slave X driver sends a transaction (on adapter B), slave address 0x10 > + * - ATR driver rewrites messages with address 0x20, forwards to adapter A > + * - Physical I2C transaction on bus A, slave address 0x20 > + * - ATR chip propagates transaction on bus B with address translated to 0x10 > + * - Slave X chip replies on bus B > + * - ATR chip forwards reply on bus A > + * - ATR driver rewrites messages with address 0x10 > + * - Slave X driver gets back the msgs[], with reply and address 0x10 > + * If I got you right this implements a three level translation, partly performed by the ATR and partly performed by the deserializer chip. The i2c alias helps the DESR to select the RX port (channel) where to emit a transaction with the alias translated (with the deserializer's own translation mechanism) to the physical address of the slave. Quoting your here above example: CPU --> 0x20 --> DESR Port0 --> 0x10 --> SLAVE CPU --> 0x30 --> DESR Port1 --> 0x10 --> SLAVE Did I get you right? I'm following the DT bindings discussion with Rob and I'm glad your last reply looks very similar to what we have in our proposed GMSL bindings, so I hope the two could somehow converge. Thanks j > + * Usage: > + * > + * 1. In your driver (typically in the probe function) add an ATR by > + * calling i2c_atr_new() passing your attach/detach callbacks > + * 2. When the attach callback is called pick an appropriate alias, > + * configure it in your chip and return the chosen alias in the > + * alias_id parameter > + * 3. When the detach callback is called, deconfigure the alias from > + * your chip and put it back in the pool for later usage > + * > + * Originally based on i2c-mux.c > + */ > + > +#include <linux/i2c.h> > +#include <linux/i2c-atr.h> > +#include <linux/kernel.h> > +#include <linux/module.h> > +#include <linux/mutex.h> > +#include <linux/of.h> > +#include <linux/slab.h> > + > +/** > + * struct i2c_atr_cli2alias_pair - Hold the alias assigned to a client. > + * @node: List node > + * @client: Pointer to the client on the child bus > + * @alias: I2C alias address assigned by the driver. > + * This is the address that will be used to issue I2C transactions > + * on the parent (physical) bus. > + */ > +struct i2c_atr_cli2alias_pair { > + struct list_head node; > + const struct i2c_client *client; > + u16 alias; > +}; > + > +/* > + * Data for each channel (child bus) > + */ > +struct i2c_atr_chan { > + struct i2c_adapter adap; > + struct i2c_atr *atr; > + u32 chan_id; > + > + struct list_head alias_list; > + > + u16 *orig_addrs; > + unsigned int orig_addrs_size; > + struct mutex orig_addrs_lock; /* Lock orig_addrs during xfer */ > +}; > + > +static struct i2c_atr_cli2alias_pair * > +i2c_atr_find_mapping_by_client(struct list_head *list, > + struct i2c_client *client) > +{ > + struct i2c_atr_cli2alias_pair *c2a; > + > + list_for_each_entry(c2a, list, node) { > + if (c2a->client == client) > + return c2a; > + } > + > + return NULL; > +} > + > +static struct i2c_atr_cli2alias_pair * > +i2c_atr_find_mapping_by_addr(struct list_head *list, > + u16 phys_addr) > +{ > + struct i2c_atr_cli2alias_pair *c2a; > + > + list_for_each_entry(c2a, list, node) { > + if (c2a->client->addr == phys_addr) > + return c2a; > + } > + > + return NULL; > +} > + > +/* > + * Replace all message addresses with their aliases, saving the original > + * addresses. > + * > + * This function is internal for use in i2c_atr_master_xfer(). It must be > + * followed by i2c_atr_unmap_msgs() to restore the original addresses. > + */ > +static int i2c_atr_map_msgs(struct i2c_atr_chan *chan, > + struct i2c_msg msgs[], int num) > + > +{ > + struct i2c_atr *atr = chan->atr; > + static struct i2c_atr_cli2alias_pair *c2a; > + int i; > + > + /* Ensure we have enough room to save the original addresses */ > + if (unlikely(chan->orig_addrs_size < num)) { > + void *new_buf = kmalloc(num * sizeof(chan->orig_addrs[0]), > + GFP_KERNEL); > + if (new_buf == NULL) > + return -ENOMEM; > + > + kfree(chan->orig_addrs); > + chan->orig_addrs = new_buf; > + chan->orig_addrs_size = num; > + } > + > + for (i = 0; i < num; i++) { > + chan->orig_addrs[i] = msgs[i].addr; > + > + c2a = i2c_atr_find_mapping_by_addr(&chan->alias_list, > + msgs[i].addr); > + if (c2a) { > + msgs[i].addr = c2a->alias; > + } else { > + dev_err(atr->dev, "client 0x%02x not mapped!\n", > + msgs[i].addr); > + return -ENXIO; > + } > + } > + > + return 0; > +} > + > +/* > + * Restore all message address aliases with the original addresses. > + * > + * This function is internal for use in i2c_atr_master_xfer(). > + * > + * @see i2c_atr_map_msgs() > + */ > +static void i2c_atr_unmap_msgs(struct i2c_atr_chan *chan, > + struct i2c_msg msgs[], int num) > +{ > + int i; > + > + for (i = 0; i < num; i++) > + msgs[i].addr = chan->orig_addrs[i]; > +} > + > +static int i2c_atr_master_xfer(struct i2c_adapter *adap, > + struct i2c_msg msgs[], int num) > +{ > + struct i2c_atr_chan *chan = adap->algo_data; > + struct i2c_atr *atr = chan->atr; > + struct i2c_adapter *parent = atr->parent; > + int ret = 0; > + > + /* Switch to the right atr port */ > + if (atr->ops->select) { > + ret = atr->ops->select(atr, chan->chan_id); > + if (ret < 0) > + goto out; > + } > + > + /* Translate addresses */ > + mutex_lock(&chan->orig_addrs_lock); > + ret = i2c_atr_map_msgs(chan, msgs, num); > + if (ret < 0) { > + mutex_unlock(&chan->orig_addrs_lock); > + goto out; > + } > + > + /* Perform the transfer */ > + ret = i2c_transfer(parent, msgs, num); > + > + /* Restore addresses */ > + i2c_atr_unmap_msgs(chan, msgs, num); > + mutex_unlock(&chan->orig_addrs_lock); > + > +out: > + if (atr->ops->deselect) > + atr->ops->deselect(atr, chan->chan_id); > + > + return ret; > +} > + > +static int i2c_atr_smbus_xfer(struct i2c_adapter *adap, > + u16 addr, unsigned short flags, > + char read_write, u8 command, > + int size, union i2c_smbus_data *data) > +{ > + struct i2c_atr_chan *chan = adap->algo_data; > + struct i2c_atr *atr = chan->atr; > + struct i2c_adapter *parent = atr->parent; > + struct i2c_atr_cli2alias_pair *c2a; > + int err = 0; > + > + c2a = i2c_atr_find_mapping_by_addr(&chan->alias_list, addr); > + if (!c2a) { > + dev_err(atr->dev, "client 0x%02x not mapped!\n", addr); > + return -ENXIO; > + } > + > + if (atr->ops->select) > + err = atr->ops->select(atr, chan->chan_id); > + if (!err) > + err = i2c_smbus_xfer(parent, c2a->alias, flags, > + read_write, command, size, data); > + if (atr->ops->deselect) > + atr->ops->deselect(atr, chan->chan_id); > + > + return err; > +} > + > +static u32 i2c_atr_functionality(struct i2c_adapter *adap) > +{ > + struct i2c_atr_chan *chan = adap->algo_data; > + struct i2c_adapter *parent = chan->atr->parent; > + > + return parent->algo->functionality(parent); > +} > + > +static void i2c_atr_lock_bus(struct i2c_adapter *adapter, unsigned int flags) > +{ > + struct i2c_atr_chan *chan = adapter->algo_data; > + struct i2c_atr *atr = chan->atr; > + > + mutex_lock(&atr->lock); > +} > + > +static int i2c_atr_trylock_bus(struct i2c_adapter *adapter, unsigned int flags) > +{ > + struct i2c_atr_chan *chan = adapter->algo_data; > + struct i2c_atr *atr = chan->atr; > + > + return mutex_trylock(&atr->lock); > +} > + > +static void i2c_atr_unlock_bus(struct i2c_adapter *adapter, unsigned int flags) > +{ > + struct i2c_atr_chan *chan = adapter->algo_data; > + struct i2c_atr *atr = chan->atr; > + > + mutex_unlock(&atr->lock); > +} > + > +static const struct i2c_lock_operations i2c_atr_lock_ops = { > + .lock_bus = i2c_atr_lock_bus, > + .trylock_bus = i2c_atr_trylock_bus, > + .unlock_bus = i2c_atr_unlock_bus, > +}; > + > +static int i2c_atr_attach_client(struct i2c_adapter *adapter, > + const struct i2c_board_info *info, > + const struct i2c_client *client) > +{ > + struct i2c_atr_chan *chan = adapter->algo_data; > + struct i2c_atr *atr = chan->atr; > + struct i2c_atr_cli2alias_pair *c2a; > + u16 alias_id = 0; > + int err = 0; > + > + c2a = kzalloc(sizeof(struct i2c_atr_cli2alias_pair), GFP_KERNEL); > + if (!c2a) { > + err = -ENOMEM; > + goto err_alloc; > + } > + > + err = atr->ops->attach_client(atr, chan->chan_id, info, client, > + &alias_id); > + if (err) > + goto err_attach; > + if (alias_id == 0) { > + err = -EINVAL; > + goto err_attach; > + } > + > + c2a->client = client; > + c2a->alias = alias_id; > + list_add(&c2a->node, &chan->alias_list); > + > + return 0; > + > +err_attach: > + kfree(c2a); > +err_alloc: > + return err; > +} > + > +static void i2c_atr_detach_client(struct i2c_adapter *adapter, > + const struct i2c_client *client) > +{ > + struct i2c_atr_chan *chan = adapter->algo_data; > + struct i2c_atr *atr = chan->atr; > + struct i2c_atr_cli2alias_pair *c2a; > + > + atr->ops->detach_client(atr, chan->chan_id, client); > + > + c2a = i2c_atr_find_mapping_by_client(&chan->alias_list, client); > + if (c2a != NULL) { > + list_del(&c2a->node); > + kfree(c2a); > + } > +} > + > +static const struct i2c_attach_operations i2c_atr_attach_ops = { > + .attach_client = i2c_atr_attach_client, > + .detach_client = i2c_atr_detach_client, > +}; > + > +/** > + * i2c_atr_add_adapter - Create a child ("downstream") I2C bus. > + * @atr: The I2C ATR > + * @chan_id: Index of the new adapter (0 .. max_adapters-1). This value is > + * passed to the callbacks in `struct i2c_atr_ops`. > + * > + * After calling this function a new i2c bus will appear. Adding and > + * removing devices on the downstream bus will result in calls to the > + * `attach_client` and `detach_client` callbacks for the driver to assign > + * an alias to the device. > + * > + * If there is a device tree node under "i2c-atr" whose "reg" property > + * equals chan_id, the new adapter will receive that node and perhaps start > + * adding devices under it. The callbacks for those additions will be made > + * before i2c_atr_add_adapter() returns. > + * > + * Call i2c_atr_del_adapter() to remove the adapter. > + * > + * Return: 0 on success, a negative error code otherwise. > + */ > +int i2c_atr_add_adapter(struct i2c_atr *atr, u32 chan_id) > +{ > + struct i2c_adapter *parent = atr->parent; > + struct device *dev = atr->dev; > + struct i2c_atr_chan *chan; > + char symlink_name[20]; > + int err; > + > + if (chan_id >= atr->max_adapters) > + return -EINVAL; > + > + if (atr->adapter[chan_id]) { > + dev_err(dev, "Adapter %d already present\n", chan_id); > + return -EEXIST; > + } > + > + chan = kzalloc(sizeof(*chan), GFP_KERNEL); > + if (!chan) > + return -ENOMEM; > + > + chan->atr = atr; > + chan->chan_id = chan_id; > + INIT_LIST_HEAD(&chan->alias_list); > + mutex_init(&chan->orig_addrs_lock); > + > + snprintf(chan->adap.name, sizeof(chan->adap.name), > + "i2c-%d-atr-%d", i2c_adapter_id(parent), chan_id); > + chan->adap.owner = THIS_MODULE; > + chan->adap.algo = &atr->algo; > + chan->adap.algo_data = chan; > + chan->adap.dev.parent = dev; > + chan->adap.retries = parent->retries; > + chan->adap.timeout = parent->timeout; > + chan->adap.quirks = parent->quirks; > + chan->adap.lock_ops = &i2c_atr_lock_ops; > + chan->adap.attach_ops = &i2c_atr_attach_ops; > + > + if (dev->of_node) { > + struct device_node *atr_node; > + struct device_node *child; > + u32 reg; > + > + atr_node = of_get_child_by_name(dev->of_node, "i2c-atr"); > + > + for_each_child_of_node(atr_node, child) { > + err = of_property_read_u32(child, "reg", ®); > + if (err) > + continue; > + if (chan_id == reg) > + break; > + } > + > + chan->adap.dev.of_node = child; > + of_node_put(atr_node); > + } > + > + err = i2c_add_adapter(&chan->adap); > + if (err) { > + dev_err(dev, "failed to add atr-adapter %u (error=%d)\n", > + chan_id, err); > + goto err_add_adapter; > + } > + > + WARN(sysfs_create_link(&chan->adap.dev.kobj, &dev->kobj, "atr_device"), > + "can't create symlink to atr device\n"); > + snprintf(symlink_name, sizeof(symlink_name), "channel-%u", chan_id); > + WARN(sysfs_create_link(&dev->kobj, &chan->adap.dev.kobj, symlink_name), > + "can't create symlink for channel %u\n", chan_id); > + > + dev_info(dev, "Added ATR child bus %d\n", i2c_adapter_id(&chan->adap)); > + > + atr->adapter[chan_id] = &chan->adap; > + return 0; > + > +err_add_adapter: > + mutex_destroy(&chan->orig_addrs_lock); > + kfree(chan); > + return err; > +} > +EXPORT_SYMBOL_GPL(i2c_atr_add_adapter); > + > +/** > + * i2c_atr_del_adapter - Remove a child ("downstream") I2C bus added by > + * i2c_atr_del_adapter(). > + * @atr: The I2C ATR > + * @chan_id: Index of the `adapter to be removed (0 .. max_adapters-1) > + */ > +void i2c_atr_del_adapter(struct i2c_atr *atr, u32 chan_id) > +{ > + char symlink_name[20]; > + > + struct i2c_adapter *adap = atr->adapter[chan_id]; > + struct i2c_atr_chan *chan = adap->algo_data; > + struct device_node *np = adap->dev.of_node; > + struct device *dev = atr->dev; > + > + if (atr->adapter[chan_id] == NULL) { > + dev_err(dev, "Adapter %d does not exist\n", chan_id); > + return; > + } > + > + dev_info(dev, "Removing ATR child bus %d\n", i2c_adapter_id(adap)); > + > + atr->adapter[chan_id] = NULL; > + > + snprintf(symlink_name, sizeof(symlink_name), > + "channel-%u", chan->chan_id); > + sysfs_remove_link(&dev->kobj, symlink_name); > + sysfs_remove_link(&chan->adap.dev.kobj, "atr_device"); > + > + i2c_del_adapter(adap); > + of_node_put(np); > + mutex_destroy(&chan->orig_addrs_lock); > + kfree(chan); > +} > +EXPORT_SYMBOL_GPL(i2c_atr_del_adapter); > + > +/** > + * i2c_atr_new() - Allocate and initialize an I2C ATR helper. > + * @parent: The parent (upstream) adapter > + * @dev: The device acting as an ATR > + * @ops: Driver-specific callbacks > + * @max_adapters: Maximum number of child adapters > + * > + * The new ATR helper is connected to the parent adapter but has no child > + * adapters. Call i2c_atr_add_adapter() to add some. > + * > + * Call i2c_atr_delete() to remove. > + * > + * Return: pointer to the new ATR helper object, or ERR_PTR > + */ > +struct i2c_atr *i2c_atr_new(struct i2c_adapter *parent, struct device *dev, > + const struct i2c_atr_ops *ops, int max_adapters) > +{ > + struct i2c_atr *atr; > + > + if (!ops || !ops->attach_client || !ops->detach_client) > + return ERR_PTR(-EINVAL); > + > + atr = devm_kzalloc(dev, sizeof(*atr) > + + max_adapters * sizeof(atr->adapter[0]), > + GFP_KERNEL); > + if (!atr) > + return ERR_PTR(-ENOMEM); > + > + mutex_init(&atr->lock); > + > + atr->parent = parent; > + atr->dev = dev; > + atr->ops = ops; > + atr->max_adapters = max_adapters; > + > + if (parent->algo->master_xfer) > + atr->algo.master_xfer = i2c_atr_master_xfer; > + if (parent->algo->smbus_xfer) > + atr->algo.smbus_xfer = i2c_atr_smbus_xfer; > + atr->algo.functionality = i2c_atr_functionality; > + > + return atr; > +} > +EXPORT_SYMBOL_GPL(i2c_atr_new); > + > +/** > + * i2c_atr_delete - Delete an I2C ATR helper. > + * @atr: I2C ATR helper to be deleted. > + * > + * Precondition: all the adapters added with i2c_atr_add_adapter() mumst be > + * removed by calling i2c_atr_del_adapter(). > + */ > +void i2c_atr_delete(struct i2c_atr *atr) > +{ > + mutex_destroy(&atr->lock); > +} > +EXPORT_SYMBOL_GPL(i2c_atr_delete); > + > +MODULE_AUTHOR("Luca Ceresoli <luca@lucaceresoli.net>"); > +MODULE_DESCRIPTION("I2C Address Translator"); > +MODULE_LICENSE("GPL v2"); > diff --git a/include/linux/i2c-atr.h b/include/linux/i2c-atr.h > new file mode 100644 > index 000000000000..019816e5a50c > --- /dev/null > +++ b/include/linux/i2c-atr.h > @@ -0,0 +1,82 @@ > +/* SPDX-License-Identifier: GPL-2.0 */ > +/** > + * drivers/i2c/i2c-atr.h -- I2C Address Translator > + * > + * Copyright (c) 2019 Luca Ceresoli <luca@lucaceresoli.net> > + * > + * Based on i2c-mux.h > + */ > + > +#ifndef _LINUX_I2C_ATR_H > +#define _LINUX_I2C_ATR_H > + > +#ifdef __KERNEL__ > + > +#include <linux/i2c.h> > +#include <linux/mutex.h> > + > +struct i2c_atr; > + > +/** > + * struct i2c_atr_ops - Callbacks from ATR to the device driver. > + * @select: Ask the driver to select a child bus (optional) > + * @deselect: Ask the driver to deselect a child bus (optional) > + * @attach_client: Notify the driver of a new device connected on a child > + * bus. The driver must choose an I2C alias, configure the > + * hardware to use it and return it in `alias_id`. > + * @detach_client: Notify the driver of a device getting disconnected. The > + * driver must configure the hardware to stop using the > + * alias. > + * > + * All these functions return 0 on success, a negative error code otherwise. > + */ > +struct i2c_atr_ops { > + int (*select)(struct i2c_atr *atr, u32 chan_id); > + int (*deselect)(struct i2c_atr *atr, u32 chan_id); > + int (*attach_client)(struct i2c_atr *atr, u32 chan_id, > + const struct i2c_board_info *info, > + const struct i2c_client *client, > + u16 *alias_id); > + void (*detach_client)(struct i2c_atr *atr, u32 chan_id, > + const struct i2c_client *client); > +}; > + > +/** > + * Helper to add I2C ATR features to a device driver. > + */ > +struct i2c_atr { > + /* private: internal use only */ > + > + struct i2c_adapter *parent; > + struct device *dev; > + const struct i2c_atr_ops *ops; > + > + void *priv; > + > + struct i2c_algorithm algo; > + struct mutex lock; > + int max_adapters; > + > + struct i2c_adapter *adapter[0]; > +}; > + > +struct i2c_atr *i2c_atr_new(struct i2c_adapter *parent, struct device *dev, > + const struct i2c_atr_ops *ops, int max_adapters); > +void i2c_atr_delete(struct i2c_atr *atr); > + > +static inline void i2c_atr_set_clientdata(struct i2c_atr *atr, void *data) > +{ > + atr->priv = data; > +} > + > +static inline void *i2c_atr_get_clientdata(struct i2c_atr *atr) > +{ > + return atr->priv; > +} > + > +int i2c_atr_add_adapter(struct i2c_atr *atr, u32 chan_id); > +void i2c_atr_del_adapter(struct i2c_atr *atr, u32 chan_id); > + > +#endif /* __KERNEL__ */ > + > +#endif /* _LINUX_I2C_ATR_H */ > -- > 2.17.1 >
Hi Luca, > + * Topology: > + * > + * Slave X @ 0x10 > + * .-----. | > + * .-----. | |---+---- B > + * | CPU |--A--| ATR | > + * `-----' | |---+---- C > + * `-----' | > + * Slave Y @ 0x10 > + * > + * Alias table: > + * > + * Client Alias > + * ------------- > + * X 0x20 > + * Y 0x30 Great that you already provided docs for this driver! One huge drawback for me is the attach/detach callbacks. One year ago, I removed a similar callback from the I2C core ("[PATCH 0/2] i2c: remove deprecated attach_adapter callback") because some drivers did a lot of crazy things there. It took years to remove all that. What I could imagine here: the adapter (B and C each in the picture above) gets a flag like NEEDS_ATR before registering to the core. The flag means all clients on that bus will have their address translated. The core will figure out a free alias when a device is registered. We can then have an ATR specific callback with the original and translated address as arguments, so one can setup the HW as needed. Do you think that would work? Jacopo, does that meet GMSL as well? Regards, Wolfram
Hi Jacopo, thanks for your feedback. On 01/09/19 16:31, jacopo mondi wrote: > Hi Luca, > thanks for keep pushing this series! I hope we can use part of this > for the (long time) on-going GMSL work... > > I hope you will be patient enough to provide (another :) overview > of this work during the BoF Wolfram has organized at LPC for the next > week. Sure! > In the meantime I would have some comments after having a read at the > series and trying to apply its concept to GMSL > > On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: >> An ATR is a device that looks similar to an i2c-mux: it has an I2C >> slave "upstream" port and N master "downstream" ports, and forwards >> transactions from upstream to the appropriate downstream port. But is >> is different in that the forwarded transaction has a different slave >> address. The address used on the upstream bus is called the "alias" >> and is (potentially) different from the physical slave address of the >> downstream chip. >> >> Add a helper file (just like i2c-mux.c for a mux or switch) to allow >> implementing ATR features in a device driver. The helper takes care or >> adapter creation/destruction and translates addresses at each transaction. >> >> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >> >> --- >> >> Changes RFCv1 -> RFCv2: >> >> RFCv1 was implemented inside i2c-mux.c and added yet more complexity >> there. RFCv2 creates a new file on its own, i2c-atr.c. Since many ATR >> features are not in a MUX and vice versa, the overlapping is low. This was >> almost a complete rewrite, but for the records here are the main >> differences from the old implementation: > > I'm not an i2c expert, but this looks very similar to me to an > augmented i2c-mux with the following additional features: > - automatic selection of the i2c address to use for the children > behind the mux > - automatic translation of the addresses the logical aliases to > the actual physical addresses of the slaves (with the help of the > deserializer address translation feature in this case). A notable difference in the hardware is that a mux needs an explicit procedure to select a port. That's why the select() op is mandatory for muxes. The ATR, at least in the DS90UB9xx case, selects the port automatically based on the slave address. So I added an optional select() op in the atr, but I suspect it's useless for "real" ATRs. More differences derive from how Linux implements muxes. The i2c-mux code has several flags for different locking schemes, and it has a fairly complex DT parsing scheme. These are mostly a historical burden. Adding the ATR features to i2c-mux.c was very tricky and error-prone due to all of this code, that's why I have moved ATR to its own file in RFCv2. > In the GMSL perspective we have similar needs but limited to the > selection of the i2c addresses to assign to the children behind our > mux. The maxims's chips work by reprogramming the remote devices and > do not support address translations on the deserializer side, unlike > what the TI chips do. Indeed, the Maxim chips implement a simple mux, so it seems like the only commonality with TI is the need for address pool management. > So I wonder if we could somehow split the here proposed solution in > two, one part to perform the address selection, the other one to > support address reprogramming. > > One thing I have noticed is that it's up to the driver using the ATR > (the DS90UB954 deserializer in this case) picking into the alias pool > and assign aliases. I would have expected this to be a feature of the > ATR itself, if you aim to have the i2c-alias-pool as a standard > construct. > > I understand the pool of free aliases 'belongs' to the base board > device, but the ATR could be provided with a pointer to it and the > routines to select and assign addresses generalized. Is there a reason > why you decided otherwise that I'm not seeing? I was about to do it, but changed my mind for a non-strongly-technical reason. The entire body of ds90_atr_attach_client() and ds90_atr_detach_client() is guarded by a mutex to protect the alias pool from concurrent access. I didn't feel comfortable in hoisting the mutex into the ATR code and have all the attach and detach callbacks run with a lock that might be unneeded in specific drivers. At least not with only one driver using i2c-atr. Also, I'm not even sure a mutex is really needed to protect the pool. Is it possible that two client adding/removal operations happen concurrently? SHould they be serialized at the i2c core level, the mutexes would be unneeded. But I haven't dug in the core enough to discover it. Wolfram? However, even though the alias picking code is not that much, I'm OK in moving it into the ATR core if it looks good. Now, I see you thinking "why not moving the ATR code _and_ the alias picking code in i2c-mux and benefit in the GMSL drivers?", and I'm a little uncomfortable about this idea. Not because the idea is bad per se, but because the intricacies of i2c-mux make this quite dreadful. I have had some discussion with Peter Rosin about simplifying i2c-atr, but they didn't show a clear path forward and were slowly abandoned. >> - change bus description >> - remove I2C_ATR_ARBITRATOR and I2C_ATR_GATE support >> - select() optional >> - rename i2c_atr_alloc -> i2c_atr_new, add i2c_atr_delete, move to bottom >> - lock the ATR, not the adapter or the muxes on the adapter >> - remove parent-locked code >> - remove I2C_MUX_LOCKED flag, now unused >> - remove I2C_ATR_ATR flag (always true) >> - translation in i2c_atr_smbus_xfer too >> - i2c_atr_map_msgs: don't ignore mapping errors >> - always require the "i2c-atr" DT node, no magic >> - remove ACPI support >> - one algo in the atrc, not one per adapter >> - remove unneeded i2c_atr_root_adapter >> - ditch force_nr >> - don't allocate private user memory, just provide a plain userdata pointer >> - consolidate all ops in a single struct, simplify naming >> - remove adapters individually, allocate in atrc->adapter[chan_id] >> --- >> drivers/i2c/Kconfig | 9 + >> drivers/i2c/Makefile | 1 + >> drivers/i2c/i2c-atr.c | 557 ++++++++++++++++++++++++++++++++++++++++ >> include/linux/i2c-atr.h | 82 ++++++ >> 4 files changed, 649 insertions(+) >> create mode 100644 drivers/i2c/i2c-atr.c >> create mode 100644 include/linux/i2c-atr.h >> >> diff --git a/drivers/i2c/Kconfig b/drivers/i2c/Kconfig >> index abedd55a1264..5df088b1d9de 100644 >> --- a/drivers/i2c/Kconfig >> +++ b/drivers/i2c/Kconfig >> @@ -71,6 +71,15 @@ config I2C_MUX >> >> source "drivers/i2c/muxes/Kconfig" >> >> +config I2C_ATR >> + tristate "I2C Address Translator (ATR) support" >> + help >> + Enable support for I2C Address Translator (ATR) chips. >> + >> + An ATR allows accessing multiple I2C busses from a single >> + physical bus via address translation instead of bus selection as >> + i2c-muxes do. >> + >> config I2C_HELPER_AUTO >> bool "Autoselect pertinent helper modules" >> default y >> diff --git a/drivers/i2c/Makefile b/drivers/i2c/Makefile >> index bed6ba63c983..81849ea393c7 100644 >> --- a/drivers/i2c/Makefile >> +++ b/drivers/i2c/Makefile >> @@ -13,6 +13,7 @@ i2c-core-$(CONFIG_OF) += i2c-core-of.o >> obj-$(CONFIG_I2C_SMBUS) += i2c-smbus.o >> obj-$(CONFIG_I2C_CHARDEV) += i2c-dev.o >> obj-$(CONFIG_I2C_MUX) += i2c-mux.o >> +obj-$(CONFIG_I2C_ATR) += i2c-atr.o >> obj-y += algos/ busses/ muxes/ >> obj-$(CONFIG_I2C_STUB) += i2c-stub.o >> obj-$(CONFIG_I2C_SLAVE_EEPROM) += i2c-slave-eeprom.o >> diff --git a/drivers/i2c/i2c-atr.c b/drivers/i2c/i2c-atr.c >> new file mode 100644 >> index 000000000000..2b61c10a8ff6 >> --- /dev/null >> +++ b/drivers/i2c/i2c-atr.c >> @@ -0,0 +1,557 @@ >> +// SPDX-License-Identifier: GPL-2.0 >> +/** >> + * drivers/i2c/i2c-atr.c -- I2C Address Translator >> + * >> + * Copyright (c) 2019 Luca Ceresoli <luca@lucaceresoli.net> >> + * >> + * An I2C Address Translator (ATR) is a device with an I2C slave parent >> + * ("upstream") port and N I2C master child ("downstream") ports, and >> + * forwards transactions from upstream to the appropriate downstream port >> + * with a modified slave address. The address used on the parent bus is >> + * called the "alias" and is (potentially) different from the physical >> + * slave address of the child bus. Address translation is done by the >> + * hardware. >> + * >> + * An ATR looks similar to an i2c-mux except: >> + * - the address on the parent and child busses can be different >> + * - there is normally no need to select the child port; the alias used on >> + * the parent bus implies it >> + * >> + * The ATR functionality can be provided by a chip with many other >> + * features. This file provides a helper to implement an ATR within your >> + * driver. >> + * >> + * The ATR creates a new I2C "child" adapter on each child bus. Adding >> + * devices on the child bus ends up in invoking the driver code to select >> + * an available alias. Maintaining an appropriate pool of available aliases >> + * and picking one for each new device is up to the driver implementer. The >> + * ATR maintains an table of currently assigned alias and uses it >> to modify >> + * all I2C transactions directed to devices on the child buses. >> + * >> + * A typical example follows. >> + * >> + * Topology: >> + * >> + * Slave X @ 0x10 >> + * .-----. | >> + * .-----. | |---+---- B >> + * | CPU |--A--| ATR | >> + * `-----' | |---+---- C >> + * `-----' | >> + * Slave Y @ 0x10 >> + * >> + * Alias table: >> + * >> + * Client Alias >> + * ------------- >> + * X 0x20 >> + * Y 0x30 >> + * >> + * Transaction: >> + * >> + * - Slave X driver sends a transaction (on adapter B), slave address 0x10 >> + * - ATR driver rewrites messages with address 0x20, forwards to adapter A >> + * - Physical I2C transaction on bus A, slave address 0x20 >> + * - ATR chip propagates transaction on bus B with address translated to 0x10 >> + * - Slave X chip replies on bus B >> + * - ATR chip forwards reply on bus A >> + * - ATR driver rewrites messages with address 0x10 >> + * - Slave X driver gets back the msgs[], with reply and address 0x10 >> + * > > If I got you right this implements a three level translation, partly > performed by the ATR and partly performed by the deserializer chip. > The i2c alias helps the DESR to select the RX port (channel) where to > emit a transaction with the alias translated (with the deserializer's > own translation mechanism) to the physical address of the slave. > > Quoting your here above example: > > CPU --> 0x20 --> DESR Port0 --> 0x10 --> SLAVE > CPU --> 0x30 --> DESR Port1 --> 0x10 --> SLAVE > > Did I get you right? I would not call it a three level translation, but yes, it is how it works. > I'm following the DT bindings discussion with Rob and I'm glad your > last reply looks very similar to what we have in our proposed GMSL > bindings, so I hope the two could somehow converge. Good. After all Maxim and TI chips have the same topology, so it seems natural that their DT description is similar.
> Adding the ATR features to i2c-mux.c was very tricky and error-prone due > to all of this code, that's why I have moved ATR to its own file in RFCv2. I forgot to say that I like this.
Hi Wolfram, On 02/09/19 22:42, Wolfram Sang wrote: > Hi Luca, > >> + * Topology: >> + * >> + * Slave X @ 0x10 >> + * .-----. | >> + * .-----. | |---+---- B >> + * | CPU |--A--| ATR | >> + * `-----' | |---+---- C >> + * `-----' | >> + * Slave Y @ 0x10 >> + * >> + * Alias table: >> + * >> + * Client Alias >> + * ------------- >> + * X 0x20 >> + * Y 0x30 > > Great that you already provided docs for this driver! > > One huge drawback for me is the attach/detach callbacks. One year ago, I > removed a similar callback from the I2C core ("[PATCH 0/2] i2c: remove > deprecated attach_adapter callback") because some drivers did a lot of > crazy things there. It took years to remove all that. Oh dear, I was completely unaware, apologies! :-) > What I could imagine here: the adapter (B and C each in the picture > above) gets a flag like NEEDS_ATR before registering to the core. The > flag means all clients on that bus will have their address translated. > The core will figure out a free alias when a device is registered. We > can then have an ATR specific callback with the original and translated > address as arguments, so one can setup the HW as needed. Do you mean moving the alias selection code from i2c-atr.c to the i2c core? And the rest of the ATR core too? > Do you think that would work? Yes.
> > One huge drawback for me is the attach/detach callbacks. One year ago, I > > removed a similar callback from the I2C core ("[PATCH 0/2] i2c: remove > > deprecated attach_adapter callback") because some drivers did a lot of > > crazy things there. It took years to remove all that. > > Oh dear, I was completely unaware, apologies! :-) Oh, no need to apologize. You don't have to research the whole I2C history before implementing something. Keeping the big picture is what I happily provide. > > What I could imagine here: the adapter (B and C each in the picture > > above) gets a flag like NEEDS_ATR before registering to the core. The > > flag means all clients on that bus will have their address translated. > > The core will figure out a free alias when a device is registered. We > > can then have an ATR specific callback with the original and translated > > address as arguments, so one can setup the HW as needed. > > Do you mean moving the alias selection code from i2c-atr.c to the i2c > core? And the rest of the ATR core too? I hope for something like this in the I2C core (simplified, naming needs to be improved etc.) in i2c_new_device: if (client->adapter->flag & NEEDS_ATR) { i2c_atr_get_alias_address(); /* probably a wrapper around a callback */ i2c_atr_setup_hw(); } with all the i2c_atr_* functions in a seperate file. It would be great if that file could be a completely independent module, but if it turns out that we need some simple helpers in the core, I am probably OK with that, too. > > Do you think that would work? > > Yes. Cool!
Hi! [ Sorry about my absence. I've been meaning to comment on this series for a long time, but work and family keep interfering... ] On 2019-09-03 09:31, Luca Ceresoli wrote: > Hi Jacopo, > > thanks for your feedback. > > On 01/09/19 16:31, jacopo mondi wrote: >> Hi Luca, >> thanks for keep pushing this series! I hope we can use part of this >> for the (long time) on-going GMSL work... >> >> I hope you will be patient enough to provide (another :) overview >> of this work during the BoF Wolfram has organized at LPC for the next >> week. > > Sure! > >> In the meantime I would have some comments after having a read at the >> series and trying to apply its concept to GMSL >> >> On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: >>> An ATR is a device that looks similar to an i2c-mux: it has an I2C >>> slave "upstream" port and N master "downstream" ports, and forwards >>> transactions from upstream to the appropriate downstream port. But is >>> is different in that the forwarded transaction has a different slave >>> address. The address used on the upstream bus is called the "alias" >>> and is (potentially) different from the physical slave address of the >>> downstream chip. >>> >>> Add a helper file (just like i2c-mux.c for a mux or switch) to allow >>> implementing ATR features in a device driver. The helper takes care or >>> adapter creation/destruction and translates addresses at each transaction. >>> >>> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >>> >>> --- >>> >>> Changes RFCv1 -> RFCv2: >>> >>> RFCv1 was implemented inside i2c-mux.c and added yet more complexity >>> there. RFCv2 creates a new file on its own, i2c-atr.c. Since many ATR >>> features are not in a MUX and vice versa, the overlapping is low. This was >>> almost a complete rewrite, but for the records here are the main >>> differences from the old implementation: >> >> I'm not an i2c expert, but this looks very similar to me to an >> augmented i2c-mux with the following additional features: >> - automatic selection of the i2c address to use for the children >> behind the mux >> - automatic translation of the addresses the logical aliases to >> the actual physical addresses of the slaves (with the help of the >> deserializer address translation feature in this case). > > A notable difference in the hardware is that a mux needs an explicit > procedure to select a port. That's why the select() op is mandatory for > muxes. The ATR, at least in the DS90UB9xx case, selects the port > automatically based on the slave address. So I added an optional > select() op in the atr, but I suspect it's useless for "real" ATRs. > > More differences derive from how Linux implements muxes. The i2c-mux > code has several flags for different locking schemes, and it has a It's two locking schemes if you count them carefully, so several is a bit of an exaggeration. But agreed, two is more than I prefer. > fairly complex DT parsing scheme. These are mostly a historical burden. > Adding the ATR features to i2c-mux.c was very tricky and error-prone due > to all of this code, that's why I have moved ATR to its own file in RFCv2. Anyway, the locking in i2c-mux may be complex, but it does solve real problems. The way I read this series, these problems are not dealt with and therefore the ATR code will not function in all surroundings. Some things to think about: - What happens when you put a mux behind an ATR? - What happens when you put an ATR behind a mux? - What happens when you put an ATR between two muxes? - Does it make a difference if the mux is parent-locked or mux-locked? - What happens if client drivers lock the adapter in order to silence the bus for some reason or to keep two xfers together or something, and then do unlocked xfers? - Can you put an ATR behind another ATR? etc I'm not saying that these things must be handled, and maybe they are handled already, and maybe some of the combinations are not valid at all. But the possibilities and limitations should be understood. And preferably documented. My gut feeling (without spending much time on it) is that ATR as implemented in this series behave approximately like mux-locked muxes, meaning that it is not obviously safe to put a parent-locked mux behind an ATR and making it impossible for client devices behind an ATR to force xfers to happen back-to-back from the root adapter. And finally, I feel that it is not wise to introduce a third locking scheme in the I2C topology. It's bad enough with two. Why not make the ATR locking exactly match the mux-locked scheme to reduce the number of cases one needs to consider? But maybe that's just me? Cheers, Peter
Hi Peter, On 04/09/19 10:09, Peter Rosin wrote:> Hi! > > [ Sorry about my absence. I've been meaning to comment on this series > for a long time, but work and family keep interfering... ] No problem, thanks for your comments. See below my reply. > > On 2019-09-03 09:31, Luca Ceresoli wrote: >> Hi Jacopo, >> >> thanks for your feedback. >> >> On 01/09/19 16:31, jacopo mondi wrote: >>> Hi Luca, >>> thanks for keep pushing this series! I hope we can use part of this >>> for the (long time) on-going GMSL work... >>> >>> I hope you will be patient enough to provide (another :) overview >>> of this work during the BoF Wolfram has organized at LPC for the next >>> week. >> >> Sure! >> >>> In the meantime I would have some comments after having a read at the >>> series and trying to apply its concept to GMSL >>> >>> On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: >>>> An ATR is a device that looks similar to an i2c-mux: it has an I2C >>>> slave "upstream" port and N master "downstream" ports, and forwards >>>> transactions from upstream to the appropriate downstream port. But is >>>> is different in that the forwarded transaction has a different slave >>>> address. The address used on the upstream bus is called the "alias" >>>> and is (potentially) different from the physical slave address of the >>>> downstream chip. >>>> >>>> Add a helper file (just like i2c-mux.c for a mux or switch) to allow >>>> implementing ATR features in a device driver. The helper takes care or >>>> adapter creation/destruction and translates addresses at each transaction. >>>> >>>> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >>>> >>>> --- >>>> >>>> Changes RFCv1 -> RFCv2: >>>> >>>> RFCv1 was implemented inside i2c-mux.c and added yet more complexity >>>> there. RFCv2 creates a new file on its own, i2c-atr.c. Since many ATR >>>> features are not in a MUX and vice versa, the overlapping is low. This was >>>> almost a complete rewrite, but for the records here are the main >>>> differences from the old implementation: >>> >>> I'm not an i2c expert, but this looks very similar to me to an >>> augmented i2c-mux with the following additional features: >>> - automatic selection of the i2c address to use for the children >>> behind the mux >>> - automatic translation of the addresses the logical aliases to >>> the actual physical addresses of the slaves (with the help of the >>> deserializer address translation feature in this case). >> >> A notable difference in the hardware is that a mux needs an explicit >> procedure to select a port. That's why the select() op is mandatory for >> muxes. The ATR, at least in the DS90UB9xx case, selects the port >> automatically based on the slave address. So I added an optional >> select() op in the atr, but I suspect it's useless for "real" ATRs. >> >> More differences derive from how Linux implements muxes. The i2c-mux >> code has several flags for different locking schemes, and it has a > > It's two locking schemes if you count them carefully, so several is > a bit of an exaggeration. But agreed, two is more than I prefer. Right, sorry for the exaggeration. Actually the most annoying part of the mux code to me was not quite the two locking schemes, but rather the DT parsing, which had some backward-compatibility to maintain. >> fairly complex DT parsing scheme. These are mostly a historical burden. >> Adding the ATR features to i2c-mux.c was very tricky and error-prone due >> to all of this code, that's why I have moved ATR to its own file in RFCv2. > > Anyway, the locking in i2c-mux may be complex, but it does solve real > problems. The way I read this series, these problems are not dealt with > and therefore the ATR code will not function in all surroundings. > > Some things to think about: > - What happens when you put a mux behind an ATR? > - What happens when you put an ATR behind a mux? > - What happens when you put an ATR between two muxes? > - Does it make a difference if the mux is parent-locked or mux-locked? > - What happens if client drivers lock the adapter in order to silence the > bus for some reason or to keep two xfers together or something, and > then do unlocked xfers? > - Can you put an ATR behind another ATR? > etc I still have to examine in depth all of the problems in the i2c-mux documented in Documentation/i2c/i2c-topology (thanks for having written those docs!), but at first sight it looks like the ATR is not going to introduce big problems because of how it works. An I2C mux works by electrically connecting the parent bus to one of the child busses. But this implies any transactions happening on the parent bus can leak through the mux and cause the problems you documented. The Maxim GMSL serdes chips work de facto in the same way, even though there is no simple electrical connection between the busses. An ATR, at least the one in the TI serdes chips, uses a store-and-forward technique: 1. when a transaction starts on the parent bus, it waits for the first 8 bits 2. it checks if the slave address matches one of the aliases assigned to the remote chips; if it doesn't, it does not drive the child bus wires at all and ignores the rest of the transaction 3. if there's a match it stretches the parent bus SCL and issues a {start + chip address + R/W} on the child bus, but replacing the alias with the physical chip address 4. it then waits for an the ack on the child bus, then issues an ack on the parent bus 5. for write transactions, it repeats until a stop condition or an error is seen: wait for an entire byte on parent bus, clock stretching on the parent bus, send the byte on the child bus, wait for ack on the child bus, send ack on the parent bus 6. for read transactions it does the same as point 5 but with "parent bus" and "child bus" swapped This technique does not leak any transaction to a child bus unless it's directed to it. So it should have many less problems than the muxes, if any. > I'm not saying that these things must be handled, and maybe they are > handled already, and maybe some of the combinations are not valid at > all. But the possibilities and limitations should be understood. And > preferably documented. > > My gut feeling (without spending much time on it) is that ATR as > implemented in this series behave approximately like mux-locked muxes, > meaning that it is not obviously safe to put a parent-locked mux behind > an ATR and making it impossible for client devices behind an ATR to force > xfers to happen back-to-back from the root adapter. For what I described above I don't expect the ATR + parent-locked mux would have the same problems as the mux-locked mux + parent-locked mux. The ATR will not let transaction on the root adapter leak through and reach the mux, unless they are targeted at the child bus where the mux is. Do you think this is correct? As I said, I still have to analyse all the possible combinations.
Hi Luca, Jacopo, Wolfram, Peter, On 09/01/2019 05:31 PM, jacopo mondi wrote: > Hi Luca, > thanks for keep pushing this series! I hope we can use part of this > for the (long time) on-going GMSL work... > > I hope you will be patient enough to provide (another :) overview > of this work during the BoF Wolfram has organized at LPC for the next > week. > > In the meantime I would have some comments after having a read at the > series and trying to apply its concept to GMSL > I won't attend the LPC, however I would appreciate if you book some time to review my original / alternative implementation of the TI DS90Ux9xx I2C bridge device driver. For your convenience the links to the driver are given below: * dt bindings: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#mead5ea226550b * driver code: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m2fe3664c5f884 * usage example: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m56c146f5decdc The reasons why my driver is better/more flexible/more functional are discussed earlier, please let me know, if you expect anything else from me to add, also I would be happy to get a summary of your offline discussion. The undeniable fact is that the device tree bindings in my I2C bridge implementation can be improved further, thanks to Luca for the comments. > On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: >> An ATR is a device that looks similar to an i2c-mux: it has an I2C >> slave "upstream" port and N master "downstream" ports, and forwards >> transactions from upstream to the appropriate downstream port. But is >> is different in that the forwarded transaction has a different slave >> address. The address used on the upstream bus is called the "alias" >> and is (potentially) different from the physical slave address of the >> downstream chip. >> >> Add a helper file (just like i2c-mux.c for a mux or switch) to allow >> implementing ATR features in a device driver. The helper takes care or >> adapter creation/destruction and translates addresses at each transaction. >> >> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >> -- Best wishes, Vladimir
Hi Luca, Jacopo, Wolfram, Peter, On 09/08/2019 11:45 PM, Vladimir Zapolskiy wrote: > Hi Luca, Jacopo, Wolfram, Peter, > > On 09/01/2019 05:31 PM, jacopo mondi wrote: >> Hi Luca, >> thanks for keep pushing this series! I hope we can use part of this >> for the (long time) on-going GMSL work... >> >> I hope you will be patient enough to provide (another :) overview >> of this work during the BoF Wolfram has organized at LPC for the next >> week. >> >> In the meantime I would have some comments after having a read at the >> series and trying to apply its concept to GMSL >> > > I won't attend the LPC, however I would appreciate if you book some > time to review my original / alternative implementation of the TI > DS90Ux9xx I2C bridge device driver. > > For your convenience the links to the driver are given below: > * dt bindings: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#mead5ea226550b > * driver code: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m2fe3664c5f884 > * usage example: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m56c146f5decdc > > The reasons why my driver is better/more flexible/more functional are > discussed earlier, please let me know, if you expect anything else > from me to add, also I would be happy to get a summary of your offline > discussion. I forgot to repeat my main objection against Luca's approach, the TI DS90Ux9xx I2C bridge driver does not require to call i2c_add_adapter() or register a new mux/bus and then do run select/deselect in runtime to overcome the created handicap. > The undeniable fact is that the device tree bindings in my I2C bridge > implementation can be improved further, thanks to Luca for the comments. > >> On Tue, Jul 23, 2019 at 10:37:19PM +0200, Luca Ceresoli wrote: >>> An ATR is a device that looks similar to an i2c-mux: it has an I2C >>> slave "upstream" port and N master "downstream" ports, and forwards >>> transactions from upstream to the appropriate downstream port. But is >>> is different in that the forwarded transaction has a different slave >>> address. The address used on the upstream bus is called the "alias" >>> and is (potentially) different from the physical slave address of the >>> downstream chip. >>> >>> Add a helper file (just like i2c-mux.c for a mux or switch) to allow >>> implementing ATR features in a device driver. The helper takes care or >>> adapter creation/destruction and translates addresses at each transaction. >>> >>> Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> >>> > -- Best wishes, Vladimir
Hi Vladimir, > I won't attend the LPC, however I would appreciate if you book some A pity. I would have liked to have you in the room. Let's see if we can get enough input from you via mail here. > time to review my original / alternative implementation of the TI > DS90Ux9xx I2C bridge device driver. We have only 45 minutes, this will not allow to review specific implementations. I want to give an overview of existing implementations with pros/cons... > The reasons why my driver is better/more flexible/more functional are > discussed earlier, please let me know, if you expect anything else > from me to add, also I would be happy to get a summary of your offline > discussion. ... and I'd appreciate support here from you, like your summary of the back then discussion (from where I can dive deeper if needed). Also, with Luca's new series we discussed some scenarios which can happen WRT to I2C address conflicts. Maybe you could comment on them, too? As I read the old thread, you have a hardcoded aliases using "ti,i2c-bridge-maps". This means you can't have own DTSI files for e.g. add-on modules, do I get this correctly? Regards, Wolfram
Hi Wolfram, On 09/09/2019 10:22 AM, Wolfram Sang wrote: > Hi Vladimir, > >> I won't attend the LPC, however I would appreciate if you book some > > A pity. I would have liked to have you in the room. Let's see if we can > get enough input from you via mail here. > if it might help, I'll attend the Embedded Recipes and ELCE conferences this year. >> time to review my original / alternative implementation of the TI >> DS90Ux9xx I2C bridge device driver. > > We have only 45 minutes, this will not allow to review specific > implementations. I want to give an overview of existing implementations > with pros/cons... > Sure! Any shared summary/opinions are greatly welcome. >> The reasons why my driver is better/more flexible/more functional are >> discussed earlier, please let me know, if you expect anything else >> from me to add, also I would be happy to get a summary of your offline >> discussion. > > ... and I'd appreciate support here from you, like your summary of the > back then discussion (from where I can dive deeper if needed). > > Also, with Luca's new series we discussed some scenarios which can > happen WRT to I2C address conflicts. Maybe you could comment on them, > too? I do remember I've commented on the Luca's suggestion of using dynamic I2C addresses from a pool (the introduced "i2c-alias-pool" property). I have to scrutinize it in Luca's v2, but then it might happen that the userspace won't know to which IC on the remote side it communicates to. > As I read the old thread, you have a hardcoded aliases using > "ti,i2c-bridge-maps". This means you can't have own DTSI files for e.g. > add-on modules, do I get this correctly? > Basically hardcoding of aliases completely resolves the highlighted above problem. Still it is possible to have own DTSI files for the FPD link detachable PCBs, and this is an exceptionally important scenario, however some limitations shall be applied: * dt overlays for "local" derializer/deserializer ICs, it's a generic and universal solution, it is successfully used in the field, * only "compatible" PCBs are supposed to be connected (same set of I2C devices/addresses on every such PCB), this is imperfect for sure, * "ti,i2c-bridge-maps" list is excessive to cover "almost compatible" (in the sense from above) PCBs, some of the missed alias matches just won't instantiate a driver, this is of course also imperfect. In general nothing critical should happen, if some I2C device on the remote side is simply not probed in runtime, in opposite you can imagine that writing for instance to another EEPROM of two on the remote side could be harmful. Any technically better solution to the two given approaches (from Luca and from me) is more than appreciated. For non-dynamic/fixed local and remote PCBs the fixed mapping is better, the dynamic case is covered by the dt overlays, why not? As a side note please do remember that the I2C bridging on Maxim GMSL and TI DS90Ux9xx are different, the former one is a real mux, and the latter one is not, I'm uncertain if it's reasonable to think of a generalized solution which covers both IC series, so likely we have to review the developed solutions for them separately instead of trying to work out a combined one. -- Best wishes, Vladimir
Hi Vladimir, On 09/09/19 16:10, Vladimir Zapolskiy wrote: > Hi Wolfram, > > On 09/09/2019 10:22 AM, Wolfram Sang wrote: >> Hi Vladimir, >> >>> I won't attend the LPC, however I would appreciate if you book some >> >> A pity. I would have liked to have you in the room. Let's see if we can >> get enough input from you via mail here. >> > > if it might help, I'll attend the Embedded Recipes and ELCE conferences > this year. > >>> time to review my original / alternative implementation of the TI >>> DS90Ux9xx I2C bridge device driver. >> >> We have only 45 minutes, this will not allow to review specific >> implementations. I want to give an overview of existing implementations >> with pros/cons... >> > > Sure! Any shared summary/opinions are greatly welcome. > >>> The reasons why my driver is better/more flexible/more functional are >>> discussed earlier, please let me know, if you expect anything else >>> from me to add, also I would be happy to get a summary of your offline >>> discussion. >> >> ... and I'd appreciate support here from you, like your summary of the >> back then discussion (from where I can dive deeper if needed). >> >> Also, with Luca's new series we discussed some scenarios which can >> happen WRT to I2C address conflicts. Maybe you could comment on them, >> too? > > I do remember I've commented on the Luca's suggestion of using dynamic > I2C addresses from a pool (the introduced "i2c-alias-pool" property). > > I have to scrutinize it in Luca's v2, but then it might happen that the > userspace won't know to which IC on the remote side it communicates to. I think you suspect this because the assigned alias is non-deterministic, so you might end up in writing to the wrong alias. Well, this is not possible because the user is not supposed to know the alias at all. Let's say you have two identical eeproms on remote port 0, with physical addresses 0x50 and 0x51. Then, with my RFCv2 code, you'll access them with physical numbers, not the alias: # i2cdetect -l i2c-0 i2c amba:camera-i2c@0 I2C adapter i2c-4 i2c i2c-0-atr-0 I2C adapter i2c-5 i2c i2c-0-atr-1 I2C adapter # hexdump /sys/bus/i2c/devices/4-0050/eeprom 0000000 ffff ffff ffff ffff ffff ffff ffff ffff * 0000100 # hexdump /sys/bus/i2c/devices/4-0051/eeprom 0000000 0001 0203 0405 0607 0809 0a0b 0c0d 0e0f * 0000100 # Here i2c-0 is the "local" bus, i2c-4 and i2c-5 are the remote busses on ports 0 and 1. As you can see the eeproms are accessed using a name like "4-0050", meaning physical slave address 0x50 on bus 4. No alias is needed. Should you want to know the alias, perhaps for debugging (it's the address you'll see on your logic analyzer), they are shown in the kernel log. Does this reply to your concern? >> As I read the old thread, you have a hardcoded aliases using >> "ti,i2c-bridge-maps". This means you can't have own DTSI files for e.g. >> add-on modules, do I get this correctly? >> > > Basically hardcoding of aliases completely resolves the highlighted > above problem. Still it is possible to have own DTSI files for the FPD > link detachable PCBs, and this is an exceptionally important scenario, > however some limitations shall be applied: > * dt overlays for "local" derializer/deserializer ICs, it's a generic > and universal solution, it is successfully used in the field, > * only "compatible" PCBs are supposed to be connected (same set of I2C > devices/addresses on every such PCB), this is imperfect for sure, > * "ti,i2c-bridge-maps" list is excessive to cover "almost compatible" > (in the sense from above) PCBs, some of the missed alias matches > just won't instantiate a driver, this is of course also imperfect. > > In general nothing critical should happen, if some I2C device on the > remote side is simply not probed in runtime, in opposite you can imagine > that writing for instance to another EEPROM of two on the remote side > could be harmful. > > Any technically better solution to the two given approaches (from Luca > and from me) is more than appreciated. For non-dynamic/fixed local and > remote PCBs the fixed mapping is better, the dynamic case is covered > by the dt overlays, why not? > > As a side note please do remember that the I2C bridging on Maxim GMSL > and TI DS90Ux9xx are different, the former one is a real mux, and the > latter one is not, I'm uncertain if it's reasonable to think of a > generalized solution which covers both IC series, so likely we > have to review the developed solutions for them separately instead > of trying to work out a combined one. > > -- > Best wishes, > Vladimir >
> Here i2c-0 is the "local" bus, i2c-4 and i2c-5 are the remote busses on > ports 0 and 1. As you can see the eeproms are accessed using a name like > "4-0050", meaning physical slave address 0x50 on bus 4. No alias is needed. > > Should you want to know the alias, perhaps for debugging (it's the > address you'll see on your logic analyzer), they are shown in the kernel > log. And to add to that: The aliases on i2c-0 will be marked busy and show up as used if you run i2cdetect. So, you'd need a force-flag if you'd want to access them from userspace.
Hi Vladimir, On 09/09/19 05:56, Vladimir Zapolskiy wrote: > Hi Luca, Jacopo, Wolfram, Peter, > > On 09/08/2019 11:45 PM, Vladimir Zapolskiy wrote: >> Hi Luca, Jacopo, Wolfram, Peter, >> >> On 09/01/2019 05:31 PM, jacopo mondi wrote: >>> Hi Luca, >>> thanks for keep pushing this series! I hope we can use part of this >>> for the (long time) on-going GMSL work... >>> >>> I hope you will be patient enough to provide (another :) overview >>> of this work during the BoF Wolfram has organized at LPC for the next >>> week. >>> >>> In the meantime I would have some comments after having a read at the >>> series and trying to apply its concept to GMSL >>> >> >> I won't attend the LPC, however I would appreciate if you book some >> time to review my original / alternative implementation of the TI >> DS90Ux9xx I2C bridge device driver. >> >> For your convenience the links to the driver are given below: >> * dt bindings: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#mead5ea226550b >> * driver code: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m2fe3664c5f884 >> * usage example: https://lore.kernel.org/lkml/20181012060314.GU4939@dell/T/#m56c146f5decdc >> >> The reasons why my driver is better/more flexible/more functional are >> discussed earlier, please let me know, if you expect anything else >> from me to add, also I would be happy to get a summary of your offline >> discussion. > > I forgot to repeat my main objection against Luca's approach, the TI > DS90Ux9xx I2C bridge driver does not require to call i2c_add_adapter() > or register a new mux/bus and then do run select/deselect in runtime to > overcome the created handicap. Whether the ser/deser drivers should or not instantiate an adapter depends on whether the child I2C bus is a separate bus or it's "the same bus" as the parent bus. Which in turn is not obvious, and depends on how you look at it. On one hand, the child bus looks like it is the same as the parent bus because transactions on the child bus also happen on the parent bus (bus not the other way around). On the other hand the child bus also looks like a separate bus because it is electrically separated from the parent bus, it can have a different speed, and devices on one child bus cannot talk with devices on another child bus under the same ser/deser. The way you modeled it has the advantage of not requiring a runtime rewriting of slave addresses. Thas's what I implemented in i2c_atr_map_msgs(), I don't love the fact that it happens at every iteration, but its runtime cost is negligible compared to I2C speeds. On the other hand I'm not sure how your approach would work if you have an i2c bridge behind another i2c bridge (see the "ATR behind another ATR" case mentioned by Peter). By contrast, adding an adapter for each child bus has its advantages. I didn't have to write code to instantiate the devices, letting the i2c core do it. Also, as child busses show up as real busses it's possible to instantiate devices from userspace just like any standard i2c bus with: echo eeprom 0x50 > /sys/bus/i2c/devices/i2c-4/new_device and devices will be assigned an alias and be usable normally. Finally, there is no need to call select()/deselect() in runtime. Those callbacks are optional, and I'm probably removing them in a future iteration as I'm more and more convinced they are not needed at all.
> I still have to examine in depth all of the problems in the i2c-mux > documented in Documentation/i2c/i2c-topology (thanks for having written > those docs!), but at first sight it looks like the ATR is not going to > introduce big problems because of how it works. Assuming we are using the previously discussed NEEDS_ATR flag for the adapter instead of the attach/detach callbacks: Can't we then simply understand an ATR as a generic 1:1 mapping device which can be setup when registering an adapter? When we add an adapter using i2c_add_adapter, we have: .-----. Slave X @ 0x10 .-----. | | | | CPU |--A--| ATR |---+---- B `-----' | | `-----' When we use i2c_add_mux_adapter, we have: Slave X @ 0x10 .-----. .-----. | .-----. | |---| ATR |---+---- B | CPU |--A--| MUX | '-----' `-----' | | .-----. | |---| ATR |---+---- C `-----' '-----' | Slave Y @ 0x10 That way we could keep the topology handling solely to the mux-core. Am I overlooking something?
diff --git a/drivers/i2c/Kconfig b/drivers/i2c/Kconfig index abedd55a1264..5df088b1d9de 100644 --- a/drivers/i2c/Kconfig +++ b/drivers/i2c/Kconfig @@ -71,6 +71,15 @@ config I2C_MUX source "drivers/i2c/muxes/Kconfig" +config I2C_ATR + tristate "I2C Address Translator (ATR) support" + help + Enable support for I2C Address Translator (ATR) chips. + + An ATR allows accessing multiple I2C busses from a single + physical bus via address translation instead of bus selection as + i2c-muxes do. + config I2C_HELPER_AUTO bool "Autoselect pertinent helper modules" default y diff --git a/drivers/i2c/Makefile b/drivers/i2c/Makefile index bed6ba63c983..81849ea393c7 100644 --- a/drivers/i2c/Makefile +++ b/drivers/i2c/Makefile @@ -13,6 +13,7 @@ i2c-core-$(CONFIG_OF) += i2c-core-of.o obj-$(CONFIG_I2C_SMBUS) += i2c-smbus.o obj-$(CONFIG_I2C_CHARDEV) += i2c-dev.o obj-$(CONFIG_I2C_MUX) += i2c-mux.o +obj-$(CONFIG_I2C_ATR) += i2c-atr.o obj-y += algos/ busses/ muxes/ obj-$(CONFIG_I2C_STUB) += i2c-stub.o obj-$(CONFIG_I2C_SLAVE_EEPROM) += i2c-slave-eeprom.o diff --git a/drivers/i2c/i2c-atr.c b/drivers/i2c/i2c-atr.c new file mode 100644 index 000000000000..2b61c10a8ff6 --- /dev/null +++ b/drivers/i2c/i2c-atr.c @@ -0,0 +1,557 @@ +// SPDX-License-Identifier: GPL-2.0 +/** + * drivers/i2c/i2c-atr.c -- I2C Address Translator + * + * Copyright (c) 2019 Luca Ceresoli <luca@lucaceresoli.net> + * + * An I2C Address Translator (ATR) is a device with an I2C slave parent + * ("upstream") port and N I2C master child ("downstream") ports, and + * forwards transactions from upstream to the appropriate downstream port + * with a modified slave address. The address used on the parent bus is + * called the "alias" and is (potentially) different from the physical + * slave address of the child bus. Address translation is done by the + * hardware. + * + * An ATR looks similar to an i2c-mux except: + * - the address on the parent and child busses can be different + * - there is normally no need to select the child port; the alias used on + * the parent bus implies it + * + * The ATR functionality can be provided by a chip with many other + * features. This file provides a helper to implement an ATR within your + * driver. + * + * The ATR creates a new I2C "child" adapter on each child bus. Adding + * devices on the child bus ends up in invoking the driver code to select + * an available alias. Maintaining an appropriate pool of available aliases + * and picking one for each new device is up to the driver implementer. The + * ATR maintains an table of currently assigned alias and uses it to modify + * all I2C transactions directed to devices on the child buses. + * + * A typical example follows. + * + * Topology: + * + * Slave X @ 0x10 + * .-----. | + * .-----. | |---+---- B + * | CPU |--A--| ATR | + * `-----' | |---+---- C + * `-----' | + * Slave Y @ 0x10 + * + * Alias table: + * + * Client Alias + * ------------- + * X 0x20 + * Y 0x30 + * + * Transaction: + * + * - Slave X driver sends a transaction (on adapter B), slave address 0x10 + * - ATR driver rewrites messages with address 0x20, forwards to adapter A + * - Physical I2C transaction on bus A, slave address 0x20 + * - ATR chip propagates transaction on bus B with address translated to 0x10 + * - Slave X chip replies on bus B + * - ATR chip forwards reply on bus A + * - ATR driver rewrites messages with address 0x10 + * - Slave X driver gets back the msgs[], with reply and address 0x10 + * + * Usage: + * + * 1. In your driver (typically in the probe function) add an ATR by + * calling i2c_atr_new() passing your attach/detach callbacks + * 2. When the attach callback is called pick an appropriate alias, + * configure it in your chip and return the chosen alias in the + * alias_id parameter + * 3. When the detach callback is called, deconfigure the alias from + * your chip and put it back in the pool for later usage + * + * Originally based on i2c-mux.c + */ + +#include <linux/i2c.h> +#include <linux/i2c-atr.h> +#include <linux/kernel.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/of.h> +#include <linux/slab.h> + +/** + * struct i2c_atr_cli2alias_pair - Hold the alias assigned to a client. + * @node: List node + * @client: Pointer to the client on the child bus + * @alias: I2C alias address assigned by the driver. + * This is the address that will be used to issue I2C transactions + * on the parent (physical) bus. + */ +struct i2c_atr_cli2alias_pair { + struct list_head node; + const struct i2c_client *client; + u16 alias; +}; + +/* + * Data for each channel (child bus) + */ +struct i2c_atr_chan { + struct i2c_adapter adap; + struct i2c_atr *atr; + u32 chan_id; + + struct list_head alias_list; + + u16 *orig_addrs; + unsigned int orig_addrs_size; + struct mutex orig_addrs_lock; /* Lock orig_addrs during xfer */ +}; + +static struct i2c_atr_cli2alias_pair * +i2c_atr_find_mapping_by_client(struct list_head *list, + struct i2c_client *client) +{ + struct i2c_atr_cli2alias_pair *c2a; + + list_for_each_entry(c2a, list, node) { + if (c2a->client == client) + return c2a; + } + + return NULL; +} + +static struct i2c_atr_cli2alias_pair * +i2c_atr_find_mapping_by_addr(struct list_head *list, + u16 phys_addr) +{ + struct i2c_atr_cli2alias_pair *c2a; + + list_for_each_entry(c2a, list, node) { + if (c2a->client->addr == phys_addr) + return c2a; + } + + return NULL; +} + +/* + * Replace all message addresses with their aliases, saving the original + * addresses. + * + * This function is internal for use in i2c_atr_master_xfer(). It must be + * followed by i2c_atr_unmap_msgs() to restore the original addresses. + */ +static int i2c_atr_map_msgs(struct i2c_atr_chan *chan, + struct i2c_msg msgs[], int num) + +{ + struct i2c_atr *atr = chan->atr; + static struct i2c_atr_cli2alias_pair *c2a; + int i; + + /* Ensure we have enough room to save the original addresses */ + if (unlikely(chan->orig_addrs_size < num)) { + void *new_buf = kmalloc(num * sizeof(chan->orig_addrs[0]), + GFP_KERNEL); + if (new_buf == NULL) + return -ENOMEM; + + kfree(chan->orig_addrs); + chan->orig_addrs = new_buf; + chan->orig_addrs_size = num; + } + + for (i = 0; i < num; i++) { + chan->orig_addrs[i] = msgs[i].addr; + + c2a = i2c_atr_find_mapping_by_addr(&chan->alias_list, + msgs[i].addr); + if (c2a) { + msgs[i].addr = c2a->alias; + } else { + dev_err(atr->dev, "client 0x%02x not mapped!\n", + msgs[i].addr); + return -ENXIO; + } + } + + return 0; +} + +/* + * Restore all message address aliases with the original addresses. + * + * This function is internal for use in i2c_atr_master_xfer(). + * + * @see i2c_atr_map_msgs() + */ +static void i2c_atr_unmap_msgs(struct i2c_atr_chan *chan, + struct i2c_msg msgs[], int num) +{ + int i; + + for (i = 0; i < num; i++) + msgs[i].addr = chan->orig_addrs[i]; +} + +static int i2c_atr_master_xfer(struct i2c_adapter *adap, + struct i2c_msg msgs[], int num) +{ + struct i2c_atr_chan *chan = adap->algo_data; + struct i2c_atr *atr = chan->atr; + struct i2c_adapter *parent = atr->parent; + int ret = 0; + + /* Switch to the right atr port */ + if (atr->ops->select) { + ret = atr->ops->select(atr, chan->chan_id); + if (ret < 0) + goto out; + } + + /* Translate addresses */ + mutex_lock(&chan->orig_addrs_lock); + ret = i2c_atr_map_msgs(chan, msgs, num); + if (ret < 0) { + mutex_unlock(&chan->orig_addrs_lock); + goto out; + } + + /* Perform the transfer */ + ret = i2c_transfer(parent, msgs, num); + + /* Restore addresses */ + i2c_atr_unmap_msgs(chan, msgs, num); + mutex_unlock(&chan->orig_addrs_lock); + +out: + if (atr->ops->deselect) + atr->ops->deselect(atr, chan->chan_id); + + return ret; +} + +static int i2c_atr_smbus_xfer(struct i2c_adapter *adap, + u16 addr, unsigned short flags, + char read_write, u8 command, + int size, union i2c_smbus_data *data) +{ + struct i2c_atr_chan *chan = adap->algo_data; + struct i2c_atr *atr = chan->atr; + struct i2c_adapter *parent = atr->parent; + struct i2c_atr_cli2alias_pair *c2a; + int err = 0; + + c2a = i2c_atr_find_mapping_by_addr(&chan->alias_list, addr); + if (!c2a) { + dev_err(atr->dev, "client 0x%02x not mapped!\n", addr); + return -ENXIO; + } + + if (atr->ops->select) + err = atr->ops->select(atr, chan->chan_id); + if (!err) + err = i2c_smbus_xfer(parent, c2a->alias, flags, + read_write, command, size, data); + if (atr->ops->deselect) + atr->ops->deselect(atr, chan->chan_id); + + return err; +} + +static u32 i2c_atr_functionality(struct i2c_adapter *adap) +{ + struct i2c_atr_chan *chan = adap->algo_data; + struct i2c_adapter *parent = chan->atr->parent; + + return parent->algo->functionality(parent); +} + +static void i2c_atr_lock_bus(struct i2c_adapter *adapter, unsigned int flags) +{ + struct i2c_atr_chan *chan = adapter->algo_data; + struct i2c_atr *atr = chan->atr; + + mutex_lock(&atr->lock); +} + +static int i2c_atr_trylock_bus(struct i2c_adapter *adapter, unsigned int flags) +{ + struct i2c_atr_chan *chan = adapter->algo_data; + struct i2c_atr *atr = chan->atr; + + return mutex_trylock(&atr->lock); +} + +static void i2c_atr_unlock_bus(struct i2c_adapter *adapter, unsigned int flags) +{ + struct i2c_atr_chan *chan = adapter->algo_data; + struct i2c_atr *atr = chan->atr; + + mutex_unlock(&atr->lock); +} + +static const struct i2c_lock_operations i2c_atr_lock_ops = { + .lock_bus = i2c_atr_lock_bus, + .trylock_bus = i2c_atr_trylock_bus, + .unlock_bus = i2c_atr_unlock_bus, +}; + +static int i2c_atr_attach_client(struct i2c_adapter *adapter, + const struct i2c_board_info *info, + const struct i2c_client *client) +{ + struct i2c_atr_chan *chan = adapter->algo_data; + struct i2c_atr *atr = chan->atr; + struct i2c_atr_cli2alias_pair *c2a; + u16 alias_id = 0; + int err = 0; + + c2a = kzalloc(sizeof(struct i2c_atr_cli2alias_pair), GFP_KERNEL); + if (!c2a) { + err = -ENOMEM; + goto err_alloc; + } + + err = atr->ops->attach_client(atr, chan->chan_id, info, client, + &alias_id); + if (err) + goto err_attach; + if (alias_id == 0) { + err = -EINVAL; + goto err_attach; + } + + c2a->client = client; + c2a->alias = alias_id; + list_add(&c2a->node, &chan->alias_list); + + return 0; + +err_attach: + kfree(c2a); +err_alloc: + return err; +} + +static void i2c_atr_detach_client(struct i2c_adapter *adapter, + const struct i2c_client *client) +{ + struct i2c_atr_chan *chan = adapter->algo_data; + struct i2c_atr *atr = chan->atr; + struct i2c_atr_cli2alias_pair *c2a; + + atr->ops->detach_client(atr, chan->chan_id, client); + + c2a = i2c_atr_find_mapping_by_client(&chan->alias_list, client); + if (c2a != NULL) { + list_del(&c2a->node); + kfree(c2a); + } +} + +static const struct i2c_attach_operations i2c_atr_attach_ops = { + .attach_client = i2c_atr_attach_client, + .detach_client = i2c_atr_detach_client, +}; + +/** + * i2c_atr_add_adapter - Create a child ("downstream") I2C bus. + * @atr: The I2C ATR + * @chan_id: Index of the new adapter (0 .. max_adapters-1). This value is + * passed to the callbacks in `struct i2c_atr_ops`. + * + * After calling this function a new i2c bus will appear. Adding and + * removing devices on the downstream bus will result in calls to the + * `attach_client` and `detach_client` callbacks for the driver to assign + * an alias to the device. + * + * If there is a device tree node under "i2c-atr" whose "reg" property + * equals chan_id, the new adapter will receive that node and perhaps start + * adding devices under it. The callbacks for those additions will be made + * before i2c_atr_add_adapter() returns. + * + * Call i2c_atr_del_adapter() to remove the adapter. + * + * Return: 0 on success, a negative error code otherwise. + */ +int i2c_atr_add_adapter(struct i2c_atr *atr, u32 chan_id) +{ + struct i2c_adapter *parent = atr->parent; + struct device *dev = atr->dev; + struct i2c_atr_chan *chan; + char symlink_name[20]; + int err; + + if (chan_id >= atr->max_adapters) + return -EINVAL; + + if (atr->adapter[chan_id]) { + dev_err(dev, "Adapter %d already present\n", chan_id); + return -EEXIST; + } + + chan = kzalloc(sizeof(*chan), GFP_KERNEL); + if (!chan) + return -ENOMEM; + + chan->atr = atr; + chan->chan_id = chan_id; + INIT_LIST_HEAD(&chan->alias_list); + mutex_init(&chan->orig_addrs_lock); + + snprintf(chan->adap.name, sizeof(chan->adap.name), + "i2c-%d-atr-%d", i2c_adapter_id(parent), chan_id); + chan->adap.owner = THIS_MODULE; + chan->adap.algo = &atr->algo; + chan->adap.algo_data = chan; + chan->adap.dev.parent = dev; + chan->adap.retries = parent->retries; + chan->adap.timeout = parent->timeout; + chan->adap.quirks = parent->quirks; + chan->adap.lock_ops = &i2c_atr_lock_ops; + chan->adap.attach_ops = &i2c_atr_attach_ops; + + if (dev->of_node) { + struct device_node *atr_node; + struct device_node *child; + u32 reg; + + atr_node = of_get_child_by_name(dev->of_node, "i2c-atr"); + + for_each_child_of_node(atr_node, child) { + err = of_property_read_u32(child, "reg", ®); + if (err) + continue; + if (chan_id == reg) + break; + } + + chan->adap.dev.of_node = child; + of_node_put(atr_node); + } + + err = i2c_add_adapter(&chan->adap); + if (err) { + dev_err(dev, "failed to add atr-adapter %u (error=%d)\n", + chan_id, err); + goto err_add_adapter; + } + + WARN(sysfs_create_link(&chan->adap.dev.kobj, &dev->kobj, "atr_device"), + "can't create symlink to atr device\n"); + snprintf(symlink_name, sizeof(symlink_name), "channel-%u", chan_id); + WARN(sysfs_create_link(&dev->kobj, &chan->adap.dev.kobj, symlink_name), + "can't create symlink for channel %u\n", chan_id); + + dev_info(dev, "Added ATR child bus %d\n", i2c_adapter_id(&chan->adap)); + + atr->adapter[chan_id] = &chan->adap; + return 0; + +err_add_adapter: + mutex_destroy(&chan->orig_addrs_lock); + kfree(chan); + return err; +} +EXPORT_SYMBOL_GPL(i2c_atr_add_adapter); + +/** + * i2c_atr_del_adapter - Remove a child ("downstream") I2C bus added by + * i2c_atr_del_adapter(). + * @atr: The I2C ATR + * @chan_id: Index of the `adapter to be removed (0 .. max_adapters-1) + */ +void i2c_atr_del_adapter(struct i2c_atr *atr, u32 chan_id) +{ + char symlink_name[20]; + + struct i2c_adapter *adap = atr->adapter[chan_id]; + struct i2c_atr_chan *chan = adap->algo_data; + struct device_node *np = adap->dev.of_node; + struct device *dev = atr->dev; + + if (atr->adapter[chan_id] == NULL) { + dev_err(dev, "Adapter %d does not exist\n", chan_id); + return; + } + + dev_info(dev, "Removing ATR child bus %d\n", i2c_adapter_id(adap)); + + atr->adapter[chan_id] = NULL; + + snprintf(symlink_name, sizeof(symlink_name), + "channel-%u", chan->chan_id); + sysfs_remove_link(&dev->kobj, symlink_name); + sysfs_remove_link(&chan->adap.dev.kobj, "atr_device"); + + i2c_del_adapter(adap); + of_node_put(np); + mutex_destroy(&chan->orig_addrs_lock); + kfree(chan); +} +EXPORT_SYMBOL_GPL(i2c_atr_del_adapter); + +/** + * i2c_atr_new() - Allocate and initialize an I2C ATR helper. + * @parent: The parent (upstream) adapter + * @dev: The device acting as an ATR + * @ops: Driver-specific callbacks + * @max_adapters: Maximum number of child adapters + * + * The new ATR helper is connected to the parent adapter but has no child + * adapters. Call i2c_atr_add_adapter() to add some. + * + * Call i2c_atr_delete() to remove. + * + * Return: pointer to the new ATR helper object, or ERR_PTR + */ +struct i2c_atr *i2c_atr_new(struct i2c_adapter *parent, struct device *dev, + const struct i2c_atr_ops *ops, int max_adapters) +{ + struct i2c_atr *atr; + + if (!ops || !ops->attach_client || !ops->detach_client) + return ERR_PTR(-EINVAL); + + atr = devm_kzalloc(dev, sizeof(*atr) + + max_adapters * sizeof(atr->adapter[0]), + GFP_KERNEL); + if (!atr) + return ERR_PTR(-ENOMEM); + + mutex_init(&atr->lock); + + atr->parent = parent; + atr->dev = dev; + atr->ops = ops; + atr->max_adapters = max_adapters; + + if (parent->algo->master_xfer) + atr->algo.master_xfer = i2c_atr_master_xfer; + if (parent->algo->smbus_xfer) + atr->algo.smbus_xfer = i2c_atr_smbus_xfer; + atr->algo.functionality = i2c_atr_functionality; + + return atr; +} +EXPORT_SYMBOL_GPL(i2c_atr_new); + +/** + * i2c_atr_delete - Delete an I2C ATR helper. + * @atr: I2C ATR helper to be deleted. + * + * Precondition: all the adapters added with i2c_atr_add_adapter() mumst be + * removed by calling i2c_atr_del_adapter(). + */ +void i2c_atr_delete(struct i2c_atr *atr) +{ + mutex_destroy(&atr->lock); +} +EXPORT_SYMBOL_GPL(i2c_atr_delete); + +MODULE_AUTHOR("Luca Ceresoli <luca@lucaceresoli.net>"); +MODULE_DESCRIPTION("I2C Address Translator"); +MODULE_LICENSE("GPL v2"); diff --git a/include/linux/i2c-atr.h b/include/linux/i2c-atr.h new file mode 100644 index 000000000000..019816e5a50c --- /dev/null +++ b/include/linux/i2c-atr.h @@ -0,0 +1,82 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/** + * drivers/i2c/i2c-atr.h -- I2C Address Translator + * + * Copyright (c) 2019 Luca Ceresoli <luca@lucaceresoli.net> + * + * Based on i2c-mux.h + */ + +#ifndef _LINUX_I2C_ATR_H +#define _LINUX_I2C_ATR_H + +#ifdef __KERNEL__ + +#include <linux/i2c.h> +#include <linux/mutex.h> + +struct i2c_atr; + +/** + * struct i2c_atr_ops - Callbacks from ATR to the device driver. + * @select: Ask the driver to select a child bus (optional) + * @deselect: Ask the driver to deselect a child bus (optional) + * @attach_client: Notify the driver of a new device connected on a child + * bus. The driver must choose an I2C alias, configure the + * hardware to use it and return it in `alias_id`. + * @detach_client: Notify the driver of a device getting disconnected. The + * driver must configure the hardware to stop using the + * alias. + * + * All these functions return 0 on success, a negative error code otherwise. + */ +struct i2c_atr_ops { + int (*select)(struct i2c_atr *atr, u32 chan_id); + int (*deselect)(struct i2c_atr *atr, u32 chan_id); + int (*attach_client)(struct i2c_atr *atr, u32 chan_id, + const struct i2c_board_info *info, + const struct i2c_client *client, + u16 *alias_id); + void (*detach_client)(struct i2c_atr *atr, u32 chan_id, + const struct i2c_client *client); +}; + +/** + * Helper to add I2C ATR features to a device driver. + */ +struct i2c_atr { + /* private: internal use only */ + + struct i2c_adapter *parent; + struct device *dev; + const struct i2c_atr_ops *ops; + + void *priv; + + struct i2c_algorithm algo; + struct mutex lock; + int max_adapters; + + struct i2c_adapter *adapter[0]; +}; + +struct i2c_atr *i2c_atr_new(struct i2c_adapter *parent, struct device *dev, + const struct i2c_atr_ops *ops, int max_adapters); +void i2c_atr_delete(struct i2c_atr *atr); + +static inline void i2c_atr_set_clientdata(struct i2c_atr *atr, void *data) +{ + atr->priv = data; +} + +static inline void *i2c_atr_get_clientdata(struct i2c_atr *atr) +{ + return atr->priv; +} + +int i2c_atr_add_adapter(struct i2c_atr *atr, u32 chan_id); +void i2c_atr_del_adapter(struct i2c_atr *atr, u32 chan_id); + +#endif /* __KERNEL__ */ + +#endif /* _LINUX_I2C_ATR_H */
An ATR is a device that looks similar to an i2c-mux: it has an I2C slave "upstream" port and N master "downstream" ports, and forwards transactions from upstream to the appropriate downstream port. But is is different in that the forwarded transaction has a different slave address. The address used on the upstream bus is called the "alias" and is (potentially) different from the physical slave address of the downstream chip. Add a helper file (just like i2c-mux.c for a mux or switch) to allow implementing ATR features in a device driver. The helper takes care or adapter creation/destruction and translates addresses at each transaction. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> --- Changes RFCv1 -> RFCv2: RFCv1 was implemented inside i2c-mux.c and added yet more complexity there. RFCv2 creates a new file on its own, i2c-atr.c. Since many ATR features are not in a MUX and vice versa, the overlapping is low. This was almost a complete rewrite, but for the records here are the main differences from the old implementation: - change bus description - remove I2C_ATR_ARBITRATOR and I2C_ATR_GATE support - select() optional - rename i2c_atr_alloc -> i2c_atr_new, add i2c_atr_delete, move to bottom - lock the ATR, not the adapter or the muxes on the adapter - remove parent-locked code - remove I2C_MUX_LOCKED flag, now unused - remove I2C_ATR_ATR flag (always true) - translation in i2c_atr_smbus_xfer too - i2c_atr_map_msgs: don't ignore mapping errors - always require the "i2c-atr" DT node, no magic - remove ACPI support - one algo in the atrc, not one per adapter - remove unneeded i2c_atr_root_adapter - ditch force_nr - don't allocate private user memory, just provide a plain userdata pointer - consolidate all ops in a single struct, simplify naming - remove adapters individually, allocate in atrc->adapter[chan_id] --- drivers/i2c/Kconfig | 9 + drivers/i2c/Makefile | 1 + drivers/i2c/i2c-atr.c | 557 ++++++++++++++++++++++++++++++++++++++++ include/linux/i2c-atr.h | 82 ++++++ 4 files changed, 649 insertions(+) create mode 100644 drivers/i2c/i2c-atr.c create mode 100644 include/linux/i2c-atr.h