platform/x86: i2c-multi-instantiate: Rename it for a generic serial driver name
authorLucas Tanure <tanureal@opensource.cirrus.com>
Fri, 21 Jan 2022 17:24:27 +0000 (17:24 +0000)
committerHans de Goede <hdegoede@redhat.com>
Wed, 2 Feb 2022 17:10:02 +0000 (18:10 +0100)
Rename I2C multi instantiate driver to serial-multi-instantiate for
upcoming addition of SPI support

Signed-off-by: Lucas Tanure <tanureal@opensource.cirrus.com>
Signed-off-by: Stefan Binding <sbinding@opensource.cirrus.com>
Link: https://lore.kernel.org/r/20220121172431.6876-6-sbinding@opensource.cirrus.com
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
MAINTAINERS
drivers/acpi/scan.c
drivers/platform/x86/Kconfig
drivers/platform/x86/Makefile
drivers/platform/x86/i2c-multi-instantiate.c [deleted file]
drivers/platform/x86/serial-multi-instantiate.c [new file with mode: 0644]

index ea3e6c91438481482cc36504187486aa64fec025..f51ff0a45c8c44544f1c72e164d825b31a6ceaf0 100644 (file)
@@ -388,11 +388,11 @@ L:        linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
 S:     Maintained
 F:     drivers/acpi/arm64
 
-ACPI I2C MULTI INSTANTIATE DRIVER
+ACPI SERIAL MULTI INSTANTIATE DRIVER
 M:     Hans de Goede <hdegoede@redhat.com>
 L:     platform-driver-x86@vger.kernel.org
 S:     Maintained
-F:     drivers/platform/x86/i2c-multi-instantiate.c
+F:     drivers/platform/x86/serial-multi-instantiate.c
 
 ACPI PCC(Platform Communication Channel) MAILBOX DRIVER
 M:     Sudeep Holla <sudeep.holla@arm.com>
