rockbox/rbutil/mkimxboot/mkimxboot.h
Amaury Pouly 6022d3100a mkimxboot: tool can now recreate a stub to recover from very low battery
Several devices, including the Fuze+ have great trouble recovering from
very low battery states, even in the presence of USB power. This is partly
due to buggy Sigmatel boot stubs and Rockbox bootloader doing unsafe power
operations on boot (should be fixed soon).  In such a state, it is impossible
to boot either the OF and Rockbox, so only the recovery mode is available.
With this commit, mkimxboot can now create a very small stub which only
does one thing but does it well: setup charging to recover from any situation.
It does not provide a fancy charging screen or whatever, screen will just
stay black and the device will slowly charge at ~100mA. When the battery is
back to a normal level, just unplug and boot normally.

Change-Id: Ib50880af85ed1f4f64a7eed0f2221e73c889c351
2014-01-21 19:01:34 +01:00

106 lines
2.7 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2011 by Amaury Pouly
*
* 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 MKIMXBOOT_H
#define MKIMXBOOT_H
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
enum imx_error_t
{
IMX_SUCCESS = 0,
IMX_ERROR = -1,
IMX_OPEN_ERROR = -2,
IMX_READ_ERROR = -3,
IMX_NO_MATCH = -4,
IMX_BOOT_INVALID = -5,
IMX_BOOT_MISMATCH = -6,
IMX_BOOT_CHECKSUM_ERROR = -7,
IMX_DONT_KNOW_HOW_TO_PATCH = -8,
IMX_VARIANT_MISMATCH = -9,
IMX_WRITE_ERROR = -10,
IMX_FIRST_SB_ERROR = -11,
};
enum imx_output_type_t
{
IMX_DUALBOOT = 0,
IMX_RECOVERY = 1,
IMX_SINGLEBOOT = 2,
IMX_CHARGE = 3,
};
/* Supported models */
enum imx_model_t
{
MODEL_UNKNOWN = -1,
MODEL_FUZEPLUS = 0,
MODEL_ZENXFI2,
MODEL_ZENXFI3,
MODEL_ZENXFISTYLE,
MODEL_ZENSTYLE, /* Style 100 and Style 300 */
MODEL_NWZE370,
MODEL_NWZE360,
/* new models go here */
NUM_MODELS
};
/* Supported firmware variants */
enum imx_firmware_variant_t
{
VARIANT_DEFAULT = 0,
/* For the Creative ZEN X-Fi2 */
VARIANT_ZENXFI2_NAND,
VARIANT_ZENXFI2_SD,
VARIANT_ZENXFI2_RECOVERY,
/* For the Creative X-Fi Style */
VARIANT_ZENXFISTYLE_RECOVERY,
/* For the Creative Zen Style 100/300 */
VARIANT_ZENSTYLE_RECOVERY,
/* Last */
VARIANT_COUNT
};
struct imx_option_t
{
bool debug;
enum imx_output_type_t output;
enum imx_firmware_variant_t fw_variant;
const char *force_version; // set to NULL to ignore
};
void dump_imx_dev_info(const char *prefix);
enum imx_error_t mkimxboot(const char *infile, const char *bootfile,
const char *outfile, struct imx_option_t opt);
enum imx_error_t extract_firmware(const char *infile,
enum imx_firmware_variant_t fw_variant, const char *outfile);
#ifdef __cplusplus
}
#endif
#endif