Skip to contentSkip to conversation

platform/x86: add meraki-mx100 platform driver

PATCH Superseded Chris Blake 2 participants 4 messages Jul 6, 2021 – Aug 4, 2021

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 platform/x86: add meraki-mx100 platform driver

This adds platform support for the Cisco Meraki MX100 (Tinkerbell) network appliance. This sets up the network LEDs and Reset button. Note that this patch requires
mfd: lpc_ich: Enable GPIO driver for DH89xxCC which has been accepted and is currently targeted for 5.15.

---
 drivers/platform/x86/Kconfig        |  13 ++
 drivers/platform/x86/Makefile       |   3 +
 drivers/platform/x86/meraki-mx100.c | 185 ++++++++++++++++++++++++++++
 3 files changed, 201 insertions(+)
 create mode 100644 drivers/platform/x86/meraki-mx100.c
drivers/platform/x86/Kconfig +13 -0
index 7d385c3b2239..8d70176e335f 100644
@@ -302,6 +302,19 @@ config ASUS_NB_WMI
 	  If you have an ACPI-WMI compatible Asus Notebook, say Y or M
 	  here.
 
+config MERAKI_MX100
+	tristate "Cisco Meraki MX100 Platform Driver"
+	depends on GPIOLIB
+	depends on GPIO_ICH
+	depends on LEDS_CLASS
+	select LEDS_GPIO
+	help
+	  This driver provides support for the front button and LEDs on
+	  the Cisco Meraki MX100 (Tinkerbell) 1U appliance.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called meraki-mx100.
+
 config EEEPC_LAPTOP
 	tristate "Eee PC Hotkey Driver"
 	depends on ACPI
drivers/platform/x86/Makefile +3 -0
index 7ee369aab10d..25c5aee1cde7 100644
@@ -39,6 +39,9 @@ obj-$(CONFIG_ASUS_NB_WMI)	+= asus-nb-wmi.o
 obj-$(CONFIG_EEEPC_LAPTOP)	+= eeepc-laptop.o
 obj-$(CONFIG_EEEPC_WMI)		+= eeepc-wmi.o
 
+# Cisco/Meraki
+obj-$(CONFIG_MERAKI_MX100)	+= meraki-mx100.o
+
 # Dell
 obj-$(CONFIG_X86_PLATFORM_DRIVERS_DELL)		+= dell/
 
drivers/platform/x86/meraki-mx100.c new file +185 -0

185 lines not on this page · raw message

Signature · 1 line
2.25.1
author
#1 lore raw
Quoted 246 lines · Chris Blake

This adds platform support for the Cisco Meraki MX100 (Tinkerbell) network appliance. This sets up the network LEDs and Reset button. Note that this patch requires
mfd: lpc_ich: Enable GPIO driver for DH89xxCC which has been accepted and is currently targeted for 5.15.

---
 drivers/platform/x86/Kconfig        |  13 ++
 drivers/platform/x86/Makefile       |   3 +
 drivers/platform/x86/meraki-mx100.c | 185 ++++++++++++++++++++++++++++
 3 files changed, 201 insertions(+)
 create mode 100644 drivers/platform/x86/meraki-mx100.c
drivers/platform/x86/Kconfig +13 -0
index 7d385c3b2239..8d70176e335f 100644
@@ -302,6 +302,19 @@ config ASUS_NB_WMI
          If you have an ACPI-WMI compatible Asus Notebook, say Y or M
          here.
 
+config MERAKI_MX100
+       tristate "Cisco Meraki MX100 Platform Driver"
+       depends on GPIOLIB
+       depends on GPIO_ICH
+       depends on LEDS_CLASS
+       select LEDS_GPIO
+       help
+         This driver provides support for the front button and LEDs on
+         the Cisco Meraki MX100 (Tinkerbell) 1U appliance.
+
+         To compile this driver as a module, choose M here: the module
+         will be called meraki-mx100.
+
 config EEEPC_LAPTOP
        tristate "Eee PC Hotkey Driver"
        depends on ACPI
