From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f51.google.com (mail-pj1-f51.google.com [209.85.216.51]) (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 6438C27CCEE for ; Mon, 22 Dec 2025 08:06:05 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.51 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1766390767; cv=none; b=EwnzGd6h53FphUnsT/WDkRxo4ILLlugVt72oV1mSgSLkgxkER2ndxMYRLs5ugqBevlnoOPNicKNp7k1RyTbZQJiREGehDK1cMHIVOqc6ZJOHR2q1jAPVNj5tYedbTiSOFCIFf7UpFPFJQfa9Eadp9IN0DiRTkG2I8BU6qDh1q+o= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1766390767; c=relaxed/simple; bh=e4lomm4dQoXyplwfCFD6ts8MxpYp7skOEaioYQvgTIo=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=bAxiNgXAx4U1s6CrW0ymWO5S4jjxTyefz5fmZtz5ZN7judKPLSknVo65wQcEzwzTQPlZG7Uh+TF6Ebw3fvjreNr67SI+ZwQNiDD2R0KSkONIN39gEuU3IPtG2kWWiPe/ZXacvPgc5Ne1W4rU26RMM1SA/oQGWIG7IabDiJ4k974= 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=MTN0UHqT; arc=none smtp.client-ip=209.85.216.51 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="MTN0UHqT" Received: by mail-pj1-f51.google.com with SMTP id 98e67ed59e1d1-34ca40c1213so3154054a91.0 for ; Mon, 22 Dec 2025 00:06:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1766390765; x=1766995565; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=4vwaOegezfUGFtkdmQG91NRUULYH7tFQw4sLTEMvhqk=; b=MTN0UHqTCvkTKT9Yo4j+cfsEDZsdW2rsM9ziL++KXWXRvJApgWfoCpIbvCHAunyru1 LPyd+XlQrieqM6n1aM1IdnS8EpDuFuy3W5AhelcRAkEeAR+HjX4GlLqJArRzTnKyGY5/ Y68gAQvd/Z5tpKamESAXJEGrDX4qH1imy7NirTivWqtGMkGRn5NlvyRg4Sfpd36hC/Y6 YGeyhbsXqnWdqADfDz2+MQjlBNu19bV92mXEK2CNn/Z+vhRpKVofBatXTMvl9nSkGwU8 PAYIsxubjzi0/FdN36GCtDoafhBFR5Peb4R1LVkkYvyOqnMewiHmHXsk8GCPLt3a3Kh0 e5lw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1766390765; x=1766995565; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=4vwaOegezfUGFtkdmQG91NRUULYH7tFQw4sLTEMvhqk=; b=iW35NjN1swIgioKyNNZs5yZfdGw5iJSRywD3npAQZplHJMJJcZ+rjavThGVpNm8F08 Ous9RmZ8TfBqyIL7jFUvosSeUL5Dy5N8K2rsFTFLFgAtwJ8xYSphv5uhyDthHaac8DLC PEnIKzBJM9/dYkLbqr5zBJaXv2qc8+Fki7dUEK1BEkM1tnveopluq93Jzquymb8r33y1 b1nF5a+EC26r2B3Qi4ojs3cERDsu6xnA0ITwHELrcCXcNe4o0m1M+ZKo6PdhdOKDyB6r FgbkbOFB0SKeAac70HgLzlt6MEBcQgkJ3Vg3ae7TMKjdLg8xxfv9IZwWn2I/7RheAmea nr5w== X-Forwarded-Encrypted: i=1; AJvYcCXe5ZFRQXGIhfhGo2Ivz1BDivbvUSGPbo+XBk3tmoaty/d17khdSWkIaP3/cWvDkC0Epo38X4YBpHWoRxg=@vger.kernel.org X-Gm-Message-State: AOJu0YzQ4K8KOROjY3DWmjf9igqbkezq0UzjuIjjagk3yDAUvhN5NcXh 3W4hdFkpjMp9NqAIM4RJdMdP+g3y2/9haJfnq21ErW2WrfGs6a+YruxU X-Gm-Gg: AY/fxX48a4EFzJrXkJW7VpR45tWga4SoNjpr6momoUP9hm11NGa6A0wfnvdg2eBlaCY ITo6eiVm1UMQbTd8u39cUigFcqU9nPc8GlLS02jPhlHRnvCm0VEIAwK8WosB8hW7imf+6NJ2SUJ gxSQzf0Qk2fapfw4exGbNpv1/c5KeKnOWdU8CZ8m1eFzozRtgbng8TNx2cDd8x21UtLxSgOjd2s MHrxSZX0ws4F1jAcqzxUoeBIzxGw7R/fN0gmQPIxy/SmNNKJect1q6orhFLRifs2k774ZjyuOHR RU//qdJMPmPt2U46tScY85I+rJcWBZhHXRp4GLVDivuemjP4+p/6aaatGAhP71kaDYVkx4+nc2Q FPbq3JEiuOE5nkTxhBkVmO+Gg4Zm5J6MuI1aWE4ZH8AFox2CqDbLCkxKh27VKWBEXGPqz5JVBpK H67+1uEs1sMgPVx10TXRGnpD3Jz9811MCxdsYqouSTHEXxv9TL82Z61JYrOgKOD2tiC812GEP88 FIMQVSk2sM7E0Zx/C7ZpDEiLZe9Y+9v X-Google-Smtp-Source: AGHT+IEGRyFS0Tv7fIK6EPDf770ukZVJpvB608i8Q1wJrgT+Euv9n5wfIRSBU3nihnzBkM+dzx27bw== X-Received: by 2002:a17:90b:4f41:b0:340:bde5:c9e3 with SMTP id 98e67ed59e1d1-34e921b73b5mr8612011a91.23.1766390764509; Mon, 22 Dec 2025 00:06:04 -0800 (PST) Received: from ubuntu-2504-ThinkPad-X9-14-Gen-1.lenovo.com (zz20234032476F6CA7C5.userreverse.dion.ne.jp. [111.108.167.197]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-34e7729b04dsm5622557a91.6.2025.12.22.00.06.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 22 Dec 2025 00:06:03 -0800 (PST) From: Vishnu Sankar To: srinivas.pandruvada@linux.intel.com, jikos@kernel.org, bentiss@kernel.org, corbet@lwn.net, vsankar@lenovo.com Cc: linux-doc@vger.kernel.org, linux-input@vger.kernel.org, linux-kernel@vger.kernel.org, Vishnu Sankar , Mark Pearson , Richie Roy Jayme Subject: [PATCH v3 1/2] HID: intel-ish-hid: loader: Add PRODUCT_FAMILY-based firmware matching Date: Mon, 22 Dec 2025 17:05:11 +0900 Message-ID: <20251222080512.956519-1-vishnuocv@gmail.com> X-Mailer: git-send-email 2.51.0 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Add support for firmware filenames that include the CRC32 checksum of the DMI product_family field. Several OEMs ship ISH firmware variants shared across a product family while product_name or product_sku may differ. This intermediate matching granularity reduces duplication and improves firmware selection for vendor-customized platforms. The newly supported filename forms are checked before existing patterns: ish_${gen}_${vendor}_${family}_${name}_${sku}.bin ish_${gen}_${vendor}_${family}_${sku}.bin ish_${gen}_${vendor}_${family}_${name}.bin ish_${gen}_${vendor}_${family}.bin The legacy product_name/product_sku rules remain unchanged and continue to provide fallback matching. ISH_FW_FILENAME_LEN_MAX is changed to 72 to accommodate the product_family. Tested with X9 series and X1 series. Reviewed-by: Mark Pearson Tested-by: Richie Roy Jayme Signed-off-by: Vishnu Sankar --- Changes in v3 - Removed the duplicate defenition of ISH_FW_FILE_VENDOR_FAMILY_FMT --- Changes in v2 - Indent corrected - More comments added --- drivers/hid/intel-ish-hid/ishtp/loader.c | 58 +++++++++++++++++++++++- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/drivers/hid/intel-ish-hid/ishtp/loader.c b/drivers/hid/intel-ish-hid/ishtp/loader.c index f34086b29cf0..ffa2042bb316 100644 --- a/drivers/hid/intel-ish-hid/ishtp/loader.c +++ b/drivers/hid/intel-ish-hid/ishtp/loader.c @@ -195,13 +195,19 @@ static int prepare_dma_bufs(struct ishtp_device *dev, return 0; } +/* Patterns with PRODUCT_FAMILY */ +#define ISH_FW_FILE_VENDOR_FAMILY_NAME_SKU_FMT "intel/ish/ish_%s_%08x_%08x_%08x_%08x.bin" +#define ISH_FW_FILE_VENDOR_FAMILY_SKU_FMT "intel/ish/ish_%s_%08x_%08x_%08x.bin" +#define ISH_FW_FILE_VENDOR_FAMILY_NAME_FMT "intel/ish/ish_%s_%08x_%08x_%08x.bin" +#define ISH_FW_FILE_VENDOR_FAMILY_FMT "intel/ish/ish_%s_%08x_%08x.bin" + #define ISH_FW_FILE_VENDOR_NAME_SKU_FMT "intel/ish/ish_%s_%08x_%08x_%08x.bin" #define ISH_FW_FILE_VENDOR_SKU_FMT "intel/ish/ish_%s_%08x_%08x.bin" #define ISH_FW_FILE_VENDOR_NAME_FMT "intel/ish/ish_%s_%08x_%08x.bin" #define ISH_FW_FILE_VENDOR_FMT "intel/ish/ish_%s_%08x.bin" #define ISH_FW_FILE_DEFAULT_FMT "intel/ish/ish_%s.bin" -#define ISH_FW_FILENAME_LEN_MAX 56 +#define ISH_FW_FILENAME_LEN_MAX 72 #define ISH_CRC_INIT (~0u) #define ISH_CRC_XOROUT (~0u) @@ -228,6 +234,12 @@ static int _request_ish_firmware(const struct firmware **firmware_p, * for the given device in the following order, prioritizing custom firmware * with more precise matching patterns: * + * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_FAMILY_CRC32) + * _$(PRODUCT_NAME_CRC32)_${PRODUCT_SKU_CRC32}.bin + * + * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_FAMILY_CRC32)_${PRODUCT_SKU_CRC32}.bin + * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_FAMILY_CRC32)_$(PRODUCT_NAME_CRC32).bin + * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_FAMILY_CRC32).bin * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_NAME_CRC32)_${PRODUCT_SKU_CRC32}.bin * ish_${fw_generation}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin * ish_${fw_generation}_${SYS_VENDOR_CRC32}_$(PRODUCT_NAME_CRC32).bin @@ -256,8 +268,9 @@ static int request_ish_firmware(const struct firmware **firmware_p, struct device *dev) { const char *gen, *sys_vendor, *product_name, *product_sku; + const char *product_family; struct ishtp_device *ishtp = dev_get_drvdata(dev); - u32 vendor_crc, name_crc, sku_crc; + u32 vendor_crc, name_crc, sku_crc, family_crc; char filename[ISH_FW_FILENAME_LEN_MAX]; int ret; @@ -265,14 +278,55 @@ static int request_ish_firmware(const struct firmware **firmware_p, sys_vendor = dmi_get_system_info(DMI_SYS_VENDOR); product_name = dmi_get_system_info(DMI_PRODUCT_NAME); product_sku = dmi_get_system_info(DMI_PRODUCT_SKU); + product_family = dmi_get_system_info(DMI_PRODUCT_FAMILY); if (sys_vendor) vendor_crc = crc32(ISH_CRC_INIT, sys_vendor, strlen(sys_vendor)) ^ ISH_CRC_XOROUT; + if (product_family) + family_crc = crc32(ISH_CRC_INIT, product_family, + strlen(product_family)) ^ ISH_CRC_XOROUT; if (product_name) name_crc = crc32(ISH_CRC_INIT, product_name, strlen(product_name)) ^ ISH_CRC_XOROUT; if (product_sku) sku_crc = crc32(ISH_CRC_INIT, product_sku, strlen(product_sku)) ^ ISH_CRC_XOROUT; + /* PRODUCT_FAMILY-extended matching */ + if (sys_vendor && product_family && product_name && product_sku) { + snprintf(filename, sizeof(filename), + ISH_FW_FILE_VENDOR_FAMILY_NAME_SKU_FMT, + gen, vendor_crc, family_crc, name_crc, sku_crc); + ret = _request_ish_firmware(firmware_p, filename, dev); + if (!ret) + return 0; + } + + if (sys_vendor && product_family && product_sku) { + snprintf(filename, sizeof(filename), + ISH_FW_FILE_VENDOR_FAMILY_SKU_FMT, + gen, vendor_crc, family_crc, sku_crc); + ret = _request_ish_firmware(firmware_p, filename, dev); + if (!ret) + return 0; + } + + if (sys_vendor && product_family && product_name) { + snprintf(filename, sizeof(filename), + ISH_FW_FILE_VENDOR_FAMILY_NAME_FMT, + gen, vendor_crc, family_crc, name_crc); + ret = _request_ish_firmware(firmware_p, filename, dev); + if (!ret) + return 0; + } + + if (sys_vendor && product_family) { + snprintf(filename, sizeof(filename), + ISH_FW_FILE_VENDOR_FAMILY_FMT, + gen, vendor_crc, family_crc); + ret = _request_ish_firmware(firmware_p, filename, dev); + if (!ret) + return 0; +} + if (sys_vendor && product_name && product_sku) { snprintf(filename, sizeof(filename), ISH_FW_FILE_VENDOR_NAME_SKU_FMT, gen, vendor_crc, name_crc, sku_crc); -- 2.51.0