File: microbituart.cpp

package info (click to toggle)
firmware-microbit-micropython 1.0.1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 25,448 kB
  • sloc: ansic: 83,496; cpp: 27,664; python: 2,475; asm: 274; makefile: 245; javascript: 41; sh: 25
file content (218 lines) | stat: -rw-r--r-- 7,634 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 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.
 */

extern "C" {

#include <errno.h>
#include "pinmap.h"
#include "serial_api.h"
#include "py/runtime.h"
#include "py/stream.h"
#include "py/mphal.h"
#include "microbit/modmicrobit.h"

// There is only one UART peripheral and it's already used by stdio (and
// connected to USB serial).  So to access the UART we go through the
// mp_hal_stdio functions.  The init method can reconfigure the underlying
// UART peripheral to a different baudrate and/or pins.

typedef struct _microbit_uart_obj_t {
    mp_obj_base_t base;
} microbit_uart_obj_t;

// timeout (in ms) to wait between characters when reading
STATIC uint16_t microbit_uart_timeout_char = 0;

STATIC mp_obj_t microbit_uart_init(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_baudrate, MP_ARG_INT, {.u_int = 9600} },
        { MP_QSTR_bits,     MP_ARG_INT, {.u_int = 8} },
        { MP_QSTR_parity,   MP_ARG_OBJ, {.u_obj = mp_const_none} },
        { MP_QSTR_stop,     MP_ARG_INT, {.u_int = 1} },
        { MP_QSTR_pins,     MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
        { MP_QSTR_tx,       MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
        { MP_QSTR_rx,       MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
    };

    // parse args
    //microbit_uart_obj_t *self = (microbit_uart_obj_t*)pos_args[0];
    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);

    SerialParity parity;
    if (args[2].u_obj == mp_const_none) {
        parity = ParityNone;
    } else {
        parity = (SerialParity)mp_obj_get_int(args[2].u_obj);
    }

    // default pins are the internal USB-UART pins
    PinName p_tx = TGT_TX;
    PinName p_rx = TGT_RX;

    // set tx/rx pins if they are given
    if (args[5].u_obj != mp_const_none) {
        p_tx = (PinName)microbit_obj_get_pin_name(args[5].u_obj);
    }
    if (args[6].u_obj != mp_const_none) {
        p_rx = (PinName)microbit_obj_get_pin_name(args[6].u_obj);
    }

    // support for legacy "pins" argument
    if (args[4].u_obj != mp_const_none) {
        mp_obj_t *pins;
        mp_obj_get_array_fixed_n(args[4].u_obj, 2, &pins);
        p_tx = (PinName)microbit_obj_get_pin_name(pins[0]);
        p_rx = (PinName)microbit_obj_get_pin_name(pins[1]);
    }

    // initialise the uart
    // Note: we don't want to call serial_init() because it sends a single 0x00
    // character on the line during initialisation.  This function has anyway
    // already been called by the MicroBitSerial constructor so it's enough to
    // just reconfigure the pins here, as would have been done by serial_init().
    serial_t serial;
    serial.uart = NRF_UART0;
    NRF_GPIO->DIR |= (1 << p_tx);
    NRF_GPIO->DIR &= ~(1 << p_rx);
    NRF_UART0->PSELTXD = p_tx;
    NRF_UART0->PSELRXD = p_rx;
    pin_mode(p_tx, PullUp);
    pin_mode(p_rx, PullUp);
    serial_baud(&serial, args[0].u_int);
    serial_format(&serial, args[1].u_int, parity, args[3].u_int);

    // set the character read timeout based on the baudrate and 13 bits
    microbit_uart_timeout_char = 13000 / args[0].u_int + 1;

    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_KW(microbit_uart_init_obj, 1, microbit_uart_init);

STATIC mp_obj_t microbit_uart_any(mp_obj_t self_in) {
    (void)self_in;
    if (mp_hal_stdin_rx_any()) {
        return mp_const_true;
    } else {
        return mp_const_false;
    }
}
MP_DEFINE_CONST_FUN_OBJ_1(microbit_uart_any_obj, microbit_uart_any);

STATIC const mp_map_elem_t microbit_uart_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_init), (mp_obj_t)&microbit_uart_init_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_any), (mp_obj_t)&microbit_uart_any_obj },

    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mp_stream_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_readline), (mp_obj_t)&mp_stream_unbuffered_readline_obj},
    { MP_OBJ_NEW_QSTR(MP_QSTR_readinto), (mp_obj_t)&mp_stream_readinto_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&mp_stream_write_obj },

    { MP_OBJ_NEW_QSTR(MP_QSTR_ODD), MP_OBJ_NEW_SMALL_INT(ParityOdd) },
    { MP_OBJ_NEW_QSTR(MP_QSTR_EVEN), MP_OBJ_NEW_SMALL_INT(ParityEven) },
};

STATIC MP_DEFINE_CONST_DICT(microbit_uart_locals_dict, microbit_uart_locals_dict_table);

// Waits at most timeout_ms for at least 1 char to become ready for reading.
// Returns true if something available, false if not.
STATIC bool microbit_uart_rx_wait(uint32_t timeout_ms) {
    uint32_t start = mp_hal_ticks_ms();
    for (;;) {
        if (mp_hal_stdin_rx_any()) {
            return true; // have at least 1 character waiting
        }
        if (mp_hal_ticks_ms() - start >= timeout_ms) {
            return false; // timeout
        }
    }
}

STATIC mp_uint_t microbit_uart_read(mp_obj_t self_in, void *buf_in, mp_uint_t size, int *errcode) {
    (void)self_in;
    byte *buf = (byte*)buf_in;
    (void)errcode;

    // make sure we want at least 1 char
    if (size == 0) {
        return 0;
    }

    // check there is at least 1 char available
    if (!mp_hal_stdin_rx_any()) {
        *errcode = EAGAIN;
        return MP_STREAM_ERROR;
    }

    // read the data
    byte *orig_buf = buf;
    for (;;) {
        *buf++ = mp_hal_stdin_rx_chr();
        if (--size == 0 || !microbit_uart_rx_wait(microbit_uart_timeout_char)) {
            // return number of bytes read
            return buf - orig_buf;
        }
    }
}

STATIC mp_uint_t microbit_uart_write(mp_obj_t self_in, const void *buf_in, mp_uint_t size, int *errcode) {
    (void)self_in;
    const char *buf = (const char*)buf_in;
    (void)errcode;
    mp_hal_stdout_tx_strn(buf, size);
    return size;
}

STATIC const mp_stream_p_t microbit_uart_stream_p = {
    .read = microbit_uart_read,
    .write = microbit_uart_write,
    .ioctl = NULL,
    .is_text = false,
};

const mp_obj_type_t microbit_uart_type = {
    { &mp_type_type },
    .name = MP_QSTR_MicroBitUART,
    .print = NULL,
    .make_new = NULL,
    .call = NULL,
    .unary_op = NULL,
    .binary_op = NULL,
    .attr = NULL,
    .subscr = NULL,
    .getiter = NULL,
    .iternext = NULL,
    .buffer_p = {NULL},
    .protocol = &microbit_uart_stream_p,
    .parent = NULL,
    .locals_dict = (mp_obj_dict_t*)&microbit_uart_locals_dict,
};

microbit_uart_obj_t microbit_uart_obj = {
    {&microbit_uart_type},
};

}