drivers/platform/x86/Makefile +3 -0
index 7ee369aab10d..25c5aee1cde7 100644
@@ -39,6 +39,9 @@ obj-$(CONFIG_ASUS_NB_WMI)     += asus-nb-wmi.o
 obj-$(CONFIG_EEEPC_LAPTOP)     += eeepc-laptop.o
 obj-$(CONFIG_EEEPC_WMI)                += eeepc-wmi.o
 
+# Cisco/Meraki
+obj-$(CONFIG_MERAKI_MX100)     += meraki-mx100.o
+
 # Dell
 obj-$(CONFIG_X86_PLATFORM_DRIVERS_DELL)                += dell/
 
drivers/platform/x86/meraki-mx100.c new file +185 -1
new file mode 100644
index 000000000000..12b17ef06d14
@@ -0,0 +1,185 @@
+// SPDX-License-Identifier: GPL-2.0+
+
+/*
+ * Cisco Meraki MX100 (Tinkerbell) board platform driver
+ *
+ * Based off of arch/x86/platform/meraki/tink.c from the
+ * Meraki GPL release meraki-firmware-sources-r23-20150601
+ *
+ * Format inspired by platform/x86/pcengines-apuv2.c
+ *
+ * Copyright (C) 2021 Chris Blake <[email protected]>
+ */
+
+#define pr_fmt(fmt)    KBUILD_MODNAME ": " fmt
+
+#include <linux/dmi.h>
+#include <linux/err.h>
+#include <linux/gpio.h>
+#include <linux/gpio_keys.h>
+#include <linux/input.h>
+#include <linux/kernel.h>
+#include <linux/leds.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+
+#define TINK_GPIO_OFFSET       436
+
+/* LEDs */
+static const struct gpio_led tink_leds[] = {
+       {
+               .name = "mx100:green:internet",
+               .gpio = TINK_GPIO_OFFSET + 11,
+               .active_low = 1,
+               .default_trigger = "default-on",
+       },
+       {
+               .name = "mx100:green:lan2",
+               .gpio = TINK_GPIO_OFFSET + 18,
+       },
+       {
+               .name = "mx100:green:lan3",
+               .gpio = TINK_GPIO_OFFSET + 20,
+       },
+       {
+               .name = "mx100:green:lan4",
+               .gpio = TINK_GPIO_OFFSET + 22,
+       },
+       {
+               .name = "mx100:green:lan5",
+               .gpio = TINK_GPIO_OFFSET + 23,
+       },
+       {
+               .name = "mx100:green:lan6",
+               .gpio = TINK_GPIO_OFFSET + 32,
+       },
+       {
+               .name = "mx100:green:lan7",
+               .gpio = TINK_GPIO_OFFSET + 34,
+       },
+       {
+               .name = "mx100:green:lan8",
+               .gpio = TINK_GPIO_OFFSET + 35,
+       },
+       {
+               .name = "mx100:green:lan9",
+               .gpio = TINK_GPIO_OFFSET + 36,
+       },
+       {
+               .name = "mx100:green:lan10",
+               .gpio = TINK_GPIO_OFFSET + 37,
+       },
+       {
+               .name = "mx100:green:lan11",
+               .gpio = TINK_GPIO_OFFSET + 48,
+       },
+       {
+               .name = "mx100:green:ha",
+               .gpio = TINK_GPIO_OFFSET + 16,
+               .active_low = 1,
+       },
+       {
+               .name = "mx100:orange:ha",
+               .gpio = TINK_GPIO_OFFSET + 7,
+               .active_low = 1,
+       },
+       {
+               .name = "mx100:green:usb",
+               .gpio = TINK_GPIO_OFFSET + 21,
+               .active_low = 1,
+       },
+       {
+               .name = "mx100:orange:usb",
+               .gpio = TINK_GPIO_OFFSET + 19,
+               .active_low = 1,
+       },
+};
+
+static const struct gpio_led_platform_data tink_leds_pdata = {
+       .num_leds       = ARRAY_SIZE(tink_leds),
+       .leds           = tink_leds,
+};
+
+/* Reset Button */
+static struct gpio_keys_button tink_buttons[] = {
+       {
+               .desc                   = "Reset",
+               .type                   = EV_KEY,
+               .code                   = KEY_RESTART,
+               .gpio                   = TINK_GPIO_OFFSET + 60,
+               .active_low             = 1,
+               .debounce_interval      = 100,
+       },
+};
+
+static const struct gpio_keys_platform_data tink_buttons_pdata = {
+       .buttons        = tink_buttons,
+       .nbuttons       = ARRAY_SIZE(tink_buttons),
+       .poll_interval  = 20,
+       .rep            = 0,
+       .name           = "mx100-keys",
+};
+
+/* Board setup */
+
+static struct platform_device *tink_leds_pdev;
+static struct platform_device *tink_keys_pdev;
+
+static struct platform_device * __init tink_create_dev(
+       const char *name,
+       const void *pdata,
+       size_t sz)
+{
+       struct platform_device *pdev;
+
+       pdev = platform_device_register_data(NULL,
+               name,
+               PLATFORM_DEVID_NONE,
+               pdata,
+               sz);
+
+       if (IS_ERR(pdev))
+               pr_err("failed registering %s: %ld\n", name, PTR_ERR(pdev));
+
+       return pdev;
+}
+
+static int __init tink_board_init(void)
+{
+       if (!dmi_match(DMI_SYS_VENDOR, "Cisco") || !dmi_match(DMI_PRODUCT_NAME, "MX100-HW")) {
+               return -ENODEV;
+       }
+
+       /* We need to make sure that GPIO60 isn't set to native mode as is default since it's our
+        * Reset Button. To do this, write to GPIO_USE_SEL2 to have GPIO60 set to GPIO mode.
+        * This is documented on page 1609 of the PCH datasheet, order number 327879-005US
+        */
+       outl(inl(0x530) | BIT(28), 0x530);
+
+       tink_leds_pdev = tink_create_dev(
+               "leds-gpio",
+               &tink_leds_pdata,
+               sizeof(tink_leds_pdata));
+
+       tink_keys_pdev = tink_create_dev(
+               "gpio-keys-polled",
+               &tink_buttons_pdata,
+               sizeof(tink_buttons_pdata));
+
+       return 0;
+}
+
+static void __exit tink_board_exit(void)
+{
+       platform_device_unregister(tink_keys_pdev);
+       platform_device_unregister(tink_leds_pdev);
+}
+
+module_init(tink_board_init);
+module_exit(tink_board_exit);
+
+MODULE_AUTHOR("Chris Blake <[email protected]>");
+MODULE_DESCRIPTION("Cisco Meraki MX100 Platform Driver");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS("platform:meraki-mx100");
+MODULE_SOFTDEP("pre: platform:gpio_ich platform:leds-gpio platform:gpio_keys_polled");
--
Quoted 2 lines

