From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756814AbbFQVON (ORCPT ); Wed, 17 Jun 2015 17:14:13 -0400 Received: from mail-bl2on0133.outbound.protection.outlook.com ([65.55.169.133]:12353 "EHLO na01-bl2-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1751616AbbFQVOC (ORCPT ); Wed, 17 Jun 2015 17:14:02 -0400 Authentication-Results: spf=fail (sender IP is 192.88.158.2) smtp.mailfrom=freescale.com; nokia.com; dkim=none (message not signed) header.d=none; From: York Sun To: CC: , , York Sun , Paul Bolle , Peter Korsgaard , Alexander Sverdlin Subject: [Patch v2] driver/i2c/mux: Add register based mux i2c-mux-reg Date: Wed, 17 Jun 2015 14:13:53 -0700 Message-ID: <1434575634-27977-1-git-send-email-yorksun@freescale.com> X-Mailer: git-send-email 1.7.9.5 X-EOPAttributedMessage: 0 X-Microsoft-Exchange-Diagnostics: 1;BN1BFFO11FD008;1:gjg9+YQel8fEaux9v7B782Wb+SZJ1e95ldn3/Q4jkT9FVe+/azy09eZLF885uESaqJs0v0xlR2xtsbIdaumQGF1ax/Bg2E4l89QhK2qwXJLXTtB6X2CQMq5Qy5hlBo5OwvSNOsdxFIyh6mohhnxoCVosfG+w4/l0yVOJ6sHrFoZS1xKg4lFp8zbsOY0ZmDGD+5jXWSDaqzUylzxCZM1mqZCvBC1JXi0Ur+4RIeaL4BvsbRAxYhsYDIsMuESn6to+qCvGDylROEIuFwH5m4VQaj4yLQbkmcWrZUldcwAmMSjohBi0uz4diUs/7/gMBhAWqTmSuJWMDYsvIurC5oFi91yBRDwSKLQHaGBpHEnKMAo= X-Forefront-Antispam-Report: CIP:192.88.158.2;CTRY:US;IPV:NLI;EFV:NLI;SFV:NSPM;SFS:(10019020)(6009001)(2970300002)(339900001)(54534003)(479174004)(189002)(199003)(105606002)(6806004)(230783001)(19580405001)(47776003)(50466002)(19580395003)(48376002)(46102003)(85426001)(50226001)(87936001)(229853001)(104016003)(33646002)(106466001)(2351001)(189998001)(5001920100001)(110136002)(36756003)(5001960100002)(86362001)(92566002)(77156002)(50986999)(77096005)(62966003)(2004002);DIR:OUT;SFP:1102;SCL:1;SRVR:BL2PR03MB147;H:az84smr01.freescale.net;FPR:;SPF:Fail;MLV:ovrnspm;MX:3;A:1;PTR:InfoDomainNonexistent;LANG:en; MIME-Version: 1.0 Content-Type: text/plain X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB147;2:BZyrxvKodglIB5NOQFqbsEOYyHj0d8JDOWqBVkScKktvSWPtHrzlHNSbKgK18t6o;2:UURSmvN5CZTEVVOAXA/M1pQ7+VjTeBn7F79pLIsYl4+0NnUbGEnDkDZmjQID8T2NpzghczGRz6Hvg/Sm0zFqrTvY6RXGIPw9/9Wn8PKWyuM0lLWCdQzFLm2qIcXbsaGVySn0bCJdeM2K+6bcadYiGNTzJbznKu2IkLfwlfx6oWLx6Vzwuv+ad5U6iZEbpbhK8qpBsvPQphyzRYIZBCzgBBmVwd8DdgvR6kZqRupll9o=;6:7+efH02/L1JCbsyKJ4wz8KmYRXoWvXrZOn4x66xexHrl0CUUjxDWft/T/BF9nbuk4vuZIlt2+eEBVJ2Fry89HpwzhmZET7zTsD5Jn2s/CZuoBoA1dZUDgpliQd+90WAGDZut738UW5n8SrP9JenbPuXqdaQ9MxzxUTns5U8KT7r98woXLMkZK6CrH8Cso9oXfQNpcXYEiHHmTwKqIXvxJZF8Y1b+QifuppQNITjMix6ETguK5QcPrMvHFgoZbeMmi02litcMKWmjVhe1X+P1mEuEUz69lqVSADTnsovi5uy7m9/NnIXazEnoUP9pqV8D8b8wLVbf/YM3ORxH9nhs6g==;3:c91zf6INxz/JDuX//wetCixF2OVg8w/6PnJ2WyBKlosb0JbbTBBUgv1J5CGgsa3EG/oSXFnaXQ+3U5vpx72I2OVhKjYMPykCxMz4+QEyu+8gzfznrzmrNDrBjguwmVIg9TvSxRNdRfCFpauouDH/DSuJ/PRoAnnCyLC0UfInAjraj5qGSYcy4P6oJ6rv5NbXhwUzfXltySb/sjEhE6KTfiLW+N7+RIR41pMjdGRIb5XJJ5Ztja1G/akab64r+vgF0Set59Plw8TvCXI4qOfAKwivxQZtnrklpxz1qK5BNLZkDkFPcpZm1k9hY14OxGz1 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BL2PR03MB147; X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0;PCL:0;RULEID:(601004)(520003)(5005006)(3002001);SRVR:BL2PR03MB147;BCL:0;PCL:0;RULEID:;SRVR:BL2PR03MB147; X-Forefront-PRVS: 0610D16BBE X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB147;9:n2dbCgCxTrYeLbaZZ4svbUmeWnDKiD4T1F0sKW6a8jOs2R80ZOum0IEjvoAJ2RhfeolDM5+fDTjwnx5E6Ok96cw1Hc+YlR/+tcYj9EVO44XV5vadDJ8hpBUAH0DugvHCnUpEuoYy38OyjF6LZHvNqYdO9CZm5KCTAQU/pf1cktLbnYrjLcz0AueIZIRRQQVYViwghMbf7L+PVLl7isOYNnh1UTa+4XxZVBEeuOR2eNM/+MQ07CKIlte73qCE9ToDdAI7XPZUeyyD+WIzX9zdlwHN8RzWjiCHNCyju08YLrNWjaOisdNNAeGRZ5W9iSqxQ6/kpxKwwYiZvQNfoyk4vD1GGdjewleyz/Cwx68ytP86uaugqu9S1pdeCrtVVupk9iAbKyrFs4KYjW1JGP5cYuDaBpGU4DmVC/5AwUIFMo7JJP5OY8lATg3h55EP8qlBjQykuI7as9OfUo2NzkCDf3afskjqea4hAXpji4CaxjOQx7a75dhH5kZnpCp09nheJxKqHyWpvac8jgsetwcA1uPUiKKLQ5xA7JyYUS+1HBkZaHPlu/Im5FDyMpqBNGh5q+n3xtShfhCVkpGzbBKVVwgA12yh7yG7+xfkujQ7eeT5MwRL1zZ7Ufzs0h8Ktm0LKN1yZAsNTC4Qz8UEkUhiQ3gvuP3lMIZSGER2y2hEaAER1w5wpcu9zhouboxbQkNKSzBLBiDF3APuGR8/J59xtYdRtT8fu08GukSXMYfYFhn87qWE56NTur9dTrWyPlSY6oAM0NeSXEXtzdjgBoG9pfB67cfpPKt1x0GVv/bUquPrXahZMxYbrmtfgDT3TD0yIjJfneypYE/zSm5FUsqQdWHFyOh9t2IsrzSH22GcRJIA/l9vkClCI7de3goCG5IFlLCD9F3lVu56zDzCEczJOgG8FV1cTyjtrkGTaD5XAZV7+Wl68JmFReHdSwv6fZkO X-Microsoft-Exchange-Diagnostics: 1;BL2PR03MB147;3:m4MujM236Im5S1cDWny8t85XM36Pcg+DssV7T9utXkYEbMF34iw2NAz6bcLV7pldiWETKJEtKzqF0zFEu8tCpAZpkm6YxgA46DPSP4iitThVZP4JabSO6XwCEDffcTOeMuOJQDcWkW1wxCGlKf5l4A==;10:Kh5n2qI6hszPAuNtiNdaXPxcbItDN3ENwfnRAAg4LPgoHVXeCJaau3Qi6XY73Jm0dHGo6KpVnqLGxSxIT3BwBkDT9JHS7q9E4BnvLvMZ4LA=;6:xILX5TN/I2kBdwQnopoSpKgwYs47KOyz2VPvPCNLunl/z4tYP7HBTHSszwDuyYxA X-OriginatorOrg: freescale.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Jun 2015 21:13:58.5623 (UTC) X-MS-Exchange-CrossTenant-Id: 710a03f5-10f6-4d38-9ff4-a80b81da590d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=710a03f5-10f6-4d38-9ff4-a80b81da590d;Ip=[192.88.158.2];Helo=[az84smr01.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL2PR03MB147 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Based on i2c-mux-gpio driver, similarly the register based mux switch from one bus to another by setting a single register. The register can be on PCIe bus, local bus, or any memory-mapped address. Signed-off-by: York Sun CC: Wolfram Sang CC: Paul Bolle CC: Peter Korsgaard CC: Alexander Sverdlin --- Change log: v2: Update to GPLv2+ licence header Use iowrite instead of direct dereference the pointer to write register Add support of difference register size of 1/2/4 bytes Remove i2c_put_adapter(parent) in probe fucntion Replace multiple dev_info() with dev_dbg() Add idle_in_use variable to gate using idle value Add __iomem for register pointer Move platform data header file to include/linux/platform_data/ .../devicetree/bindings/i2c/i2c-mux-reg.txt | 71 ++++++ drivers/i2c/muxes/Kconfig | 11 + drivers/i2c/muxes/Makefile | 1 + drivers/i2c/muxes/i2c-mux-reg.c | 266 ++++++++++++++++++++ include/linux/platform_data/i2c-mux-reg.h | 40 +++ 5 files changed, 389 insertions(+) create mode 100644 Documentation/devicetree/bindings/i2c/i2c-mux-reg.txt create mode 100644 drivers/i2c/muxes/i2c-mux-reg.c create mode 100644 include/linux/platform_data/i2c-mux-reg.h diff --git a/Documentation/devicetree/bindings/i2c/i2c-mux-reg.txt b/Documentation/devicetree/bindings/i2c/i2c-mux-reg.txt new file mode 100644 index 0000000..b685d6c --- /dev/null +++ b/Documentation/devicetree/bindings/i2c/i2c-mux-reg.txt @@ -0,0 +1,71 @@ +Register-based I2C Bus Mux + +This binding describes an I2C bus multiplexer that uses a single register +to route the I2C signals. + +Required properties: +- compatible: i2c-mux-reg +- i2c-parent: The phandle of the I2C bus that this multiplexer's master-side + port is connected to. +* Standard I2C mux properties. See mux.txt in this directory. +* I2C child bus nodes. See mux.txt in this directory. + +Optional properties: +- reg: this pair of specifies the register to control the mux. + The depends on its parent node. It can be any memory-mapped + address. The size must be either 1, 2, or 4 bytes. If reg is omitted, the + resource of this device will be used. +- idle-state: value to set the muxer to when idle. When no value is + given, it defaults to the last value used. + +For each i2c child node, an I2C child bus will be created. They will +be numbered based on their order in the device tree. + +Whenever an access is made to a device on a child bus, the value set +in the revelant node's reg property will be output to the register. + +If an idle state is defined, using the idle-state (optional) property, +whenever an access is not being made to a device on a child bus, the +register will be set according to the idle value. + +If an idle state is not defined, the most recently used value will be +left programmed into the register. + +Example of a mux on PCIe card, the host is a powerpc SoC (big endian): + + i2c-mux { + /* the depends on the address translation + * of the parent device. If omitted, device resource + * will be used instead. The size is to determine + * whether iowrite32, iowrite16, or iowrite8 will be used. + */ + reg = <0x6028 0x4>; + compatible = "i2c-mux-reg"; + #address-cells = <1>; + #size-cells = <0>; + i2c-parent = <&i2c1>; + i2c@0 { + reg = <0>; + #address-cells = <1>; + #size-cells = <0>; + + si5338: clock-generator@70 { + compatible = "silabs,si5338"; + reg = <0x70>; + /* other stuff */ + }; + }; + + i2c@1 { + /* data is written using iowrite32 */ + reg = <1>; + #address-cells = <1>; + #size-cells = <0>; + + si5338: clock-generator@70 { + compatible = "silabs,si5338"; + reg = <0x70>; + /* other stuff */ + }; + }; + }; diff --git a/drivers/i2c/muxes/Kconfig b/drivers/i2c/muxes/Kconfig index f6d313e..77c1257 100644 --- a/drivers/i2c/muxes/Kconfig +++ b/drivers/i2c/muxes/Kconfig @@ -29,6 +29,17 @@ config I2C_MUX_GPIO This driver can also be built as a module. If so, the module will be called i2c-mux-gpio. +config I2C_MUX_REG + tristate "Register-based I2C multiplexer" + help + If you say yes to this option, support will be included for a + register based I2C multiplexer. This driver provides access to + I2C busses connected through a MUX, which is controlled + by a sinple register. + + This driver can also be built as a module. If so, the module + will be called i2c-mux-reg. + config I2C_MUX_PCA9541 tristate "NXP PCA9541 I2C Master Selector" help diff --git a/drivers/i2c/muxes/Makefile b/drivers/i2c/muxes/Makefile index 465778b..bc517bb 100644 --- a/drivers/i2c/muxes/Makefile +++ b/drivers/i2c/muxes/Makefile @@ -4,6 +4,7 @@ obj-$(CONFIG_I2C_ARB_GPIO_CHALLENGE) += i2c-arb-gpio-challenge.o obj-$(CONFIG_I2C_MUX_GPIO) += i2c-mux-gpio.o +obj-$(CONFIG_I2C_MUX_REG) += i2c-mux-reg.o obj-$(CONFIG_I2C_MUX_PCA9541) += i2c-mux-pca9541.o obj-$(CONFIG_I2C_MUX_PCA954x) += i2c-mux-pca954x.o obj-$(CONFIG_I2C_MUX_PINCTRL) += i2c-mux-pinctrl.o diff --git a/drivers/i2c/muxes/i2c-mux-reg.c b/drivers/i2c/muxes/i2c-mux-reg.c new file mode 100644 index 0000000..e5b5838 --- /dev/null +++ b/drivers/i2c/muxes/i2c-mux-reg.c @@ -0,0 +1,266 @@ +/* + * I2C multiplexer using a single register + * + * Copyright 2015 Freescale Semiconductor + * York Sun + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +struct regmux { + struct i2c_adapter *parent; + struct i2c_adapter **adap; /* child busses */ + struct i2c_mux_reg_platform_data data; +}; + +static int i2c_mux_reg_set(const struct regmux *mux, unsigned int chan) +{ + if (!mux->data.reg || chan < 0 || chan > mux->data.n_values) + return -EINVAL; + + switch (mux->data.reg_size) { + case 4: + iowrite32(mux->data.values[chan], mux->data.reg); + break; + case 2: + iowrite16(mux->data.values[chan], mux->data.reg); + break; + case 1: + iowrite8(mux->data.values[chan], mux->data.reg); + break; + default: + pr_err("Invalid register size\n"); + return -EINVAL; + } + + return 0; +} + +static int i2c_mux_reg_select(struct i2c_adapter *adap, void *data, + unsigned int chan) +{ + struct regmux *mux = data; + + return i2c_mux_reg_set(mux, chan); +} + +static int i2c_mux_reg_deselect(struct i2c_adapter *adap, void *data, + unsigned int chan) +{ + struct regmux *mux = data; + + if (mux->data.idle_in_use) + return i2c_mux_reg_set(mux, mux->data.idle); + + return 0; +} + +#ifdef CONFIG_OF +static int i2c_mux_reg_probe_dt(struct regmux *mux, + struct platform_device *pdev) +{ + struct device_node *np = pdev->dev.of_node; + struct device_node *adapter_np, *child; + struct i2c_adapter *adapter; + struct resource res; + unsigned *values; + int i = 0; + + if (!np) + return -ENODEV; + + adapter_np = of_parse_phandle(np, "i2c-parent", 0); + if (!adapter_np) { + dev_err(&pdev->dev, "Cannot parse i2c-parent\n"); + return -ENODEV; + } + adapter = of_find_i2c_adapter_by_node(adapter_np); + if (!adapter) { + dev_err(&pdev->dev, "Cannot find parent bus\n"); + return -EPROBE_DEFER; + } + mux->parent = adapter; + mux->data.parent = i2c_adapter_id(adapter); + put_device(&adapter->dev); + + mux->data.n_values = of_get_child_count(np); + + values = devm_kzalloc(&pdev->dev, + sizeof(*mux->data.values) * mux->data.n_values, + GFP_KERNEL); + if (!values) { + dev_err(&pdev->dev, "Cannot allocate values array"); + return -ENOMEM; + } + + for_each_child_of_node(np, child) { + of_property_read_u32(child, "reg", values + i); + i++; + } + mux->data.values = values; + + if (!of_property_read_u32(np, "idle-state", &mux->data.idle)) + mux->data.idle_in_use = true; + + /* map address from "reg" if exists */ + if (of_address_to_resource(np, 0, &res)) { + mux->data.reg_size = resource_size(&res); + if (mux->data.reg_size > 4) { + dev_err(&pdev->dev, "Invalid address size\n"); + return -EINVAL; + } + mux->data.reg = devm_ioremap_resource(&pdev->dev, &res); + if (IS_ERR(mux->data.reg)) + return PTR_ERR(mux->data.reg); + } + + return 0; +} +#else +static int i2c_mux_reg_probe_dt(struct gpiomux *mux, + struct platform_device *pdev) +{ + return 0; +} +#endif + +static int i2c_mux_reg_probe(struct platform_device *pdev) +{ + struct regmux *mux; + struct i2c_adapter *parent; + struct resource *res; + int (*deselect)(struct i2c_adapter *, void *, u32); + unsigned int initial_state, class; + int i, ret, nr; + + mux = devm_kzalloc(&pdev->dev, sizeof(*mux), GFP_KERNEL); + if (!mux) + return -ENOMEM; + + platform_set_drvdata(pdev, mux); + + if (dev_get_platdata(&pdev->dev)) { + memcpy(&mux->data, dev_get_platdata(&pdev->dev), + sizeof(mux->data)); + + parent = i2c_get_adapter(mux->data.parent); + if (!parent) { + dev_err(&pdev->dev, "Parent adapter (%d) not found\n", + mux->data.parent); + return -EPROBE_DEFER; + } + mux->parent = parent; + } else { + ret = i2c_mux_reg_probe_dt(mux, pdev); + if (ret < 0) { + dev_err(&pdev->dev, "Error parsing device tree"); + return ret; + } + } + + if (!mux->data.reg) { + dev_info(&pdev->dev, + "Register not set, using platform resource\n"); + res = platform_get_resource(pdev, IORESOURCE_MEM, 0); + mux->data.reg_size = resource_size(res); + if (mux->data.reg_size > 4) { + dev_err(&pdev->dev, "Invalid resource size\n"); + return -EINVAL; + } + mux->data.reg = devm_ioremap_resource(&pdev->dev, res); + if (IS_ERR(mux->data.reg)) + return PTR_ERR(mux->data.reg); + } + + mux->adap = devm_kzalloc(&pdev->dev, + sizeof(*mux->adap) * mux->data.n_values, + GFP_KERNEL); + if (!mux->adap) { + dev_err(&pdev->dev, "Cannot allocate i2c_adapter structure"); + return -ENOMEM; + } + + if (mux->data.idle_in_use) { + initial_state = mux->data.idle; + deselect = i2c_mux_reg_deselect; + } else { + initial_state = mux->data.values[0]; + deselect = NULL; + } + + for (i = 0; i < mux->data.n_values; i++) { + nr = mux->data.base_nr ? (mux->data.base_nr + i) : 0; + class = mux->data.classes ? mux->data.classes[i] : 0; + + mux->adap[i] = i2c_add_mux_adapter(mux->parent, &pdev->dev, mux, + nr, mux->data.values[i], + class, i2c_mux_reg_select, + deselect); + if (!mux->adap[i]) { + ret = -ENODEV; + dev_err(&pdev->dev, "Failed to add adapter %d\n", i); + goto add_adapter_failed; + } + } + + dev_dbg(&pdev->dev, "%d port mux on %s adapter\n", + mux->data.n_values, mux->parent->name); + + return 0; + +add_adapter_failed: + for (; i > 0; i--) + i2c_del_mux_adapter(mux->adap[i - 1]); + + return ret; +} + +static int i2c_mux_reg_remove(struct platform_device *pdev) +{ + struct regmux *mux = platform_get_drvdata(pdev); + int i; + + for (i = 0; i < mux->data.n_values; i++) + i2c_del_mux_adapter(mux->adap[i]); + + i2c_put_adapter(mux->parent); + + dev_dbg(&pdev->dev, "Removed\n"); + + return 0; +} + +static const struct of_device_id i2c_mux_reg_of_match[] = { + { .compatible = "i2c-mux-reg", }, + {}, +}; +MODULE_DEVICE_TABLE(of, i2c_mux_reg_of_match); + +static struct platform_driver i2c_mux_reg_driver = { + .probe = i2c_mux_reg_probe, + .remove = i2c_mux_reg_remove, + .driver = { + .owner = THIS_MODULE, + .name = "i2c-mux-reg", + }, +}; + +module_platform_driver(i2c_mux_reg_driver); + +MODULE_DESCRIPTION("Register-based I2C multiplexer driver"); +MODULE_AUTHOR("York Sun "); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:i2c-mux-reg"); diff --git a/include/linux/platform_data/i2c-mux-reg.h b/include/linux/platform_data/i2c-mux-reg.h new file mode 100644 index 0000000..c9c2423 --- /dev/null +++ b/include/linux/platform_data/i2c-mux-reg.h @@ -0,0 +1,40 @@ +/* + * I2C multiplexer using a single register + * + * Copyright 2015 Freescale Semiconductor + * York Sun + * + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License as published by the + * Free Software Foundation; either version 2 of the License, or (at your + * option) any later version. + */ + +#ifndef __LINUX_PLATFORM_DATA_I2C_MUX_REG_H +#define __LINUX_PLATFORM_DATA_I2C_MUX_REG_H + +/** + * struct i2c_mux_reg_platform_data - Platform-dependent data for i2c-mux-reg + * @parent: Parent I2C bus adapter number + * @base_nr: Base I2C bus number to number adapters from or zero for dynamic + * @values: Array of value for each channel + * @n_values: Number of multiplexer channels + * @classes: Optional I2C auto-detection classes + * @idle: Value to write to mux when idle + * @idle_in_use: indicate if idle value is in use + * @reg: Virtual address of the register to switch channel + * @reg_size: register size in bytes + */ +struct i2c_mux_reg_platform_data { + int parent; + int base_nr; + const unsigned int *values; + int n_values; + const unsigned int *classes; + u32 idle; + bool idle_in_use; + void __iomem *reg; + resource_size_t reg_size; +}; + +#endif /* __LINUX_PLATFORM_DATA_I2C_MUX_REG_H */ -- 1.7.9.5