Add README and COPYRIGHT, change the distribution layout

If it's too hard to explain the naming rules to the end users, it's
better to simplify the rules.  Use subdirectories with the version
numbers.

3 files changed, 124 insertions, 2 deletions

diff --git a/fwutils/COPYRIGHT b/fwutils/COPYRIGHT
new file mode 100644
index 0000000..8caeb1d
--- /dev/null
+++ b/fwutils/COPYRIGHT
@@ -0,0 +1,29 @@
+Copyright 2004 Atmel Corporation. All Rights Reserved. Redistribution and use
+of the microcode software ("Firmware") is permitted provided that the following
+conditions are met:
+    1. Firmware is redistributed in object code only.
+    2. Any reproduction of Firmware must contain the above copyright notice,
+	this list of conditions and the below disclaimer in the documentation
+	and/or other materials provided with the distribution; and
+    3. The name of Atmel Corporation may not be used to endorse or promote products
+        derived from this Firmware without specific prior written consent.
+
+DISCLAIMER: ATMEL PROVIDES THIS FIRMWARE "AS IS'' WITH NO WARRANTIES
+OR INDEMNITIES WHATSOEVER. ATMEL EXPRESSLY DISCLAIMS ANY
+EXPRESS, STATUTORY OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL ATMEL
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+FIRMWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+USER ACKNOWLEDGES AND AGREES THAT THE PURCHASE OR USE OF THE
+FIRMWARE WILL NOT CREATE OR GIVE GROUNDS FOR A LICENSE BY
+IMPLICATION, ESTOPPEL, OR OTHERWISE IN ANY INTELLECTUAL PROPERTY
+RIGHTS (PATENT, COPYRIGHT, TRADE SECRET, MASK WORK, OR OTHER
+PROPRIETARY RIGHT) EMBODIED IN ANY OTHER ATMEL HARDWARE OR
+FIRMWARE EITHER SOLELY OR IN COMBINATION WITH THE FIRMWARE.
diff --git a/fwutils/Makefile b/fwutils/Makefile
index bfefcc6..5ddba4e 100644
--- a/fwutils/Makefile
+++ b/fwutils/Makefile
@@ -18,6 +18,8 @@ OLDBINFILES = \
 
 BINFILES = $(NEWBINFILES) $(OLDBINFILES)
 
+DISTFILES = README COPYRIGHT
+
 DISTDIR = at76c503a-firmware-$(VERSION)
 
 
@@ -35,8 +37,13 @@ clean:
 dist: all
 	mkdir $(DISTDIR)
 	cp $(NEWBINFILES) $(DISTDIR)
-	mkdir $(DISTDIR)/old
-	cp $(OLDBINFILES) $(DISTDIR)/old
+	cp $(DISTFILES) $(DISTDIR)
+	for f in $(OLDBINFILES); do \
+		ver=`echo $$f | sed 's/^.*-\([^-]*-[^.]*\)\.bin/\1/'`; \
+		name=`echo $$f | sed 's/-\([^-]*-[^.]*\)\.bin/.bin/'`; \
+		mkdir -p $(DISTDIR)/old/$$ver; \
+		cp $$f $(DISTDIR)/old/$$ver/$$name; \
+	done
 	tar cf - $(DISTDIR) | gzip --best > $(DISTDIR).tar.gz
 	rm -rf $(DISTDIR)
 
diff --git a/fwutils/README b/fwutils/README
new file mode 100644
index 0000000..9ab5517
--- /dev/null
+++ b/fwutils/README
@@ -0,0 +1,86 @@
+Firmware for at76c503a driver
+=============================
+
+
+Copyright
+---------
+
+The firmware is copyrighted by Atmel Corporation.  Please see file
+COPYRIGHT.
+
+
+Purpose
+-------
+
+The included firmware files are intended only for use with Linux
+at76c503a driver.  Every supported device need just one firmware file,
+and the driver knows which firmware to load.
+
+
+Installation
+------------
+
+The firmware is loaded by the kernel using hotplug or udev.  For the
+firmware to be found and loaded, it should be copied to the directory
+where hotplug or udev will find it.
+
+udev supports firmware download starting with version 066.  If an older
+version of udev is installed, then hotplug is likely in change of the
+firmware loading.
+
+If you don't have either of udev or hotplug, please install a recent
+version of udev.
+
+When udev is used, this directory is normally called /lib/firmware.  If
+hotplug is handling the firmware, if would normally look in following
+directories:
+
+  /lib/hotplug/firmware
+  /usr/local/lib/hotplug/firmware
+  /usr/lib/hotplug/firmware
+
+For example, if you determine that the firmware is loaded from
+/lib/firmware, copy the firmware files there as root:
+
+  cp *.bin /lib/firmware
+
+The firmware download is initiated by the driver after it detects the
+appropriate hardware.  No additional scripts or utilities are needed to
+load the firmware.  See kernel log (using the dmesg command) to make
+sure that the firmware download has succeeded.
+
+
+Older firmwares
+---------------
+
+Some older versions of the firmware are included in the "old" directory. 
+The firmware version is the name of the subdirectory under "old".
+
+If for some reason you want to try an older version of the firmware,
+copy it over the firmware used by udev or hotplug and reconnect the
+device.  See kernel messages to make sure the driver is using the
+desired version of the firmware.
+
+
+Contact information
+-------------------
+
+Please don't contact Atmel about this firmware.  Atmel neither wrote the
+at76c503a driver nor packaged this firmware.  Their good will should not
+be punished by misdirected support requests.
+
+Please don't write any individual developers personally.  The driver is
+developed collectively, and the discussion about the driver should be
+open for others.
+
+The mailing list for developers of the at76c503a driver is
+
+  at76c503a-develop@lists.berlios.de
+
+The mailing list for users of the at76c503a driver is
+
+  at76c503a-user@lists.berlios.de
+
+You may also want to download the latest version of the driver and check
+the included documentation, which may be more current than this
+document.