circuitpython/shared-bindings/nvm/ByteArray.c

177 lines
7.0 KiB
C
Raw Normal View History

/*
* This file is part of the Micro Python project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
*
* 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/binary.h"
#include "py/objproperty.h"
#include "py/runtime.h"
#include "py/runtime0.h"
#include "shared-bindings/nvm/ByteArray.h"
2018-07-31 19:53:54 -04:00
#include "supervisor/shared/translate.h"
2020-05-07 18:40:46 -04:00
//| class ByteArray:
//| r"""Presents a stretch of non-volatile memory as a bytearray.
//|
2020-05-07 18:40:46 -04:00
//| Non-volatile memory is available as a byte array that persists over reloads
//| and power cycles. Each assignment causes an erase and write cycle so its recommended to assign
//| all values to change at once.
//|
2020-05-07 18:40:46 -04:00
//| Usage::
//|
2020-05-07 18:40:46 -04:00
//| import microcontroller
2021-03-06 08:47:07 -05:00
//| microcontroller.nvm[0:3] = b"\xcc\x10\x00"
//| """
//|
2020-07-03 14:23:34 -04:00
//| def __init__(self) -> None:
2020-05-07 18:40:46 -04:00
//| """Not currently dynamically supported. Access the sole instance through `microcontroller.nvm`."""
//| ...
//|
2020-07-23 14:22:41 -04:00
//| def __bool__(self) -> bool:
//| ...
2020-07-03 13:49:00 -04:00
//|
//| def __len__(self) -> int:
2020-05-07 18:40:46 -04:00
//| """Return the length. This is used by (`len`)"""
//| ...
//|
2017-10-25 13:52:03 -04:00
STATIC mp_obj_t nvm_bytearray_unary_op(mp_unary_op_t op, mp_obj_t self_in) {
nvm_bytearray_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint16_t len = common_hal_nvm_bytearray_get_length(self);
switch (op) {
2021-03-15 09:57:36 -04:00
case MP_UNARY_OP_BOOL:
return mp_obj_new_bool(len != 0);
case MP_UNARY_OP_LEN:
return MP_OBJ_NEW_SMALL_INT(len);
default:
return MP_OBJ_NULL; // op not supported
}
}
STATIC const mp_rom_map_elem_t nvm_bytearray_locals_dict_table[] = {
};
STATIC MP_DEFINE_CONST_DICT(nvm_bytearray_locals_dict, nvm_bytearray_locals_dict_table);
2020-07-23 14:22:41 -04:00
//| @overload
//| def __getitem__(self, index: slice) -> bytearray: ...
2020-08-03 00:35:43 -04:00
//| @overload
2020-07-23 14:22:41 -04:00
//| def __getitem__(self, index: int) -> int:
//| """Returns the value at the given index."""
//| ...
//|
//| @overload
//| def __setitem__(self, index: slice, value: ReadableBuffer) -> None: ...
2020-08-03 00:35:43 -04:00
//| @overload
2020-07-23 14:22:41 -04:00
//| def __setitem__(self, index: int, value: int) -> None:
//| """Set the value at the given index."""
//| ...
//|
STATIC mp_obj_t nvm_bytearray_subscr(mp_obj_t self_in, mp_obj_t index_in, mp_obj_t value) {
if (value == MP_OBJ_NULL) {
// delete item
// slice deletion
return MP_OBJ_NULL; // op not supported
} else {
nvm_bytearray_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (0) {
2021-03-15 09:57:36 -04:00
#if MICROPY_PY_BUILTINS_SLICE
} else if (mp_obj_is_type(index_in, &mp_type_slice)) {
mp_bound_slice_t slice;
if (!mp_seq_get_fast_slice_indexes(common_hal_nvm_bytearray_get_length(self), index_in, &slice)) {
2018-07-31 19:53:54 -04:00
mp_raise_NotImplementedError(translate("only slices with step=1 (aka None) are supported"));
}
if (value != MP_OBJ_SENTINEL) {
#if MICROPY_PY_ARRAY_SLICE_ASSIGN
// Assign
size_t src_len = slice.stop - slice.start;
2021-03-15 09:57:36 -04:00
uint8_t *src_items;
if (mp_obj_is_type(value, &mp_type_array) ||
mp_obj_is_type(value, &mp_type_bytearray) ||
mp_obj_is_type(value, &mp_type_memoryview) ||
mp_obj_is_type(value, &mp_type_bytes)) {
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(value, &bufinfo, MP_BUFFER_READ);
if (bufinfo.len != src_len) {
2018-07-31 19:53:54 -04:00
mp_raise_ValueError(translate("Slice and value different lengths."));
}
src_len = bufinfo.len;
src_items = bufinfo.buf;
if (1 != mp_binary_get_size('@', bufinfo.typecode, NULL)) {
2018-07-31 19:53:54 -04:00
mp_raise_ValueError(translate("Array values should be single bytes."));
}
} else {
2018-07-31 19:53:54 -04:00
mp_raise_NotImplementedError(translate("array/bytes required on right side"));
}
if (!common_hal_nvm_bytearray_set_bytes(self, slice.start, src_items, src_len)) {
2018-07-31 19:53:54 -04:00
mp_raise_RuntimeError(translate("Unable to write to nvm."));
}
return mp_const_none;
#else
return MP_OBJ_NULL; // op not supported
#endif
} else {
// Read slice.
size_t len = slice.stop - slice.start;
uint8_t *items = m_new(uint8_t, len);
common_hal_nvm_bytearray_get_bytes(self, slice.start, len, items);
return mp_obj_new_bytearray_by_ref(len, items);
}
2021-03-15 09:57:36 -04:00
#endif
} else {
// Single index rather than slice.
size_t index = mp_get_index(self->base.type, common_hal_nvm_bytearray_get_length(self),
2021-03-15 09:57:36 -04:00
index_in, false);
if (value == MP_OBJ_SENTINEL) {
// load
uint8_t value_out;
common_hal_nvm_bytearray_get_bytes(self, index, 1, &value_out);
return MP_OBJ_NEW_SMALL_INT(value_out);
} else {
// store
mp_int_t byte_value = mp_obj_get_int(value);
if (byte_value > 0xff || byte_value < 0) {
2018-07-31 19:53:54 -04:00
mp_raise_ValueError(translate("Bytes must be between 0 and 255."));
}
uint8_t short_value = byte_value;
if (!common_hal_nvm_bytearray_set_bytes(self, index, &short_value, 1)) {
2018-07-31 19:53:54 -04:00
mp_raise_RuntimeError(translate("Unable to write to nvm."));
}
return mp_const_none;
}
}
}
}
const mp_obj_type_t nvm_bytearray_type = {
{ &mp_type_type },
.name = MP_QSTR_ByteArray,
.subscr = nvm_bytearray_subscr,
.unary_op = nvm_bytearray_unary_op,
.print = NULL,
.locals_dict = (mp_obj_t)&nvm_bytearray_locals_dict,
};