e1000e: provide comment for 82571 workaround

Signed-off-by: Bruce Allan <bruce.w.allan@intel.com>
Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>

1 files changed, 7 insertions, 0 deletions

diff --git a/drivers/net/e1000e/82571.c b/drivers/net/e1000e/82571.c
index 7cdf1768afac..0e8aa3441b97 100644
--- a/drivers/net/e1000e/82571.c
+++ b/drivers/net/e1000e/82571.c
@@ -1114,6 +1114,13 @@ static void e1000_initialize_hw_bits_82571(struct e1000_hw *hw)
                 reg |= (1 << 22);
                 ew32(GCR, reg);
 
+                /*
+                 * Workaround for hardware errata.
+                 * apply workaround for hardware errata documented in errata
+                 * docs Fixes issue where some error prone or unreliable PCIe
+                 * completions are occurring, particularly with ASPM enabled.
+                 * Without fix, issue can cause tx timeouts.
+                 */
                 reg = er32(GCR2);
                 reg |= 1;
                 ew32(GCR2, reg);