uart.c 13.2 KB
Newer Older
1
2
3
#include <stdio.h>
#include <string.h>

4
5
6
#include "stm32f4xx_hal.h"

#include "nlr.h"
7
8
9
10
#include "misc.h"
#include "mpconfig.h"
#include "qstr.h"
#include "obj.h"
11
12
#include "runtime.h"
#include "bufhelper.h"
Damien George's avatar
Damien George committed
13
#include "uart.h"
14

15
16
// Usage model:
//
Damien George's avatar
Damien George committed
17
18
// See usage model of I2C in i2c.c.  UART is very similar.  Main difference is
// parameters to init the UART bus:
19
//
Damien George's avatar
Damien George committed
20
21
22
//     from pyb import UART
//     uart = UART(1, 9600)                         # init with given baudrate
//     uart.init(9600, bits=8, stop=1, parity=None) # init with given parameters
23
24
25
26
27
//
// Bits can be 8 or 9, stop can be 1 or 2, parity can be None, 0 (even), 1 (odd).
//
// Extra method:
//
Damien George's avatar
Damien George committed
28
//     uart.any()               # returns True if any characters waiting
29

Damien George's avatar
Damien George committed
30
struct _pyb_uart_obj_t {
Dave Hylands's avatar
Dave Hylands committed
31
    mp_obj_base_t base;
Damien George's avatar
Damien George committed
32
    pyb_uart_t uart_id;
Dave Hylands's avatar
Dave Hylands committed
33
    bool is_enabled;
34
    UART_HandleTypeDef uart;
Dave Hylands's avatar
Dave Hylands committed
35
};
36

Damien George's avatar
Damien George committed
37
pyb_uart_obj_t *pyb_uart_global_debug = NULL;
38

39
// assumes Init parameters have been set up correctly
Damien George's avatar
Damien George committed
40
41
bool uart_init2(pyb_uart_obj_t *uart_obj) {
    USART_TypeDef *UARTx = NULL;
42

43
    uint32_t GPIO_Pin = 0;
Damien George's avatar
Damien George committed
44
    uint8_t  GPIO_AF_UARTx = 0;
45
    GPIO_TypeDef* GPIO_Port = NULL;
46

Damien George's avatar
Damien George committed
47
48
49
50
51
    switch (uart_obj->uart_id) {
        // USART1 is on PA9/PA10 (CK on PA8), PB6/PB7
        case PYB_UART_1:
            UARTx = USART1;
            GPIO_AF_UARTx = GPIO_AF7_USART1;
52

Damien George's avatar
Damien George committed
53
#if defined (PYBV4) || defined(PYBV10)
54
55
56
            GPIO_Port = GPIOB;
            GPIO_Pin = GPIO_PIN_6 | GPIO_PIN_7;
#else
57
58
            GPIO_Port = GPIOA;
            GPIO_Pin = GPIO_PIN_9 | GPIO_PIN_10;
59
#endif
60
61
62

            __USART1_CLK_ENABLE();
            break;
63

Damien George's avatar
Damien George committed
64
65
66
67
        // USART2 is on PA2/PA3 (CK on PA4), PD5/PD6 (CK on PD7)
        case PYB_UART_2:
            UARTx = USART2;
            GPIO_AF_UARTx = GPIO_AF7_USART2;
68

Damien George's avatar
Damien George committed
69
70
            GPIO_Port = GPIOA;
            GPIO_Pin = GPIO_PIN_2 | GPIO_PIN_3;
71
72
73

            __USART2_CLK_ENABLE();
            break;
74

Damien George's avatar
Damien George committed
75
76
77
78
        // USART3 is on PB10/PB11 (CK on PB12), PC10/PC11 (CK on PC12), PD8/PD9 (CK on PD10)
        case PYB_UART_3:
            UARTx = USART3;
            GPIO_AF_UARTx = GPIO_AF7_USART3;
79

80
#if defined(PYBV3) || defined(PYBV4) | defined(PYBV10)
81
82
83
84
85
86
87
88
            GPIO_Port = GPIOB;
            GPIO_Pin = GPIO_PIN_10 | GPIO_PIN_11;
#else
            GPIO_Port = GPIOD;
            GPIO_Pin = GPIO_PIN_8 | GPIO_PIN_9;
#endif
            __USART3_CLK_ENABLE();
            break;
89

90
        // UART4 is on PA0/PA1, PC10/PC11
Damien George's avatar
Damien George committed
91
92
93
        case PYB_UART_4:
            UARTx = UART4;
            GPIO_AF_UARTx = GPIO_AF8_UART4;
94
95
96
97
98
99
100

            GPIO_Port = GPIOA;
            GPIO_Pin = GPIO_PIN_0 | GPIO_PIN_1;

            __UART4_CLK_ENABLE();
            break;

Damien George's avatar
Damien George committed
101
102
103
104
        // USART6 is on PC6/PC7 (CK on PC8)
        case PYB_UART_6:
            UARTx = USART6;
            GPIO_AF_UARTx = GPIO_AF8_USART6;
105
106
107
108
109
110

            GPIO_Port = GPIOC;
            GPIO_Pin = GPIO_PIN_6 | GPIO_PIN_7;

            __USART6_CLK_ENABLE();
            break;
111
112
113

        default:
            return false;
114
115
    }

116
    // init GPIO
117
118
119
120
121
    GPIO_InitTypeDef GPIO_InitStructure;
    GPIO_InitStructure.Pin = GPIO_Pin;
    GPIO_InitStructure.Speed = GPIO_SPEED_HIGH;
    GPIO_InitStructure.Mode = GPIO_MODE_AF_PP;
    GPIO_InitStructure.Pull = GPIO_PULLUP;
Damien George's avatar
Damien George committed
122
    GPIO_InitStructure.Alternate = GPIO_AF_UARTx;
123
124
    HAL_GPIO_Init(GPIO_Port, &GPIO_InitStructure);

Damien George's avatar
Damien George committed
125
126
127
    // init UARTx
    uart_obj->uart.Instance = UARTx;
    HAL_UART_Init(&uart_obj->uart);
128

Damien George's avatar
Damien George committed
129
    uart_obj->is_enabled = true;
130
131
132
133

    return true;
}

