esp8266: Add basic pyb.Pin class; supports output mode only.

5 files changed, 225 insertions, 0 deletions

diff --git a/esp8266/Makefile b/esp8266/Makefile
index 76b16b1502..0728e8a56d 100644
--- a/esp8266/Makefile
+++ b/esp8266/Makefile
@@ -47,6 +47,7 @@ SRC_C = \
 	gccollect.c \
 	uart.c \
 	modpyb.c \
+	modpybpin.c \
 	modesp.c \
 
 STM_SRC_C = $(addprefix stmhal/,\
diff --git a/esp8266/modpyb.c b/esp8266/modpyb.c
index 2687803ea6..c4eb35d57b 100644
--- a/esp8266/modpyb.c
+++ b/esp8266/modpyb.c
@@ -33,6 +33,7 @@
 #include "pyexec.h"
 #include MICROPY_HAL_H
 #include "user_interface.h"
+#include "modpyb.h"
 
 STATIC mp_obj_t pyb_info(mp_uint_t n_args, const mp_obj_t *args) {
     // print info about memory
@@ -156,6 +157,8 @@ STATIC const mp_map_elem_t pyb_module_globals_table[] = {
     { MP_OBJ_NEW_QSTR(MP_QSTR_udelay), (mp_obj_t)&pyb_udelay_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_sync), (mp_obj_t)&pyb_sync_obj },
     { MP_OBJ_NEW_QSTR(MP_QSTR_hard_reset), (mp_obj_t)&pyb_hard_reset_obj },
+
+    { MP_OBJ_NEW_QSTR(MP_QSTR_Pin), (mp_obj_t)&pyb_pin_type },
 };
 
 STATIC MP_DEFINE_CONST_DICT(pyb_module_globals, pyb_module_globals_table);
diff --git a/esp8266/modpyb.h b/esp8266/modpyb.h
new file mode 100644
index 0000000000..87dac5227a
--- /dev/null
+++ b/esp8266/modpyb.h
@@ -0,0 +1 @@
+extern const mp_obj_type_t pyb_pin_type;
diff --git a/esp8266/modpybpin.c b/esp8266/modpybpin.c
new file mode 100644
index 0000000000..0089e71ab2
--- /dev/null
+++ b/esp8266/modpybpin.c
@@ -0,0 +1,205 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2013, 2014, 2015 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.
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <string.h>
+
+#include "c_types.h"
+#include "user_interface.h"
+#include "gpio.h"
+
+#include "py/nlr.h"
+#include "py/runtime.h"
+#include "modpyb.h"
+
+#define GPIO_MODE_INPUT (0)
+#define GPIO_MODE_OUTPUT (1)
+#define GPIO_PULL_NONE (0)
+#define GPIO_PULL_UP (1)
+#define GPIO_PULL_DOWN (2)
+
+typedef struct _pyb_pin_obj_t {
+    mp_obj_base_t base;
+    uint16_t pin_id;
+    uint16_t phys_port;
+    uint32_t periph;
+    uint16_t func;
+} pyb_pin_obj_t;
+
+STATIC const pyb_pin_obj_t pyb_pin_obj[] = {
+    {{&pyb_pin_type}, 0, 0, PERIPHS_IO_MUX_GPIO0_U, FUNC_GPIO0},
+    {{&pyb_pin_type}, 1, 1, PERIPHS_IO_MUX_U0TXD_U, FUNC_GPIO1},
+    {{&pyb_pin_type}, 2, 2, PERIPHS_IO_MUX_GPIO2_U, FUNC_GPIO2},
+    {{&pyb_pin_type}, 3, 3, PERIPHS_IO_MUX_U0RXD_U, FUNC_GPIO3},
+    {{&pyb_pin_type}, 4, 4, PERIPHS_IO_MUX_GPIO4_U, FUNC_GPIO4},
+    {{&pyb_pin_type}, 5, 5, PERIPHS_IO_MUX_GPIO5_U, FUNC_GPIO5},
+    {{&pyb_pin_type}, 9, 9, PERIPHS_IO_MUX_SD_DATA2_U, FUNC_GPIO9},
+    {{&pyb_pin_type}, 10, 10, PERIPHS_IO_MUX_SD_DATA3_U, FUNC_GPIO10},
+    {{&pyb_pin_type}, 12, 12, PERIPHS_IO_MUX_MTDI_U, FUNC_GPIO12},
+    {{&pyb_pin_type}, 13, 13, PERIPHS_IO_MUX_MTCK_U, FUNC_GPIO13},
+    {{&pyb_pin_type}, 14, 14, PERIPHS_IO_MUX_MTMS_U, FUNC_GPIO14},
+    {{&pyb_pin_type}, 15, 15, PERIPHS_IO_MUX_MTDO_U, FUNC_GPIO15},
+};
+
+STATIC void pyb_pin_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
+    pyb_pin_obj_t *self = self_in;
+
+    // pin name
+    print(env, "Pin(%u)", self->pin_id);
+}
+
+// pin.init(mode, pull=Pin.PULL_NONE, af=-1)
+STATIC mp_obj_t pyb_pin_obj_init_helper(pyb_pin_obj_t *self, mp_uint_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_mode, MP_ARG_REQUIRED | MP_ARG_INT },
+        { MP_QSTR_pull,                   MP_ARG_INT, {.u_int = GPIO_PULL_NONE}},
+    };
+
+    // parse args
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    // get io mode
+    uint mode = args[0].u_int;
+
+    // get pull mode
+    uint pull = args[1].u_int;
+
+    // configure the GPIO as requested
+    PIN_FUNC_SELECT(self->periph, self->func);
+    if ((pull & GPIO_PULL_DOWN) == 0) {
+        PIN_PULLDWN_DIS(self->periph);
+    }
+    if ((pull & GPIO_PULL_UP) == 0) {
+        PIN_PULLUP_DIS(self->periph);
+    }
+    if ((pull & GPIO_PULL_DOWN) != 0) {
+        PIN_PULLDWN_EN(self->periph);
+    }
+    if ((pull & GPIO_PULL_UP) != 0) {
+        PIN_PULLUP_EN(self->periph);
+    }
+
+    // TODO input mode is not working...
+    if ((mode & GPIO_MODE_OUTPUT) == 0) {
+        GPIO_DIS_OUTPUT(self->phys_port);
+    }
+
+    return mp_const_none;
+}
+
+// constructor(id, ...)
+STATIC mp_obj_t pyb_pin_make_new(mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
+    mp_arg_check_num(n_args, n_kw, 1, MP_OBJ_FUN_ARGS_MAX, true);
+
+    // Run an argument through the mapper and return the result.
+    int wanted_pin = mp_obj_get_int(args[0]);
+    pyb_pin_obj_t *pin = NULL;
+    for (int i = 0; i < MP_ARRAY_SIZE(pyb_pin_obj); i++) {
+        if (pyb_pin_obj[i].pin_id == wanted_pin) {
+            pin = (pyb_pin_obj_t*)&pyb_pin_obj[i];
+            break;
+        }
+    }
+    if (pin == NULL) {
+        nlr_raise(mp_obj_new_exception_msg(&mp_type_ValueError, "invalid pin"));
+    }
+
+    if (n_args > 1 || n_kw > 0) {
+        // pin mode given, so configure this GPIO
+        mp_map_t kw_args;
+        mp_map_init_fixed_table(&kw_args, n_kw, args + n_args);
+        pyb_pin_obj_init_helper(pin, n_args - 1, args + 1, &kw_args);
+    }
+
+    return (mp_obj_t)pin;
+}
+
+// pin.init(mode, pull)
+STATIC mp_obj_t pyb_pin_obj_init(mp_uint_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
+    return pyb_pin_obj_init_helper(args[0], n_args - 1, args + 1, kw_args);
+}
+MP_DEFINE_CONST_FUN_OBJ_KW(pyb_pin_init_obj, 1, pyb_pin_obj_init);
+
+// pin.value([value])
+STATIC mp_obj_t pyb_pin_value(mp_uint_t n_args, const mp_obj_t *args) {
+    pyb_pin_obj_t *self = args[0];
+    if (n_args == 1) {
+        // get pin
+        return MP_OBJ_NEW_SMALL_INT(GPIO_INPUT_GET(self->phys_port));
+    } else {
+        // set pin
+        if (mp_obj_is_true(args[1])) {
+            GPIO_OUTPUT_SET(self->phys_port, 1);
+        } else {
+            GPIO_OUTPUT_SET(self->phys_port, 0);
+        }
+        return mp_const_none;
+    }
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(pyb_pin_value_obj, 1, 2, pyb_pin_value);
+
+// pin.low()
+STATIC mp_obj_t pyb_pin_low(mp_obj_t self_in) {
+    pyb_pin_obj_t *self = self_in;
+    GPIO_OUTPUT_SET(self->phys_port, 0);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_low_obj, pyb_pin_low);
+
+// pin.high()
+STATIC mp_obj_t pyb_pin_high(mp_obj_t self_in) {
+    pyb_pin_obj_t *self = self_in;
+    GPIO_OUTPUT_SET(self->phys_port, 1);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_pin_high_obj, pyb_pin_high);
+
+STATIC const mp_map_elem_t pyb_pin_locals_dict_table[] = {
+    // instance methods
+    { MP_OBJ_NEW_QSTR(MP_QSTR_init),    (mp_obj_t)&pyb_pin_init_obj },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_value),   (mp_obj_t)&pyb_pin_value_obj },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_low),     (mp_obj_t)&pyb_pin_low_obj },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_high),    (mp_obj_t)&pyb_pin_high_obj },
+
+    // class constants
+    { MP_OBJ_NEW_QSTR(MP_QSTR_IN),        MP_OBJ_NEW_SMALL_INT(GPIO_MODE_INPUT) },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_OUT_PP),    MP_OBJ_NEW_SMALL_INT(GPIO_MODE_OUTPUT) },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_PULL_NONE), MP_OBJ_NEW_SMALL_INT(GPIO_PULL_NONE) },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_PULL_UP),   MP_OBJ_NEW_SMALL_INT(GPIO_PULL_UP) },
+    { MP_OBJ_NEW_QSTR(MP_QSTR_PULL_DOWN), MP_OBJ_NEW_SMALL_INT(GPIO_PULL_DOWN) },
+};
+
+STATIC MP_DEFINE_CONST_DICT(pyb_pin_locals_dict, pyb_pin_locals_dict_table);
+
+const mp_obj_type_t pyb_pin_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_Pin,
+    .print = pyb_pin_print,
+    .make_new = pyb_pin_make_new,
+    .locals_dict = (mp_obj_t)&pyb_pin_locals_dict,
+};
diff --git a/esp8266/qstrdefsport.h b/esp8266/qstrdefsport.h
index 692e8233fe..5781b91165 100644
--- a/esp8266/qstrdefsport.h
+++ b/esp8266/qstrdefsport.h
@@ -46,3 +46,18 @@ Q(connect)
 Q(disconnect)
 Q(scan)
 Q(status)
+
+// Pin class
+Q(Pin)
+Q(init)
+Q(mode)
+Q(pull)
+Q(value)
+Q(low)
+Q(high)
+Q(IN)
+Q(OUT_PP)
+Q(OUT_OD)
+Q(PULL_NONE)
+Q(PULL_UP)
+Q(PULL_DOWN)