ThinkWiki - User contributions [en]

Problem with e1000: EEPROM Checksum Is Not Valid

2008-02-25T17:16:27Z

Andrz: /* Solutions */ Added Auke Kok's patches.

== Problem Description ==
On certain ThinkPads, [[e1000]] driver for [[Ethernet_Controllers#Intel_Gigabit_.2810.2F100.2F1000.29|Intel Gigabit controller]] fails to load with the following error message in /var/log/messages:

<pre>
e1000: 0000:02:00.0: e1000_probe: The EEPROM Checksum Is Not Valid
e1000: probe of 0000:02:00.0 failed with error -5
</pre>

The problem is caused by a power savings feature obstructing normal operation, and causes the first bytes read from the EEPROM to be corrupt, resulting in a random or invalid MAC address (but no other data corruption). The EEPROM checksum test traps the problem and the driver refuses to load.

== Solutions ==

Try to reload the e1000 module until the ethernet is pluged in, and the hardware have a chance to detect a link.

=== Use e1000e---Kernel Patch ===
Auke Kok published two patches in October 2007 that help solve both the "corrupted" EEPROM read and bad latency.
One of the patches moves many network cards over to the e1000e (e1000 for PCI-Express) module. The second disables some PCIe power management features that were the cause for the bad EEPROM read and some stability issues.
[http://kerneltrap.org/mailarchive/linux-netdev/2007/10/31/374579 <nowiki>[PATCH 3/4] e1000/e1000e: Move PCI-Express device IDs over to e1000e</nowiki>]
[http://kerneltrap.org/mailarchive/linux-netdev/2007/10/31/374573 <nowiki>[PATCH 2/4] e1000e: Disable L1 ASPM power savings for 82573 mobile variants</nowiki>]
Refer to [http://www.linuxhq.com/patch-howto.html LinuxHQ] on how to apply kernel patches.

=== From Lenovo ===
Lenovo provides a [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-67166 script] that uses 'ethtool' command to update the card's settings. They say it is for SLED 10 but the Linux flavor shouldn't really matter. For some users, neither of the circumventions listed below help, but this script does!

=== Via module parameter ===

In recent kernels (at least with 2.6.22, maybe also in 2.6.21) there is a kernel module option to make the module ignore the error.

Load the module like this
<pre>
modprobe e1000 eeprom_bad_csum_allow=1
</pre>

You might also apply that parameter via modprobe.d or if you are using Debian/Ubuntu as append-line in your bootloader: e1000.eeprom_bad_csum_allow=1

=== From Mat's Blog ===
The fundamental solution is explained at [http://www.matinfo.ch/blog/archive/2007/01/26/intel-nic-pxe-e05-error.html Mat's Blog]
which directs the reader to Intel's site to download [http://downloadcenter.intel.com/detail_desc.aspx?agr=Y&ProductID=412&DwnldID=8242&lang=eng PROBOOT.EXE].
Extract files from PROBOOT.EXE onto a bootable DOS device. Boot from it. Then run the command "IBAUTIL -DEFCFG"

---

After IBAUTIL -DEFCFG, you may have your mac address changed. Then you can update it with the real one with a dos binary to put an a bootable cd : EEUPDATE.EXE
For example, EEUPDATE /NIC=1 /MAC=XX:XX:XX:XX:XX:XX. Then, no more "invalid mac address" message using linux and no need to use MACAddressChanger for windows :)

Where you can find this magic tool : ftp://ftp.extensa.ru/Drivers/DESKTOPS/Ver_x900/BIOS_XP/AMT/

---

== Circumvention ==

* Upgrade your BIOS

Lenovo has published newer BIOS revisions that appear to fix the issue for some users. The BIOS upgrade turns off "Deep smart power down" which has been known to cause issues at initialization time (the driver can re-enable the issue later if you desire, the feature works correctly then).

* Insert a cable

Inserting a linked network cable bypasses the problem.

* Take the checksum twice

This [http://sourceforge.net/tracker/index.php?func=detail&aid=1474679&group_id=42302&atid=447449 bug report] describes a fix -- take the checksum twice. First time will report a bad checksum, second will work (the problem seems to be triggered by some power-saving technology). This requires a tweak to the driver source and a rebuild of your kernel. This is much better than a previous "fix" published here that disabled checksum checking entirely.

I updated the patch above to 2.6.22:
<pre>
diff -urN linux-2.6.22-suspend2-r1.orig/drivers/net/e1000/e1000_main.c linux-2.6.22-suspend2-r1/drivers/net/e1000/e1000_main.c
--- linux-2.6.22-suspend2-r1.orig/drivers/net/e1000/e1000_main.c 2007-08-17 23:32:04.000000000 +0200
+++ linux-2.6.22-suspend2-r1/drivers/net/e1000/e1000_main.c 2007-09-05 16:39:11.000000000 +0200
@@ -999,16 +999,18 @@
goto err_eeprom;
}

- /* before reading the EEPROM, reset the controller to
- * put the device in a known good starting state */
-
- e1000_reset_hw(&adapter->hw);
-
- /* make sure the EEPROM is good */
-
if (e1000_validate_eeprom_checksum(&adapter->hw) < 0) {
- DPRINTK(PROBE, ERR, "The EEPROM Checksum Is Not Valid\n");
- goto err_eeprom;
+ /* before reading the EEPROM, reset the controller to
+ * put the device in a known good starting state */
+
+ e1000_reset_hw(&adapter->hw);
+
+ /* make sure the EEPROM is good */
+
+ if (e1000_validate_eeprom_checksum(&adapter->hw) < 0) {
+ DPRINTK(PROBE, ERR, "The EEPROM Checksum Is Not Valid\n");
+ goto err_eeprom;
+ }
}

/* copy the MAC address out of the EEPROM */
</pre>
[[User:Ra|Ra]] 15:28, 5 September 2007 (UTC)

* Remove/add kernel module

Removing and adding the kernel module is a possible work-around. As root, run

<pre>
# modprobe -r e1000
# modprobe e1000
</pre>

On some occasions, the commands have to be run twice before eth0 becomes useable.
On some X60s this will not work at all.

* Disabling and re-enabling the NIC in the BIOS

For some it fixed the issue finally, for some it helped just temporarily.

* Hacking the kernel to carry on even if the checksum is not valid

Although being a very ugly, hack, this works fine for me. To do that, you have to search drivers/net/e1000/e1000_main.c for the line containing the error message and then comment out the following two lines which set the error state and then jump to the error code. Although this doesn't fry the hardware for me, consider yourself warned...

== See also ==

* [http://www-307.ibm.com/pc/support/site.wss/document.do?sitestyle=lenovo&lndocid=MIGR-67166 Lenovo's solution]
* [http://sourceforge.net/tracker/index.php?func=detail&aid=1474679&group_id=42302&atid=447449 bug report] submitted for e1000 driver.
* Discussion at [http://forums.gentoo.org/viewtopic-t-476305-highlight-e1000.html Gentoo forums]

Code/thinkpad-smapi.sh

2007-06-01T12:57:40Z

Andrz: -c option in shebang is unnecessary.

#!/bin/bash
# Copyright (C) 2007 William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
# This file is licensed under the GPL v2. E-mail me if you have any ideas of
# other licenses to use (BSD, GPL v3, Public Domain, etc.), I'm open :)

# IDEAS
# - make an ncurses interface, and also maybe gtk+ and qt
# - add option to enable modifying the charge control variables

TP_SMAPI_BASE=/sys/devices/platform/smapi

# function to simplify reading from files
# syntax: read_file <variable> <filename> <check_return_value 0/1> <translate 0/1> [[value] [translation_string]]
read_file()
{
local VARIABLE
local FILENAME
local CHECK_RETURN
local TRANSLATE
local VAL
local RET

VARIABLE="$1"; shift
FILENAME="$1"; shift
CHECK_RETURN="$1"; shift
TRANSLATE="$1"; shift

VAL=`cat "$FILENAME" 2> /dev/null`
RET=$?

if [[ "$CHECK_RETURN" == "1" ]] && [[ $RET -gt 0 ]]
then
RESULT="[unavailable]"
elif [ "$TRANSLATE" == "1" ]
then
RESULT="unknown ($RET)"
while [ -n "$1" ]
do
if [ "$VAL" == "$1" ]
then
RESULT="$2"
break
fi
shift 2
done
else
RESULT="$VAL"
fi

eval "$VARIABLE="'"'"$RESULT"'"'
# eval "$VARIABLE=$RESULT"
}

give_units()
{
local VARIABLE
local UNIT
local VALUE
local RESULT

VARIABLE="$1"
UNIT="$2"
eval "VALUE=\$$VARIABLE"

if (echo "$VALUE" | grep -qs "^-\?[0-9]")
then
RESULT="$VALUE $UNIT"
else
RESULT="$VALUE"
fi

eval "$VARIABLE="'"'"$RESULT"'"'
}

replace_val()
{
local VARIABLE
local OLD_VALUE
local NEW_VALUE
local VALUE
local RESULT

VARIABLE="$1"
OLD_VALUE="$2"
NEW_VALUE="$3"

eval "VALUE=\$$VARIABLE"

if [ "$VALUE" == "$OLD_VALUE" ]
then
RESULT="$NEW_VALUE"
else
RESULT="$VALUE"
fi

eval "$VARIABLE="'"'"$RESULT"'"'
}

show_help()
{
cat << EOF

thinkpad-smapi.sh - Show SMAPI information on ThinkPad laptops, through
the exported SMAPI information by the tp_smapi module.

-a Show all available information
-b [n] Show all available information for battery [n]
-h Show this help text
-m Show miscellaneous information

EOF
}

show_misc()
{
cd $TP_SMAPI_BASE

read_file PCI_POWER_SAVINGS "enable_pci_power_saving_on_boot" 1 1 1 "enabled" 0 "disabled"
read_file AC_ADAPTER "ac_connected" 1 1 1 "connected" 0 "disconnected"

cat << EOF
MISCELLANEOUS INFORMATION
=========================

PCI power savings on boot: $PCI_POWER_SAVINGS
AC adapter status: $AC_ADAPTER

EOF
}

show_batt()
{
SLOT=$1
cd $TP_SMAPI_BASE/BAT$SLOT

TMP=`cat installed`
if [ $TMP -eq 1 ]
then
BATT_INSTALLED="yes"
else
BATT_INSTALLED="no"
fi

BATT_STATE=`cat state`

if [ $BATT_INSTALLED == "yes" ]
then

read_file BARCODING "barcoding" 1 0
read_file BATT_CHEMISTRY "chemistry" 1 0
read_file DESIGN_CAPACITY "design_capacity" 1 0
read_file DESIGN_VOLTAGE "design_voltage" 1 0
read_file MANUFACTURE_DATE "manufacture_date" 1 0
read_file BATT_FRU "model" 1 0
read_file MANUFACTURER "manufacturer" 1 0
read_file BATT_SERIAL "serial" 1 0

read_file FIRST_USE_DATE "first_use_date" 1 0
read_file CYCLE_COUNT "cycle_count" 1 0
read_file LAST_FULL_CAPACITY "last_full_capacity" 1 0
read_file CURRENT_1MIN "current_avg" 1 0
read_file POWER_1MIN "power_avg" 1 0

read_file CAPACITY_MWH "remaining_capacity" 1 0
read_file CAPACITY_PERCENT "remaining_percent" 1 0
read_file REMAINING_RUNNING_TIME "remaining_running_time" 1 0
read_file CURRENT_NOW "current_now" 1 0
read_file POWER_NOW "power_now" 1 0
read_file BATT_TEMPERATURE "temperature" 1 0
read_file BATT_VOLTAGE "voltage" 1 0
read_file REMAINING_CHARGING_TIME "remaining_charging_time" 1 0

# fixups
give_units DESIGN_CAPACITY "mWh"
give_units DESIGN_VOLTAGE "mV"
give_units CURRENT_NOW "mA"
give_units POWER_NOW "mW"
give_units CURRENT_1MIN "mA"
give_units POWER_1MIN "mW"
give_units LAST_FULL_CAPACITY "mWh"
give_units REMAINING_RUNNING_TIME "min"
give_units REMAINING_CHARGING_TIME "min"
give_units CAPACITY_PERCENT "%"
give_units BATT_TEMPERATURE "mC"
give_units BATT_VOLTAGE "mV"

# some more
replace_val REMAINING_RUNNING_TIME "not_discharging" "[not discharging]"
replace_val REMAINING_CHARGING_TIME "not_charging" "[not charging]"

else

BATT_FRU=
MANUFACTURER=
BATT_SERIAL=
BARCODING=
BATT_CHEMISTRY=
DESIGN_CAPACITY=
DESIGN_VOLTAGE=
MANUFACTURE_DATE=

FIRST_USE_DATE=
CYCLE_COUNT=
LAST_FULL_CAPACITY=
CURRENT_1MIN=
POWER_1MIN=

CAPACITY_MWH=
CAPACITY_PERCENT=
REMAINING_RUNNING_TIME=
CURRENT_NOW=
POWER_NOW=
BATT_TEMPERATURE=
BATT_VOLTAGE=
REMAINING_CHARGING_TIME=

fi

read_file START_CHARGE_THRESH "start_charge_thresh" 1 0
read_file STOP_CHARGE_THRESH "stop_charge_thresh" 1 0
read_file INHIBIT_CHARGE_MIN "inhibit_charge_minutes" 1 0
read_file BATT_FORCE_DISCHARGE "force_discharge" 1 1 1 "yes" 0 "no"

# installed*, state*, dump
# barcoding, chemistry, design_capacity, design_voltage, manufacture_date, model, manufacturer, serial
# first_use_date, cycle_count, last_full_capacity, current_avg, power_avg
# remaining_capacity, remaining_percent, remaining_running_time, current_now, power_now, temperature, voltage, remaining_charging_time
# start_charge_thresh*, stop_charge_thresh*, inhibit_charge_minutes*, force_discharge*

cat << EOF
BATTERY $SLOT INFORMATION
=====================

Battery slot:
Battery present: $BATT_INSTALLED
Battery state: $BATT_STATE

EOF

if [ "$BATT_INSTALLED" == "yes" ]
then
cat << EOF
Embedded info:
FRU P/N: $BATT_FRU
Barcoding: $BARCODING
Serial number: $BATT_SERIAL
OEM Manufacturer: $MANUFACTURER
Chemistry: $BATT_CHEMISTRY
Manufacture date: $MANUFACTURE_DATE
Design capacity & voltage: $DESIGN_CAPACITY, $DESIGN_VOLTAGE

Battery health:
First use date: $FIRST_USE_DATE
Cycle count: $CYCLE_COUNT
Last full capacity: $LAST_FULL_CAPACITY
Average current / power (past 1 minute): $CURRENT_1MIN, $POWER_1MIN

Battery status:
Remaining capacity: $CAPACITY_MWH mWh ($CAPACITY_PERCENT)
Remaining running time: $REMAINING_RUNNING_TIME
Running current & power: $CURRENT_NOW, $POWER_NOW
Temperature: $BATT_TEMPERATURE
Voltage: $BATT_VOLTAGE
Remaining charging time: $REMAINING_CHARGING_TIME

EOF
fi

cat << EOF
Battery charging control:
Start charging at: $START_CHARGE_THRESH %
Stop charging at: $STOP_CHARGE_THRESH %
Prevent charging for: $INHIBIT_CHARGE_MIN min
Force battery discharge: $BATT_FORCE_DISCHARGE

EOF
}

SHOW_ALL=
SHOW_BATT=
SHOW_MISC=
GOT_OPTS=

while getopts ab:hm OPT
do
GOT_OPTS=y
case ${OPT} in
a) SHOW_ALL=y;;
b) if [ ${OPTARG} -eq 0 -o ${OPTARG} -eq 1 ]
then
SHOW_BATT=${OPTARG}
else
SHOW_BATT=y
fi
;;
h) show_help
exit 0
;;
m) SHOW_MISC=y;;
\?) show_help
exit 1
;;
esac
done

if [ "$GOT_OPTS" != y ]
then
show_help
exit 1
fi

if [ "$SHOW_ALL" == y ]
then
show_misc
show_batt 0
show_batt 1
else
if [ -n "$SHOW_MISC" ]
then
show_misc
fi
if [ -n "$SHOW_BATT" ]
then
show_batt $SHOW_BATT
fi
fi