Damien George's avatar
Damien George committed
134
135
bool uart_init(pyb_uart_obj_t *uart_obj, uint32_t baudrate) {
    UART_HandleTypeDef *uh = &uart_obj->uart;
Dave Hylands's avatar
Dave Hylands committed
136
137
    memset(uh, 0, sizeof(*uh));
    uh->Init.BaudRate = baudrate;
138
139
140
141
    uh->Init.WordLength = UART_WORDLENGTH_8B;
    uh->Init.StopBits = UART_STOPBITS_1;
    uh->Init.Parity = UART_PARITY_NONE;
    uh->Init.Mode = UART_MODE_TX_RX;
Dave Hylands's avatar
Dave Hylands committed
142
143
    uh->Init.HwFlowCtl = UART_HWCONTROL_NONE;
    uh->Init.OverSampling = UART_OVERSAMPLING_16;
Damien George's avatar
Damien George committed
144
    return uart_init2(uart_obj);
145
}
146

Damien George's avatar
Damien George committed
147
148
149
void uart_deinit(pyb_uart_obj_t *uart_obj) {
    uart_obj->is_enabled = false;
    UART_HandleTypeDef *uart = &uart_obj->uart;
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
    HAL_UART_DeInit(uart);
    if (uart->Instance == USART1) {
        __USART1_FORCE_RESET();
        __USART1_RELEASE_RESET();
        __USART1_CLK_DISABLE();
    } else if (uart->Instance == USART2) {
        __USART2_FORCE_RESET();
        __USART2_RELEASE_RESET();
        __USART2_CLK_DISABLE();
    } else if (uart->Instance == USART3) {
        __USART3_FORCE_RESET();
        __USART3_RELEASE_RESET();
        __USART3_CLK_DISABLE();
    } else if (uart->Instance == UART4) {
        __UART4_FORCE_RESET();
        __UART4_RELEASE_RESET();
        __UART4_CLK_DISABLE();
    } else if (uart->Instance == USART6) {
        __USART6_FORCE_RESET();
        __USART6_RELEASE_RESET();
        __USART6_CLK_DISABLE();
    }
172
173
}

Damien George's avatar
Damien George committed
174
175
bool uart_rx_any(pyb_uart_obj_t *uart_obj) {
    return __HAL_UART_GET_FLAG(&uart_obj->uart, UART_FLAG_RXNE);
176
177
}

Damien George's avatar
Damien George committed
178
int uart_rx_char(pyb_uart_obj_t *uart_obj) {
179
    uint8_t ch;
Damien George's avatar
Damien George committed
180
    if (HAL_UART_Receive(&uart_obj->uart, &ch, 1, 0) != HAL_OK) {
181
182
183
184
185
        ch = 0;
    }
    return ch;
}

