2016-06-18 16:35:04 -04:00
|
|
|
/*
|
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2016 Paul Sokolovsky
|
|
|
|
*
|
|
|
|
* 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/mpconfig.h"
|
|
|
|
#if MICROPY_PY_MACHINE
|
|
|
|
|
|
|
|
#include "py/obj.h"
|
|
|
|
#include "py/runtime.h"
|
|
|
|
#include "extmod/virtpin.h"
|
2017-09-12 02:00:21 -04:00
|
|
|
#include "extmod/machine_pinbase.h"
|
2016-06-18 16:35:04 -04:00
|
|
|
|
|
|
|
// PinBase class
|
|
|
|
|
|
|
|
// As this is abstract class, its instance is null.
|
|
|
|
// But there should be an instance, as the rest of instance code
|
|
|
|
// expects that there will be concrete object for inheritance.
|
|
|
|
typedef struct _mp_pinbase_t {
|
|
|
|
mp_obj_base_t base;
|
|
|
|
} mp_pinbase_t;
|
|
|
|
|
2017-09-12 02:00:21 -04:00
|
|
|
STATIC const mp_pinbase_t pinbase_singleton = {
|
|
|
|
.base = { &machine_pinbase_type },
|
2016-06-18 16:35:04 -04:00
|
|
|
};
|
|
|
|
|
2019-01-18 15:52:27 -05:00
|
|
|
STATIC mp_obj_t pinbase_make_new(const mp_obj_type_t *type, size_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
|
2016-06-18 16:35:04 -04:00
|
|
|
(void)type;
|
|
|
|
(void)n_args;
|
|
|
|
(void)args;
|
2019-01-18 15:52:27 -05:00
|
|
|
(void)kw_args;
|
2016-06-18 17:26:57 -04:00
|
|
|
return MP_OBJ_FROM_PTR(&pinbase_singleton);
|
2016-06-18 16:35:04 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
mp_uint_t pinbase_ioctl(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode);
|
|
|
|
mp_uint_t pinbase_ioctl(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode) {
|
|
|
|
(void)errcode;
|
|
|
|
switch (request) {
|
|
|
|
case MP_PIN_READ: {
|
|
|
|
mp_obj_t dest[2];
|
|
|
|
mp_load_method(obj, MP_QSTR_value, dest);
|
|
|
|
return mp_obj_get_int(mp_call_method_n_kw(0, 0, dest));
|
|
|
|
}
|
|
|
|
case MP_PIN_WRITE: {
|
|
|
|
mp_obj_t dest[3];
|
|
|
|
mp_load_method(obj, MP_QSTR_value, dest);
|
|
|
|
dest[2] = (arg == 0 ? mp_const_false : mp_const_true);
|
|
|
|
mp_call_method_n_kw(1, 0, dest);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
STATIC const mp_pin_p_t pinbase_pin_p = {
|
protocols: Allow them to be (optionally) type-safe
Protocols are nice, but there is no way for C code to verify whether
a type's "protocol" structure actually implements some particular
protocol. As a result, you can pass an object that implements the
"vfs" protocol to one that expects the "stream" protocol, and the
opposite of awesomeness ensues.
This patch adds an OPTIONAL (but enabled by default) protocol identifier
as the first member of any protocol structure. This identifier is
simply a unique QSTR chosen by the protocol designer and used by each
protocol implementer. When checking for protocol support, instead of
just checking whether the object's type has a non-NULL protocol field,
use `mp_proto_get` which implements the protocol check when possible.
The existing protocols are now named:
protocol_framebuf
protocol_i2c
protocol_pin
protocol_stream
protocol_spi
protocol_vfs
(most of these are unused in CP and are just inherited from MP; vfs and
stream are definitely used though)
I did not find any crashing examples, but here's one to give a flavor of what
is improved, using `micropython_coverage`. Before the change,
the vfs "ioctl" protocol is invoked, and the result is not intelligible
as json (but it could have resulted in a hard fault, potentially):
>>> import uos, ujson
>>> u = uos.VfsPosix('/tmp')
>>> ujson.load(u)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: syntax error in JSON
After the change, the vfs object is correctly detected as not supporting
the stream protocol:
>>> ujson.load(p)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
OSError: stream operation not supported
2019-12-03 15:50:37 -05:00
|
|
|
MP_PROTO_IMPLEMENT(MP_QSTR_protocol_pin)
|
2016-06-18 16:35:04 -04:00
|
|
|
.ioctl = pinbase_ioctl,
|
|
|
|
};
|
|
|
|
|
|
|
|
const mp_obj_type_t machine_pinbase_type = {
|
|
|
|
{ &mp_type_type },
|
|
|
|
.name = MP_QSTR_PinBase,
|
|
|
|
.make_new = pinbase_make_new,
|
|
|
|
.protocol = &pinbase_pin_p,
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // MICROPY_PY_MACHINE
|