File: microbitspi.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 (170 lines) | stat: -rw-r--r-- 6,573 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
/*
 * This file is part of the MicroPython project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2017 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 "spi_api.h"
#include "py/runtime.h"
#include "microbit/modmicrobit.h"

typedef struct _microbit_spi_obj_t {
    mp_obj_base_t base;
    spi_t spi;
} microbit_spi_obj_t;

STATIC void microbit_spi_check_initialised(microbit_spi_obj_t *self) {
    // the spi variable will be set to a non-zero value by spi_init()
    if (!self->spi.spi) {
        mp_raise_ValueError("SPI not initialised");
    }
}

STATIC mp_obj_t microbit_spi_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 = 1000000} },
        { MP_QSTR_bits,     MP_ARG_INT, {.u_int = 8} },
        { MP_QSTR_mode,     MP_ARG_INT, {.u_int = 0} },
        { MP_QSTR_sclk,     MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
        { MP_QSTR_mosi,     MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
        { MP_QSTR_miso,     MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none } },
    };

    // parse args
    microbit_spi_obj_t *self = (microbit_spi_obj_t*)pos_args[0];
    struct {
        mp_arg_val_t baudrate, bits, mode, sclk, mosi, miso;
    } args;
    mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args,
        MP_ARRAY_SIZE(allowed_args), allowed_args, (mp_arg_val_t*)&args);

    // get pins
    const microbit_pin_obj_t *sclk = &microbit_p13_obj;
    const microbit_pin_obj_t *mosi = &microbit_p15_obj;
    const microbit_pin_obj_t *miso = &microbit_p14_obj;
    if (args.sclk.u_obj != mp_const_none) {
        sclk = microbit_obj_get_pin(args.sclk.u_obj);
    }
    if (args.mosi.u_obj != mp_const_none) {
        mosi = microbit_obj_get_pin(args.mosi.u_obj);
    }
    if (args.miso.u_obj != mp_const_none) {
        miso = microbit_obj_get_pin(args.miso.u_obj);
    }

    // initialise the pins
    // note: we don't ever free the pins, so init'ing the SPI a second time on
    // different pins will leave the old pins still in SPI mode
    microbit_obj_pin_acquire(sclk, microbit_pin_mode_spi);
    microbit_obj_pin_acquire(mosi, microbit_pin_mode_spi);
    microbit_obj_pin_acquire(miso, microbit_pin_mode_spi);

    // initialise the SPI
    spi_init(&self->spi, (PinName)mosi->name, (PinName)miso->name, (PinName)sclk->name, NC);
    spi_format(&self->spi, args.bits.u_int, args.mode.u_int, 0);
    spi_frequency(&self->spi, args.baudrate.u_int);

    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_KW(microbit_spi_init_obj, 1, microbit_spi_init);

STATIC mp_obj_t microbit_spi_write(mp_obj_t self_in, mp_obj_t buf_in) {
    microbit_spi_obj_t *self = (microbit_spi_obj_t*)self_in;
    microbit_spi_check_initialised(self);
    mp_buffer_info_t bufinfo;
    mp_get_buffer_raise(buf_in, &bufinfo, MP_BUFFER_READ);
    const byte *buf = (const byte*)bufinfo.buf;
    for (uint i = 0; i < bufinfo.len; ++i, ++buf) {
        spi_master_write(&self->spi, *buf);
    }
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_2(microbit_spi_write_obj, microbit_spi_write);

STATIC mp_obj_t microbit_spi_read(size_t n_args, const mp_obj_t *args) {
    microbit_spi_obj_t *self = (microbit_spi_obj_t*)args[0];
    microbit_spi_check_initialised(self);
    vstr_t vstr;
    vstr_init_len(&vstr, mp_obj_get_int(args[1]));
    mp_int_t byte_out = 0;
    if (n_args == 3) {
        byte_out = mp_obj_get_int(args[2]);
    }
    for (uint i = 0; i < vstr.len; ++i) {
        vstr.buf[i] = spi_master_write(&self->spi, byte_out);
    }
    return mp_obj_new_str_from_vstr(&mp_type_bytes, &vstr);
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(microbit_spi_read_obj, 2, 3, microbit_spi_read);

STATIC mp_obj_t microbit_spi_write_readinto(mp_obj_t self_in, mp_obj_t write_buf, mp_obj_t read_buf) {
    microbit_spi_obj_t *self = (microbit_spi_obj_t*)self_in;
    microbit_spi_check_initialised(self);
    mp_buffer_info_t write_bufinfo;
    mp_get_buffer_raise(write_buf, &write_bufinfo, MP_BUFFER_READ);
    const byte *wr_buf = (const byte*)write_bufinfo.buf;
    mp_buffer_info_t read_bufinfo;
    mp_get_buffer_raise(read_buf, &read_bufinfo, MP_BUFFER_WRITE);
    byte *rd_buf = (byte*)read_bufinfo.buf;
    for (uint i = 0; i < write_bufinfo.len; ++i, ++wr_buf, ++rd_buf) {
        *rd_buf = spi_master_write(&self->spi, *wr_buf);
    }
    return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_3(microbit_spi_write_readinto_obj, microbit_spi_write_readinto);

STATIC const mp_map_elem_t microbit_spi_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_init), (mp_obj_t)&microbit_spi_init_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&microbit_spi_write_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&microbit_spi_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_write_readinto), (mp_obj_t)&microbit_spi_write_readinto_obj },
};

STATIC MP_DEFINE_CONST_DICT(microbit_spi_locals_dict, microbit_spi_locals_dict_table);

const mp_obj_type_t microbit_spi_type = {
    { &mp_type_type },
    .name = MP_QSTR_MicroBitSPI,
    .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 = NULL,
    .parent = NULL,
    .locals_dict = (mp_obj_dict_t*)&microbit_spi_locals_dict,
};

microbit_spi_obj_t microbit_spi_obj = {
    {&microbit_spi_type},
    .spi = {},
};

}