2014-05-03 23:27:38 +01:00
|
|
|
/*
|
2017-06-30 08:22:17 +01:00
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
2014-05-03 23:27:38 +01:00
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 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.
|
|
|
|
*/
|
|
|
|
|
2014-05-03 13:24:21 +01:00
|
|
|
#include <stdint.h>
|
2014-03-22 14:56:32 +00:00
|
|
|
#include <string.h>
|
|
|
|
|
2015-07-27 23:52:56 +01:00
|
|
|
#include "py/mpstate.h"
|
2016-10-07 03:58:25 +01:00
|
|
|
#include "py/runtime.h"
|
2015-01-01 21:06:20 +00:00
|
|
|
#include "py/objtuple.h"
|
2015-04-21 15:51:49 +01:00
|
|
|
#include "py/objstr.h"
|
2017-03-31 12:29:39 +01:00
|
|
|
#include "lib/timeutils/timeutils.h"
|
2017-01-27 12:11:59 +00:00
|
|
|
#include "lib/oofatfs/ff.h"
|
|
|
|
#include "lib/oofatfs/diskio.h"
|
|
|
|
#include "extmod/vfs.h"
|
|
|
|
#include "extmod/vfs_fat.h"
|
2015-04-22 17:38:05 +01:00
|
|
|
#include "genhdr/mpversion.h"
|
2014-03-22 14:56:32 +00:00
|
|
|
#include "rng.h"
|
2015-10-19 21:57:41 +01:00
|
|
|
#include "uart.h"
|
2014-05-03 23:27:38 +01:00
|
|
|
#include "portmodules.h"
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2014-08-08 23:30:01 +01:00
|
|
|
/// \module os - basic "operating system" services
|
|
|
|
///
|
|
|
|
/// The `os` module contains functions for filesystem access and `urandom`.
|
|
|
|
///
|
|
|
|
/// The filesystem has `/` as the root directory, and the available physical
|
|
|
|
/// drives are accessible from here. They are currently:
|
|
|
|
///
|
|
|
|
/// /flash -- the internal flash filesystem
|
|
|
|
/// /sd -- the SD card (if it exists)
|
|
|
|
///
|
|
|
|
/// On boot up, the current directory is `/flash` if no SD card is inserted,
|
|
|
|
/// otherwise it is `/sd`.
|
|
|
|
|
2015-04-21 15:51:49 +01:00
|
|
|
STATIC const qstr os_uname_info_fields[] = {
|
|
|
|
MP_QSTR_sysname, MP_QSTR_nodename,
|
|
|
|
MP_QSTR_release, MP_QSTR_version, MP_QSTR_machine
|
|
|
|
};
|
|
|
|
STATIC const MP_DEFINE_STR_OBJ(os_uname_info_sysname_obj, "pyboard");
|
|
|
|
STATIC const MP_DEFINE_STR_OBJ(os_uname_info_nodename_obj, "pyboard");
|
|
|
|
STATIC const MP_DEFINE_STR_OBJ(os_uname_info_release_obj, MICROPY_VERSION_STRING);
|
|
|
|
STATIC const MP_DEFINE_STR_OBJ(os_uname_info_version_obj, MICROPY_GIT_TAG " on " MICROPY_BUILD_DATE);
|
|
|
|
STATIC const MP_DEFINE_STR_OBJ(os_uname_info_machine_obj, MICROPY_HW_BOARD_NAME " with " MICROPY_HW_MCU_NAME);
|
|
|
|
STATIC MP_DEFINE_ATTRTUPLE(
|
|
|
|
os_uname_info_obj,
|
|
|
|
os_uname_info_fields,
|
|
|
|
5,
|
|
|
|
(mp_obj_t)&os_uname_info_sysname_obj,
|
|
|
|
(mp_obj_t)&os_uname_info_nodename_obj,
|
|
|
|
(mp_obj_t)&os_uname_info_release_obj,
|
|
|
|
(mp_obj_t)&os_uname_info_version_obj,
|
|
|
|
(mp_obj_t)&os_uname_info_machine_obj
|
|
|
|
);
|
|
|
|
|
|
|
|
STATIC mp_obj_t os_uname(void) {
|
|
|
|
return (mp_obj_t)&os_uname_info_obj;
|
|
|
|
}
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_0(os_uname_obj, os_uname);
|
|
|
|
|
2014-08-08 23:30:01 +01:00
|
|
|
/// \function sync()
|
|
|
|
/// Sync all filesystems.
|
2014-03-22 14:56:32 +00:00
|
|
|
STATIC mp_obj_t os_sync(void) {
|
2017-01-27 12:11:59 +00:00
|
|
|
for (mp_vfs_mount_t *vfs = MP_STATE_VM(vfs_mount_table); vfs != NULL; vfs = vfs->next) {
|
|
|
|
// this assumes that vfs->obj is fs_user_mount_t with block device functions
|
|
|
|
disk_ioctl(MP_OBJ_TO_PTR(vfs->obj), CTRL_SYNC, NULL);
|
|
|
|
}
|
2014-03-22 14:56:32 +00:00
|
|
|
return mp_const_none;
|
|
|
|
}
|
2015-03-04 20:38:28 +00:00
|
|
|
MP_DEFINE_CONST_FUN_OBJ_0(mod_os_sync_obj, os_sync);
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2014-08-05 23:35:21 +01:00
|
|
|
#if MICROPY_HW_ENABLE_RNG
|
2014-08-08 23:30:01 +01:00
|
|
|
/// \function urandom(n)
|
|
|
|
/// Return a bytes object with n random bytes, generated by the hardware
|
|
|
|
/// random number generator.
|
2014-03-22 14:56:32 +00:00
|
|
|
STATIC mp_obj_t os_urandom(mp_obj_t num) {
|
2014-07-03 13:25:24 +01:00
|
|
|
mp_int_t n = mp_obj_get_int(num);
|
2015-01-21 22:48:37 +00:00
|
|
|
vstr_t vstr;
|
|
|
|
vstr_init_len(&vstr, n);
|
2014-03-22 14:56:32 +00:00
|
|
|
for (int i = 0; i < n; i++) {
|
2015-01-21 22:48:37 +00:00
|
|
|
vstr.buf[i] = rng_get();
|
2014-03-22 14:56:32 +00:00
|
|
|
}
|
2015-01-21 22:48:37 +00:00
|
|
|
return mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
|
2014-03-22 14:56:32 +00:00
|
|
|
}
|
2014-07-19 16:39:13 +01:00
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(os_urandom_obj, os_urandom);
|
2014-08-05 23:35:21 +01:00
|
|
|
#endif
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2015-10-19 21:57:41 +01:00
|
|
|
// Get or set the UART object that the REPL is repeated on.
|
|
|
|
// TODO should accept any object with read/write methods.
|
|
|
|
STATIC mp_obj_t os_dupterm(mp_uint_t n_args, const mp_obj_t *args) {
|
|
|
|
if (n_args == 0) {
|
|
|
|
if (MP_STATE_PORT(pyb_stdio_uart) == NULL) {
|
|
|
|
return mp_const_none;
|
|
|
|
} else {
|
|
|
|
return MP_STATE_PORT(pyb_stdio_uart);
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if (args[0] == mp_const_none) {
|
|
|
|
MP_STATE_PORT(pyb_stdio_uart) = NULL;
|
|
|
|
} else if (mp_obj_get_type(args[0]) == &pyb_uart_type) {
|
|
|
|
MP_STATE_PORT(pyb_stdio_uart) = args[0];
|
|
|
|
} else {
|
2017-08-09 05:40:45 +01:00
|
|
|
mp_raise_ValueError("need a UART object");
|
2015-10-19 21:57:41 +01:00
|
|
|
}
|
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mod_os_dupterm_obj, 0, 1, os_dupterm);
|
|
|
|
|
2017-05-06 08:03:40 +01:00
|
|
|
STATIC const mp_rom_map_elem_t os_module_globals_table[] = {
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_uos) },
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_uname), MP_ROM_PTR(&os_uname_obj) },
|
2015-04-21 15:51:49 +01:00
|
|
|
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_chdir), MP_ROM_PTR(&mp_vfs_chdir_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_getcwd), MP_ROM_PTR(&mp_vfs_getcwd_obj) },
|
2017-05-05 14:36:17 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_ilistdir), MP_ROM_PTR(&mp_vfs_ilistdir_obj) },
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_listdir), MP_ROM_PTR(&mp_vfs_listdir_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_mkdir), MP_ROM_PTR(&mp_vfs_mkdir_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_remove), MP_ROM_PTR(&mp_vfs_remove_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_rename),MP_ROM_PTR(&mp_vfs_rename_obj)},
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_rmdir), MP_ROM_PTR(&mp_vfs_rmdir_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_stat), MP_ROM_PTR(&mp_vfs_stat_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_statvfs), MP_ROM_PTR(&mp_vfs_statvfs_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_unlink), MP_ROM_PTR(&mp_vfs_remove_obj) }, // unlink aliases to remove
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_sync), MP_ROM_PTR(&mod_os_sync_obj) },
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2014-08-08 23:30:01 +01:00
|
|
|
/// \constant sep - separation character used in paths
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_sep), MP_ROM_QSTR(MP_QSTR__slash_) },
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2014-08-05 23:35:21 +01:00
|
|
|
#if MICROPY_HW_ENABLE_RNG
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_urandom), MP_ROM_PTR(&os_urandom_obj) },
|
2014-08-05 23:35:21 +01:00
|
|
|
#endif
|
2015-10-19 21:57:41 +01:00
|
|
|
|
|
|
|
// these are MicroPython extensions
|
2017-05-06 08:03:40 +01:00
|
|
|
{ MP_ROM_QSTR(MP_QSTR_dupterm), MP_ROM_PTR(&mod_os_dupterm_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_mount), MP_ROM_PTR(&mp_vfs_mount_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_umount), MP_ROM_PTR(&mp_vfs_umount_obj) },
|
|
|
|
{ MP_ROM_QSTR(MP_QSTR_VfsFat), MP_ROM_PTR(&mp_fat_vfs_type) },
|
2014-03-22 14:56:32 +00:00
|
|
|
};
|
|
|
|
|
2014-11-29 14:39:27 +00:00
|
|
|
STATIC MP_DEFINE_CONST_DICT(os_module_globals, os_module_globals_table);
|
2014-03-22 14:56:32 +00:00
|
|
|
|
2014-10-12 20:23:47 +01:00
|
|
|
const mp_obj_module_t mp_module_uos = {
|
2014-03-22 14:56:32 +00:00
|
|
|
.base = { &mp_type_module },
|
2014-04-05 21:53:54 +01:00
|
|
|
.globals = (mp_obj_dict_t*)&os_module_globals,
|
2014-03-22 14:56:32 +00:00
|
|
|
};
|