forked from len0rd/rockbox
06423cab58
This is a new flash installer framework for the X1000 targets. A bunch of this code is *UNTESTED* but there is an external test harness which allows the library to be built and tested on a PC. Once tests are written and the bugs are ironed out this framework will replace the existing installer code. New features: - Update tarballs are MD5-checksummed to guarantee integrity. - The flash map is no longer fixed -- updates are self describing and carry a map file which specifies the areas to update. - Can take full or partial backups with checksums computed on the fly. - Supports an additional verification mode which reads back data after writing to ensure the flash contents were not silently corrupted. Change-Id: I29a89190c7ff566019f6a844ad0571f01fb7192f
53 lines
1.9 KiB
C
53 lines
1.9 KiB
C
/***************************************************************************
|
|
* __________ __ ___.
|
|
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
|
|
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
|
|
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
|
|
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
|
|
* \/ \/ \/ \/ \/
|
|
* $Id$
|
|
*
|
|
* Copyright (C) 2021 Aidan MacDonald
|
|
*
|
|
* 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 _XF_UPDATE_H_
|
|
#define _XF_UPDATE_H_
|
|
|
|
#include "xf_package.h"
|
|
#include "xf_nandio.h"
|
|
#include "xf_flashmap.h"
|
|
|
|
typedef int(*xf_update_open_stream_cb)(void* arg, const char* file,
|
|
struct xf_stream* stream);
|
|
|
|
enum xf_update_mode {
|
|
XF_UPDATE,
|
|
XF_BACKUP,
|
|
XF_VERIFY,
|
|
};
|
|
|
|
/** The main updater entry point
|
|
*
|
|
* \param mode Operational mode
|
|
* \param nio Initialized NAND I/O object.
|
|
* \param map Flash map describing what regions to update.
|
|
* \param map_size Number of entries in the map.
|
|
* \param open_stream Callback used to open a stream for each map entry.
|
|
* \param arg Argument passed to the `open_stream` callback.
|
|
*
|
|
* \returns XF_E_SUCCESS on success or a negative error code on failure.
|
|
*/
|
|
int xf_updater_run(enum xf_update_mode mode, struct xf_nandio* nio,
|
|
struct xf_map* map, int map_size,
|
|
xf_update_open_stream_cb open_stream, void* arg);
|
|
|
|
#endif /* _XF_UPDATE_H_ */
|