From patchwork Fri Feb 7 07:44:56 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 863272 Received: from mail-pj1-f45.google.com (mail-pj1-f45.google.com [209.85.216.45]) (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 53F7A1A5BA2; Fri, 7 Feb 2025 07:45:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.45 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914324; cv=none; b=qaNXAdq7/Ynn6gNc8KJv6Uq3GCQi/kXb8UIwI5hxf5N2SqsknZxVFH6RjH0aavqLnMrHIfFhFu4dOxviz7kRGfqzzuGvDoQMqUSl2ihUnjGCVi9O1QuE+UUjrXUNr363z52z8UuBjBF1mwkzhVkcahZDFM23srKst90eLY/I5sM= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914324; c=relaxed/simple; bh=bBMBUG/TLz3wnhFozI14dhEvByTW5PN34WV2IuwtIoo=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=a/fCh1GCBwCE10aNzAEkhi+MZHE5rKEMkaVItWMeUfLZXDVj5UwJ0rpphQT6u6hnu35w8iQV6It0FdxAVAwWx7/TPsXu82Nt63Qq+h52THC8gDnR5lUI6XuPALm1jtVwWVihy3HkqcylFdmEDnTdfSM/zfOnGUnaKCTCcCrJLQg= 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=dcWChcnB; arc=none smtp.client-ip=209.85.216.45 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="dcWChcnB" Received: by mail-pj1-f45.google.com with SMTP id 98e67ed59e1d1-2ee9a780de4so2800783a91.3; Thu, 06 Feb 2025 23:45:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738914321; x=1739519121; 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=4m9cDfieDHuMcwATErZ9wtQJWUp1rjyzePh7/TrWy68=; b=dcWChcnBs4zCi3l+nfcVm4/FADD3szD42m5Q3Qz3bf93p/wYcK3Y0vgDgQ6R9aoWoo alZOR08LkLFn9SDFSBMmd3yM4YxeCOBGQ5lCpnMNR/fqhCCGuqi33cCADQD7oTK+Ui33 l2Tn1C62o8mFDR8o4WcK5UgI9XqTvakF5Z8YbMaDeA1QBHc+KntuID+usK/dNjSiB+0f 3+bIPLa8XMOkMaj8lD+ZGCqYS3SaqRYojaw8fV0gv+r4C9YGGzw0WVjTO2G2llJvjnAr abCsLZ48/SgZKGkoZTCKyfdKed1BwBACxuLTkmqRFSJ3yuGI9HZPJk7HLmDLQdxfB0NA zS6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738914321; x=1739519121; 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=4m9cDfieDHuMcwATErZ9wtQJWUp1rjyzePh7/TrWy68=; b=NLLswEmW9n7JVucVWHI8UfO0zKL+7U8AHSkQeriGJu8qycvX/vTyoIVS0RQ/nKGpJO UWl827tINXtForwldNSop/Jk9/QHe6t5S4i3uk/pS4PQMO9OPtr3gxa+XCgBX2f82OZO 0+QwtglFg8/KAd9ZuflEeqSWtdYMcsbKTnJsT7iOL5Hhzu48AickJMvz8l0ThYo+8lLz tHrAjIpt0k06z38gywaAv4Bapa4VnJH6Ssejw3FmoJ6sIif4LARwmbrFaaW0Ip5p/l7b DWChf6oXSpdVK04OcQ8mHONjfpDg370LKkmRK9dFR9yEE9Rqe+2LHc5EIDcyPN44A1SR XXFw== X-Forwarded-Encrypted: i=1; AJvYcCU3W8d0kZjbwNc+yOkR3q/PiBP1k9rreFt2bBSm3qGFOPsKGQAPx/eKo7uGUSgDiH2PtuFez/7o9CpHAtRkBwI=@vger.kernel.org, AJvYcCUWZpRgIyLLseBpx/854ifW7wQUcPmr2xtp/jfuX/dAE7KPVQepSoP45o0np0L44XVCmHtfpQfkDV1f@vger.kernel.org, AJvYcCVfcjhHLCpKamxso1AdbdKqQjBr5dM4FmeyqB2aRqmBz9pH2N8tMZ9mIoslw4qCzTkoQbpwEDuuGt+mkg==@vger.kernel.org, AJvYcCViRPuyMswTAJRRqql9lqk/tZyKUZr/+MeTV6OtL2Fu0uc8UK+myt+EFVd04wpCXn+r1jiC3ErU@vger.kernel.org, AJvYcCVlY2YEpLOa9x6FK68uUxtJkM8t5j5KfcTjgE51sMx3vkAanGarug3nXH9ecqAf8ZKmlvOmzX0u8RTX@vger.kernel.org, AJvYcCVpsTeh1rVMhBIjfj6NATLKoJRFYKhxBBTxikCn5ZxDm0DDIap+lP70NtJH+YV/eGx2lk+6+bXtUDU=@vger.kernel.org, AJvYcCXBzAGzx8NGlg92p3Y5SzK+rM+semyBsHPLgoXsAAmLbI1n0lmEe03PumXLwuxnNt4TIMbeRyU4ZhcB+/w=@vger.kernel.org, AJvYcCXP7upawoTQ+wPIFwm0Pi930pQCNQ3Ki56Pzy8ffUAkdw2jQvJLfK0TFkpH4OGw9LQ6FGjnFc7QSRv/@vger.kernel.org X-Gm-Message-State: AOJu0YxbrtjzXbpDn2cKhcoDh8OpytIIwV6j9IqVagE4WnCVNg9cLIDZ x98irNyeM+EgnLdPVoYDtXBpAYWQblOIVquoz2llhcNIaj3J2kxe X-Gm-Gg: ASbGncszXuKepL/3fci04moAkd8/WVVZ6PrdtGlG6UQovro5BFnctIoRzkodJZ0NTF+ Nifp4FUsbvk2FboYfslt09x9D6+QPE3Zqi/jg3yI++s7jZUUAvYFV0t4SoVhIHpmb3gT8Lcvyke ZU8QyAfNdHYhSEx5uljCwe5YWv1s3xtFm2Ft+h4DYEfkAW+Kwj3uSowd9NQy3/PYjiLLOAh7Be0 MQwVli9lYOtZxKyFaKs7c/S2XxSCreZ+MgFwX5iHu1tPj9DlmdRoT/L3fDeUzxRb1MU+qPlcx1b r4htuuUM8OEn/A2UE6hOmWeYUhCt4tnG5lwm96l7aea2hwHNfUmn5VMOxVA= X-Google-Smtp-Source: AGHT+IFfrJn2JbuEbL9x8pZ6nbx8qzAAjEN55Q80oiC4xBGtVV/xbZFo3FcjdfZvQjpQiac2cJCfnw== X-Received: by 2002:a17:90b:4b8c:b0:2fa:20f4:d27a with SMTP id 98e67ed59e1d1-2fa23f5330dmr3659976a91.7.1738914321277; Thu, 06 Feb 2025 23:45:21 -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 98e67ed59e1d1-2f9e1d5f8d6sm4967367a91.7.2025.02.06.23.45.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2025 23:45:20 -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 v7 1/7] mfd: Add core driver for Nuvoton NCT6694 Date: Fri, 7 Feb 2025 15:44:56 +0800 Message-Id: <20250207074502.1055111-2-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250207074502.1055111-1-a0282524688@gmail.com> References: <20250207074502.1055111-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-watchdog@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 | 373 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/nct6694.h | 102 ++++++++++ 5 files changed, 502 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..ab857d5b06a5 --- /dev/null +++ b/drivers/mfd/nct6694.c @@ -0,0 +1,373 @@ +// 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 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 */ + + devm_mutex_init(dev, &nct6694->access_lock); + devm_mutex_init(dev, &nct6694->irq_lock); + + 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..c75a69f04927 --- /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_CAN1, + NCT6694_IRQ_CAN2, + 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 Fri Feb 7 07:44:58 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 863271 Received: from mail-pj1-f49.google.com (mail-pj1-f49.google.com [209.85.216.49]) (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 7CFF4233149; Fri, 7 Feb 2025 07:45:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.49 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914333; cv=none; b=XC1wmMkXmTHYxH+s7Bc2oMbqrzMbMEgB3Cjx09KpAycw1n6sCuxRBTTgK6Z1rE8GT6sFe60rjnlDL6Is2aeZWVVAPGvuXKbY2p3+OeCsdEcVgGvxdvWr7r/TIsbmx+nS6UcnxQGmjlRbL8vaGd0KJhre9wr7uHmaDXaJDj7OZKY= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914333; c=relaxed/simple; bh=RXsq1NcL3DKTjfS8a6SN0dZw1IKe2ELzM77Imhm+ix8=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=NdRuib6rXE1qUh3/hZ4o4tyisln+Kb6ChUd9mZ7NAmvaQcL+pG4rnkL4uAuarktaTJ5I4vkajknxoU+sYAfhEWZuBLAejukF1UIDGMZ2bvENynjpBxHS2BputyQG+jr9BobwTHs5VM3HsYR0amWEiSEg78tqMG3LHrH9RDOzzxc= 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=ajEiivrU; arc=none smtp.client-ip=209.85.216.49 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="ajEiivrU" Received: by mail-pj1-f49.google.com with SMTP id 98e67ed59e1d1-2ee9a780de4so2801017a91.3; Thu, 06 Feb 2025 23:45:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738914331; x=1739519131; 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=FO2aEDA5hjCU4efzP7RpvFcN2oikBDau/9P080xiKFY=; b=ajEiivrUNKqVW4xT649APBHz3MGNbu9zn2iPVxuA3X7vGBcPk4qqox2QPF1ertV0pk LH538I67uPw7RnRk2hffM3NsstKCd3UtERlu4lkTvPM6pYz6Nb17S4RukfJv4fvklZsp peT/GNw5lgpaF8cfg3OlaHGOvbyptZGiEdjN1tQ/0TztOa/lmwXOsETAFbpWXFRlmUTd PzcsfPS2/xTOWHpw02L8Py2Op6a69+ix4i1vfxDTFGAl3eHN6JjJrO8F6ROInmPzOgvU 7mPkvPWyoI90CDlh9blp2g14SaAV/qamD4b0/GldYOjUltVHWmQm0jdXWs8J5DSweXrX mCyw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738914331; x=1739519131; 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=FO2aEDA5hjCU4efzP7RpvFcN2oikBDau/9P080xiKFY=; b=qxUlgOzyVBHhrSPXJjMyHf5z+8HsPLcvme8Dvd21GJUg7JgJLa1LX1WeH2KdEonIXn OYT2KfADt4iMsaPSr/tZO+VUzZvdKsIVtllnr+2qgwRkEKtoj6Y6UQo5614o97aqbJL2 T+TnjJT0pEC+vWT2rvdGsAbSfvv4RbkhCwgTb3uA7rJ8SWdxt/wWwtpCdQAzO9ppGM3V oFXAKk/BtlVzq806pChV/c7O3hM46DfpyjVfU0bUXbB8HBjdIoz328kDxozKyY1uZTgl hJfk+0BSs0XsUzkxm1rpf2N5CJyYdNkMhVfoMel8k7U+gZcHfpKCDjbI9zXZJknvtto4 Wq0A== X-Forwarded-Encrypted: i=1; AJvYcCUGJcHcVhn41PIkQ59R5kQEh2JHb2yoGWuv7Dsi/B/A8v7s21pCFsUiA8wtCBVUIGZoko5Xabgu@vger.kernel.org, AJvYcCUzD88CNT4w+1FU781Xm3t2a3E8DGvmFSv+y1vLCWYwX+RXYZBJFufkxOvxQTyW3ARlDXfBDaUU/4K+@vger.kernel.org, AJvYcCVfkhYLtZwC2p1f59Tbd3k57KojJw7Lv3rZkvcVSiiva5lQ01SnA5Vr8r24VnD/wr1hwYCUd2x4dOQ=@vger.kernel.org, AJvYcCWFzoQnPidHJmFWORaHNgPNpOJHPv+rpPg0o6UltPxk7AqfPC7wwoZ+XvDhSAw3bFipF5uKMM6R2oyHp+Kqxnc=@vger.kernel.org, AJvYcCWKvR8hckF7vVDJfTnZ20x0RFykw5GrNZaTWAV5o/P+YUttT6zkZ4BxatHzQDQL4R+su4oD1iHHsjSy@vger.kernel.org, AJvYcCWOOx1LGg449Fzsx1iDgcWBPNT8/CpKzmnlBr3jLwW/KB8zoteohTGc51TZq0FUhmUf8VhnVuyMEde4@vger.kernel.org, AJvYcCX29DiDU2sEP8gIT8VpJ56PHDBpICQaI/w0pbUNGesU00RFkGYdRkSSj1ks/4iJzvrW9lb+sBMxMd6Ttww=@vger.kernel.org, AJvYcCXvAQAg0c8BaCvEabAgFSt6hWesTNVf03VBH0K9gl102tj6ZO5OxfO8ZzhbjlHpb0Uk66WhoBvFLAyDnw==@vger.kernel.org X-Gm-Message-State: AOJu0Yz7O34InFsWn1Cf4LEuSlGjgVH4FBkT/cDGnPBgeMEFJ42itQpB p7clZftAXMKhWXqxGH5gTZn68cmH6jlMc9PRX4cEqx1WaCAuvcby X-Gm-Gg: ASbGncudNI+tL/NQLAYyiZruL9qjUUXDJseu3P58guElMW1wfk2JTVFYVtPZrYN0m+V iBms60WYoLLZbok9imF1HUkFXKLkRd3iP0ezZbpcyMnwDDi5CL5lRDZ7LqAmybW2f1LeISjK30Y 9dKFUQZwm4udJkkO4qaU9FyTTDIrgUJfRXZ9B7ZwtdFT9435IIo2M0v03k7kWQ7LMWZp+VJrhaf PgqHP6WR2cRr3G0p+UcTnGi2LI7g7Fk4VAXm4FBjc2G4oIRaOZtWg3UrmmScWhIWUqRy5YBA9eF 50c8Qj3Fz4bhRHNS0K5ONTXIDaIcuLt5ev+xd1y3bn4CAHKZEy1Zc6xkckU= X-Google-Smtp-Source: AGHT+IF1AhhsJLi1YrJJXC+6SaqP546/+M57iunqBeZZFSrSsaqHdODVWhDBgLGfhak8G+MPw0rDAA== X-Received: by 2002:a17:90b:5544:b0:2ef:114d:7bf8 with SMTP id 98e67ed59e1d1-2fa23f5518fmr2906960a91.6.1738914330742; Thu, 06 Feb 2025 23:45:30 -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 98e67ed59e1d1-2f9e1d5f8d6sm4967367a91.7.2025.02.06.23.45.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2025 23:45:30 -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 v7 3/7] i2c: Add Nuvoton NCT6694 I2C support Date: Fri, 7 Feb 2025 15:44:58 +0800 Message-Id: <20250207074502.1055111-4-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250207074502.1055111-1-a0282524688@gmail.com> References: <20250207074502.1055111-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-watchdog@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..eb5b44182b5b --- /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 Fri Feb 7 07:45:00 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 863270 Received: from mail-pj1-f48.google.com (mail-pj1-f48.google.com [209.85.216.48]) (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 21B592343AA; Fri, 7 Feb 2025 07:45:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.48 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914342; cv=none; b=ONKE45EVwBwB+7frXXuKGrqUv/7GDfFfoBJKqDJLbdjqGiL3j5wqFmPdXwLCpB8Q68XOpu2KxPYAj/6o4PWlbzjnAONzbITY4SpqUki+iujwJgkDwLC8OedoW/twa/PoAjMoBJCcfUZEn2dyGEqK/lkndEDSnMbpxj2xhW/o6Vw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914342; c=relaxed/simple; bh=o5T5OQiSdzO3RhLgyMKFpSWgxBG12v7T/AmNTtb8V5Q=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=MPYAXgjFUGzcJBvqT8IOSomCjkAeDuPWvojBFJy9kb/Tk2bkNv5sqDcMkzVVJLjjwc5SiVjS9L9mxh+iQImyxnF6rEAGcaWu4ybjkiiEQ04jN/IfMn2ymTc/gyo+6GzoNpWy3//1x2idfbF89mzvx3efHIOEnKnNzXo+VFwnrt8= 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=i8+5IHYM; arc=none smtp.client-ip=209.85.216.48 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="i8+5IHYM" Received: by mail-pj1-f48.google.com with SMTP id 98e67ed59e1d1-2fa2eb7eb45so197673a91.1; Thu, 06 Feb 2025 23:45:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738914340; x=1739519140; 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=UurdY6Alt68aGySpMyscVszKXVOm2Q9HkACrygxskYE=; b=i8+5IHYMuly80v6d2hCFiEoShVMlbNhoTLiLo/gCIfiqGUQdJydv1lOELX+0evu9k0 kgMVlLfLyYjwyxTYllPVkEU0/34dc6FFBodZE+rw99Qsp2/sjqhEDg6C9J648WLXST2v ENUuiKbLpFTdx/2MqI+OD9KFx15cXBAUXpE9/dWSb1C+1d+YKi268uCrYc2IfQ8zBZwc ToQ76B46Gu0R+trZxIohIduBdEFYvnmJF0YUek26RiA9So0qt+5Mqv4qGROeI5qCjAYT vUmNRX3exTclgfdF3AuGGcc/My5B8d62SSjCW+/ZsOmYLqdgEuPDEhxCcqSFBLn1EY84 9sDQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738914340; x=1739519140; 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=UurdY6Alt68aGySpMyscVszKXVOm2Q9HkACrygxskYE=; b=DjdRA/gtvpF7TKZ8deW3sZMhMIpfvgqZL3XuKxb7/CZotDLefhBwSJdTptSOfFV0ez 8Sb2Ej5BCvBrUNdU4RiAphODPDV3yJN1QYAkQchVJsuqaTVzMCZAaq2zLkepnchGPcVU KLSclkMBiT/JoOrsatoN8OqW4wPB1+YitUvJEVkZAla8RNY2c4hYRwApfb8ECD7PzmAV dssrNhhBeIQx1txeF67XuTTq+lWLxLupsJwWZnEUcjL8UoNF/Naypcrp15Q8gJzT3JTI PelW1Dgza+Pkrt0L06zjQ7OULgu8eNj6vF1ccyXIuvKlSjnefEQpBFRTsMV2ayWD+b2c AFbQ== X-Forwarded-Encrypted: i=1; AJvYcCU0oVpUYHG+YW/MOQ8UruWLs7b/tQey1bvB7XvUfHDfpPTuWMjvGfz3w66yudcHwN5iCRitShuU@vger.kernel.org, AJvYcCUOTQmjQpjlEcyiqPK6+v/TRM9zlopCIn5r4fKTJixHQHcOE+EOgEzJQ5XaUzuTTOSAC2Rpx5FkIoBVqEZ4P/A=@vger.kernel.org, AJvYcCUTY0DMmKHe4mG6LVHjqX+6T144aSmWrQL7uguklS4ntOuWG2DWYritARTwzDP1I7m2ddrZ9h7hMoM=@vger.kernel.org, AJvYcCUq5cccvZsOD4GxDpnaTpllmiaboeNRfICzAIIkVtIIAlgK8I2YEghmw/ITPLk46mZkA/4PSqVtDJQY@vger.kernel.org, AJvYcCVTMJ4ltl2GUsl1FNEFSW4tiulmrmoyKABQILcVayBTW0vTF3ZRWJeJiKSDKdFVU9oaRGQY4Nn0pmyC@vger.kernel.org, AJvYcCVcL4MY0YBcHOqe0GC9aQ7PoIZFzdrs9AMzhrAht6dDxI0Jmn9emx5i8PuqF2bglv0rwwvC4Ex9BokZI7I=@vger.kernel.org, AJvYcCVgDkXonplKwRffcp2UUF2dMAyudUbA3m85e9TLQL19yIWOr4SLQapfu7wAMWREhvw3s0F26Cg63oqpbQ==@vger.kernel.org, AJvYcCVw/2aWeijlEJyCOechN+Fdw9/jX7Mx313YINIR14bpbqCGNGt+5Z6g5jXPK8+fhDb/fTWDxhQAksoS@vger.kernel.org X-Gm-Message-State: AOJu0Yz8B+qLAMZ4aGNNUV2/FaRmksKpe50Kj0LziVfS5iCZZHvmBQ54 Ywn/SKnrda7flqY25ghP8Y7AJY3Gshr+Ux2L7Z5wuvRoZeVmKXhR X-Gm-Gg: ASbGncs0qy/2nsYlPy7rL/LIZN9GW3n4zeB+JumnaeUr1Emq1feLPVsf08ufzNab8Ou R4JbH1DZf5+tR5Co5YsOWda/eOiyWUm37SGITCXscPhz+lj9y+Wij7F6TQEw3q6GdPRcZkhJ6ME 5mlLXE9GrZIGdjLbJ+oFmfk6LDdbUOSAm0Rw0gobOY2hZTxRPz+DHftqjF7EkmW3XtKirJCSA7S T6msyFEx4zaH2iauXloJVPkRXvrIxbY0QL7YJRiMqBqvv/NwaH10e9e7JRQHd+Ot+d8+UVyNY3y jHOWL0xfTZ47rBX9ap9kCVnCOF3ZOrOgAKCN3QTGai0sbwym40tsCPgBmVI= X-Google-Smtp-Source: AGHT+IHn4JQsyFSxasFB9kseG6GL5OH2joNG2H4RvUQRMi3bBoNmSMbOzK2ZeABDPAmWpvG4lsn4Jg== X-Received: by 2002:a17:90b:1a91:b0:2ef:949c:6f6b with SMTP id 98e67ed59e1d1-2f9ffb38596mr11411129a91.13.1738914340268; Thu, 06 Feb 2025 23:45:40 -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 98e67ed59e1d1-2f9e1d5f8d6sm4967367a91.7.2025.02.06.23.45.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2025 23:45:39 -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 v7 5/7] watchdog: Add Nuvoton NCT6694 WDT support Date: Fri, 7 Feb 2025 15:45:00 +0800 Message-Id: <20250207074502.1055111-6-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250207074502.1055111-1-a0282524688@gmail.com> References: <20250207074502.1055111-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-watchdog@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 | 295 +++++++++++++++++++++++++++++++++ 4 files changed, 308 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..6f0a6b7a203b --- /dev/null +++ b/drivers/watchdog/nct6694_wdt.c @@ -0,0 +1,295 @@ +// 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; + 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; + 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; + 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; + 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; + + 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; + + devm_mutex_init(dev, &data->lock); + + 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 Fri Feb 7 07:45:02 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 863269 Received: from mail-pl1-f178.google.com (mail-pl1-f178.google.com [209.85.214.178]) (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 5CD752397AC; Fri, 7 Feb 2025 07:45:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.178 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914352; cv=none; b=F2vxnas/FpMwRMUQaf+JWvjUUb3nkYP2ajX+/nrIMNLifnN5SDTgmfwhlWOQ/7YQvm9qVcsX0rqjo98GUwrloX+atDi4d/uCO+Yk3vPoImy4H7Hmv0YDVYZ8eehpOYjasN1NfKd2AFLBR45xMbJqWcBPCCK4Obt2VUzc+xVGYuo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738914352; c=relaxed/simple; bh=VyO1gY+quioa1x+mn9rphtVK2rIpVpnOMY66Pbkon2Q=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=NQrp+3Jp5WcWUQCi7c1enTp27/EDEyVFj9WLWcyOFUs9ajXRM+c7vOgclOCOqsqkuz22pYq2gi+NGapQLcJAuV0UUqt8l33BdS64D1BaCaNo1YvvdBnzHilQORAp6kb1Xjd6Nbgpiu3dBAAeOGnH7P5O2eOXgiOrzl+s5PF2lUQ= 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=kfzW6u1r; arc=none smtp.client-ip=209.85.214.178 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="kfzW6u1r" Received: by mail-pl1-f178.google.com with SMTP id d9443c01a7336-21f573ff39bso3580955ad.1; Thu, 06 Feb 2025 23:45:50 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1738914349; x=1739519149; 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=kfzW6u1r/I8PTkj0NB2R8A160Ypnx+YZtoXdZmztyLdsZK/3IRrnT1QjEudbNKGpgx iGqypZRSMLnXA47X2qOZM5MQcnM92NLIXOXTdvAtyZ4hruSzIAvcmG0q/eloJjDmNUhy yGmBHemvib9v4SVfw3pJ8FAPAEExMcT1oQk89Xjs0ghxXqG6IAAs5R0copPHapBpshkn G1+mRsoRH5YRR7XcaXnJgqW0rUVu4nkR4nnP3C9oM7Lhg6uV69xpDwqP5Ga3816ZckBj 9284UzOFxERUEXDh/hBmV8pUz35cSNzfgUpmwngun31kxuKg+kfCFqX3KeaCBDkoh0KN e3IQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1738914349; x=1739519149; 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=Xb02MSaRX312iwpa4KZ46aTKDU1WvMYTfcos83pv+lAJ+sh335Ojccrk9L8GY4Tt8P dIekbMyReBvx62tHSqP8r/jIUMPDRMeSpQc44bgqC8F2LF/JPzWIkNAoTkPknr1fcmxt KV5VJLPPpAiEqI3vBlC9uDgbnBQJmfAFQ88mlkkzmVRCCQ6MAkfoCPJ4WVLyhFGwG9kZ ztVmcIyk4HLpOuNHc6SngiQZYi7y46Cqserl1z3QXAPHRA8jxAEM61iCjkxVn7mip0gf FcENVkgBysvtGxHk7Iohm02VF7UrR8xiu0zYUbVCxkgkLBaCjS6tALn1s1BRX7X/rYWU HrGA== X-Forwarded-Encrypted: i=1; AJvYcCUEiyDGeYIzPnOCEvdG1UovvrxTl9ATlgiue7o8sGxd8W4BpOyjhUYgprozysWlom47mb2QecoO/0ShkA8=@vger.kernel.org, AJvYcCUPfAy21cG/zjjzaa9iJLKQfSK7hTinF20eXkCD4L2SfgeLs+NNcxwX3UKmUCFyQ0DdX3I+hI+R7Jxb@vger.kernel.org, AJvYcCUtD+vLUDv6FnII7DL72hopiymJSXGOSKfGFr3+vLFNHF24jt6ShmLmWd9GjyXPj8W9qM1n0sEpeEPHIw==@vger.kernel.org, AJvYcCV2y/kXY8sw+ZFbAaYn+t1LOZXVRZv0nnTVZdFwq8jKrwHVgHBi+BOk0kDg4HCtrhmUKZ3FiLNEV14=@vger.kernel.org, AJvYcCVla6nYlHYXlC5SAV6qaMFX0uGjXhgYzmV5JOUO+aSUhDF9jlXqViG7RsosF6NFgWgrA0sZUeoV1jMPcjKhB7U=@vger.kernel.org, AJvYcCWcPTB6Q4eQRtsqn7/5Ay878fwHjI4p1enArrJBddnHcwFcoekkTLa0QEqPyZOvPW8XbJZi8vPIIGHK@vger.kernel.org, AJvYcCX3mQ0ANrCYW1JktQYGGQK0zAtPyIK4m8svvQil1jcABmqZnFoT/jdBp9BNAGc82O+PV0OpnvxEmrxZ@vger.kernel.org, AJvYcCXUAoHFJ7CaXBNkdMF+YjfYaAGI5OovF/q7PZsqqOs+n8gNoWDKNCzF5qdeVUTl13o+3xKpJ6Yv@vger.kernel.org X-Gm-Message-State: AOJu0YxP7c6KAHK8Sgg2QsXpzkPYdMeUDA/nEXghnEk/M5tE8scbktfD Gp3LU0Vrb/gedPDHwRpuamVgNJ+MyGq+0WuDTfu+43VPZP4dZZ07 X-Gm-Gg: ASbGnctBQWLt7j3YVSeeu7ak/2viwb4GUWIwPNhBp5rlEL5M2UzqWXSQKairuYOuUxF dSZlw1O4sjA5JshiSLl/LUzqjevmd+6gKUpbIpg2IFdSocSbA1dGRIBwrHv5JAwP5mEpwNZ0llA yo2JivqWHt9JqX+sSU6bWBdpYuIs2oKUXIhXKj2yudvs83chi2kAR2uxSeW38PPwuhoo1uv7WMQ UxVG7xJhHtgjpIMnWDr3PeaJuc7Gz9MsHaHXP4aue0W+e9midjdB/U0AyK1ptG487sy3vGNHxvO OIA//7U78tw/iSaLbvOJPS/3rr8ipwFssqmnf7wPZbhqOnptvadFFnygfGY= X-Google-Smtp-Source: AGHT+IHDhKzo/6C0ZJ+1Y/1N0dZtZGyB8D2liwfxXSMceabOSa8ZjjR4Vp7fyF7XejLF1h4heGFRkQ== X-Received: by 2002:a17:903:2b0c:b0:21f:b6f:3f39 with SMTP id d9443c01a7336-21f4e73b041mr37739405ad.34.1738914349561; Thu, 06 Feb 2025 23:45:49 -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 98e67ed59e1d1-2f9e1d5f8d6sm4967367a91.7.2025.02.06.23.45.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Feb 2025 23:45:49 -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 v7 7/7] rtc: Add Nuvoton NCT6694 RTC support Date: Fri, 7 Feb 2025 15:45:02 +0800 Message-Id: <20250207074502.1055111-8-a0282524688@gmail.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20250207074502.1055111-1-a0282524688@gmail.com> References: <20250207074502.1055111-1-a0282524688@gmail.com> Precedence: bulk X-Mailing-List: linux-watchdog@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");