Extend return codes for chinachip_patch().

Instead of passing error messages using a callback function (which becomes
awkward when used from a C++ class object) return distinct error codes from
chinachip_patch(). This also removes the kludge to support translations for
Rockbox Utility and moves the strings to translate to the installation class
where they belong.

As a side effect info messages won't be passed to Rockbox Utility anymore, but
the details of the patching progress aren't of that much interest for the user
anyway.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31115 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Dominik Riebeling 2011-12-03 09:41:44 +00:00
parent 07da9ce5ea
commit 059cb71c96
5 changed files with 110 additions and 103 deletions

View file

@ -27,8 +27,6 @@
#include <time.h> #include <time.h>
#include "chinachip.h" #include "chinachip.h"
#define tr(x) x /* Qt translation support */
/* From http://www.rockbox.org/wiki/ChinaChip */ /* From http://www.rockbox.org/wiki/ChinaChip */
struct header struct header
{ {
@ -63,22 +61,11 @@ static long int filesize(FILE* fd)
return len; return len;
} }
#ifdef STANDALONE
#define ERR(fmt, ...) err(userdata, "[ERR] "fmt"\n", ##__VA_ARGS__)
#define INFO(fmt, ...) info(userdata, "[INFO] "fmt"\n", ##__VA_ARGS__)
#define tr(x) x
#else
#define ERR(fmt, ...) err(userdata, fmt, ##__VA_ARGS__)
#define INFO(fmt, ...) info(userdata, fmt, ##__VA_ARGS__)
#endif
#define FCLOSE(fd) fclose(fd); fd = NULL; #define FCLOSE(fd) fclose(fd); fd = NULL;
#define CCPMPBIN_HEADER_SIZE (sizeof(uint32_t)*2 + sizeof(uint8_t) + 9) #define CCPMPBIN_HEADER_SIZE (sizeof(uint32_t)*2 + sizeof(uint8_t) + 9)
#define TOTAL_SIZE (fsize + CCPMPBIN_HEADER_SIZE + bsize) #define TOTAL_SIZE (fsize + CCPMPBIN_HEADER_SIZE + bsize)
int chinachip_patch(const char* firmware, const char* bootloader, enum cc_error chinachip_patch(const char* firmware, const char* bootloader,
const char* output, const char* ccpmp_backup, const char* output, const char* ccpmp_backup)
void (*info)(void*, char*, ...),
void (*err)(void*, char*, ...),
void* userdata)
{ {
char header_time[13]; char header_time[13];
time_t cur_time; time_t cur_time;
@ -87,46 +74,52 @@ int chinachip_patch(const char* firmware, const char* bootloader,
FILE *fd = NULL, *bd = NULL, *od = NULL; FILE *fd = NULL, *bd = NULL, *od = NULL;
unsigned int ccpmp_size = 0, i, fsize, bsize; unsigned int ccpmp_size = 0, i, fsize, bsize;
signed int checksum = 0, ccpmp_pos; signed int checksum = 0, ccpmp_pos;
int result = E_OK;
fd = fopen(firmware, "rb"); fd = fopen(firmware, "rb");
if(!fd) if(!fd)
{ {
ERR(tr("Can't open file %s!"), firmware); fprintf(stderr, "[ERR] Can't open file %s!\n", firmware);
result = E_OPEN_FIRMWARE;
goto err; goto err;
} }
bd = fopen(bootloader, "rb"); bd = fopen(bootloader, "rb");
if(!bd) if(!bd)
{ {
ERR(tr("Can't open file %s!"), bootloader); fprintf(stderr, "[ERR] Can't open file %s!\n", bootloader);
result = E_OPEN_BOOTLOADER;
goto err; goto err;
} }
bsize = filesize(bd); bsize = filesize(bd);
INFO(tr("Bootloader size is %d bytes"), bsize); fprintf(stderr, "[INFO] Bootloader size is %d bytes\n", bsize);
FCLOSE(bd); FCLOSE(bd);
fsize = filesize(fd); fsize = filesize(fd);
INFO(tr("Firmware size is %d bytes"), fsize); fprintf(stderr, "[INFO] Firmware size is %d bytes\n", fsize);
buf = malloc(TOTAL_SIZE); buf = malloc(TOTAL_SIZE);
if(buf == NULL) if(buf == NULL)
{ {
ERR(tr("Can't allocate %d bytes!"), fsize); fprintf(stderr, "[ERR] Can't allocate %d bytes!\n", fsize);
result = E_MEMALLOC;
goto err; goto err;
} }
memset(buf, 0, TOTAL_SIZE); memset(buf, 0, TOTAL_SIZE);
INFO(tr("Reading %s into memory..."), firmware); fprintf(stderr, "[INFO] Reading %s into memory...\n", firmware);
if(fread(buf, fsize, 1, fd) != 1) if(fread(buf, fsize, 1, fd) != 1)
{ {
ERR(tr("Can't read file %s to memory!"), firmware); fprintf(stderr, "[ERR] Can't read file %s to memory!\n", firmware);
result = E_LOAD_FIRMWARE;
goto err; goto err;
} }
FCLOSE(fd); FCLOSE(fd);
if(memcmp(buf, "WADF", 4)) if(memcmp(buf, "WADF", 4))
{ {
ERR(tr("File %s isn't a valid ChinaChip firmware!"), firmware); fprintf(stderr, "[ERR] File %s isn't a valid ChinaChip firmware!\n", firmware);
result = E_INVALID_FILE;
goto err; goto err;
} }
@ -148,10 +141,11 @@ int chinachip_patch(const char* firmware, const char* bootloader,
if(i >= fsize) if(i >= fsize)
{ {
ERR(tr("Couldn't find ccpmp.bin in %s!"), firmware); fprintf(stderr, "[ERR] Couldn't find ccpmp.bin in %s!\n", firmware);
result = E_NO_CCPMP;
goto err; goto err;
} }
INFO(tr("Found ccpmp.bin at %d bytes"), ccpmp_pos); fprintf(stderr, "[INFO] Found ccpmp.bin at %d bytes\n", ccpmp_pos);
if(ccpmp_backup) if(ccpmp_backup)
{ {
@ -159,20 +153,22 @@ int chinachip_patch(const char* firmware, const char* bootloader,
bd = fopen(ccpmp_backup, "wb"); bd = fopen(ccpmp_backup, "wb");
if(!bd) if(!bd)
{ {
ERR(tr("Can't open file %s!"), ccpmp_backup); fprintf(stderr, "[ERR] Can't open file %s!\n", ccpmp_backup);
result = E_OPEN_BACKUP;
goto err; goto err;
} }
INFO(tr("Writing %d bytes to %s..."), ccpmp_size, ccpmp_backup); fprintf(stderr, "[INFO] Writing %d bytes to %s...\n", ccpmp_size, ccpmp_backup);
if(fwrite(&buf[ccpmp_data_pos], ccpmp_size, 1, bd) != 1) if(fwrite(&buf[ccpmp_data_pos], ccpmp_size, 1, bd) != 1)
{ {
ERR(tr("Can't write to file %s!"), ccpmp_backup); fprintf(stderr, "[ERR] Can't write to file %s!\n", ccpmp_backup);
result = E_WRITE_BACKUP;
goto err; goto err;
} }
FCLOSE(bd); FCLOSE(bd);
} }
INFO(tr("Renaming it to ccpmp.old...")); fprintf(stderr, "[INFO] Renaming it to ccpmp.old...\n");
buf[ccpmp_pos + 6] = 'o'; buf[ccpmp_pos + 6] = 'o';
buf[ccpmp_pos + 7] = 'l'; buf[ccpmp_pos + 7] = 'l';
buf[ccpmp_pos + 8] = 'd'; buf[ccpmp_pos + 8] = 'd';
@ -180,27 +176,29 @@ int chinachip_patch(const char* firmware, const char* bootloader,
bd = fopen(bootloader, "rb"); bd = fopen(bootloader, "rb");
if(!bd) if(!bd)
{ {
ERR(tr("Can't open file %s!"), bootloader); fprintf(stderr, "[ERR] Can't open file %s!\n", bootloader);
result = E_OPEN_BOOTLOADER;
goto err; goto err;
} }
/* Also include path size */ /* Also include path size */
ccpmp_pos -= sizeof(uint32_t); ccpmp_pos -= sizeof(uint32_t);
INFO(tr("Making place for ccpmp.bin...")); fprintf(stderr, "[INFO] Making place for ccpmp.bin...\n");
memmove(&buf[ccpmp_pos + bsize + CCPMPBIN_HEADER_SIZE], memmove(&buf[ccpmp_pos + bsize + CCPMPBIN_HEADER_SIZE],
&buf[ccpmp_pos], fsize - ccpmp_pos); &buf[ccpmp_pos], fsize - ccpmp_pos);
INFO(tr("Reading %s into memory..."), bootloader); fprintf(stderr, "[INFO] Reading %s into memory...\n", bootloader);
if(fread(&buf[ccpmp_pos + CCPMPBIN_HEADER_SIZE], if(fread(&buf[ccpmp_pos + CCPMPBIN_HEADER_SIZE],
bsize, 1, bd) != 1) bsize, 1, bd) != 1)
{ {
ERR(tr("Can't read file %s to memory!"), bootloader); fprintf(stderr, "[ERR] Can't read file %s to memory!\n", bootloader);
result = E_LOAD_BOOTLOADER;
goto err; goto err;
} }
FCLOSE(bd); FCLOSE(bd);
INFO(tr("Adding header to %s..."), bootloader); fprintf(stderr, "[INFO] Adding header to %s...\n", bootloader);
int2le(&buf[ccpmp_pos ], 9); /* Pathname Size */ int2le(&buf[ccpmp_pos ], 9); /* Pathname Size */
memcpy(&buf[ccpmp_pos + 4 ], "ccpmp.bin", 9); /* Pathname */ memcpy(&buf[ccpmp_pos + 4 ], "ccpmp.bin", 9); /* Pathname */
memset(&buf[ccpmp_pos + 4 + 9 ], 0x20, sizeof(uint8_t)); /* File Type */ memset(&buf[ccpmp_pos + 4 + 9 ], 0x20, sizeof(uint8_t)); /* File Type */
@ -210,7 +208,8 @@ int chinachip_patch(const char* firmware, const char* bootloader,
time_info = localtime(&cur_time); time_info = localtime(&cur_time);
if(time_info == NULL) if(time_info == NULL)
{ {
ERR(tr("Can't obtain current time!")); fprintf(stderr, "[ERR] Can't obtain current time!\n");
result = E_GET_TIME;
goto err; goto err;
} }
@ -220,11 +219,11 @@ int chinachip_patch(const char* firmware, const char* bootloader,
time_info->tm_hour, time_info->tm_hour,
time_info->tm_min); time_info->tm_min);
INFO(tr("Computing checksum...")); fprintf(stderr, "[INFO] Computing checksum...\n");
for(i = sizeof(struct header); i < TOTAL_SIZE; i+=4) for(i = sizeof(struct header); i < TOTAL_SIZE; i+=4)
checksum += le2int(&buf[i]); checksum += le2int(&buf[i]);
INFO(tr("Updating main header...")); fprintf(stderr, "[INFO] Updating main header...\n");
memcpy(&buf[offsetof(struct header, timestamp)], header_time, 12); memcpy(&buf[offsetof(struct header, timestamp)], header_time, 12);
int2le(&buf[offsetof(struct header, size) ], TOTAL_SIZE); int2le(&buf[offsetof(struct header, size) ], TOTAL_SIZE);
int2le(&buf[offsetof(struct header, checksum) ], checksum); int2le(&buf[offsetof(struct header, checksum) ], checksum);
@ -232,20 +231,18 @@ int chinachip_patch(const char* firmware, const char* bootloader,
od = fopen(output, "wb"); od = fopen(output, "wb");
if(!od) if(!od)
{ {
ERR(tr("Can't open file %s!"), output); fprintf(stderr, "[ERR] Can't open file %s!\n", output);
result = E_OPEN_OUTFILE;
goto err; goto err;
} }
INFO(tr("Writing output to %s..."), output); fprintf(stderr, "[INFO] Writing output to %s...\n", output);
if(fwrite(buf, TOTAL_SIZE, 1, od) != 1) if(fwrite(buf, TOTAL_SIZE, 1, od) != 1)
{ {
ERR(tr("Can't write to file %s!"), output); fprintf(stderr, "[ERR] Can't write to file %s!\n", output);
result = E_WRITE_OUTFILE;
goto err; goto err;
} }
fclose(od);
free(buf);
return 0;
err: err:
if(buf) if(buf)
@ -257,6 +254,6 @@ err:
if(od) if(od)
fclose(od); fclose(od);
return -1; return result;
} }

View file

@ -26,11 +26,24 @@
extern "C" { extern "C" {
#endif #endif
int chinachip_patch(const char* firmware, const char* bootloader, enum cc_error {
const char* output, const char* ccpmp_backup, E_OK,
void (*info)(void*, char*, ...), E_OPEN_FIRMWARE,
void (*err)(void*, char*, ...), E_OPEN_BOOTLOADER,
void* userdata); E_MEMALLOC,
E_LOAD_FIRMWARE,
E_INVALID_FILE,
E_NO_CCPMP,
E_OPEN_BACKUP,
E_WRITE_BACKUP,
E_LOAD_BOOTLOADER,
E_GET_TIME,
E_OPEN_OUTFILE,
E_WRITE_OUTFILE,
};
enum cc_error chinachip_patch(const char* firmware, const char* bootloader,
const char* output, const char* ccpmp_backup);
#ifdef __cplusplus #ifdef __cplusplus
} }

View file

@ -25,24 +25,6 @@
#define VERSION "0.1" #define VERSION "0.1"
#define PRINT(fmt, ...) fprintf(stderr, fmt"\n", ##__VA_ARGS__) #define PRINT(fmt, ...) fprintf(stderr, fmt"\n", ##__VA_ARGS__)
static void info(void* userdata, char* fmt, ...)
{
(void)userdata;
va_list args;
va_start(args, fmt);
vfprintf(stderr, fmt, args);
va_end(args);
}
static void err(void* userdata, char* fmt, ...)
{
(void)userdata;
va_list args;
va_start(args, fmt);
vfprintf(stderr, fmt, args);
va_end(args);
}
void usage(char* name) void usage(char* name)
{ {
PRINT("Usage:"); PRINT("Usage:");
@ -66,7 +48,6 @@ int main(int argc, char* argv[])
return 1; return 1;
} }
return chinachip_patch(argv[1], argv[2], argv[3], argc > 4 ? argv[4] : NULL, return chinachip_patch(argv[1], argv[2], argv[3], argc > 4 ? argv[4] : NULL);
&info, &err, NULL);
} }

View file

@ -42,34 +42,6 @@ QString BootloaderInstallChinaChip::ofHint()
"file."); "file.");
} }
void BootloaderInstallChinaChip::logString(char* format, va_list args, int type)
{
QString translation = QCoreApplication::translate("", format, NULL, QCoreApplication::UnicodeUTF8);
emit logItem(QString().vsprintf(translation.toLocal8Bit(), args), type);
QCoreApplication::processEvents();
}
static void info(void* userdata, char* format, ...)
{
BootloaderInstallChinaChip* pThis = (BootloaderInstallChinaChip*) userdata;
va_list args;
va_start(args, format);
pThis->logString(format, args, LOGINFO);
va_end(args);
}
static void err(void* userdata, char* format, ...)
{
BootloaderInstallChinaChip* pThis = (BootloaderInstallChinaChip*) userdata;
va_list args;
va_start(args, format);
pThis->logString(format, args, LOGERROR);
va_end(args);
}
bool BootloaderInstallChinaChip::install() bool BootloaderInstallChinaChip::install()
{ {
if(m_offile.isEmpty()) if(m_offile.isEmpty())
@ -85,17 +57,62 @@ bool BootloaderInstallChinaChip::install()
void BootloaderInstallChinaChip::installStage2() void BootloaderInstallChinaChip::installStage2()
{ {
enum cc_error result;
bool error = true;
m_tempfile.open(); m_tempfile.open();
QString blfile = m_tempfile.fileName(); QString blfile = m_tempfile.fileName();
m_tempfile.close(); m_tempfile.close();
QString backupfile = QFileInfo(m_blfile).absoluteDir().absoluteFilePath("ccpmp.bin"); QString backupfile = QFileInfo(m_blfile).absoluteDir().absoluteFilePath("ccpmp.bin");
int ret = chinachip_patch(m_offile.toLocal8Bit(), blfile.toLocal8Bit(), m_blfile.toLocal8Bit(), result = chinachip_patch(m_offile.toLocal8Bit(), blfile.toLocal8Bit(),
backupfile.toLocal8Bit(), &info, &err, (void*)this); m_blfile.toLocal8Bit(), backupfile.toLocal8Bit());
qDebug() << "chinachip_patch" << ret; switch(result) {
case E_OK:
error = false;
break;
case E_OPEN_FIRMWARE:
emit logItem(tr("Could not open firmware file"), LOGERROR);
break;
case E_OPEN_BOOTLOADER:
emit logItem(tr("Could not open bootloader file"), LOGERROR);
break;
case E_MEMALLOC:
emit logItem(tr("Could not allocate memory"), LOGERROR);
break;
case E_LOAD_FIRMWARE:
emit logItem(tr("Could not load firmware file"), LOGERROR);
break;
case E_INVALID_FILE:
emit logItem(tr("File is not a valid ChinaChip firmware"), LOGERROR);
break;
case E_NO_CCPMP:
emit logItem(tr("Could not find ccpmp.bin in input file"), LOGERROR);
break;
case E_OPEN_BACKUP:
emit logItem(tr("Could not open backup file for ccpmp.bin"), LOGERROR);
break;
case E_WRITE_BACKUP:
emit logItem(tr("Could not write backup file for ccpmp.bin"), LOGERROR);
break;
case E_LOAD_BOOTLOADER:
emit logItem(tr("Could not load bootloader file"), LOGERROR);
break;
case E_GET_TIME:
emit logItem(tr("Could not get current time"), LOGERROR);
break;
case E_OPEN_OUTFILE:
emit logItem(tr("Could not open output file"), LOGERROR);
break;
case E_WRITE_OUTFILE:
emit logItem(tr("Could not write output file"), LOGERROR);
break;
default:
emit logItem(tr("Unexpected error from chinachippatcher"), LOGERROR);
break;
}
emit done(ret); emit done(error);
} }
bool BootloaderInstallChinaChip::uninstall() bool BootloaderInstallChinaChip::uninstall()

View file

@ -33,7 +33,6 @@ class BootloaderInstallChinaChip : public BootloaderInstallBase
BootloaderInstallBase::BootloaderType installed(void); BootloaderInstallBase::BootloaderType installed(void);
Capabilities capabilities(void); Capabilities capabilities(void);
QString ofHint(); QString ofHint();
void logString(char* buffer, va_list args, int type);
private slots: private slots:
void installStage2(void); void installStage2(void);