From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from smtp4.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 43203C5AD49 for ; Wed, 4 Jun 2025 00:54:50 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id DDEFC417E8; Wed, 4 Jun 2025 00:54:49 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id MtIupr6zEZRJ; Wed, 4 Jun 2025 00:54:49 +0000 (UTC) X-Comment: SPF check N/A for local connections - client-ip=140.211.166.142; helo=lists1.osuosl.org; envelope-from=intel-wired-lan-bounces@osuosl.org; receiver= DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org 2C494419DC DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=osuosl.org; s=default; t=1748998489; bh=mzDsE+q3RN32eD0QtZykTIdOcILvByXR8G9OflB23r4=; h=From:To:Cc:Date:In-Reply-To:References:Subject:List-Id: List-Unsubscribe:List-Archive:List-Post:List-Help:List-Subscribe: From; b=zGrqO9Xfy/f8HKFUw0bQjNcPHAksAOo167aJ1AjAD+qqYjfkbo35kyaKRzVZrmHjM RpOTzjHdGzToAerdepPcry5i8uH+f4gQPPa5PyjPIqyWjG0fU1scT0dLOXwMeNJGRN fEhjxIkjuG1DMOlWrz8mQu6JmWJblS2gLgwa6rNGrCDpmLlvPmmsoDa0GdkiejJAgX RVYsEZoiC0b9lvQV50cOF5OoabUAvS8tsprD2ypRXAMfOeuacN5YVr73DzBV+nC0u5 SOj6FvSBXyvpfYlXOiAPExKuAMhKCoJTLkNTSzfwa+IbuvbuiASBy2kzoIVKlxnPvz L2g7NrS/iZ92A== Received: from lists1.osuosl.org (lists1.osuosl.org [140.211.166.142]) by smtp4.osuosl.org (Postfix) with ESMTP id 2C494419DC; Wed, 4 Jun 2025 00:54:49 +0000 (UTC) Received: from smtp4.osuosl.org (smtp4.osuosl.org [IPv6:2605:bc80:3010::137]) by lists1.osuosl.org (Postfix) with ESMTP id 7FCC1B07 for ; Wed, 4 Jun 2025 00:54:48 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by smtp4.osuosl.org (Postfix) with ESMTP id 7D1BA417E8 for ; Wed, 4 Jun 2025 00:54:48 +0000 (UTC) X-Virus-Scanned: amavis at osuosl.org Received: from smtp4.osuosl.org ([127.0.0.1]) by localhost (smtp4.osuosl.org [127.0.0.1]) (amavis, port 10024) with ESMTP id 5IJ0oUMwhrJL for ; Wed, 4 Jun 2025 00:54:47 +0000 (UTC) Received-SPF: Pass (mailfrom) identity=mailfrom; client-ip=2604:1380:4641:c500::1; helo=dfw.source.kernel.org; envelope-from=sashal@kernel.org; receiver= DMARC-Filter: OpenDMARC Filter v1.4.2 smtp4.osuosl.org C1F0F419DC DKIM-Filter: OpenDKIM Filter v2.11.0 smtp4.osuosl.org C1F0F419DC Received: from dfw.source.kernel.org (dfw.source.kernel.org [IPv6:2604:1380:4641:c500::1]) by smtp4.osuosl.org (Postfix) with ESMTPS id C1F0F419DC for ; Wed, 4 Jun 2025 00:54:47 +0000 (UTC) Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id BC60D5C336A; Wed, 4 Jun 2025 00:52:29 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 5669CC4CEED; Wed, 4 Jun 2025 00:54:45 +0000 (UTC) From: Sasha Levin To: patches@lists.linux.dev, stable@vger.kernel.org Cc: Rand Deeb , Rinitha S , Tony Nguyen , Sasha Levin , przemyslaw.kitszel@intel.com, intel-wired-lan@lists.osuosl.org Date: Tue, 3 Jun 2025 20:50:33 -0400 Message-Id: <20250604005049.4147522-102-sashal@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250604005049.4147522-1-sashal@kernel.org> References: <20250604005049.4147522-1-sashal@kernel.org> MIME-Version: 1.0 X-stable: review X-Patchwork-Hint: Ignore X-stable-base: Linux 6.15 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1748998486; bh=dca/qdOQd8trVl3PyThEbwDVoz8kJ2EoR/OfkEaN2sc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=dZkvRmprOMtwj5IYL2zxc8jvbJ/ggZm5MkWh4NW4+Brazawl/1YqpG3kBn0VDDMkR WH61nqXLhVTaHb2BGO0P/h+uVm8ItdPi3QZyZGe4hJF77YliImura8AK0yTMoismup Igj3GHQI3cAIpKizSm35PqNknX/xJox2KCcOw8Mo48IfHQ4zLxDYepMe4i4rRlGwxQ /Nze01I9oX9QsQDaRb7wqfR1BVtTETxm9XG8/nV0yrjbbIuzT1qfKP487u42lzGeMV j2wFNSM2utwjVwT12IT1FI2fDEPLDTe2wQANw2f9C5RSfpjalQPq+O8iWk/97J2BeA p+RvxD6ig7lCw== X-Mailman-Original-Authentication-Results: smtp4.osuosl.org; dmarc=pass (p=quarantine dis=none) header.from=kernel.org X-Mailman-Original-Authentication-Results: smtp4.osuosl.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.a=rsa-sha256 header.s=k20201202 header.b=dZkvRmpr Subject: [Intel-wired-lan] [PATCH AUTOSEL 6.15 102/118] ixgbe: Fix unreachable retry logic in combined and byte I2C write functions X-BeenThere: intel-wired-lan@osuosl.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Intel Wired Ethernet Linux Kernel Driver Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-wired-lan-bounces@osuosl.org Sender: "Intel-wired-lan" From: Rand Deeb [ Upstream commit cdcb3804eeda24d588348bbab6766cf14fddbeaa ] The current implementation of `ixgbe_write_i2c_combined_generic_int` and `ixgbe_write_i2c_byte_generic_int` sets `max_retry` to `1`, which makes the condition `retry < max_retry` always evaluate to `false`. This renders the retry mechanism ineffective, as the debug message and retry logic are never executed. This patch increases `max_retry` to `3` in both functions, aligning them with the retry logic in `ixgbe_read_i2c_combined_generic_int`. This ensures that the retry mechanism functions as intended, improving robustness in case of I2C write failures. Found by Linux Verification Center (linuxtesting.org) with SVACE. Signed-off-by: Rand Deeb Tested-by: Rinitha S (A Contingent worker at Intel) Signed-off-by: Tony Nguyen Signed-off-by: Sasha Levin --- **YES** This commit should be backported to stable kernel trees. Here's my extensive analysis: ## Bug Analysis **Critical Logic Flaw:** The commit fixes a fundamental bug where the retry logic in I2C write functions was completely ineffective. With `max_retry = 1`, the condition `retry < max_retry` would only allow `retry = 0`, meaning the retry loop would never execute more than once, making the entire retry mechanism useless. **Code Impact:** The change from `max_retry = 1` to `max_retry = 3` in both: - `ixgbe_write_i2c_combined_generic_int()` (line ~170) - `ixgbe_write_i2c_byte_generic_int()` (line ~2288) This aligns with the existing `ixgbe_read_i2c_combined_generic_int()` function which already uses `max_retry = 3`. ## Backport Suitability Criteria **1. Fixes Important User-Affecting Bug:** ✓ - I2C write failures directly impact SFP/QSFP module detection and configuration - Affects `ethtool --identify` LED functionality - Can cause intermittent network interface initialization failures - Users would experience unreliable hardware detection and configuration **2. Small and Contained Change:** ✓ - Only changes two integer values from 1 to 3 - No architectural changes or new functionality - Minimal risk of introducing regressions - Affects only the specific I2C write retry mechanism **3. No Side Effects Beyond the Fix:** ✓ - Simply enables existing retry logic to work as intended - Doesn't change the fundamental I2C communication protocol - Maintains consistency with read operations - No new code paths introduced **4. Critical Subsystem Impact:** ✓ - Network driver functionality is critical for system operation - I2C communication is essential for modern network hardware management - Affects Intel ixgbe NICs which are widely deployed in enterprise environments **5. Clear Bug Evidence:** ✓ - Linux Verification Center found this with static analysis (SVACE) - Logic flaw is mathematically provable (retry < 1 never allows retry) - Consistent with similar commits in the pattern (Similar Commit #1 shows retry count adjustments are appropriate for backporting) ## Comparison to Historical Patterns This commit closely matches **Similar Commit #1** (Backport Status: YES) which also modified I2C retry counts in ixgbe. That commit reduced retry counts to avoid regressions, while this one increases retry counts to fix broken logic - both are stability improvements worthy of backporting. Unlike **Similar Commit #2** (Backport Status: NO) which was architectural refactoring, this commit fixes a clear functional defect without introducing new features or code reorganization. ## Risk Assessment **Low Risk:** - Increasing retries from effectively 0 to 3 cannot make things worse - The retry mechanism already existed and was intended to be used - 3 retries aligns with established patterns in the same driver - Intel has tested this change (as indicated by the "Tested- by" tag) **High Impact:** - Fixes complete failure of I2C write retry mechanism - Improves reliability of critical network hardware functionality - Addresses systematic logic flaw affecting all ixgbe deployments This commit represents exactly the type of important, low- risk bug fix that stable trees are designed to receive. drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c b/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c index 0a03a8bb5f886..2d54828bdfbbc 100644 --- a/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c +++ b/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c @@ -167,7 +167,7 @@ int ixgbe_write_i2c_combined_generic_int(struct ixgbe_hw *hw, u8 addr, u16 reg, u16 val, bool lock) { u32 swfw_mask = hw->phy.phy_semaphore_mask; - int max_retry = 1; + int max_retry = 3; int retry = 0; u8 reg_high; u8 csum; @@ -2285,7 +2285,7 @@ static int ixgbe_write_i2c_byte_generic_int(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr, u8 data, bool lock) { u32 swfw_mask = hw->phy.phy_semaphore_mask; - u32 max_retry = 1; + u32 max_retry = 3; u32 retry = 0; int status; -- 2.39.5 From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 6147C1C84C4; Wed, 4 Jun 2025 00:54:46 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748998486; cv=none; b=G34GT+FtAX3kDp00fcWl1z489t2I04R7jd75arD49+TE3Yf1dr+YE7AfTvO+CgbaW2c2+nWthBa7WJO/FdtgrQmZtZ0fZdns8IN2bz10Q6qF2PyZcNfp2afSnKlbd+cUya0yq3nRB3wbw5mYcLoiCpHTorbIG/WxNP+DdLlgNzM= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1748998486; c=relaxed/simple; bh=dca/qdOQd8trVl3PyThEbwDVoz8kJ2EoR/OfkEaN2sc=; h=From:To:Cc:Subject:Date:Message-Id:In-Reply-To:References: MIME-Version:Content-Type; b=Bbth8JDRND7V3h8AJ5xV746OSCNXXiMQc+17viuc+EPDKZVe/JS+YQeg64PmM0HD7QVlkiFyeEfGtJTXdopHlWbNajCOa29uOnA71YT7Phrrj1ESdlBhQ5XiNT5xr9uUpZTbsVOFZlyYusu/JwW9y9I0n/HdiVQDK4dkZvySrZk= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=dZkvRmpr; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="dZkvRmpr" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 5669CC4CEED; Wed, 4 Jun 2025 00:54:45 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1748998486; bh=dca/qdOQd8trVl3PyThEbwDVoz8kJ2EoR/OfkEaN2sc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=dZkvRmprOMtwj5IYL2zxc8jvbJ/ggZm5MkWh4NW4+Brazawl/1YqpG3kBn0VDDMkR WH61nqXLhVTaHb2BGO0P/h+uVm8ItdPi3QZyZGe4hJF77YliImura8AK0yTMoismup Igj3GHQI3cAIpKizSm35PqNknX/xJox2KCcOw8Mo48IfHQ4zLxDYepMe4i4rRlGwxQ /Nze01I9oX9QsQDaRb7wqfR1BVtTETxm9XG8/nV0yrjbbIuzT1qfKP487u42lzGeMV j2wFNSM2utwjVwT12IT1FI2fDEPLDTe2wQANw2f9C5RSfpjalQPq+O8iWk/97J2BeA p+RvxD6ig7lCw== From: Sasha Levin To: patches@lists.linux.dev, stable@vger.kernel.org Cc: Rand Deeb , Rinitha S , Tony Nguyen , Sasha Levin , przemyslaw.kitszel@intel.com, intel-wired-lan@lists.osuosl.org Subject: [PATCH AUTOSEL 6.15 102/118] ixgbe: Fix unreachable retry logic in combined and byte I2C write functions Date: Tue, 3 Jun 2025 20:50:33 -0400 Message-Id: <20250604005049.4147522-102-sashal@kernel.org> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20250604005049.4147522-1-sashal@kernel.org> References: <20250604005049.4147522-1-sashal@kernel.org> Precedence: bulk X-Mailing-List: patches@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-stable: review X-Patchwork-Hint: Ignore X-stable-base: Linux 6.15 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit From: Rand Deeb [ Upstream commit cdcb3804eeda24d588348bbab6766cf14fddbeaa ] The current implementation of `ixgbe_write_i2c_combined_generic_int` and `ixgbe_write_i2c_byte_generic_int` sets `max_retry` to `1`, which makes the condition `retry < max_retry` always evaluate to `false`. This renders the retry mechanism ineffective, as the debug message and retry logic are never executed. This patch increases `max_retry` to `3` in both functions, aligning them with the retry logic in `ixgbe_read_i2c_combined_generic_int`. This ensures that the retry mechanism functions as intended, improving robustness in case of I2C write failures. Found by Linux Verification Center (linuxtesting.org) with SVACE. Signed-off-by: Rand Deeb Tested-by: Rinitha S (A Contingent worker at Intel) Signed-off-by: Tony Nguyen Signed-off-by: Sasha Levin --- **YES** This commit should be backported to stable kernel trees. Here's my extensive analysis: ## Bug Analysis **Critical Logic Flaw:** The commit fixes a fundamental bug where the retry logic in I2C write functions was completely ineffective. With `max_retry = 1`, the condition `retry < max_retry` would only allow `retry = 0`, meaning the retry loop would never execute more than once, making the entire retry mechanism useless. **Code Impact:** The change from `max_retry = 1` to `max_retry = 3` in both: - `ixgbe_write_i2c_combined_generic_int()` (line ~170) - `ixgbe_write_i2c_byte_generic_int()` (line ~2288) This aligns with the existing `ixgbe_read_i2c_combined_generic_int()` function which already uses `max_retry = 3`. ## Backport Suitability Criteria **1. Fixes Important User-Affecting Bug:** ✓ - I2C write failures directly impact SFP/QSFP module detection and configuration - Affects `ethtool --identify` LED functionality - Can cause intermittent network interface initialization failures - Users would experience unreliable hardware detection and configuration **2. Small and Contained Change:** ✓ - Only changes two integer values from 1 to 3 - No architectural changes or new functionality - Minimal risk of introducing regressions - Affects only the specific I2C write retry mechanism **3. No Side Effects Beyond the Fix:** ✓ - Simply enables existing retry logic to work as intended - Doesn't change the fundamental I2C communication protocol - Maintains consistency with read operations - No new code paths introduced **4. Critical Subsystem Impact:** ✓ - Network driver functionality is critical for system operation - I2C communication is essential for modern network hardware management - Affects Intel ixgbe NICs which are widely deployed in enterprise environments **5. Clear Bug Evidence:** ✓ - Linux Verification Center found this with static analysis (SVACE) - Logic flaw is mathematically provable (retry < 1 never allows retry) - Consistent with similar commits in the pattern (Similar Commit #1 shows retry count adjustments are appropriate for backporting) ## Comparison to Historical Patterns This commit closely matches **Similar Commit #1** (Backport Status: YES) which also modified I2C retry counts in ixgbe. That commit reduced retry counts to avoid regressions, while this one increases retry counts to fix broken logic - both are stability improvements worthy of backporting. Unlike **Similar Commit #2** (Backport Status: NO) which was architectural refactoring, this commit fixes a clear functional defect without introducing new features or code reorganization. ## Risk Assessment **Low Risk:** - Increasing retries from effectively 0 to 3 cannot make things worse - The retry mechanism already existed and was intended to be used - 3 retries aligns with established patterns in the same driver - Intel has tested this change (as indicated by the "Tested- by" tag) **High Impact:** - Fixes complete failure of I2C write retry mechanism - Improves reliability of critical network hardware functionality - Addresses systematic logic flaw affecting all ixgbe deployments This commit represents exactly the type of important, low- risk bug fix that stable trees are designed to receive. drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c b/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c index 0a03a8bb5f886..2d54828bdfbbc 100644 --- a/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c +++ b/drivers/net/ethernet/intel/ixgbe/ixgbe_phy.c @@ -167,7 +167,7 @@ int ixgbe_write_i2c_combined_generic_int(struct ixgbe_hw *hw, u8 addr, u16 reg, u16 val, bool lock) { u32 swfw_mask = hw->phy.phy_semaphore_mask; - int max_retry = 1; + int max_retry = 3; int retry = 0; u8 reg_high; u8 csum; @@ -2285,7 +2285,7 @@ static int ixgbe_write_i2c_byte_generic_int(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr, u8 data, bool lock) { u32 swfw_mask = hw->phy.phy_semaphore_mask; - u32 max_retry = 1; + u32 max_retry = 3; u32 retry = 0; int status; -- 2.39.5