-
Notifications
You must be signed in to change notification settings - Fork 70
Expand file tree
/
Copy pathrvswd_module.c
More file actions
399 lines (350 loc) · 16.6 KB
/
rvswd_module.c
File metadata and controls
399 lines (350 loc) · 16.6 KB
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
/**
* MicroPython bindings for the esp32-component-rvswd RVSWD programmer.
* Exposes an RVSWD class for programming WCH CH32 microcontrollers from Python.
*
* Usage:
* from rvswd import RVSWD
* from lib.drivers.fri3d.expander import Expander
* from machine import Pin, I2C
* import time
*
* expander_i2c = I2C(0, sda=Pin(39), scl=Pin(42), freq=400000)
* expander = Expander(i2c_bus=expander_i2c)
* time.sleep(.1)
*
* # TODO: check the version before flashing
* print("version:", ".".join(str(i) for i in expander.version))
*
* expander.config = 0x0B # trigger SWD enable
* time.sleep(.2)
*
* prog = RVSWD(39, 42)
*
* # optional check, already halts the MCU
* vendor = prog.read_vendor_bytes()
* if (vendor[1] & 0xffffff0f) != 0x03560601:
* raise RuntimeError("CH32X035G8U6 not detected")
*
* # flash
* with open('firmware.bin', 'rb') as f:
* fw = f.read()
* prog.x03x_program(fw, lambda msg, pct: print(f"{msg}: {pct}%"))
*
* # give it some time to boot
* time.sleep(4)
*
* # check the new version number
* expander_i2c = I2C(0, sda=Pin(39), scl=Pin(42), freq=400000)
* expander = Expander(i2c_bus=expander_i2c)
* print("version:", ".".join(str(i) for i in expander.version))
*/
#include "py/obj.h"
#include "py/runtime.h"
#include "py/mphal.h"
#include <string.h>
#include "rvswd.h"
#include "rvswd_ch32.h"
#include "rvswd_ch32v20x.h"
#include "rvswd_ch32x03x.h"
// ---------------------------------------------------------------------------
// Object type
// ---------------------------------------------------------------------------
typedef struct {
mp_obj_base_t base;
rvswd_handle_t handle;
} rvswd_obj_t;
// ---------------------------------------------------------------------------
// Callback bridge
// Single-threaded MicroPython GIL makes a global safe here;
// these flash functions are blocking and never re-entrant.
// ---------------------------------------------------------------------------
static mp_obj_t g_status_callback = MP_OBJ_NULL;
static void c_status_callback(char const *msg, uint8_t progress) {
if (g_status_callback != MP_OBJ_NULL && g_status_callback != mp_const_none) {
mp_obj_t call_args[2] = {
mp_obj_new_str(msg, strlen(msg)),
MP_OBJ_NEW_SMALL_INT(progress),
};
mp_call_function_n_kw(g_status_callback, 2, 0, call_args);
}
}
// ---------------------------------------------------------------------------
// Internal helpers
// ---------------------------------------------------------------------------
static void raise_rvswd_result(rvswd_result_t result) {
switch (result) {
case RVSWD_OK: return;
case RVSWD_FAIL: mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("RVSWD operation failed")); break;
case RVSWD_INVALID_ARGS: mp_raise_ValueError(MP_ERROR_TEXT("RVSWD invalid arguments")); break;
case RVSWD_PARITY_ERROR: mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("RVSWD parity error")); break;
default: mp_raise_msg_varg(&mp_type_RuntimeError, MP_ERROR_TEXT("RVSWD error: %d"), (int)result); break;
}
}
// ---------------------------------------------------------------------------
// Constructor: RVSWD(swdio, swclk)
// ---------------------------------------------------------------------------
static mp_obj_t rvswd_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
mp_arg_check_num(n_args, n_kw, 2, 2, false);
rvswd_obj_t *self = mp_obj_malloc(rvswd_obj_t, type);
self->handle.swdio = (gpio_num_t)mp_obj_get_int(args[0]);
self->handle.swclk = (gpio_num_t)mp_obj_get_int(args[1]);
rvswd_result_t result = rvswd_init(&self->handle);
if (result != RVSWD_OK) {
mp_raise_msg_varg(&mp_type_RuntimeError, MP_ERROR_TEXT("rvswd_init failed: %d"), (int)result);
}
return MP_OBJ_FROM_PTR(self);
}
// ---------------------------------------------------------------------------
// Low-level RVSWD protocol
// ---------------------------------------------------------------------------
static mp_obj_t mprvswd_reset(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
raise_rvswd_result(rvswd_reset(&self->handle));
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_reset_obj, mprvswd_reset);
static mp_obj_t mprvswd_write_reg(mp_obj_t self_in, mp_obj_t reg_in, mp_obj_t val_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint8_t reg = (uint8_t)mp_obj_get_int(reg_in);
uint32_t val = (uint32_t)mp_obj_get_int(val_in);
raise_rvswd_result(rvswd_write(&self->handle, reg, val));
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_3(rvswd_write_reg_obj, mprvswd_write_reg);
static mp_obj_t mprvswd_read_reg(mp_obj_t self_in, mp_obj_t reg_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint8_t reg = (uint8_t)mp_obj_get_int(reg_in);
uint32_t val = 0;
raise_rvswd_result(rvswd_read(&self->handle, reg, &val));
return mp_obj_new_int_from_uint(val);
}
MP_DEFINE_CONST_FUN_OBJ_2(rvswd_read_reg_obj, mprvswd_read_reg);
// ---------------------------------------------------------------------------
// CH32 generic debug operations
// ---------------------------------------------------------------------------
static mp_obj_t mprvswd_halt(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
raise_rvswd_result(ch32_halt_microprocessor(&self->handle));
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_halt_obj, mprvswd_halt);
static mp_obj_t mprvswd_resume(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
raise_rvswd_result(ch32_resume_microprocessor(&self->handle));
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_resume_obj, mprvswd_resume);
static mp_obj_t mprvswd_reset_and_run(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
raise_rvswd_result(ch32_reset_microprocessor_and_run(&self->handle));
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_reset_and_run_obj, mprvswd_reset_and_run);
static mp_obj_t mprvswd_read_memory(mp_obj_t self_in, mp_obj_t addr_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint32_t addr = (uint32_t)mp_obj_get_int(addr_in);
uint32_t val = 0;
if (!ch32_read_memory_word(&self->handle, addr, &val)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32_read_memory_word failed"));
}
return mp_obj_new_int_from_uint(val);
}
MP_DEFINE_CONST_FUN_OBJ_2(rvswd_read_memory_obj, mprvswd_read_memory);
static mp_obj_t mprvswd_write_memory(mp_obj_t self_in, mp_obj_t addr_in, mp_obj_t val_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint32_t addr = (uint32_t)mp_obj_get_int(addr_in);
uint32_t val = (uint32_t)mp_obj_get_int(val_in);
if (!ch32_write_memory_word(&self->handle, addr, val)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32_write_memory_word failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_3(rvswd_write_memory_obj, mprvswd_write_memory);
// Returns a 4-tuple of uint32 vendor bytes for chip identification.
static mp_obj_t mprvswd_read_vendor_bytes(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
uint32_t vendor_bytes[4] = {0, 0, 0, 0};
if (!ch32_read_vendor_bytes(&self->handle, vendor_bytes)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32_read_vendor_bytes failed"));
}
mp_obj_t tuple[4];
for (int i = 0; i < 4; i++) {
tuple[i] = mp_obj_new_int_from_uint(vendor_bytes[i]);
}
return mp_obj_new_tuple(4, tuple);
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_read_vendor_bytes_obj, mprvswd_read_vendor_bytes);
// ---------------------------------------------------------------------------
// CH32V20x flash operations
// ---------------------------------------------------------------------------
// v20x_program(firmware[, callback])
// High-level: halts, erases, writes, verifies and restarts the target.
static mp_obj_t mprvswd_v20x_program(size_t n_args, const mp_obj_t *args) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(args[0]);
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
g_status_callback = (n_args > 2) ? args[2] : mp_const_none;
ch32v20x_status_callback cb = (g_status_callback != mp_const_none) ? c_status_callback : NULL;
bool ok = ch32v20x_program(&self->handle, bufinfo.buf, bufinfo.len, cb);
g_status_callback = MP_OBJ_NULL;
if (!ok) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32v20x_program failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rvswd_v20x_program_obj, 2, 3, mprvswd_v20x_program);
static mp_obj_t mprvswd_v20x_unlock_flash(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32v20x_unlock_flash(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32v20x_unlock_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_v20x_unlock_flash_obj, mprvswd_v20x_unlock_flash);
static mp_obj_t mprvswd_v20x_lock_flash(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32v20x_lock_flash(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32v20x_lock_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_v20x_lock_flash_obj, mprvswd_v20x_lock_flash);
// v20x_write_flash(addr, data[, callback])
// data: bytes-like object with firmware content
// callback: optional callable(msg: str, progress: int)
static mp_obj_t mprvswd_v20x_write_flash(size_t n_args, const mp_obj_t *args) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(args[0]);
uint32_t addr = (uint32_t)mp_obj_get_int(args[1]);
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[2], &bufinfo, MP_BUFFER_READ);
g_status_callback = (n_args > 3) ? args[3] : mp_const_none;
ch32v20x_status_callback cb = (g_status_callback != mp_const_none) ? c_status_callback : NULL;
bool ok = ch32v20x_write_flash(&self->handle, addr, bufinfo.buf, bufinfo.len, cb);
g_status_callback = MP_OBJ_NULL;
if (!ok) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32v20x_write_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rvswd_v20x_write_flash_obj, 3, 4, mprvswd_v20x_write_flash);
static mp_obj_t mprvswd_v20x_clear_ops(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32v20x_clear_running_operations(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32v20x_clear_running_operations failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_v20x_clear_ops_obj, mprvswd_v20x_clear_ops);
// ---------------------------------------------------------------------------
// CH32x03x flash operations
// ---------------------------------------------------------------------------
// x03x_program(firmware[, callback])
// High-level: halts, erases, writes, verifies and restarts the target.
static mp_obj_t mprvswd_x03x_program(size_t n_args, const mp_obj_t *args) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(args[0]);
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
g_status_callback = (n_args > 2) ? args[2] : mp_const_none;
ch32x03x_status_callback cb = (g_status_callback != mp_const_none) ? c_status_callback : NULL;
bool ok = ch32x03x_program(&self->handle, bufinfo.buf, bufinfo.len, cb);
g_status_callback = MP_OBJ_NULL;
if (!ok) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32x03x_program failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rvswd_x03x_program_obj, 2, 3, mprvswd_x03x_program);
static mp_obj_t mprvswd_x03x_unlock_flash(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32x03x_unlock_flash(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32x03x_unlock_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_x03x_unlock_flash_obj, mprvswd_x03x_unlock_flash);
static mp_obj_t mprvswd_x03x_lock_flash(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32x03x_lock_flash(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32x03x_lock_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_x03x_lock_flash_obj, mprvswd_x03x_lock_flash);
// x03x_write_flash(addr, data[, callback])
static mp_obj_t mprvswd_x03x_write_flash(size_t n_args, const mp_obj_t *args) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(args[0]);
uint32_t addr = (uint32_t)mp_obj_get_int(args[1]);
mp_buffer_info_t bufinfo;
mp_get_buffer_raise(args[2], &bufinfo, MP_BUFFER_READ);
g_status_callback = (n_args > 3) ? args[3] : mp_const_none;
ch32x03x_status_callback cb = (g_status_callback != mp_const_none) ? c_status_callback : NULL;
bool ok = ch32x03x_write_flash(&self->handle, addr, bufinfo.buf, bufinfo.len, cb);
g_status_callback = MP_OBJ_NULL;
if (!ok) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32x03x_write_flash failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(rvswd_x03x_write_flash_obj, 3, 4, mprvswd_x03x_write_flash);
static mp_obj_t mprvswd_x03x_clear_ops(mp_obj_t self_in) {
rvswd_obj_t *self = MP_OBJ_TO_PTR(self_in);
if (!ch32x03x_clear_running_operations(&self->handle)) {
mp_raise_msg(&mp_type_RuntimeError, MP_ERROR_TEXT("ch32x03x_clear_running_operations failed"));
}
return mp_const_none;
}
MP_DEFINE_CONST_FUN_OBJ_1(rvswd_x03x_clear_ops_obj, mprvswd_x03x_clear_ops);
// ---------------------------------------------------------------------------
// Type definition
// ---------------------------------------------------------------------------
static const mp_rom_map_elem_t rvswd_locals_dict_table[] = {
// Low-level RVSWD protocol
{ MP_ROM_QSTR(MP_QSTR_reset), MP_ROM_PTR(&rvswd_reset_obj) },
{ MP_ROM_QSTR(MP_QSTR_write_reg), MP_ROM_PTR(&rvswd_write_reg_obj) },
{ MP_ROM_QSTR(MP_QSTR_read_reg), MP_ROM_PTR(&rvswd_read_reg_obj) },
// CH32 generic
{ MP_ROM_QSTR(MP_QSTR_halt), MP_ROM_PTR(&rvswd_halt_obj) },
{ MP_ROM_QSTR(MP_QSTR_resume), MP_ROM_PTR(&rvswd_resume_obj) },
{ MP_ROM_QSTR(MP_QSTR_reset_and_run), MP_ROM_PTR(&rvswd_reset_and_run_obj) },
{ MP_ROM_QSTR(MP_QSTR_read_memory), MP_ROM_PTR(&rvswd_read_memory_obj) },
{ MP_ROM_QSTR(MP_QSTR_write_memory), MP_ROM_PTR(&rvswd_write_memory_obj) },
{ MP_ROM_QSTR(MP_QSTR_read_vendor_bytes), MP_ROM_PTR(&rvswd_read_vendor_bytes_obj) },
// CH32V20x
{ MP_ROM_QSTR(MP_QSTR_v20x_program), MP_ROM_PTR(&rvswd_v20x_program_obj) },
{ MP_ROM_QSTR(MP_QSTR_v20x_unlock_flash), MP_ROM_PTR(&rvswd_v20x_unlock_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_v20x_lock_flash), MP_ROM_PTR(&rvswd_v20x_lock_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_v20x_write_flash), MP_ROM_PTR(&rvswd_v20x_write_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_v20x_clear_ops), MP_ROM_PTR(&rvswd_v20x_clear_ops_obj) },
// CH32x03x
{ MP_ROM_QSTR(MP_QSTR_x03x_program), MP_ROM_PTR(&rvswd_x03x_program_obj) },
{ MP_ROM_QSTR(MP_QSTR_x03x_unlock_flash), MP_ROM_PTR(&rvswd_x03x_unlock_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_x03x_lock_flash), MP_ROM_PTR(&rvswd_x03x_lock_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_x03x_write_flash), MP_ROM_PTR(&rvswd_x03x_write_flash_obj) },
{ MP_ROM_QSTR(MP_QSTR_x03x_clear_ops), MP_ROM_PTR(&rvswd_x03x_clear_ops_obj) },
};
static MP_DEFINE_CONST_DICT(rvswd_locals_dict, rvswd_locals_dict_table);
MP_DEFINE_CONST_OBJ_TYPE(
rvswd_type,
MP_QSTR_RVSWD,
MP_TYPE_FLAG_NONE,
make_new, rvswd_make_new,
locals_dict, &rvswd_locals_dict
);
// ---------------------------------------------------------------------------
// Module definition
// ---------------------------------------------------------------------------
static const mp_rom_map_elem_t rvswd_module_globals_table[] = {
{ MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_rvswd) },
{ MP_ROM_QSTR(MP_QSTR_RVSWD), MP_ROM_PTR(&rvswd_type) },
// rvswd_result_t constants
{ MP_ROM_QSTR(MP_QSTR_OK), MP_ROM_INT(RVSWD_OK) },
{ MP_ROM_QSTR(MP_QSTR_FAIL), MP_ROM_INT(RVSWD_FAIL) },
{ MP_ROM_QSTR(MP_QSTR_INVALID_ARGS), MP_ROM_INT(RVSWD_INVALID_ARGS) },
{ MP_ROM_QSTR(MP_QSTR_PARITY_ERROR), MP_ROM_INT(RVSWD_PARITY_ERROR) },
};
static MP_DEFINE_CONST_DICT(rvswd_module_globals, rvswd_module_globals_table);
const mp_obj_module_t rvswd_user_cmodule = {
.base = { &mp_type_module },
.globals = (mp_obj_dict_t *)&rvswd_module_globals,
};
MP_REGISTER_MODULE(MP_QSTR_rvswd, rvswd_user_cmodule);