From patchwork Thu Nov 21 06:40:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844785 Received: from mail-pf1-f169.google.com (mail-pf1-f169.google.com [209.85.210.169]) (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 BF7691C9DF6; Thu, 21 Nov 2024 06:41:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171268; cv=none; b=qbuDKx1T2ogSMw75hVfNy2ir7/a1sduL70JnUiEJE4XE7CJD61WBg/u+a9SfIrVgcRSK+X2P48SKS7OPU0nqwYCU3t3AH/cg35vxkzyd52m69K+pZSn5L7mvyxicYV8zzKBUF4oRPWBpqUiTFndJxFJ3rML9nftc8Nm7sCsU3ik= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171268; c=relaxed/simple; bh=1Ad7boXiK81bBb4hrpnHXDp6RHFHSLujsHdBxtE9+dc=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=HKM/JNQQCAuHgu0snVq6yn2vQWaSwDwpaUx+r89WmAjK4f/VyMv+foMGHPXTvJGSQ6i4Ysxijq0gg/g1kNRSgZHI0L0QOm7Eqke9qRNjHcmsRQKk8D0DYm/IDdjQ+cI+rRfjXjhJrg0gO6zx6fDzR8rXBXh7cMftrcOK0BTskOA= 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=PnSk+T3A; arc=none smtp.client-ip=209.85.210.169 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="PnSk+T3A" Received: by mail-pf1-f169.google.com with SMTP id d2e1a72fcca58-720b2d8bcd3so459614b3a.2; Wed, 20 Nov 2024 22:41:06 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171266; x=1732776066; 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=/QRLyHmPfdTDtbGtNfafkBqirNBX/D0Qp3Sa4aEfp6A=; b=PnSk+T3AagKLLAi+uMk29X4TZbO2+o5KhecxsIqj68184eOq7HC3s0PZu82Hk4Fdi8 +W0pvTT/K6Jyps2Dfvco3DP62knAVGYWSK6FCenSsplig2F7g6ZwFhWlc63gU9JD2jCs MHawau7XOhJ3uv/gM8MBq9bbwx75tz/sotGYNuSSu2nFPGKi2fF6XndeIXtz9LTYNCTS d3z6C+8zos7JOJgX/f6Je5Rzj3gcAhjIYtkc3WvMUFdSfX2y/vUkVYJdQwdX+n1kiOh/ bVL98eWaunaK83M3cavXbe/sRY/n7vySpgF3UaiFpXVtgm8QnK5vIIkNDEK/FKFv2NS6 5uWg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171266; x=1732776066; 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=/QRLyHmPfdTDtbGtNfafkBqirNBX/D0Qp3Sa4aEfp6A=; b=Sgd2vyxHq7De7oEGYntIcWDEoJ2OtQqbB6snhYnlYZMh/1URc+xK9BxGRQYNi3Gz9G F0/tXxjfmAj8Mj2bUKck4e9SGdCDu7PE9Urm7Jts8P3Bi/uoVCV+HsnWudsoY0aoXJzc E2ayb0i0zhuJ33BXJRy7AyM2sXxFs4BbZ6j56J7964JiV4kgzT9/Q2A4t6E54Mh1fPUZ 4FieI57d/EIWtsbcX53xC/hWNTTOTKEl9APFrPuoigdQxe84GT7zL6n5jPzLP5JGvHDU iP1iGNyYvS4hkLyvdDWNezhiI32b+Gli61j/sJe7MjoGXb0eegMRF0PWSoxNzzOV79jL RH4Q== X-Forwarded-Encrypted: i=1; AJvYcCU4dx5wHvdMRS06SheDwUgWR5k8ozVes4K/2fZjzmV6u1mT19FqVDMR9vQdwGXNBecOsaPuRIM26fw=@vger.kernel.org, AJvYcCUYlaKv+hSiSAKgEGyUQ6524aUojyTgY7Wqc7LmTrAl+RcaT8kfpzPhG4d1yA2by4DqztbQ0Tn9@vger.kernel.org, AJvYcCV8Yq0m8eQvNu2N7eYT/ljULOXRgbh2FJGTLjKHKg/GpLFwNjuaUInVPuswziCYwkOlcRjQZg7ahC35VZ4=@vger.kernel.org, AJvYcCW2wjkTNYyC6klHNtWzVvr9y+DoKO/GU77CcmAT1aaYClj+MZC4KN9anP+UaIviyLi/ZNsX6dtucnuv@vger.kernel.org, AJvYcCW2xOE0Ff+b8fbur2EOOqkSjI5af6l1f1DC+he+V6popqrnLWVso1EAyc5sPnFrDeVecT2eJOpdsCHdZw==@vger.kernel.org, AJvYcCWSWAOQC3HFGrjMkOHGso8HGiCl3Mw2/BxVqi6efxCH8/BnMmNlJARdGSycyw7sRfx0RN/9e+eQkGMklBNC24Y=@vger.kernel.org, AJvYcCWdMCq6+viiB1lNGmDYjCU9ZcchDgalULxmrgUhS3ihhVxGVSuLk87hKj2KUSaU4dmlkYMPx9L9GFjy@vger.kernel.org X-Gm-Message-State: AOJu0YwaShS0EP+iX2Axes5z8yWrz6JrechGgkEz7CaLTiq6ENo+3CV+ CInMxpmDQQyT/wbqwd20GHdUuGMUwicfEola4hJELoS1v46gV6eV X-Gm-Gg: ASbGncv8PbtZTViBM/26IJbpdTS8WqY98gKdxFcKepGi6RRYZqiAA1j54p9f7CJFfKI yu0H3nX8CgJNE/nyvsb9DVKBKEqqL14HaWbLUr4M+noCayKp4GYh7T+GgmiA00F4Nso6OdPcCmf 7ID5LWSjBph0aldayR8osTxF5bEZ9Dw/6+LG9l6F+NZcybXMm93YtE0eLZHmUtypxjYjxNVs/Qe c72id7l12uM7gj1DZ6jxuRY2gIHjxsU307q2JVYIG7JDblFeAHPlw8C7RF2/UZUqWfX6CUixT5c kqqQiVtF4fB3 X-Google-Smtp-Source: AGHT+IFKyvoGhto6kqRGfdZYJqk0LQiUr14qPytVmRakJyFaXuQWSdCzdI4G1KNzn/yuPsZOehr0uw== X-Received: by 2002:a05:6a00:9293:b0:71e:55e2:2c54 with SMTP id d2e1a72fcca58-724becb8374mr6248484b3a.12.1732171265891; Wed, 20 Nov 2024 22:41: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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:05 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 1/7] mfd: Add core driver for Nuvoton NCT6694 Date: Thu, 21 Nov 2024 14:40:40 +0800 Message-Id: <20241121064046.3724726-2-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@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 | 10 + drivers/mfd/Makefile | 2 + drivers/mfd/nct6694.c | 382 ++++++++++++++++++++++++++++++++++++ include/linux/mfd/nct6694.h | 139 +++++++++++++ 5 files changed, 540 insertions(+) create mode 100644 drivers/mfd/nct6694.c create mode 100644 include/linux/mfd/nct6694.h diff --git a/MAINTAINERS b/MAINTAINERS index 67d2159406c2..9c9a94ff8f98 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16541,6 +16541,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 03c1e4e3eea4..07ccc32f9985 100644 --- a/drivers/mfd/Kconfig +++ b/drivers/mfd/Kconfig @@ -558,6 +558,16 @@ config MFD_MX25_TSADC i.MX25 processors. They consist of a conversion queue for general purpose ADC and a queue for Touchscreens. +config MFD_NCT6694 + tristate "Nuvoton NCT6694 support" + select MFD_CORE + depends on USB + help + This adds support for Nuvoton USB device NCT6694 sharing peripherals + This includes the USB devcie driver and core APIs. + Additional drivers must be enabled in order to use the functionality + of the device. + config MFD_HI6421_PMIC tristate "HiSilicon Hi6421 PMU/Codec IC" depends on OF diff --git a/drivers/mfd/Makefile b/drivers/mfd/Makefile index e057d6d6faef..9d0365ba6a26 100644 --- a/drivers/mfd/Makefile +++ b/drivers/mfd/Makefile @@ -117,6 +117,8 @@ obj-$(CONFIG_TWL6040_CORE) += twl6040.o obj-$(CONFIG_MFD_MX25_TSADC) += fsl-imx25-tsadc.o +obj-$(CONFIG_MFD_NCT6694) += nct6694.o + obj-$(CONFIG_MFD_MC13XXX) += mc13xxx-core.o obj-$(CONFIG_MFD_MC13XXX_SPI) += mc13xxx-spi.o obj-$(CONFIG_MFD_MC13XXX_I2C) += mc13xxx-i2c.o diff --git a/drivers/mfd/nct6694.c b/drivers/mfd/nct6694.c new file mode 100644 index 000000000000..071333d13eae --- /dev/null +++ b/drivers/mfd/nct6694.c @@ -0,0 +1,382 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 MFD driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define MFD_DEV_SIMPLE(_name) \ +{ \ + .name = NCT6694_DEV_##_name, \ +} \ + +#define MFD_DEV_WITH_ID(_name, _id) \ +{ \ + .name = NCT6694_DEV_##_name, \ + .id = _id, \ +} + +/* MFD device resources */ +static const struct mfd_cell nct6694_dev[] = { + MFD_DEV_WITH_ID(GPIO, 0x0), + MFD_DEV_WITH_ID(GPIO, 0x1), + MFD_DEV_WITH_ID(GPIO, 0x2), + MFD_DEV_WITH_ID(GPIO, 0x3), + MFD_DEV_WITH_ID(GPIO, 0x4), + MFD_DEV_WITH_ID(GPIO, 0x5), + MFD_DEV_WITH_ID(GPIO, 0x6), + MFD_DEV_WITH_ID(GPIO, 0x7), + MFD_DEV_WITH_ID(GPIO, 0x8), + MFD_DEV_WITH_ID(GPIO, 0x9), + MFD_DEV_WITH_ID(GPIO, 0xA), + MFD_DEV_WITH_ID(GPIO, 0xB), + MFD_DEV_WITH_ID(GPIO, 0xC), + MFD_DEV_WITH_ID(GPIO, 0xD), + MFD_DEV_WITH_ID(GPIO, 0xE), + MFD_DEV_WITH_ID(GPIO, 0xF), + + MFD_DEV_WITH_ID(I2C, 0x0), + MFD_DEV_WITH_ID(I2C, 0x1), + MFD_DEV_WITH_ID(I2C, 0x2), + MFD_DEV_WITH_ID(I2C, 0x3), + MFD_DEV_WITH_ID(I2C, 0x4), + MFD_DEV_WITH_ID(I2C, 0x5), + + MFD_DEV_WITH_ID(CAN, 0x0), + MFD_DEV_WITH_ID(CAN, 0x1), + + MFD_DEV_WITH_ID(WDT, 0x0), + MFD_DEV_WITH_ID(WDT, 0x1), + + MFD_DEV_SIMPLE(HWMON), + MFD_DEV_SIMPLE(RTC), +}; + +static int nct6694_response_err_handling(struct nct6694 *nct6694, + unsigned char err_status) +{ + struct device *dev = &nct6694->udev->dev; + + switch (err_status) { + case NCT6694_NO_ERROR: + return err_status; + case NCT6694_NOT_SUPPORT_ERROR: + dev_dbg(dev, "%s: Command is not support!\n", __func__); + break; + case NCT6694_NO_RESPONSE_ERROR: + dev_dbg(dev, "%s: Command is no response!\n", __func__); + break; + case NCT6694_TIMEOUT_ERROR: + dev_dbg(dev, "%s: Command is timeout!\n", __func__); + break; + case NCT6694_PENDING: + dev_dbg(dev, "%s: Command is pending!\n", __func__); + break; + default: + return -EINVAL; + } + + return -EIO; +} + +int nct6694_read_msg(struct nct6694 *nct6694, u8 mod, u16 offset, + u16 length, void *buf) +{ + struct nct6694_cmd_header *cmd_header = nct6694->cmd_header; + struct nct6694_response_header *response_header = nct6694->response_header; + struct usb_device *udev = nct6694->udev; + int tx_len, rx_len, ret; + + guard(mutex)(&nct6694->access_lock); + + /* Send command packet to USB device */ + cmd_header->mod = mod; + cmd_header->cmd = offset & 0xFF; + cmd_header->sel = (offset >> 8) & 0xFF; + cmd_header->hctrl = NCT6694_HCTRL_GET; + cmd_header->len = length; + + ret = usb_bulk_msg(udev, usb_sndbulkpipe(udev, NCT6694_BULK_OUT_EP), + cmd_header, NCT6694_CMD_PACKET_SZ, &tx_len, + nct6694->timeout); + if (ret) + return ret; + + /* Receive response packet from USB device */ + ret = usb_bulk_msg(udev, usb_rcvbulkpipe(udev, NCT6694_BULK_IN_EP), + response_header, NCT6694_CMD_PACKET_SZ, &rx_len, + nct6694->timeout); + if (ret) + return ret; + + ret = usb_bulk_msg(udev, usb_rcvbulkpipe(udev, NCT6694_BULK_IN_EP), + buf, NCT6694_MAX_PACKET_SZ, &rx_len, nct6694->timeout); + if (ret) + return ret; + + return nct6694_response_err_handling(nct6694, response_header->sts); +} +EXPORT_SYMBOL(nct6694_read_msg); + +int nct6694_write_msg(struct nct6694 *nct6694, u8 mod, u16 offset, + u16 length, void *buf) +{ + struct nct6694_cmd_header *cmd_header = nct6694->cmd_header; + struct nct6694_response_header *response_header = nct6694->response_header; + struct usb_device *udev = nct6694->udev; + int tx_len, rx_len, ret; + + guard(mutex)(&nct6694->access_lock); + + /* Send command packet to USB device */ + cmd_header->mod = mod; + cmd_header->cmd = offset & 0xFF; + cmd_header->sel = (offset >> 8) & 0xFF; + cmd_header->hctrl = NCT6694_HCTRL_SET; + cmd_header->len = length; + + ret = usb_bulk_msg(udev, usb_sndbulkpipe(udev, NCT6694_BULK_OUT_EP), + cmd_header, NCT6694_CMD_PACKET_SZ, &tx_len, + nct6694->timeout); + if (ret) + return ret; + + ret = usb_bulk_msg(udev, usb_sndbulkpipe(udev, NCT6694_BULK_OUT_EP), + buf, length, &tx_len, nct6694->timeout); + if (ret) + return ret; + + /* Receive response packet from USB device */ + ret = usb_bulk_msg(udev, usb_rcvbulkpipe(udev, NCT6694_BULK_IN_EP), + response_header, NCT6694_CMD_PACKET_SZ, &rx_len, + nct6694->timeout); + if (ret) + return ret; + + ret = usb_bulk_msg(udev, usb_rcvbulkpipe(udev, NCT6694_BULK_IN_EP), + buf, NCT6694_MAX_PACKET_SZ, &rx_len, nct6694->timeout); + if (ret) + return ret; + + return nct6694_response_err_handling(nct6694, response_header->sts); +} +EXPORT_SYMBOL(nct6694_write_msg); + +static void usb_int_callback(struct urb *urb) +{ + struct nct6694 *nct6694 = urb->context; + struct device *dev = &nct6694->udev->dev; + 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); + + if (*int_status & (1 << irq)) + generic_handle_irq_safe(irq_find_mapping(nct6694->domain, irq)); + + *int_status &= ~(1 << irq); + } + +resubmit: + ret = usb_submit_urb(urb, GFP_ATOMIC); + if (ret) + dev_dbg(dev, "%s: Failed to resubmit urb, status %d", + __func__, 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); + unsigned int irq = data->hwirq; + + nct6694->irq_enable |= (1 << irq); +} + +static void nct6694_irq_disable(struct irq_data *data) +{ + struct nct6694 *nct6694 = irq_data_get_irq_chip_data(data); + unsigned int irq = data->hwirq; + + nct6694->irq_enable &= ~(1 << irq); +} + +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 device *dev = &udev->dev; + struct usb_host_interface *interface; + struct usb_endpoint_descriptor *int_endpoint; + struct nct6694 *nct6694; + struct nct6694_cmd_header *cmd_header; + struct nct6694_response_header *response_header; + int pipe, maxp; + int ret; + + interface = iface->cur_altsetting; + + int_endpoint = &interface->endpoint[0].desc; + if (!usb_endpoint_is_int_in(int_endpoint)) + return -ENODEV; + + 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); + + cmd_header = devm_kzalloc(dev, sizeof(*cmd_header), + GFP_KERNEL); + if (!cmd_header) + return -ENOMEM; + + response_header = devm_kzalloc(dev, sizeof(*response_header), + GFP_KERNEL); + if (!response_header) + return -ENOMEM; + + nct6694->int_buffer = devm_kcalloc(dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), 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) + return -ENODEV; + + nct6694->udev = udev; + nct6694->timeout = NCT6694_URB_TIMEOUT; /* Wait until urb complete */ + nct6694->cmd_header = cmd_header; + nct6694->response_header = response_header; + + mutex_init(&nct6694->access_lock); + mutex_init(&nct6694->irq_lock); + + 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; + + dev_set_drvdata(dev, nct6694); + usb_set_intfdata(iface, nct6694); + + ret = mfd_add_hotplug_devices(dev, nct6694_dev, ARRAY_SIZE(nct6694_dev)); + if (ret) + goto err_mfd; + + dev_info(dev, "Probed device: (%04X:%04X)\n", id->idVendor, id->idProduct); + return 0; + +err_mfd: + usb_kill_urb(nct6694->int_in_urb); +err_urb: + usb_free_urb(nct6694->int_in_urb); + return dev_err_probe(dev, ret, "Probe failed\n"); +} + +static void nct6694_usb_disconnect(struct usb_interface *iface) +{ + struct usb_device *udev = interface_to_usbdev(iface); + struct nct6694 *nct6694 = usb_get_intfdata(iface); + + mfd_remove_devices(&udev->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-MFD 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..9733d47f5a01 --- /dev/null +++ b/include/linux/mfd/nct6694.h @@ -0,0 +1,139 @@ +/* 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_DEV_GPIO "nct6694-gpio" +#define NCT6694_DEV_I2C "nct6694-i2c" +#define NCT6694_DEV_CAN "nct6694-can" +#define NCT6694_DEV_WDT "nct6694-wdt" +#define NCT6694_DEV_HWMON "nct6694-hwmon" +#define NCT6694_DEV_RTC "nct6694-rtc" + +#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_MAX_PACKET_SZ 0x200 + +#define NCT6694_CMD_PACKET_SZ 0x8 +#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 nct6694 { + struct usb_device *udev; + struct urb *int_in_urb; + struct irq_domain *domain; + struct nct6694_cmd_header *cmd_header; + struct nct6694_response_header *response_header; + struct mutex access_lock; + struct mutex irq_lock; + unsigned char *int_buffer; + unsigned int irq_enable; + /* time in msec to wait for the urb to the complete */ + long timeout; +}; + +struct nct6694_cmd_header { + unsigned char rsv1; + unsigned char mod; + unsigned char cmd; + unsigned char sel; + unsigned char hctrl; + unsigned char rsv2; + unsigned short len; +} __packed; + +struct nct6694_response_header { + unsigned char sequence_id; + unsigned char sts; + unsigned int rsv; + unsigned short len; +} __packed; + +/* + * nct6694_read_msg - Receive data from NCT6694 USB device + * + * @nct6694 - Nuvoton NCT6694 structure + * @mod - Module byte + * @offset - Offset byte or (Select byte | Command byte) + * @length - Length byte + * @buf - Read data from rx buffer + * + * USB Transaction format: + * + * OUT |RSV|MOD|CMD|SEL|HCTL|RSV|LEN_L|LEN_H| + * OUT |SEQ|STS|RSV|RSV|RSV|RSV||LEN_L|LEN_H| + * IN |-------D------A------D------A-------| + * IN ...... + * IN |-------D------A------D------A-------| + */ +int nct6694_read_msg(struct nct6694 *nct6694, u8 mod, u16 offset, + u16 length, void *buf); + +/* + * nct6694_read_msg - Transmit data to NCT6694 USB device + * + * @nct6694 - Nuvoton NCT6694 structure + * @mod - Module byte + * @offset - Offset byte or (Select byte | Command byte) + * @length - Length byte + * @buf - Write data to tx buffer + * + * USB Transaction format: + * + * OUT |RSV|MOD|CMD|SEL|HCTL|RSV|LEN_L|LEN_H| + * OUT |-------D------A------D------A-------| + * OUT ...... + * OUT |-------D------A------D------A-------| + * IN |SEQ|STS|RSV|RSV|RSV|RSV||LEN_L|LEN_H| + * IN |-------D------A------D------A-------| + * IN ...... + * IN |-------D------A------D------A-------| + */ +int nct6694_write_msg(struct nct6694 *nct6694, u8 mod, u16 offset, + u16 length, void *buf); + +#endif From patchwork Thu Nov 21 06:40:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844972 Received: from mail-pg1-f176.google.com (mail-pg1-f176.google.com [209.85.215.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 A4B061CB306; Thu, 21 Nov 2024 06:41:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171272; cv=none; b=r3WweFYhxOXDh7cmi3/N6z6amlShW18FIZekorDAEggfVWSYl7YGJurDrMY1T0XUh/M7R7yN0jCljqRFYReS4Vy2/Zf1sJ0XdeM0t73y5V0RX5sXAyBwBVkU5NiRo0T1YllQmAgPvo1oqzmWf6fmCnrHEutJbjfd1PrdSKe5iqE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171272; c=relaxed/simple; bh=K7S8SXf3E31TM1mBHOTndKgVL+cg8ph+SloNbaVP4Dk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=EoD4LYcKUzbsQ8fvYaSat/oCe1hRThM4/pDNpS2+bt+eCfH+hPvCFTglrtFQ5yNPIIPEruSgMNXGJKTiVnXmfhuCABDxO6vIB8oNgYezq2LKQp/amYoy2us/yy8rojMmNYX98Q/W9xpo99LAYL4J2tzFUY1uxPSfIQMzoFyfrPU= 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=lkGzph0n; arc=none smtp.client-ip=209.85.215.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="lkGzph0n" Received: by mail-pg1-f176.google.com with SMTP id 41be03b00d2f7-7edb6879196so479756a12.3; Wed, 20 Nov 2024 22:41:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171270; x=1732776070; 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=hWTz/CCxD6wE1B6xtr3ZE+FE9Zph7go2Puk8PDECfpk=; b=lkGzph0nykF9LrpX38cSHsesdQUqv2dvHDfDonXByPz+dpSNEPw7Ff8NLgfw2Oj/Sr 98REFiVxGrWAzGuI6ZEsFzJ3mJB46jRe6w/BQOVTZn6+VvxXHyL4/40Z7YBLAXcCPh1M VXltl3l2gwqJZFy9CxC7m1ZqWVn3RqggZSVFak8k9jLGZs5qFkrneRgDJnVi7kvoeA5q lec/m5XknGP5n6kpKU5jibV20m8s3D51aCEMUN9Td19KsDhth3IPk5g7YIWBq+gIEP/k fiQ8qAKQZ6g787gOok2eR+AA8/hZEF1T1MFwy+jtZNK+NnYNVxHHJh5ae7KPpFRLZ69K nx9Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171270; x=1732776070; 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=hWTz/CCxD6wE1B6xtr3ZE+FE9Zph7go2Puk8PDECfpk=; b=BjKxMk2Bqk8LGPpg8u58uCrkEzHGZsz7T+2Cd7kLEB1Xw++kH/TbGjevQf85UnhK/7 Wr+cdYy1CvA7xA8b48GNWMCNQ78hacjQinBCjBHss6GT/g+IcNW8jQ2Sqo6ssG8xstmg hkOKsLImxvmIFf0xFVPwOzyghVK/+Zh3uL7F6rphv4Z0+ejNmAyNTwktiGxe1bzveF7B LyvMkg08obWhgQ+yKRikKroDqZ+dqwH191XYfw/e3ObYEfdGm3xNpHeb/Qrqh6y6Ez9Y nA+Y9Ut9PE+ag4h7FrqZ54QmYyCouEV4ucZN6KIgo7jC4Cs9PzVXeOZTYmRFGVL1khW0 Ubug== X-Forwarded-Encrypted: i=1; AJvYcCUK9OSvppMALCyb5VNTMyhHVZfw0K/ll/us3hWIGmlbrvieFsx682jS4YxiY+NzTTxNZlCwfCEbIq5XTK4=@vger.kernel.org, AJvYcCUNO86xoLk+BmWnWC0EnjKRPDAN3LYiGr3iyX17XHMUCp54dmy2+7paVZ35RaHTHC4Q+7OHDAIcX5M=@vger.kernel.org, AJvYcCVZjfS6ZoPoosmw7GeBQvHX8L+yTbEA6ETelmwdKKIgSs9k5cMoIFvjdoTCSAKADcXRvbUe9z3r@vger.kernel.org, AJvYcCW8FmH4Dad9tXKWWgtjE7s+QnPvn9bBDWwkwRMDp/eM8cNjwrp7k29koMbBAIOmPnSN3hVS54RrufihWeHc/ec=@vger.kernel.org, AJvYcCWl5MGfCKMpgBRtNxhiehmwHqh32LKiHsOXJHbjDDepDP4euXw1Tx0e5viRrVzK8BK2VCrUX9/wdxXk@vger.kernel.org, AJvYcCX/38L5Y8VdqE9iLzILJw+0YHfZLzOTR1r+xd6+eqfVTW2XnXxLh4NWNl/YMyZV8cnYGeyUrpuA38r8@vger.kernel.org, AJvYcCXjGEk5sv01I6ywvTX2Wrc7TThbeg0Dp6CP+A+3EqaQ+fLOSBxTEzk0Xu37eIhHp+Y50uANZ2uEtOtIyw==@vger.kernel.org X-Gm-Message-State: AOJu0YxOkMTyqxNgd3l+mrbSwwiE5wZ1EbXkqmqL0SOLAUmzCoxEpwKP gScTSMeS4+AV+s9PgiNk2bgtJuXh7xthdYCskVEWHei6DoKUD0nj X-Gm-Gg: ASbGnctn2AxI/M/y5E2FUPJKPXr9pvhYiXNV4J8AEd7qz7e0LR3NnsGS2GKxmLCLmRs c5ouJZFKgiweRoTOxupLzgleMWnxyrNDU1e+iGxD0cGSHvB21+TQMaUmcAmEgqXxk0tZ/daBZp1 JuP+5MFHncRT0FJn3LWsjomml+NuS2Py6ZKy8zGr8ALyz4R+oZR+UjOq4MkP8D3JUfXVqr6slCX EN51ag7mfk9gj/+aFo2L8moLlLYPCdhtSPbxIUhuEWViECCEi5GxMzyoqvnJuhs6rDp7IcjwBgv YSfcJOGm+5Hd X-Google-Smtp-Source: AGHT+IEIpRcSYA3dtbiUCuQMLwfuQUevbjED3YAUq2sxzHHTrR5Nr6a0NFwL4oWW1bu4ac2Ta3w6oA== X-Received: by 2002:a05:6a20:a10e:b0:1d5:1354:5256 with SMTP id adf61e73a8af0-1ddb033a1aamr8036224637.39.1732171269680; Wed, 20 Nov 2024 22:41:09 -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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:09 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 2/7] gpio: Add Nuvoton NCT6694 GPIO support Date: Thu, 21 Nov 2024 14:40:41 +0800 Message-Id: <20241121064046.3724726-3-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports GPIO and IRQ functionality for NCT6694 MFD device based on USB interface. Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/gpio/Kconfig | 12 + drivers/gpio/Makefile | 1 + drivers/gpio/gpio-nct6694.c | 441 ++++++++++++++++++++++++++++++++++++ 4 files changed, 455 insertions(+) create mode 100644 drivers/gpio/gpio-nct6694.c diff --git a/MAINTAINERS b/MAINTAINERS index 9c9a94ff8f98..6688c5c470b7 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16545,6 +16545,7 @@ NUVOTON NCT6694 MFD DRIVER M: Ming Yu L: linux-kernel@vger.kernel.org S: Supported +F: drivers/gpio/gpio-nct6694.c F: drivers/mfd/nct6694.c F: include/linux/mfd/nct6694.h diff --git a/drivers/gpio/Kconfig b/drivers/gpio/Kconfig index 56fee58e281e..7773b5326e60 100644 --- a/drivers/gpio/Kconfig +++ b/drivers/gpio/Kconfig @@ -1460,6 +1460,18 @@ config GPIO_MAX77650 GPIO driver for MAX77650/77651 PMIC from Maxim Semiconductor. These chips have a single pin that can be configured as GPIO. +config GPIO_NCT6694 + tristate "Nuvoton NCT6694 GPIO controller support" + depends on MFD_NCT6694 + select GENERIC_IRQ_CHIP + select GPIOLIB_IRQCHIP + help + This driver supports 8 GPIO pins per bank that can all be interrupt + sources. + + This driver can also be built as a module. If so, the module will be + called gpio-nct6694. + config GPIO_PALMAS bool "TI PALMAS series PMICs GPIO" depends on MFD_PALMAS diff --git a/drivers/gpio/Makefile b/drivers/gpio/Makefile index af3ba4d81b58..ad80a078b27b 100644 --- a/drivers/gpio/Makefile +++ b/drivers/gpio/Makefile @@ -123,6 +123,7 @@ obj-$(CONFIG_GPIO_MXC) += gpio-mxc.o obj-$(CONFIG_GPIO_MXS) += gpio-mxs.o obj-$(CONFIG_GPIO_NOMADIK) += gpio-nomadik.o obj-$(CONFIG_GPIO_NPCM_SGPIO) += gpio-npcm-sgpio.o +obj-$(CONFIG_GPIO_NCT6694) += gpio-nct6694.o obj-$(CONFIG_GPIO_OCTEON) += gpio-octeon.o obj-$(CONFIG_GPIO_OMAP) += gpio-omap.o obj-$(CONFIG_GPIO_PALMAS) += gpio-palmas.o diff --git a/drivers/gpio/gpio-nct6694.c b/drivers/gpio/gpio-nct6694.c new file mode 100644 index 000000000000..1776200b3a04 --- /dev/null +++ b/drivers/gpio/gpio-nct6694.c @@ -0,0 +1,441 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 GPIO controller driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include + +/* Host interface */ +#define NCT6694_GPIO_MOD 0xFF +#define NCT6694_GPIO_LEN 0x01 + +/* Report Channel */ +#define NCT6694_GPIO_VER 0x90 +#define NCT6694_GPIO_VALID 0x110 +#define NCT6694_GPI_DATA 0x120 +#define NCT6694_GPO_DIR 0x170 +#define NCT6694_GPO_TYPE 0x180 +#define NCT6694_GPO_DATA 0x190 + +#define NCT6694_GPI_STS 0x130 +#define NCT6694_GPI_CLR 0x140 +#define NCT6694_GPI_FALLING 0x150 +#define NCT6694_GPI_RISING 0x160 + +#define NCT6694_NR_GPIO 8 + +struct nct6694_gpio_data { + struct nct6694 *nct6694; + struct gpio_chip gpio; + struct mutex lock; + /* Protect irq operation */ + struct mutex irq_lock; + + unsigned char xmit_buf; + unsigned char irq_trig_falling; + unsigned char irq_trig_rising; + + /* Current gpio group */ + unsigned char group; + + /* GPIO line names */ + char **names; +}; + +static int nct6694_get_direction(struct gpio_chip *gpio, unsigned int offset) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + return !(BIT(offset) & data->xmit_buf); +} + +static int nct6694_direction_input(struct gpio_chip *gpio, unsigned int offset) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + data->xmit_buf &= ~(1 << offset); + + return nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); +} + +static int nct6694_direction_output(struct gpio_chip *gpio, + unsigned int offset, int val) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + /* Set direction to output */ + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + data->xmit_buf |= (1 << offset); + ret = nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + /* Then set output level */ + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + if (val) + data->xmit_buf |= (1 << offset); + else + data->xmit_buf &= ~(1 << offset); + + return nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); +} + +static int nct6694_get_value(struct gpio_chip *gpio, unsigned int offset) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DIR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + if (BIT(offset) & data->xmit_buf) { + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + return !!(BIT(offset) & data->xmit_buf); + } + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + return !!(BIT(offset) & data->xmit_buf); +} + +static void nct6694_set_value(struct gpio_chip *gpio, unsigned int offset, + int val) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + + guard(mutex)(&data->lock); + + nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + + if (val) + data->xmit_buf |= (1 << offset); + else + data->xmit_buf &= ~(1 << offset); + + nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_DATA + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); +} + +static int nct6694_set_config(struct gpio_chip *gpio, unsigned int offset, + unsigned long config) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_TYPE + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + switch (pinconf_to_config_param(config)) { + case PIN_CONFIG_DRIVE_OPEN_DRAIN: + data->xmit_buf |= (1 << offset); + break; + case PIN_CONFIG_DRIVE_PUSH_PULL: + data->xmit_buf &= ~(1 << offset); + break; + default: + return -ENOTSUPP; + } + + return nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPO_TYPE + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); +} + +static int nct6694_init_valid_mask(struct gpio_chip *gpio, + unsigned long *valid_mask, + unsigned int ngpios) +{ + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPIO_VALID + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + if (ret < 0) + return ret; + + *valid_mask = data->xmit_buf; + + return ret; +} + +static irqreturn_t nct6694_irq_handler(int irq, void *priv) +{ + struct nct6694_gpio_data *data = priv; + unsigned char status; + + guard(mutex)(&data->lock); + + nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_STS + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + + status = data->xmit_buf; + + while (status) { + int bit = __ffs(status); + + data->xmit_buf = BIT(bit); + handle_nested_irq(irq_find_mapping(data->gpio.irq.domain, bit)); + status &= ~(1 << bit); + nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_CLR + data->group, + NCT6694_GPIO_LEN, &data->xmit_buf); + } + + return IRQ_HANDLED; +} + +static int nct6694_get_irq_trig(struct nct6694_gpio_data *data) +{ + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_FALLING + data->group, + NCT6694_GPIO_LEN, &data->irq_trig_falling); + if (ret) + return ret; + + return nct6694_read_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_RISING + data->group, + NCT6694_GPIO_LEN, &data->irq_trig_rising); +} + +static void nct6694_irq_mask(struct irq_data *d) +{ + struct gpio_chip *gpio = irq_data_get_irq_chip_data(d); + irq_hw_number_t hwirq = irqd_to_hwirq(d); + + gpiochip_disable_irq(gpio, hwirq); +} + +static void nct6694_irq_unmask(struct irq_data *d) +{ + struct gpio_chip *gpio = irq_data_get_irq_chip_data(d); + irq_hw_number_t hwirq = irqd_to_hwirq(d); + + gpiochip_enable_irq(gpio, hwirq); +} + +static int nct6694_irq_set_type(struct irq_data *d, unsigned int type) +{ + struct gpio_chip *gpio = irq_data_get_irq_chip_data(d); + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + irq_hw_number_t hwirq = irqd_to_hwirq(d); + + guard(mutex)(&data->lock); + + switch (type) { + case IRQ_TYPE_EDGE_RISING: + data->irq_trig_rising |= BIT(hwirq); + break; + + case IRQ_TYPE_EDGE_FALLING: + data->irq_trig_falling |= BIT(hwirq); + break; + + case IRQ_TYPE_EDGE_BOTH: + data->irq_trig_rising |= BIT(hwirq); + data->irq_trig_falling |= BIT(hwirq); + break; + + default: + return -ENOTSUPP; + } + + return 0; +} + +static void nct6694_irq_bus_lock(struct irq_data *d) +{ + struct gpio_chip *gpio = irq_data_get_irq_chip_data(d); + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + + mutex_lock(&data->irq_lock); +} + +static void nct6694_irq_bus_sync_unlock(struct irq_data *d) +{ + struct gpio_chip *gpio = irq_data_get_irq_chip_data(d); + struct nct6694_gpio_data *data = gpiochip_get_data(gpio); + + scoped_guard(mutex, &data->lock) { + nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_FALLING + data->group, + NCT6694_GPIO_LEN, &data->irq_trig_falling); + + nct6694_write_msg(data->nct6694, NCT6694_GPIO_MOD, + NCT6694_GPI_RISING + data->group, + NCT6694_GPIO_LEN, &data->irq_trig_rising); + } + + mutex_unlock(&data->irq_lock); +} + +static const struct irq_chip nct6694_irq_chip = { + .name = "nct6694-gpio", + .irq_mask = nct6694_irq_mask, + .irq_unmask = nct6694_irq_unmask, + .irq_set_type = nct6694_irq_set_type, + .irq_bus_lock = nct6694_irq_bus_lock, + .irq_bus_sync_unlock = nct6694_irq_bus_sync_unlock, + .flags = IRQCHIP_IMMUTABLE, + GPIOCHIP_IRQ_RESOURCE_HELPERS, +}; + +static int nct6694_gpio_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_gpio_data *data; + struct gpio_irq_chip *girq; + int ret, irq, i; + + irq = irq_create_mapping(nct6694->domain, + NCT6694_IRQ_GPIO0 + cell->id); + if (!irq) + return -EINVAL; + + data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->names = devm_kzalloc(dev, sizeof(char *) * NCT6694_NR_GPIO, + GFP_KERNEL); + if (!data->names) + return -ENOMEM; + + for (i = 0; i < NCT6694_NR_GPIO; i++) { + data->names[i] = devm_kasprintf(dev, GFP_KERNEL, "GPIO%X%d", + cell->id, i); + if (!data->names[i]) + return -ENOMEM; + } + + data->nct6694 = nct6694; + data->group = cell->id; + + data->gpio.names = (const char * const*)data->names; + data->gpio.label = pdev->name; + data->gpio.direction_input = nct6694_direction_input; + data->gpio.get = nct6694_get_value; + data->gpio.direction_output = nct6694_direction_output; + data->gpio.set = nct6694_set_value; + data->gpio.get_direction = nct6694_get_direction; + data->gpio.set_config = nct6694_set_config; + data->gpio.init_valid_mask = nct6694_init_valid_mask; + data->gpio.base = -1; + data->gpio.can_sleep = false; + data->gpio.owner = THIS_MODULE; + data->gpio.ngpio = NCT6694_NR_GPIO; + + mutex_init(&data->irq_lock); + + platform_set_drvdata(pdev, data); + + ret = nct6694_get_irq_trig(data); + if (ret) + return dev_err_probe(dev, ret, "Failed to get irq trigger type\n"); + + /* Register gpio chip to GPIO framework */ + girq = &data->gpio.irq; + gpio_irq_chip_set_chip(girq, &nct6694_irq_chip); + girq->parent_handler = NULL; + girq->num_parents = 0; + girq->parents = NULL; + girq->default_type = IRQ_TYPE_NONE; + girq->handler = handle_level_irq; + girq->threaded = true; + + ret = devm_request_threaded_irq(dev, irq, NULL, nct6694_irq_handler, + IRQF_ONESHOT | IRQF_SHARED, + "nct6694-gpio", data); + if (ret) + return dev_err_probe(dev, ret, "Failed to request irq\n"); + + return devm_gpiochip_add_data(dev, &data->gpio, data); +} + +static struct platform_driver nct6694_gpio_driver = { + .driver = { + .name = "nct6694-gpio", + }, + .probe = nct6694_gpio_probe, +}; + +module_platform_driver(nct6694_gpio_driver); + +MODULE_DESCRIPTION("USB-GPIO controller driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); From patchwork Thu Nov 21 06:40:42 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844784 Received: from mail-pg1-f169.google.com (mail-pg1-f169.google.com [209.85.215.169]) (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 3BEF615099D; Thu, 21 Nov 2024 06:41:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171275; cv=none; b=WPtjTY+8dY7giXofTXaMrMgb/vcGfnfmLKo2SeIepD8gF2hJHCxJm2P5o5Pr/gj2JRmrNyvvpSt3IiXETOoV68AqJ7bwN3O24zTOT0r9mppLyEumTh3an+ElKrsh5kQeK6NdzYNrNbXv0SWgQ4nVott9Q9dRymrVuXd+YBzIAAs= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171275; c=relaxed/simple; bh=44flUDwzHTOuwdS/AmpIAJD6AXf1fHpI1Z+26lfCyYk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=EmPgHYJ7UKunDvIhnpFMgf4IJTvESYgUIzwHhevL0F/Id23Hz9YwVzNeXCPQue63Fy9i2RpdAQzNoTuLCho2z73wUTN9XR13GmQbzQ21DWqIbEcHXkws6JW3Bt3tb5YWoJ9J/U/1z2DukLI9DzcpGuNu0xSPc7nk5v4QmX0uAUY= 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=kDkEftL2; arc=none smtp.client-ip=209.85.215.169 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="kDkEftL2" Received: by mail-pg1-f169.google.com with SMTP id 41be03b00d2f7-7f46d5d1ad5so482379a12.3; Wed, 20 Nov 2024 22:41:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171273; x=1732776073; 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=Z06lEdw1Wb06OgkCMR/MvOB5af33NE4Om1wi64Y5ueM=; b=kDkEftL2wvVXT/XWdd1TrBfjFviA4wb18j4CSUQFsvHhi97iQlDApeVMfIVq7WfA3r LrR5DF+oStYWCjVg2dfPudaHE6KQtsHuZFpF3PUNA/sh7pQJXKuog8LoNn0Zqe7Oc2zS wsE+MovHSMReJYvchRFOd6gdS4J0KZWMeRYUaeG303Zge/pr2pDK0MIyv1ngE0/s7GhE NlnHZvIhAARqdzNFellvuw6VyP0wL24+y8wZB1dn7vKSuUqDYTmSjbyVaTitU4Z+JlEl Q/9WX9VepjlcFXidz/bTU3aThHizbWkm/PJ6BbkZRQvMYcSsYgXlABMF5nFRWnX9aci2 JDXQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171273; x=1732776073; 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=Z06lEdw1Wb06OgkCMR/MvOB5af33NE4Om1wi64Y5ueM=; b=waBywvu6NFPJoO6ziK5ROfjHA/HBDrao8daWMDn77J34K4BrwiOjr6/nC+T/ow5h21 JWM7iTCospJW1ACNt6oh2OjRosoztnPEwW0co4wPFFcOADTmUQ8U0FcTnB7g1Atb2ex8 XBzPGSyd9Aw2+DKElPrFpmrFigvoUODdamCah0CIK9/xhmv54QJFbdRngmoztn2necgR xoCZawI7JOyQyrvhh2CqlaXnrkaRYsAc8DR/QzQf96vmDSzmDj8NVHC1HvGhnE9V77R8 vpp1Q9QRnQwjNQToJmmzRv+aKEGEQhdPWQv1DWsXRV/PJkHhyQ8UhgwAc6T0OIJqBuun LVEg== X-Forwarded-Encrypted: i=1; AJvYcCU2435wSl+/QZg45xqb+Fksw23Am4Xmjlh8LtkfufyyUtApCbVMOWT/jiIy5Kgvk6QXwQBKf9w8iN8TdPE=@vger.kernel.org, AJvYcCU4KaxQlG8++4qZj/F5FZ94MxFwA0WIu9toegiBFkOXoNAfZmH1Xeodn6PLTpZD3snJp9/TX3aN@vger.kernel.org, AJvYcCUZHapRQEJjKw1hgsSF0mq6CVAKeNA5bEIpxpG7YMT+ogWZMk3y98g6gnywMYqN3wSP6Sl2gN3rfC8UnA==@vger.kernel.org, AJvYcCVNlcsRVG1gM3ohe82T/D3DOveLNvr7Wg0D/qM0TC7WKzj5PZxCDXFSfipxNodtOzJEZVgk2xY2Q5s=@vger.kernel.org, AJvYcCVPI8HnnOi8ii9c21t+fYF5nIhE+FmfYRZlbIAnW8ljTmNddR13C0ahPXVdlIME6fZTRfoNxWKGcP3o@vger.kernel.org, AJvYcCWUc6sgRsP9rNsmLp+aHtCm4TH4EE2rVinv5LuY6jazXfIUW/GLSG89ZMVLJl3tfMRBAXhrgPACPLWy@vger.kernel.org, AJvYcCXJP8qMpaduXhmyf5bkJ1/Q7OwPbwQfYeDm9b2pcGHK5rC0skTWVRXx+CTBU9siyBHeitR2vuGmdkzNdVxzBPc=@vger.kernel.org X-Gm-Message-State: AOJu0YwmY1kwCwf3y1AU5u90TxLkTKuhy6aMU8Ow1ragP1+9LaIhqDEZ SYGaZoSmhZ8fW4tVXTiIBwhgdJMXmxlPf58r5t0OJCzs+hCFdf5P X-Gm-Gg: ASbGncuHQGlrZUfVxP32A5ns1EC/8Jqrffhd6ocDnlbikk2ldHqC/1X25X07GYopNCP qiVCPfUsiHJisonAfjPl6iioOttPbo2H+c0pwY7PUoBkgUOC8J44nxwxbtp/8zHEA6geO+lswGh 4/lpMJ19t+KK+BdmA9Dl+GYSCBANbHZhAv6CjjT3C79sjZ+XYsOuQchw6tb3fQAOVsIzlXuz6aw 1NCfJdIAtmkC5whUCMvVbTf4CbevG3aumZG0Lt2B5UdOJ/pjJBU8LBPD7Hz4lUAL/BEygrwZUos 59TwTwEelSE9 X-Google-Smtp-Source: AGHT+IHwkLpxRqEoEahyxYL8ckipeHn0RrOylLzacy2EPPt1/BMEDWRQZS0KNwimnpjdKEtj3rk1ng== X-Received: by 2002:a05:6a20:158f:b0:1db:edb3:ed87 with SMTP id adf61e73a8af0-1ddaecd0d51mr8338555637.22.1732171273445; Wed, 20 Nov 2024 22:41:13 -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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.09 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:13 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 3/7] i2c: Add Nuvoton NCT6694 I2C support Date: Thu, 21 Nov 2024 14:40:42 +0800 Message-Id: <20241121064046.3724726-4-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@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 6688c5c470b7..a190f2b08fa3 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16546,6 +16546,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 4977abcd7c46..1962cf1e71f9 100644 --- a/drivers/i2c/busses/Kconfig +++ b/drivers/i2c/busses/Kconfig @@ -1325,6 +1325,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 a6bcbf2febcf..6d2fd8e56569 100644 --- a/drivers/i2c/busses/Makefile +++ b/drivers/i2c/busses/Makefile @@ -135,6 +135,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..2a5e0629f860 --- /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 + +/* Host interface */ +#define NCT6694_I2C_MOD 0x03 + +/* Message Channel*/ +/* Command 00h */ +#define NCT6694_I2C_CMD0_OFFSET 0x0000 /* OFFSET = SEL|CMD */ +#define NCT6694_I2C_CMD0_LEN 0x90 + +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_cmd0 { + 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; + unsigned char *xmit_buf; + 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_cmd0 *cmd = (struct nct6694_i2c_cmd0 *)data->xmit_buf; + int ret, i; + + for (i = 0; i < num ; i++) { + struct i2c_msg *msg_temp = &msgs[i]; + + memset(data->xmit_buf, 0, sizeof(struct nct6694_i2c_cmd0)); + + if (msg_temp->len > 64) + return -EPROTO; + cmd->port = data->port; + cmd->br = data->br; + cmd->addr = i2c_8bit_addr_from_msg(msg_temp); + if (msg_temp->flags & I2C_M_RD) { + cmd->r_cnt = msg_temp->len; + ret = nct6694_write_msg(data->nct6694, NCT6694_I2C_MOD, + NCT6694_I2C_CMD0_OFFSET, + NCT6694_I2C_CMD0_LEN, + cmd); + if (ret < 0) + return 0; + + memcpy(msg_temp->buf, cmd->read_data, msg_temp->len); + } else { + cmd->w_cnt = msg_temp->len; + memcpy(cmd->write_data, msg_temp->buf, msg_temp->len); + ret = nct6694_write_msg(data->nct6694, NCT6694_I2C_MOD, + NCT6694_I2C_CMD0_OFFSET, + NCT6694_I2C_CMD0_LEN, + cmd); + if (ret < 0) + return 0; + } + } + + 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->xmit_buf = devm_kcalloc(&pdev->dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!data->xmit_buf) + 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 = "nct6694-i2c", + }, + .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"); From patchwork Thu Nov 21 06:40:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844971 Received: from mail-pg1-f176.google.com (mail-pg1-f176.google.com [209.85.215.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 33BB61CC88D; Thu, 21 Nov 2024 06:41:17 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171280; cv=none; b=gf33wIcrZ/vyBzYVlCzecZu3GTiJxm/mWh23wbnM0arlYXZuLyBjogQNhFjmj7eOE68bYdXsoU1MYClU6n4afX5ejXGMgR/YP6sgkDAs4lHdfXnPWKQ05F38TNe3MQcOs8+ol91BB4F1TTZwd+C+lHub3BtcfR9pEFIdILgBtts= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171280; c=relaxed/simple; bh=0hVL2t1CuwPfGPKzkFkaDPuidSi/hglvmDs8gsH7JSs=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=svDoJlcNAo50bofVxkHEEKV5EJOFk80Pp2UQ+YxbW9AEpCof21ZERTBG66gVeS3604K2Fiw7QxrM6r3Use4Wuv52Ol5uDGDsscyAjDMCcN8IHb7t/uXGuvYi9+VPocsQQzabuKcKZc3K8rNOdE63CQmRgmS/E4wLbQmPEELpaDk= 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=O3UAp6Ct; arc=none smtp.client-ip=209.85.215.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="O3UAp6Ct" Received: by mail-pg1-f176.google.com with SMTP id 41be03b00d2f7-7f3e30a43f1so443250a12.1; Wed, 20 Nov 2024 22:41:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171277; x=1732776077; 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=4ivXA3ih4Jtkvn6o309jxZBtNqJlVaJGdZyO9cc2dUM=; b=O3UAp6CtfXaWR9y/w69gZh2WXqIN8KOi4S0ssZYCZJR5wfCGPjnQ076/l0dkJ8QWps xSz3CTmpJbksIlgkS7yVJbvZZsBtMr00FlVe8Ac9maOM7JpsZK+tLy3lBInyi74hGArR ZBLqafWQDYEcUkRD9X2UEkzIwcg35hGSFovoGKSquXKn1uKh4CpBFFeKDSfzmwn2cHrG o8T1vqoYT8qNDH3dti7yV+UbhvVEwKN6C3/9T8O92foTtdMvspjOSbYL62FO6gN6Ns2q 5jd5KTBHUr7sHqSvc29FuoSs3q31X9J7Ku0tkLZdumBd0KTe62Wksjnf6nGoDnfnmSME RWVw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171277; x=1732776077; 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=4ivXA3ih4Jtkvn6o309jxZBtNqJlVaJGdZyO9cc2dUM=; b=Q8/9D1kqb6HRIpQViIx5E4bDn7VXGtBxqByoFsNt1uAInsq6dR6OdjQjj62vltdC/V Il3LeZbOlGSr4SB6HGaVL1ozV9v0u9G7RXmAtEZKrCJ+158VCDlbEPbKk9PvfQvugRPd PqeUMFMB4U/pWu77SDH0oSEMdhM/L3YPhnmRCi9fDSn3w1EluxYtdwNHOIdCLvPqFrXf yTJ237F73YYpjGWJI683rJaMjL/EsFid7L6lV7qgy6V9RgcqtM04LYFdlH9sXtxAX3J0 SkWYoI+BDkpreRIHJFEbAcmhHkXawEtcybn5Y7Yyf5FLzwS6Zv38yRF49d9zySxq7wV1 a6HA== X-Forwarded-Encrypted: i=1; AJvYcCU3/5mxFci4ryHMsLrz57TImS7M/qk2+8F/Is5iZqzSupPFHf7HA3/dx2jwx8wSnQzNYCaVx65jteZP@vger.kernel.org, AJvYcCV6+abJuJTdexwWdrLmTlQeApirvwyWs8sadu0urKfpXAzpowfVk9+qGBpdCFD8Q1Aanw+PfbOr@vger.kernel.org, AJvYcCVtTVAE2v/usqjd2bW0yKRIlkOO8by2+X9U7I19u3e2WaEGK5ZSiQOyPYR6nccijwzj6cHF6AqM9Iym@vger.kernel.org, AJvYcCW+NaBBl5d+2yCQZPpJkgfMLZrtkwp4iGSa+mzoVFeMwSXyFks/z0Q3KJBX/j+R2kGR5vQJPyGpDhQ=@vger.kernel.org, AJvYcCWDoGJERfeEdzQVlTkvHlBsiiBJbjixVmMuzHKZwwk6Mq4kThJ84NfNbRIx27AOTDD1RExGSLm1LlKDhcAFQTk=@vger.kernel.org, AJvYcCWQSytfBL3YWHiTUpgnEWdzTgVvwgsouKr5mw1sLnTlhsl/sQyUQnDqFeiGvAMXVkf3G62mrkX6iT8YOG8=@vger.kernel.org, AJvYcCWcl4KSyV6aoD9JH2LavicW42tkeLDKKnypPIqq19n5glCMIrVIVMazKX7+Dgf1hp21IMjsUfYGyHFH3g==@vger.kernel.org X-Gm-Message-State: AOJu0YynhJmE9boeMKH1A1Yt8O89+LZxKMWB69N3WPzjSPC5W9eIPr6X 8qNBv7EH0T6IIVEi/ZIbH5W8hSiGdpHNP62/L1PNmJKw0wHltxoA X-Google-Smtp-Source: AGHT+IG3ypNSbqHChFy9UQbSlhwShNvXEdjqWejgJ/1uq+MONYjlC8GwoXsOSxg7ea8jHuvDYkRNPg== X-Received: by 2002:a05:6a20:a124:b0:1dc:7907:6d67 with SMTP id adf61e73a8af0-1ddb04340ebmr8605324637.40.1732171277249; Wed, 20 Nov 2024 22:41:17 -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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:16 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 4/7] can: Add Nuvoton NCT6694 CAN support Date: Thu, 21 Nov 2024 14:40:43 +0800 Message-Id: <20241121064046.3724726-5-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports Socket CANfd functionality for NCT6694 MFD device based on USB interface. Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/net/can/Kconfig | 10 + drivers/net/can/Makefile | 1 + drivers/net/can/nct6694_canfd.c | 926 ++++++++++++++++++++++++++++++++ 4 files changed, 938 insertions(+) create mode 100644 drivers/net/can/nct6694_canfd.c diff --git a/MAINTAINERS b/MAINTAINERS index a190f2b08fa3..eb5d46825e71 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16548,6 +16548,7 @@ S: Supported F: drivers/gpio/gpio-nct6694.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c +F: drivers/net/can/nct6694_canfd.c F: include/linux/mfd/nct6694.h NVIDIA (rivafb and nvidiafb) FRAMEBUFFER DRIVER diff --git a/drivers/net/can/Kconfig b/drivers/net/can/Kconfig index cf989bea9aa3..130e98ec28a5 100644 --- a/drivers/net/can/Kconfig +++ b/drivers/net/can/Kconfig @@ -200,6 +200,16 @@ config CAN_SUN4I To compile this driver as a module, choose M here: the module will be called sun4i_can. +config CAN_NCT6694 + tristate "Nuvoton NCT6694 Socket CANfd support" + depends on MFD_NCT6694 + help + If you say yes to this option, support will be included for Nuvoton + NCT6694, a USB device to socket CANfd controller. + + This driver can also be built as a module. If so, the module will + be called nct6694_canfd. + config CAN_TI_HECC depends on ARM tristate "TI High End CAN Controller" diff --git a/drivers/net/can/Makefile b/drivers/net/can/Makefile index a71db2cfe990..4a6b5b9d6c2b 100644 --- a/drivers/net/can/Makefile +++ b/drivers/net/can/Makefile @@ -28,6 +28,7 @@ obj-$(CONFIG_CAN_JANZ_ICAN3) += janz-ican3.o obj-$(CONFIG_CAN_KVASER_PCIEFD) += kvaser_pciefd.o obj-$(CONFIG_CAN_MSCAN) += mscan/ obj-$(CONFIG_CAN_M_CAN) += m_can/ +obj-$(CONFIG_CAN_NCT6694) += nct6694_canfd.o obj-$(CONFIG_CAN_PEAK_PCIEFD) += peak_canfd/ obj-$(CONFIG_CAN_SJA1000) += sja1000/ obj-$(CONFIG_CAN_SUN4I) += sun4i_can.o diff --git a/drivers/net/can/nct6694_canfd.c b/drivers/net/can/nct6694_canfd.c new file mode 100644 index 000000000000..d488414981ec --- /dev/null +++ b/drivers/net/can/nct6694_canfd.c @@ -0,0 +1,926 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 Socket CANfd driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#define DRVNAME "nct6694-can" + +/* Host interface */ +#define NCT6694_CAN_MOD 0x05 + +/* Message Channel*/ +/* Command 00h */ +#define NCT6694_CAN_CMD0_LEN 0x18 +#define NCT6694_CAN_CMD0_OFFSET(idx) (idx ? 0x0100 : 0x0000) +#define NCT6694_CAN_CTRL1_MON BIT(0) +#define NCT6694_CAN_CTRL1_NISO BIT(1) +#define NCT6694_CAN_CTRL1_LBCK BIT(2) + +/* Command 01h */ +#define NCT6694_CAN_CMD1_LEN 0x08 +#define NCT6694_CAN_CMD1_OFFSET 0x0001 + +/* Command 02h */ +#define NCT6694_CAN_CMD2_LEN 0x10 +#define NCT6694_CAN_CMD2_OFFSET(idx, mask) \ + ({ typeof(mask) mask_ = (mask); \ + idx ? ((0x80 | (mask_ & 0xFF)) << 8 | 0x02) : \ + ((0x00 | (mask_ & 0xFF)) << 8 | 0x02); }) + +#define NCT6694_CAN_EVENT_ERR BIT(0) +#define NCT6694_CAN_EVENT_STATUS BIT(1) +#define NCT6694_CAN_EVENT_TX_EVT BIT(2) +#define NCT6694_CAN_EVENT_RX_EVT BIT(3) +#define NCT6694_CAN_EVENT_REC BIT(4) +#define NCT6694_CAN_EVENT_TEC BIT(5) +#define NCT6694_CAN_EVT_TX_FIFO_EMPTY BIT(7) /* Read-clear */ +#define NCT6694_CAN_EVT_RX_DATA_LOST BIT(5) /* Read-clear */ +#define NCT6694_CAN_EVT_RX_HALF_FULL BIT(6) /* Read-clear */ +#define NCT6694_CAN_EVT_RX_DATA_IN BIT(7) + +/* Command 10h */ +#define NCT6694_CAN_CMD10_LEN 0x90 +#define NCT6694_CAN_CMD10_OFFSET(buf_cnt) \ + (((buf_cnt) & 0xFF) << 8 | 0x10) +#define NCT6694_CAN_TAG_CAN0 0xC0 +#define NCT6694_CAN_TAG_CAN1 0xC1 +#define NCT6694_CAN_FLAG_EFF BIT(0) +#define NCT6694_CAN_FLAG_RTR BIT(1) +#define NCT6694_CAN_FLAG_FD BIT(2) +#define NCT6694_CAN_FLAG_BRS BIT(3) +#define NCT6694_CAN_FLAG_ERR BIT(4) + +/* Command 11h */ +#define NCT6694_CAN_CMD11_LEN 0x90 +#define NCT6694_CAN_CMD11_OFFSET(idx, buf_cnt) \ + ({ typeof(buf_cnt) buf_cnt_ = (buf_cnt); \ + idx ? ((0x80 | (buf_cnt_ & 0xFF)) << 8 | 0x11) : \ + ((0x00 | (buf_cnt_ & 0xFF)) << 8 | 0x11); }) + +#define NCT6694_CAN_RX_QUOTA 64 + +enum nct6694_event_err { + NCT6694_CAN_EVT_NO_ERROR, + NCT6694_CAN_EVT_CRC_ERROR, + NCT6694_CAN_EVT_STUFF_ERROR, + NCT6694_CAN_EVT_ACK_ERROR, + NCT6694_CAN_EVT_FORM_ERROR, + NCT6694_CAN_EVT_BIT_ERROR, + NCT6694_CAN_EVT_TIMEOUT_ERROR, + NCT6694_CAN_EVT_UNKNOWN_ERROR, +}; + +enum nct6694_event_status { + NCT6694_CAN_EVT_ERROR_ACTIVE, + NCT6694_CAN_EVT_ERROR_PASSIVE, + NCT6694_CAN_EVT_BUS_OFF, + NCT6694_CAN_EVT_WARNING, +}; + +struct __packed nct6694_can_cmd0 { + u32 nbr; + u32 dbr; + u32 active:8; + u32 reserved:24; + u16 ctrl1; + u16 ctrl2; + u32 nbtp; + u32 dbtp; +}; + +struct __packed nct6694_can_cmd1 { + u8 tx_fifo_cnt; + u8 rx_fifo_cnt; + u16 reserved; + __le32 can_clk; +}; + +struct __packed nct6694_can_cmd2 { + u8 err1; + u8 status1; + u8 tx_evt1; + u8 rx_evt1; + u8 rec1; + u8 tec1; + u8 reserved1[2]; + u8 err2; + u8 status2; + u8 tx_evt2; + u8 rx_evt2; + u8 rec2; + u8 tec2; + u8 reserved2[2]; +}; + +struct __packed nct6694_can_cmd10_11 { + u8 tag; + u8 flag; + u8 reserved; + u8 dlc; + __le32 id; + u8 data[64]; + u8 msg_buf[72]; +}; + +struct nct6694_canfd_priv { + struct can_priv can; /* must be the first member */ + struct net_device *ndev; + struct nct6694 *nct6694; + struct mutex lock; + struct sk_buff *tx_skb; + struct workqueue_struct *wq; + struct work_struct tx_work; + unsigned char *tx_buf; + unsigned char *rx_buf; + unsigned char can_idx; + bool tx_busy; +}; + +static const struct can_bittiming_const nct6694_canfd_bittiming_nominal_const = { + .name = DRVNAME, + .tseg1_min = 2, + .tseg1_max = 256, + .tseg2_min = 2, + .tseg2_max = 128, + .sjw_max = 128, + .brp_min = 1, + .brp_max = 511, + .brp_inc = 1, +}; + +static const struct can_bittiming_const nct6694_canfd_bittiming_data_const = { + .name = DRVNAME, + .tseg1_min = 1, + .tseg1_max = 32, + .tseg2_min = 1, + .tseg2_max = 16, + .sjw_max = 16, + .brp_min = 1, + .brp_max = 31, + .brp_inc = 1, +}; + +static void nct6694_canfd_clean(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + + if (priv->tx_skb || priv->tx_busy) + ndev->stats.tx_errors++; + dev_kfree_skb(priv->tx_skb); + if (priv->tx_busy) + can_free_echo_skb(priv->ndev, 0, NULL); + priv->tx_skb = NULL; + priv->tx_busy = false; +} + +static int nct6694_canfd_get_berr_counter(const struct net_device *ndev, + struct can_berr_counter *bec) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd2 *buf = (struct nct6694_can_cmd2 *)priv->rx_buf; + u8 mask = NCT6694_CAN_EVENT_REC | NCT6694_CAN_EVENT_TEC; + int ret; + + guard(mutex)(&priv->lock); + + ret = nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD2_OFFSET(priv->can_idx, mask), + NCT6694_CAN_CMD2_LEN, + buf); + if (ret < 0) + return ret; + + bec->rxerr = priv->can_idx ? buf->rec2 : buf->rec1; + bec->txerr = priv->can_idx ? buf->tec2 : buf->tec1; + + return 0; +} + +static int nuv_canfd_handle_lost_msg(struct net_device *ndev) +{ + struct net_device_stats *stats = &ndev->stats; + struct sk_buff *skb; + struct can_frame *frame; + + netdev_err(ndev, "RX FIFO overflow, message(s) lost.\n"); + + stats->rx_errors++; + stats->rx_over_errors++; + + skb = alloc_can_err_skb(ndev, &frame); + if (unlikely(!skb)) + return 0; + + frame->can_id |= CAN_ERR_CRTL; + frame->data[1] = CAN_ERR_CRTL_RX_OVERFLOW; + + netif_receive_skb(skb); + + return 1; +} + +static void nuv_canfd_read_fifo(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd10_11 *buf = (struct nct6694_can_cmd10_11 *)priv->rx_buf; + struct net_device_stats *stats = &ndev->stats; + struct canfd_frame *cf; + struct sk_buff *skb; + int can_idx = priv->can_idx; + u32 id; + int ret; + u8 fd_format = 0; + int i; + + guard(mutex)(&priv->lock); + + ret = nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD11_OFFSET(can_idx, 1), + NCT6694_CAN_CMD11_LEN, buf); + if (ret < 0) + return; + + /* Check type of frame and create skb */ + fd_format = buf->flag & NCT6694_CAN_FLAG_FD; + if (fd_format) + skb = alloc_canfd_skb(ndev, &cf); + else + skb = alloc_can_skb(ndev, (struct can_frame **)&cf); + + if (!skb) { + stats->rx_dropped++; + return; + } + + cf->len = buf->dlc; + + /* Get ID and set flag by its type(Standard ID format or Ext ID format) */ + id = le32_to_cpu(buf->id); + if (buf->flag & NCT6694_CAN_FLAG_EFF) { + /* + * In case the Extended ID frame is received, the standard + * and extended part of the ID are swapped in the register, + * so swap them back to obtain the correct ID. + */ + id |= CAN_EFF_FLAG; + } + + cf->can_id = id; + + /* Set ESI flag */ + if (buf->flag & NCT6694_CAN_FLAG_ERR) { + cf->flags |= CANFD_ESI; + netdev_dbg(ndev, "ESI Error\n"); + } + + /* Set RTR and BRS */ + if (!fd_format && (buf->flag & NCT6694_CAN_FLAG_RTR)) { + cf->can_id |= CAN_RTR_FLAG; + } else { + if (buf->flag & NCT6694_CAN_FLAG_BRS) + cf->flags |= CANFD_BRS; + + for (i = 0; i < cf->len; i++) + cf->data[i] = buf->data[i]; + } + + /* Remove the packet from FIFO */ + stats->rx_packets++; + stats->rx_bytes += cf->len; + netif_receive_skb(skb); +} + +static int nct6694_canfd_do_rx_poll(struct net_device *ndev, int quota) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd2 *buf = (struct nct6694_can_cmd2 *)priv->rx_buf; + int can_idx = priv->can_idx; + u32 pkts = 0; + u8 mask_rx = NCT6694_CAN_EVENT_RX_EVT; + u8 rx_evt; + + for (;;) { + scoped_guard(mutex, &priv->lock) { + nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD2_OFFSET(can_idx, mask_rx), + NCT6694_CAN_CMD2_LEN, buf); + + rx_evt = can_idx ? buf->rx_evt2 : buf->rx_evt1; + } + + if (rx_evt & NCT6694_CAN_EVT_RX_DATA_LOST) + nuv_canfd_handle_lost_msg(ndev); + + /* No data */ + if ((rx_evt & NCT6694_CAN_EVT_RX_DATA_IN) == 0) + break; + + if (quota <= 0) + break; + + nuv_canfd_read_fifo(ndev); + quota--; + pkts++; + } + + return pkts; +} + +static int nct6694_canfd_handle_lec_err(struct net_device *ndev, u8 bus_err) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct net_device_stats *stats = &ndev->stats; + struct can_frame *cf; + struct sk_buff *skb; + + if (bus_err == NCT6694_CAN_EVT_NO_ERROR) + return 0; + + priv->can.can_stats.bus_error++; + stats->rx_errors++; + + /* Propagate the error condition to the CAN stack. */ + skb = alloc_can_err_skb(ndev, &cf); + + if (unlikely(!skb)) + return 0; + + /* Read the error counter register and check for new errors. */ + cf->can_id |= CAN_ERR_PROT | CAN_ERR_BUSERROR; + + switch (bus_err) { + case NCT6694_CAN_EVT_CRC_ERROR: + cf->data[3] = CAN_ERR_PROT_LOC_CRC_SEQ; + break; + + case NCT6694_CAN_EVT_STUFF_ERROR: + cf->data[2] |= CAN_ERR_PROT_STUFF; + break; + + case NCT6694_CAN_EVT_ACK_ERROR: + cf->data[3] = CAN_ERR_PROT_LOC_ACK; + break; + + case NCT6694_CAN_EVT_FORM_ERROR: + cf->data[2] |= CAN_ERR_PROT_FORM; + break; + + case NCT6694_CAN_EVT_BIT_ERROR: + cf->data[2] |= CAN_ERR_PROT_BIT | + CAN_ERR_PROT_BIT0 | + CAN_ERR_PROT_BIT1; + break; + + case NCT6694_CAN_EVT_TIMEOUT_ERROR: + cf->data[2] |= CAN_ERR_PROT_UNSPEC; + break; + + case NCT6694_CAN_EVT_UNKNOWN_ERROR: + cf->data[2] |= CAN_ERR_PROT_UNSPEC; + /* + * It means 'unspecified'(the value is '0'). + * But it is not sure if it's ok to send an error package + * without specific error bit. + */ + break; + + default: + break; + } + + /* Reset the error counter, ack the IRQ and re-enable the counter. */ + stats->rx_packets++; + stats->rx_bytes += cf->can_dlc; + netif_receive_skb(skb); + + return 1; +} + +static int nct6694_canfd_handle_state_change(struct net_device *ndev, + enum can_state new_state) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct net_device_stats *stats = &ndev->stats; + struct can_frame *cf; + struct sk_buff *skb; + struct can_berr_counter bec; + + switch (new_state) { + case CAN_STATE_ERROR_ACTIVE: + /* error active state */ + priv->can.can_stats.error_warning++; + priv->can.state = CAN_STATE_ERROR_ACTIVE; + break; + case CAN_STATE_ERROR_WARNING: + /* error warning state */ + priv->can.can_stats.error_warning++; + priv->can.state = CAN_STATE_ERROR_WARNING; + break; + case CAN_STATE_ERROR_PASSIVE: + /* error passive state */ + priv->can.can_stats.error_passive++; + priv->can.state = CAN_STATE_ERROR_PASSIVE; + break; + case CAN_STATE_BUS_OFF: + /* bus-off state */ + priv->can.state = CAN_STATE_BUS_OFF; + priv->can.can_stats.bus_off++; + can_bus_off(ndev); + break; + default: + break; + } + + /* propagate the error condition to the CAN stack */ + skb = alloc_can_err_skb(ndev, &cf); + if (unlikely(!skb)) + return 0; + + nct6694_canfd_get_berr_counter(ndev, &bec); + + switch (new_state) { + case CAN_STATE_ERROR_WARNING: + /* error warning state */ + cf->can_id |= CAN_ERR_CRTL; + cf->data[1] = (bec.txerr > bec.rxerr) ? CAN_ERR_CRTL_TX_WARNING : + CAN_ERR_CRTL_RX_WARNING; + cf->data[6] = bec.txerr; + cf->data[7] = bec.rxerr; + break; + case CAN_STATE_ERROR_PASSIVE: + /* error passive state */ + cf->can_id |= CAN_ERR_CRTL; + cf->data[1] |= CAN_ERR_CRTL_RX_PASSIVE; + if (bec.txerr > 127) + cf->data[1] |= CAN_ERR_CRTL_TX_PASSIVE; + cf->data[6] = bec.txerr; + cf->data[7] = bec.rxerr; + break; + case CAN_STATE_BUS_OFF: + /* bus-off state */ + cf->can_id |= CAN_ERR_BUSOFF; + break; + default: + break; + } + + stats->rx_packets++; + stats->rx_bytes += cf->can_dlc; + netif_receive_skb(skb); + + return 1; +} + +static int nct6694_canfd_handle_state_errors(struct net_device *ndev, + unsigned char can_status) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + int work_done = 0; + + if (can_status == NCT6694_CAN_EVT_ERROR_ACTIVE && + priv->can.state != CAN_STATE_ERROR_ACTIVE) { + netdev_dbg(ndev, "Error, entered active state\n"); + work_done += nct6694_canfd_handle_state_change(ndev, + CAN_STATE_ERROR_ACTIVE); + } + + if (can_status == NCT6694_CAN_EVT_WARNING && + priv->can.state != CAN_STATE_ERROR_WARNING) { + netdev_dbg(ndev, "Error, entered warning state\n"); + work_done += nct6694_canfd_handle_state_change(ndev, + CAN_STATE_ERROR_WARNING); + } + + if (can_status == NCT6694_CAN_EVT_ERROR_PASSIVE && + priv->can.state != CAN_STATE_ERROR_PASSIVE) { + netdev_dbg(ndev, "Error, entered passive state\n"); + work_done += nct6694_canfd_handle_state_change(ndev, + CAN_STATE_ERROR_PASSIVE); + } + + if (can_status == NCT6694_CAN_EVT_BUS_OFF && + priv->can.state != CAN_STATE_BUS_OFF) { + netdev_dbg(ndev, "Error, entered bus-off state\n"); + work_done += nct6694_canfd_handle_state_change(ndev, + CAN_STATE_BUS_OFF); + } + + return work_done; +} + +static int nct6694_canfd_poll(struct net_device *ndev, int quota) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd2 *buf = (struct nct6694_can_cmd2 *)priv->rx_buf; + int can_idx = priv->can_idx; + int work_done = 0, ret; + u8 evt_mask = NCT6694_CAN_EVENT_ERR | NCT6694_CAN_EVENT_STATUS; + u8 bus_err, can_status; + + scoped_guard(mutex, &priv->lock) { + ret = nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD2_OFFSET(can_idx, evt_mask), + NCT6694_CAN_CMD2_LEN, buf); + if (ret < 0) + return IRQ_NONE; + + if (can_idx) { + bus_err = buf->err2; + can_status = buf->status2; + } else { + bus_err = buf->err1; + can_status = buf->status1; + } + } + + /* Handle bus state changes */ + work_done += nct6694_canfd_handle_state_errors(ndev, can_status); + + /* Handle lec errors on the bus */ + if (priv->can.ctrlmode & CAN_CTRLMODE_BERR_REPORTING) + work_done += nct6694_canfd_handle_lec_err(ndev, bus_err); + + /* Handle RX events */ + work_done += nct6694_canfd_do_rx_poll(ndev, quota - work_done); + return work_done; +} + +static void nct6694_canfd_tx_irq(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct net_device_stats *stats = &ndev->stats; + + guard(mutex)(&priv->lock); + stats->tx_bytes += can_get_echo_skb(ndev, 0, NULL); + stats->tx_packets++; + priv->tx_busy = false; + netif_wake_queue(ndev); +} + +static irqreturn_t nct6694_canfd_irq(int irq, void *data) +{ + struct net_device *ndev = data; + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd2 *buf = (struct nct6694_can_cmd2 *)priv->rx_buf; + int can_idx = priv->can_idx; + int ret; + u8 mask_sts = NCT6694_CAN_EVENT_TX_EVT; + u8 tx_evt; + + scoped_guard(mutex, &priv->lock) { + ret = nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD2_OFFSET(can_idx, mask_sts), + NCT6694_CAN_CMD2_LEN, buf); + if (ret < 0) + return IRQ_NONE; + + tx_evt = can_idx ? buf->tx_evt2 : buf->tx_evt1; + } + + if (tx_evt) { + nct6694_canfd_tx_irq(ndev); + } else { + ret = nct6694_canfd_poll(ndev, NCT6694_CAN_RX_QUOTA); + if (!ret) + return IRQ_NONE; + } + + return IRQ_HANDLED; +} + +static int nct6694_canfd_start(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd0 *buf = (struct nct6694_can_cmd0 *)priv->tx_buf; + const struct can_bittiming *n_bt = &priv->can.bittiming; + const struct can_bittiming *d_bt = &priv->can.data_bittiming; + int ret; + + guard(mutex)(&priv->lock); + + memset(priv->tx_buf, 0, NCT6694_CAN_CMD0_LEN); + buf->nbr = n_bt->bitrate; + buf->dbr = d_bt->bitrate; + + if (priv->can.ctrlmode & CAN_CTRLMODE_LISTENONLY) + buf->ctrl1 |= NCT6694_CAN_CTRL1_MON; + + if ((priv->can.ctrlmode & CAN_CTRLMODE_FD) && + priv->can.ctrlmode & CAN_CTRLMODE_FD_NON_ISO) + buf->ctrl1 |= NCT6694_CAN_CTRL1_NISO; + + if (priv->can.ctrlmode & CAN_CTRLMODE_LOOPBACK) + buf->ctrl1 |= NCT6694_CAN_CTRL1_LBCK; + + ret = nct6694_write_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD0_OFFSET(priv->can_idx), + NCT6694_CAN_CMD0_LEN, buf); + if (ret < 0) + return ret; + + priv->can.state = CAN_STATE_ERROR_ACTIVE; + + return 0; +} + +static int nct6694_canfd_stop(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + + netif_stop_queue(ndev); + free_irq(ndev->irq, ndev); + destroy_workqueue(priv->wq); + priv->wq = NULL; + nct6694_canfd_clean(ndev); + priv->can.state = CAN_STATE_STOPPED; + close_candev(ndev); + + return 0; +} + +static int nct6694_canfd_set_mode(struct net_device *ndev, enum can_mode mode) +{ + switch (mode) { + case CAN_MODE_START: + nct6694_canfd_clean(ndev); + nct6694_canfd_start(ndev); + netif_wake_queue(ndev); + break; + default: + return -EOPNOTSUPP; + } + + return 0; +} + +static int nct6694_canfd_open(struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + int ret; + + ret = open_candev(ndev); + if (ret) + return ret; + + ret = request_threaded_irq(ndev->irq, NULL, + nct6694_canfd_irq, IRQF_ONESHOT, + "nct6694_can", ndev); + if (ret) { + netdev_err(ndev, "Failed to request IRQ\n"); + goto close_candev; + } + + priv->wq = alloc_ordered_workqueue("%s-nct6694_wq", + WQ_FREEZABLE | WQ_MEM_RECLAIM, + ndev->name); + if (!priv->wq) { + ret = -ENOMEM; + goto free_irq; + } + + priv->tx_skb = NULL; + priv->tx_busy = false; + + ret = nct6694_canfd_start(ndev); + if (ret) + goto destroy_wq; + + netif_start_queue(ndev); + + return 0; + +destroy_wq: + destroy_workqueue(priv->wq); +free_irq: + free_irq(ndev->irq, ndev); +close_candev: + close_candev(ndev); + return ret; +} + +static netdev_tx_t nct6694_canfd_start_xmit(struct sk_buff *skb, + struct net_device *ndev) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + + if (priv->tx_skb || priv->tx_busy) { + netdev_err(ndev, "hard_xmit called while tx busy\n"); + return NETDEV_TX_BUSY; + } + + if (can_dev_dropped_skb(ndev, skb)) + return NETDEV_TX_OK; + + netif_stop_queue(ndev); + priv->tx_skb = skb; + queue_work(priv->wq, &priv->tx_work); + + return NETDEV_TX_OK; +} + +static void nct6694_canfd_tx(struct net_device *ndev, struct canfd_frame *cf) +{ + struct nct6694_canfd_priv *priv = netdev_priv(ndev); + struct nct6694_can_cmd10_11 *buf = (struct nct6694_can_cmd10_11 *)priv->tx_buf; + u32 txid = 0; + int i; + + memset(buf, 0, NCT6694_CAN_CMD10_LEN); + + if (priv->can_idx == 0) + buf->tag = NCT6694_CAN_TAG_CAN0; + else + buf->tag = NCT6694_CAN_TAG_CAN1; + + if (cf->can_id & CAN_EFF_FLAG) { + txid = cf->can_id & CAN_EFF_MASK; + /* + * In case the Extended ID frame is transmitted, the + * standard and extended part of the ID are swapped + * in the register, so swap them back to send the + * correct ID. + */ + buf->flag |= NCT6694_CAN_FLAG_EFF; + } else { + txid = cf->can_id & CAN_SFF_MASK; + } + + buf->id = cpu_to_le32(txid); + buf->dlc = cf->len; + + if ((priv->can.ctrlmode & CAN_CTRLMODE_FD) && + can_is_canfd_skb(priv->tx_skb)) { + buf->flag |= NCT6694_CAN_FLAG_FD; + if (cf->flags & CANFD_BRS) + buf->flag |= NCT6694_CAN_FLAG_BRS; + } + + if (cf->can_id & CAN_RTR_FLAG) + buf->flag |= NCT6694_CAN_FLAG_RTR; + + /* set data to buf */ + for (i = 0; i < cf->len; i++) + buf->data[i] = cf->data[i]; + + nct6694_write_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD10_OFFSET(1), + NCT6694_CAN_CMD10_LEN, + buf); +} + +static void nct6694_canfd_tx_work(struct work_struct *work) +{ + struct nct6694_canfd_priv *priv = container_of(work, + struct nct6694_canfd_priv, + tx_work); + struct net_device *ndev = priv->ndev; + struct canfd_frame *cf; + + guard(mutex)(&priv->lock); + + if (priv->tx_skb) { + if (priv->can.state == CAN_STATE_BUS_OFF) { + nct6694_canfd_clean(ndev); + } else { + cf = (struct canfd_frame *)priv->tx_skb->data; + nct6694_canfd_tx(ndev, cf); + priv->tx_busy = true; + can_put_echo_skb(priv->tx_skb, ndev, 0, 0); + priv->tx_skb = NULL; + } + } +} + +static const struct net_device_ops nct6694_canfd_netdev_ops = { + .ndo_open = nct6694_canfd_open, + .ndo_stop = nct6694_canfd_stop, + .ndo_start_xmit = nct6694_canfd_start_xmit, + .ndo_change_mtu = can_change_mtu, +}; + +static int nct6694_canfd_get_clock(struct nct6694_canfd_priv *priv) +{ + struct nct6694_can_cmd1 *buf = (struct nct6694_can_cmd1 *)priv->rx_buf; + int ret; + + ret = nct6694_read_msg(priv->nct6694, NCT6694_CAN_MOD, + NCT6694_CAN_CMD1_OFFSET, + NCT6694_CAN_CMD1_LEN, + buf); + if (ret) + return ret; + + return le32_to_cpu(buf->can_clk); +} + +static int nct6694_canfd_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_canfd_priv *priv; + struct net_device *ndev; + int ret, irq, can_clk; + + irq = irq_create_mapping(nct6694->domain, + NCT6694_IRQ_CAN1 + cell->id); + if (!irq) + return -EINVAL; + + ndev = alloc_candev(sizeof(struct nct6694_canfd_priv), 1); + if (!ndev) + return -ENOMEM; + + ndev->irq = irq; + ndev->flags |= IFF_ECHO; + ndev->netdev_ops = &nct6694_canfd_netdev_ops; + + priv = netdev_priv(ndev); + priv->nct6694 = nct6694; + priv->ndev = ndev; + + priv->tx_buf = devm_kcalloc(&pdev->dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!priv->tx_buf) { + ret = -ENOMEM; + goto free_candev; + } + + priv->rx_buf = devm_kcalloc(&pdev->dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!priv->rx_buf) { + ret = -ENOMEM; + goto free_candev; + } + + can_clk = nct6694_canfd_get_clock(priv); + if (can_clk < 0) { + ret = -EIO; + goto free_candev; + } + + mutex_init(&priv->lock); + INIT_WORK(&priv->tx_work, nct6694_canfd_tx_work); + + priv->can_idx = cell->id; + priv->can.state = CAN_STATE_STOPPED; + priv->can.clock.freq = can_clk; + priv->can.bittiming_const = &nct6694_canfd_bittiming_nominal_const; + priv->can.data_bittiming_const = &nct6694_canfd_bittiming_data_const; + priv->can.do_set_mode = nct6694_canfd_set_mode; + priv->can.do_get_berr_counter = nct6694_canfd_get_berr_counter; + + priv->can.ctrlmode = CAN_CTRLMODE_FD; + + priv->can.ctrlmode_supported = CAN_CTRLMODE_LOOPBACK | + CAN_CTRLMODE_LISTENONLY | + CAN_CTRLMODE_FD | + CAN_CTRLMODE_FD_NON_ISO | + CAN_CTRLMODE_BERR_REPORTING; + + platform_set_drvdata(pdev, priv); + SET_NETDEV_DEV(priv->ndev, &pdev->dev); + + ret = register_candev(priv->ndev); + if (ret) + goto free_candev; + + return 0; + +free_candev: + free_candev(ndev); + return dev_err_probe(&pdev->dev, ret, "Probe failed\n"); +} + +static void nct6694_canfd_remove(struct platform_device *pdev) +{ + struct nct6694_canfd_priv *priv = platform_get_drvdata(pdev); + + cancel_work_sync(&priv->tx_work); + unregister_candev(priv->ndev); + free_candev(priv->ndev); +} + +static struct platform_driver nct6694_canfd_driver = { + .driver = { + .name = DRVNAME, + }, + .probe = nct6694_canfd_probe, + .remove = nct6694_canfd_remove, +}; + +module_platform_driver(nct6694_canfd_driver); + +MODULE_DESCRIPTION("USB-CAN FD driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); From patchwork Thu Nov 21 06:40:44 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844783 Received: from mail-pg1-f180.google.com (mail-pg1-f180.google.com [209.85.215.180]) (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 D8C5C1CD1FC; Thu, 21 Nov 2024 06:41:21 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.180 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171283; cv=none; b=aMMD4/+3r2DOHct3jsj/kW188j3UyJMxWHg+bUSH2FSL1WKdSTMltbhZFQod9SSSkeEserIzNNFOhtd97TsWYTqAy6lcXYaM6eJ0KX+ZPwzVGO7tta6IM+ONxGstoUOdSGrG4JCbrApCnF9War5DeESYXfCjVS7mtF5UkvsPX+4= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171283; c=relaxed/simple; bh=CPXoehGwTSs45YlcqtJ+F/QvQrwzI5sbYSnD2Pak/mE=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=L2UOKXwtpFoVh0KeepTmWhttamUsE7pqLbjK+7PqS0IUFbS2ffxfTuoqq5wEER4eRTM1hrC7c49d5tXpzHzu3GLiO4mgwdgzzcx3Mo5qXGS1MlcFrxQhZ26V4Ri+rEKpS6cD8Hxu4xncd5lhpNheySyeRo9JtoeJx9LY6N+Jp14= 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=WVhHMXsR; arc=none smtp.client-ip=209.85.215.180 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="WVhHMXsR" Received: by mail-pg1-f180.google.com with SMTP id 41be03b00d2f7-7f4325168c8so396126a12.1; Wed, 20 Nov 2024 22:41:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171281; x=1732776081; 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=gsLP5BfEq+ny/TNJBmMYQ+aCSSVlRXL5xPNb64PDy8c=; b=WVhHMXsRnlnd9qol6ZM4YbxZNA+HOTThBF4TuPQ+zcdeze1bJYp4XBFYC1O2dlFqFF xD9YpWRjU6UpBnXY9G4erbIWZrpluXjJ6Km/YlHKXsB/lcnN5KpHgA0u5E54m0+h5iHU k/PmJVNSVRKIsNEd173KnYH7kbIh2e1M5EirTcJkTSBf2tWfFSjUhYJUMZfxhFYejwAZ y9L4+m9AZz7L/sIsIFfw76vYIqkkMdjDk7HwJG/Pyi4/rE5YxOFkny45U7RqCFiUJxD7 AqrWCTPjeP5si2BOSheLmyoMrX+itAokLM2fG3YMfwTlxF81Kh7G7GhOUoD7eKy3GSvC uzEA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171281; x=1732776081; 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=gsLP5BfEq+ny/TNJBmMYQ+aCSSVlRXL5xPNb64PDy8c=; b=mUoM1ZIJRa+gcQSU1qT3TeiZlR7t1BmX29oVPkrq3Enoa/zVPC7a9DkhgomqIYEWwa TUYe4Sles/5CW5DZL4f6bA97S0Xrg1aw0t/T+tqblUJudBtjFzoBsl1YidwcvpT09F/S 1fF7L9qdm19Fm0B8qYpOBL+dR0RHtFevcQatRPXLUEAVK+/p7cy3ykNlKScDZiXKUvN/ cIvXicgZ84ourP5/642yCwesvfXvD91RvpHE/9xLMoLamwYQy/vY6rg6Y+Pz6IbHS/pI ygQUatmvfiSVx4WmX9rUha3q9//mLwTqXgxa2/VscIHEv0V9xYhk4TFVi171EBbaR5dL Ex6A== X-Forwarded-Encrypted: i=1; AJvYcCUcf2yrw4wTju8UdcnBqoo5vd5KUMgzOPLhUz8VclTOkNgImzXrQXFLL/MIIrb9xrXTBXFTkURAKxXXyg==@vger.kernel.org, AJvYcCUhNWkwhDEtfdCYl7EdAP/gDb+OMkTr7dZDqrYic2PArnEg0sK/D2FTx+4Ds7nWLlERzXpd1EPOj2kw2m+qSh0=@vger.kernel.org, AJvYcCUsR/qzHGav9Sk+aEexkV2wx8f164L3DLkjTgheQ70EXSyfBmTsPsf8kNZAvl2CXUQVRf4sLSx8xng=@vger.kernel.org, AJvYcCVYGK7LM4m3eYiRqUQ+cTq6H/RmWcUh4vJQRwVRb8Lgr0C/ihhcGtG94RjJuDA38OIVH+bmzBUnfvRo@vger.kernel.org, AJvYcCWZwpQXHjJPdK+83pYzjAyQKO105ATlp1R/SWCICNysbXtUqHeZvDJ9DgTrBWTrxY5VRijrK8wai48VE8g=@vger.kernel.org, AJvYcCWjTCmk2/G3UCQ5zbdXUF2Q3OexwzOhvRquypS4iM9uRZG0aPWFFttJTH0WvdUsr9sKxKoh+bJN@vger.kernel.org, AJvYcCXRGl5qSI/VdzeqwnTyTeHUoGc92NsYcnWYx6UtRaBd7HTwvDPahQIGny62oJtljH0vsdIlr1Nqj8nt@vger.kernel.org X-Gm-Message-State: AOJu0YxfTwEmMKO9Eh4WLgyBGcpruR9VVtOCT9gvO9ehU+XRXUKAuopS vtjrly8gMNwW7kFmf8AlEzPFPK1hXHknOFghNSgMYXIfq2iLRVMr X-Google-Smtp-Source: AGHT+IEokQsrbNi6zBGYjcv9dBanc/vtO5pLqsDrV8MZO6La3pSabbKKLXvwdl8PKCh+QdVTOH921g== X-Received: by 2002:a05:6a20:748e:b0:1db:eb2c:a74 with SMTP id adf61e73a8af0-1ddaefbd38dmr8314594637.12.1732171281038; Wed, 20 Nov 2024 22:41: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 d2e1a72fcca58-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:20 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 5/7] watchdog: Add Nuvoton NCT6694 WDT support Date: Thu, 21 Nov 2024 14:40:44 +0800 Message-Id: <20241121064046.3724726-6-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@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 | 277 +++++++++++++++++++++++++++++++++ 4 files changed, 290 insertions(+) create mode 100644 drivers/watchdog/nct6694_wdt.c diff --git a/MAINTAINERS b/MAINTAINERS index eb5d46825e71..496fe7d5a23f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16549,6 +16549,7 @@ F: drivers/gpio/gpio-nct6694.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: drivers/net/can/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 2333476a42c0..851c1f17712d 100644 --- a/drivers/watchdog/Kconfig +++ b/drivers/watchdog/Kconfig @@ -739,6 +739,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 + If you say yes to this option, support will be included for Nuvoton + NCT6694, a USB device to watchdog timer. + + 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 386d88d89fe5..8355893b4435 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..7d2c8d5c6fa3 --- /dev/null +++ b/drivers/watchdog/nct6694_wdt.c @@ -0,0 +1,277 @@ +// 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 + +/* Host interface */ +#define NCT6694_WDT_MOD 0x07 + +/* Message Channel*/ +/* Command 00h */ +#define NCT6694_WDT_CMD0_LEN 0x0F +#define NCT6694_WDT_CMD0_OFFSET(idx) (idx ? 0x0100 : 0x0000) /* OFFSET = SEL|CMD */ + +/* Command 01h */ +#define NCT6694_WDT_CMD1_LEN 0x08 +#define NCT6694_WDT_CMD1_OFFSET(idx) (idx ? 0x0101 : 0x0001) /* OFFSET = SEL|CMD */ + +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_cmd0 { + __le32 pretimeout; + __le32 timeout; + u8 owner; + u8 scratch; + u8 control; + u8 status; + __le32 countdown; +}; + +struct __packed nct6694_wdt_cmd1 { + u32 wdt_cmd; + u32 reserved; +}; + +struct nct6694_wdt_data { + struct watchdog_device wdev; + struct device *dev; + struct nct6694 *nct6694; + struct mutex lock; + unsigned char *xmit_buf; + 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_cmd0 *buf = (struct nct6694_wdt_cmd0 *)data->xmit_buf; + struct nct6694 *nct6694 = data->nct6694; + 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(buf, 0, NCT6694_WDT_CMD0_LEN); + buf->timeout = cpu_to_le32(timeout_fmt); + buf->pretimeout = cpu_to_le32(pretimeout_fmt); + + return nct6694_write_msg(nct6694, NCT6694_WDT_MOD, + NCT6694_WDT_CMD0_OFFSET(data->wdev_idx), + NCT6694_WDT_CMD0_LEN, buf); +} + +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_info(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_cmd1 *buf = (struct nct6694_wdt_cmd1 *)data->xmit_buf; + struct nct6694 *nct6694 = data->nct6694; + + guard(mutex)(&data->lock); + + memcpy(buf, "WDTC", 4); + buf->reserved = 0; + + return nct6694_write_msg(nct6694, NCT6694_WDT_MOD, + NCT6694_WDT_CMD1_OFFSET(data->wdev_idx), + NCT6694_WDT_CMD1_LEN, buf); +} + +static int nct6694_wdt_ping(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_cmd1 *buf = (struct nct6694_wdt_cmd1 *)data->xmit_buf; + struct nct6694 *nct6694 = data->nct6694; + + guard(mutex)(&data->lock); + memcpy(buf, "WDTS", 4); + buf->reserved = 0; + + return nct6694_write_msg(nct6694, NCT6694_WDT_MOD, + NCT6694_WDT_CMD1_OFFSET(data->wdev_idx), + NCT6694_WDT_CMD1_LEN, buf); +} + +static int nct6694_wdt_set_timeout(struct watchdog_device *wdev, + unsigned int timeout) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + int ret; + + if (timeout < wdev->pretimeout) { + dev_warn(data->dev, "pretimeout < timeout. Setting to zero\n"); + wdev->pretimeout = 0; + } + + ret = nct6694_wdt_setting(wdev, timeout, NCT6694_ACTION_GPO, + wdev->pretimeout, NCT6694_ACTION_GPO); + if (ret) + return ret; + + wdev->timeout = timeout; + + return ret; +} + +static int nct6694_wdt_set_pretimeout(struct watchdog_device *wdev, + unsigned int pretimeout) +{ + int ret; + + ret = nct6694_wdt_setting(wdev, wdev->timeout, NCT6694_ACTION_GPO, + pretimeout, NCT6694_ACTION_GPO); + if (ret) + return ret; + + wdev->pretimeout = pretimeout; + + return ret; +} + +static unsigned int nct6694_wdt_get_time(struct watchdog_device *wdev) +{ + struct nct6694_wdt_data *data = watchdog_get_drvdata(wdev); + struct nct6694_wdt_cmd0 *buf = (struct nct6694_wdt_cmd0 *)data->xmit_buf; + struct nct6694 *nct6694 = data->nct6694; + unsigned int timeleft_ms; + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(nct6694, NCT6694_WDT_MOD, + NCT6694_WDT_CMD0_OFFSET(data->wdev_idx), + NCT6694_WDT_CMD0_LEN, buf); + if (ret) + return ret; + + timeleft_ms = le32_to_cpu(buf->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->xmit_buf = devm_kcalloc(dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!data->xmit_buf) + 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; + wdev->min_timeout = 1; + wdev->max_timeout = 255; + + mutex_init(&data->lock); + + platform_set_drvdata(pdev, data); + + /* Register watchdog timer device to WDT framework */ + watchdog_set_drvdata(&data->wdev, data); + watchdog_init_timeout(&data->wdev, timeout, dev); + 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"); From patchwork Thu Nov 21 06:40:45 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844970 Received: from mail-pf1-f178.google.com (mail-pf1-f178.google.com [209.85.210.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 1485B1D042A; Thu, 21 Nov 2024 06:41:25 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.210.178 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171288; cv=none; b=I90JnUMnkV1hFSt0pdn0zfvVCKdOfjhfBdtKhx2BmKiJjid11Qw5gwNXdN9WzaKRB82mV+Wydoc+Zfjr0e70pZxCQTQt9z9elBUlvTk9yNhm/LsMeVIyzT39MKatsiMXgRUWtdggXdYhG2S+1XrE7fvqRwMDgOvZVw4NBBsQZxo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171288; c=relaxed/simple; bh=Y09MsOcz5N8twanN9PbHOUroV8Dkaa4xvJyyxIyGm4w=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=ACsLSEMLYvwz1/wUzs9BF4wkB2GaEL9F3ieF8O/TV4mZT2uAldssXXdK5DK4iYfgOQhIAiufoLIH5QxgZhyEZu/iJR4MS0lse75XoVGB8qSVX9Z8nySW5cSZBKdDZbyYcfCWkK/Doip+/7N0875RJC442S1WXANpD+sYUI6MOpQ= 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=Xk4K+e3h; arc=none smtp.client-ip=209.85.210.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="Xk4K+e3h" Received: by mail-pf1-f178.google.com with SMTP id d2e1a72fcca58-7240fa50694so534564b3a.1; Wed, 20 Nov 2024 22:41:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171285; x=1732776085; 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=gnPml4GDk6hNaNBzUXJnTs1TMG9m0w9bAhxENq0oaX8=; b=Xk4K+e3hDBNBt94TY+azdeZ4wXm+1GmOpXAxrjkwlULMQ6UgFfeSQ7OoVIhzqdtSVw SLvIHdDTtXzMjDI9lmPkhWAiRjZFIFd/Ya/Mn/SKwcQGhETta6qb39JKRrFuEbRkgWMr z78nAQEtmxZfFqCaW4DmFOLPEmvnwuVGrmjKpAjSJCyoXvA5+aLgxDZRAJbFyDgv03Jy Ep0lQR17xW3qpwwe12mhLXpnLs+XpPLQRx7mcl+0uwG8QUDp911NggZqOvF0/8datdXV W9DA/qcLsIEUQM726bNGifC4EFf6859+baY8uZfjkZwglSpGpP+LmYS1bUYClHFnDS4B EP/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171285; x=1732776085; 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=gnPml4GDk6hNaNBzUXJnTs1TMG9m0w9bAhxENq0oaX8=; b=NHkvvXhKiUkiQBgFYEbF6H7JZD7NvA1mAkN/8AeEN2YiD1iFx+1sFu+12TlF3PJuBM fi6ygmc4yVCMCspZlNVyeEHvhH9vndGWAIJcdC+iLSBXTpkRL1bSNEqmSlnIbCYQpKFm 0Uqs4fz8k6QFsowTy447WZs8pEB/lgLqp6ctczyNSVPZHSivK2En1qTadho59TjVMiMZ c3SqRjVL924cm4eOfZWvfFTO5olCfLS6TJCiCl5k6H8cX+dSe+ut/D8Qnzy8eiYbpI+O o83zGYKoufnzkMLqF7Fst/snTPK4RNV/cCKiwQ/L3rh77YoiIgE0M1zMJpEbT3L1Lb4I K+8w== X-Forwarded-Encrypted: i=1; AJvYcCUMkSeiIQWM1IuDvcy+OmblV7BdjOGzmurX5C5aZTumPJ3bLAqlWvLZMM6JJFOEk5B6e3NqmFO1u2ub@vger.kernel.org, AJvYcCURR/5XBWsXSSkcN6ZnbogXO8KnO63kPYT4Kbv7MOQ24DFrSaAi3SymTANabdGCQ6bLMhCPyyOR@vger.kernel.org, AJvYcCV7nQ2PQmot0W0D90e6HYLKrK4dgYsHfgvmUwU1qSRnlNeY8vH9nAaS9WV5t2pM0mF4BJuUlS0RLyUcBek=@vger.kernel.org, AJvYcCVP2OvrAdPdlGn8GovDvbzIC2jc1oISCPFsLk6aWpxFGxtKjwumYbZ+cTtgMRrl6A95IwLPfhydEz6gkg==@vger.kernel.org, AJvYcCVj0iPReScvz8DQJRryNqCFz5L0F7L5tdE9rFf7C7LVUgBghVMJVa1CBj3FsDAdcNHf1N30uqFqGDVJezRKj5c=@vger.kernel.org, AJvYcCWjzFRuOW+8/MBIFoMbFmH9xWvKOd4LVfSwgKg/ED5CAIm2g8NkLpHUMh8Mz9CAPiHBJvM5z3M8K5U=@vger.kernel.org, AJvYcCWyDIHm6IMk6V9sKsUNRB7emf9DE1Icb3uIHHArFItDc80cxdIMvJLfW9TUacdXKj7tN+OMrBUesTrG@vger.kernel.org X-Gm-Message-State: AOJu0YzOho/DhdqjXbJRzZiK+dOUg42+8s4U9tBHW44Elzks41DRAf1y jBG/wp1gxwGNg+M5jqlxFt4a8X8ZjsA5M36ecMqJCmUYqHgYyWdP X-Google-Smtp-Source: AGHT+IG8Fdb2YHTSefimQ0ER5THBYqNERK9PbK2GVaDkK4875tHx2p3fh5yqUpLWJzyiPaJpeOI5fg== X-Received: by 2002:a05:6a00:852:b0:71e:6c3f:2fb6 with SMTP id d2e1a72fcca58-724beca4215mr8245617b3a.8.1732171285078; Wed, 20 Nov 2024 22:41:25 -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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.21 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:24 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 6/7] hwmon: Add Nuvoton NCT6694 HWMON support Date: Thu, 21 Nov 2024 14:40:45 +0800 Message-Id: <20241121064046.3724726-7-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 This driver supports Hardware monitor functionality for NCT6694 MFD device based on USB interface. Signed-off-by: Ming Yu --- MAINTAINERS | 1 + drivers/hwmon/Kconfig | 10 + drivers/hwmon/Makefile | 1 + drivers/hwmon/nct6694-hwmon.c | 771 ++++++++++++++++++++++++++++++++++ 4 files changed, 783 insertions(+) create mode 100644 drivers/hwmon/nct6694-hwmon.c diff --git a/MAINTAINERS b/MAINTAINERS index 496fe7d5a23f..d6414eea0463 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16546,6 +16546,7 @@ M: Ming Yu L: linux-kernel@vger.kernel.org S: Supported F: drivers/gpio/gpio-nct6694.c +F: drivers/hwmon/nct6694-hwmon.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: drivers/net/can/nct6694_canfd.c diff --git a/drivers/hwmon/Kconfig b/drivers/hwmon/Kconfig index dd376602f3f1..df40986424bd 100644 --- a/drivers/hwmon/Kconfig +++ b/drivers/hwmon/Kconfig @@ -1636,6 +1636,16 @@ config SENSORS_NCT6683 This driver can also be built as a module. If so, the module will be called nct6683. +config SENSORS_NCT6694 + tristate "Nuvoton NCT6694 Hardware Monitor support" + depends on MFD_NCT6694 + help + Say Y here to support Nuvoton NCT6694 hardware monitoring + functionality. + + This driver can also be built as a module. If so, the module + will be called nct6694-hwmon. + config SENSORS_NCT6775_CORE tristate select REGMAP diff --git a/drivers/hwmon/Makefile b/drivers/hwmon/Makefile index b827b92f2a78..27a43e67cdb7 100644 --- a/drivers/hwmon/Makefile +++ b/drivers/hwmon/Makefile @@ -168,6 +168,7 @@ obj-$(CONFIG_SENSORS_MLXREG_FAN) += mlxreg-fan.o obj-$(CONFIG_SENSORS_MENF21BMC_HWMON) += menf21bmc_hwmon.o obj-$(CONFIG_SENSORS_MR75203) += mr75203.o obj-$(CONFIG_SENSORS_NCT6683) += nct6683.o +obj-$(CONFIG_SENSORS_NCT6694) += nct6694-hwmon.o obj-$(CONFIG_SENSORS_NCT6775_CORE) += nct6775-core.o nct6775-objs := nct6775-platform.o obj-$(CONFIG_SENSORS_NCT6775) += nct6775.o diff --git a/drivers/hwmon/nct6694-hwmon.c b/drivers/hwmon/nct6694-hwmon.c new file mode 100644 index 000000000000..f24cc22b8b42 --- /dev/null +++ b/drivers/hwmon/nct6694-hwmon.c @@ -0,0 +1,771 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Nuvoton NCT6694 HWMON driver based on USB interface. + * + * Copyright (C) 2024 Nuvoton Technology Corp. + */ + +#include +#include +#include +#include +#include +#include +#include + +/* Host interface */ +#define NCT6694_RPT_MOD 0xFF +#define NCT6694_HWMON_MOD 0x00 +#define NCT6694_PWM_MOD 0x01 + +/* Report Channel */ +#define NCT6694_VIN_IDX(x) (0x00 + (x)) +#define NCT6694_TIN_IDX(x) \ + ({ typeof(x) (_x) = (x); \ + ((_x) < 10) ? (0x10 + ((_x) * 2)) : \ + (0x30 + (((_x) - 10) * 2)); }) +#define NCT6694_FIN_IDX(x) (0x50 + ((x) * 2)) +#define NCT6694_PWM_IDX(x) (0x70 + (x)) +#define NCT6694_VIN_STS(x) (0x68 + (x)) +#define NCT6694_TIN_STS(x) (0x6A + (x)) +#define NCT6694_FIN_STS(x) (0x6E + (x)) + +/* Message Channel*/ +/* HWMON Command */ +/* Command 00h */ +#define NCT6694_HWMON_CMD0_LEN 0x40 +#define NCT6694_HWMON_CMD0_OFFSET 0x0000 /* OFFSET = SEL|CMD */ +#define NCT6694_VIN_EN(x) (0x00 + (x)) +#define NCT6694_TIN_EN(x) (0x02 + (x)) +#define NCT6694_FIN_EN(x) (0x04 + (x)) +#define NCT6694_PWM_EN(x) (0x06 + (x)) +#define NCT6694_PWM_FREQ_IDX(x) (0x30 + (x)) +/* Command 02h */ +#define NCT6694_HWMON_CMD2_LEN 0x90 +#define NCT6694_HWMON_CMD2_OFFSET 0x0002 /* OFFSET = SEL|CMD */ +#define NCT6694_SMI_CTRL_IDX 0x00 +#define NCT6694_VIN_HL(x) (0x10 + ((x) * 2)) +#define NCT6694_VIN_LL(x) (0x11 + ((x) * 2)) +#define NCT6694_TIN_HYST(x) (0x30 + ((x) * 2)) +#define NCT6694_TIN_HL(x) (0x31 + ((x) * 2)) +#define NCT6694_FIN_HL(x) (0x70 + ((x) * 2)) +#define NCT6694_FIN_LL(x) (0x71 + ((x) * 2)) +/* PWM Command */ +#define NCT6694_PWM_CMD1_LEN 0x18 +#define NCT6694_PWM_CMD1_OFFSET 0x0001 +#define NCT6694_MAL_VAL(x) (0x02 + (x)) + +#define NCT6694_FREQ_FROM_REG(reg) ((reg) * 25000 / 255) +#define NCT6694_FREQ_TO_REG(val) \ + (DIV_ROUND_CLOSEST(clamp_val((val), 100, 25000) * 255, 25000)) + +#define NCT6694_LSB_REG_MASK GENMASK(7, 5) +#define NCT6694_TIN_HYST_MASK GENMASK(7, 5) + +static inline long in_from_reg(u8 reg) +{ + return reg * 16; +} + +static inline u8 in_to_reg(long val) +{ + if (val <= 0) + return 0; + return val / 16; +} + +static inline long temp_from_reg(u8 reg) +{ + return reg * 1000; +} + +static inline u8 temp_to_reg(long val) +{ + return val / 1000; +} + +struct nct6694_hwmon_data { + struct nct6694 *nct6694; + struct mutex lock; + unsigned char *xmit_buf; + unsigned char hwmon_en[NCT6694_HWMON_CMD0_LEN]; +}; + +#define NCT6694_HWMON_IN_CONFIG (HWMON_I_INPUT | HWMON_I_ENABLE | \ + HWMON_I_MAX | HWMON_I_MIN | \ + HWMON_I_ALARM) +#define NCT6694_HWMON_TEMP_CONFIG (HWMON_T_INPUT | HWMON_T_ENABLE | \ + HWMON_T_MAX | HWMON_T_MAX_HYST | \ + HWMON_T_MAX_ALARM) +#define NCT6694_HWMON_FAN_CONFIG (HWMON_F_INPUT | HWMON_F_ENABLE | \ + HWMON_F_MIN | HWMON_F_MIN_ALARM) +#define NCT6694_HWMON_PWM_CONFIG (HWMON_PWM_INPUT | HWMON_PWM_ENABLE | \ + HWMON_PWM_FREQ) +static const struct hwmon_channel_info *nct6694_info[] = { + HWMON_CHANNEL_INFO(in, + NCT6694_HWMON_IN_CONFIG, /* VIN0 */ + NCT6694_HWMON_IN_CONFIG, /* VIN1 */ + NCT6694_HWMON_IN_CONFIG, /* VIN2 */ + NCT6694_HWMON_IN_CONFIG, /* VIN3 */ + NCT6694_HWMON_IN_CONFIG, /* VIN5 */ + NCT6694_HWMON_IN_CONFIG, /* VIN6 */ + NCT6694_HWMON_IN_CONFIG, /* VIN7 */ + NCT6694_HWMON_IN_CONFIG, /* VIN14 */ + NCT6694_HWMON_IN_CONFIG, /* VIN15 */ + NCT6694_HWMON_IN_CONFIG, /* VIN16 */ + NCT6694_HWMON_IN_CONFIG, /* VBAT */ + NCT6694_HWMON_IN_CONFIG, /* VSB */ + NCT6694_HWMON_IN_CONFIG, /* AVSB */ + NCT6694_HWMON_IN_CONFIG, /* VCC */ + NCT6694_HWMON_IN_CONFIG, /* VHIF */ + NCT6694_HWMON_IN_CONFIG), /* VTT */ + + HWMON_CHANNEL_INFO(temp, + NCT6694_HWMON_TEMP_CONFIG, /* THR1 */ + NCT6694_HWMON_TEMP_CONFIG, /* THR2 */ + NCT6694_HWMON_TEMP_CONFIG, /* THR14 */ + NCT6694_HWMON_TEMP_CONFIG, /* THR15 */ + NCT6694_HWMON_TEMP_CONFIG, /* THR16 */ + NCT6694_HWMON_TEMP_CONFIG, /* TDP0 */ + NCT6694_HWMON_TEMP_CONFIG, /* TDP1 */ + NCT6694_HWMON_TEMP_CONFIG, /* TDP2 */ + NCT6694_HWMON_TEMP_CONFIG, /* TDP3 */ + NCT6694_HWMON_TEMP_CONFIG, /* TDP4 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN0 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN1 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN2 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN3 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN4 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN5 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN6 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN7 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN8 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN9 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN10 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN11 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN12 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN13 */ + NCT6694_HWMON_TEMP_CONFIG, /* DTIN14 */ + NCT6694_HWMON_TEMP_CONFIG), /* DTIN15 */ + + HWMON_CHANNEL_INFO(fan, + NCT6694_HWMON_FAN_CONFIG, /* FIN0 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN1 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN2 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN3 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN4 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN5 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN6 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN7 */ + NCT6694_HWMON_FAN_CONFIG, /* FIN8 */ + NCT6694_HWMON_FAN_CONFIG), /* FIN9 */ + + HWMON_CHANNEL_INFO(pwm, + NCT6694_HWMON_PWM_CONFIG, /* PWM0 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM1 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM2 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM3 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM4 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM5 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM6 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM7 */ + NCT6694_HWMON_PWM_CONFIG, /* PWM8 */ + NCT6694_HWMON_PWM_CONFIG), /* PWM9 */ + NULL +}; + +static int nct6694_in_read(struct device *dev, u32 attr, int channel, + long *val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + unsigned char vin_en; + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_in_enable: + vin_en = data->hwmon_en[NCT6694_VIN_EN(channel / 8)]; + *val = vin_en & BIT(channel % 8) ? 1 : 0; + + return 0; + case hwmon_in_input: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_VIN_IDX(channel), 1, + data->xmit_buf); + if (ret) + return ret; + + *val = in_from_reg(data->xmit_buf[0]); + + return 0; + case hwmon_in_max: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + *val = in_from_reg(data->xmit_buf[NCT6694_VIN_HL(channel)]); + + return 0; + case hwmon_in_min: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + *val = in_from_reg(data->xmit_buf[NCT6694_VIN_LL(channel)]); + + return 0; + case hwmon_in_alarm: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_VIN_STS(channel / 8), 1, + data->xmit_buf); + if (ret) + return ret; + + *val = !!(data->xmit_buf[0] & BIT(channel % 8)); + + return 0; + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_temp_read(struct device *dev, u32 attr, int channel, + long *val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + unsigned char temp_en, temp_hyst; + int ret, int_part, frac_part; + signed char temp_max; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_temp_enable: + temp_en = data->hwmon_en[NCT6694_TIN_EN(channel / 8)]; + *val = temp_en & BIT(channel % 8) ? 1 : 0; + + return 0; + case hwmon_temp_input: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_TIN_IDX(channel), 2, + data->xmit_buf); + if (ret) + return ret; + + int_part = sign_extend32(data->xmit_buf[0], 7); + frac_part = FIELD_GET(NCT6694_LSB_REG_MASK, data->xmit_buf[1]); + if (int_part < 0) + *val = (int_part + 1) * 1000 - (8 - frac_part) * 125; + else + *val = int_part * 1000 + frac_part * 125; + + return 0; + case hwmon_temp_max: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + *val = temp_from_reg(data->xmit_buf[NCT6694_TIN_HL(channel)]); + + return 0; + case hwmon_temp_max_hyst: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + temp_max = (signed char)data->xmit_buf[NCT6694_TIN_HL(channel)]; + temp_hyst = FIELD_GET(NCT6694_TIN_HYST_MASK, + data->xmit_buf[NCT6694_TIN_HYST(channel)]); + if (temp_max < 0) + *val = temp_from_reg(temp_max + temp_hyst); + else + *val = temp_from_reg(temp_max - temp_hyst); + + return 0; + case hwmon_temp_max_alarm: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_TIN_STS(channel / 8), 1, + data->xmit_buf); + if (ret) + return ret; + + *val = !!(data->xmit_buf[0] & BIT(channel % 8)); + + return 0; + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_fan_read(struct device *dev, u32 attr, int channel, + long *val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + unsigned char fanin_en; + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_fan_enable: + fanin_en = data->hwmon_en[NCT6694_FIN_EN(channel / 8)]; + *val = fanin_en & BIT(channel % 8) ? 1 : 0; + + return 0; + case hwmon_fan_input: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_FIN_IDX(channel), 2, + data->xmit_buf); + if (ret) + return ret; + + *val = (data->xmit_buf[1] | + (data->xmit_buf[0] << 8)) & 0xFFFF; + + return 0; + case hwmon_fan_min: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + *val = (data->xmit_buf[NCT6694_FIN_LL(channel)] | + data->xmit_buf[NCT6694_FIN_HL(channel)] << 8) & 0xFFFF; + + return 0; + case hwmon_fan_min_alarm: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_FIN_STS(channel / 8), + 1, data->xmit_buf); + if (ret) + return ret; + + *val = data->xmit_buf[0] & BIT(channel % 8); + + return 0; + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_pwm_read(struct device *dev, u32 attr, int channel, + long *val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + unsigned char pwm_en; + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_pwm_enable: + pwm_en = data->hwmon_en[NCT6694_PWM_EN(channel / 8)]; + *val = pwm_en & BIT(channel % 8) ? 1 : 0; + + return 0; + case hwmon_pwm_input: + ret = nct6694_read_msg(data->nct6694, NCT6694_RPT_MOD, + NCT6694_PWM_IDX(channel), + 1, data->xmit_buf); + if (ret) + return ret; + + *val = data->xmit_buf[0]; + + return 0; + case hwmon_pwm_freq: + *val = NCT6694_FREQ_FROM_REG(data->hwmon_en[NCT6694_PWM_FREQ_IDX(channel)]); + + return 0; + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_enable_channel(struct device *dev, u8 reg, + int channel, long val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + + if (val == 0) + data->hwmon_en[reg] &= ~BIT(channel % 8); + else if (val == 1) + data->hwmon_en[reg] |= BIT(channel % 8); + else + return -EINVAL; + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD0_OFFSET, + NCT6694_HWMON_CMD0_LEN, + data->hwmon_en); +} + +static int nct6694_in_write(struct device *dev, u32 attr, int channel, + long val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_in_enable: + return nct6694_enable_channel(dev, NCT6694_VIN_EN(channel / 8), + channel, val); + case hwmon_in_max: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + val = clamp_val(val, 0, 2032); + data->xmit_buf[NCT6694_VIN_HL(channel)] = in_to_reg(val); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + case hwmon_in_min: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + val = clamp_val(val, 0, 2032); + data->xmit_buf[NCT6694_VIN_LL(channel)] = in_to_reg(val); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_temp_write(struct device *dev, u32 attr, int channel, + long val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + signed char temp_max, temp_hyst; + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_temp_enable: + return nct6694_enable_channel(dev, NCT6694_TIN_EN(channel / 8), + channel, val); + case hwmon_temp_max: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + val = clamp_val(val, -127000, 127000); + data->xmit_buf[NCT6694_TIN_HL(channel)] = temp_to_reg(val); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + case hwmon_temp_max_hyst: + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + + val = clamp_val(val, -127000, 127000); + temp_max = (signed char)data->xmit_buf[NCT6694_TIN_HL(channel)]; + temp_hyst = (temp_max < 0) ? (temp_max + val / 1000) : + (temp_max - val / 1000); + if (temp_hyst < 0 || temp_hyst > 7) + return -EINVAL; + + data->xmit_buf[NCT6694_TIN_HYST(channel)] = + (data->xmit_buf[NCT6694_TIN_HYST(channel)] & ~NCT6694_TIN_HYST_MASK) | + FIELD_PREP(NCT6694_TIN_HYST_MASK, temp_hyst); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_fan_write(struct device *dev, u32 attr, int channel, + long val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_fan_enable: + return nct6694_enable_channel(dev, NCT6694_FIN_EN(channel / 8), + channel, val); + case hwmon_fan_min: + if (val <= 0) + return -EINVAL; + + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + val = clamp_val(val, 1, 65535); + data->xmit_buf[NCT6694_FIN_HL(channel)] = (u8)((val >> 8) & 0xFF); + data->xmit_buf[NCT6694_FIN_LL(channel)] = (u8)(val & 0xFF); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_pwm_write(struct device *dev, u32 attr, int channel, + long val) +{ + struct nct6694_hwmon_data *data = dev_get_drvdata(dev); + int ret; + + guard(mutex)(&data->lock); + + switch (attr) { + case hwmon_pwm_enable: + return nct6694_enable_channel(dev, NCT6694_PWM_EN(channel / 8), + channel, val); + case hwmon_pwm_input: + if (val < 0 || val > 255) + return -EINVAL; + + ret = nct6694_read_msg(data->nct6694, NCT6694_PWM_MOD, + NCT6694_PWM_CMD1_OFFSET, + NCT6694_PWM_CMD1_LEN, + data->xmit_buf); + if (ret) + return ret; + + data->xmit_buf[NCT6694_MAL_VAL(channel)] = val; + + return nct6694_write_msg(data->nct6694, NCT6694_PWM_MOD, + NCT6694_PWM_CMD1_OFFSET, + NCT6694_PWM_CMD1_LEN, + data->xmit_buf); + case hwmon_pwm_freq: + data->hwmon_en[NCT6694_PWM_FREQ_IDX(channel)] = NCT6694_FREQ_TO_REG(val); + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD0_OFFSET, + NCT6694_HWMON_CMD0_LEN, + data->hwmon_en); + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_read(struct device *dev, enum hwmon_sensor_types type, + u32 attr, int channel, long *val) +{ + switch (type) { + case hwmon_in: /* in mV */ + return nct6694_in_read(dev, attr, channel, val); + case hwmon_temp:/* in mC */ + return nct6694_temp_read(dev, attr, channel, val); + case hwmon_fan: /* in RPM */ + return nct6694_fan_read(dev, attr, channel, val); + case hwmon_pwm: /* in value 0~255 */ + return nct6694_pwm_read(dev, attr, channel, val); + default: + return -EOPNOTSUPP; + } +} + +static int nct6694_write(struct device *dev, enum hwmon_sensor_types type, + u32 attr, int channel, long val) +{ + switch (type) { + case hwmon_in: + return nct6694_in_write(dev, attr, channel, val); + case hwmon_temp: + return nct6694_temp_write(dev, attr, channel, val); + case hwmon_fan: + return nct6694_fan_write(dev, attr, channel, val); + case hwmon_pwm: + return nct6694_pwm_write(dev, attr, channel, val); + default: + return -EOPNOTSUPP; + } +} + +static umode_t nct6694_is_visible(const void *data, + enum hwmon_sensor_types type, + u32 attr, int channel) +{ + switch (type) { + case hwmon_in: + switch (attr) { + case hwmon_in_enable: + case hwmon_in_max: + case hwmon_in_min: + return 0644; + case hwmon_in_alarm: + case hwmon_in_input: + return 0444; + default: + return 0; + } + case hwmon_temp: + switch (attr) { + case hwmon_temp_enable: + case hwmon_temp_max: + case hwmon_temp_max_hyst: + return 0644; + case hwmon_temp_input: + case hwmon_temp_max_alarm: + return 0444; + default: + return 0; + } + case hwmon_fan: + switch (attr) { + case hwmon_fan_enable: + case hwmon_fan_min: + return 0644; + case hwmon_fan_input: + case hwmon_fan_min_alarm: + return 0444; + default: + return 0; + } + case hwmon_pwm: + switch (attr) { + case hwmon_pwm_enable: + case hwmon_pwm_freq: + case hwmon_pwm_input: + return 0644; + default: + return 0; + } + default: + return 0; + } +} + +static const struct hwmon_ops nct6694_hwmon_ops = { + .is_visible = nct6694_is_visible, + .read = nct6694_read, + .write = nct6694_write, +}; + +static const struct hwmon_chip_info nct6694_chip_info = { + .ops = &nct6694_hwmon_ops, + .info = nct6694_info, +}; + +static int nct6694_hwmon_init(struct nct6694_hwmon_data *data) +{ + int ret; + + guard(mutex)(&data->lock); + + /* + * Record each Hardware Monitor Channel enable status + * and PWM frequency register + */ + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD0_OFFSET, + NCT6694_HWMON_CMD0_LEN, + data->hwmon_en); + if (ret) + return ret; + + /* Set Fan input Real Time alarm mode */ + ret = nct6694_read_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); + if (ret) + return ret; + + data->xmit_buf[NCT6694_SMI_CTRL_IDX] = 0x02; + + return nct6694_write_msg(data->nct6694, NCT6694_HWMON_MOD, + NCT6694_HWMON_CMD2_OFFSET, + NCT6694_HWMON_CMD2_LEN, + data->xmit_buf); +} + +static int nct6694_hwmon_probe(struct platform_device *pdev) +{ + struct nct6694_hwmon_data *data; + struct nct6694 *nct6694 = dev_get_drvdata(pdev->dev.parent); + struct device *hwmon_dev; + int ret; + + data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->xmit_buf = devm_kcalloc(&pdev->dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!data->xmit_buf) + return -ENOMEM; + + data->nct6694 = nct6694; + mutex_init(&data->lock); + platform_set_drvdata(pdev, data); + + ret = nct6694_hwmon_init(data); + if (ret) + return ret; + + /* Register hwmon device to HWMON framework */ + hwmon_dev = devm_hwmon_device_register_with_info(&pdev->dev, + "nct6694", data, + &nct6694_chip_info, + NULL); + return PTR_ERR_OR_ZERO(hwmon_dev); +} + +static struct platform_driver nct6694_hwmon_driver = { + .driver = { + .name = "nct6694-hwmon", + }, + .probe = nct6694_hwmon_probe, +}; + +module_platform_driver(nct6694_hwmon_driver); + +MODULE_DESCRIPTION("USB-HWMON driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL"); From patchwork Thu Nov 21 06:40:46 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ming Yu X-Patchwork-Id: 844782 Received: from mail-pg1-f178.google.com (mail-pg1-f178.google.com [209.85.215.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 A3C411C9DDF; Thu, 21 Nov 2024 06:41:29 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.215.178 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171291; cv=none; b=jxb241lKjnHfk3jhbyEQZT9hMbqoK0W5YGS/HI2BI315ccMEtKW4c1iqUhQajZ4L6zLoaTB38UN2ZdQNi+Z9+yLNcIElkl18F1C9NgKd1kNXb0Ajm3hHKUmYM+LFPSnNKITnl+oaYn7NYaOKyN1AVmOZEENNaHYvj/jVqtJM9oQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1732171291; c=relaxed/simple; bh=VM3tcKTrNIKtcWEiY3g5a2hzNV1pFWStN+suLtgL4zk=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version; b=gfbbdo2CgpGJ5hWx1PuwT3nb6Gd2hLKHI7gd/6+H3zUpKewUU5FDdevEFOYEzBge1H3Ten+0xKFkjmZioOo6KvtRXWNrVjn57Mc6rvxtJOuuCz3g38fHNm0ywwKTFrrM7S5YRNqXVrfsZ1xf3q2HG4F3hVVbeUIF8zLerdMovv4= 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=O2EyV406; arc=none smtp.client-ip=209.85.215.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="O2EyV406" Received: by mail-pg1-f178.google.com with SMTP id 41be03b00d2f7-7ea7e250c54so503810a12.0; Wed, 20 Nov 2024 22:41:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1732171289; x=1732776089; 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=PFrCg7m8aamOuaiYkktMUCP7hs/Ab5XF+r6SW6zPgUM=; b=O2EyV406jEwEvwF7Usb9d9/obwzVK78ilyxlOFweCzku6k/ej/5vYa3iYecsg/Fp/l o2wMOhBJRGV5GA+6Q2TqIIQrmdTl6Mf6llDofB95B705d7UUFeBocVrYFpv0+fYH/XWy RydZSdQh/6ASAZTAbdtubP8w5pAsdJrmUJwHyqKisFQrbzaHODQB6cLgkjKHR5/8Y6VS l6AQjp7yI/x3IHLr3Pz3Ea98fqvT1Mt/pZLkes7VDXxBAzYvQ0YzUnjxrPwQKjvme8D4 EEbXcuKjPGGzBy++8J9Jb7yimqskmesPzhfOXsXZwquuby9X0k6mn9O9cb8chmA5Dsrj mR2Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1732171289; x=1732776089; 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=PFrCg7m8aamOuaiYkktMUCP7hs/Ab5XF+r6SW6zPgUM=; b=tMHMCQwIe34NrDCR1KxoFJbBMSlF/+Ta+SH4NHy6pp2/3C8LIGs3Fcuzxrs5O7g/gl 2/WGdoTQXg0AX5MxhQO1NqgeqIwUtooOkSbkiRTLUEvozGVzpkNsXGx1bwqm+eQl9k6k bNfG5tW+5zZAD49G/5KhhmdQvaS2orYciAEsF9QzITtJbT4FajBLWUu+7964p9KRY31U xSu9yrTPIjKiDPPCg3BBGDSrxwlrY7LCiHvvM+eiNh1g9opNcgECSV8C0bH9wQnptkBK t+qW7rX0PXpnSYJL3sVkcR0OUW+fb1LJwNiu2imVn9+f96PTpflnsXU/xaX2tnv4EEGJ bQuQ== X-Forwarded-Encrypted: i=1; AJvYcCUmNwaMxgg82qxwQU0VZKq1OuvMnGvRwYz9M2ogQGWxFKmG5Ir5bUyQ+CFL6DJqwhtjO1694J71@vger.kernel.org, AJvYcCUqYeLJOzJNXeUQckqP0+1F+puRytpIMIVhZnBSNw5uouZ50i2zK3eLcumUcq01Yf+6AWwwve0GgjS0FsaZVso=@vger.kernel.org, AJvYcCVWTNWca7G0VBjMaWg21gTat7Jl/T/w/+59b0PYNz/HHgntLWomoQJCBKXradp5EcDC2LSyVLKWCK4kfXw=@vger.kernel.org, AJvYcCWEkUHSsu1tHoMul7Ef6BEWuD15WhZnaFrp6tkAwwQYCPNrRcDa7mqqEjPFaJBFo0YAUyF51BOe+9Y0kw==@vger.kernel.org, AJvYcCWg2hM/KjVEsdI0A9/WiLv0UJ6P8MdcgUUpfgIszGa45/uxc8OKPvDaCb0SM/MbsyNR7GXA+Rri0gxe@vger.kernel.org, AJvYcCWvKKQ3Zs84ZnvREMM4QleAHuLGOy9dzkH85prYewbVxfyLBuLWIU41UZipIxpHOagV4LBAxJQ+Xf0=@vger.kernel.org, AJvYcCX0Azd29oc/D5DAEg9L/XVSHkYK2zE5OgUzQ5voPC4iT1+BUP4OlTT/rGtD6NY6d1vVh/REbpIvm5Hi@vger.kernel.org X-Gm-Message-State: AOJu0YxzsBRI0c4/LtzwK8JcUDu2KNE0uSx1GyiSlJFcFfMYCddjTvmr taoN/HVHhUWtOzSQnt4JI64+NkPXiOv01bLTMHJhKobkzuYJzQ9t X-Google-Smtp-Source: AGHT+IHiQw2caxTW3sY1YGKi/DVCIIlxVF7EDTea2/gtWdN97dJp29cPAa2mIse1tA0QInWOyJMgbA== X-Received: by 2002:a05:6a20:841c:b0:1db:c20f:2c4d with SMTP id adf61e73a8af0-1ddae2f0277mr8333238637.2.1732171288857; Wed, 20 Nov 2024 22:41:28 -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-724beeb83d4sm2812530b3a.40.2024.11.20.22.41.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Nov 2024 22:41:28 -0800 (PST) From: Ming Yu X-Google-Original-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 Subject: [PATCH v2 7/7] rtc: Add Nuvoton NCT6694 RTC support Date: Thu, 21 Nov 2024 14:40:46 +0800 Message-Id: <20241121064046.3724726-8-tmyu0@nuvoton.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20241121064046.3724726-1-tmyu0@nuvoton.com> References: <20241121064046.3724726-1-tmyu0@nuvoton.com> Precedence: bulk X-Mailing-List: linux-gpio@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 | 263 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 275 insertions(+) create mode 100644 drivers/rtc/rtc-nct6694.c diff --git a/MAINTAINERS b/MAINTAINERS index d6414eea0463..6d1cfec28076 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -16550,6 +16550,7 @@ F: drivers/hwmon/nct6694-hwmon.c F: drivers/i2c/busses/i2c-nct6694.c F: drivers/mfd/nct6694.c F: drivers/net/can/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 66eb1122248b..36829d096194 100644 --- a/drivers/rtc/Kconfig +++ b/drivers/rtc/Kconfig @@ -406,6 +406,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 f62340ecc534..64443d26bb5b 100644 --- a/drivers/rtc/Makefile +++ b/drivers/rtc/Makefile @@ -116,6 +116,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..097555a16b4f --- /dev/null +++ b/drivers/rtc/rtc-nct6694.c @@ -0,0 +1,263 @@ +// 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 + +/* Host interface */ +#define NCT6694_RTC_MOD 0x08 + +/* Message Channel */ +/* Command 00h */ +#define NCT6694_RTC_CMD0_LEN 0x07 +#define NCT6694_RTC_CMD0_OFFSET 0x0000 /* OFFSET = SEL|CMD */ +/* Command 01h */ +#define NCT6694_RTC_CMD1_LEN 0x05 +#define NCT6694_RTC_CMD1_OFFSET 0x0001 /* OFFSET = SEL|CMD */ +/* Command 02h */ +#define NCT6694_RTC_CMD2_LEN 0x02 +#define NCT6694_RTC_CMD2_OFFSET 0x0002 /* OFFSET = SEL|CMD */ + +#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_cmd0 { + u8 sec; + u8 min; + u8 hour; + u8 week; + u8 day; + u8 month; + u8 year; +}; + +struct __packed nct6694_rtc_cmd1 { + u8 sec; + u8 min; + u8 hour; + u8 alarm_en; + u8 alarm_pend; +}; + +struct __packed nct6694_rtc_cmd2 { + u8 irq_en; + u8 irq_pend; +}; + +struct nct6694_rtc_data { + struct nct6694 *nct6694; + struct rtc_device *rtc; + struct mutex lock; + unsigned char *xmit_buf; +}; + +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_cmd0 *buf = (struct nct6694_rtc_cmd0 *)data->xmit_buf; + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD0_OFFSET, + NCT6694_RTC_CMD0_LEN, + buf); + if (ret) + return ret; + + tm->tm_sec = bcd2bin(buf->sec); /* tm_sec expect 0 ~ 59 */ + tm->tm_min = bcd2bin(buf->min); /* tm_min expect 0 ~ 59 */ + tm->tm_hour = bcd2bin(buf->hour); /* tm_hour expect 0 ~ 23 */ + tm->tm_wday = bcd2bin(buf->week) - 1; /* tm_wday expect 0 ~ 6 */ + tm->tm_mday = bcd2bin(buf->day); /* tm_mday expect 1 ~ 31 */ + tm->tm_mon = bcd2bin(buf->month) - 1; /* tm_month expect 0 ~ 11 */ + tm->tm_year = bcd2bin(buf->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_cmd0 *buf = (struct nct6694_rtc_cmd0 *)data->xmit_buf; + + guard(mutex)(&data->lock); + + buf->sec = bin2bcd(tm->tm_sec); + buf->min = bin2bcd(tm->tm_min); + buf->hour = bin2bcd(tm->tm_hour); + buf->week = bin2bcd(tm->tm_wday + 1); + buf->day = bin2bcd(tm->tm_mday); + buf->month = bin2bcd(tm->tm_mon + 1); + buf->year = bin2bcd(tm->tm_year - 100); + + return nct6694_write_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD0_OFFSET, + NCT6694_RTC_CMD0_LEN, + buf); +} + +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_cmd1 *buf = (struct nct6694_rtc_cmd1 *)data->xmit_buf; + int ret; + + guard(mutex)(&data->lock); + + ret = nct6694_read_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD1_OFFSET, + NCT6694_RTC_CMD1_LEN, + buf); + if (ret) + return ret; + + alrm->time.tm_sec = bcd2bin(buf->sec); + alrm->time.tm_min = bcd2bin(buf->min); + alrm->time.tm_hour = bcd2bin(buf->hour); + alrm->enabled = buf->alarm_en; + alrm->pending = buf->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_cmd1 *buf = (struct nct6694_rtc_cmd1 *)data->xmit_buf; + + guard(mutex)(&data->lock); + + buf->sec = bin2bcd(alrm->time.tm_sec); + buf->min = bin2bcd(alrm->time.tm_min); + buf->hour = bin2bcd(alrm->time.tm_hour); + buf->alarm_en = alrm->enabled ? NCT6694_RTC_IRQ_EN : 0; + buf->alarm_pend = 0; + + return nct6694_write_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD1_OFFSET, + NCT6694_RTC_CMD1_LEN, + buf); +} + +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_cmd2 *buf = (struct nct6694_rtc_cmd2 *)data->xmit_buf; + + guard(mutex)(&data->lock); + + if (enabled) + buf->irq_en |= NCT6694_RTC_IRQ_EN; + else + buf->irq_en &= ~NCT6694_RTC_IRQ_EN; + + buf->irq_pend = 0; + + return nct6694_write_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD2_OFFSET, + NCT6694_RTC_CMD2_LEN, + buf); +} + +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_cmd2 *buf = (struct nct6694_rtc_cmd2 *)data->xmit_buf; + int ret; + + guard(mutex)(&data->lock); + + buf->irq_en = NCT6694_RTC_IRQ_EN; + buf->irq_pend = NCT6694_RTC_IRQ_STS; + ret = nct6694_write_msg(data->nct6694, NCT6694_RTC_MOD, + NCT6694_RTC_CMD2_OFFSET, + NCT6694_RTC_CMD2_LEN, + buf); + if (ret) + return IRQ_NONE; + + rtc_update_irq(data->rtc, 1, RTC_IRQF | RTC_AF); + + 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->xmit_buf = devm_kcalloc(&pdev->dev, NCT6694_MAX_PACKET_SZ, + sizeof(unsigned char), GFP_KERNEL); + if (!data->xmit_buf) + 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; + + mutex_init(&data->lock); + + device_set_wakeup_capable(&pdev->dev, 1); + + platform_set_drvdata(pdev, data); + + ret = devm_request_threaded_irq(&pdev->dev, irq, NULL, + nct6694_irq, IRQF_ONESHOT, + "nct6694-rtc", data); + if (ret < 0) + return dev_err_probe(&pdev->dev, ret, "Failed to request irq\n"); + + /* Register rtc device to RTC framework */ + return devm_rtc_register_device(data->rtc); +} + +static struct platform_driver nct6694_rtc_driver = { + .driver = { + .name = "nct6694-rtc", + }, + .probe = nct6694_rtc_probe, +}; + +module_platform_driver(nct6694_rtc_driver); + +MODULE_DESCRIPTION("USB-RTC driver for NCT6694"); +MODULE_AUTHOR("Ming Yu "); +MODULE_LICENSE("GPL");