Damien George's avatar
Damien George committed
186
void uart_tx_char(pyb_uart_obj_t *uart_obj, int c) {
187
    uint8_t ch = c;
Damien George's avatar
Damien George committed
188
    HAL_UART_Transmit(&uart_obj->uart, &ch, 1, 100000);
189
190
}

Damien George's avatar
Damien George committed
191
192
void uart_tx_str(pyb_uart_obj_t *uart_obj, const char *str) {
    HAL_UART_Transmit(&uart_obj->uart, (uint8_t*)str, strlen(str), 100000);
193
194
}

Damien George's avatar
Damien George committed
195
196
void uart_tx_strn(pyb_uart_obj_t *uart_obj, const char *str, uint len) {
    HAL_UART_Transmit(&uart_obj->uart, (uint8_t*)str, len, 100000);
197
198
}

Damien George's avatar
Damien George committed
199
void uart_tx_strn_cooked(pyb_uart_obj_t *uart_obj, const char *str, uint len) {
200
201
    for (const char *top = str + len; str < top; str++) {
        if (*str == '\n') {
Damien George's avatar
Damien George committed
202
            uart_tx_char(uart_obj, '\r');
203
        }
Damien George's avatar
Damien George committed
204
        uart_tx_char(uart_obj, *str);
205
206
207
208
209
210
    }
}

/******************************************************************************/
/* Micro Python bindings                                                      */

Damien George's avatar
Damien George committed
211
212
STATIC void pyb_uart_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
    pyb_uart_obj_t *self = self_in;
213
    if (!self->is_enabled) {
Damien George's avatar
Damien George committed
214
        print(env, "UART(%lu)", self->uart_id);
215
    } else {
Damien George's avatar
Damien George committed
216
217
        print(env, "UART(%lu, baudrate=%u, bits=%u, stop=%u",
            self->uart_id, self->uart.Init.BaudRate,
218
219
220
221
222
223
224
225
            self->uart.Init.WordLength == UART_WORDLENGTH_8B ? 8 : 9,
            self->uart.Init.StopBits == UART_STOPBITS_1 ? 1 : 2);
        if (self->uart.Init.Parity == UART_PARITY_NONE) {
            print(env, ", parity=None)");
        } else {
            print(env, ", parity=%u)", self->uart.Init.Parity == UART_PARITY_EVEN ? 0 : 1);
        }
    }
226
227
}

228
229
230
231
232
STATIC const mp_arg_t pyb_uart_init_args[] = {
    { MP_QSTR_baudrate, MP_ARG_REQUIRED | MP_ARG_INT, {.u_int = 9600} },
    { MP_QSTR_bits,     MP_ARG_KW_ONLY | MP_ARG_INT,  {.u_int = 8} },
    { MP_QSTR_stop,     MP_ARG_KW_ONLY | MP_ARG_INT,  {.u_int = 1} },
    { MP_QSTR_parity,   MP_ARG_KW_ONLY | MP_ARG_OBJ,  {.u_obj = mp_const_none} },
233
};
234
#define PYB_UART_INIT_NUM_ARGS ARRAY_SIZE(pyb_uart_init_args)
235

Damien George's avatar
Damien George committed
236
STATIC mp_obj_t pyb_uart_init_helper(pyb_uart_obj_t *self, uint n_args, const mp_obj_t *args, mp_map_t *kw_args) {
237
    // parse args
238
239
    mp_arg_val_t vals[PYB_UART_INIT_NUM_ARGS];
    mp_arg_parse_all(n_args, args, kw_args, PYB_UART_INIT_NUM_ARGS, pyb_uart_init_args, vals);
240

Damien George's avatar
Damien George committed
241
    // set the UART configuration values
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
    memset(&self->uart, 0, sizeof(self->uart));
    UART_InitTypeDef *init = &self->uart.Init;
    init->BaudRate = vals[0].u_int;
    init->WordLength = vals[1].u_int == 8 ? UART_WORDLENGTH_8B : UART_WORDLENGTH_9B;
    switch (vals[2].u_int) {
        case 1: init->StopBits = UART_STOPBITS_1; break;
        default: init->StopBits = UART_STOPBITS_2; break;
    }
    if (vals[3].u_obj == mp_const_none) {
        init->Parity = UART_PARITY_NONE;
    } else {
        machine_int_t parity = mp_obj_get_int(vals[3].u_obj);
        init->Parity = (parity & 1) ? UART_PARITY_ODD : UART_PARITY_EVEN;
    }
    init->Mode = UART_MODE_TX_RX;
    init->HwFlowCtl = UART_HWCONTROL_NONE;
    init->OverSampling = UART_OVERSAMPLING_16;

Damien George's avatar
Damien George committed
260
261
262
    // init UART (if it fails, it's because the port doesn't exist)
    if (!uart_init2(self)) {
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "UART port %d does not exist", self->uart_id));
263
264
    }

