This modules is to allow for the new ITE 5632 EC chip
to support the watchdog for initial use in the Lenovo SE10
Signed-off-by: David Ober <dober6023@xxxxxxxxx>
V2 Fix stop to deactivate wdog on unload of module
V2 Remove extra logging that is not needed
V2 change udelays to usleep_range
V2 Changed to now request region on start and release on stop instead
of for every ping and read/write
V3 add counter to while loops so it will not hang
V3 rework code to use platform_device_register_simple
V3 rework getting the Chip ID to remove duplicate code and close IO
V3 change some extra logging to be debug only
---
drivers/watchdog/Kconfig | 10 ++
drivers/watchdog/Makefile | 1 +
drivers/watchdog/ite5632_wdt.c | 278 +++++++++++++++++++++++++++++++++
3 files changed, 289 insertions(+)
create mode 100644 drivers/watchdog/ite5632_wdt.c
diff --git a/drivers/watchdog/Kconfig b/drivers/watchdog/Kconfig
index ee97d89dfc11..861cc0eff468 100644
--- a/drivers/watchdog/Kconfig
+++ b/drivers/watchdog/Kconfig
@@ -264,6 +264,16 @@ config MENZ069_WATCHDOG
This driver can also be built as a module. If so the module
will be called menz069_wdt.
+config ITE5632_WDT
+ tristate "ITE 5632"
+ select WATCHDOG_CORE
+ help
+ If you say yes here you get support for the watchdog
+ functionality of the ITE 5632 eSIO chip.
+
+ This driver can also be built as a module. If so, the module
+ will be called ite5632_wdt.
+
config WDAT_WDT
tristate "ACPI Watchdog Action Table (WDAT)"
depends on ACPI
diff --git a/drivers/watchdog/Makefile b/drivers/watchdog/Makefile
index 3633f5b98236..32c8340f3175 100644
--- a/drivers/watchdog/Makefile
+++ b/drivers/watchdog/Makefile
@@ -119,6 +119,7 @@ obj-$(CONFIG_WAFER_WDT) += wafer5823wdt.o
obj-$(CONFIG_I6300ESB_WDT) += i6300esb.o
obj-$(CONFIG_IE6XX_WDT) += ie6xx_wdt.o
obj-$(CONFIG_ITCO_WDT) += iTCO_wdt.o
+obj-$(CONFIG_ITE5632_WDT) += ite5632_wdt.o
ifeq ($(CONFIG_ITCO_VENDOR_SUPPORT),y)
obj-$(CONFIG_ITCO_WDT) += iTCO_vendor_support.o
endif
diff --git a/drivers/watchdog/ite5632_wdt.c b/drivers/watchdog/ite5632_wdt.c
new file mode 100644
index 000000000000..efa0881eef4a
--- /dev/null
+++ b/drivers/watchdog/ite5632_wdt.c
@@ -0,0 +1,278 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Customized ITE5632 WDT driver for Lenovo SE10.
+ *
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include <linux/delay.h>
+#include <linux/init.h>
+#include <linux/io.h>
+#include <linux/ioport.h>
+#include <linux/module.h>
+#include <linux/moduleparam.h>
+#include <linux/platform_device.h>
+#include <linux/string.h>
+#include <linux/types.h>
+#include <linux/watchdog.h>
+
+#define ITE5632_SIO_UNLOCK_KEY 0x87
+#define ITE5632_SIO_LOCK_KEY 0xAA
+
+#define EC_STATUS_port 0x6C
+#define EC_CMD_port 0x6C
+#define EC_DATA_port 0x68
+#define EC_OBF 0x01
+#define EC_IBF 0x02
+#define CFG_LDN 0x07
+#define CFG_BRAM_LDN 0x10 /* for BRAM Base */
+#define CFG_PORT 0x2E
+
+#define CUS_WDT_SWI 0x1A
+#define CUS_WDT_CFG 0x1B
+#define CUS_WDT_FEED 0xB0
+#define CUS_WDT_CNT 0xB1
+
+#define DRVNAME "ite5632"
+
+/*The timeout range is 1-255 seconds*/
+#define MIN_TIMEOUT 1
+#define MAX_TIMEOUT 255
+#define MAX_WAIT 10
+
+#define WATCHDOG_TIMEOUT 60 /* 60 sec default timeout */
+static unsigned short bram_base;
+
+static int timeout; /* in seconds */
+module_param(timeout, int, 0);
+MODULE_PARM_DESC(timeout,
+ "Watchdog timeout in seconds. 1 <= timeout <= 255, default="
+ __MODULE_STRING(WATCHDOG_TIMEOUT) ".");
+
+static bool nowayout = WATCHDOG_NOWAYOUT;
+module_param(nowayout, bool, 0);
+MODULE_PARM_DESC(nowayout,
+ "Watchdog cannot be stopped once started (default="
+ __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
+
+/* the watchdog platform device */
+static struct platform_device *ite5632wdt_platform_device;
+
+/* Kernel methods. */
+static void set_bram(unsigned char offset, unsigned char val)
+{
+ outb(offset, bram_base);
+ outb(val, bram_base + 1);
+}
+
+/* wait EC output buffer full */
+static void wait_EC_OBF(void)
+{
+ int loop = 0;
+
+ while (1) {
+ if (inb(EC_STATUS_port) & EC_OBF || loop > MAX_WAIT)
+ break;
+ loop++;
+ usleep_range(10, 125);
+ }
+}
+
+/* wait EC input buffer empty */
+static void wait_EC_IBE(void)
+{
+ int loop = 0;
+
+ while (1) {
+ if (!(inb(EC_STATUS_port) & EC_IBF) || loop > MAX_WAIT)
+ break;
+ loop++;
+ usleep_range(10, 125);
+ }
+}
+
+static void send_EC_cmd(unsigned char eccmd)
+{
+ wait_EC_IBE();
+ outb(eccmd, EC_CMD_port);
+ wait_EC_IBE();
+}
+
+static unsigned char Read_EC_data(void)
+{
+ wait_EC_OBF();
+ return inb(EC_DATA_port);
+}
+
+static void LPC_Write_Byte(unsigned char index, unsigned char data)
+{
+ outb(index, CFG_PORT);
+ outb(data, CFG_PORT + 1);
+}
+
+static unsigned char LPC_Read_Byte(unsigned char index)
+{
+ outb(index, CFG_PORT);
+ return inb(CFG_PORT + 1);
+}
+
+static int GetChipID(void)
+{
+ unsigned char MSB, LSB;
+ unsigned char cmd = 0x55;
+
+ outb(ITE5632_SIO_UNLOCK_KEY, CFG_PORT);
+ outb(0x01, CFG_PORT);
+ outb(0x55, CFG_PORT);
+ outb(cmd, CFG_PORT);
+ MSB = LPC_Read_Byte(0x20);
+ LSB = LPC_Read_Byte(0x21);
+ outb(ITE5632_SIO_LOCK_KEY, CFG_PORT);
+ return (MSB * 256 + LSB);
+}
+
+static int wdt_start(struct watchdog_device *wdog)
+{
+ set_bram(CUS_WDT_SWI, 0x80);
+ return 0;
+}
+
+static int wdt_set_timeout(struct watchdog_device *wdog, unsigned int timeout)
+{
+ wdog->timeout = timeout;
+ set_bram(CUS_WDT_CFG, wdog->timeout);
+ return 0;
+}
+
+static int wdt_stop(struct watchdog_device *wdog)
+{
+ set_bram(CUS_WDT_SWI, 0);
+ return 0;
+}
+
+static unsigned int wdt_get_time(struct watchdog_device *wdog)
+{
+ unsigned int timeleft;
+
+ send_EC_cmd(CUS_WDT_CNT);
+
+ timeleft = Read_EC_data();
+ return timeleft;
+}
+
+static int wdt_ping(struct watchdog_device *wdog)
+{
+ send_EC_cmd(CUS_WDT_FEED);
+ return 0;
+}
+
+/* Kernel Interfaces */
+static const struct watchdog_info wdt_info = {
+ .options = WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE,
+ .identity = "5632 Watchdog",
+};
+
+static const struct watchdog_ops wdt_ops = {
+ .owner = THIS_MODULE,
+ .start = wdt_start,
+ .stop = wdt_stop,
+ .ping = wdt_ping,
+ .set_timeout = wdt_set_timeout,
+ .get_timeleft = wdt_get_time,
+};
+
+static int ite5632_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct watchdog_device *wdt;
+ int ret;
+
+ dev_dbg(&pdev->dev, "Probe ITE5632 called\n");
+
+ wdt = devm_kzalloc(dev, sizeof(*wdt), GFP_KERNEL);
+ if (!wdt) {
+ release_region(EC_DATA_port, 5);
+ return -ENOMEM;
+ }
+
+ wdt->info = &wdt_info,
+ wdt->ops = &wdt_ops,
+ wdt->timeout = WATCHDOG_TIMEOUT; /* Set default timeout */
+ wdt->min_timeout = MIN_TIMEOUT;
+ wdt->max_timeout = MAX_TIMEOUT;
+ wdt->parent = &pdev->dev;
+
+ watchdog_init_timeout(wdt, timeout, &pdev->dev);
+ watchdog_set_nowayout(wdt, nowayout);
+ watchdog_stop_on_reboot(wdt);
+ watchdog_stop_on_unregister(wdt);
+
+ ret = devm_watchdog_register_device(dev, wdt);
+
+ dev_dbg(&pdev->dev, "initialized. timeout=%d sec (nowayout=%d)\n",
+ wdt->timeout, nowayout);
+
+ return ret;
+}
+
+static struct platform_driver ite5632_driver = {
+ .driver = {
+ .name = DRVNAME,
+ },
+ .probe = ite5632_probe,
+};
+
+static int __init wdt_init(void)
+{
+ int err;
+ int chip;
+
+ if (!request_region(EC_DATA_port, 5, "EC")) {
+ pr_err(":request fail\n");
+ return -EIO;
+ }
+ chip = GetChipID();
+
+ if (chip != 0x5632) {
+ release_region(EC_DATA_port, 5);
+ return -ENODEV;
+ }
+ pr_info("Found ITE ChipID = %4X\n", chip);
+
+ LPC_Write_Byte(CFG_LDN, CFG_BRAM_LDN);
+ bram_base = (LPC_Read_Byte(0x60) << 8) | LPC_Read_Byte(0x61);
+
+ ite5632wdt_platform_device = platform_device_register_simple(DRVNAME,
+ -1, NULL, 0);
+ if (IS_ERR(ite5632wdt_platform_device)) {
+ release_region(EC_DATA_port, 5);
+ return PTR_ERR(ite5632wdt_platform_device);
+ }
+
+ err = platform_driver_probe(&ite5632_driver, ite5632_probe);
+ if (err)
+ goto unreg_platform_device;
+
+ return 0;
+
+unreg_platform_device:
+ platform_device_unregister(ite5632wdt_platform_device);
+ release_region(EC_DATA_port, 5);
+ return err;
+}
+
+static void __exit wdt_exit(void)
+{
+ platform_device_unregister(ite5632wdt_platform_device);
+ platform_driver_unregister(&ite5632_driver);
+
+ release_region(EC_DATA_port, 5);
+}
+
+module_init(wdt_init);
+module_exit(wdt_exit);
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("David Ober<dober@xxxxxxxxxx>");
+MODULE_DESCRIPTION("WDT driver for ITE5632");
--
2.34.1
