Files
PX4-Autopilot/src/systemcmds/bl_update/bl_update.cpp
T
2024-09-19 09:25:18 +03:00

267 lines
6.8 KiB
C++

/****************************************************************************
*
* Copyright (c) 2012-2021 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/**
* @file bl_update.cpp
*
* STM32F4 & STM32F7 bootloader update tool.
*/
#include <px4_platform_common/px4_config.h>
#include <px4_platform_common/log.h>
#include <px4_platform_common/module.h>
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <arch/board/board.h>
#include <nuttx/progmem.h>
#if defined(CONFIG_ARCH_CHIP_STM32H7)
# define BL_FILE_SIZE_LIMIT 128*1024
# define STM_RAM_BASE STM32_AXISRAM_BASE
# define PAGE_SIZE_MATTERS 1
#elif defined(CONFIG_ARCH_CHIP_STM32F7)
# define BL_FILE_SIZE_LIMIT 32*1024
# define STM_RAM_BASE STM32_SRAM_BASE
#else
# define BL_FILE_SIZE_LIMIT 16384
# define STM_RAM_BASE STM32_SRAM_BASE
#endif
#if defined (CONFIG_STM32_STM32F4XXX) || defined (CONFIG_ARCH_CHIP_STM32F7) || \
defined (CONFIG_ARCH_CHIP_STM32H7)
static int setopt(void);
static void print_usage(const char *reason)
{
if (reason) {
PX4_ERR("%s", reason);
}
PRINT_MODULE_DESCRIPTION("Utility to flash the bootloader from a file");
PRINT_MODULE_USAGE_NAME_SIMPLE("bl_update", "command");
PRINT_MODULE_USAGE_COMMAND_DESCR("setopt", "Set option bits to unlock the FLASH (only needed if in locked state)");
PRINT_MODULE_USAGE_COMMAND_DESCR("<file>", "Bootloader bin file");
}
#endif // defined (CONFIG_STM32_STM32F4XXX) || defined (CONFIG_ARCH_CHIP_STM32F7)
extern "C" __EXPORT int bl_update_main(int argc, char *argv[])
{
#if !(defined (CONFIG_STM32_STM32F4XXX) || defined (CONFIG_ARCH_CHIP_STM32F7) \
|| defined (CONFIG_ARCH_CHIP_STM32H7))
PX4_ERR("Not supported on this HW");
return 1;
}
#else
if (argc != 2)
{
print_usage("missing firmware filename or command");
return 1;
}
if (!strcmp(argv[1], "setopt"))
{
return setopt();
}
int fd = open(argv[1], O_RDONLY);
if (fd < 0)
{
PX4_ERR("open %s failed", argv[1]);
return 1;
}
struct stat s;
if (stat(argv[1], &s) != 0)
{
PX4_ERR("stat %s failed", argv[1]);
close(fd);
return 1;
}
/* sanity-check file size */
if (s.st_size > BL_FILE_SIZE_LIMIT)
{
PX4_ERR("%s: file too large (limit: %u, actual: %jd)", argv[1], BL_FILE_SIZE_LIMIT, (intmax_t) s.st_size);
close(fd);
return 1;
}
off_t file_size = s.st_size;
off_t image_size = file_size;
#if defined(PAGE_SIZE_MATTERS)
size_t page_size = up_progmem_pagesize(0) - 1;
image_size = (file_size + page_size) & ~page_size;
#endif
uint8_t *buf = (uint8_t *)malloc(image_size);
if (buf == nullptr)
{
PX4_ERR("failed to allocate %jd bytes for firmware buffer", (intmax_t) file_size);
close(fd);
return 1;
}
memset(buf, 0xff, image_size);
if (read(fd, buf, file_size) != file_size)
{
PX4_ERR("firmware read error");
close(fd);
free(buf);
return 1;
}
close(fd);
uint32_t *hdr = (uint32_t *)buf;
if ((hdr[0] < STM_RAM_BASE) || /* stack not below RAM */
(hdr[0] > (STM_RAM_BASE + (128 * 1024))) || /* stack not above RAM */
(hdr[1] < PX4_FLASH_BASE) || /* entrypoint not below flash */
((hdr[1] - PX4_FLASH_BASE) > BL_FILE_SIZE_LIMIT)) /* entrypoint not outside bootloader */
{
free(buf);
PX4_ERR("not a bootloader image");
return 1;
}
PX4_INFO("image validated, erasing bootloader...");
px4_usleep(10000);
/* prevent other tasks from running while we do this */
sched_lock();
const size_t page = 0;
uint8_t *base = (uint8_t *) PX4_FLASH_BASE;
ssize_t size = up_progmem_eraseblock(page);
if (size != BL_FILE_SIZE_LIMIT)
{
PX4_ERR("erase error at %p", &base[size]);
}
PX4_INFO("flashing...");
/* now program the bootloader - speed is not critical so use x8 mode */
size = up_progmem_write((size_t) base, buf, image_size);
if (size != image_size)
{
PX4_ERR("program error at %p", &base[size]);
goto flash_end;
}
/* re-lock the flash control register */
stm32_flash_lock();
PX4_INFO("verifying...");
/* now run a verify pass */
for (int i = 0; i < image_size; i++)
{
if (base[i] != buf[i]) {
PX4_WARN("verify failed at %i - retry update, DO NOT reboot", i);
goto flash_end;
}
}
PX4_INFO("bootloader update complete");
flash_end:
/* unlock the scheduler */
sched_unlock();
free(buf);
exit(0);
}
static int
setopt(void)
{
volatile uint32_t *optcr = (volatile uint32_t *)0x40023c14;
const uint16_t opt_mask = (3 << 2); /* BOR_LEV bitmask */
const uint16_t opt_bits = (0 << 2); /* BOR = 0, setting for 2.7-3.6V operation */
if ((*optcr & opt_mask) == opt_bits) {
PX4_INFO("option bits are already set as required");
return 0;
}
/* unlock the control register */
volatile uint32_t *optkeyr = (volatile uint32_t *)0x40023c08;
*optkeyr = 0x08192a3bU;
*optkeyr = 0x4c5d6e7fU;
if (*optcr & 1) {
PX4_ERR("option control register unlock failed");
return 1;
}
/* program the new option value */
*optcr = (*optcr & ~opt_mask) | opt_bits | (1 << 1);
px4_usleep(1000);
if ((*optcr & opt_mask) == opt_bits) {
PX4_INFO("option bits set");
return 0;
}
PX4_ERR("option bits setting failed; readback 0x%04" PRIx32, *optcr);
return 1;
}
#endif // defined (CONFIG_STM32_STM32F4XXX) || defined (CONFIG_ARCH_CHIP_STM32F7)