From patchwork Tue Feb 25 08:16:38 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 868475 Received: from mail-pl1-f177.google.com (mail-pl1-f177.google.com [209.85.214.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C8957260A3E; Tue, 25 Feb 2025 08:17:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.177 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471428; cv=none; b=MmGc3Ym605KOs0MHPajClFN9a9p5wuy5hgQA7d2qF38zPyZYQLY5uuY7MhnMjY2ZAHwug7qIXQQlkeYLb356KR5i1FXWLLc5vUQUxcJLtxC1bn8N+ypsdIgmMm930IMUA//a39wu86LFI46R7I84T71L4dSAeLyhHLgYrCpOOn0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471428; c=relaxed/simple; bh=wTcgAHgfFWIybvNMH9edu2N5qLgonbm8NVaOy5eTAdo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=h92TPg0ejl4jaI5z+7ZnJjWCZU4wgCki0AvR4q0MJhheNtQ09w52itHKNDF5idbAeTTK2Wtuek1Rhq8i+6Kjq9BQ/s5D8CX5xzKhet4ystiubpsZJObhYQco7VasODGg6ADywnYtPEsVKHqrfHsFSf0HUiyGfhOE03cEOHd7lsQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=akAhGlSZ; arc=none smtp.client-ip=209.85.214.177 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="akAhGlSZ" Received: by mail-pl1-f177.google.com with SMTP id d9443c01a7336-2212a930001so31449525ad.0; Tue, 25 Feb 2025 00:17:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740471426; x=1741076226; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=T9oc2SWiXuAIMl4znlOr1U5awixWpdxyus650D01B0k=; b=akAhGlSZaUjUYt13i+U6+n9RIZ5xT7SHlaBbuUx+XOr2VELmr6ABbTl/xoaKlKxyTm NyT2Tl7Gib8f3BiJAUlaGP+rOJztz8uQGc6kAS/OlIALLFUahxu/YautBqZZzqi5Rhvs Y+EGqBqiQwtwSbrtsjV6vfin2em77Hdt3bivrEziukCdhdvkzUpX7kpF+omSD/bLWmHf quzMzDR1zjd9rlyLJghKKz088EgCLuHCxXXVxdI9RNN7lOHmnMcOkvhQGyleYesS5Z1i Fcb3eBP9s77aubxpmp3BUtnKH6BiFPUOCQg1VegHlOPezvt0RuLuKOTClmCw9XNJFBCt eCxA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740471426; x=1741076226; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=T9oc2SWiXuAIMl4znlOr1U5awixWpdxyus650D01B0k=; b=AlQE87zC8s9O4+nH0GjpDdmYFtDmwW6z+/G6dKmhxr2CAM2Xb6XcuHGP0tgrgnu7nn xpfFTxxBTWoyMb4nmJup5Ns5+gP1U7Y2/pTWNKKordiGG6m0qjRUjkUcF7QywHgHC1Yl Vvz8JkFCjADdWMeYZ+iPrkuvvGfS9Vwy1Yrcb/1f+Toiz5ObcnY3qf5oBaPaxAuIRt4x G9smHmpHJwJv9z15dn8BXHhaung6vITVacGwaaXTKFC82BqbzaVqiYZrmoljLB4Y6479 NCDr7e1pPYK+OpoHC03ySl17edwF8wYKrPbFBHlhdnpqYrTTyChD+hZ1MEV/oDhKW1vX xxYA== X-Forwarded-Encrypted: i=1; AJvYcCUZmfw2+F4d5+kGpoyBJL4CBNl+Ec+SWUW2dL7VbR/Gz1Ei0iG7vOTnSyyrp+MRRmmSvnPge2HqH0cr@vger.kernel.org, AJvYcCVrWQFQz3zRU0EkzVuf2TgCONUCUwY+uDNjVV4QtVFxexCCJcgcRtJCojVkz8m/IZGq5ZY6SxHh0BrWTxQ=@vger.kernel.org, AJvYcCWa0Soi/1yMFpFLR+vG4sUez6Weoj6Xtvfj2gkWKPcOPGu5pHCZ8r4H1htsCSbTjCMNSwA0i75rnGKz@vger.kernel.org, AJvYcCWvfvjgrQI8vP1/bsOZucywqUEUKphlGJ5ySTt6Z5B/586invswnNBcADGJF/5bLw6U2uzKDDNt08Htjw==@vger.kernel.org, AJvYcCX6pWKkV+U4VzIxGaRI3CFVj9gzoXZ3IuSmSOp8DSKHCvbOraBGq6FXcuoo/xwiy7QqMETOlQRr@vger.kernel.org, AJvYcCX75RxmVssyc9/GhXO4gFNwbV/BO0oedSQVKBcGSfMScaa5VMxTRSdkhmCFesIxVArZZFPLdTOcOc8=@vger.kernel.org, AJvYcCXPV3A5mH51O+klYQVTUJ85pusNNEqQt68e7p/magonwoZT8PeKeI9zbasBiSdxtqgpyFofVE0Z8rGi@vger.kernel.org, AJvYcCXS0iqmSCGQr8nWX/FSjlkhTDTIMJLuldFHt/C9fABQ1qWww9fCOBjVUYLTgCY8idpISsLCbmOqciTAasIcoUs=@vger.kernel.org X-Gm-Message-State: AOJu0YyH0wg4nfoW+KJZt9DUyvvXvH7JV1V6u5LKVnK0znHZJcgvDwzv PczcStIVY3W89V9G0S7ltPxeSavTTii28PNGMrJ3QVW8sYguI1qB X-Gm-Gg: ASbGnct8FxZqaLMGaNohPNrK0TnqcCP5NEpCzg/jbi6kTtZ4jqdCwfPiUKh5Qn72Z5u jyN0CdlAZzwkiMrcyD7+8wOPrk7/o1JsYKlJdUgwsZ5byvaPCymQushR5bBNg2GLTN+11rQ8fz8 rGeiO8loHl1aPJep4pPfK9DIrKsQyTDda//F2723TBQwLdTlcmYZpIpxH41STXVAo1YWD0IOor6 0kgJNHvOuDbesB32IxwRc4dqkG+hC/o+1nG7zke1NWEiIVdsUyz6KBlhKx8youhgyM/QhpXW3Eo i+UfUrpwU2UjsnAX+afj7JuPpi4CeRHWxQTAxoQRq1GIuYESyVzns8W0jDA8rcGQeNGaQA== X-Google-Smtp-Source: AGHT+IF1ITx+3HFDVNp+fisF054nBAzUuzWiIwfssUbmUfH00/vIpzXRok3wRx8wqX/9dQCVndG4fQ== X-Received: by 2002:a05:6a00:1a86:b0:730:74f8:25b9 with SMTP id d2e1a72fcca58-73426d81592mr24503473b3a.17.1740471425829; Tue, 25 Feb 2025 00:17:05 -0800 (PST) Received: from hcdev-d520mt2.. (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7347a6abaddsm902178b3a.20.2025.02.25.00.17.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2025 00:17:05 -0800 (PST) From: Ming Yu To: tmyu0@nuvoton.com, lee@kernel.org, linus.walleij@linaro.org, brgl@bgdev.pl, andi.shyti@kernel.org, mkl@pengutronix.de, mailhol.vincent@wanadoo.fr, andrew+netdev@lunn.ch, davem@davemloft.net, edumazet@google.com, kuba@kernel.org, pabeni@redhat.com, wim@linux-watchdog.org, linux@roeck-us.net, jdelvare@suse.com, alexandre.belloni@bootlin.com Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, linux-i2c@vger.kernel.org, linux-can@vger.kernel.org, netdev@vger.kernel.org, linux-watchdog@vger.kernel.org, linux-hwmon@vger.kernel.org, linux-rtc@vger.kernel.org, linux-usb@vger.kernel.org, Ming Yu Subject: [PATCH v8 1/7] mfd: Add core driver for Nuvoton NCT6694 Date: Tue, 25 Feb 2025 16:16:38 +0800 Message-Id: <20250225081644.3524915-2-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250225081644.3524915-1-a0282524688@gmail.com> References: <20250225081644.3524915-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-usb@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 The Nuvoton NCT6694 is a peripheral expander with 16 GPIO chips, 6 I2C controllers, 2 CANfd controllers, 2 Watchdog timers, ADC, PWM, and RTC. This driver implements USB device functionality and shares the chip's peripherals as a child device. Each child device can use the USB functions nct6694_read_msg() and nct6694_write_msg() to issue a command. They can also request interrupt that will be called when the USB device receives its interrupt pipe. Signed-off-by: Ming Yu --- MAINTAINERS | 7 + drivers/mfd/Kconfig | 18 ++ drivers/mfd/Makefile | 2 + drivers/mfd/nct6694.c | 378 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/nct6694.h | 102 ++++++++++ 5 files changed, 507 insertions(+) create mode 100644 drivers/mfd/nct6694.c create mode 100644 include/linux/mfd/nct6694.h diff --git a/MAINTAINERS b/MAINTAINERS index 873aa2cce4d7..c700a0b96960 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16918,6 +16918,13 @@ F: drivers/nubus/ F: include/linux/nubus.h F: include/uapi/linux/nubus.h +NUVOTON NCT6694 MFD DRIVER +M: Ming Yu +L: linux-kernel@vger.kernel.org +S: Supported +F: drivers/mfd/nct6694.c +F: include/linux/mfd/nct6694.h + NVIDIA (rivafb and nvidiafb) FRAMEBUFFER DRIVER M: Antonino Daplas L: linux-fbdev@vger.kernel.org diff --git a/drivers/mfd/Kconfig b/drivers/mfd/Kconfig index 6b0682af6e32..c97a2bdcea0b 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -1045,6 +1045,24 @@ config MFD_MENF21BMC This driver can also be built as a module. If so the module will be called menf21bmc. +config MFD_NCT6694 + tristate "Nuvoton NCT6694 support" + select MFD_CORE + depends on USB + help + This enables support for the Nuvoton USB device NCT6694, which shares + peripherals. + + This driver provides core APIs to access the NCT6694 hardware + monitoring and control features. + + The NCT6694 is a versatile multi-function device that supports + functionalities such as GPIO, I2C, CAN, WDT, HWMON, and RTC + management. + + Additional drivers must be enabled to utilize the specific + functionalities of the device. + config MFD_OCELOT tristate "Microsemi Ocelot External Control Support" depends on SPI_MASTER diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index 9220eaf7cf12..7725b732e265 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -121,6 +121,8 @@ obj-$(CONFIG_MFD_MC13XXX) += mc13xxx-core.o obj-$(CONFIG_MFD_MC13XXX_SPI) += mc13xxx-spi.o obj-$(CONFIG_MFD_MC13XXX_I2C) += mc13xxx-i2c.o +obj-$(CONFIG_MFD_NCT6694) += nct6694.o + obj-$(CONFIG_MFD_CORE) += mfd-core.o ocelot-soc-objs := ocelot-core.o ocelot-spi.o diff --git a/drivers/mfd/nct6694.c b/drivers/mfd/nct6694.c new file mode 100644 index 000000000000..c82457679ca6 --- /dev/null +++ b/drivers/mfd/nct6694.c @@ -0,0 +1,378 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 core driver using USB interface to provide + * access to the NCT6694 hardware monitoring and control features. + * + * The NCT6694 is a versatile multi-function device that supports + * functionalities such as GPIO, I2C, CAN, WDT, HWMON and RTC + * management. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static const struct mfd_cell nct6694_dev[] = { + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x0), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x1), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x2), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x3), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x4), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x5), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x6), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x7), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x8), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0x9), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xA), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xB), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xC), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xD), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xE), + MFD_CELL_BASIC("gpio-nct6694", NULL, NULL, 0, 0xF), + + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x0), + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x1), + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x2), + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x3), + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x4), + MFD_CELL_BASIC("i2c-nct6694", NULL, NULL, 0, 0x5), + + MFD_CELL_BASIC("nct6694_canfd", NULL, NULL, 0, 0x0), + MFD_CELL_BASIC("nct6694_canfd", NULL, NULL, 0, 0x1), + + MFD_CELL_BASIC("nct6694_wdt", NULL, NULL, 0, 0x0), + MFD_CELL_BASIC("nct6694_wdt", NULL, NULL, 0, 0x1), + + MFD_CELL_NAME("nct6694-hwmon"), + MFD_CELL_NAME("rtc-nct6694"), +}; + +static int nct6694_response_err_handling(struct nct6694 *nct6694, + unsigned char err_status) +{ + switch (err_status) { + case NCT6694_NO_ERROR: + return err_status; + case NCT6694_NOT_SUPPORT_ERROR: + dev_warn(nct6694->dev, "Command is not supported!\n"); + break; + case NCT6694_NO_RESPONSE_ERROR: + dev_warn(nct6694->dev, "Command received no response!\n"); + break; + case NCT6694_TIMEOUT_ERROR: + dev_warn(nct6694->dev, "Command timed out!\n"); + break; + case NCT6694_PENDING: + dev_warn(nct6694->dev, "Command is pending!\n"); + break; + default: + return -EINVAL; + } + + return -EIO; +} + +int nct6694_read_msg(struct nct6694 *nct6694, const struct nct6694_cmd_header *cmd_hd, void *buf) +{ + union nct6694_usb_msg *msg = nct6694->usb_msg; + int tx_len, rx_len, ret; + + guard(mutex)(&nct6694->access_lock); + + /* Send command packet to USB device */ + memcpy(&msg->cmd_header, cmd_hd, sizeof(*cmd_hd)); + msg->cmd_header.hctrl = NCT6694_HCTRL_GET; + + ret = usb_bulk_msg(nct6694->udev, + usb_sndbulkpipe(nct6694->udev, NCT6694_BULK_OUT_EP), + &msg->cmd_header, sizeof(*msg), &tx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Receive response packet from USB device */ + ret = usb_bulk_msg(nct6694->udev, + usb_rcvbulkpipe(nct6694->udev, NCT6694_BULK_IN_EP), + &msg->response_header, sizeof(*msg), &rx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Receive data packet from USB device */ + ret = usb_bulk_msg(nct6694->udev, + usb_rcvbulkpipe(nct6694->udev, NCT6694_BULK_IN_EP), + buf, le16_to_cpu(cmd_hd->len), &rx_len, + nct6694->timeout); + if (ret) + return ret; + + if (rx_len != le16_to_cpu(cmd_hd->len)) { + dev_err(nct6694->dev, "Expected received length %d, but got %d\n", + le16_to_cpu(cmd_hd->len), rx_len); + return -EIO; + } + + return nct6694_response_err_handling(nct6694, msg->response_header.sts); +} +EXPORT_SYMBOL(nct6694_read_msg); + +int nct6694_write_msg(struct nct6694 *nct6694, const struct nct6694_cmd_header *cmd_hd, void *buf) +{ + union nct6694_usb_msg *msg = nct6694->usb_msg; + int tx_len, rx_len, ret; + + guard(mutex)(&nct6694->access_lock); + + /* Send command packet to USB device */ + memcpy(&msg->cmd_header, cmd_hd, sizeof(*cmd_hd)); + msg->cmd_header.hctrl = NCT6694_HCTRL_SET; + + ret = usb_bulk_msg(nct6694->udev, + usb_sndbulkpipe(nct6694->udev, NCT6694_BULK_OUT_EP), + &msg->cmd_header, sizeof(*msg), &tx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Send data packet to USB device */ + ret = usb_bulk_msg(nct6694->udev, + usb_sndbulkpipe(nct6694->udev, NCT6694_BULK_OUT_EP), + buf, le16_to_cpu(cmd_hd->len), &tx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Receive response packet from USB device */ + ret = usb_bulk_msg(nct6694->udev, + usb_rcvbulkpipe(nct6694->udev, NCT6694_BULK_IN_EP), + &msg->response_header, sizeof(*msg), &rx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Receive data packet from USB device */ + ret = usb_bulk_msg(nct6694->udev, + usb_rcvbulkpipe(nct6694->udev, NCT6694_BULK_IN_EP), + buf, le16_to_cpu(cmd_hd->len), &rx_len, + nct6694->timeout); + if (ret) + return ret; + + if (rx_len != le16_to_cpu(cmd_hd->len)) { + dev_err(nct6694->dev, "Expected transmitted length %d, but got %d\n", + le16_to_cpu(cmd_hd->len), rx_len); + return -EIO; + } + + return nct6694_response_err_handling(nct6694, msg->response_header.sts); +} +EXPORT_SYMBOL(nct6694_write_msg); + +static void usb_int_callback(struct urb *urb) +{ + struct nct6694 *nct6694 = urb->context; + unsigned int *int_status = urb->transfer_buffer; + int ret; + + switch (urb->status) { + case 0: + break; + case -ECONNRESET: + case -ENOENT: + case -ESHUTDOWN: + return; + default: + goto resubmit; + } + + while (*int_status) { + int irq = __ffs(*int_status); + + generic_handle_irq_safe(irq_find_mapping(nct6694->domain, irq)); + *int_status &= ~BIT(irq); + } + +resubmit: + ret = usb_submit_urb(urb, GFP_ATOMIC); + if (ret) + dev_dbg(nct6694->dev, "%s: Failed to resubmit urb, status %pe", + __func__, ERR_PTR(ret)); +} + +static void nct6694_irq_lock(struct irq_data *data) +{ + struct nct6694 *nct6694 = irq_data_get_irq_chip_data(data); + + mutex_lock(&nct6694->irq_lock); +} + +static void nct6694_irq_sync_unlock(struct irq_data *data) +{ + struct nct6694 *nct6694 = irq_data_get_irq_chip_data(data); + + mutex_unlock(&nct6694->irq_lock); +} + +static void nct6694_irq_enable(struct irq_data *data) +{ + struct nct6694 *nct6694 = irq_data_get_irq_chip_data(data); + irq_hw_number_t hwirq = irqd_to_hwirq(data); + + nct6694->irq_enable |= BIT(hwirq); +} + +static void nct6694_irq_disable(struct irq_data *data) +{ + struct nct6694 *nct6694 = irq_data_get_irq_chip_data(data); + irq_hw_number_t hwirq = irqd_to_hwirq(data); + + nct6694->irq_enable &= ~BIT(hwirq); +} + +static const struct irq_chip nct6694_irq_chip = { + .name = "nct6694-irq", + .flags = IRQCHIP_SKIP_SET_WAKE, + .irq_bus_lock = nct6694_irq_lock, + .irq_bus_sync_unlock = nct6694_irq_sync_unlock, + .irq_enable = nct6694_irq_enable, + .irq_disable = nct6694_irq_disable, +}; + +static int nct6694_irq_domain_map(struct irq_domain *d, unsigned int irq, + irq_hw_number_t hw) +{ + struct nct6694 *nct6694 = d->host_data; + + irq_set_chip_data(irq, nct6694); + irq_set_chip_and_handler(irq, &nct6694_irq_chip, handle_simple_irq); + + return 0; +} + +static void nct6694_irq_domain_unmap(struct irq_domain *d, unsigned int irq) +{ + irq_set_chip_and_handler(irq, NULL, NULL); + irq_set_chip_data(irq, NULL); +} + +static const struct irq_domain_ops nct6694_irq_domain_ops = { + .map = nct6694_irq_domain_map, + .unmap = nct6694_irq_domain_unmap, +}; + +static int nct6694_usb_probe(struct usb_interface *iface, + const struct usb_device_id *id) +{ + struct usb_device *udev = interface_to_usbdev(iface); + struct usb_endpoint_descriptor *int_endpoint; + struct usb_host_interface *interface; + struct device *dev = &iface->dev; + struct nct6694 *nct6694; + int pipe, maxp; + int ret; + + nct6694 = devm_kzalloc(dev, sizeof(*nct6694), GFP_KERNEL); + if (!nct6694) + return -ENOMEM; + + pipe = usb_rcvintpipe(udev, NCT6694_INT_IN_EP); + maxp = usb_maxpacket(udev, pipe); + + nct6694->usb_msg = devm_kzalloc(dev, sizeof(union nct6694_usb_msg), GFP_KERNEL); + if (!nct6694->usb_msg) + return -ENOMEM; + + nct6694->int_buffer = devm_kzalloc(dev, maxp, GFP_KERNEL); + if (!nct6694->int_buffer) + return -ENOMEM; + + nct6694->int_in_urb = usb_alloc_urb(0, GFP_KERNEL); + if (!nct6694->int_in_urb) + return -ENOMEM; + + nct6694->domain = irq_domain_add_simple(NULL, NCT6694_NR_IRQS, 0, + &nct6694_irq_domain_ops, + nct6694); + if (!nct6694->domain) { + ret = -ENODEV; + goto err_urb; + } + + nct6694->dev = dev; + nct6694->udev = udev; + nct6694->timeout = NCT6694_URB_TIMEOUT; /* Wait until URB completes */ + + ret = devm_mutex_init(dev, &nct6694->access_lock); + if (ret) + goto err_urb; + + ret = devm_mutex_init(dev, &nct6694->irq_lock); + if (ret) + goto err_urb; + + interface = iface->cur_altsetting; + int_endpoint = &interface->endpoint[0].desc; + if (!usb_endpoint_is_int_in(int_endpoint)) { + ret = -ENODEV; + goto err_urb; + } + usb_fill_int_urb(nct6694->int_in_urb, udev, pipe, + nct6694->int_buffer, maxp, usb_int_callback, + nct6694, int_endpoint->bInterval); + ret = usb_submit_urb(nct6694->int_in_urb, GFP_KERNEL); + if (ret) + goto err_urb; + + usb_set_intfdata(iface, nct6694); + + ret = mfd_add_hotplug_devices(dev, nct6694_dev, ARRAY_SIZE(nct6694_dev)); + if (ret) + goto err_mfd; + + return 0; + +err_mfd: + usb_kill_urb(nct6694->int_in_urb); +err_urb: + usb_free_urb(nct6694->int_in_urb); + return ret; +} + +static void nct6694_usb_disconnect(struct usb_interface *iface) +{ + struct nct6694 *nct6694 = usb_get_intfdata(iface); + + mfd_remove_devices(nct6694->dev); + usb_kill_urb(nct6694->int_in_urb); + usb_free_urb(nct6694->int_in_urb); +} + +static const struct usb_device_id nct6694_ids[] = { + { USB_DEVICE_AND_INTERFACE_INFO(NCT6694_VENDOR_ID, + NCT6694_PRODUCT_ID, + 0xFF, 0x00, 0x00)}, + {} +}; +MODULE_DEVICE_TABLE(usb, nct6694_ids); + +static struct usb_driver nct6694_usb_driver = { + .name = "nct6694", + .id_table = nct6694_ids, + .probe = nct6694_usb_probe, + .disconnect = nct6694_usb_disconnect, +}; + +module_usb_driver(nct6694_usb_driver); + +MODULE_DESCRIPTION("USB core driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); diff --git a/include/linux/mfd/nct6694.h b/include/linux/mfd/nct6694.h new file mode 100644 index 000000000000..8171f975761e --- /dev/null +++ b/include/linux/mfd/nct6694.h @@ -0,0 +1,102 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Nuvoton NCT6694 USB transaction and data structure. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#ifndef __MFD_NCT6694_H +#define __MFD_NCT6694_H + +#define NCT6694_VENDOR_ID 0x0416 +#define NCT6694_PRODUCT_ID 0x200B +#define NCT6694_INT_IN_EP 0x81 +#define NCT6694_BULK_IN_EP 0x02 +#define NCT6694_BULK_OUT_EP 0x03 + +#define NCT6694_HCTRL_SET 0x40 +#define NCT6694_HCTRL_GET 0x80 + +#define NCT6694_URB_TIMEOUT 1000 + +enum nct6694_irq_id { + NCT6694_IRQ_GPIO0 = 0, + NCT6694_IRQ_GPIO1, + NCT6694_IRQ_GPIO2, + NCT6694_IRQ_GPIO3, + NCT6694_IRQ_GPIO4, + NCT6694_IRQ_GPIO5, + NCT6694_IRQ_GPIO6, + NCT6694_IRQ_GPIO7, + NCT6694_IRQ_GPIO8, + NCT6694_IRQ_GPIO9, + NCT6694_IRQ_GPIOA, + NCT6694_IRQ_GPIOB, + NCT6694_IRQ_GPIOC, + NCT6694_IRQ_GPIOD, + NCT6694_IRQ_GPIOE, + NCT6694_IRQ_GPIOF, + NCT6694_IRQ_CAN0, + NCT6694_IRQ_CAN1, + NCT6694_IRQ_RTC, + NCT6694_NR_IRQS, +}; + +enum nct6694_response_err_status { + NCT6694_NO_ERROR = 0, + NCT6694_FORMAT_ERROR, + NCT6694_RESERVED1, + NCT6694_RESERVED2, + NCT6694_NOT_SUPPORT_ERROR, + NCT6694_NO_RESPONSE_ERROR, + NCT6694_TIMEOUT_ERROR, + NCT6694_PENDING, +}; + +struct __packed nct6694_cmd_header { + u8 rsv1; + u8 mod; + union __packed { + __le16 offset; + struct __packed { + u8 cmd; + u8 sel; + }; + }; + u8 hctrl; + u8 rsv2; + __le16 len; +}; + +struct __packed nct6694_response_header { + u8 sequence_id; + u8 sts; + u8 reserved[4]; + __le16 len; +}; + +union __packed nct6694_usb_msg { + struct nct6694_cmd_header cmd_header; + struct nct6694_response_header response_header; +}; + +struct nct6694 { + struct device *dev; + struct irq_domain *domain; + /* Mutex to protect access to the device */ + struct mutex access_lock; + /* Mutex to protect access to the IRQ */ + struct mutex irq_lock; + struct urb *int_in_urb; + struct usb_device *udev; + union nct6694_usb_msg *usb_msg; + unsigned char *int_buffer; + unsigned int irq_enable; + /* Time in msec to wait for the URB to the complete */ + long timeout; +}; + +int nct6694_read_msg(struct nct6694 *nct6694, const struct nct6694_cmd_header *cmd_hd, void *buf); +int nct6694_write_msg(struct nct6694 *nct6694, const struct nct6694_cmd_header *cmd_hd, void *buf); + +#endif From patchwork Tue Feb 25 08:16:40 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 868474 Received: from mail-pl1-f179.google.com (mail-pl1-f179.google.com [209.85.214.179]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 164D22627E9; Tue, 25 Feb 2025 08:17:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.179 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471437; cv=none; b=bhWz1JJ0jxuJ6rZtzRD0RbzdM7inoNJkf/Gm+FWcUk0jzchFkMOUWCnlp+Q94XYGwahklwZ/YYbH6/Xk/BnxPYn7TPFLGxRl/SWK/5EQ8EU/W6FkExAv+nAgaeXogvvEv0Fv3KAR8MlIGVN/dJfa6WiyYD/wiTUpdXCO9+M4A74= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471437; c=relaxed/simple; bh=bSZzlFBF2yruJOVHYy5GhwwLpfUSSNNXNqKSrPzZiUo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=iP/WBXee/j7NDjUFTLqx5z1w0umeqowlbV3zegYGAbZ5miVbopkbtxwjGaEmk2fFUMChB4ldNmJByjstImMNXXUWtMGglldu0Ebuj5xzWVNd8Ff0IWAsoNx6KqBZF9rqJ6jvjPBTswgwGanPPgOyGk10iVBP112eRCDovwwqQxo= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=e4SICjDr; arc=none smtp.client-ip=209.85.214.179 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="e4SICjDr" Received: by mail-pl1-f179.google.com with SMTP id d9443c01a7336-221206dbd7eso109385385ad.2; Tue, 25 Feb 2025 00:17:15 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740471435; x=1741076235; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=AzXMX0GdCmam8+leSYD2zUvdF77p9BrMkiZ29xVQTk0=; b=e4SICjDryON5Xi/QLhkHxAWXa+MEB/NKNgGlwUoAhsLL0Wbg6Sm/3nzTM6EcJFKeB2 5Ol0JeYcqmaAZOn8UzE/9G5fkJR/hdPDcm22Pi9qiGfcrJ3jGi6IbWmO9jsGLRuzexNs ltAAqw5TFderKRm3dAlp0hmADidQ6bbZHQX2Zx5epS+quj+6ZtMyvCC+17dsSIufiee/ Zs6xtEDKKufYdgcVr5qFTB7Z+yzn/Mf9A+oTX/6jLOlzxFN/qpePT8Lod/pezAsAZElB FhJqXwnrvR6vmJqEXGirPQtbywfon7UyFa9SnllT8hlAHSWFqw3/UPjAY9kEF73Nlrg4 e/Ng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740471435; x=1741076235; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=AzXMX0GdCmam8+leSYD2zUvdF77p9BrMkiZ29xVQTk0=; b=q7aYrMb31Gq6yxU68vbH+QfLRtwVHqGeliL0z8aL3FB0ECFqgMGlnoKgNgDyRnmHYf cDH18HfIkGUZnKMTwfvundeW+qI+oGDPbILX+dJotH+QLE1irax6i+WD5oORRgIGVi8Y Z0speV4RCnefH8ElyywAHi7IWKjT9aVDvVGH7scGK4SL+9kpwN/w7xnIryBcNvIkna9W 4b7In7a2HO3Pz93sk6w7kfylopBGdiSGElHNhJJwOL4aRF576mlB0n/I1e4lwtaRNC7Q L/RFGnL+9TJ7IUvK7YGuhGx31QiO3c2xu6RNHq9DW2ziK7y1ckJ7eSeRiWC8ArhU/u7s FINA== X-Forwarded-Encrypted: i=1; AJvYcCUZuUpgOJ2XkkzFOxoJk19OGAqbUA7hkytfnnDKX2KEcjBVdsCuoKUaEC2HVg66/zhuaq9ra9mOv8PfNw==@vger.kernel.org, AJvYcCVZ4Pnun3ZbE/3VE8YjF8d3gnEly2OgPUCKdPsnjsmloO3+v930JuttUwmP6s4roMCqDjyKo1U1y1xz@vger.kernel.org, AJvYcCWQsqGa8X2SmBM0n68QdaSSKBjroNmNHU1OrVjY9B707bSDRUnPg1A5IJl+NrjmJi2pz43f88yEh9LR@vger.kernel.org, AJvYcCWWzDMHXjezZcgl5Gc/Zlo4khsO+6BUPzBeJCc1YvSDAZDh82nB5PUpnOAPgDZ4N1w4S+V1/ZfuyZWRQtzNOwE=@vger.kernel.org, AJvYcCWglJZtxJmwvm3AF+X032mNZFnmbHWaHRv0CKsvk1lDhki8YR/HboEN2fEybKSi3ZGEVRrRPNoZVcUpej0=@vger.kernel.org, AJvYcCWqMdjOfqbBfex15hnJhn1doxkdGyzuW/9HyT/ksWmZ672sw41IjhOdwpmHbUi0rc/KkAMuoGqwz7E=@vger.kernel.org, AJvYcCXhvDQ8fGIAiGdtYGiGL+akLEKle0xLDBiUHWap3mxs4/vwOs5gDTUwHaQ5HOVZ0JkJSZA+exX79Dhl@vger.kernel.org, AJvYcCXk5RnHvd+vp6VrwQ5LpxsvO4b4+xk1zFsXQOXrQ5ALv9o0JmC9EuaPCf0dWgsXsFYeyDxyB47/@vger.kernel.org X-Gm-Message-State: AOJu0YyXbl5n+h3x8zwPkWUelBbZQAICqKjHXGw75UDIwPoz/FmEeTHy wXjCtJhjsAt/kKmvDfKvW/OU5P3WdF5Hs8yehwKk6UmmyXFHxTsH X-Gm-Gg: ASbGncvv6slTnr2vwmSMdCjyQi60Fu8rbRRhNotj6gx0i+4eLrujTchnljNeln82HTj p8LOzsY88QeNNhw4JuXPqdRbkaWT5+QDq5igAfdLEk6UQ6tcICrUYJwRm4rlFUwA6RDD1DlNnMn ILa/J1bcGYjHjUQ+BfF/xU3iZP15UHuvhanj51+Lz5egccw2BvnYGV5H0Rgl3qApjms8/4dOCnc XuC5fyqHeaIRkzyzVrS9tdj5qCghZuyAbTXlgfNVOwyB4ukGZ7up/UnuFjm+Qh/fO454PpxPJyn bKkVP8Q+oUf2/yzZ8SGFN+73lHaJ/GD629P8XW6HCLndR36Xcwz9bCHMdtQkwAQYMQNVGg== X-Google-Smtp-Source: AGHT+IGs0mPRgxuxCHkOSigZvHyUu2/6ZX64UZblCedBW+pVaxOtJCnt/Kx92blq46LE12m2qW9W7A== X-Received: by 2002:a05:6a20:7f81:b0:1ee:ace8:8181 with SMTP id adf61e73a8af0-1eef3ca3f5amr30044978637.21.1740471435091; Tue, 25 Feb 2025 00:17:15 -0800 (PST) Received: from hcdev-d520mt2.. (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7347a6abaddsm902178b3a.20.2025.02.25.00.17.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2025 00:17:14 -0800 (PST) From: Ming Yu To: tmyu0@nuvoton.com, lee@kernel.org, linus.walleij@linaro.org, brgl@bgdev.pl, andi.shyti@kernel.org, mkl@pengutronix.de, mailhol.vincent@wanadoo.fr, andrew+netdev@lunn.ch, davem@davemloft.net, edumazet@google.com, kuba@kernel.org, pabeni@redhat.com, wim@linux-watchdog.org, linux@roeck-us.net, jdelvare@suse.com, alexandre.belloni@bootlin.com Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, linux-i2c@vger.kernel.org, linux-can@vger.kernel.org, netdev@vger.kernel.org, linux-watchdog@vger.kernel.org, linux-hwmon@vger.kernel.org, linux-rtc@vger.kernel.org, linux-usb@vger.kernel.org, Ming Yu Subject: [PATCH v8 3/7] i2c: Add Nuvoton NCT6694 I2C support Date: Tue, 25 Feb 2025 16:16:40 +0800 Message-Id: <20250225081644.3524915-4-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250225081644.3524915-1-a0282524688@gmail.com> References: <20250225081644.3524915-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-usb@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports I2C adapter functionality for NCT6694 MFD device based on USB interface, each I2C controller use default baudrate(100K). Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/i2c/busses/Kconfig | 10 ++ drivers/i2c/busses/Makefile | 1 + drivers/i2c/busses/i2c-nct6694.c | 152 +++++++++++++++++++++++++++++++ 4 files changed, 164 insertions(+) create mode 100644 drivers/i2c/busses/i2c-nct6694.c diff --git a/MAINTAINERS b/MAINTAINERS index be7cd44a4c88..1327e7a6e507 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16923,6 +16923,7 @@ M: Ming Yu L: linux-kernel@vger.kernel.org S: Supported F: drivers/gpio/gpio-nct6694.c +F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: include/linux/mfd/nct6694.h diff --git a/drivers/i2c/busses/Kconfig b/drivers/i2c/busses/Kconfig index fc438f445771..d0753d0adaae 100644 --- a/drivers/i2c/busses/Kconfig +++ b/drivers/i2c/busses/Kconfig @@ -1329,6 +1329,16 @@ config I2C_LJCA This driver can also be built as a module. If so, the module will be called i2c-ljca. +config I2C_NCT6694 + tristate "Nuvoton NCT6694 I2C adapter support" + depends on MFD_NCT6694 + help + If you say yes to this option, support will be included for Nuvoton + NCT6694, a USB to I2C interface. + + This driver can also be built as a module. If so, the module will + be called i2c-nct6694. + config I2C_CP2615 tristate "Silicon Labs CP2615 USB sound card and I2C adapter" depends on USB diff --git a/drivers/i2c/busses/Makefile b/drivers/i2c/busses/Makefile index 1c2a4510abe4..c5a60116dd54 100644 --- a/drivers/i2c/busses/Makefile +++ b/drivers/i2c/busses/Makefile @@ -133,6 +133,7 @@ obj-$(CONFIG_I2C_GXP) += i2c-gxp.o obj-$(CONFIG_I2C_DIOLAN_U2C) += i2c-diolan-u2c.o obj-$(CONFIG_I2C_DLN2) += i2c-dln2.o obj-$(CONFIG_I2C_LJCA) += i2c-ljca.o +obj-$(CONFIG_I2C_NCT6694) += i2c-nct6694.o obj-$(CONFIG_I2C_CP2615) += i2c-cp2615.o obj-$(CONFIG_I2C_PARPORT) += i2c-parport.o obj-$(CONFIG_I2C_PCI1XXXX) += i2c-mchp-pci1xxxx.o diff --git a/drivers/i2c/busses/i2c-nct6694.c b/drivers/i2c/busses/i2c-nct6694.c new file mode 100644 index 000000000000..fc26fb6e3751 --- /dev/null +++ b/drivers/i2c/busses/i2c-nct6694.c @@ -0,0 +1,152 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 I2C adapter driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include + +/* + * USB command module type for NCT6694 I2C controller. + * This defines the module type used for communication with the NCT6694 + * I2C controller over the USB interface. + */ +#define NCT6694_I2C_MOD 0x03 + +/* Command 00h - I2C Deliver */ +#define NCT6694_I2C_DELIVER 0x00 +#define NCT6694_I2C_DELIVER_SEL 0x00 + +enum i2c_baudrate { + I2C_BR_25K = 0, + I2C_BR_50K, + I2C_BR_100K, + I2C_BR_200K, + I2C_BR_400K, + I2C_BR_800K, + I2C_BR_1M +}; + +struct __packed nct6694_i2c_deliver { + u8 port; + u8 br; + u8 addr; + u8 w_cnt; + u8 r_cnt; + u8 rsv[11]; + u8 write_data[0x40]; + u8 read_data[0x40]; +}; + +struct nct6694_i2c_data { + struct nct6694 *nct6694; + struct i2c_adapter adapter; + struct nct6694_i2c_deliver deliver; + unsigned char port; + unsigned char br; +}; + +static int nct6694_xfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num) +{ + struct nct6694_i2c_data *data = adap->algo_data; + struct nct6694_i2c_deliver *deliver = &data->deliver; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_I2C_MOD, + .cmd = NCT6694_I2C_DELIVER, + .sel = NCT6694_I2C_DELIVER_SEL, + .len = cpu_to_le16(sizeof(*deliver)) + }; + int ret, i; + + for (i = 0; i < num; i++) { + struct i2c_msg *msg_temp = &msgs[i]; + + memset(deliver, 0, sizeof(*deliver)); + + if (msg_temp->len > 64) + return -EPROTO; + + deliver->port = data->port; + deliver->br = data->br; + deliver->addr = i2c_8bit_addr_from_msg(msg_temp); + if (msg_temp->flags & I2C_M_RD) { + deliver->r_cnt = msg_temp->len; + ret = nct6694_write_msg(data->nct6694, &cmd_hd, deliver); + if (ret < 0) + return ret; + + memcpy(msg_temp->buf, deliver->read_data, msg_temp->len); + } else { + deliver->w_cnt = msg_temp->len; + memcpy(deliver->write_data, msg_temp->buf, msg_temp->len); + ret = nct6694_write_msg(data->nct6694, &cmd_hd, deliver); + if (ret < 0) + return ret; + } + } + + return num; +} + +static u32 nct6694_func(struct i2c_adapter *adapter) +{ + return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL; +} + +static const struct i2c_algorithm algorithm = { + .master_xfer = nct6694_xfer, + .functionality = nct6694_func, +}; + +static int nct6694_i2c_probe(struct platform_device *pdev) +{ + const struct mfd_cell *cell = mfd_get_cell(pdev); + struct nct6694 *nct6694 = dev_get_drvdata(pdev->dev.parent); + struct nct6694_i2c_data *data; + + data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->nct6694 = nct6694; + data->port = cell->id; + data->br = I2C_BR_100K; + + sprintf(data->adapter.name, "NCT6694 I2C Adapter %d", cell->id); + data->adapter.owner = THIS_MODULE; + data->adapter.algo = &algorithm; + data->adapter.dev.parent = &pdev->dev; + data->adapter.algo_data = data; + + platform_set_drvdata(pdev, data); + + return i2c_add_adapter(&data->adapter); +} + +static void nct6694_i2c_remove(struct platform_device *pdev) +{ + struct nct6694_i2c_data *data = platform_get_drvdata(pdev); + + i2c_del_adapter(&data->adapter); +} + +static struct platform_driver nct6694_i2c_driver = { + .driver = { + .name = "i2c-nct6694", + }, + .probe = nct6694_i2c_probe, + .remove = nct6694_i2c_remove, +}; + +module_platform_driver(nct6694_i2c_driver); + +MODULE_DESCRIPTION("USB-I2C adapter driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:nct6694-i2c"); From patchwork Tue Feb 25 08:16:42 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 868473 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3A6C5260A2B; Tue, 25 Feb 2025 08:17:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.172 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471447; cv=none; b=a/f4YzBR5ovMe4YTsCVmZ/oYx5W/vG8wST3/xJqsx4P0uGQduARbocyne6LJn5YEe692DQJnWMzz7ukidP/szYEwc3+zy3pI5VsCHw3tTpjLsfxXEAVzW0U9QkodQeKRUdq+mdoj1qz+tCVRH+jLrBH0t+BNF3ZxbbcqIW0EDrM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471447; c=relaxed/simple; bh=B9RW3Eonh/3at8SeLi/2hDGNoQkoS/kW6tOa8ggxxGQ=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=OCV10Ep9XhVgVNJrB9g6uwGEWLPmT8Fheo38Bem5qabZgk94LfNfOIPLMROUYjZ6yOlLRYii/hAzDlYZzI9R7+58k7OehIxqu49Cu4ZdWt32cS/3sj7p5WN8Byu/OA+ZiH89JWAWT1d+0j3o/LxyWt3LX/pCdrPMfrbldn7TpRk= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=N8Du+mlw; arc=none smtp.client-ip=209.85.214.172 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="N8Du+mlw" Received: by mail-pl1-f172.google.com with SMTP id d9443c01a7336-220e989edb6so144141105ad.1; Tue, 25 Feb 2025 00:17:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740471444; x=1741076244; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=eYnF0mLdu3t6wKiHnoa4wYtpXxwWMR8C+fhC7qG98zE=; b=N8Du+mlwJfgmXrqFQ4iw5xKsBoeAy2LOCUiUrVFf+Li0kRdLbnf9ebHQq0Q5vlG+t3 QnPy2aCbq0UE6v2AFoVmLXht3yPSzBsdblf5pwZjvXle/FgiQc8gROfOv/NpamPIHngF GXzpUr8RlsoVEB0rSzND1r80PEU4XEMGcPxcva2w3XAQfxO8FQ4k4CmXHbdWQgyvZYqX Xl/OflgVPXN4mcbRD8LY2sJgJOt3dHAM1hCT+9ZNgGGS+efcHL1zbb2kjp+VqOFuSYjz GyIAJlmgdDiOwgNn8+S1M/1fHaIx29JQ9edxrSYfl6V1PSdHuWXj9ATg5J0XRTnMJFnR 1Haw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740471444; x=1741076244; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=eYnF0mLdu3t6wKiHnoa4wYtpXxwWMR8C+fhC7qG98zE=; b=gHpoMC4SkDxB72PsRfyZBj+kkxlvNjkxDawCDvLibkGQKRL2uZxQduBGuncWU18Nx/ GDpUyzS5cme7Ooctf6K+eVhWHgQYq653+IFa6fjnmPiXQdjm3Av/ChQ4BehEvpYJZ5f9 tmq3VHhLvSDSPjLIEySYmcJTs2d3CcClDBwC9MzG9qNgV0oWeB2fxNKlsowuu3B7VG+C OqlY+s9DxUatOjWJcAGF2xJSkXsxPVVl70OXZp5Pbin64TVcpdsex77AhQN3ZQ0NB4Bv j9CBXprW82oOzPT8jNBonZKHIMlMR+gjCwnQ1i94t7JPI8QroeYmaeihPwGB2JlC6IuN hgkQ== X-Forwarded-Encrypted: i=1; AJvYcCUbrMrCh8wFyeC5vu8FI8rD4jTQyt0a56oeQoqp3ldC2MiQn28a0W5e0Gv0SA8Nw2iX8FqDnySHNgv4@vger.kernel.org, AJvYcCWFMoiBRNPwO1Kn2h6CjwREBC+Cu2+tyJb3d5JwpjN7/om6jBSXwNhEgR1VhvpDBhMHc0nn68f/OyuZU9afytE=@vger.kernel.org, AJvYcCWO1ErrgeRhw8zf/iDaWSgyOwGv/N5V1vPcuh3taD2+hZ3z8Eq2t/iD20PC3XSiL8wgMxyZSB5xDho=@vger.kernel.org, AJvYcCWsRxK/f7d09fM3XN0EaDJrNISPfx+UbtgtcJoLJpKMfD7r6g6vOxopu6dVT0zSiGA8uaJU0GuIiy32@vger.kernel.org, AJvYcCWuHKrxrmg+oUtx7u+XrkCrGFPZfSkktRRAmNv9g7llSsgw4/ezOfBH18/kw5jcqTED+cVry+alyTCu@vger.kernel.org, AJvYcCX/V28DF3OZyNf/elnAIXnphpzqFRKNlUunx68WpsjtLurpq+b0RnheJAYG4DAwQMaKv7aG3BEq1YgF5A==@vger.kernel.org, AJvYcCXVm042oVcEzXkpZoe7Fisg/BkmWBUBoQZCbXVkGsjjCoubTzPFlUlKAhaiBdpoFIkaqShre2pD@vger.kernel.org, AJvYcCXthtEextFKm7whw3/4i6yWrQU6vnOaHdLRFLorfJWMogR+eVOXs1ljzvPR1/oXegeaufAS9sT2cz+AgPk=@vger.kernel.org X-Gm-Message-State: AOJu0Yygn+wxj9evltZ9IrIv9E7vywhtsLT0mTAjEpbqysGiqjGa7e3B xrw+Tp/qDclpIOhQKMNv82+fTZA6gzwL1RtAP7tQtQtAoXxk5dDV X-Gm-Gg: ASbGncvb5fsf+y6g4EDRHC1iLlzy648iUwiXlXEt3+hgNmPvEEROSVssdgAiIDJapqc U/+iuSNwupvW6hhEDWkHkvy7Z/V8LMsNCtmCBTPLHdu38sludjPdwmX3Tt0f4N9stSdmwsT20Yu G6OWhTJDUKtrfA9Qbtnmuvo80rkixZOeWcMOO6xN7wkkHP7s6ev9F1V3k1Z3cdPxf9vDY5RTart uWGFMA49h1VNHkVlgdCpTZz62EJKAFnTA1KQECHAos4L9lkVokK8vqYmc6Ld829YnZJ6Ld1NSL1 eo6ZB5kNwFiAXnzop2+R/XEcSj5IYyDrIPzikYa/n3cVrU9NZk4YBbqThkwnkD4YAd5wzQ== X-Google-Smtp-Source: AGHT+IFg+eCWkEZwgZZMe/+bI6x7V/JhCuQTwIRM1Cqlf1Lj3ZTV/kfNZt1xg0lOtFFHl1dQGt8H/Q== X-Received: by 2002:a05:6a00:992:b0:730:7d3f:8c79 with SMTP id d2e1a72fcca58-734791a2883mr3604458b3a.19.1740471444309; Tue, 25 Feb 2025 00:17:24 -0800 (PST) Received: from hcdev-d520mt2.. (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7347a6abaddsm902178b3a.20.2025.02.25.00.17.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2025 00:17:24 -0800 (PST) From: Ming Yu To: tmyu0@nuvoton.com, lee@kernel.org, linus.walleij@linaro.org, brgl@bgdev.pl, andi.shyti@kernel.org, mkl@pengutronix.de, mailhol.vincent@wanadoo.fr, andrew+netdev@lunn.ch, davem@davemloft.net, edumazet@google.com, kuba@kernel.org, pabeni@redhat.com, wim@linux-watchdog.org, linux@roeck-us.net, jdelvare@suse.com, alexandre.belloni@bootlin.com Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, linux-i2c@vger.kernel.org, linux-can@vger.kernel.org, netdev@vger.kernel.org, linux-watchdog@vger.kernel.org, linux-hwmon@vger.kernel.org, linux-rtc@vger.kernel.org, linux-usb@vger.kernel.org, Ming Yu Subject: [PATCH v8 5/7] watchdog: Add Nuvoton NCT6694 WDT support Date: Tue, 25 Feb 2025 16:16:42 +0800 Message-Id: <20250225081644.3524915-6-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250225081644.3524915-1-a0282524688@gmail.com> References: <20250225081644.3524915-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-usb@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports Watchdog timer functionality for NCT6694 MFD device based on USB interface. Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/watchdog/Kconfig | 11 ++ drivers/watchdog/Makefile | 1 + drivers/watchdog/nct6694_wdt.c | 298 +++++++++++++++++++++++++++++++++ 4 files changed, 311 insertions(+) create mode 100644 drivers/watchdog/nct6694_wdt.c diff --git a/MAINTAINERS b/MAINTAINERS index 8aa611504172..4889b618abef 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16926,6 +16926,7 @@ F: drivers/gpio/gpio-nct6694.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: drivers/net/can/usb/nct6694_canfd.c +F: drivers/watchdog/nct6694_wdt.c F: include/linux/mfd/nct6694.h NVIDIA (rivafb and nvidiafb) FRAMEBUFFER DRIVER diff --git a/drivers/watchdog/Kconfig b/drivers/watchdog/Kconfig index f81705f8539a..4c4f826368c4 100644 --- a/drivers/watchdog/Kconfig +++ b/drivers/watchdog/Kconfig @@ -748,6 +748,17 @@ config MAX77620_WATCHDOG MAX77620 chips. To compile this driver as a module, choose M here: the module will be called max77620_wdt. +config NCT6694_WATCHDOG + tristate "Nuvoton NCT6694 watchdog support" + depends on MFD_NCT6694 + select WATCHDOG_CORE + help + Say Y here to support Nuvoton NCT6694 watchdog timer + functionality. + + This driver can also be built as a module. If so, the module + will be called nct6694_wdt. + config IMX2_WDT tristate "IMX2+ Watchdog" depends on ARCH_MXC || ARCH_LAYERSCAPE || COMPILE_TEST diff --git a/drivers/watchdog/Makefile b/drivers/watchdog/Makefile index 8411626fa162..de2a04ff8a92 100644 --- a/drivers/watchdog/Makefile +++ b/drivers/watchdog/Makefile @@ -232,6 +232,7 @@ obj-$(CONFIG_WM831X_WATCHDOG) += wm831x_wdt.o obj-$(CONFIG_WM8350_WATCHDOG) += wm8350_wdt.o obj-$(CONFIG_MAX63XX_WATCHDOG) += max63xx_wdt.o obj-$(CONFIG_MAX77620_WATCHDOG) += max77620_wdt.o +obj-$(CONFIG_NCT6694_WATCHDOG) += nct6694_wdt.o obj-$(CONFIG_ZIIRAVE_WATCHDOG) += ziirave_wdt.o obj-$(CONFIG_SOFT_WATCHDOG) += softdog.o obj-$(CONFIG_MENF21BMC_WATCHDOG) += menf21bmc_wdt.o diff --git a/drivers/watchdog/nct6694_wdt.c b/drivers/watchdog/nct6694_wdt.c new file mode 100644 index 000000000000..a99d0429e637 --- /dev/null +++ b/drivers/watchdog/nct6694_wdt.c @@ -0,0 +1,298 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 WDT driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include + +#define DRVNAME "nct6694_wdt" + +#define NCT6694_DEFAULT_TIMEOUT 10 +#define NCT6694_DEFAULT_PRETIMEOUT 0 + +/* + * USB command module type for NCT6694 WDT controller. + * This defines the module type used for communication with the NCT6694 + * WDT controller over the USB interface. + */ +#define NCT6694_WDT_MOD 0x07 + +/* Command 00h - WDT Setup */ +#define NCT6694_WDT_SETUP 0x00 +#define NCT6694_WDT_SETUP_SEL(idx) (idx ? 0x01 : 0x00) + +/* Command 01h - WDT Command */ +#define NCT6694_WDT_COMMAND 0x01 +#define NCT6694_WDT_COMMAND_SEL(idx) (idx ? 0x01 : 0x00) + +static unsigned int timeout = NCT6694_DEFAULT_TIMEOUT; +module_param(timeout, int, 0); +MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds"); + +static unsigned int pretimeout = NCT6694_DEFAULT_PRETIMEOUT; +module_param(pretimeout, int, 0); +MODULE_PARM_DESC(pretimeout, "Watchdog pre-timeout in seconds"); + +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) ")"); + +enum { + NCT6694_ACTION_NONE = 0, + NCT6694_ACTION_SIRQ, + NCT6694_ACTION_GPO, +}; + +struct __packed nct6694_wdt_setup { + __le32 pretimeout; + __le32 timeout; + u8 owner; + u8 scratch; + u8 control; + u8 status; + __le32 countdown; +}; + +struct __packed nct6694_wdt_cmd { + __le32 wdt_cmd; + __le32 reserved; +}; + +union __packed nct6694_wdt_msg { + struct nct6694_wdt_setup setup; + struct nct6694_wdt_cmd cmd; +}; + +struct nct6694_wdt_data { + struct watchdog_device wdev; + struct device *dev; + struct nct6694 *nct6694; + struct mutex lock; + union nct6694_wdt_msg *msg; + unsigned int wdev_idx; +}; + +static int nct6694_wdt_setting(struct watchdog_device *wdev, + u32 timeout_val, u8 timeout_act, + u32 pretimeout_val, u8 pretimeout_act) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_setup *setup = &data->msg->setup; + const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_WDT_MOD, + .cmd = NCT6694_WDT_SETUP, + .sel = NCT6694_WDT_SETUP_SEL(data->wdev_idx), + .len = cpu_to_le16(sizeof(*setup)) + }; + unsigned int timeout_fmt, pretimeout_fmt; + + guard(mutex)(&data->lock); + + if (pretimeout_val == 0) + pretimeout_act = NCT6694_ACTION_NONE; + + timeout_fmt = (timeout_val * 1000) | (timeout_act << 24); + pretimeout_fmt = (pretimeout_val * 1000) | (pretimeout_act << 24); + + memset(setup, 0, sizeof(*setup)); + setup->timeout = cpu_to_le32(timeout_fmt); + setup->pretimeout = cpu_to_le32(pretimeout_fmt); + + return nct6694_write_msg(data->nct6694, &cmd_hd, setup); +} + +static int nct6694_wdt_start(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + int ret; + + ret = nct6694_wdt_setting(wdev, wdev->timeout, NCT6694_ACTION_GPO, + wdev->pretimeout, NCT6694_ACTION_GPO); + if (ret) + return ret; + + dev_dbg(data->dev, "Setting WDT(%d): timeout = %d, pretimeout = %d\n", + data->wdev_idx, wdev->timeout, wdev->pretimeout); + + return ret; +} + +static int nct6694_wdt_stop(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_cmd *cmd = &data->msg->cmd; + const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_WDT_MOD, + .cmd = NCT6694_WDT_COMMAND, + .sel = NCT6694_WDT_COMMAND_SEL(data->wdev_idx), + .len = cpu_to_le16(sizeof(*cmd)) + }; + + guard(mutex)(&data->lock); + + memcpy(&cmd->wdt_cmd, "WDTC", 4); + cmd->reserved = 0; + + return nct6694_write_msg(data->nct6694, &cmd_hd, cmd); +} + +static int nct6694_wdt_ping(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_cmd *cmd = &data->msg->cmd; + const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_WDT_MOD, + .cmd = NCT6694_WDT_COMMAND, + .sel = NCT6694_WDT_COMMAND_SEL(data->wdev_idx), + .len = cpu_to_le16(sizeof(*cmd)) + }; + + guard(mutex)(&data->lock); + memcpy(&cmd->wdt_cmd, "WDTS", 4); + cmd->reserved = 0; + + return nct6694_write_msg(data->nct6694, &cmd_hd, cmd); +} + +static int nct6694_wdt_set_timeout(struct watchdog_device *wdev, + unsigned int new_timeout) +{ + int ret; + + ret = nct6694_wdt_setting(wdev, new_timeout, NCT6694_ACTION_GPO, + wdev->pretimeout, NCT6694_ACTION_GPO); + if (ret) + return ret; + + wdev->timeout = new_timeout; + + return 0; +} + +static int nct6694_wdt_set_pretimeout(struct watchdog_device *wdev, + unsigned int new_pretimeout) +{ + int ret; + + ret = nct6694_wdt_setting(wdev, wdev->timeout, NCT6694_ACTION_GPO, + new_pretimeout, NCT6694_ACTION_GPO); + if (ret) + return ret; + + wdev->pretimeout = new_pretimeout; + + return 0; +} + +static unsigned int nct6694_wdt_get_time(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_setup *setup = &data->msg->setup; + const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_WDT_MOD, + .cmd = NCT6694_WDT_SETUP, + .sel = NCT6694_WDT_SETUP_SEL(data->wdev_idx), + .len = cpu_to_le16(sizeof(*setup)) + }; + unsigned int timeleft_ms; + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, &cmd_hd, setup); + if (ret) + return 0; + + timeleft_ms = le32_to_cpu(setup->countdown); + + return timeleft_ms / 1000; +} + +static const struct watchdog_info nct6694_wdt_info = { + .options = WDIOF_SETTIMEOUT | + WDIOF_KEEPALIVEPING | + WDIOF_MAGICCLOSE | + WDIOF_PRETIMEOUT, + .identity = DRVNAME, +}; + +static const struct watchdog_ops nct6694_wdt_ops = { + .owner = THIS_MODULE, + .start = nct6694_wdt_start, + .stop = nct6694_wdt_stop, + .set_timeout = nct6694_wdt_set_timeout, + .set_pretimeout = nct6694_wdt_set_pretimeout, + .get_timeleft = nct6694_wdt_get_time, + .ping = nct6694_wdt_ping, +}; + +static int nct6694_wdt_probe(struct platform_device *pdev) +{ + const struct mfd_cell *cell = mfd_get_cell(pdev); + struct device *dev = &pdev->dev; + struct nct6694 *nct6694 = dev_get_drvdata(pdev->dev.parent); + struct nct6694_wdt_data *data; + struct watchdog_device *wdev; + int ret; + + data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->msg = devm_kzalloc(dev, sizeof(union nct6694_wdt_msg), + GFP_KERNEL); + if (!data->msg) + return -ENOMEM; + + data->dev = dev; + data->nct6694 = nct6694; + data->wdev_idx = cell->id; + + wdev = &data->wdev; + wdev->info = &nct6694_wdt_info; + wdev->ops = &nct6694_wdt_ops; + wdev->timeout = timeout; + wdev->pretimeout = pretimeout; + if (timeout < pretimeout) { + dev_warn(data->dev, "pretimeout < timeout. Setting to zero\n"); + wdev->pretimeout = 0; + } + + wdev->min_timeout = 1; + wdev->max_timeout = 255; + + ret = devm_mutex_init(dev, &data->lock); + if (ret) + return ret; + + platform_set_drvdata(pdev, data); + + watchdog_set_drvdata(&data->wdev, data); + watchdog_set_nowayout(&data->wdev, nowayout); + watchdog_stop_on_reboot(&data->wdev); + + return devm_watchdog_register_device(dev, &data->wdev); +} + +static struct platform_driver nct6694_wdt_driver = { + .driver = { + .name = DRVNAME, + }, + .probe = nct6694_wdt_probe, +}; + +module_platform_driver(nct6694_wdt_driver); + +MODULE_DESCRIPTION("USB-WDT driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:nct6694-wdt"); From patchwork Tue Feb 25 08:16:44 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 868472 Received: from mail-pl1-f176.google.com (mail-pl1-f176.google.com [209.85.214.176]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8A0C6266573; Tue, 25 Feb 2025 08:17:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471456; cv=none; b=THA6MK/VtH3jntGiEoakocb/2T1v/9gO+578RUGjPy0JEJYPkkHGRbkP6XC3HZUf/b/KLs2dW/pzl6mLNz1XuxH8V79qG0mEeEMgQ7lcVKD5IGv4QO1hOiIUUX4om3e+jRxgbMxgrgK8lRB7AAG1yxsJ6CpR3uUAEJ8Lb9C8jW8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1740471456; c=relaxed/simple; bh=VyO1gY+quioa1x+mn9rphtVK2rIpVpnOMY66Pbkon2Q=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=Q4dpaYNhgelTxuC4y6DVfEIotPEAHznB8A6I5J9OcKBIdCOgY2GZfesT4nsGFXRB11v2pT80zoauuC55M44cKvgUzuC6KHZkXhyrnc3O8THkARD/XQkz/DTI5359FArWUfSYQXg4TwYOttFtr6xg5T1EO2DzSQ8elrDMJah+PxA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=CZulISXl; arc=none smtp.client-ip=209.85.214.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="CZulISXl" Received: by mail-pl1-f176.google.com with SMTP id d9443c01a7336-220bfdfb3f4so5173065ad.2; Tue, 25 Feb 2025 00:17:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1740471454; x=1741076254; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=R1/MlL808W3xu35xb2GKiIvjOGN0x2mk1uW+PFc6mZk=; b=CZulISXlk9qLWI/IS6cgKeiJFoyH2JjY/jmWcitmWyQ5VaVdgJO5ndb4+IgDJdIH++ 9aHzx4fge/HbBRgOyp4IIR438GRvH5qGhftixoVZzFNeoJ0ZwBIJDUr/mgMedAvhkYl4 2htu2iIbOlW1rHowdpHDhAqj0n5hi+v6okxeMWA3VxOs8+5A6Xko3/XNH0lmGSKOeWK6 wmhEHMKJRi5RL2gj5EyII8eKL559uCETnmtAjQf2NwAGqSpLJtO8dxB5iFld9DX2rVEk 8ZQqN/5y74UBqw5E+QHkuUyNZpXrKKXjwTH+GZ8qvYBw74ycPMx24EKxPMoAybV+39zB W17w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1740471454; x=1741076254; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=R1/MlL808W3xu35xb2GKiIvjOGN0x2mk1uW+PFc6mZk=; b=CbSHhoE9UtZKEYR7f3UPqRGAPTT6bHnD4r2t0V3EIQGMmc1Ab//h/JY/P5iqImLQqk 3r+jHnBGyrl1RdLaPUF3GxRCyoQNaTxf47UsQZl2XAGz2i2utg9i9uWj+8P388bIC2Si aozsDURIk/BNaKBy+8OeWrqI/jM5MlzpscBJ+C+M78VF4Vxr2IHWq3fNPQA3PIQyu1LR 9MWtqPQuxBmyODFTvCc0jaPy5NW6tENgxIy03Yxqhz1PGXLEbysdt7ifd6NMkLjTbf4Y no8Jw3my2grvjwG20DGC5DGIF2bSFpBDsfG77wAXWrza8sL1ZLIQMnfXO7TKx+Nte3yU TN4g== X-Forwarded-Encrypted: i=1; AJvYcCUHNL/LCJrLys9Tyjpv4Blq6TFr1VRFN+vy3nFVkbEmG/Ko1VcCnj9xqpvsu+WgetW34uoXqzRyhp47Jw==@vger.kernel.org, AJvYcCUJP6F+KpprkM5Mp30xho4SoSZ7l7aSoIF7e5ODIZl539OuXC4Zpo4Oo4aToAM4hf+nd/SPM1MMnb0=@vger.kernel.org, AJvYcCULkiIVfsXQj64MXi6XU/MXJnal+PWYOf9NHQopgDwpFdvb+Dm+n8kUZGtLzdPvwqaconPCvWXdJamw@vger.kernel.org, AJvYcCVBhh+h7QJ0lNrLrypJQB6Yrn1ix8HjrByjmxtRa5sCQMHzuRTVWKMiH9PhfRd/MhAhRc/Bn8iFxfih@vger.kernel.org, AJvYcCWFpywrrhSi/WCcGwSanNM9PwomGMD/OnGg1i/d63bZ1euIPtmFCICdLaQSaBeorMO442a/UvIj6AEp@vger.kernel.org, AJvYcCWJojWUrJSQ1FHn4THjEb/Ts4FMXb9T8YWlcxGTI2VK+Cv4y7SmtbxqiSAjKqoDzznNq5lTmw3lbKQvzp7QdCE=@vger.kernel.org, AJvYcCWd6mKjdrKDGDVrglYeEF2ZzY3vFgEheETfA8e6IxFXEDx7XaMw0stGC4iDpVwGpdTOK0rPC9IItX+giNU=@vger.kernel.org, AJvYcCWkS6f8Tqqjw4TRPtyL7JtdtVClR6u2vcWObjOsuXiRM7NibXCbRqRJgL1/y7DVwxtDlVlyXAYP@vger.kernel.org X-Gm-Message-State: AOJu0YyYEEibpkqTmV9H7ygEZRSv8R134jWg1/Ebb3yw4fpDwyBnAyJg 1hfn23ST6wLHqlXmQ2sq2K7K/HaKjb6vD6oBsONfMQ+jSNdi8Dht X-Gm-Gg: ASbGnctdU3FLaRax3ZpycW3WTa05udr94lt0a6UtL5i4qG7Nx4lrA9OGUZHAFxDxzbK V/OiWbiaXExuHy60R9oMn0MHJ+3ZrWszhFGAKan7LEJ9+iq8w/b97Ox0F2pVMeFU3T/MUTnZSfE wZ4w2fkKlJ7SHafsvxy/yVbur3X9SgmefDX6c+fzWQXgA5viNYRGdNLJ44m/w5IKzQ3pHEq7M8H CppRC7sVb073TRFNhusWb0+6bMyNFF/rH/sx6GUdNTssns1QbWUw5roMsaH5UCdbH/MNkkrMpFK Cr450sjOlffKoya7dczAoETYk54kHwspSpsDrU2bNBK3VtklV3c4OGjj7nMep9xv4vBb4w== X-Google-Smtp-Source: AGHT+IH/gdqYrLFyBEtR8VWeKFEBaSCVXjtQW0HPLKg4ppwIhgMGGP47oVP66uI6RA/b/qX2/N13dA== X-Received: by 2002:a05:6a00:b84:b0:732:2170:b696 with SMTP id d2e1a72fcca58-73426daad91mr26552886b3a.22.1740471453637; Tue, 25 Feb 2025 00:17:33 -0800 (PST) Received: from hcdev-d520mt2.. (60-250-196-139.hinet-ip.hinet.net. [60.250.196.139]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-7347a6abaddsm902178b3a.20.2025.02.25.00.17.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 25 Feb 2025 00:17:33 -0800 (PST) From: Ming Yu To: tmyu0@nuvoton.com, lee@kernel.org, linus.walleij@linaro.org, brgl@bgdev.pl, andi.shyti@kernel.org, mkl@pengutronix.de, mailhol.vincent@wanadoo.fr, andrew+netdev@lunn.ch, davem@davemloft.net, edumazet@google.com, kuba@kernel.org, pabeni@redhat.com, wim@linux-watchdog.org, linux@roeck-us.net, jdelvare@suse.com, alexandre.belloni@bootlin.com Cc: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org, linux-i2c@vger.kernel.org, linux-can@vger.kernel.org, netdev@vger.kernel.org, linux-watchdog@vger.kernel.org, linux-hwmon@vger.kernel.org, linux-rtc@vger.kernel.org, linux-usb@vger.kernel.org, Ming Yu Subject: [PATCH v8 7/7] rtc: Add Nuvoton NCT6694 RTC support Date: Tue, 25 Feb 2025 16:16:44 +0800 Message-Id: <20250225081644.3524915-8-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250225081644.3524915-1-a0282524688@gmail.com> References: <20250225081644.3524915-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-usb@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports RTC functionality for NCT6694 MFD device based on USB interface. Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/rtc/Kconfig | 10 ++ drivers/rtc/Makefile | 1 + drivers/rtc/rtc-nct6694.c | 286 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 298 insertions(+) create mode 100644 drivers/rtc/rtc-nct6694.c diff --git a/MAINTAINERS b/MAINTAINERS index a9eda4530b07..7eba4ffdc877 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16927,6 +16927,7 @@ F: drivers/hwmon/nct6694-hwmon.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: drivers/net/can/usb/nct6694_canfd.c +F: drivers/rtc/rtc-nct6694.c F: drivers/watchdog/nct6694_wdt.c F: include/linux/mfd/nct6694.h diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig index 0bbbf778ecfa..248425bf26f3 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -416,6 +416,16 @@ config RTC_DRV_NCT3018Y This driver can also be built as a module, if so, the module will be called "rtc-nct3018y". +config RTC_DRV_NCT6694 + tristate "Nuvoton NCT6694 RTC support" + depends on MFD_NCT6694 + help + If you say yes to this option, support will be included for Nuvoton + NCT6694, a USB device to RTC. + + This driver can also be built as a module. If so, the module will + be called rtc-nct6694. + config RTC_DRV_RK808 tristate "Rockchip RK805/RK808/RK809/RK817/RK818 RTC" depends on MFD_RK8XX diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile index 489b4ab07068..d0d6f4a4972e 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -118,6 +118,7 @@ obj-$(CONFIG_RTC_DRV_MXC) += rtc-mxc.o obj-$(CONFIG_RTC_DRV_MXC_V2) += rtc-mxc_v2.o obj-$(CONFIG_RTC_DRV_GAMECUBE) += rtc-gamecube.o obj-$(CONFIG_RTC_DRV_NCT3018Y) += rtc-nct3018y.o +obj-$(CONFIG_RTC_DRV_NCT6694) += rtc-nct6694.o obj-$(CONFIG_RTC_DRV_NTXEC) += rtc-ntxec.o obj-$(CONFIG_RTC_DRV_OMAP) += rtc-omap.o obj-$(CONFIG_RTC_DRV_OPAL) += rtc-opal.o diff --git a/drivers/rtc/rtc-nct6694.c b/drivers/rtc/rtc-nct6694.c new file mode 100644 index 000000000000..892674d453d1 --- /dev/null +++ b/drivers/rtc/rtc-nct6694.c @@ -0,0 +1,286 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 RTC driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* + * USB command module type for NCT6694 RTC controller. + * This defines the module type used for communication with the NCT6694 + * RTC controller over the USB interface. + */ +#define NCT6694_RTC_MOD 0x08 + +/* Command 00h - RTC Time */ +#define NCT6694_RTC_TIME 0x0000 +#define NCT6694_RTC_TIME_SEL 0x00 + +/* Command 01h - RTC Alarm */ +#define NCT6694_RTC_ALARM 0x01 +#define NCT6694_RTC_ALARM_SEL 0x00 + +/* Command 02h - RTC Status */ +#define NCT6694_RTC_STATUS 0x02 +#define NCT6694_RTC_STATUS_SEL 0x00 + +#define NCT6694_RTC_IRQ_INT_EN BIT(0) /* Transmit a USB INT-in when RTC alarm */ +#define NCT6694_RTC_IRQ_GPO_EN BIT(5) /* Trigger a GPO Low Pulse when RTC alarm */ + +#define NCT6694_RTC_IRQ_EN (NCT6694_RTC_IRQ_INT_EN | NCT6694_RTC_IRQ_GPO_EN) +#define NCT6694_RTC_IRQ_STS BIT(0) /* Write 1 clear IRQ status */ + +struct __packed nct6694_rtc_time { + u8 sec; + u8 min; + u8 hour; + u8 week; + u8 day; + u8 month; + u8 year; +}; + +struct __packed nct6694_rtc_alarm { + u8 sec; + u8 min; + u8 hour; + u8 alarm_en; + u8 alarm_pend; +}; + +struct __packed nct6694_rtc_status { + u8 irq_en; + u8 irq_pend; +}; + +union __packed nct6694_rtc_msg { + struct nct6694_rtc_time time; + struct nct6694_rtc_alarm alarm; + struct nct6694_rtc_status sts; +}; + +struct nct6694_rtc_data { + struct nct6694 *nct6694; + struct rtc_device *rtc; + union nct6694_rtc_msg *msg; +}; + +static int nct6694_rtc_read_time(struct device *dev, struct rtc_time *tm) +{ + struct nct6694_rtc_data *data = dev_get_drvdata(dev); + struct nct6694_rtc_time *time = &data->msg->time; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_TIME, + .sel = NCT6694_RTC_TIME_SEL, + .len = cpu_to_le16(sizeof(*time)) + }; + int ret; + + ret = nct6694_read_msg(data->nct6694, &cmd_hd, time); + if (ret) + return ret; + + tm->tm_sec = bcd2bin(time->sec); /* tm_sec expect 0 ~ 59 */ + tm->tm_min = bcd2bin(time->min); /* tm_min expect 0 ~ 59 */ + tm->tm_hour = bcd2bin(time->hour); /* tm_hour expect 0 ~ 23 */ + tm->tm_wday = bcd2bin(time->week) - 1; /* tm_wday expect 0 ~ 6 */ + tm->tm_mday = bcd2bin(time->day); /* tm_mday expect 1 ~ 31 */ + tm->tm_mon = bcd2bin(time->month) - 1; /* tm_month expect 0 ~ 11 */ + tm->tm_year = bcd2bin(time->year) + 100; /* tm_year expect since 1900 */ + + return ret; +} + +static int nct6694_rtc_set_time(struct device *dev, struct rtc_time *tm) +{ + struct nct6694_rtc_data *data = dev_get_drvdata(dev); + struct nct6694_rtc_time *time = &data->msg->time; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_TIME, + .sel = NCT6694_RTC_TIME_SEL, + .len = cpu_to_le16(sizeof(*time)) + }; + + time->sec = bin2bcd(tm->tm_sec); + time->min = bin2bcd(tm->tm_min); + time->hour = bin2bcd(tm->tm_hour); + time->week = bin2bcd(tm->tm_wday + 1); + time->day = bin2bcd(tm->tm_mday); + time->month = bin2bcd(tm->tm_mon + 1); + time->year = bin2bcd(tm->tm_year - 100); + + return nct6694_write_msg(data->nct6694, &cmd_hd, time); +} + +static int nct6694_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm) +{ + struct nct6694_rtc_data *data = dev_get_drvdata(dev); + struct nct6694_rtc_alarm *alarm = &data->msg->alarm; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_ALARM, + .sel = NCT6694_RTC_ALARM_SEL, + .len = cpu_to_le16(sizeof(*alarm)) + }; + int ret; + + ret = nct6694_read_msg(data->nct6694, &cmd_hd, alarm); + if (ret) + return ret; + + alrm->time.tm_sec = bcd2bin(alarm->sec); + alrm->time.tm_min = bcd2bin(alarm->min); + alrm->time.tm_hour = bcd2bin(alarm->hour); + alrm->enabled = alarm->alarm_en; + alrm->pending = alarm->alarm_pend; + + return ret; +} + +static int nct6694_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm) +{ + struct nct6694_rtc_data *data = dev_get_drvdata(dev); + struct nct6694_rtc_alarm *alarm = &data->msg->alarm; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_ALARM, + .sel = NCT6694_RTC_ALARM_SEL, + .len = cpu_to_le16(sizeof(*alarm)) + }; + + alarm->sec = bin2bcd(alrm->time.tm_sec); + alarm->min = bin2bcd(alrm->time.tm_min); + alarm->hour = bin2bcd(alrm->time.tm_hour); + alarm->alarm_en = alrm->enabled ? NCT6694_RTC_IRQ_EN : 0; + alarm->alarm_pend = 0; + + return nct6694_write_msg(data->nct6694, &cmd_hd, alarm); +} + +static int nct6694_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) +{ + struct nct6694_rtc_data *data = dev_get_drvdata(dev); + struct nct6694_rtc_status *sts = &data->msg->sts; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_STATUS, + .sel = NCT6694_RTC_STATUS_SEL, + .len = cpu_to_le16(sizeof(*sts)) + }; + + if (enabled) + sts->irq_en |= NCT6694_RTC_IRQ_EN; + else + sts->irq_en &= ~NCT6694_RTC_IRQ_EN; + + sts->irq_pend = 0; + + return nct6694_write_msg(data->nct6694, &cmd_hd, sts); +} + +static const struct rtc_class_ops nct6694_rtc_ops = { + .read_time = nct6694_rtc_read_time, + .set_time = nct6694_rtc_set_time, + .read_alarm = nct6694_rtc_read_alarm, + .set_alarm = nct6694_rtc_set_alarm, + .alarm_irq_enable = nct6694_rtc_alarm_irq_enable, +}; + +static irqreturn_t nct6694_irq(int irq, void *dev_id) +{ + struct nct6694_rtc_data *data = dev_id; + struct nct6694_rtc_status *sts = &data->msg->sts; + static const struct nct6694_cmd_header cmd_hd = { + .mod = NCT6694_RTC_MOD, + .cmd = NCT6694_RTC_STATUS, + .sel = NCT6694_RTC_STATUS_SEL, + .len = cpu_to_le16(sizeof(*sts)) + }; + int ret; + + rtc_lock(data->rtc); + + sts->irq_en = NCT6694_RTC_IRQ_EN; + sts->irq_pend = NCT6694_RTC_IRQ_STS; + ret = nct6694_write_msg(data->nct6694, &cmd_hd, sts); + if (ret) { + rtc_unlock(data->rtc); + return IRQ_NONE; + } + + rtc_update_irq(data->rtc, 1, RTC_IRQF | RTC_AF); + + rtc_unlock(data->rtc); + + return IRQ_HANDLED; +} + +static int nct6694_rtc_probe(struct platform_device *pdev) +{ + struct nct6694_rtc_data *data; + struct nct6694 *nct6694 = dev_get_drvdata(pdev->dev.parent); + int ret, irq; + + irq = irq_create_mapping(nct6694->domain, NCT6694_IRQ_RTC); + if (!irq) + return -EINVAL; + + data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->msg = devm_kzalloc(&pdev->dev, sizeof(union nct6694_rtc_msg), + GFP_KERNEL); + if (!data->msg) + return -ENOMEM; + + data->rtc = devm_rtc_allocate_device(&pdev->dev); + if (IS_ERR(data->rtc)) + return PTR_ERR(data->rtc); + + data->nct6694 = nct6694; + data->rtc->ops = &nct6694_rtc_ops; + data->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000; + data->rtc->range_max = RTC_TIMESTAMP_END_2099; + + platform_set_drvdata(pdev, data); + + ret = devm_request_threaded_irq(&pdev->dev, irq, NULL, + nct6694_irq, IRQF_ONESHOT, + "rtc-nct6694", data); + if (ret < 0) + return dev_err_probe(&pdev->dev, ret, "Failed to request irq\n"); + + ret = devm_rtc_register_device(data->rtc); + if (ret) + return ret; + + device_init_wakeup(&pdev->dev, true); + return 0; +} + +static struct platform_driver nct6694_rtc_driver = { + .driver = { + .name = "rtc-nct6694", + }, + .probe = nct6694_rtc_probe, +}; + +module_platform_driver(nct6694_rtc_driver); + +MODULE_DESCRIPTION("USB-RTC driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); +MODULE_ALIAS("platform:nct6694-rtc");