2.25.1

Hello,

Just following up to see what is required to get this reviewed. Thanks!

Regards,
Chris B

#2 lore raw
In reply to Chris Blake

Hi Chris,

Quoted 82 lines · Chris Blake

This adds platform support for the Cisco Meraki MX100 (Tinkerbell) network appliance. This sets up the network LEDs and Reset button. Note that this patch requires
mfd: lpc_ich: Enable GPIO driver for DH89xxCC which has been accepted and is currently targeted for 5.15.

---
 drivers/platform/x86/Kconfig        |  13 ++
 drivers/platform/x86/Makefile       |   3 +
 drivers/platform/x86/meraki-mx100.c | 185 ++++++++++++++++++++++++++++
 3 files changed, 201 insertions(+)
 create mode 100644 drivers/platform/x86/meraki-mx100.c
drivers/platform/x86/Kconfig +13 -0
index 7d385c3b2239..8d70176e335f 100644
@@ -302,6 +302,19 @@ config ASUS_NB_WMI
 	  If you have an ACPI-WMI compatible Asus Notebook, say Y or M
 	  here.
 
+config MERAKI_MX100
+	tristate "Cisco Meraki MX100 Platform Driver"
+	depends on GPIOLIB
+	depends on GPIO_ICH
+	depends on LEDS_CLASS
+	select LEDS_GPIO
+	help
+	  This driver provides support for the front button and LEDs on
+	  the Cisco Meraki MX100 (Tinkerbell) 1U appliance.
+
+	  To compile this driver as a module, choose M here: the module
+	  will be called meraki-mx100.
+
 config EEEPC_LAPTOP
 	tristate "Eee PC Hotkey Driver"
 	depends on ACPI