index 1331756d4cfce0613d20cebebc4b059bd455c842..48db5e80c2dcccb61adb84b80b83e3d64756affb 100644 (file)
@@ -1734,12 +1734,13 @@ static bool acpi_device_enumeration_by_parent(struct acpi_device *device)
        bool is_serial_bus_slave = false;
        static const struct acpi_device_id ignore_serial_bus_ids[] = {
        /*
-        * These devices have multiple I2cSerialBus resources and an i2c-client
-        * must be instantiated for each, each with its own i2c_device_id.
-        * Normally we only instantiate an i2c-client for the first resource,
-        * using the ACPI HID as id. These special cases are handled by the
-        * drivers/platform/x86/i2c-multi-instantiate.c driver, which knows
-        * which i2c_device_id to use for each resource.
+        * These devices have multiple SerialBus resources and a client
+        * device must be instantiated for each of them, each with
+        * its own device id.
+        * Normally we only instantiate one client device for the first
+        * resource, using the ACPI HID as id. These special cases are handled
+        * by the drivers/platform/x86/serial-multi-instantiate.c driver, which
+        * knows which client device id to use for each resource.
         */
                {"BSG1160", },
                {"BSG2150", },
index 24deeeb29af21bff0432cbf5c5d8acc1cc3c551f..2e656909a8666eb9766d23fa6a9f075f2d5a30aa 100644 (file)
@@ -990,16 +990,16 @@ config TOPSTAR_LAPTOP
 
          If you have a Topstar laptop, say Y or M here.
 
-config I2C_MULTI_INSTANTIATE
-       tristate "I2C multi instantiate pseudo device driver"
+config SERIAL_MULTI_INSTANTIATE
+       tristate "Serial bus multi instantiate pseudo device driver"
        depends on I2C && ACPI
        help
-         Some ACPI-based systems list multiple i2c-devices in a single ACPI
-         firmware-node. This driver will instantiate separate i2c-clients
+         Some ACPI-based systems list multiple devices in a single ACPI
+         firmware-node. This driver will instantiate separate clients
          for each device in the firmware-node.
 
          To compile this driver as a module, choose M here: the module
-         will be called i2c-multi-instantiate.
+         will be called serial-multi-instantiate.
 
 config MLX_PLATFORM
        tristate "Mellanox Technologies platform support"
index c12a9b044fd872c40fba96e8d93eb6ca5881a196..9527088bba7fa7d02252fe0573eeac33f25afabd 100644 (file)
@@ -110,7 +110,7 @@ obj-$(CONFIG_TOPSTAR_LAPTOP)        += topstar-laptop.o
 
 # Platform drivers
 obj-$(CONFIG_FW_ATTR_CLASS)            += firmware_attributes_class.o
-obj-$(CONFIG_I2C_MULTI_INSTANTIATE)    += i2c-multi-instantiate.o
+obj-$(CONFIG_SERIAL_MULTI_INSTANTIATE) += serial-multi-instantiate.o
 obj-$(CONFIG_MLX_PLATFORM)             += mlx-platform.o
 obj-$(CONFIG_TOUCHSCREEN_DMI)          += touchscreen_dmi.o
 obj-$(CONFIG_WIRELESS_HOTKEY)          += wireless-hotkey.o
diff --git a/drivers/platform/x86/i2c-multi-instantiate.c b/drivers/platform/x86/i2c-multi-instantiate.c
deleted file mode 100644 (file)
index 4956a1d..0000000
+++ /dev/null
@@ -1,174 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0+
-/*
- * I2C multi-instantiate driver, pseudo driver to instantiate multiple
- * i2c-clients from a single fwnode.
- *
- * Copyright 2018 Hans de Goede <hdegoede@redhat.com>
- */
-
-#include <linux/acpi.h>
-#include <linux/bits.h>
-#include <linux/i2c.h>
-#include <linux/interrupt.h>
-#include <linux/kernel.h>
-#include <linux/module.h>
-#include <linux/platform_device.h>
-#include <linux/property.h>
-#include <linux/types.h>
-
-#define IRQ_RESOURCE_TYPE      GENMASK(1, 0)
-#define IRQ_RESOURCE_NONE      0
-#define IRQ_RESOURCE_GPIO      1
-#define IRQ_RESOURCE_APIC      2
-
-struct i2c_inst_data {
-       const char *type;
-       unsigned int flags;
-       int irq_idx;
-};
-
-struct i2c_multi_inst_data {
-       int num_clients;
-       struct i2c_client *clients[];
-};
-
-static int i2c_multi_inst_probe(struct platform_device *pdev)
-{
-       struct i2c_multi_inst_data *multi;
-       const struct i2c_inst_data *inst_data;
-       struct i2c_board_info board_info = {};
-       struct device *dev = &pdev->dev;
-       struct acpi_device *adev;
-       char name[32];
-       int i, ret;
-
-       inst_data = device_get_match_data(dev);
-       if (!inst_data) {
-               dev_err(dev, "Error ACPI match data is missing\n");
-               return -ENODEV;
-       }
-
-       adev = ACPI_COMPANION(dev);
-
-       /* Count number of clients to instantiate */
-       ret = i2c_acpi_client_count(adev);
-       if (ret < 0)
-               return ret;
-
-       multi = devm_kmalloc(dev, struct_size(multi, clients, ret), GFP_KERNEL);
-       if (!multi)
-               return -ENOMEM;
-
-       multi->num_clients = ret;
-
-       for (i = 0; i < multi->num_clients && inst_data[i].type; i++) {
-               memset(&board_info, 0, sizeof(board_info));
-               strlcpy(board_info.type, inst_data[i].type, I2C_NAME_SIZE);
-               snprintf(name, sizeof(name), "%s-%s.%d", dev_name(dev),
-                        inst_data[i].type, i);
-               board_info.dev_name = name;
-               switch (inst_data[i].flags & IRQ_RESOURCE_TYPE) {
-               case IRQ_RESOURCE_GPIO:
-                       ret = acpi_dev_gpio_irq_get(adev, inst_data[i].irq_idx);
-                       if (ret < 0) {
-                               dev_err(dev, "Error requesting irq at index %d: %d\n",
-                                       inst_data[i].irq_idx, ret);
-                               goto error;
-                       }
-                       board_info.irq = ret;
-                       break;
-               case IRQ_RESOURCE_APIC:
-                       ret = platform_get_irq(pdev, inst_data[i].irq_idx);
-                       if (ret < 0) {
-                               dev_dbg(dev, "Error requesting irq at index %d: %d\n",
-                                       inst_data[i].irq_idx, ret);
-                               goto error;
-                       }
-                       board_info.irq = ret;
-                       break;
-               default:
-                       board_info.irq = 0;
-                       break;
-               }
-               multi->clients[i] = i2c_acpi_new_device(dev, i, &board_info);
-               if (IS_ERR(multi->clients[i])) {
-                       ret = dev_err_probe(dev, PTR_ERR(multi->clients[i]),
-                                           "Error creating i2c-client, idx %d\n", i);
-                       goto error;
-               }
-       }
-       if (i < multi->num_clients) {
-               dev_err(dev, "Error finding driver, idx %d\n", i);
-               ret = -ENODEV;
-               goto error;
-       }
-
-       platform_set_drvdata(pdev, multi);
-       return 0;
-
-error:
-       while (--i >= 0)
-               i2c_unregister_device(multi->clients[i]);
-
-       return ret;
-}
-
-static int i2c_multi_inst_remove(struct platform_device *pdev)
-{
-       struct i2c_multi_inst_data *multi = platform_get_drvdata(pdev);
-       int i;
-
-       for (i = 0; i < multi->num_clients; i++)
-               i2c_unregister_device(multi->clients[i]);
-
-       return 0;
-}
-
-static const struct i2c_inst_data bsg1160_data[]  = {
-       { "bmc150_accel", IRQ_RESOURCE_GPIO, 0 },
-       { "bmc150_magn" },
-       { "bmg160" },
-       {}
-};
-
-static const struct i2c_inst_data bsg2150_data[]  = {
-       { "bmc150_accel", IRQ_RESOURCE_GPIO, 0 },
-       { "bmc150_magn" },
-       /* The resources describe a 3th client, but it is not really there. */
-       { "bsg2150_dummy_dev" },
-       {}
-};
-
-static const struct i2c_inst_data int3515_data[]  = {
-       { "tps6598x", IRQ_RESOURCE_APIC, 0 },
-       { "tps6598x", IRQ_RESOURCE_APIC, 1 },
-       { "tps6598x", IRQ_RESOURCE_APIC, 2 },
-       { "tps6598x", IRQ_RESOURCE_APIC, 3 },
-       {}
-};
-
-/*
- * Note new device-ids must also be added to i2c_multi_instantiate_ids in
- * drivers/acpi/scan.c: acpi_device_enumeration_by_parent().
- */
-static const struct acpi_device_id i2c_multi_inst_acpi_ids[] = {
-       { "BSG1160", (unsigned long)bsg1160_data },
-       { "BSG2150", (unsigned long)bsg2150_data },
-       { "INT3515", (unsigned long)int3515_data },
-       { }
-};
-MODULE_DEVICE_TABLE(acpi, i2c_multi_inst_acpi_ids);
-
-static struct platform_driver i2c_multi_inst_driver = {
-       .driver = {
-               .name = "I2C multi instantiate pseudo device driver",
-               .acpi_match_table = i2c_multi_inst_acpi_ids,
-       },
-       .probe = i2c_multi_inst_probe,
-       .remove = i2c_multi_inst_remove,
-};
-module_platform_driver(i2c_multi_inst_driver);
-
-MODULE_DESCRIPTION("I2C multi instantiate pseudo device driver");
-MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
-MODULE_LICENSE("GPL");
diff --git a/drivers/platform/x86/serial-multi-instantiate.c b/drivers/platform/x86/serial-multi-instantiate.c
new file mode 100644 (file)
index 0000000..9af5bcd
--- /dev/null
@@ -0,0 +1,173 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Serial multi-instantiate driver, pseudo driver to instantiate multiple
+ * client devices from a single fwnode.
+ *
+ * Copyright 2018 Hans de Goede <hdegoede@redhat.com>
+ */
+
+#include <linux/acpi.h>
+#include <linux/bits.h>
+#include <linux/i2c.h>
+#include <linux/interrupt.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/property.h>
+#include <linux/types.h>
+
+#define IRQ_RESOURCE_TYPE      GENMASK(1, 0)
+#define IRQ_RESOURCE_NONE      0
+#define IRQ_RESOURCE_GPIO      1
+#define IRQ_RESOURCE_APIC      2
+
+struct smi_instance {
+       const char *type;
+       unsigned int flags;
+       int irq_idx;
+};
+
+struct smi {
+       int i2c_num;
+       struct i2c_client *i2c_devs[];
+};
+
+static int smi_probe(struct platform_device *pdev)
+{
+       struct i2c_board_info board_info = {};
+       const struct smi_instance *inst;
+       struct device *dev = &pdev->dev;
+       struct acpi_device *adev;
+       struct smi *smi;
+       char name[32];
+       int i, ret;
+
+       inst = device_get_match_data(dev);
+       if (!inst) {
+               dev_err(dev, "Error ACPI match data is missing\n");
+               return -ENODEV;
+       }
+
+       adev = ACPI_COMPANION(dev);
+
+       /* Count number of clients to instantiate */
+       ret = i2c_acpi_client_count(adev);
+       if (ret < 0)
+               return ret;
+
+       smi = devm_kmalloc(dev, struct_size(smi, i2c_devs, ret), GFP_KERNEL);
+       if (!smi)
+               return -ENOMEM;
+
+       smi->i2c_num = ret;
+
+       for (i = 0; i < smi->i2c_num && inst[i].type; i++) {
+               memset(&board_info, 0, sizeof(board_info));
+               strlcpy(board_info.type, inst[i].type, I2C_NAME_SIZE);
+               snprintf(name, sizeof(name), "%s-%s.%d", dev_name(dev), inst[i].type, i);
+               board_info.dev_name = name;
+               switch (inst[i].flags & IRQ_RESOURCE_TYPE) {
+               case IRQ_RESOURCE_GPIO:
+                       ret = acpi_dev_gpio_irq_get(adev, inst[i].irq_idx);
+                       if (ret < 0) {
+                               dev_err(dev, "Error requesting irq at index %d: %d\n",
+                                               inst[i].irq_idx, ret);
+                               goto error;
+                       }
+                       board_info.irq = ret;
+                       break;
+               case IRQ_RESOURCE_APIC:
+                       ret = platform_get_irq(pdev, inst[i].irq_idx);
+                       if (ret < 0) {
+                               dev_dbg(dev, "Error requesting irq at index %d: %d\n",
+                                       inst[i].irq_idx, ret);
+                               goto error;
+                       }
+                       board_info.irq = ret;
+                       break;
+               default:
+                       board_info.irq = 0;
+                       break;
+               }
+               smi->i2c_devs[i] = i2c_acpi_new_device(dev, i, &board_info);
+               if (IS_ERR(smi->i2c_devs[i])) {
+                       ret = dev_err_probe(dev, PTR_ERR(smi->i2c_devs[i]),
+                                           "Error creating i2c-client, idx %d\n", i);
+                       goto error;
+               }
+       }
+       if (i < smi->i2c_num) {
+               dev_err(dev, "Error finding driver, idx %d\n", i);
+               ret = -ENODEV;
+               goto error;
+       }
+
+       platform_set_drvdata(pdev, smi);
+       return 0;
+
+error:
+       while (--i >= 0)
+               i2c_unregister_device(smi->i2c_devs[i]);
+
+       return ret;
+}
+
+static int smi_remove(struct platform_device *pdev)
+{
+       struct smi *smi = platform_get_drvdata(pdev);
+       int i;
+
+       for (i = 0; i < smi->i2c_num; i++)
+               i2c_unregister_device(smi->i2c_devs[i]);
+
+       return 0;
+}
+
+static const struct smi_instance bsg1160_data[]  = {
+       { "bmc150_accel", IRQ_RESOURCE_GPIO, 0 },
+       { "bmc150_magn" },
+       { "bmg160" },
+       {}
+};
+
+static const struct smi_instance bsg2150_data[]  = {
+       { "bmc150_accel", IRQ_RESOURCE_GPIO, 0 },
+       { "bmc150_magn" },
+       /* The resources describe a 3th client, but it is not really there. */
+       { "bsg2150_dummy_dev" },
+       {}
+};
+
+static const struct smi_instance int3515_data[]  = {
+       { "tps6598x", IRQ_RESOURCE_APIC, 0 },
+       { "tps6598x", IRQ_RESOURCE_APIC, 1 },
+       { "tps6598x", IRQ_RESOURCE_APIC, 2 },
+       { "tps6598x", IRQ_RESOURCE_APIC, 3 },
+       {}
+};
+
+/*
+ * Note new device-ids must also be added to ignore_serial_bus_ids in
+ * drivers/acpi/scan.c: acpi_device_enumeration_by_parent().
+ */
+static const struct acpi_device_id smi_acpi_ids[] = {
+       { "BSG1160", (unsigned long)bsg1160_data },
+       { "BSG2150", (unsigned long)bsg2150_data },
+       { "INT3515", (unsigned long)int3515_data },
+       { }
+};
+MODULE_DEVICE_TABLE(acpi, smi_acpi_ids);
+
+static struct platform_driver smi_driver = {
+       .driver = {
+               .name = "Serial bus multi instantiate pseudo device driver",
+               .acpi_match_table = smi_acpi_ids,
+       },
+       .probe = smi_probe,
+       .remove = smi_remove,
+};
+module_platform_driver(smi_driver);
+
+MODULE_DESCRIPTION("Serial multi instantiate pseudo device driver");
+MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
+MODULE_LICENSE("GPL");