Skip to content

Commit 751e3b7

Browse files
pfalconpfalcon
committed
extmod/virtpin: Initial implementation of open-ended C-level Pin interface.
Using usual method of virtual method tables. Single virtual method, ioctl, is defined currently for all operations. This universal and extensible vtable-based method is also defined as a default MPHAL GPIO implementation, but a specific port may override it with its own implementation (e.g. close-ended, but very efficient, e.g. avoiding virtual method dispatch).
1 parent 74e6c03 commit 751e3b7

4 files changed

Lines changed: 89 additions & 0 deletions

File tree

‎extmod/virtpin.c‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* This file is part of the MicroPython project, http://micropython.org/
3+
*
4+
* The MIT License (MIT)
5+
*
6+
* Copyright (c) 2016 Paul Sokolovsky
7+
*
8+
* Permission is hereby granted, free of charge, to any person obtaining a copy
9+
* of this software and associated documentation files (the "Software"), to deal
10+
* in the Software without restriction, including without limitation the rights
11+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
* copies of the Software, and to permit persons to whom the Software is
13+
* furnished to do so, subject to the following conditions:
14+
*
15+
* The above copyright notice and this permission notice shall be included in
16+
* all copies or substantial portions of the Software.
17+
*
18+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24+
* THE SOFTWARE.
25+
*/
26+
27+
#include "extmod/virtpin.h"
28+
29+
int mp_virtual_pin_read(mp_obj_t pin) {
30+
mp_obj_base_t* s = (mp_obj_base_t*)MP_OBJ_TO_PTR(pin);
31+
mp_pin_p_t *pin_p = (mp_pin_p_t*)s->type->stream_p;
32+
return pin_p->ioctl(pin, MP_PIN_READ, 0, NULL);
33+
}
34+
35+
void mp_virtual_pin_write(mp_obj_t pin, int value) {
36+
mp_obj_base_t* s = (mp_obj_base_t*)MP_OBJ_TO_PTR(pin);
37+
mp_pin_p_t *pin_p = (mp_pin_p_t*)s->type->stream_p;
38+
pin_p->ioctl(pin, MP_PIN_WRITE, value, NULL);
39+
}

‎extmod/virtpin.h‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* This file is part of the MicroPython project, http://micropython.org/
3+
*
4+
* The MIT License (MIT)
5+
*
6+
* Copyright (c) 2016 Paul Sokolovsky
7+
*
8+
* Permission is hereby granted, free of charge, to any person obtaining a copy
9+
* of this software and associated documentation files (the "Software"), to deal
10+
* in the Software without restriction, including without limitation the rights
11+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
* copies of the Software, and to permit persons to whom the Software is
13+
* furnished to do so, subject to the following conditions:
14+
*
15+
* The above copyright notice and this permission notice shall be included in
16+
* all copies or substantial portions of the Software.
17+
*
18+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24+
* THE SOFTWARE.
25+
*/
26+
27+
#include "py/obj.h"
28+
29+
#define MP_PIN_READ (1)
30+
#define MP_PIN_WRITE (2)
31+
#define MP_PIN_INPUT (3)
32+
#define MP_PIN_OUTPUT (4)
33+
34+
// Pin protocol
35+
typedef struct _mp_pin_p_t {
36+
mp_uint_t (*ioctl)(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode);
37+
} mp_pin_p_t;
38+
39+
int mp_virtual_pin_read(mp_obj_t pin);
40+
void mp_virtual_pin_write(mp_obj_t pin, int value);

‎py/mphal.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,13 @@ mp_uint_t mp_hal_ticks_ms(void);
6666
mp_uint_t mp_hal_ticks_us(void);
6767
#endif
6868

69+
// If port HAL didn't define its own pin API, use generic
70+
// "virtual pin" API from the core.
71+
#ifndef mp_hal_pin_obj_t
72+
#define mp_hal_pin_obj_t mp_obj_t
73+
#define mp_hal_get_pin_obj(pin) (pin)
74+
#define mp_hal_pin_read(pin) mp_virtual_pin_read(pin)
75+
#define mp_hal_pin_write(pin, v) mp_virtual_pin_write(pin, v)
76+
#endif
77+
6978
#endif // __MICROPY_INCLUDED_PY_MPHAL_H__

‎py/py.mk‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ PY_O_BASENAME = \
174174
../extmod/moduheapq.o \
175175
../extmod/moduhashlib.o \
176176
../extmod/modubinascii.o \
177+
../extmod/virtpin.o \
177178
../extmod/machine_mem.o \
178179
../extmod/machine_i2c.o \
179180
../extmod/modussl.o \

0 commit comments

Comments
 (0)