97753a1bbc
The new function factory_reset_make_files() populates the given filesystem with the default factory files. It is defined with weak linkage so it can be overridden by a board. This commit also brings some minor user-facing changes: - boot.py is now no longer created unconditionally if it doesn't exist, it is now only created when the filesystem is formatted and the other files are populated (so, before, if the user deleted boot.py it would be recreated at next boot; now it won't be). - pybcdc.inf and README.txt are only created if the board has USB, because they only really make sense if the filesystem is exposed via USB.
99 lines
3.4 KiB
C
99 lines
3.4 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2013-2019 Damien P. George
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#include "py/runtime.h"
|
|
#include "factoryreset.h"
|
|
|
|
#if MICROPY_HW_ENABLE_STORAGE
|
|
|
|
static const char fresh_boot_py[] =
|
|
"# boot.py -- run on boot-up\r\n"
|
|
"# can run arbitrary Python, but best to keep it minimal\r\n"
|
|
"\r\n"
|
|
"import machine\r\n"
|
|
"import pyb\r\n"
|
|
"#pyb.main('main.py') # main script to run after this one\r\n"
|
|
#if MICROPY_HW_ENABLE_USB
|
|
"#pyb.usb_mode('VCP+MSC') # act as a serial and a storage device\r\n"
|
|
"#pyb.usb_mode('VCP+HID') # act as a serial device and a mouse\r\n"
|
|
#endif
|
|
;
|
|
|
|
static const char fresh_main_py[] =
|
|
"# main.py -- put your code here!\r\n"
|
|
;
|
|
|
|
#if MICROPY_HW_ENABLE_USB
|
|
static const char fresh_pybcdc_inf[] =
|
|
#include "genhdr/pybcdc_inf.h"
|
|
;
|
|
|
|
static const char fresh_readme_txt[] =
|
|
"This is a MicroPython board\r\n"
|
|
"\r\n"
|
|
"You can get started right away by writing your Python code in 'main.py'.\r\n"
|
|
"\r\n"
|
|
"For a serial prompt:\r\n"
|
|
" - Windows: you need to go to 'Device manager', right click on the unknown device,\r\n"
|
|
" then update the driver software, using the 'pybcdc.inf' file found on this drive.\r\n"
|
|
" Then use a terminal program like Hyperterminal or putty.\r\n"
|
|
" - Mac OS X: use the command: screen /dev/tty.usbmodem*\r\n"
|
|
" - Linux: use the command: screen /dev/ttyACM0\r\n"
|
|
"\r\n"
|
|
"Please visit http://micropython.org/help/ for further help.\r\n"
|
|
;
|
|
#endif
|
|
|
|
typedef struct _factory_file_t {
|
|
const char *name;
|
|
size_t len;
|
|
const char *data;
|
|
} factory_file_t;
|
|
|
|
static const factory_file_t factory_files[] = {
|
|
{"boot.py", sizeof(fresh_boot_py) - 1, fresh_boot_py},
|
|
{"main.py", sizeof(fresh_main_py) - 1, fresh_main_py},
|
|
#if MICROPY_HW_ENABLE_USB
|
|
{"pybcdc.inf", sizeof(fresh_pybcdc_inf) - 1, fresh_pybcdc_inf},
|
|
{"README.txt", sizeof(fresh_readme_txt) - 1, fresh_readme_txt},
|
|
#endif
|
|
};
|
|
|
|
MP_WEAK void factory_reset_make_files(FATFS *fatfs) {
|
|
for (int i = 0; i < MP_ARRAY_SIZE(factory_files); ++i) {
|
|
const factory_file_t *f = &factory_files[i];
|
|
FIL fp;
|
|
FRESULT res = f_open(fatfs, &fp, f->name, FA_WRITE | FA_CREATE_ALWAYS);
|
|
if (res == FR_OK) {
|
|
UINT n;
|
|
f_write(&fp, f->data, f->len, &n);
|
|
f_close(&fp);
|
|
}
|
|
}
|
|
}
|
|
|
|
#endif // MICROPY_HW_ENABLE_STORAGE
|