drivers/platform/x86/Makefile +3 -0
index 7ee369aab10d..25c5aee1cde7 100644
@@ -39,6 +39,9 @@ obj-$(CONFIG_ASUS_NB_WMI)	+= asus-nb-wmi.o
 obj-$(CONFIG_EEEPC_LAPTOP)	+= eeepc-laptop.o
 obj-$(CONFIG_EEEPC_WMI)		+= eeepc-wmi.o
 
+# Cisco/Meraki
+obj-$(CONFIG_MERAKI_MX100)	+= meraki-mx100.o
+
 # Dell
 obj-$(CONFIG_X86_PLATFORM_DRIVERS_DELL)		+= dell/
 
drivers/platform/x86/meraki-mx100.c new file +23 -0
new file mode 100644
index 000000000000..12b17ef06d14
@@ -0,0 +1,185 @@
+// SPDX-License-Identifier: GPL-2.0+
+
+/*
+ * Cisco Meraki MX100 (Tinkerbell) board platform driver
+ *
+ * Based off of arch/x86/platform/meraki/tink.c from the
+ * Meraki GPL release meraki-firmware-sources-r23-20150601
+ *
+ * Format inspired by platform/x86/pcengines-apuv2.c
+ *
+ * Copyright (C) 2021 Chris Blake <[email protected]>
+ */
+
+#define pr_fmt(fmt)	KBUILD_MODNAME ": " fmt
+
+#include <linux/dmi.h>
+#include <linux/err.h>
+#include <linux/gpio.h>
+#include <linux/gpio_keys.h>
+#include <linux/input.h>
+#include <linux/kernel.h>
+#include <linux/leds.h>
+#include <linux/module.h>

