Commit: fdc895d636cc81641342c8bbe5e117b75edd3021 - gsl-firmware (git)

Firmware of Silead Touchscreen Controller for Jumper EZpad 6 Pro.

Commit MetaInfo

• Révision: fdc895d636cc81641342c8bbe5e117b75edd3021 (tree)
• l'heure: 2017-04-19 15:31:44
• Auteur: Gregor Riepl <onitake@gmai...>
• Commiter: Gregor Riepl

Message de Log

WIP rewrite of fwtool and the Perl lib

Change Summary

• modified: tools/Firmware/Silead.pm
• modified: tools/fwtool

Modification

--- a/tools/Firmware/Silead.pm
+++ b/tools/Firmware/Silead.pm
@@ -2,11 +2,58 @@ package Firmware::Silead;
 
 use strict;
 use IO::File;
+use IO::Scalar;
 
 our $MAGIC = 'GSLX';
 our $FORMAT = 1;
 our $HEADER_SIZE = 24;
 our $PAGE_SIZE = 132;
+our %formats = (
+	'new' => {
+		'load' => sub {
+			$_[0]->load_new($_[1])
+		},
+		'save' => sub {
+			$_[0]->save_new($_[1]);
+		},
+		'test' => sub {
+			return defined Firmware::Silead->load_new($_[0]);
+		},
+	},
+	'header' => {
+		'load' => sub {
+			$_[0]->load_header($_[1])
+		},
+		'save' => sub {
+			$_[0]->save_header($_[1]);
+		},
+		'test' => sub {
+			return defined Firmware::Silead->load_header($_[0]);
+		},
+	},
+	'win' => {
+		'load' => sub {
+			$_[0]->load_win($_[1])
+		},
+		'save' => sub {
+			$_[0]->save_win($_[1]);
+		},
+		'test' => sub {
+			return defined Firmware::Silead->load_win($_[0]);
+		},
+	},
+	'old' => {
+		'load' => sub {
+			$_[0]->load_old($_[1])
+		},
+		'save' => sub {
+			$_[0]->save_old($_[1]);
+		},
+		'test' => sub {
+			return defined Firmware::Silead->load_old($_[0]);
+		},
+	},
+};
 
 sub _unpack_header {
 	my ($header) = @_;
@@ -40,18 +87,50 @@ sub new {
 		xmirrored => 0,
 		ymirrored => 0,
 		tracking => 0,
-	}, ref $class ? ref $class : $class;
+		format => undef,
+		config => [ (0) x 512 ],
+	}, ref $class || $class;
 }
 
 sub load {
-	my ($class, $handle) = @_;
+	my ($class, $handle, $type) = @_;
 	if (!ref $handle) {
 		$handle = IO::File->new($handle, 'r');
 	}
 	if (!defined $handle) {
-		$@ = "Invalid file handle";
+		$@ = "File name or handle required";
+		return undef;
+	}
+	if (!defined $type or $type eq 'auto') {
+		my $here = $handle->tell();
+		for my $format (keys(%formats)) {
+			if (!$handle->seek($here, 0)) {
+				$@ = "A seekable file handle is required for format autodetection";
+				return undef;
+			}
+			my $self = $class->new();
+			if ($formats{$format}->load($self, $handle)) {
+				return $self;
+			}
+		}
+		$@ = "Format autodetection failed";
+		return undef;
+	} else {
+		if (!defined $formats{$type}) {
+			$@ = "Invalid type";
+			return undef;
+		}
+		my $self = $class->new();
+		if ($formats{$type}->load($self, $handle)) {
+			return $self;
+		}
+		$@ = "Invalid data for format";
 		return undef;
 	}
+}
+
+sub load_new {
+	my ($self, $handle) = @_;
 	binmode $handle;
 	read $handle, my $header, $HEADER_SIZE;
 	my ($magic, $model, $format, $touches, $width, $height, $swapped, $xmirrored, $ymirrored, $tracking, $pages) = _unpack_header $header;
@@ -63,17 +142,16 @@ sub load {
 		$@ = "Invalid file format $format";
 		return undef;
 	}
-	my $self = bless {
-		pages => { },
-		model => $model,
-		touches => $touches,
-		width => $width,
-		height => $height,
-		swapped => $swapped,
-		xmirrored => $xmirrored,
-		ymirrored => $ymirrored,
-		tracking => $tracking,
-	}, ref $class ? ref $class : $class;
+	$self->{pages} = { };
+	$self->{model} = $model;
+	$self->{touches} = $touches;
+	$self->{width} = $width;
+	$self->{height} = $height;
+	$self->{swapped} = $swapped;
+	$self->{xmirrored} = $xmirrored;
+	$self->{ymirrored} = $ymirrored;
+	$self->{tracking} = $tracking;
+	$self->{config} = [ (0) x 512 ];
 	for (my $i = 0; $i < $pages; $i++) {
 		read $handle, my $buffer, $PAGE_SIZE;
 		my ($address, $size, $data) = _unpack_page $buffer;
@@ -81,11 +159,12 @@ sub load {
 			return undef;
 		}
 	}
+	$self->{format} = 'new';
 	return $self;
 }
 
 sub save {
-	my ($self, $handle) = @_;
+	my ($self, $handle, $type) = @_;
 	if (!ref $handle) {
 		$handle = IO::File->new($handle, 'w');
 	}
@@ -93,6 +172,22 @@ sub save {
 		$@ = "Invalid file handle";
 		return 0;
 	}
+	if (!defined $type or $type eq 'copy') {
+		if (!defined $self->{format}) {
+			$@ = "Source format unknown, can't copy";
+			return 0;
+		}
+		$type = $self->{format};
+	}
+	if (!defined $formats{$type}) {
+		$@ = "Invalid format $type";
+		return 0;
+	}
+	return $formats{$type}->save($self, $handle);
+}
+
+sub save_new {
+	my ($self, $handle) = @_;
 	binmode $handle;
 	my @pages = $self->get_pages;
 	my $header = _pack_header $self->model, $self->touches, $self->width, $self->height, $self->swapped, $self->xmirrored, $self->ymirrored, $self->tracking, scalar(@pages);
@@ -106,7 +201,10 @@ sub save {
 }
 
 sub unpack {
-	my ($class, $data) = @_;
+	my ($self, $data) = @_;
+	if (!ref $self) {
+		$self = $self->new();
+	}
 	my $header = substr $data, 0, $HEADER_SIZE;
 	my ($magic, $model, $format, $touches, $width, $height, $swapped, $xmirrored, $ymirrored, $tracking, $pages) = _unpack_header $header;
 	if ($magic ne $MAGIC) {
@@ -117,17 +215,16 @@ sub unpack {
 		$@ = "Invalid file format $format";
 		return undef;
 	}
-	my $self = bless {
-		pages => { },
-		model => $model,
-		touches => $touches,
-		width => $width,
-		height => $height,
-		swapped => $swapped,
-		xmirrored => $xmirrored,
-		ymirrored => $ymirrored,
-		tracking => $tracking,
-	}, ref $class ? ref $class : $class;
+	$self->{pages} = { };
+	$self->{model} = $model;
+	$self->{touches} = $touches;
+	$self->{width} = $width;
+	$self->{height} = $height;
+	$self->{swapped} = $swapped;
+	$self->{xmirrored} = $xmirrored;
+	$self->{ymirrored} = $ymirrored;
+	$self->{tracking} = $tracking;
+	$self->{config} = [ (0) x 512 ];
 	for (my $i = 0; $i < $pages; $i++) {
 		my $buffer = substr $HEADER_SIZE + $i * $PAGE_SIZE, $PAGE_SIZE;
 		my ($address, $size, $data) = _unpack_page $buffer ;
@@ -152,37 +249,101 @@ sub pack {
 	return $data;
 }
 
-sub import_scrambled {
+sub load_win {
 	my ($self, $input) = @_;
 	my $tscfg = '';
 	for my $byte (split //, $input) {
 		my $descrambled = chr(ord($byte) ^ 0x88);
 		$tscfg .= $descrambled;
 	}
-	return $self->import_tscfg($tscfg);
+	my $ret = $self->load_header($tscfg);
+	$self->{format} = 'win';
+	return $ret;
+}
+
+sub save_win {
+	my ($self) = @_;
+	my $tscfg = $self->save_header;
+	my $scrambled = '';
+	for my $byte (split //, $tscfg) {
+		$scrambled .= chr(ord($byte) ^ 0x88);
+	}
+	return $scrambled;
 }
 
-sub import_tscfg {
+sub load_header {
 	my ($self, $input) = @_;
 	my ($cfg, $fw) = (0, '');
+	my @config;
 	for my $line (split /\n/, $input) {
-		if ($cfg and $line =~ /};/) {
+		if ($cfg > 0 and $line =~ /};/) {
 			$cfg = 0;
 		}
 		if ($line =~ /TS_CFG_DATA|GSLX68X_FW/) {
 			$cfg = 1;
 		}
-		if ($cfg) {
+		if ($cfg == 0 and $line =~ /gsl_config_data_id/) {
+			$cfg = 2;
+		}
+		if ($cfg == 1) {
 			$line =~ s/\s//g;
-			$line = lc($line);
+			$line = lc $line;
 			if ($line =~ /{0x([0-9a-f]+),0x([0-9a-f]+)},/) {
-				my $address = hex($1);
-				my $data = hex($2);
+				my $address = hex $1;
+				my $data = hex $2;
 				$fw .= pack '(LL)<', $address, $data;
 			}
+		} elsif ($cfg == 2) {
+			$line =~ s/\s//g;
+			$line =~ s#//.*$##;
+			$line = lc $line;
+			for my $str (split(',', $line)) {
+				if ($str =~ /0x([a-f0-9]+)/) {
+					my $value = unpack 'H*', $1;
+					push @config, $value;
+				} elsif ($str =~ /([a-f0-9]+)/) {
+					my $value = int $1;
+					push @config, $value;
+				}
+			}
+		}
+	}
+	if (@config != 512) {
+		warn "Ignoring invalid config block";
+	} else {
+		$self->{config} = \@config;
+	}
+	my $ret = $self->import_fw($fw);
+	$self->{format} = 'win';
+	return $ret;
+}
+
+sub save_header {
+	my ($self) = @_;
+	my $tscfg = '';
+	$tscfg .= "\n";
+	$tscfg .= "unsigned int gsl_config_data_id[512]=\n";
+	$tscfg .= "{\n";
+	for (my $offset = 0; $offset < @{$self->{config}}; $offset += 4) {
+		$tscfg .= sprintf "\t0x%08x,0x%08x,0x%08x,0x%08x,\n", $self->{config}->[$offset..($offset+3)];
+	}
+	$tscfg .= "};\n";
+	$tscfg .= "TS_CFG_DATA GSL_TS_CFG[] =  {\n";
+	$tscfg .= "\n";
+	my @pages = $self->get_pages;
+	for my $page (@pages) {
+		my $pagedata = $self->get_page($page);
+		$tscfg .= sprintf "{0x%02x,0x%02x}\n", 0xf0, $page;
+		my $length = length $pagedata;
+		for (my $offset = 0; $offset + 3 < $length; $offset += 4) {
+			my $word = substr $pagedata, $offset, 4;
+			my $value = unpack '(L)<', $word;
+			$tscfg .= sprintf "{0x%02x,0x%08x}\n", $offset, $value;
 		}
 	}
-	return $self->import_fw($fw);
+	$tscfg .= "\n";
+	$tscfg .= "};\n";
+	return $tscfg;
 }
 
 sub import_fw {

--- a/tools/fwtool
+++ b/tools/fwtool
@@ -9,81 +9,62 @@ use lib dirname (__FILE__);
 use Firmware::Silead;
 
 sub usage() {
-	print STDERR "Usage: fwtool {-i | -c <original.fw> | -s | -x <legacy.fw>} [ -1 | -2 | -3 ] [-w <width>] [-h <height>] [-t <num_touches>] [-f <flags>] <firmware.fw>\n";
-	print STDERR "-i    Prints statistics and information about new-style firmware.fw\n";
-	print STDERR "-c    Converts any older firmware format into new-style firmware.fw\n";
-	print STDERR "-s    Sets parameters and flags\n";
-	print STDERR "-x    Exports a firmware into plain format, to use with other Linux/Android drivers\n";
-	print STDERR "      The source firmware format can be specified with these parameters:\n";
-	print STDERR "-1    Plain firmware, as used with the Android driver (default)\n";
-	print STDERR "-2    Windows GSL_TS_CFG.h firmware\n";
-	print STDERR "-3    Scrambled Windows SileadTouch.fw firmware\n";
-	print STDERR "      For the -c and -s modes, the following parameters may be set:\n";
-	print STDERR "-m    Sets the controller model (4-byte ASCII string, ex.: 1680)\n";
-	print STDERR "-w    Sets the width parameter\n";
-	print STDERR "-h    Sets the height parameter\n";
-	print STDERR "-t    Sets the number of supported touch points parameter\n";
-	print STDERR "-f    Sets flags, separated by commas (optional, supported flags: xflip, yflip, swap, track)\n";
-	print STDERR "      xflip enables horizontal flipping\n";
-	print STDERR "      yflip enables vertical flipping\n";
-	print STDERR "      swap enables axis swapping\n";
-	print STDERR "      track enables in-driver finger tracking (use for controllers that don't support it)\n";
-	print STDERR "      Each flag may be prefixed with 'no' to disable it.\n";
+	print STDERR "Usage: fwtool [MODE] [INPUT] [MODIFIERS] [OUTPUT]\n";
+	print STDERR "[MODE] is one of:\n";
+	print STDERR "-r                (Read-only mode, default) Prints statistics and/or information about firmware\n";
+	print STDERR "-w                (Read-write mode) Writes a new firmware image, optionally setting flags\n";
+	print STDERR "[INPUT] specifies the input:\n";
+	print STDERR "-f [FORMAT]       (Optional, default: auto) Sets the input file format\n";
+	print STDERR "-i [FILE]         Specifies the input firmware file\n";
+	print STDERR "[MODIFIERS] can be any number of:\n";
+	print STDERR "-s [KEY]=[VALUE]  Sets flag KEY to VALUE\n";
+	print STDERR "[OUTPUT] specifies the output:\n";
+	print STDERR "-g [FORMAT]       (Optional, default: copy) Sets the output file format\n";
+	print STDERR "-o [FILE]         (Optional, input will be overwritten if omitted) Specifies the output firmware file\n";
+	print STDERR "[FORMAT] is one of:\n";
+	print STDERR "auto              (Only valid for input) Auto-detect firmware\n";
+	print STDERR "copy              (Only valid for output) Use the same format as input\n";
+	print STDERR "old               Old-style binary firmware, as used by the Android driver\n";
+	print STDERR "new               New-style binary firmware, as used by gslx680-acpi\n";
+	print STDERR "header            C header file containing a firmware image and calibration data\n";
+	print STDERR "win               Scrambled firmware, as used by the Windows driver\n";
+	print STDERR "[KEY] can be:\n";
+	print STDERR "model             A 4-character string describing the controller (ex.: 1680, default=    )\n";
+	print STDERR "width             The width of the touch panel, i.e. x coordinate maximum (0-4095, default=4095)\n";
+	print STDERR "height            The height of the touch panel, i.e. the y coordinate maximum (0-4095, default=4095)\n";
+	print STDERR "points            The number of supported touch points (1-10, default=10)\n";
+	print STDERR "track             Enables in-kernel finger tracking (1=enable, 0=disable, default=enable)\n";
+	print STDERR "xflip             Enables horizontal flipping (1=enable, 0=disable, default=disable)\n";
+	print STDERR "yflip             Enables vertical flipping (1=enable, 0=disable, default=disable)\n";
+	print STDERR "swap              Enables x-y axis swapping (1=enable, 0=disable, default=disable)\n";
 	-1;
 }
 
-my ($mode, $format, $tscfg, $model, $width, $height, $touches, $flags, $plain) = ('info', 'plain');
+my ($readwrite, $iformat, $ifile, $oformat, $ofile) = (0, 'auto', undef, 'copy', undef);
+my %flags;
 GetOptions(
-	'info' => sub { $mode = 'info'; },
-	'convert=s' => sub { $mode = 'convert'; $tscfg = $_[1]; },
-	'set' => sub { $mode = 'set'; },
-	'xport=s' => sub { $mode = 'export'; $plain = $_[1]; },
-	'model=s' => \$model,
-	'width=i' => \$width,
-	'height=i' => \$height,
-	'touches=i' => \$touches,
-	'flags=s' => \$flags,
-	'1' => sub { $format = 'plain' },
-	'2' => sub { $format = 'tscfg' },
-	'3' => sub { $format = 'scrambled' },
+	'read' => sub { $readwrite = 0; },
+	'write' => sub { $readwrite = 1; },
+	'f|iformat=s' => \$iformat,
+	'ifile=s' => \$ifile,
+	'g|oformat=s' => \$oformat,
+	'ofile=s' => \$ofile,
+	'set=s%' => $flags,
 ) or exit usage;
 
-my $fwfile = $ARGV[0] or exit usage;
+defined $ifile or exit usage;
 
-sub set_params {
-	my ($rep) = @_;
-	if (defined $model) {
-		$rep->set_model($model);
-	}
-	if (defined $width) {
-		$rep->set_width($width);
-	}
-	if (defined $height) {
-		$rep->set_height($height);
-	}
-	if (defined $touches) {
-		$rep->set_touches($touches);
-	}
-	if (defined $flags) {
-		for my $flag (split /,\s*/, $flags) {
-			if ($flag =~ /^(no)?xflip$/) {
-				$rep->set_xmirrored($flag !~ /^no/);
-			} elsif ($flag =~ /^(no)?yflip$/) {
-				$rep->set_ymirrored($flag !~ /^no/);
-			} elsif ($flag =~ /^(no)?swap$/) {
-				$rep->set_swapped($flag !~ /^no/);
-			} elsif ($flag =~ /^(no)?track$/) {
-				$rep->set_tracking($flag !~ /^no/);
-			} else {
-				warn "Invalid flag: $flag";
-			}
-		}
+print "Loading $ifile...\n";
+my $rep = Firmware::Silead->load_as($ifile, $iformat);
+if (!defined($rep)) {
+	if ($iformat eq 'auto') {
+		die "Can't autodetect format of $ifile - is this really a firmware image?";
+	} else {
+		die "Invalid input - can't load $ifile as type $iformat (or $iformat is not a valid format)";
 	}
 }
 
-if ($mode eq 'info') {
-	print "Loading $fwfile...\n";
-	my $rep = Firmware::Silead->load($fwfile) or die "Can't load firmware $fwfile: $@";
+if (!$readwrite) {
 	print "Controller model: " . $rep->model . "\n";
 	print "Panel width: " . $rep->width . "\n";
 	print "Panel height: " . $rep->height . "\n";
@@ -99,45 +80,29 @@ if ($mode eq 'info') {
 		printf " %02x", $page;
 	}
 	print "\n";
-} elsif ($mode eq 'set') {
-	print "Loading $fwfile...\n";
-	my $rep = Firmware::Silead->load($fwfile) or die "Can't load firmware $fwfile: $@";
-	print "Setting parameters...\n";
-	set_params($rep);
-	print "Saving $fwfile...\n";
-	$rep->save($fwfile);
-} elsif ($mode eq 'convert') {
-	print "Loading $tscfg...\n";
-	my $data;
-	do {
-		my $in = IO::File->new($tscfg, 'r') or die "Can't open $tscfg: $!";
-		$in->binmode;
-		local $/ = undef;
-		$data = <$in>;
-		defined($data) or die "Can't load firmware: $!";
-		$in->close();
-	};
-	
-	my $rep = Firmware::Silead->new();
-	if ($format eq 'plain') {
-		$rep->import_fw($data) or die "Can't parse firmware: $@";
-	} elsif ($format eq 'tscfg') {
-		$rep->import_tscfg($data) or die "Can't parse firmware: $@";
-	} elsif ($format eq 'scrambled') {
-		$rep->import_scrambled($data) or die "Can't parse firmware: $@";
+}
+
+if ($readwrite) {
+	print "Setting parameters...\n" unless !int %flags;
+	for my $key (keys(%flags)) {
+		$rep->set_param($key, $flags{$key});
 	}
-	
-	print "Setting parameters...\n";
-	set_params($rep);
 
-	print "Saving $fwfile...\n";
-	$rep->save($fwfile) or die "Can't write firmware: $@";
-} elsif ($mode eq 'export') {
-	print "Loading $fwfile...\n";
-	my $rep = Firmware::Silead->load($fwfile) or die "Can't load firmware $fwfile: $@";
-	print "Exporting to $plain...\n";
-	my $out = IO::File->new($plain, 'w') or die "Can't open $plain: $!";
-	my $data = $rep->export_fw();
-	$out->print($data) or die "Can't write firmware: $!";
-	$out->close();
+	if ($oformat eq 'copy') {
+		# TODO does not work for auto, implement better detection api
+		$oformat = $iformat;
+	}
+	print "Saving $ofile...\n";
+	if (!$rep->save_as($ofile, $oformat)) {
+		die "Error saving to $ofile";
+	}
 }
+
+do {
+	my $in = IO::File->new($tscfg, 'r') or die "Can't open $tscfg: $!";
+	$in->binmode;
+	local $/ = undef;
+	$data = <$in>;
+	defined($data) or die "Can't load firmware: $!";
+	$in->close();
+};