234 lines
7.8 KiB
C
234 lines
7.8 KiB
C
/***************************************************************************
|
|
* __________ __ ___.
|
|
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
|
|
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
|
|
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
|
|
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
|
|
* \/ \/ \/ \/ \/
|
|
*
|
|
* Copyright (C) 2005 by Linus Nielsen Feltzing
|
|
* Copyright (C) 2017 by William Wilgus
|
|
*
|
|
* 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 1
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#include <stdio.h>
|
|
#include "config.h"
|
|
#include "system.h"
|
|
#include "file.h"
|
|
#include "loader_strerror.h"
|
|
#include "checksum.h"
|
|
|
|
#if defined(HAVE_BOOTDATA)
|
|
#include "bootdata.h"
|
|
#include "crc32.h"
|
|
|
|
/* Write bootdata into location in FIRMWARE marked by magic header
|
|
* Assumes buffer is already loaded with the firmware image
|
|
* We just need to find the location and write data into the
|
|
* payload region along with the crc for later verification and use.
|
|
* Returns payload len on success,
|
|
* On error returns EKEY_NOT_FOUND
|
|
*/
|
|
int write_bootdata(unsigned char* buf, int len, unsigned int boot_volume)
|
|
{
|
|
struct boot_data_t bl_boot_data;
|
|
struct boot_data_t *fw_boot_data = NULL;
|
|
int search_len = MIN(len, BOOT_DATA_SEARCH_SIZE) - sizeof(struct boot_data_t);
|
|
int payload_len = EKEY_NOT_FOUND;
|
|
|
|
/* search for boot data header prior to search_len */
|
|
for(int i = 0;i < search_len;i++)
|
|
{
|
|
fw_boot_data = (struct boot_data_t*) &buf[i];
|
|
if (fw_boot_data->magic[0] != BOOT_DATA_MAGIC0 ||
|
|
fw_boot_data->magic[1] != BOOT_DATA_MAGIC1)
|
|
continue;
|
|
|
|
memset(&bl_boot_data.payload, 0, BOOT_DATA_PAYLOAD_SIZE);
|
|
bl_boot_data.boot_volume = boot_volume;
|
|
|
|
memset(fw_boot_data->payload, 0, fw_boot_data->length);
|
|
/* determine maximum bytes we can write to firmware
|
|
BOOT_DATA_PAYLOAD_SIZE is the size the bootloader expects */
|
|
payload_len = MIN(BOOT_DATA_PAYLOAD_SIZE, fw_boot_data->length);
|
|
fw_boot_data->length = payload_len;
|
|
/* copy data to FIRMWARE bootdata struct */
|
|
memcpy(fw_boot_data->payload, &bl_boot_data.payload, payload_len);
|
|
/* crc will be used within the firmware to check validity of bootdata */
|
|
fw_boot_data->crc = crc_32(fw_boot_data->payload, payload_len, 0xffffffff);
|
|
break;
|
|
|
|
}
|
|
return payload_len;
|
|
}
|
|
#endif /* HAVE_BOOTDATA */
|
|
|
|
#ifdef HAVE_MULTIBOOT /* defined by config.h */
|
|
/* Check in root of this <volume> for rockbox_main.<playername>
|
|
* if this file empty or there is a single slash '/'
|
|
* buf = '<volume#>/<rootdir>/<firmware(name)>\0'
|
|
* If instead '/<*DIRECTORY*>' is supplied
|
|
* addpath will be set to this DIRECTORY buf =
|
|
* '/<volume#>/addpath/<rootdir>/<firmware(name)>\0'
|
|
* On error returns Negative number or 0
|
|
* On success returns bytes from snprintf
|
|
* and generated path will be placed in buf
|
|
* note: if supplied buffer is too small return will be
|
|
* the number of bytes that would have been written
|
|
*/
|
|
int get_redirect_dir(char* buf, int buffer_size, int volume,
|
|
const char* rootdir, const char* firmware)
|
|
{
|
|
int fd;
|
|
int f_offset;
|
|
char add_path[MAX_PATH];
|
|
/* Check in root of volume for rockbox_main.<playername> redirect */
|
|
snprintf(add_path, sizeof(add_path), "/<%d>/"BOOT_REDIR, volume);
|
|
fd = open(add_path, O_RDONLY);
|
|
if (fd < 0)
|
|
return EFILE_NOT_FOUND;
|
|
|
|
/*clear add_path for re-use*/
|
|
memset(add_path, 0, sizeof(add_path));
|
|
f_offset = read(fd, add_path,sizeof(add_path));
|
|
close(fd);
|
|
|
|
for(int i = f_offset - 1;i > 0; i--)
|
|
{
|
|
/* strip control chars < SPACE or all if path doesn't start with '/' */
|
|
if (add_path[i] < 0x20 || add_path[0] != '/')
|
|
add_path[i] = '\0';
|
|
}
|
|
/* if '/add_path' is specified in rockbox_main.<playername>
|
|
path is /<vol#>/add_path/rootdir/firmwarename
|
|
if add_path is empty or '/' is missing from beginning
|
|
path is /<vol#>/rootdir/firmwarename
|
|
*/
|
|
return snprintf(buf, buffer_size, "/<%d>%s/%s/%s", volume, add_path,
|
|
rootdir, firmware);
|
|
}
|
|
#endif /* HAVE_MULTIBOOT */
|
|
|
|
/* loads a firmware file from supplied filename
|
|
* file opened, checks firmware size and checksum
|
|
* if no error, firmware loaded to supplied buffer
|
|
* file closed
|
|
* Returns size of loaded image on success
|
|
* On error returns Negative value deciphered by means
|
|
* of strerror() function
|
|
*/
|
|
static int load_firmware_filename(unsigned char* buf,
|
|
const char* filename,
|
|
int buffer_size)
|
|
{
|
|
int len;
|
|
unsigned long chksum;
|
|
int ret;
|
|
int fd = open(filename, O_RDONLY);
|
|
|
|
if (fd < 0)
|
|
return EFILE_NOT_FOUND;
|
|
|
|
len = filesize(fd) - 8;
|
|
|
|
if (len > buffer_size)
|
|
{
|
|
ret = EFILE_TOO_BIG;
|
|
goto end;
|
|
}
|
|
|
|
lseek(fd, FIRMWARE_OFFSET_FILE_CRC, SEEK_SET);
|
|
|
|
if (read(fd, &chksum, 4) < 4)
|
|
{
|
|
ret = EREAD_CHKSUM_FAILED;
|
|
goto end;
|
|
}
|
|
chksum = betoh32(chksum); /* Rockbox checksums are big-endian */
|
|
|
|
lseek(fd, FIRMWARE_OFFSET_FILE_DATA, SEEK_SET);
|
|
|
|
if (read(fd, buf, len) < len)
|
|
{
|
|
ret = EREAD_IMAGE_FAILED;
|
|
goto end;
|
|
}
|
|
|
|
if (!verify_checksum(chksum, buf, len))
|
|
{
|
|
ret = EBAD_CHKSUM;
|
|
goto end;
|
|
}
|
|
ret = len;
|
|
|
|
end:
|
|
close(fd);
|
|
return ret;
|
|
}
|
|
|
|
/* Load firmware image in a format created by add method of tools/scramble
|
|
* on success we return size loaded image
|
|
* on error we return negative value which can be deciphered by means
|
|
* of strerror() function
|
|
*/
|
|
int load_firmware(unsigned char* buf, const char* firmware, int buffer_size)
|
|
{
|
|
|
|
int ret = EFILE_NOT_FOUND;
|
|
char filename[MAX_PATH+2];
|
|
/* only filename passed */
|
|
if (firmware[0] != '/')
|
|
{
|
|
|
|
#ifdef HAVE_MULTIBOOT /* defined by config.h */
|
|
/* checks <volumes> highest index to lowest for redirect file
|
|
* 0 is the default boot volume, it is not checked here
|
|
* if found <volume>/rockbox_main.<playername> and firmware
|
|
* has a bootdata region this firmware will be loaded */
|
|
for (unsigned int i = NUM_VOLUMES - 1; i > 0 && ret < 0; i--)
|
|
{
|
|
if (get_redirect_dir(filename, sizeof(filename), i,
|
|
BOOTDIR, firmware) > 0)
|
|
{
|
|
ret = load_firmware_filename(buf, filename, buffer_size);
|
|
/* if firmware has no boot_data don't load from external drive */
|
|
if (write_bootdata(buf, ret, i) <= 0)
|
|
ret = EKEY_NOT_FOUND;
|
|
}
|
|
/* if ret is valid breaks from loop to continue loading */
|
|
}
|
|
#endif
|
|
|
|
if (ret < 0) /* Check default volume, no valid firmware file loaded yet */
|
|
{
|
|
/* First check in BOOTDIR */
|
|
snprintf(filename, sizeof(filename), BOOTDIR "/%s",firmware);
|
|
|
|
ret = load_firmware_filename(buf, filename, buffer_size);
|
|
|
|
if (ret < 0)
|
|
{
|
|
/* Check in root dir */
|
|
snprintf(filename, sizeof(filename),"/%s",firmware);
|
|
ret = load_firmware_filename(buf, filename, buffer_size);
|
|
}
|
|
#ifdef HAVE_BOOTDATA
|
|
/* 0 is the default boot volume */
|
|
write_bootdata(buf, ret, 0);
|
|
#endif
|
|
}
|
|
}
|
|
else /* full path passed ROLO etc.*/
|
|
ret = load_firmware_filename(buf, firmware, buffer_size);
|
|
|
|
return ret;
|
|
}
|