drivers/platform/x86/meraki-mx100.c line 33

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+#include <linux/platform_device.h>
+
+#define TINK_GPIO_OFFSET	436
+
+/* LEDs */
+static const struct gpio_led tink_leds[] = {
+	{
+		.name = "mx100:green:internet", 
+		.gpio = TINK_GPIO_OFFSET + 11,
+		.active_low = 1,

Unfortunately you cannot count on gpio-numbers on x86 devices being stable, so you need to drop all the .gpio = *and active_low* settings here, instead you need to create + add a gpiod lookup table looking like this:

static struct gpiod_lookup_table gpios_led_table = {
        .dev_id = "leds-gpio",
        .table = {
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 11,
                                NULL, 0, GPIO_ACTIVE_LOW),
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 18,
                                NULL, 1, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 20,
                                NULL, 2, GPIO_ACTIVE_HIGH),

Note the first set of numbers are the pin numbers on the TINK gpiochip.

The second set of numbers simply goes 0,1,2,3,4... and basically gives the indexes into your tink_leds[] array for which this lookup is.

You can use e.g. gpiodetect from libgpiod-utils to find the <TINK-gpiochip-dev_id>.

(I assume the GPIO_ACTIVE_FOO field explains itself)

Once you've created the table don't forget to register it with gpiod_add_lookup_table() and unregister it again on module remove.

Quoted 67 lines
drivers/platform/x86/meraki-mx100.c new file +67 -0
+		.default_trigger = "default-on",
+	},
+	{
+		.name = "mx100:green:lan2",
+		.gpio = TINK_GPIO_OFFSET + 18,
+	},
+	{
+		.name = "mx100:green:lan3",
+		.gpio = TINK_GPIO_OFFSET + 20,
+	},
+	{
+		.name = "mx100:green:lan4",
+		.gpio = TINK_GPIO_OFFSET + 22,
+	},
+	{
+		.name = "mx100:green:lan5",
+		.gpio = TINK_GPIO_OFFSET + 23,
+	},
+	{
+		.name = "mx100:green:lan6",
+		.gpio = TINK_GPIO_OFFSET + 32,
+	},
+	{
+		.name = "mx100:green:lan7",
+		.gpio = TINK_GPIO_OFFSET + 34,
+	},
+	{
+		.name = "mx100:green:lan8",
+		.gpio = TINK_GPIO_OFFSET + 35,
+	},
+	{
+		.name = "mx100:green:lan9",
+		.gpio = TINK_GPIO_OFFSET + 36,
+	},
+	{
+		.name = "mx100:green:lan10",
+		.gpio = TINK_GPIO_OFFSET + 37,
+	},
+	{
+		.name = "mx100:green:lan11",
+		.gpio = TINK_GPIO_OFFSET + 48,
+	},
+	{
+		.name = "mx100:green:ha",
+		.gpio = TINK_GPIO_OFFSET + 16,
+		.active_low = 1,
+	},
+	{
+		.name = "mx100:orange:ha",
+		.gpio = TINK_GPIO_OFFSET + 7,
+		.active_low = 1,
+	},
+	{
+		.name = "mx100:green:usb",
+		.gpio = TINK_GPIO_OFFSET + 21,
+		.active_low = 1,
+	},
+	{
+		.name = "mx100:orange:usb",
+		.gpio = TINK_GPIO_OFFSET + 19,
+		.active_low = 1,
+	},
+};
+
+static const struct gpio_led_platform_data tink_leds_pdata = {
+	.num_leds	= ARRAY_SIZE(tink_leds),
+	.leds		= tink_leds,

drivers/platform/x86/meraki-mx100.c line 110

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+};
+
+/* Reset Button */
+static struct gpio_keys_button tink_buttons[] = {
+	{
+		.desc			= "Reset",
+		.type			= EV_KEY,
+		.code			= KEY_RESTART,
+		.gpio			= TINK_GPIO_OFFSET + 60,
+		.active_low             = 1,

Same remark wrt hardcoding GPIO numbers. Note this needs a separate lookup table, see the pcengines-apuv2.c code.

Quoted 26 lines
drivers/platform/x86/meraki-mx100.c new file +26 -0
+		.debounce_interval      = 100,
+	},
+};
+
+static const struct gpio_keys_platform_data tink_buttons_pdata = {
+	.buttons	= tink_buttons,
+	.nbuttons	= ARRAY_SIZE(tink_buttons),
+	.poll_interval  = 20,
+	.rep		= 0,
+	.name		= "mx100-keys",
+};
+
+/* Board setup */
+
+static struct platform_device *tink_leds_pdev;
+static struct platform_device *tink_keys_pdev;
+
+static struct platform_device * __init tink_create_dev(
+	const char *name,
+	const void *pdata,
+	size_t sz)
+{
+	struct platform_device *pdev;
+
+	pdev = platform_device_register_data(NULL,
+		name,

drivers/platform/x86/meraki-mx100.c line 146

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+		PLATFORM_DEVID_NONE,
+		pdata,
+		sz);
+
+	if (IS_ERR(pdev))
+		pr_err("failed registering %s: %ld\n", name, PTR_ERR(pdev));
+
+	return pdev;
+}
+

You probably want to put the following here:

static const struct dmi_system_id tink_systems[] __initconst = {
	{
		.matches = {
			DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Cisco"),
			DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "MX100-HW"),
		},
	},
        {} /* Terminating entry */
};

MODULE_DEVICE_TABLE(dmi, tink_systems);

The MODULE_DEVICE_TABLE line will cause the module to get auto-loaded on the systems in the table.

drivers/platform/x86/meraki-mx100.c line 151

Quoted 5 lines
drivers/platform/x86/meraki-mx100.c new file +5 -0
+static int __init tink_board_init(void)
+{
+	if (!dmi_match(DMI_SYS_VENDOR, "Cisco") || !dmi_match(DMI_PRODUCT_NAME, "MX100-HW")) {
+		return -ENODEV;
+	}

And then replace this with:

	if (!dmi_first_match(tink_systems))
		return -ENODEV;

In case someone tries to load the module manually.

Quoted 25 lines
drivers/platform/x86/meraki-mx100.c new file +25 -0
+
+	/* We need to make sure that GPIO60 isn't set to native mode as is default since it's our 
+	 * Reset Button. To do this, write to GPIO_USE_SEL2 to have GPIO60 set to GPIO mode.
+	 * This is documented on page 1609 of the PCH datasheet, order number 327879-005US
+	 */
+	outl(inl(0x530) | BIT(28), 0x530);
+
+	tink_leds_pdev = tink_create_dev(
+		"leds-gpio",
+		&tink_leds_pdata,
+		sizeof(tink_leds_pdata));
+
+	tink_keys_pdev = tink_create_dev(
+		"gpio-keys-polled",
+		&tink_buttons_pdata,
+		sizeof(tink_buttons_pdata));
+
+	return 0;
+}
+
+static void __exit tink_board_exit(void)
+{
+	platform_device_unregister(tink_keys_pdev);
+	platform_device_unregister(tink_leds_pdev);
+}

