From nobody Thu Dec 18 01:37:51 2025 Received: from mail-wm1-f41.google.com (mail-wm1-f41.google.com [209.85.128.41]) (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 34DFD1EF38E; Sun, 1 Jun 2025 15:30:34 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.41 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748791837; cv=none; b=Fdd5Ka4DINX6HRwpoWpw6vIGvwWSHdhW0xxmUTr7ehgX5nebU0Fizmxkkfy8LY61ZaWcGTX/fOhcpo0Bl2TvxU55TdDOzW1HvAeod7fKhk3kJoLcItVdYPTWYDZhHVRPeZu5lwSYVoZDjz2pTdHKibamkamRnXlWcDixewsCJUo= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748791837; c=relaxed/simple; bh=vliKAtpu5qiC6NZhT4uUbvrt0sGBUZJEpdWF/X+qL4Q=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ipHCMMjSpy37AsQZKa85SX/L8xc0KhLglBCIDGZBIwJDUJbWE5OxsBwN3esXUgXmAdMOUVDx+v0zi9hF6BHkEwKSmfKJIkuufrMn2WliZFam6K0KsWPzmKAU3d2JsLSwvDovDlf8G+1icbiGzmZw1hWPEqyxyLhabdQO3AAPHws= 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=i/7w+9HA; arc=none smtp.client-ip=209.85.128.41 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="i/7w+9HA" Received: by mail-wm1-f41.google.com with SMTP id 5b1f17b1804b1-450ce671a08so22232835e9.3; Sun, 01 Jun 2025 08:30:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1748791833; x=1749396633; 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=Y3jNMoT+iRqn98OkncMggAh9rXyui2JmVuatQmlGrPg=; b=i/7w+9HAUZIIdSVQIOdW3kvYprttuGMaM6qTPlvuG7tbqVRbsZab09vfiazY2BrfkZ S5eHuIfgS0Lw1yuFkOGOJou4Mk9BSo6Yki1ILHeNpv4fdg426d1PbEUlNngOmDT+9A79 W3rSCb327hHXd5ow6WHpo/on9CmutvbUaTf6Dha8/zilK4JiJxMfdPXPvPwzwXUuo4x4 0LrBjuGKa33Kyv9IXiHkGhcZu/vBk5Qx1rn/RNuWe7EGA+ayMMlNm2F0CFmcgTsZYPIZ 1xJgKAHeaGVyvVLT39lyCFGj5z5iXM1XmrcOcGlmGXamelJvVG/YiyPYs2eH91D31PYg LQLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1748791833; x=1749396633; 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=Y3jNMoT+iRqn98OkncMggAh9rXyui2JmVuatQmlGrPg=; b=cu8GwgAErcPmQ1+Kfp5+LhdB414OGnjmhyDiUd/4sm/ZpLSLKwQ4nTWJ2DwfXYJWf6 4FrH7sS9jUAKQtE9MzpKVDe1qSYC2dNgaoVrmN+ssRXAoujABN1WhhBfuski7MrrR49J QwIytfsiG+3LsbSix5mO1i6zLQgGbG/32D5NXKGCrYRVUIkXgoJnPLCfSIac1p2FWzmX 5XsxgJrBbt2iYCD3uZtzRRHlo5jUeC0v/4R1SKYQusUvw9qoT5bavUw44g28cYVDKjPN iYLG7SJeezlLYSX9yWCMcYfFrcadOMgLS3TMKjZqVo6Ad3/7UUpic/yU++js7Eq+/OMY xctw== X-Forwarded-Encrypted: i=1; AJvYcCUl+fo6TWXE7RBqt4SSPcM5/Z0koCwzA3Cc9oi+6tFIDHMI2whttwxtH4UVSYPVRh94CDN1eEbXKK5R@vger.kernel.org X-Gm-Message-State: AOJu0YyCaZdezBuvoxtCTV0cRpg+C4nZ3wONxQX7OU0TL8HUaBl8eI+z Ru3jmZr7Nq60Yf9n3gEFD8qAxuKbx5nZs0+a9e4F01LdHi/B629HKpsd1UMLZnX3 X-Gm-Gg: ASbGncuMRICVRhy+GXFvwK7GqrbScDfjbi/UxYzxDriEZYW7yeD0OGdxDfborDB6QX5 TvcQpddDW16PH1Zg8OqyPx5u1850yriKEG2YMHEjnNOaduN/q85WZPvm+Jw8m0T9K6oL7N1b4Xo qOrQnGaMY1MfsP34E9WKVq1gH8aUkQ+toohEfrRwvVMdSeq3mrnMX+IYplz9+gTBH4W4OaLY5eF n2BcYU5oo49BhPjXePAlVDsZnO6Mod3wXI1MZr9NSsHVgOmfu4ANFZBs4uVu2Dj8SzQ+KGjCZgE MfajxCInaCZP9QH8+ZEZOZUQN2TxmZxBWKON8UbZoZSlCzTnId7nyxmLBC8AhJWrfNasiAabYtY UpJ4e9V2kCnY= X-Google-Smtp-Source: AGHT+IGRHEHyS2AMGT3STNLNGc9FU6UCQHRnuUyJewmtr5RgiNMgDtlTs4y3wDoSKzu/TvUZ7EUxmg== X-Received: by 2002:a05:600c:1986:b0:44a:775d:b5e8 with SMTP id 5b1f17b1804b1-451191fd3b0mr38407295e9.1.1748791832747; Sun, 01 Jun 2025 08:30:32 -0700 (PDT) Received: from masalkhi.. (ip-109-43-115-37.web.vodafone.de. [109.43.115.37]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-450d800671csm88780205e9.30.2025.06.01.08.30.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 01 Jun 2025 08:30:32 -0700 (PDT) From: Abd-Alrhman Masalkhi To: linux-kernel@vger.kernel.org, devicetree@vger.kernel.org Cc: arnd@arndb.de, gregkh@linuxfoundation.org, robh@kernel.org, krzk+dt@kernel.org, conor+dt@kernel.org, abd.masalkhi@gmail.com Subject: [PATCH v2 2/3] misc: add sysfs control driver for ST M24LR series RFID/NFC chips Date: Sun, 1 Jun 2025 15:30:20 +0000 Message-ID: <20250601153022.2027919-3-abd.masalkhi@gmail.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20250601153022.2027919-1-abd.masalkhi@gmail.com> References: <20250601153022.2027919-1-abd.masalkhi@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Add a sysfs-based control driver for the STMicroelectronics M24LR series RFID/NFC EEPROM chips, such as the M24LR04E-R. It enables access to control registers for features such as password authentication, memory access, and device configuration. It also synchronize access to the device. (The EEPROM uses a separate driver; see the note below for details.) This driver provides only the control interface for M24LR chips. It also acts as an I2C mux (gate) for the EEPROM. Therefore, the EEPROM is represented as a child node in the Device Tree and is accessed through a separate driver (the standard 'at24' driver). This setup is possible because M24LR chips use two I2C addresses: one for accessing the system parameter sector, and another for accessing the EEPROM. Signed-off-by: Abd-Alrhman Masalkhi --- drivers/misc/Kconfig | 15 + drivers/misc/Makefile | 1 + drivers/misc/m24lr_ctl.c | 677 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 693 insertions(+) create mode 100644 drivers/misc/m24lr_ctl.c diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig index c161546d728f..c4152f03695f 100644 --- a/drivers/misc/Kconfig +++ b/drivers/misc/Kconfig @@ -644,6 +644,21 @@ config MCHP_LAN966X_PCI - lan966x-miim (MDIO_MSCC_MIIM) - lan966x-switch (LAN966X_SWITCH) =20 +config M24LR_CTL + tristate "M24LR I2C RFID/NFC Control Interface driver" + depends on I2C_MUX && SYSFS + select REGMAP_I2C + help + This driver provides support for the control interface of M24LR I2C + RFID/NFC chips. + + Note This driver does not handle the EEPROM on the device. For EEPROM + access, use the standard 'at24' driver (drivers/misc/eeprom/at24.c), + which supports I2C-based EEPROMs. + + To compile this driver as a module, choose M here: the + module will be called m24lr_ctl. + source "drivers/misc/c2port/Kconfig" source "drivers/misc/eeprom/Kconfig" source "drivers/misc/cb710/Kconfig" diff --git a/drivers/misc/Makefile b/drivers/misc/Makefile index 054cee9b08a4..5ae54112ad7e 100644 --- a/drivers/misc/Makefile +++ b/drivers/misc/Makefile @@ -75,3 +75,4 @@ lan966x-pci-objs :=3D lan966x_pci.o lan966x-pci-objs +=3D lan966x_pci.dtbo.o obj-$(CONFIG_MCHP_LAN966X_PCI) +=3D lan966x-pci.o obj-y +=3D keba/ +obj-$(CONFIG_M24LR_CTL) +=3D m24lr_ctl.o diff --git a/drivers/misc/m24lr_ctl.c b/drivers/misc/m24lr_ctl.c new file mode 100644 index 000000000000..5c8fbabbaac7 --- /dev/null +++ b/drivers/misc/m24lr_ctl.c @@ -0,0 +1,677 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * m24lr_ctl.c - Sysfs control interface for ST M24LR series RFID/NFC chips + * + * Copyright (c) 2025 Abd-Alrhman Masalkhi + * + * This driver implements a sysfs-based control interface for interacting = with + * STMicroelectronics M24LR series chips (e.g., M24LR04E-R). It enables ac= cess + * to control registers for features such as password authentication, memo= ry + * access, and device configuration. It also synchronize access to the dev= ice + * (the EEPROM uses a separate driver, see the note below for details) + * + * NOTE: + * This driver provides only the control interface for M24LR chips. It acts + * as an I2C mux (gate) for the EEPROM. Therefore, the EEPROM is represent= ed + * as a child node in the Device Tree and is accessed through a separate d= river + * (the standard 'at24' driver). This setup is possible because M24LR chip= s use + * two I2C addresses: one for accessing the system parameter sector, and a= nother + * for accessing the EEPROM. + */ + +#include +#include +#include +#include +#include +#include +#include + +#define M24LR_CTL_PAGESIZE_DEFAULT 1u + +/* + * Limits the number of I/O control bytes to 64 to prevent holding the + * I2C bus for too long, especially important when operating at low I2C + * frequencies + */ +#define M24LR_CTL_PAGESIZE_LIMIT 64u +#define M24LR_CTL_WRITE_TIMEOUT 25u +#define M24LR_CTL_READ_TIMEOUT (M24LR_CTL_WRITE_TIMEOUT) + +#define to_sys_entry(attrp) container_of(attrp, struct m24lr_sys_entry, = attr) + +/** + * struct m24lr_sys_entry - describes a sysfs entry for M24LR device access + * @reg_addr: register address in the M24LR device + * @reg_size: size of the register in bytes + * @attr: sysfs attribute used for exposing register access to usersp= ace + * + * Used to define readable/writable register entries through sysfs. + */ +struct m24lr_sys_entry { + unsigned int reg_addr; + unsigned int reg_size; + struct device_attribute attr; +}; + +/** + * struct m24lr_ctl_chip - describes chip-specific sysfs layout + * @entries: array of sysfs entries specific to the chip variant + * @n_entries: number of entries in the array + * @n_sss_entries: number of sss entries required for the chip + * + * Supports multiple M24LR chip variants (e.g., M24LRxx) by allowing each + * to define its own set of sysfs attributes, depending on its available + * registers and features. + */ +struct m24lr_ctl_chip { + const struct m24lr_sys_entry *entries; + unsigned int n_entries; + unsigned int n_sss_entries; +}; + +/** + * struct m24lr_ctl - core driver data for M24LR chip control + * @page_size: chip-specific limit on the maximum number of bytes allo= wed + * in a single write operation. + * @muxc: mux core struct as the driver act as a gate for the eep= rom + * @regmap: regmap interface for accessing chip registers + * @gate_lock: mutex to synchronize operations to the device from this + * driver and the eeprom driver + * @sss_entries: array of sssc sysfs entries specific to the chip variant + * @n_sss_entries: number of entries in the sss entries array + * + * Central data structure holding the state and resources used by the + * M24LR device driver. + */ +struct m24lr_ctl { + unsigned int page_size; + struct regmap *regmap; + struct i2c_mux_core *muxc; + struct mutex gate_lock; /* synchronize operations to the device */ + struct m24lr_sys_entry *sss_entries; + unsigned int n_sss_entries; +}; + +static ssize_t m24lr_ctl_show(struct device *dev, + struct device_attribute *attr, char *buf); +static ssize_t m24lr_ctl_store(struct device *dev, struct device_attribute= *attr, + const char *buf, size_t count); +static ssize_t m24lr_ctl_unlock_command(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count); +static ssize_t m24lr_ctl_newpass_command(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count); + +static const struct regmap_range m24lr_ctl_vo_ranges[] =3D { + regmap_reg_range(0, 63), +}; + +static const struct regmap_access_table m24lr_ctl_vo_table =3D { + .yes_ranges =3D m24lr_ctl_vo_ranges, + .n_yes_ranges =3D ARRAY_SIZE(m24lr_ctl_vo_ranges), +}; + +static const struct regmap_config m24lr_ctl_regmap_conf =3D { + .name =3D "m24lr_ctl", + .reg_stride =3D 1, + .reg_bits =3D 16, + .val_bits =3D 8, + .disable_locking =3D false, + .cache_type =3D REGCACHE_RBTREE,/* Flat can't be used, there's huge gap */ + .volatile_table =3D &m24lr_ctl_vo_table, +}; + +/* define the default sysfs entries specific to the M24LR */ +static const struct m24lr_sys_entry m24lr_ctl_sys_entry_default_table[] = =3D { + {.attr =3D __ATTR(unlock, 0200, NULL, m24lr_ctl_unlock_command)}, + {.attr =3D __ATTR(new_pass, 0200, NULL, m24lr_ctl_newpass_command)}, + {.reg_addr =3D 2324, .reg_size =3D 8, + .attr =3D __ATTR(uid, 0444, m24lr_ctl_show, NULL)}, + {.reg_addr =3D 2334, .reg_size =3D 1, + .attr =3D __ATTR(mem_size, 0400, m24lr_ctl_show, NULL)}, +}; + +/* Chip descriptor for M24LR04E-R variant */ +static const struct m24lr_ctl_chip m24lr04e_r_chip =3D { + .entries =3D m24lr_ctl_sys_entry_default_table, + .n_entries =3D ARRAY_SIZE(m24lr_ctl_sys_entry_default_table), + .n_sss_entries =3D 4, +}; + +/* Chip descriptor for M24LR16E-R variant */ +static const struct m24lr_ctl_chip m24lr16e_r_chip =3D { + .entries =3D m24lr_ctl_sys_entry_default_table, + .n_entries =3D ARRAY_SIZE(m24lr_ctl_sys_entry_default_table), + .n_sss_entries =3D 16, +}; + +/* Chip descriptor for M24LR64E-R variant */ +static const struct m24lr_ctl_chip m24lr64e_r_chip =3D { + .entries =3D m24lr_ctl_sys_entry_default_table, + .n_entries =3D ARRAY_SIZE(m24lr_ctl_sys_entry_default_table), + .n_sss_entries =3D 64, +}; + +static const struct i2c_device_id m24lr_ctl_ids[] =3D { + { "m24lr04e-r", (kernel_ulong_t)&m24lr04e_r_chip}, + { "m24lr16e-r", (kernel_ulong_t)&m24lr16e_r_chip}, + { "m24lr64e-r", (kernel_ulong_t)&m24lr64e_r_chip}, + { } +}; +MODULE_DEVICE_TABLE(i2c, m24lr_ctl_ids); + +static const struct of_device_id m24lr_ctl_of_match[] =3D { + { .compatible =3D "st,m24lr04e-r", .data =3D &m24lr04e_r_chip}, + { .compatible =3D "st,m24lr16e-r", .data =3D &m24lr16e_r_chip}, + { .compatible =3D "st,m24lr64e-r", .data =3D &m24lr64e_r_chip}, + { } +}; +MODULE_DEVICE_TABLE(of, m24lr_ctl_of_match); + +static int m24lr_ctl_gate_select(struct i2c_mux_core *muxc, + unsigned int chan_id) +{ + struct m24lr_ctl *ctl =3D i2c_mux_priv(muxc); + + mutex_lock(&ctl->gate_lock); + + return 0; +} + +static int m24lr_ctl_gate_deselect(struct i2c_mux_core *muxc, + unsigned int chan_id) +{ + struct m24lr_ctl *ctl =3D i2c_mux_priv(muxc); + + mutex_unlock(&ctl->gate_lock); + + return 0; +} + +/** + * m24lr_parse_le_value - Parse hex string and convert to little-endian bi= nary + * @buf: Input string buffer (hex format) + * @reg_size: Size of the register in bytes (must be 1, 2, 4, or 8) + * @output: Output buffer to store the value in little-endian format + * + * Converts a hexadecimal string to a numeric value of the given register = size + * and writes it in little-endian byte order into the provided buffer. + * + * Return: 0 on success, or negative error code on failure + */ +static int m24lr_parse_le_value(const char *buf, u32 reg_size, u8 *output) +{ + int err; + + switch (reg_size) { + case 1: { + u8 tmp; + + err =3D kstrtou8(buf, 16, &tmp); + if (!err) + *output =3D tmp; + break; + } + case 2: { + u16 tmp; + + err =3D kstrtou16(buf, 16, &tmp); + if (!err) + *(__le16 *)output =3D cpu_to_le16(tmp); + break; + } + case 4: { + u32 tmp; + + err =3D kstrtou32(buf, 16, &tmp); + if (!err) + *(__le32 *)output =3D cpu_to_le32(tmp); + break; + } + case 8: { + u64 tmp; + + err =3D kstrtou64(buf, 16, &tmp); + if (!err) + *(__le64 *)output =3D cpu_to_le64(tmp); + break; + } + default: + err =3D -EINVAL; + } + + return err; +} + +/** + * m24lr_ctl_regmap_read - read data using regmap with retry on failure + * @regmap: regmap instance for the device + * @buf: buffer to store the read data + * @size: number of bytes to read + * @offset: starting register address + * + * Attempts to read a block of data from the device with retries and timeo= ut. + * Some M24LR chips may transiently NACK reads (e.g., during internal write + * cycles), so this function retries with a short sleep until the timeout + * expires. + * + * Returns: + * Number of bytes read on success, + * -ETIMEDOUT if the read fails within the timeout window. + */ +static ssize_t m24lr_ctl_regmap_read(struct regmap *regmap, u8 *buf, + size_t size, unsigned int offset) +{ + int err; + unsigned long timeout, read_time; + ssize_t ret =3D -ETIMEDOUT; + + timeout =3D jiffies + msecs_to_jiffies(M24LR_CTL_READ_TIMEOUT); + do { + read_time =3D jiffies; + + err =3D regmap_bulk_read(regmap, offset, buf, size); + if (!err) { + ret =3D size; + break; + } + + usleep_range(1000, 2000); + } while (time_before(read_time, timeout)); + + return ret; +} + +/** + * m24lr_ctl_regmap_write - write data using regmap with retry on failure + * @regmap: regmap instance for the device + * @buf: buffer containing the data to write + * @size: number of bytes to write + * @offset: starting register address + * + * Attempts to write a block of data to the device with retries and a time= out. + * Some M24LR devices may NACK I2C writes while an internal write operation + * is in progress. This function retries the write operation with a short = delay + * until it succeeds or the timeout is reached. + * + * Returns: + * Number of bytes written on success, + * -ETIMEDOUT if the write fails within the timeout window. + */ +static ssize_t m24lr_ctl_regmap_write(struct regmap *regmap, const u8 *buf, + size_t size, unsigned int offset) +{ + int err; + unsigned long timeout, write_time; + ssize_t ret =3D -ETIMEDOUT; + + timeout =3D jiffies + msecs_to_jiffies(M24LR_CTL_WRITE_TIMEOUT); + + do { + write_time =3D jiffies; + + err =3D regmap_bulk_write(regmap, offset, buf, size); + if (!err) { + ret =3D size; + break; + } + + usleep_range(1000, 2000); + } while (time_before(write_time, timeout)); + + return ret; +} + +static ssize_t m24lr_ctl_read(struct m24lr_ctl *ctl, u8 *buf, + size_t size, unsigned int offset) +{ + int ret =3D 0; + struct regmap *regmap =3D ctl->regmap; + + if (unlikely(!size)) + return ret; + + m24lr_ctl_gate_select(ctl->muxc, 0); + ret =3D m24lr_ctl_regmap_read(regmap, buf, size, offset); + m24lr_ctl_gate_deselect(ctl->muxc, 0); + + return ret; +} + +/** + * m24lr_ctl_write - write buffer to M24LR device with page alignment hand= ling + * @ctl: pointer to driver context + * @buf: data buffer to write + * @size: number of bytes to write + * @offset: target register address in the device + * + * Writes data to the M24LR device using regmap, split into chunks no larg= er + * than page_size to respect device-specific write limitations (e.g., page + * size or I2C hold-time concerns). Each chunk is aligned to the page boun= dary + * defined by page_size. + * + * Returns: + * Total number of bytes written on success, + * A negative error code if any write fails. + */ +static ssize_t m24lr_ctl_write(struct m24lr_ctl *ctl, const u8 *buf, + size_t size, unsigned int offset) +{ + unsigned int n, next_sector; + struct regmap *regmap =3D ctl->regmap; + long err; + ssize_t ret =3D 0; + + if (unlikely(!size)) + return ret; + + n =3D min(size, ctl->page_size); + next_sector =3D roundup(offset + 1, ctl->page_size); + if (offset + n > next_sector) + n =3D next_sector - offset; + + m24lr_ctl_gate_select(ctl->muxc, 0); + while (n) { + err =3D m24lr_ctl_regmap_write(regmap, buf, n, offset); + if (IS_ERR_VALUE(err)) { + m24lr_ctl_gate_deselect(ctl->muxc, 0); + if (ret) + return ret; + else + return err; + } + + offset +=3D n; + size -=3D n; + ret +=3D n; + n =3D min(size, ctl->page_size); + } + m24lr_ctl_gate_deselect(ctl->muxc, 0); + + return ret; +} + +/** + * m24lr_ctl_write_pass - Write password to M24LR043-R using secure format + * @ctl: Pointer to device control structure + * @buf: Input buffer containing hex-encoded password + * @count: Number of bytes in @buf + * @code: Operation code to embed between password copies + * + * This function parses a 4-byte password, encodes it in big-endian forma= t, + * and constructs a 9-byte sequence of the form: + * + * [BE(password), code, BE(password)] + * + * The result is written to register 0x0900 (2304), which is the password + * register in M24LR04E-R chip. + * + * Return: Number of bytes written on success, or negative error code on f= ailure + */ +static ssize_t m24lr_ctl_write_pass(struct m24lr_ctl *ctl, const char *buf, + size_t count, u8 code) +{ + int ret; + u32 pass; + __be32 be_pass; + u8 output[9]; + + ret =3D kstrtou32(buf, 16, &pass); + if (ret) + return ret; + + be_pass =3D cpu_to_be32(pass); + + memcpy(output, &be_pass, sizeof(be_pass)); + output[4] =3D code; + memcpy(output + 5, &be_pass, sizeof(be_pass)); + + m24lr_ctl_gate_select(ctl->muxc, 0); + ret =3D m24lr_ctl_regmap_write(ctl->regmap, output, 9, 2304); + m24lr_ctl_gate_deselect(ctl->muxc, 0); + + return ret; +} + +static ssize_t m24lr_ctl_newpass_command(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct m24lr_ctl *ctl =3D i2c_get_clientdata(to_i2c_client(dev)); + + if (count > 8) + return -EINVAL; + + return m24lr_ctl_write_pass(ctl, buf, count, 7); +} + +static ssize_t m24lr_ctl_unlock_command(struct device *dev, + struct device_attribute *attr, + const char *buf, size_t count) +{ + struct m24lr_ctl *ctl =3D i2c_get_clientdata(to_i2c_client(dev)); + + if (count > 8) + return -EINVAL; + + return m24lr_ctl_write_pass(ctl, buf, count, 9); +} + +static ssize_t m24lr_ctl_store(struct device *dev, struct device_attribute= *attr, + const char *buf, size_t count) +{ + struct m24lr_ctl *ctl =3D i2c_get_clientdata(to_i2c_client(dev)); + struct m24lr_sys_entry *entry =3D to_sys_entry(attr); + unsigned int reg_size =3D entry->reg_size; + unsigned int reg_addr =3D entry->reg_addr; + u8 output[8]; + int err =3D 0; + + if (unlikely(!is_power_of_2(reg_size) || reg_size > 8)) { + dev_dbg(dev, + "Invalid register size: must be a power of 2 and <=3D 8 bytes (%u)\n", + reg_size); + return -EIO; + } + + if (count > (reg_size << 1)) + return -EINVAL; + + err =3D m24lr_parse_le_value(buf, reg_size, output); + if (err) + return err; + + return m24lr_ctl_write(ctl, (u8 *)&output, reg_size, reg_addr); +} + +static ssize_t m24lr_ctl_show(struct device *dev, struct device_attribute = *attr, + char *buf) +{ + long ret; + u64 val; + __le64 input =3D 0; + struct m24lr_ctl *ctl =3D i2c_get_clientdata(to_i2c_client(dev)); + struct m24lr_sys_entry *entry =3D to_sys_entry(attr); + unsigned int reg_addr =3D entry->reg_addr; + unsigned int reg_size =3D entry->reg_size; + + if (unlikely(!is_power_of_2(reg_size) || reg_size > 8)) { + dev_dbg(dev, + "Invalid register size: must be a power of 2 and <=3D 8 bytes (%u)\n", + reg_size); + return -EIO; + } + + ret =3D m24lr_ctl_read(ctl, (u8 *)&input, reg_size, reg_addr); + if (IS_ERR_VALUE(ret)) + return ret; + + if (ret !=3D reg_size) + return -EIO; + + switch (reg_size) { + case 1: + val =3D *(u8 *)&input; + break; + case 2: + val =3D le16_to_cpu((__le16)input); + break; + case 4: + val =3D le32_to_cpu((__le32)input); + break; + case 8: + val =3D le64_to_cpu((__le64)input); + break; + }; + + return sysfs_emit(buf, "%llx\n", val); +} + +static const struct m24lr_ctl_chip *m24lr_ctl_get_chip(struct device *dev) +{ + const struct m24lr_ctl_chip *ret; + const struct i2c_device_id *id; + + id =3D i2c_match_id(m24lr_ctl_ids, to_i2c_client(dev)); + + if (dev->of_node && of_match_device(m24lr_ctl_of_match, dev)) + ret =3D of_device_get_match_data(dev); + else if (id) + ret =3D (void *)id->driver_data; + else + ret =3D acpi_device_get_match_data(dev); + + return ret; +} + +static int m24lr_ctl_probe(struct i2c_client *client) +{ + struct regmap *regmap; + struct m24lr_ctl *ctl; + struct i2c_mux_core *muxc; + const struct m24lr_ctl_chip *chip; + struct m24lr_sys_entry *sss =3D NULL; + unsigned int page_size; + unsigned int n_sss; + long err; + u8 test; + int i; + struct device *dev =3D &client->dev; + + if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) + return -EOPNOTSUPP; + + chip =3D m24lr_ctl_get_chip(dev); + if (!chip) + return -ENODEV; + + ctl =3D devm_kzalloc(dev, sizeof(struct m24lr_ctl), GFP_KERNEL); + if (!ctl) + return -ENOMEM; + + err =3D device_property_read_u32(dev, "pagesize", &page_size); + if (!err) { + if (!is_power_of_2(page_size)) { + dev_warn(dev, + "Invalid pagesize length %d (not power of 2); using default %d byte\n= ", + page_size, M24LR_CTL_PAGESIZE_DEFAULT); + page_size =3D M24LR_CTL_PAGESIZE_DEFAULT; + } + if (page_size > M24LR_CTL_PAGESIZE_LIMIT) { + dev_info(dev, + "pagesize %d exceeds limit; rounded down to %d\n", + page_size, M24LR_CTL_PAGESIZE_LIMIT); + page_size =3D M24LR_CTL_PAGESIZE_LIMIT; + } + } else { /* use the default */ + page_size =3D M24LR_CTL_PAGESIZE_DEFAULT; + } + + for (i =3D 0; i < chip->n_entries; i++) { + const struct device_attribute *attr =3D &chip->entries[i].attr; + + err =3D device_create_file(dev, attr); + if (err) + dev_warn(dev, + "Failed to create sysfs entry '%s'\n", + attr->attr.name); + } + + n_sss =3D chip->n_sss_entries; + if (n_sss) { + sss =3D devm_kzalloc(dev, n_sss * sizeof(struct m24lr_sys_entry), + GFP_KERNEL); + if (!sss) + return -ENOMEM; + + for (i =3D 0; i < n_sss; i++) { + char *name =3D devm_kasprintf(dev, GFP_KERNEL, "sss%d", i); + + sss[i].reg_size =3D 1; + sss[i].reg_addr =3D i; + sss[i].attr.attr.name =3D name; + sss[i].attr.attr.mode =3D 0600; + sss[i].attr.show =3D m24lr_ctl_show; + sss[i].attr.store =3D m24lr_ctl_store; + + err =3D device_create_file(dev, &sss[i].attr); + if (err) + dev_warn(dev, + "Failed to create sysfs entry '%s'\n", + name); + } + } + + regmap =3D devm_regmap_init_i2c(client, &m24lr_ctl_regmap_conf); + if (IS_ERR(regmap)) { + err =3D PTR_ERR(regmap); + dev_dbg(dev, "Failed to init regmap (error: %ld)\n", err); + return err; + } + + muxc =3D i2c_mux_alloc(client->adapter, &client->dev, 1, 0, I2C_MUX_GATE, + m24lr_ctl_gate_select, m24lr_ctl_gate_deselect); + if (!muxc) + return -ENOMEM; + + muxc->priv =3D ctl; + + mutex_init(&ctl->gate_lock); + ctl->page_size =3D page_size; + ctl->regmap =3D regmap; + ctl->muxc =3D muxc; + ctl->n_sss_entries =3D n_sss; + ctl->sss_entries =3D sss; + + i2c_set_clientdata(client, ctl); + + err =3D m24lr_ctl_read(ctl, &test, 1, 0); + if (IS_ERR_VALUE(err)) + return -ENODEV; + + return i2c_mux_add_adapter(muxc, 0, 0); +} + +static void remove(struct i2c_client *client) +{ + struct m24lr_ctl *ctl =3D i2c_get_clientdata(client); + + i2c_mux_del_adapters(ctl->muxc); +} + +static struct i2c_driver m24lr_ctl_driver =3D { + .driver =3D { + .name =3D "m24lr_ctl", + .of_match_table =3D m24lr_ctl_of_match, + }, + .probe =3D m24lr_ctl_probe, + .remove =3D remove, + .id_table =3D m24lr_ctl_ids, +}; +module_i2c_driver(m24lr_ctl_driver); + +MODULE_AUTHOR("Abd-Alrhman Masalkhi"); +MODULE_DESCRIPTION("st m24lr control driver"); +MODULE_LICENSE("GPL"); --=20 2.43.0