/
terminal-m0.s
172 lines (149 loc) · 7.57 KB
/
terminal-m0.s
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
@ swdcom terminal functions
@ Copyright (c) 2020, Jan Bramkamp <crest+swdcom@rlwinm.de>
@ Copyright (c) 2020, Robert Clausecker <fuz@fuz.su>
@ All rights reserved.
@
@ Redistribution and use in source and binary forms, with or without
@ modification, are permitted provided that the following conditions are met:
@
@ 1. Redistributions of source code must retain the above copyright notice, this
@ list of conditions and the following disclaimer.
@
@ 2. Redistributions in binary form must reproduce the above copyright notice,
@ this list of conditions and the following disclaimer in the documentation
@ and/or other materials provided with the distribution.
@
@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
@ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
@ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
@ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
@ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@ Instead of the normal USART these terminal words use a pair of ring buffers
@ in SRAM. The PC (ab)uses the STLINK/V2 as remote memory access interface.
@ All four indices are stores in a single 32 bit word allowing the host
@ to poll them all with a single 32 bit memory read. Updates to the indices
@ use 8 bit writes.
@ The ring buffers are used as single producer, single consumer queues to
@ decouple bursty producers from their consumer.
@ The buffer base address is permanently stored in register R11 allowing the
@ host PC to stop the core, read the address from R11 and resume the core.
@
@ In a simple benchmark this code transfered >90 kilobyte/second from a
@ STM32L476 at 48MHz through the STLINK/V2 to the host PC running swd2
@ on FreeBSD 12.1 and >100 kilobyte/second in the opposite direction.
@ The "words" word finishes in a fraction of a second.
@
@ Compared to normal USART initialization this code is almost hardware
@ independent and a lot easier to port.
@
@ The terminal program for the host PC that goes with this code is hosted at:
@
@ https://github.com/Crest/swdcom
@
@ Memory Layout of the buffer pair:
@
@ SWD_Base + 0x0000 : RX buffer write index
@ SWD_Base + 0x0001 : RX buffer read index
@ SWD_Base + 0x0002 : TX buffer write index
@ SWD_Base + 0x0003 : TX buffer read index
@ SWD_Base + 0x0104 : 256 bytes of RX buffer space
@ SWD_Base + 0x0204 : 256 bytes of TX buffer space
@
@ The host PC is only allowed to write to these locations:
@ * The RX buffer write index
@ * The TX buffer read index
@ * The unallocated range of the RX buffer space wrapping around at the end
@ TODO: Replace ramallot for with a call to ram_allot.
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd"
@ -----------------------------------------------------------------------------
dup @ In theory the rest could be written in forth
mov tos, r11 @ with just knowledge of this constant, but
bx lr @ it would require a two stage bootstrap.
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd-init"
@ -----------------------------------------------------------------------------
uart_init: @ Hijack the usart_init symbol to minimize code changes
push {lr}
ldr r0, =Dictionarypointer @ Assumes that the directory pointer points to a word aligned address in SRAM.
ldr r1, [r0] @ Load the start of free space
movs r0, 0 @ Initialize all four indices to zero.
str r0, [r1]
mov r11, r1 @ Save the base address in R11. This makes the code
@ slightly faster and allows the host PC to autodiscover
@ the buffer address.
dup @ Allocate the required 4 + 2*256 bytes
pushdaconstw 516 @ Ignore failure. There is nothing we can do
bl allot @ to recover and there should always be at least
pop {pc} @ this much free SRAM on start up.
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd-key?" @ ( -- ? )
@ -----------------------------------------------------------------------------
serial_qkey: @ Hijack the serial_qkey symbol to minimize code changes
push {lr} @ Yield the CPU
bl pause
dup
mov r2, r11 @ Load SWD buffer base address into a low register
ldrb r0, [r2] @ Load RX write index
ldrb r1, [r2, 1] @ Load RX read index
movs tos, 0 @ Assume that the RX buffer is empty (read == write)
cmp r0, r1 @ Test the assumption
beq 1f @ Change from 0 to -1 if the assumption was incorrect
subs tos, 1
1: pop {pc}
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd-emit?" @ ( -- ? )
@ -----------------------------------------------------------------------------
serial_qemit: @ Hijack the serial_qemit symbol to minimize code changes
push {lr} @ Yield the CPU
bl pause
dup
mov r2, r11 @ Load SWD buffer base address into a low register
ldrb r0, [r2, 2] @ Load TX write index
ldrb r1, [r2, 3] @ Load TX read index
adds r0, 1 @ Check if RX write index + 1 == RX read index
uxtb r0, r0 @ clear possible carry
movs tos, 0 @ Assume that the TX buffer is full (write + 1 == RX)
cmp r0, r1 @ Test the assumption
beq 1f @ Change from 0 to -1 if the assumption was incorrect
subs tos, 1
1: pop {pc}
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd-key" @ ( -- c )
@ -----------------------------------------------------------------------------
serial_key: @ Hijack the serial_key symbol to minimize code changes
dup
mov r2, r11 @ Load SWD buffer base address into a low register
ldrb r0, [r2, 1] @ Cache RX read index
1: ldrb r1, [r2, 0] @ Load RX write index
cmp r0, r1 @ Wait while RX read == RX write
beq 1b
adds r1, r0, 4 @ The next byte is at R11 + 4 + RX read
ldrb tos, [r1, r2] @ Load the byte that was written
adds r0, 1 @ Advance the read index one byte
strb r0, [r2, 1] @ And write it to the ring buffer
bx lr
@ -----------------------------------------------------------------------------
Wortbirne Flag_visible, "swd-emit" @ ( c -- )
@ -----------------------------------------------------------------------------
serial_emit: @ Hijack the serial_emit symbol to minimize code changes
mov r3, r11 @ Load SWD buffer base address into a low register
ldrb r0, [r3, 2] @ Cache TX write index
adds r1, r0, 1 @ Increment TX write index % 256
uxtb r1, r1
1: ldrb r2, [r3, 3] @ Load TX read index
cmp r1, r2 @ Wait while TX write + 1 == TX read
beq 1b
adds r0, r0, 255 @ Store the next byte at R11 + 4 + 256 + TX write
adds r0, r0, 5
strb tos, [r0, r3]
strb r1, [r3, 2]
drop
bx lr
.include "../common/terminalhooks.s"
.ltorg @ Flush constant pool