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 #ifndef MICROPY_INCLUDED_EXTMOD_VIRTPIN_H
27 #define MICROPY_INCLUDED_EXTMOD_VIRTPIN_H
28 
29 #include "py/obj.h"
30 
31 #define MP_PIN_READ   (1)
32 #define MP_PIN_WRITE  (2)
33 #define MP_PIN_INPUT  (3)
34 #define MP_PIN_OUTPUT (4)
35 
36 // Pin protocol
37 typedef struct _mp_pin_p_t {
38     mp_uint_t (*ioctl)(mp_obj_t obj, mp_uint_t request, uintptr_t arg, int *errcode);
39 } mp_pin_p_t;
40 
41 int mp_virtual_pin_read(mp_obj_t pin);
42 void mp_virtual_pin_write(mp_obj_t pin, int value);
43 
44 // If a port exposes a Pin object, it's constructor should be like this
45 mp_obj_t mp_pin_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args);
46 
47 #endif // MICROPY_INCLUDED_EXTMOD_VIRTPIN_H
48