Add new testing framework along with a few micro-tests.

util/wp-range.sh

Index: util/wp-range.sh
diff --git a/util/wp-range.sh b/util/wp-range.sh
new file mode 100755
index 0000000000000000000000000000000000000000..b823bf3c00aaecb095e7dfe6adf552b4fc64c91e
--- /dev/null
+++ b/util/wp-range.sh
@@ -0,0 +1,76 @@
+#!/bin/sh
+#
+# Copyright (C) 2010 Google Inc.
+# Written by David Hendricks for Google Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+
+# Assume we can set a write protect range for 0-64KB
+# This assumes the output from wp-status is:
+# "some text ... start=0x00000000, len=0x00010000"
+# where the start and length are key=value pairs
+
+# FIXME: Should we intentionally disable write protection for this? The
+# status register will not be changeable if hardware WP is in effect.
+# Then again, if hardware WP is on, then we won't be able to disable WP
+# either...
+
+LOGFILE="${0}.log"
+NEW_WP_RANGE_START=0x000000
+NEW_WP_RANGE_LEN=0x010000
+
+# Back-up old settings
+tmp=$(./flashrom ${FLASHROM_PARAM} --wp-status 2>/dev/null)
+old_start=${tmp##*start=}
+old_start=`printf "%s" "${old_start%%,*}"`
+
+old_len=${tmp##*len=}
+old_len=`printf "%s" "${old_len%%,*}"`
+echo "old start: ${old_start}, old length: ${old_len}" >> ${LOGFILE}
+
+# If the old write protection settings are the same as the new ones, we need
+# to choose new values. If this is the case, we'll extend the range to the
+# next 64K block.

[hailfinger, 2010/11/23 20:05:34]

That won't work for most flash chips because each vendor has another protection
scheme, and many only have a all-or-nothing protection.

[Stefan Reinauer, 2010/11/23 21:14:14]

Oh.. would we want some flashrom function to dump blocks and/or protection
blocks?

[dhendrix, 2010/11/24 02:48:14]

Correct -- This is sort of a crappy method that will only work for some of the
more recent flash chips with fine-grained block protection.

As Stefan pointed out, the long-term solution is to implement a "--wp-list"
command to list valid write protection values and then pick one that is not
currently in use.

+if [ $((${old_start} == ${NEW_WP_RANGE_START})) -ne 1 ] && [ $((${old_len} == ${NEW_WP_RANGE_LEN})) -ne 1 ] ; then
+	NEW_WP_RANGE_LEN=$((${NEW_WP_RANGE_LEN} + 0x10000}))
+fi
+
+# Try to set new range values
+echo "attempting to set write protect range: start=${NEW_WP_RANGE_START} ${NEW_WP_RANGE_LEN}" >> ${LOGFILE}
+./flashrom ${FLASHROM_PARAM} --wp-range ${NEW_WP_RANGE_START} ${NEW_WP_RANGE_LEN} 2>/dev/null
+if [ ${?} -ne ${EXIT_SUCCESS} ]; then
+	echo -n "failed to set write protect range" >> ${LOGFILE}
+	return ${EXIT_FAILURE}
+fi
+
+tmp=$(./flashrom ${FLASHROM_PARAM} --wp-status 2>/dev/null)

[hailfinger, 2010/11/23 20:05:34]

You only check that the printed range and the requested range are identical. If
the range encoding is incorrect, this test will still succeed.

[dhendrix, 2010/11/24 02:48:14]

Yeah :-/ For all this test is concerned, one could hard code a range to print
from within flashrom without touching the chip.

I added a #FIXME comment near the top to remind us to revisit this.

+new_start=${tmp##*start=}
+new_start=`printf "%s" "${new_start%%,*}"`
+
+new_len=${tmp##*len=}
+new_len=`printf "%s" "${new_len%%,*}"`
+
+if [ $((${new_start} == ${NEW_WP_RANGE_START})) -ne 1 ]; then return ${EXIT_FAILURE} ; fi
+if [ $((${new_len} == ${NEW_WP_RANGE_LEN})) -ne 1 ]; then return ${EXIT_FAILURE} ; fi
+
+# restore the old settings
+./flashrom ${FLASHROM_PARAM} --wp-range ${old_start} ${old_len} 2>/dev/null
+if [ ${?} -ne ${EXIT_SUCCESS} ]; then
+	echo "failed to restore old settings" >> ${LOGFILE}
+	return ${EXIT_FAILURE}
+fi
+
+echo "$0: passed" >> ${LOGFILE}
+return ${EXIT_SUCCESS}