265
266
267
    return mp_const_none;
}

Damien George's avatar
Damien George committed
268
STATIC mp_obj_t pyb_uart_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
269
270
271
    // check arguments
    mp_arg_check_num(n_args, n_kw, 1, MP_OBJ_FUN_ARGS_MAX, true);

272
    // create object
Damien George's avatar
Damien George committed
273
274
    pyb_uart_obj_t *o = m_new_obj(pyb_uart_obj_t);
    o->base.type = &pyb_uart_type;
275

276
    // work out port
Damien George's avatar
Damien George committed
277
    o->uart_id = 0;
278
279
    if (MP_OBJ_IS_STR(args[0])) {
        const char *port = mp_obj_str_get_str(args[0]);
280
281
282
        if (0) {
#if defined(PYBV10)
        } else if (strcmp(port, "XA") == 0) {
Damien George's avatar
Damien George committed
283
            o->uart_id = PYB_UART_XA;
284
        } else if (strcmp(port, "XB") == 0) {
Damien George's avatar
Damien George committed
285
            o->uart_id = PYB_UART_XB;
286
        } else if (strcmp(port, "YA") == 0) {
Damien George's avatar
Damien George committed
287
            o->uart_id = PYB_UART_YA;
288
        } else if (strcmp(port, "YB") == 0) {
Damien George's avatar
Damien George committed
289
            o->uart_id = PYB_UART_YB;
290
#endif
291
        } else {
Damien George's avatar
Damien George committed
292
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_ValueError, "UART port %s does not exist", port));
293
        }
294
    } else {
Damien George's avatar
Damien George committed
295
        o->uart_id = mp_obj_get_int(args[0]);
296
297
    }

298
299
300
301
    if (n_args > 1 || n_kw > 0) {
        // start the peripheral
        mp_map_t kw_args;
        mp_map_init_fixed_table(&kw_args, n_kw, args + n_args);
Damien George's avatar
Damien George committed
302
        pyb_uart_init_helper(o, n_args - 1, args + 1, &kw_args);
303
304
    }

305
306
307
    return o;
}

Damien George's avatar
Damien George committed
308
309
STATIC mp_obj_t pyb_uart_init(uint n_args, const mp_obj_t *args, mp_map_t *kw_args) {
    return pyb_uart_init_helper(args[0], n_args - 1, args + 1, kw_args);
310
}
Damien George's avatar
Damien George committed
311
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(pyb_uart_init_obj, 1, pyb_uart_init);
312

Damien George's avatar
Damien George committed
313
314
315
STATIC mp_obj_t pyb_uart_deinit(mp_obj_t self_in) {
    pyb_uart_obj_t *self = self_in;
    uart_deinit(self);
316
317
    return mp_const_none;
}
Damien George's avatar
Damien George committed
318
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_uart_deinit_obj, pyb_uart_deinit);
319

Damien George's avatar
Damien George committed
320
321
322
STATIC mp_obj_t pyb_uart_any(mp_obj_t self_in) {
    pyb_uart_obj_t *self = self_in;
    if (uart_rx_any(self)) {
323
324
325
326
327
        return mp_const_true;
    } else {
        return mp_const_false;
    }
}
Damien George's avatar
Damien George committed
328
STATIC MP_DEFINE_CONST_FUN_OBJ_1(pyb_uart_any_obj, pyb_uart_any);
329

330
331
332
STATIC const mp_arg_t pyb_uart_send_args[] = {
    { MP_QSTR_send,    MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
    { MP_QSTR_timeout, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 5000} },
333
};
334
#define PYB_UART_SEND_NUM_ARGS ARRAY_SIZE(pyb_uart_send_args)
335

