<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libnjb: fwupgrade.c</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>fwupgrade.c</h1><div class="fragment"><pre class="fragment">
<span class="preprocessor">#include "common.h"</span>
<span class="preprocessor">#include <sys/stat.h></span>
<span class="preprocessor">#include <sys/types.h></span>
<span class="preprocessor">#include <fcntl.h></span>
<span class="preprocessor">#include <string.h></span>
<span class="comment">/* To handle .exe files, this must exist */</span>
<span class="preprocessor">#if HAVE_ZLIB_H</span>
<span class="preprocessor"></span><span class="preprocessor">#include <zlib.h></span>
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span><span class="comment">/* You need this 10 MB buffer for this operation... */</span>
<span class="preprocessor">#define BUFFERSIZE 10*1024*1024</span>
<span class="preprocessor"></span>
<span class="keyword">static</span> <span class="keywordtype">int</span> progress (u_int64_t sent, u_int64_t total, <span class="keyword">const</span> <span class="keywordtype">char</span>* buf, <span class="keywordtype">unsigned</span> len, <span class="keywordtype">void</span> *data)
{
<span class="keywordtype">int</span> percent = (sent*100)/total;
<span class="preprocessor">#ifdef __WIN32__</span>
<span class="preprocessor"></span> printf(<span class="stringliteral">"Progress: %I64u of %I64u (%d%%)\r"</span>, sent, total, percent);
<span class="preprocessor">#else</span>
<span class="preprocessor"></span> printf(<span class="stringliteral">"Progress: %llu of %llu (%d%%)\r"</span>, sent, total, percent);
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span> fflush(stdout);
<span class="keywordflow">return</span> 0;
}
<span class="keyword">static</span> <span class="keywordtype">void</span> usage (<span class="keywordtype">void</span>)
{
fprintf(stderr, <span class="stringliteral">"usage: fwupgrade [ -D<debuglvl> ] <path>\n"</span>);
exit(1);
}
<span class="keyword">static</span> <span class="keywordtype">int</span> read_in_fw(<span class="keywordtype">char</span> *path, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer) {
<span class="comment">/* File descriptor and pointer */</span>
<span class="keywordtype">int</span> fd;
<span class="keywordtype">size_t</span> bread;
<span class="comment">/* Read in the firmware file */</span>
<span class="preprocessor">#ifdef __WIN32__</span>
<span class="preprocessor"></span> <span class="keywordflow">if</span> ( (fd = open(path, O_RDONLY|O_BINARY)) == -1 ) {
<span class="preprocessor">#else</span>
<span class="preprocessor"></span> <span class="keywordflow">if</span> ( (fd = open(path, O_RDONLY)) == -1 ) {
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span> printf(<span class="stringliteral">"Could not open firmware file descriptor.\n"</span>);
<span class="keywordflow">return</span> -1;
}
bread = read(fd, buffer, BUFFERSIZE);
<span class="keywordflow">if</span> (bread < 0) {
printf(<span class="stringliteral">"Error while reading firmware file.\n"</span>);
close(fd);
<span class="keywordflow">return</span> -1;
}
<span class="keywordflow">if</span> (bread == BUFFERSIZE) {
printf(<span class="stringliteral">"Warning: this firmware file is very large.\n"</span>);
printf(<span class="stringliteral">"It probably cannot be properly decoded.\n"</span>);
}
close(fd);
printf(<span class="stringliteral">"Read in a firmware file of size 0x%x.\n"</span>, bread);
<span class="keywordflow">if</span> (bread < 1024) {
printf(<span class="stringliteral">"Ridiculously small firmware file. Aborting.\n"</span>);
<span class="keywordflow">return</span> -1;
}
<span class="keywordflow">return</span> bread;
}
<span class="keyword">static</span> <span class="keywordtype">void</span> ucs2_printf(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *str) {
<span class="keywordflow">while</span> (!str[0] == 0x00 || !str[1] == 0x00) {
printf(<span class="stringliteral">"%c"</span>, str[1]);
str += 2;
}
}
<span class="keyword">static</span> <span class="keywordtype">void</span> analyze_firmware(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer) {
<span class="keywordflow">if</span> (buffer[0] == <span class="charliteral">'C'</span> && buffer[1] == <span class="charliteral">'I'</span> &&
buffer[2] == <span class="charliteral">'F'</span> && buffer[3] == <span class="charliteral">'F'</span>) {
u_int32_t cifflen;
u_int32_t offset = 0;
cifflen = (buffer[4] << 24) | (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
printf(<span class="stringliteral">"Firmware CIFF image, %08x bytes:\n"</span>, cifflen);
<span class="comment">/* Wind past header */</span>
offset = 8;
printf(<span class="stringliteral">" Offset: Type: Size:\n"</span>);
<span class="keywordflow">while</span> (offset < cifflen) {
<span class="keywordtype">char</span> secname[5];
u_int32_t seclen;
secname[0] = buffer[offset];
secname[1] = buffer[offset+1];
secname[2] = buffer[offset+2];
secname[3] = buffer[offset+3];
secname[4] = <span class="charliteral">'\0'</span>;
seclen = (buffer[offset+4] << 24) | (buffer[offset+5] << 16) |
(buffer[offset+6] << 8) | buffer[offset+7];
printf(<span class="stringliteral">" %08x %s %08x bytes"</span>, offset, secname, seclen);
<span class="keywordflow">if</span> (!strcmp(secname, <span class="stringliteral">"CINF"</span>) || !strcmp(secname, <span class="stringliteral">"DATA"</span>)) {
printf(<span class="stringliteral">" \""</span>);
ucs2_printf(&buffer[offset+8]);
printf(<span class="stringliteral">"\""</span>);
}
printf(<span class="stringliteral">"\n"</span>);
offset += 8;
offset += seclen;
}
} <span class="keywordflow">else</span> {
printf(<span class="stringliteral">"Unknown firmware image type.\n"</span>);
}
}
<span class="preprocessor">#if HAVE_ZLIB_H</span>
<span class="preprocessor"></span><span class="keyword">static</span> <span class="keywordtype">void</span> dexor_fw_image(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer,
<span class="keywordtype">size_t</span> zimglen,
<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *key,
u_int8_t keylen) {
<span class="keyword">register</span> u_int8_t j = 0;
<span class="keyword">register</span> u_int32_t i;
<span class="keyword">register</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c;
printf(<span class="stringliteral">"Dexor with key: "</span>);
<span class="keywordflow">for</span> (i = 0; i < keylen; i++) {
printf(<span class="stringliteral">"%02x "</span>, key[i]);
}
printf(<span class="stringliteral">"\n"</span>);
<span class="keywordflow">for</span> (i = 0; i < zimglen; i++) {
c = key[j] | 0x80;
buffer[i] = buffer[i] ^ c;
j = (i+1) % keylen;
}
}
<span class="keyword">static</span> <span class="keywordtype">void</span> decompress_fw_image(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *compressed, <span class="keywordtype">size_t</span> compressed_len,
<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> **decompressed, <span class="keywordtype">size_t</span> *rawlen) {
<span class="comment">/* Allocate another big buffer */</span>
*decompressed = (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *) malloc(BUFFERSIZE);
<span class="keywordflow">if</span> (*decompressed == NULL) {
*rawlen = 0;
<span class="keywordflow">return</span>;
}
*rawlen = BUFFERSIZE;
<span class="keywordflow">if</span> (uncompress(*decompressed, (uLongf*) rawlen, compressed, compressed_len) != Z_OK) {
*rawlen = 0;
<span class="keywordflow">return</span>;
}
}
<span class="keyword">static</span> <span class="keywordtype">int</span> write_fw_file(<span class="keywordtype">char</span> *path,
<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *decompressed,
<span class="keywordtype">size_t</span> rawlen) {
<span class="keywordtype">int</span> fd = -1;
<span class="preprocessor">#ifdef __WIN32__</span>
<span class="preprocessor"></span> <span class="keywordflow">if</span> ( (fd = open(path, O_CREAT|O_TRUNC|O_WRONLY|O_BINARY, 0664)) == -1 ) {
<span class="preprocessor">#else</span>
<span class="preprocessor"></span> <span class="keywordflow">if</span> ( (fd = open(path, O_CREAT|O_TRUNC|O_WRONLY, 0664)) == -1 ) {
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span> printf(<span class="stringliteral">"Could not open uncompressed file.\n"</span>);
<span class="keywordflow">return</span> -1;
}
<span class="keywordflow">if</span> (write(fd, decompressed, rawlen) == -1) {
printf(<span class="stringliteral">"Error while writing uncompressed file.\n"</span>);
close(fd);
unlink(path);
<span class="keywordflow">return</span> -1;
}
close(fd);
<span class="keywordflow">return</span> 0;
}
<span class="preprocessor">#endif</span>
<span class="preprocessor"></span>
<span class="keyword">static</span> <span class="keywordtype">int</span> prompt()
{
<span class="keywordtype">char</span> buff[2];
<span class="keywordflow">while</span> (1) {
fprintf(stdout, <span class="stringliteral">"> "</span>);
<span class="keywordflow">if</span> ( fgets(buff, <span class="keyword">sizeof</span>(buff), stdin) == NULL ) {
<span class="keywordflow">if</span> (ferror(stdin)) {
fprintf(stderr, <span class="stringliteral">"File error on stdin\n"</span>);
} <span class="keywordflow">else</span> {
fprintf(stderr, <span class="stringliteral">"EOF on stdin\n"</span>);
}
<span class="keywordflow">return</span> 1;
}
<span class="keywordflow">if</span> (buff[0] == <span class="charliteral">'y'</span>) {
<span class="keywordflow">return</span> 0;
} <span class="keywordflow">else</span> <span class="keywordflow">if</span> (buff[0] == <span class="charliteral">'n'</span>) {
<span class="keywordflow">return</span> 1;
}
}
}
<span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)
{
<a name="_a0"></a><a class="code" href="structnjb__struct.html">njb_t</a> njbs[<a name="a1"></a><a class="code" href="libnjb_8h.html#46e41076f44166b6446e3fdae6db62a9">NJB_MAX_DEVICES</a>], *njb;
<span class="keywordtype">int</span> n, opt, debug;
<span class="keyword">extern</span> <span class="keywordtype">int</span> optind;
<span class="keyword">extern</span> <span class="keywordtype">char</span> *optarg;
<span class="keywordtype">char</span> *path;
<span class="keywordtype">char</span> *sendpath;
<span class="keywordtype">char</span> *lang;
<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buffer;
<span class="keywordtype">size_t</span> bread;
debug = 0;
<span class="keywordflow">while</span> ( (opt = getopt(argc, argv, <span class="stringliteral">"D:"</span>)) != -1 ) {
<span class="keywordflow">switch</span> (opt) {
<span class="keywordflow">case</span> <span class="charliteral">'D'</span>:
debug = atoi(optarg);
<span class="keywordflow">break</span>;
<span class="keywordflow">default</span>:
usage();
<span class="keywordflow">break</span>;
}
}
argc -= optind;
argv += optind;
<span class="keywordflow">if</span> ( argc != 1 ) usage();
<span class="keywordflow">if</span> ( debug ) <a name="a2"></a><a class="code" href="group__internals.html#ga5ff48cc89e320bc1c1d89efd2613d77">NJB_Set_Debug</a>(debug);
<span class="comment">/*</span>
<span class="comment"> * Check environment variables $LANG and $LC_CTYPE</span>
<span class="comment"> * to see if we want to support UTF-8 unicode</span>
<span class="comment"> * $LANG = "xx_XX.UTF-8" or $LC_CTYPE = "?"</span>
<span class="comment"> * trigger unicode support.</span>
<span class="comment"> */</span>
lang = getenv(<span class="stringliteral">"LANG"</span>);
<span class="keywordflow">if</span> (lang != NULL) {
<span class="keywordflow">if</span> (strlen(lang) > 5) {
<span class="keywordflow">if</span> (!strcmp(&lang[strlen(lang)-5], <span class="stringliteral">"UTF-8"</span>)) {
<a name="a3"></a><a class="code" href="group__internals.html#g22a893c243cd4398de35fcdea5b49b39">NJB_Set_Unicode</a>(<a name="a4"></a><a class="code" href="group__unicodeflags.html#g388e9c70b7a684c777f6b25e2e9d801b">NJB_UC_UTF8</a>);
}
}
}
path = argv[0];
printf(<span class="stringliteral">"Analyzing firmware file %s...\n"</span>, path);
<span class="comment">/* Allocate a buffer */</span>
buffer = (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *) malloc(BUFFERSIZE);
<span class="keywordflow">if</span> (buffer == NULL) {
printf(<span class="stringliteral">"Could not allocate a firmware scanning buffer.\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="comment">/* Read in to buffer */</span>
bread = read_in_fw(path, buffer);
<span class="keywordflow">if</span> (bread == -1) {
<span class="keywordflow">return</span> 1;
}
<span class="comment">/*</span>
<span class="comment"> * See if this is a RAW (dexored) firmware image, all</span>
<span class="comment"> * firmware images starts with the string "CIFF"</span>
<span class="comment"> */</span>
<span class="keywordflow">if</span> (buffer[0] == <span class="charliteral">'C'</span> && buffer[1] == <span class="charliteral">'I'</span> &&
buffer[2] == <span class="charliteral">'F'</span> && buffer[3] == <span class="charliteral">'F'</span>) {
printf(<span class="stringliteral">"This seems to be a raw (dexored) firmware image.\n"</span>);
sendpath = path;
} <span class="keywordflow">else</span> {
<span class="preprocessor">#if HAVE_ZLIB_H</span>
<span class="preprocessor"></span> <span class="keywordtype">char</span> known_key[] = <span class="stringliteral">"SamBanDam"</span>;
<span class="keywordtype">char</span> uncompressed_file[] = <span class="stringliteral">"tempimage.bin"</span>;
<span class="comment">/* Length of the zlib compressed image */</span>
<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> zimglen;
<span class="comment">/* Pointer into file buffer */</span>
<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset = 0;
<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *decompressed;
<span class="keywordtype">size_t</span> rawlen;
<span class="keywordtype">size_t</span> i;
printf(<span class="stringliteral">"This could be a zlib compressed windows executable.\n"</span>);
<span class="comment">/* Scanning for zlib header */</span>
printf(<span class="stringliteral">"Scanning for zlib header...\n"</span>);
<span class="keywordflow">for</span> (i = 0; i < bread-3; i++) {
<span class="keywordflow">if</span> (
<span class="comment">// Old Key</span>
(buffer[i] == 0xAB && buffer[i+1] == 0x3B && buffer[i+2] == 0x01) ||
<span class="comment">// New Key</span>
(buffer[i] == 0xCA && buffer[i+1] == 0x69 && buffer[i+2] == 0x0F)
)
{
offset = i-4;
<span class="keywordflow">break</span>;
}
}
<span class="keywordflow">if</span> (offset == 0) {
printf(<span class="stringliteral">"Could not locate a zlib header in this firmware file.\n"</span>);
<span class="keywordflow">return</span> 1;
} <span class="keywordflow">else</span> {
printf(<span class="stringliteral">"Found zlib header at file position 0x%x.\n"</span>, offset);
}
zimglen = buffer[offset+3] << 24 | buffer[offset+2] << 16
| buffer[offset+1] << 8 | buffer[offset];
printf(<span class="stringliteral">"Zlib compressed image length: 0x%x\n"</span>, zimglen);
<span class="keywordflow">if</span> (zimglen > bread-offset) {
printf(<span class="stringliteral">"Inconsistent length of zlib compressed image, aborting.\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="comment">/* Decompress zlib image using Zlib */</span>
printf(<span class="stringliteral">"Calling zlib uncompress() on raw chunks...\n"</span>);
decompress_fw_image(&buffer[offset+4], zimglen, &decompressed, &rawlen);
<span class="keywordflow">if</span> (rawlen == 0) {
printf(<span class="stringliteral">"Failed.\n"</span>);
<span class="comment">/* "Dexor" the firmware image */</span>
printf(<span class="stringliteral">"\"Dexoring\" firmware zlib image with a known key...\n"</span>);
dexor_fw_image(&buffer[offset+4], zimglen, known_key, strlen(known_key));
<span class="comment">/* Decompress zlib image using Zlib */</span>
printf(<span class="stringliteral">"Calling zlib uncompress()...\n"</span>);
decompress_fw_image(&buffer[offset+4], zimglen, &decompressed, &rawlen);
<span class="keywordflow">if</span> (rawlen == 0) {
printf(<span class="stringliteral">"Could not dexor the firmware :(\nAborting.\n"</span>);
exit(1);
}
}
printf(<span class="stringliteral">"Decompressed image size: 0x%x\n"</span>, rawlen);
<span class="keywordflow">if</span> (decompressed[0] == <span class="charliteral">'C'</span> && decompressed[1] == <span class="charliteral">'I'</span> &&
decompressed[2] == <span class="charliteral">'F'</span> && decompressed[3] == <span class="charliteral">'F'</span>) {
printf(<span class="stringliteral">"The extracted image looks like a firmware file.\n"</span>);
} <span class="keywordflow">else</span> {
printf(<span class="stringliteral">"The extracted image does not look like a firmware file.\n"</span>);
printf(<span class="stringliteral">"Aborting.\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="comment">/* Write out decompressed file */</span>
printf(<span class="stringliteral">"Writing out the extracted image to disk as \"%s\".\n"</span>, uncompressed_file);
<span class="keywordflow">if</span> (write_fw_file(uncompressed_file, decompressed, rawlen) == -1) {
printf(<span class="stringliteral">"Failed to write uncompressed file. Aborting.\n"</span>);
<span class="keywordflow">return</span> 1;
}
sendpath = uncompressed_file;
<span class="comment">/* Exchange buffer for the decompressed image */</span>
free(buffer);
buffer = decompressed;
<span class="preprocessor">#else</span>
<span class="preprocessor"></span> printf(<span class="stringliteral">"This may be an zlib compressed .exe file firmware.\n"</span>);
printf(<span class="stringliteral">"You must compile the \"fwupgrade\" program on a system\n"</span>);
printf(<span class="stringliteral">"which has the zlib library and headers properly installed\n"</span>);
printf(<span class="stringliteral">"to enable the compression of zlib compressed firmware images.\n"</span>);
<span class="preprocessor">#endif </span>
<span class="preprocessor"></span> }
<span class="comment">/* Make some more information available on this firmware */</span>
analyze_firmware(buffer);
<span class="comment">/* Free firmware read buffer */</span>
free(buffer);
printf(<span class="stringliteral">"Sending firmware file to jukebox\n"</span>);
<span class="keywordflow">if</span> (<a name="a5"></a><a class="code" href="group__basic.html#g199efd7711a70ae5d63f4052c2e492d3">NJB_Discover</a>(njbs, 0, &n) == -1) {
fprintf(stderr, <span class="stringliteral">"could not locate any jukeboxes\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="keywordflow">if</span> ( n == 0 ) {
fprintf(stderr, <span class="stringliteral">"no NJB devices found\n"</span>);
<span class="keywordflow">return</span> 0;
}
njb = njbs;
<span class="keywordflow">if</span> ( <a name="a6"></a><a class="code" href="group__basic.html#ga631536b597d8f8cb73eeb47eff6640a">NJB_Open</a>(njb) == -1 ) {
<a name="a7"></a><a class="code" href="group__internals.html#ge9b849a9a883fe1fd697278bd8d49585">NJB_Error_Dump</a>(njb,stderr);
<span class="keywordflow">return</span> 1;
}
<a name="a8"></a><a class="code" href="group__basic.html#g023eb258743b5961ec1b85cbd62a55cb">NJB_Capture</a>(njb);
printf(<span class="stringliteral">"I will now send the firmware to your device.\n"</span>);
printf(<span class="stringliteral">"Continue? (y/n)\n"</span>);
<span class="keywordflow">if</span> (prompt() == 0) {
<span class="keywordflow">if</span> ( <a name="a9"></a><a class="code" href="group__basic.html#g5d9a7922425646d198ac81692e8e99ce">NJB_Send_Firmware</a>(njb, sendpath, progress, NULL) == -1 ) {
<a class="code" href="group__internals.html#ge9b849a9a883fe1fd697278bd8d49585">NJB_Error_Dump</a>(njb,stderr);
} <span class="keywordflow">else</span> {
printf(<span class="stringliteral">"\nFirmware upload complete."</span>);
}
printf(<span class="stringliteral">"\n"</span>);
} <span class="keywordflow">else</span> {
printf(<span class="stringliteral">"Aborted.\n"</span>);
}
<a name="a10"></a><a class="code" href="group__basic.html#g69d4034384f1bd033ed2c9ba7a9b32d4">NJB_Release</a>(njb);
<a name="a11"></a><a class="code" href="group__basic.html#g13a9c926c430f38f3a6535ecaaf3e9b9">NJB_Close</a>(njb);
<span class="keywordflow">return</span> 0;
}
</pre></div> </div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 17:17:29 2009 for libnjb by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