drivers/platform/x86/meraki-mx100.c line 185

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +9 -0
+
+module_init(tink_board_init);
+module_exit(tink_board_exit);
+
+MODULE_AUTHOR("Chris Blake <[email protected]>");
+MODULE_DESCRIPTION("Cisco Meraki MX100 Platform Driver");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS("platform:meraki-mx100");
 
+MODULE_SOFTDEP("pre: platform:gpio_ich platform:leds-gpio platform:gpio_keys_polled");

This softdep line should not be necessary (once you use GPIO lookups) the creation of the platform devs will automatically cause the leds-gpio resp gpio_keyS_polled modules to get loaded.

Other then the remarks above this looks good to me.

Regards,

Hans

author
#3 lore raw
Quoted 314 lines · Hans de Goede

Hi Chris,

Quoted 82 lines · Chris Blake

This adds platform support for the Cisco Meraki MX100 (Tinkerbell) network appliance. This sets up the network LEDs and Reset button. Note that this patch requires
mfd: lpc_ich: Enable GPIO driver for DH89xxCC which has been accepted and is currently targeted for 5.15.

---
 drivers/platform/x86/Kconfig        |  13 ++
 drivers/platform/x86/Makefile       |   3 +
 drivers/platform/x86/meraki-mx100.c | 185 ++++++++++++++++++++++++++++
 3 files changed, 201 insertions(+)
 create mode 100644 drivers/platform/x86/meraki-mx100.c
drivers/platform/x86/Kconfig +13 -0
index 7d385c3b2239..8d70176e335f 100644
@@ -302,6 +302,19 @@ config ASUS_NB_WMI
        If you have an ACPI-WMI compatible Asus Notebook, say Y or M
        here.
 
+config MERAKI_MX100
+     tristate "Cisco Meraki MX100 Platform Driver"
+     depends on GPIOLIB
+     depends on GPIO_ICH
+     depends on LEDS_CLASS
+     select LEDS_GPIO
+     help
+       This driver provides support for the front button and LEDs on
+       the Cisco Meraki MX100 (Tinkerbell) 1U appliance.
+
+       To compile this driver as a module, choose M here: the module
+       will be called meraki-mx100.
+
 config EEEPC_LAPTOP
      tristate "Eee PC Hotkey Driver"
      depends on ACPI
drivers/platform/x86/Makefile +3 -0
index 7ee369aab10d..25c5aee1cde7 100644
@@ -39,6 +39,9 @@ obj-$(CONFIG_ASUS_NB_WMI)   += asus-nb-wmi.o
 obj-$(CONFIG_EEEPC_LAPTOP)   += eeepc-laptop.o
 obj-$(CONFIG_EEEPC_WMI)              += eeepc-wmi.o
 
+# Cisco/Meraki
+obj-$(CONFIG_MERAKI_MX100)   += meraki-mx100.o
+
 # Dell
 obj-$(CONFIG_X86_PLATFORM_DRIVERS_DELL)              += dell/
 
drivers/platform/x86/meraki-mx100.c new file +23 -0
new file mode 100644
index 000000000000..12b17ef06d14
@@ -0,0 +1,185 @@
+// SPDX-License-Identifier: GPL-2.0+
+
+/*
+ * Cisco Meraki MX100 (Tinkerbell) board platform driver
+ *
+ * Based off of arch/x86/platform/meraki/tink.c from the
+ * Meraki GPL release meraki-firmware-sources-r23-20150601
+ *
+ * Format inspired by platform/x86/pcengines-apuv2.c
+ *
+ * Copyright (C) 2021 Chris Blake <[email protected]>
+ */
+
+#define pr_fmt(fmt)  KBUILD_MODNAME ": " fmt
+
+#include <linux/dmi.h>
+#include <linux/err.h>
+#include <linux/gpio.h>
+#include <linux/gpio_keys.h>
+#include <linux/input.h>
+#include <linux/kernel.h>
+#include <linux/leds.h>
+#include <linux/module.h>

