multiboot: Refactor duplicated functions to a separate file
The implementation of write_bootdata() and get_redirect_dir() was copied verbatim in two different places, obviously a bad thing for maintainability. This moves them to a new file multiboot.c as they are only used for multiboot. Change-Id: Id0279216e4dd019f8bf612a81d3835eff010e506
This commit is contained in:
Aidan MacDonald
parent
439b4e8bca
commit
7fa48faeb5
10 changed files with 165 additions and 220 deletions
|
|
@ -128,6 +128,7 @@
|
|||
|
||||
#if defined(HAVE_BOOTDATA) && !defined(SIMULATOR)
|
||||
#include "bootdata.h"
|
||||
#include "multiboot.h"
|
||||
#include "rbpaths.h"
|
||||
#include "pathfuncs.h"
|
||||
#include "rb-loader.h"
|
||||
|
|
|
|||
|
|
@ -51,6 +51,10 @@ panic.c
|
|||
target/hosted/rolo.c
|
||||
#endif
|
||||
|
||||
#if defined(HAVE_BOOTDATA) || defined(HAVE_MULTIBOOT)
|
||||
common/multiboot.c
|
||||
#endif
|
||||
|
||||
#ifdef HAVE_SDL
|
||||
target/hosted/sdl/button-sdl.c
|
||||
target/hosted/sdl/kernel-sdl.c
|
||||
|
|
|
|||
113
firmware/common/multiboot.c
Normal file
113
firmware/common/multiboot.c
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
/***************************************************************************
|
||||
* __________ __ ___.
|
||||
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
|
||||
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
|
||||
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
|
||||
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
|
||||
* \/ \/ \/ \/ \/
|
||||
*
|
||||
* Copyright (C) 2017, 2020 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 2
|
||||
* 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 "system.h"
|
||||
#include "bootdata.h"
|
||||
#include "crc32.h"
|
||||
#include "loader_strerror.h"
|
||||
#include "file.h"
|
||||
#include <string.h>
|
||||
#include <stdio.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;
|
||||
}
|
||||
|
||||
#ifdef HAVE_MULTIBOOT
|
||||
/* 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
|
||||
|
|
@ -26,96 +26,9 @@
|
|||
#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 */
|
||||
#if defined(HAVE_BOOTDATA) || defined(HAVE_MULTIBOOT)
|
||||
#include "multiboot.h"
|
||||
#endif
|
||||
|
||||
/* loads a firmware file from supplied filename
|
||||
* file opened, checks firmware size and checksum
|
||||
|
|
|
|||
|
|
@ -21,6 +21,9 @@
|
|||
*
|
||||
****************************************************************************/
|
||||
|
||||
#ifndef __MI4_LOADER_H__
|
||||
#define __MI4_LOADER_H__
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#define MI4_HEADER_SIZE 0x200
|
||||
|
|
@ -50,21 +53,4 @@ struct tea_key {
|
|||
int load_mi4(unsigned char* buf, const char* firmware, unsigned int buffer_size);
|
||||
const char *mi4_strerror(int8_t errno);
|
||||
|
||||
#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
|
||||
*/
|
||||
|
||||
/* TODO needs mapped back to debug_menu if root redirect ever becomes a reality */
|
||||
int get_redirect_dir(char* buf, int buffer_size, int volume,
|
||||
const char* rootdir, const char* firmware);
|
||||
#endif
|
||||
#endif /* __MI4_LOADER_H__ */
|
||||
|
|
|
|||
30
firmware/export/multiboot.h
Normal file
30
firmware/export/multiboot.h
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
/***************************************************************************
|
||||
* __________ __ ___.
|
||||
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
|
||||
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
|
||||
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
|
||||
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
|
||||
* \/ \/ \/ \/ \/
|
||||
*
|
||||
* Copyright (C) 2017, 2020 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 2
|
||||
* 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.
|
||||
*
|
||||
****************************************************************************/
|
||||
|
||||
#ifndef __MULTIBOOT_H__
|
||||
#define __MULTIBOOT_H__
|
||||
|
||||
extern int write_bootdata(unsigned char* buf, int len, unsigned int boot_volume);
|
||||
#ifdef HAVE_MULTIBOOT
|
||||
extern int get_redirect_dir(char* buf, int buffer_size, int volume,
|
||||
const char* rootdir, const char* firmware);
|
||||
#endif
|
||||
|
||||
#endif /* __MULTIBOOT_H__ */
|
||||
|
|
@ -27,6 +27,7 @@
|
|||
|
||||
#if defined(HAVE_MULTIBOOT) && !defined(SIMULATOR) && !defined(BOOTLOADER)
|
||||
#include "rb-loader.h"
|
||||
#include "multiboot.h"
|
||||
#include "bootdata.h"
|
||||
#include "crc32.h"
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -18,21 +18,9 @@
|
|||
*
|
||||
****************************************************************************/
|
||||
|
||||
#ifndef __RB_LOADER_H__
|
||||
#define __RB_LOADER_H__
|
||||
|
||||
int load_firmware(unsigned char* buf, const char* firmware, int buffer_size);
|
||||
|
||||
#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);
|
||||
#endif
|
||||
#endif /* __RB_LOADER_H__ */
|
||||
|
|
|
|||
|
|
@ -41,23 +41,19 @@
|
|||
#include "loader_strerror.h"
|
||||
#if defined(MI4_FORMAT)
|
||||
#include "mi4-loader.h"
|
||||
#if defined(HAVE_BOOTDATA) && !defined(SIMULATOR)
|
||||
#include "bootdata.h"
|
||||
#include "crc32.h"
|
||||
extern int write_bootdata(unsigned char* buf, int len, unsigned int boot_volume); /*mi4-loader.c*/
|
||||
#endif
|
||||
#define LOAD_FIRMWARE(a,b,c) load_mi4(a,b,c)
|
||||
#elif defined(RKW_FORMAT)
|
||||
#include "rkw-loader.h"
|
||||
#define LOAD_FIRMWARE(a,b,c) load_rkw(a,b,c)
|
||||
#else
|
||||
#include "rb-loader.h"
|
||||
#define LOAD_FIRMWARE(a,b,c) load_firmware(a,b,c)
|
||||
#endif
|
||||
|
||||
#if defined(HAVE_BOOTDATA) && !defined(SIMULATOR)
|
||||
#include "multiboot.h"
|
||||
#include "bootdata.h"
|
||||
#include "crc32.h"
|
||||
extern int write_bootdata(unsigned char* buf, int len, unsigned int boot_volume); /*rb-loader.c*/
|
||||
#endif
|
||||
#define LOAD_FIRMWARE(a,b,c) load_firmware(a,b,c)
|
||||
#endif
|
||||
|
||||
#if CONFIG_CPU == AS3525v2
|
||||
|
|
|
|||
|
|
@ -30,96 +30,9 @@
|
|||
#include "crc32.h"
|
||||
#include "file.h"
|
||||
#if defined(HAVE_BOOTDATA)
|
||||
#include "system.h"
|
||||
#include "bootdata.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;
|
||||
}
|
||||
#include "multiboot.h"
|
||||
#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 */
|
||||
|
||||
static inline unsigned int le2int(unsigned char* buf)
|
||||
{
|
||||
int32_t res = (buf[3] << 24) | (buf[2] << 16) | (buf[1] << 8) | buf[0];
|
||||
|
|
|
|||
Loading…
Reference in a new issue