Damien George's avatar
Damien George committed
336
STATIC mp_obj_t pyb_uart_send(uint n_args, const mp_obj_t *args, mp_map_t *kw_args) {
337
    // TODO assumes transmission size is 8-bits wide
338

Damien George's avatar
Damien George committed
339
    pyb_uart_obj_t *self = args[0];
340

341
    // parse args
342
343
    mp_arg_val_t vals[PYB_UART_SEND_NUM_ARGS];
    mp_arg_parse_all(n_args - 1, args + 1, kw_args, PYB_UART_SEND_NUM_ARGS, pyb_uart_send_args, vals);
344
345
346
347
348
349
350
351
352
353
354
355

    // get the buffer to send from
    mp_buffer_info_t bufinfo;
    uint8_t data[1];
    pyb_buf_get_for_send(vals[0].u_obj, &bufinfo, data);

    // send the data
    HAL_StatusTypeDef status = HAL_UART_Transmit(&self->uart, bufinfo.buf, bufinfo.len, vals[1].u_int);

    if (status != HAL_OK) {
        // TODO really need a HardwareError object, or something
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_Exception, "HAL_UART_Transmit failed with code %d", status));
356
    }
357

358
359
    return mp_const_none;
}
Damien George's avatar
Damien George committed
360
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(pyb_uart_send_obj, 1, pyb_uart_send);
361

362
363
364
STATIC const mp_arg_t pyb_uart_recv_args[] = {
    { MP_QSTR_recv,    MP_ARG_REQUIRED | MP_ARG_OBJ, {.u_obj = MP_OBJ_NULL} },
    { MP_QSTR_timeout, MP_ARG_KW_ONLY | MP_ARG_INT, {.u_int = 5000} },
365
};
366
#define PYB_UART_RECV_NUM_ARGS ARRAY_SIZE(pyb_uart_recv_args)
367

Damien George's avatar
Damien George committed
368
STATIC mp_obj_t pyb_uart_recv(uint n_args, const mp_obj_t *args, mp_map_t *kw_args) {
369
    // TODO assumes transmission size is 8-bits wide
370

Damien George's avatar
Damien George committed
371
    pyb_uart_obj_t *self = args[0];
372

373
    // parse args
374
375
    mp_arg_val_t vals[PYB_UART_RECV_NUM_ARGS];
    mp_arg_parse_all(n_args - 1, args + 1, kw_args, PYB_UART_RECV_NUM_ARGS, pyb_uart_recv_args, vals);
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395

    // get the buffer to receive into
    mp_buffer_info_t bufinfo;
    mp_obj_t o_ret = pyb_buf_get_for_recv(vals[0].u_obj, &bufinfo);

    // receive the data
    HAL_StatusTypeDef status = HAL_UART_Receive(&self->uart, bufinfo.buf, bufinfo.len, vals[1].u_int);

    if (status != HAL_OK) {
        // TODO really need a HardwareError object, or something
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_Exception, "HAL_UART_Receive failed with code %d", status));
    }

    // return the received data
    if (o_ret == MP_OBJ_NULL) {
        return vals[0].u_obj;
    } else {
        return mp_obj_str_builder_end(o_ret);
    }
}
Damien George's avatar
Damien George committed
396
STATIC MP_DEFINE_CONST_FUN_OBJ_KW(pyb_uart_recv_obj, 1, pyb_uart_recv);
397

Damien George's avatar
Damien George committed
398
STATIC const mp_map_elem_t pyb_uart_locals_dict_table[] = {
399
    // instance methods
Damien George's avatar
Damien George committed
400
401
402
403
404
    { MP_OBJ_NEW_QSTR(MP_QSTR_init), (mp_obj_t)&pyb_uart_init_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_deinit), (mp_obj_t)&pyb_uart_deinit_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_any), (mp_obj_t)&pyb_uart_any_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_send), (mp_obj_t)&pyb_uart_send_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_recv), (mp_obj_t)&pyb_uart_recv_obj },
405
406
};

Damien George's avatar
Damien George committed
407
STATIC MP_DEFINE_CONST_DICT(pyb_uart_locals_dict, pyb_uart_locals_dict_table);
408

Damien George's avatar
Damien George committed
409
const mp_obj_type_t pyb_uart_type = {
410
    { &mp_type_type },
Damien George's avatar
Damien George committed
411
412
413
414
    .name = MP_QSTR_UART,
    .print = pyb_uart_print,
    .make_new = pyb_uart_make_new,
    .locals_dict = (mp_obj_t)&pyb_uart_locals_dict,
415
};