drivers/platform/x86/meraki-mx100.c line 33

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+#include <linux/platform_device.h>
+
+#define TINK_GPIO_OFFSET     436
+
+/* LEDs */
+static const struct gpio_led tink_leds[] = {
+     {
+             .name = "mx100:green:internet",
+             .gpio = TINK_GPIO_OFFSET + 11,
+             .active_low = 1,

Unfortunately you cannot count on gpio-numbers on x86 devices being stable, so you need to drop all the .gpio = *and active_low* settings here, instead you need to create + add a gpiod lookup table looking like this:

static struct gpiod_lookup_table gpios_led_table = {
        .dev_id = "leds-gpio",
        .table = {
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 11,
                                NULL, 0, GPIO_ACTIVE_LOW),
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 18,
                                NULL, 1, GPIO_ACTIVE_HIGH),
                GPIO_LOOKUP_IDX("<TINK-gpiochip-dev_id>", 20,
                                NULL, 2, GPIO_ACTIVE_HIGH),

Note the first set of numbers are the pin numbers on the TINK gpiochip.

The second set of numbers simply goes 0,1,2,3,4... and basically gives the indexes into your tink_leds[] array for which this lookup is.

You can use e.g. gpiodetect from libgpiod-utils to find the <TINK-gpiochip-dev_id>.

(I assume the GPIO_ACTIVE_FOO field explains itself)

Once you've created the table don't forget to register it with gpiod_add_lookup_table() and unregister it again on module remove.

Quoted 67 lines
drivers/platform/x86/meraki-mx100.c new file +67 -0
+             .default_trigger = "default-on",
+     },
+     {
+             .name = "mx100:green:lan2",
+             .gpio = TINK_GPIO_OFFSET + 18,
+     },
+     {
+             .name = "mx100:green:lan3",
+             .gpio = TINK_GPIO_OFFSET + 20,
+     },
+     {
+             .name = "mx100:green:lan4",
+             .gpio = TINK_GPIO_OFFSET + 22,
+     },
+     {
+             .name = "mx100:green:lan5",
+             .gpio = TINK_GPIO_OFFSET + 23,
+     },
+     {
+             .name = "mx100:green:lan6",
+             .gpio = TINK_GPIO_OFFSET + 32,
+     },
+     {
+             .name = "mx100:green:lan7",
+             .gpio = TINK_GPIO_OFFSET + 34,
+     },
+     {
+             .name = "mx100:green:lan8",
+             .gpio = TINK_GPIO_OFFSET + 35,
+     },
+     {
+             .name = "mx100:green:lan9",
+             .gpio = TINK_GPIO_OFFSET + 36,
+     },
+     {
+             .name = "mx100:green:lan10",
+             .gpio = TINK_GPIO_OFFSET + 37,
+     },
+     {
+             .name = "mx100:green:lan11",
+             .gpio = TINK_GPIO_OFFSET + 48,
+     },
+     {
+             .name = "mx100:green:ha",
+             .gpio = TINK_GPIO_OFFSET + 16,
+             .active_low = 1,
+     },
+     {
+             .name = "mx100:orange:ha",
+             .gpio = TINK_GPIO_OFFSET + 7,
+             .active_low = 1,
+     },
+     {
+             .name = "mx100:green:usb",
+             .gpio = TINK_GPIO_OFFSET + 21,
+             .active_low = 1,
+     },
+     {
+             .name = "mx100:orange:usb",
+             .gpio = TINK_GPIO_OFFSET + 19,
+             .active_low = 1,
+     },
+};
+
+static const struct gpio_led_platform_data tink_leds_pdata = {
+     .num_leds       = ARRAY_SIZE(tink_leds),
+     .leds           = tink_leds,

drivers/platform/x86/meraki-mx100.c line 110

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+};
+
+/* Reset Button */
+static struct gpio_keys_button tink_buttons[] = {
+     {
+             .desc                   = "Reset",
+             .type                   = EV_KEY,
+             .code                   = KEY_RESTART,
+             .gpio                   = TINK_GPIO_OFFSET + 60,
+             .active_low             = 1,

Same remark wrt hardcoding GPIO numbers. Note this needs a separate lookup table, see the pcengines-apuv2.c code.

Quoted 26 lines
drivers/platform/x86/meraki-mx100.c new file +26 -0
+             .debounce_interval      = 100,
+     },
+};
+
+static const struct gpio_keys_platform_data tink_buttons_pdata = {
+     .buttons        = tink_buttons,
+     .nbuttons       = ARRAY_SIZE(tink_buttons),
+     .poll_interval  = 20,
+     .rep            = 0,
+     .name           = "mx100-keys",
+};
+
+/* Board setup */
+
+static struct platform_device *tink_leds_pdev;
+static struct platform_device *tink_keys_pdev;
+
+static struct platform_device * __init tink_create_dev(
+     const char *name,
+     const void *pdata,
+     size_t sz)
+{
+     struct platform_device *pdev;
+
+     pdev = platform_device_register_data(NULL,
+             name,

drivers/platform/x86/meraki-mx100.c line 146

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +10 -0
+             PLATFORM_DEVID_NONE,
+             pdata,
+             sz);
+
+     if (IS_ERR(pdev))
+             pr_err("failed registering %s: %ld\n", name, PTR_ERR(pdev));
+
+     return pdev;
+}
+

