Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 1 | /*************************************************************************** |
| 2 | * __________ __ ___. |
| 3 | * Open \______ \ ____ ____ | | _\_ |__ _______ ___ |
| 4 | * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ / |
| 5 | * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < < |
| 6 | * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \ |
| 7 | * \/ \/ \/ \/ \/ |
| 8 | * $Id$ |
| 9 | * |
| 10 | * mkamsboot.h - a tool for merging bootloader code into an Sansa V2 |
| 11 | * (AMS) firmware file |
| 12 | * |
| 13 | * Copyright (C) 2008 Dave Chapman |
| 14 | * |
| 15 | * This program is free software; you can redistribute it and/or |
| 16 | * modify it under the terms of the GNU General Public License |
| 17 | * as published by the Free Software Foundation; either version 2 |
| 18 | * of the License, or (at your option) any later version. |
| 19 | * |
| 20 | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 21 | * KIND, either express or implied. |
| 22 | * |
| 23 | ****************************************************************************/ |
| 24 | |
| 25 | #ifndef MKAMSBOOT_H |
| 26 | #define MKAMSBOOT_H |
| 27 | |
| 28 | #include <stdint.h> |
| 29 | #include <sys/types.h> |
| 30 | |
Dominik Wenger | cb55d5c | 2009-08-15 14:09:05 +0000 | [diff] [blame] | 31 | #ifdef __cplusplus |
| 32 | extern "C" { |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 33 | #endif |
Dominik Wenger | cb55d5c | 2009-08-15 14:09:05 +0000 | [diff] [blame] | 34 | |
Rafaël Carré | ef7ad19 | 2009-07-05 08:25:44 +0000 | [diff] [blame] | 35 | /* Supported models */ |
| 36 | enum { |
| 37 | MODEL_UNKNOWN = -1, |
| 38 | MODEL_FUZE = 0, |
| 39 | MODEL_CLIP, |
| 40 | MODEL_CLIPV2, |
| 41 | MODEL_E200V2, |
| 42 | MODEL_M200V4, |
| 43 | MODEL_C200V2, |
Rafaël Carré | 8b926e9 | 2010-01-13 03:05:29 +0000 | [diff] [blame] | 44 | MODEL_CLIPPLUS, |
Thomas Martitz | f6540e8 | 2010-02-26 13:55:17 +0000 | [diff] [blame] | 45 | MODEL_FUZEV2, |
Bertrik Sikken | 463b3ed | 2011-08-27 16:21:19 +0000 | [diff] [blame] | 46 | MODEL_CLIPZIP, |
Rafaël Carré | ff6b042 | 2010-05-24 10:06:52 +0000 | [diff] [blame] | 47 | /* new models go here */ |
| 48 | |
| 49 | NUM_MODELS |
Rafaël Carré | ef7ad19 | 2009-07-05 08:25:44 +0000 | [diff] [blame] | 50 | }; |
| 51 | |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 52 | |
Thomas Martitz | f9eeab2 | 2009-07-05 02:30:33 +0000 | [diff] [blame] | 53 | /* Holds info about the OF */ |
| 54 | struct md5sums { |
| 55 | int model; |
| 56 | char *version; |
| 57 | char *md5; |
| 58 | }; |
| 59 | |
Dominik Riebeling | 02dce45 | 2011-01-31 20:15:50 +0000 | [diff] [blame] | 60 | struct ams_models { |
| 61 | unsigned short hw_revision; |
| 62 | unsigned short fw_revision; |
| 63 | /* Descriptive name of this model */ |
| 64 | const char* model_name; |
| 65 | /* Dualboot functions for this model */ |
| 66 | const unsigned char* bootloader; |
| 67 | /* Size of dualboot functions for this model */ |
| 68 | int bootloader_size; |
| 69 | /* Model name used in the Rockbox header in ".sansa" files - these match the |
| 70 | -add parameter to the "scramble" tool */ |
| 71 | const char* rb_model_name; |
| 72 | /* Model number used to initialise the checksum in the Rockbox header in |
| 73 | ".sansa" files - these are the same as MODEL_NUMBER in config-target.h */ |
| 74 | const int rb_model_num; |
| 75 | }; |
| 76 | extern const struct ams_models ams_identity[]; |
Dominik Riebeling | ea61780 | 2009-11-04 20:58:40 +0000 | [diff] [blame] | 77 | |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 78 | /* load_rockbox_file() |
| 79 | * |
| 80 | * Loads a rockbox bootloader file into memory |
| 81 | * |
| 82 | * ARGUMENTS |
| 83 | * |
| 84 | * filename : bootloader file to load |
Rafaël Carré | ff6b042 | 2010-05-24 10:06:52 +0000 | [diff] [blame] | 85 | * model : will be set to this bootloader's model |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 86 | * bootloader_size : set to the uncompressed bootloader size |
| 87 | * rb_packed_size : set to the size of compressed bootloader |
| 88 | * errstr : provided buffer to store an eventual error |
| 89 | * errstrsize : size of provided error buffer |
| 90 | * |
| 91 | * RETURN VALUE |
| 92 | * pointer to allocated memory containing the content of compressed bootloader |
| 93 | * or NULL in case of error (errstr will hold a description of the error) |
| 94 | */ |
| 95 | |
| 96 | unsigned char* load_rockbox_file( |
Rafaël Carré | ff6b042 | 2010-05-24 10:06:52 +0000 | [diff] [blame] | 97 | char* filename, int *model, int* bootloader_size, int* rb_packedsize, |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 98 | char* errstr, int errstrsize); |
| 99 | |
| 100 | |
| 101 | /* load_of_file() |
| 102 | * |
| 103 | * Loads a Sansa AMS Original Firmware file into memory |
| 104 | * |
| 105 | * ARGUMENTS |
| 106 | * |
| 107 | * filename : firmware file to load |
Rafaël Carré | ff6b042 | 2010-05-24 10:06:52 +0000 | [diff] [blame] | 108 | * model : desired player's model |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 109 | * bufsize : set to firmware file size |
| 110 | * md5sum : set to file md5sum, must be at least 33 bytes long |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 111 | * firmware_size : set to firmware block's size |
| 112 | * of_packed : pointer to allocated memory containing the compressed |
| 113 | * original firmware block |
| 114 | * of_packedsize : size of compressed original firmware block |
| 115 | * errstr : provided buffer to store an eventual error |
| 116 | * errstrsize : size of provided error buffer |
| 117 | * |
| 118 | * RETURN VALUE |
| 119 | * pointer to allocated memory containing the content of Original Firmware |
| 120 | * or NULL in case of error (errstr will hold a description of the error) |
| 121 | */ |
| 122 | |
| 123 | unsigned char* load_of_file( |
Rafaël Carré | ff6b042 | 2010-05-24 10:06:52 +0000 | [diff] [blame] | 124 | char* filename, int model, off_t* bufsize, struct md5sums *sum, |
Thomas Martitz | f9eeab2 | 2009-07-05 02:30:33 +0000 | [diff] [blame] | 125 | int* firmware_size, unsigned char** of_packed, |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 126 | int* of_packedsize, char* errstr, int errstrsize); |
| 127 | |
| 128 | |
| 129 | /* patch_firmware() |
| 130 | * |
| 131 | * Patches a Sansa AMS Original Firmware file |
| 132 | * |
| 133 | * ARGUMENTS |
| 134 | * |
| 135 | * model : firmware model (MODEL_XXX) |
| 136 | * fw_version : firmware format version (1 or 2) |
| 137 | * firmware_size : size of uncompressed original firmware block |
| 138 | * buf : pointer to original firmware file |
| 139 | * len : size of original firmware file |
| 140 | * of_packed : pointer to compressed original firmware block |
| 141 | * of_packedsize : size of compressed original firmware block |
| 142 | * rb_packed : pointer to compressed rockbox bootloader |
| 143 | * rb_packed_size : size of compressed rockbox bootloader |
| 144 | */ |
| 145 | |
| 146 | void patch_firmware( |
| 147 | int model, int fw_version, int firmware_size, unsigned char* buf, |
| 148 | int len, unsigned char* of_packed, int of_packedsize, |
| 149 | unsigned char* rb_packed, int rb_packedsize); |
| 150 | |
| 151 | |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 152 | /* check_sizes() |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 153 | * |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 154 | * Verify if the given bootloader can be embedded in the OF file, while still |
| 155 | * allowing both the bootloader and the OF to be unpacked at runtime |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 156 | * |
| 157 | * ARGUMENTS |
| 158 | * |
| 159 | * model : firmware model (MODEL_XXX) |
| 160 | * rb_packed_size : size of compressed rockbox bootloader |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 161 | * rb_unpacked_size : size of compressed rockbox bootloader |
| 162 | * of_packed_size : size of compressed original firmware block |
| 163 | * of_unpacked_size : size of compressed original firmware block |
| 164 | * total_size : will contain the size of useful data that would be |
| 165 | * written to the firmware block, even in case of an |
| 166 | * error |
| 167 | * errstr : provided buffer to store an eventual error |
| 168 | * errstrsize : size of provided error buffer |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 169 | * |
| 170 | * RETURN VALUE |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 171 | * 0 if the conditions aren't met, 1 if we can go and patch the firmware |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 172 | */ |
| 173 | |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 174 | int check_sizes(int model, int rb_packed_size, int rb_unpacked_size, |
| 175 | int of_packed_size, int of_unpacked_size, int *total_size, |
| 176 | char *errstr, int errstrsize); |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 177 | |
Dominik Wenger | a66dfa4 | 2009-08-15 13:04:21 +0000 | [diff] [blame] | 178 | /* firmware_revision() |
| 179 | * |
| 180 | * returns the firmware revision for a particular model |
| 181 | * |
| 182 | * ARGUMENTS |
| 183 | * |
| 184 | * model : firmware model (MODEL_XXX) |
| 185 | * |
| 186 | * RETURN VALUE |
| 187 | * firmware version |
| 188 | */ |
| 189 | int firmware_revision(int model); |
| 190 | |
Dominik Wenger | cb55d5c | 2009-08-15 14:09:05 +0000 | [diff] [blame] | 191 | #ifdef __cplusplus |
| 192 | }; |
Rafaël Carré | b6c20c1 | 2010-02-19 14:10:26 +0000 | [diff] [blame] | 193 | #endif |
Dominik Wenger | cb55d5c | 2009-08-15 14:09:05 +0000 | [diff] [blame] | 194 | |
Rafaël Carré | 96165ab | 2009-05-28 18:27:08 +0000 | [diff] [blame] | 195 | #endif |