-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathGDB-SerialMirror.spin
465 lines (393 loc) · 35.4 KB
/
GDB-SerialMirror.spin
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
{{
SerialMirror.spin : V07.05.10
Derived from: Full-Duplex Serial Driver v1.1
┌────────────────────────────────────────────────┐
│ Copyright (c) 2007 Mirror / 2006 Parallax Inc. │
│ (See end of file for terms of use) │
└────────────────────────────────────────────────┘
It has been extended in the following ways:
1) Make allowance for different buffer sizes. I've set the default buffer to
64 bytes as this is large enough to contain a complete incoming/outgoing
message for my protocol.
2) Check for a stop bit!! If a stop bit is not present then the received byte
is dropped. No flags of any sort are set. It's up to a higher level of the
protocol to check the message for integrity.
3) Variables have been moved to DAT space.
The significance of this is not obvious at first, but what it means is that
every instance of this object shares the same variable space. Why do this?
If you have multiple nested objects, then serial comms can be added to all
of them. ONLY the top object must call the start method. The nested objects
then have full comms access. A simple example is:
┌────────────────────────────────────────────────────────────────────┐
│ APP_SerialMirror.spin │
├────────────────────────────────────────────────────────────────────┤
│CON │
│ _clkmode = xtal1 + pll16x │
│ _xinfreq = 5_000_000 │
│ │
│ BaudRate = 38400 'Baud │
│ RxPin = 31 'For RS232 │
│ TxPin = 30 'For RS232 │
│ CommsMode = %0000 'See SerialMirror.spin for meaning │
│ │
│OBJ │
│ Debug : "SerialMirror" │
│ Test : "TestObject" │
│ │
│PUB Start │
│ Debug.start(RxPin, TxPin, CommsMode, BaudRate) │
│ Test.SayHello │
└────────────────────────────────────────────────────────────────────┘
┌────────────────────────────────────────────────────────────────────┐
│ TestObject.spin │
├────────────────────────────────────────────────────────────────────┤
│OBJ │
│ Debug : "SerialMirror" │
│ │
│PUB SayHello │
│ Debug.str(string("Hello",13,10)) │
└────────────────────────────────────────────────────────────────────┘
4) This object is NOT suitable for driving multiple serial ports.
If you want multiple serial ports each with single object access, then
use FullDuplexSerial.
If you want serial comms through the same port from multiple objects,
then use THIS object.
If you want multiple serial ports each with multi-object usage, then copy
and rename this files for the number of unique serial ports.
5) Added GetNumber which will receive a number (positive or negative) from
the serial port in either decimal, binary or hexadecimal notation.
6) Added extra comments to the assembler section - for the newbies. I've been
doing this propeller stuff for a month now, so I guess that makes me an
old hand.
7) Added CrLf which does just that - purely a conveniance function for me.
}}
CON
'BEWARE BEWARE : buffer_length can be any one of:
' 2, 4, 8, 16, 32, 64, 128 or 256
' BUT, if you change it, you MUST also make sure that the rx_buffer and
' tx_buffer variables are adjusted in the DAT space. This is because there
' is no way to declare an array in DAT space, so the length must be
' manually defined.
buffer_length = 64
buffer_mask = buffer_length - 1
''
''Parallax Serial Terminal Control Character Constants
''────────────────────────────────────────────────────
HOME = 1 ''HOME = 1
CRSRXY = 2 ''CRSRXY = 2
CRSRLF = 3 ''CRSRLF = 3
CRSRRT = 4 ''CRSRRT = 4
CRSRUP = 5 ''CRSRUP = 5
CRSRDN = 6 ''CRSRDN = 6
BELL = 7 ''BELL = 7
BKSP = 8 ''BKSP = 8
TAB = 9 ''TAB = 9
LF = 10 ''LF = 10
CLREOL = 11 ''CLREOL = 11
CLRDN = 12 ''CLRDN = 12
CR = 13 ''CR = 13
CRSRX = 14 ''CRSRX = 14
CRSRY = 15 ''CRSRY = 15
CLS = 16 ''CLS = 16
DEBUG_STATE = true
DAT
cog long 0 'cog flag/id
rx_head long 0 '9 contiguous longs
rx_tail long 0
tx_head long 0
tx_tail long 0
rx_pin long 0
tx_pin long 0
rxtx_mode long 0
bit_ticks long 0
buffer_ptr long 0
'Set these buffers to the buffer_length constant in bytes.
'longs are used as a shortcut - 1 long == 4 bytes.
rx_buffer long 0, 0, 0, 0, 0, 0, 0, 0 '32 bytes
long 0, 0, 0, 0, 0, 0, 0, 0 '64 bytes
tx_buffer long 0, 0, 0, 0, 0, 0, 0, 0 '32 bytes
long 0, 0, 0, 0, 0, 0, 0, 0 '64 bytes
PUB start(rxpin, txpin, mode, baudrate) : okay
{{
Start serial driver - starts a cog
returns false if no cog available
mode bit 0 = invert rx
mode bit 1 = invert tx
mode bit 2 = open-drain/source tx
mode bit 3 = ignore tx echo on rx
}}
stop
longfill(@rx_head, 0, 4)
longmove(@rx_pin, @rxpin, 3)
bit_ticks := clkfreq / baudrate
buffer_ptr := @rx_buffer
okay := cog := cognew(@entry, @rx_head) + 1
PUB stop
{{
Stop serial driver - frees a cog
}}
if cog
cogstop(cog~ - 1)
longfill(@rx_head, 0, 9)
PUB rxflush
{{
Flush receive buffer
}}
repeat while rxcheck => 0
PUB rxcheck : rxbyte
{{
Check if byte received (never waits)
returns -1 if no byte received, $00..$FF if byte
}}
rxbyte--
if rx_tail <> rx_head
rxbyte := byte[@rx_buffer][rx_tail]
rx_tail := (rx_tail + 1) & buffer_mask
PUB rxtime(ms) : rxbyte | t
{{
Wait ms milliseconds for a byte to be received
returns -1 if no byte received, $00..$FF if byte
}}
t := cnt
repeat until (rxbyte := rxcheck) => 0 or (cnt - t) / (clkfreq / 1000) > ms
PUB rx : rxbyte
{{
Receive byte (may wait for byte)
returns $00..$FF
}}
repeat while (rxbyte := rxcheck) < 0
PUB tx(txbyte)
{{
Send byte (may wait for room in buffer)
}}
'Wait till there's space in the Tx buffer
repeat until (tx_tail <> (tx_head + 1) & buffer_mask)
byte[@tx_buffer][tx_head] := txbyte
tx_head := (tx_head + 1) & buffer_mask
if rxtx_mode & %1000
rx
PUB str(stringptr)
{{
Send string
}}
repeat strsize(stringptr)
tx(byte[stringptr++])
PUB dec(value) | i
{{
Print a decimal number
}}
if value < 0
-value
tx("-")
i := 1_000_000_000
repeat 10
if value => i
tx(value / i + "0")
value //= i
result~~
elseif result or i == 1
tx("0")
i /= 10
PUB hex(value, digits)
{{
Print a hexadecimal number
}}
value <<= (8 - digits) << 2
repeat digits
tx(lookupz((value <-= 4) & $F : "0".."9", "A".."F"))
PUB bin(value, digits)
{{
Print a binary number
}}
value <<= 32 - digits
repeat digits
tx((value <-= 1) & 1 + "0")
PUB GetNumber : value | base, digit, cmd, negative
{{
Get a number from the serial port. The number may start with a "-" if its
negative. This may be followed by digits for a decimal number, "%" then
0..1's for a binary number and "$" then digits or "A".."F" (or "a".."f")
for a hexidecimal number. The first illegal character terminates number
entry.
}}
negative := 1
value := 0
base := 10
cmd := rx
if cmd == "-"
negative := -1
cmd := rx
if cmd == "%"
base := 2
elseif cmd == "$"
base := 16
else
value := lookdown(cmd : "0".."9") - 1
if value < 0
abort
repeat
cmd := rx
if base == 10
digit := lookdown(cmd : "0".."9") - 1
elseif base == 2
digit := lookdown(cmd : "0".."1") - 1
elseif base == 16
digit := lookdown(cmd : "0".."9", "A".."F", "a".."f") - 1
if digit => 16 'Compensate for the lower case letters
digit -= 6
if digit < 0 'All done?
return value * negative
value := value * base + digit
PUB CrLf
{{
Send a carriage return linefeed combination.
}}
tx(13)
tx(10)
DAT
'***********************************
'* Assembly language serial driver *
'***********************************
org
'
'
' Entry
'
entry mov t1,par 'get structure address
add t1,#4 << 2 'skip past heads and tails
rdlong t2,t1 'get rx_pin
mov rxmask,#1
shl rxmask,t2
add t1,#4 'get tx_pin
rdlong t2,t1
mov txmask,#1
shl txmask,t2
add t1,#4 'get rxtx_mode
rdlong rxtxmode,t1
add t1,#4 'get bit_ticks
rdlong bitticks,t1
add t1,#4 'get buffer_ptr ...
rdlong rxbuff,t1 '... for the receiver
mov txbuff,rxbuff '... and the transmitter
add txbuff,#buffer_length
test rxtxmode,#%100 wz 'if_nz = open drain Tx
test rxtxmode,#%010 wc 'if_c = inverted output
if_z_ne_c or outa,txmask
if_z or dira,txmask
mov rxcode,#0 'for Gear debugger
mov txcode,#transmit 'initialize ping-pong multitasking
'
'
' Receive
'
receive jmpret rxcode,txcode 'run a chunk of transmit code, then return
test rxtxmode,#%001 wz 'wait for start bit on rx pin
test rxmask,ina wc
if_z_eq_c jmp #receive
mov rxbits,#9 'ready to receive byte
mov rxcnt,bitticks
shr rxcnt,#1 'half a bit tick
add rxcnt,cnt '+ the current clock
:bit add rxcnt,bitticks 'ready for the middle of the bit period
:wait jmpret rxcode,txcode 'run a chuck of transmit code, then return
mov t1,rxcnt 'check if bit receive period done
sub t1,cnt
cmps t1,#0 wc
if_nc jmp #:wait
test rxmask,ina wc 'receive bit on rx pin into carry
rcr rxdata,#1 'shift carry into receiver
djnz rxbits,#:bit 'go get another bit till done
test rxtxmode,#%001 wz 'find out if rx is inverted
if_z_ne_c jmp #receive 'abort if no stop bit
shr rxdata,#32-9 'justify and trim received byte
and rxdata,#$FF
if_nz xor rxdata,#$FF 'if rx inverted, invert byte
rdlong t2,par 'rx_head
add t2,rxbuff 'plus the buffer offset
wrbyte rxdata,t2 'write the byte
sub t2,rxbuff
add t2,#1 'update rx_head
and t2,#buffer_mask
wrlong t2,par 'and save
jmp #receive 'byte done, receive next byte
'
'
' Transmit
'
transmit jmpret txcode,rxcode 'run a chunk of receive code, then return
mov t1,par 'check for head <> tail
add t1,#2 << 2 'tx_head
rdlong t2,t1
add t1,#1 << 2 'tx_tail
rdlong t3,t1
cmp t2,t3 wz
if_z jmp #transmit
add t3,txbuff 'get byte and inc tail
rdbyte txdata,t3
sub t3,txbuff
add t3,#1
and t3,#buffer_mask
wrlong t3,t1
or txdata,#$100 'or in a stop bit
shl txdata,#2
or txdata,#1 'or in a idle line state and a start bit
mov txbits,#11
mov txcnt,cnt
:bit test rxtxmode,#%100 wz 'output bit on tx pin according to mode
test rxtxmode,#%010 wc
if_z_and_c xor txdata,#1
shr txdata,#1 wc
if_z muxc outa,txmask
if_nz muxnc dira,txmask
add txcnt,bitticks 'ready next cnt
:wait jmpret txcode,rxcode 'run a chunk of receive code, then return
mov t1,txcnt 'check if bit transmit period done
sub t1,cnt
cmps t1,#0 wc
if_nc jmp #:wait
djnz txbits,#:bit 'another bit to transmit?
jmp #transmit 'byte done, transmit next byte
'
'
' Uninitialized data
'
t1 res 1
t2 res 1
t3 res 1
rxtxmode res 1
bitticks res 1
rxmask res 1
rxbuff res 1
rxdata res 1
rxbits res 1
rxcnt res 1
rxcode res 1
txmask res 1
txbuff res 1
txdata res 1
txbits res 1
txcnt res 1
txcode res 1
{{
┌───────────────────────────────────────────────────────────────────────────┐
│ Terms of use: MIT License │
├───────────────────────────────────────────────────────────────────────────┤
│ 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. │
└───────────────────────────────────────────────────────────────────────────┘
}}