You probably want to put the following here:

static const struct dmi_system_id tink_systems[] __initconst = {
        {
                .matches = {
                        DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Cisco"),
                        DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "MX100-HW"),
                },
        },
        {} /* Terminating entry */
};

MODULE_DEVICE_TABLE(dmi, tink_systems);

The MODULE_DEVICE_TABLE line will cause the module to get auto-loaded on the systems in the table.

drivers/platform/x86/meraki-mx100.c line 151

Quoted 5 lines
drivers/platform/x86/meraki-mx100.c new file +5 -0
+static int __init tink_board_init(void)
+{
+     if (!dmi_match(DMI_SYS_VENDOR, "Cisco") || !dmi_match(DMI_PRODUCT_NAME, "MX100-HW")) {
+             return -ENODEV;
+     }

And then replace this with:

        if (!dmi_first_match(tink_systems))
                return -ENODEV;

In case someone tries to load the module manually.

Quoted 25 lines
drivers/platform/x86/meraki-mx100.c new file +25 -0
+
+     /* We need to make sure that GPIO60 isn't set to native mode as is default since it's our
+      * Reset Button. To do this, write to GPIO_USE_SEL2 to have GPIO60 set to GPIO mode.
+      * This is documented on page 1609 of the PCH datasheet, order number 327879-005US
+      */
+     outl(inl(0x530) | BIT(28), 0x530);
+
+     tink_leds_pdev = tink_create_dev(
+             "leds-gpio",
+             &tink_leds_pdata,
+             sizeof(tink_leds_pdata));
+
+     tink_keys_pdev = tink_create_dev(
+             "gpio-keys-polled",
+             &tink_buttons_pdata,
+             sizeof(tink_buttons_pdata));
+
+     return 0;
+}
+
+static void __exit tink_board_exit(void)
+{
+     platform_device_unregister(tink_keys_pdev);
+     platform_device_unregister(tink_leds_pdev);
+}

drivers/platform/x86/meraki-mx100.c line 185

Quoted 10 lines
drivers/platform/x86/meraki-mx100.c new file +9 -0
+
+module_init(tink_board_init);
+module_exit(tink_board_exit);
+
+MODULE_AUTHOR("Chris Blake <[email protected]>");
+MODULE_DESCRIPTION("Cisco Meraki MX100 Platform Driver");
+MODULE_LICENSE("GPL");
+MODULE_ALIAS("platform:meraki-mx100");
 
+MODULE_SOFTDEP("pre: platform:gpio_ich platform:leds-gpio platform:gpio_keys_polled");

This softdep line should not be necessary (once you use GPIO lookups) the creation of the platform devs will automatically cause the leds-gpio resp gpio_keyS_polled modules to get loaded.

Quoted 6 lines

Other then the remarks above this looks good to me.

Regards,

Hans

Hello Hans,

Thank you so much for the feedback. I'll try to get a version 2 of this patch out sometime in the next week or so. I appreciate you taking the time to review this for me.

Regards,
Chris Blake