sysclk-lwla: Add bitstream extraction utility for the LWLA1034.
authorDaniel Elstner <daniel.kitta@gmail.com>
Mon, 13 Jan 2014 22:59:30 +0000 (23:59 +0100)
committerDaniel Elstner <daniel.kitta@gmail.com>
Tue, 14 Jan 2014 00:49:24 +0000 (01:49 +0100)
firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034 [new file with mode: 0755]
firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034.1 [new file with mode: 0644]

diff --git a/firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034 b/firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034
new file mode 100755 (executable)
index 0000000..c9e261e
--- /dev/null
@@ -0,0 +1,41 @@
+#! /bin/sh -e
+##
+## This file is part of the sigrok-util project.
+##
+## Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com>
+##
+## 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 3 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, see <http://www.gnu.org/licenses/>.
+##
+
+infile=$1
+if [ -z "$infile" ]; then
+    echo "Usage: $0 SETUP-EXE" >&2
+    exit 1
+fi
+
+# Verify the checksum to make sure this is the right binary file
+expectsum=f2a9333329200ad1d939d051257f914200cf0c765ff4962b2907dcf30716f455
+set '' $(sha256sum -b "$infile")
+
+if [ "$2" != "$expectsum" ]; then
+    echo "$0: checksum mismatch for '$infile'" >&2
+    echo "$0: make sure you picked the right file (lwla1034_EN_setup.exe on the CD-ROM)" >&2
+    exit 1
+fi
+
+# Extract the firmware binaries from the executable
+dd bs=1 skip=34110338 count=78398 if="$infile" of=sysclk-lwla1034-int.bitstream
+dd bs=1 skip=34266237 count=78247 if="$infile" of=sysclk-lwla1034-extpos.bitstream
+dd bs=1 skip=34344484 count=79145 if="$infile" of=sysclk-lwla1034-extneg.bitstream
+dd bs=1 skip=34578631 count=48525 if="$infile" of=sysclk-lwla1034-off.bitstream
diff --git a/firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034.1 b/firmware/sysclk-lwla/sigrok-fwextract-sysclk-lwla1034.1
new file mode 100644 (file)
index 0000000..825c301
--- /dev/null
@@ -0,0 +1,33 @@
+.TH SIGROK\-FWEXTRACT\-SYSCLK\-LWLA1034 1 "Jan 04, 2014"
+.SH "NAME"
+sigrok\-fwextract\-sysclk\-lwla1034 \- Extract SysClk LWLA1034 firmware
+.SH "SYNOPSIS"
+.B sigrok\-fwextract\-sysclk\-lwla1034 SETUP-EXE
+.SH "DESCRIPTION"
+This tool extracts FPGA bitstreams from the vendor software for the SysClk
+LWLA1034 USB logic analyzer. Insert the CD-ROM that ships with the device,
+and locate the Windows installer executable "lwla1034_EN_setup.exe".
+.PP
+In order to extract the bitstreams, run the following command:
+.PP
+.B "  $ sigrok-fwextract-sysclk-lwla1034 lwla1034_EN_setup.exe"
+.PP
+Copy the resulting four bitstream files over to the location where libsigrok
+expects to find its firmware files. By default this is
+.BR /usr/local/share/sigrok-firmware .
+.SH OPTIONS
+None.
+.SH "EXIT STATUS"
+Exits with 0 on success, 1 on most failures.
+.SH "SEE ALSO"
+\fBsigrok\-fwextract\-hantek\-dso\fP(1)
+.SH "BUGS"
+Please report any bugs via Bugzilla
+.RB "(" http://sigrok.org/bugzilla ")"
+or on the sigrok\-devel mailing list
+.RB "(" sigrok\-devel@lists.souceforge.net ")."
+.SH "LICENSE"
+This program is covered by the GNU General Public License (GPL),
+version 3 or later.
+.SH "AUTHORS"
+Please see the individual source code files.