06fc054ae9879153e8ce43a0d393d7da1f3f28ed
[fw/altos] / src / stmf0 / ao_serial_stm.c
1 /*
2  * Copyright © 2016 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 #include <ao.h>
16 #include <ao_exti.h>
17
18 void
19 ao_debug_out(char c)
20 {
21         if (c == '\n')
22                 ao_debug_out('\r');
23         while (!(stm_usart1.isr & (1 << STM_USART_ISR_TXE)));
24         stm_usart1.tdr = c;
25 }
26
27 static int
28 _ao_usart_tx_start(struct ao_stm_usart *usart)
29 {
30         if (!ao_fifo_empty(usart->tx_fifo)) {
31 #if HAS_SERIAL_SW_FLOW
32                 if (usart->gpio_cts && ao_gpio_get(usart->gpio_cts, usart->pin_cts, foo) == 1) {
33                         ao_exti_enable(usart->gpio_cts, usart->pin_cts);
34                         return 0;
35                 }
36 #endif
37                 if (usart->reg->isr & (1 << STM_USART_ISR_TXE))
38                 {
39                         usart->tx_running = 1;
40                         usart->reg->cr1 |= (1 << STM_USART_CR1_TXEIE) | (1 << STM_USART_CR1_TCIE);
41                         ao_fifo_remove(usart->tx_fifo, usart->reg->tdr);
42                         ao_wakeup(&usart->tx_fifo);
43                         return 1;
44                 }
45         }
46         return 0;
47 }
48
49 #if HAS_SERIAL_SW_FLOW
50 static void
51 _ao_usart_cts(struct ao_stm_usart *usart)
52 {
53         if (_ao_usart_tx_start(usart))
54                 ao_exti_disable(usart->gpio_cts, usart->pin_cts);
55 }
56 #endif
57
58 static void
59 _ao_usart_rx(struct ao_stm_usart *usart, int stdin)
60 {
61         if (usart->reg->isr & (1 << STM_USART_ISR_RXNE)) {
62                 usart->reg->icr = (1 << STM_USART_ICR_ORECF);
63                 if (!ao_fifo_full(usart->rx_fifo)) {
64                         ao_fifo_insert(usart->rx_fifo, usart->reg->rdr);
65                         ao_wakeup(&usart->rx_fifo);
66                         if (stdin)
67                                 ao_wakeup(&ao_stdin_ready);
68 #if HAS_SERIAL_SW_FLOW
69                         /* If the fifo is nearly full, turn off RTS and wait
70                          * for it to drain a bunch
71                          */
72                         if (usart->gpio_rts && ao_fifo_mostly(usart->rx_fifo)) {
73                                 ao_gpio_set(usart->gpio_rts, usart->pin_rts, usart->pin_rts, 1);
74                                 usart->rts = 0;
75                         }
76 #endif
77                 } else {
78                         usart->reg->cr1 &= ~(1 << STM_USART_CR1_RXNEIE);
79                 }
80         }
81 }
82
83 static void
84 ao_usart_isr(struct ao_stm_usart *usart, int stdin)
85 {
86         _ao_usart_rx(usart, stdin);
87
88         if (!_ao_usart_tx_start(usart))
89                 usart->reg->cr1 &= ~(1<< STM_USART_CR1_TXEIE);
90
91         if (usart->reg->isr & (1 << STM_USART_ISR_TC)) {
92                 usart->tx_running = 0;
93                 usart->reg->cr1 &= ~(1 << STM_USART_CR1_TCIE);
94                 if (usart->draining) {
95                         usart->draining = 0;
96                         ao_wakeup(&usart->tx_fifo);
97                 }
98         }
99 }
100
101 static int
102 _ao_usart_pollchar(struct ao_stm_usart *usart)
103 {
104         int     c;
105
106         if (ao_fifo_empty(usart->rx_fifo))
107                 c = AO_READ_AGAIN;
108         else {
109                 uint8_t u;
110                 ao_fifo_remove(usart->rx_fifo,u);
111                 if ((usart->reg->cr1 & (1 << STM_USART_CR1_RXNEIE)) == 0) {
112                         if (ao_fifo_barely(usart->rx_fifo))
113                                 usart->reg->cr1 |= (1 << STM_USART_CR1_RXNEIE);
114                 }
115 #if HAS_SERIAL_SW_FLOW
116                 /* If we've cleared RTS, check if there's space now and turn it back on */
117                 if (usart->gpio_rts && usart->rts == 0 && ao_fifo_barely(usart->rx_fifo)) {
118                         ao_gpio_set(usart->gpio_rts, usart->pin_rts, foo, 0);
119                         usart->rts = 1;
120                 }
121 #endif
122                 c = u;
123         }
124         return c;
125 }
126
127 static char
128 ao_usart_getchar(struct ao_stm_usart *usart)
129 {
130         int c;
131         ao_arch_block_interrupts();
132         while ((c = _ao_usart_pollchar(usart)) == AO_READ_AGAIN)
133                 ao_sleep(&usart->rx_fifo);
134         ao_arch_release_interrupts();
135         return (char) c;
136 }
137
138 static inline uint8_t
139 _ao_usart_sleep_for(struct ao_stm_usart *usart, uint16_t timeout)
140 {
141         return ao_sleep_for(&usart->rx_fifo, timeout);
142 }
143
144 static void
145 ao_usart_putchar(struct ao_stm_usart *usart, char c)
146 {
147         ao_arch_block_interrupts();
148         while (ao_fifo_full(usart->tx_fifo))
149                 ao_sleep(&usart->tx_fifo);
150         ao_fifo_insert(usart->tx_fifo, c);
151         _ao_usart_tx_start(usart);
152         ao_arch_release_interrupts();
153 }
154
155 static void
156 ao_usart_drain(struct ao_stm_usart *usart)
157 {
158         ao_arch_block_interrupts();
159         while (!ao_fifo_empty(usart->tx_fifo) || usart->tx_running) {
160                 usart->draining = 1;
161                 ao_sleep(&usart->tx_fifo);
162         }
163         ao_arch_release_interrupts();
164 }
165
166 static const uint32_t ao_usart_speeds[] = {
167         [AO_SERIAL_SPEED_4800] = 4800,
168         [AO_SERIAL_SPEED_9600] = 9600,
169         [AO_SERIAL_SPEED_19200] = 19200,
170         [AO_SERIAL_SPEED_57600] = 57600,
171         [AO_SERIAL_SPEED_115200] = 115200,
172 };
173
174 static void
175 ao_usart_set_speed(struct ao_stm_usart *usart, uint8_t speed)
176 {
177         if (speed > AO_SERIAL_SPEED_115200)
178                 return;
179         usart->reg->brr = AO_PCLK / ao_usart_speeds[speed];
180 }
181
182 static void
183 ao_usart_init(struct ao_stm_usart *usart)
184 {
185         usart->reg->cr1 = ((0 << STM_USART_CR1_M1) |
186                            (0 << STM_USART_CR1_EOBIE) |
187                            (0 << STM_USART_CR1_RTOIE) |
188                            (0 << STM_USART_CR1_DEAT) |
189                            (0 << STM_USART_CR1_DEDT) |
190                            (0 << STM_USART_CR1_OVER8) |
191                            (0 << STM_USART_CR1_CMIE) |
192                            (0 << STM_USART_CR1_MME) |
193                            (0 << STM_USART_CR1_M0) |
194                            (0 << STM_USART_CR1_WAKE) |
195                            (0 << STM_USART_CR1_PCE) |
196                            (0 << STM_USART_CR1_PS) |
197                            (0 << STM_USART_CR1_PEIE) |
198                            (0 << STM_USART_CR1_TXEIE) |
199                            (0 << STM_USART_CR1_TCIE) |
200                            (1 << STM_USART_CR1_RXNEIE) |
201                            (0 << STM_USART_CR1_IDLEIE) |
202                            (1 << STM_USART_CR1_TE) |
203                            (1 << STM_USART_CR1_RE) |
204                            (0 << STM_USART_CR1_UESM) |
205                            (0 << STM_USART_CR1_UE));
206
207         usart->reg->cr2 = ((0 << STM_USART_CR2_ADD) |
208                            (0 << STM_USART_CR2_RTOEN) |
209                            (0 << STM_USART_CR2_ABRMOD) |
210                            (0 << STM_USART_CR2_ABREN) |
211                            (0 << STM_USART_CR2_MSBFIRST) |
212                            (0 << STM_USART_CR2_DATAINV) |
213                            (0 << STM_USART_CR2_TXINV) |
214                            (0 << STM_USART_CR2_RXINV) |
215                            (0 << STM_USART_CR2_SWAP) |
216                            (0 << STM_USART_CR2_LINEN) |
217                            (0 << STM_USART_CR2_STOP) |
218                            (0 << STM_USART_CR2_CLKEN) |
219                            (0 << STM_USART_CR2_CPOL) |
220                            (0 << STM_USART_CR2_CHPA) |
221                            (0 << STM_USART_CR2_LBCL) |
222                            (0 << STM_USART_CR2_LBDIE) |
223                            (0 << STM_USART_CR2_LBDL) |
224                            (0 << STM_USART_CR2_ADDM7));
225
226         usart->reg->cr3 = ((0 << STM_USART_CR3_WUFIE) |
227                            (0 << STM_USART_CR3_WUS) |
228                            (0 << STM_USART_CR3_SCARCNT) |
229                            (0 << STM_USART_CR3_DEP) |
230                            (0 << STM_USART_CR3_DEM) |
231                            (0 << STM_USART_CR3_DDRE) |
232                            (0 << STM_USART_CR3_OVRDIS) |
233                            (0 << STM_USART_CR3_ONEBIT) |
234                            (0 << STM_USART_CR3_CTIIE) |
235                            (0 << STM_USART_CR3_CTSE) |
236                            (0 << STM_USART_CR3_RTSE) |
237                            (0 << STM_USART_CR3_DMAT) |
238                            (0 << STM_USART_CR3_DMAR) |
239                            (0 << STM_USART_CR3_SCEN) |
240                            (0 << STM_USART_CR3_NACK) |
241                            (0 << STM_USART_CR3_HDSEL) |
242                            (0 << STM_USART_CR3_IRLP) |
243                            (0 << STM_USART_CR3_IREN) |
244                            (0 << STM_USART_CR3_EIE));
245
246
247         /* Pick a 9600 baud rate */
248         ao_usart_set_speed(usart, AO_SERIAL_SPEED_9600);
249
250         /* Enable the usart */
251         usart->reg->cr1 |= (1 << STM_USART_CR1_UE);
252
253 }
254
255 #if HAS_SERIAL_HW_FLOW
256 static void
257 ao_usart_set_flow(struct ao_stm_usart *usart)
258 {
259         usart->reg->cr3 |= ((1 << STM_USART_CR3_CTSE) |
260                             (1 << STM_USART_CR3_RTSE));
261 }
262 #endif
263
264 #if HAS_SERIAL_1
265
266 struct ao_stm_usart ao_stm_usart1;
267
268 void stm_usart1_isr(void) { ao_usart_isr(&ao_stm_usart1, USE_SERIAL_1_STDIN); }
269
270 char
271 ao_serial1_getchar(void)
272 {
273         return ao_usart_getchar(&ao_stm_usart1);
274 }
275
276 void
277 ao_serial1_putchar(char c)
278 {
279         ao_usart_putchar(&ao_stm_usart1, c);
280 }
281
282 int
283 _ao_serial1_pollchar(void)
284 {
285         return _ao_usart_pollchar(&ao_stm_usart1);
286 }
287
288 uint8_t
289 _ao_serial1_sleep_for(uint16_t timeout)
290 {
291         return _ao_usart_sleep_for(&ao_stm_usart1, timeout);
292 }
293
294 void
295 ao_serial1_drain(void)
296 {
297         ao_usart_drain(&ao_stm_usart1);
298 }
299
300 void
301 ao_serial1_set_speed(uint8_t speed)
302 {
303         ao_usart_drain(&ao_stm_usart1);
304         ao_usart_set_speed(&ao_stm_usart1, speed);
305 }
306 #endif  /* HAS_SERIAL_1 */
307
308 #if HAS_SERIAL_2
309
310 struct ao_stm_usart ao_stm_usart2;
311
312 void stm_usart2_isr(void) { ao_usart_isr(&ao_stm_usart2, USE_SERIAL_2_STDIN); }
313
314 char
315 ao_serial2_getchar(void)
316 {
317         return ao_usart_getchar(&ao_stm_usart2);
318 }
319
320 void
321 ao_serial2_putchar(char c)
322 {
323         ao_usart_putchar(&ao_stm_usart2, c);
324 }
325
326 int
327 _ao_serial2_pollchar(void)
328 {
329         return _ao_usart_pollchar(&ao_stm_usart2);
330 }
331
332 uint8_t
333 _ao_serial2_sleep_for(uint16_t timeout)
334 {
335         return _ao_usart_sleep_for(&ao_stm_usart2, timeout);
336 }
337
338 void
339 ao_serial2_drain(void)
340 {
341         ao_usart_drain(&ao_stm_usart2);
342 }
343
344 void
345 ao_serial2_set_speed(uint8_t speed)
346 {
347         ao_usart_drain(&ao_stm_usart2);
348         ao_usart_set_speed(&ao_stm_usart2, speed);
349 }
350
351 #if HAS_SERIAL_SW_FLOW
352 void
353 ao_serial2_cts(void)
354 {
355         _ao_usart_cts(&ao_stm_usart2);
356 }
357 #endif
358
359 #endif  /* HAS_SERIAL_2 */
360
361 #if HAS_SERIAL_SW_FLOW
362 static void
363 ao_serial_set_sw_rts_cts(struct ao_stm_usart *usart,
364                          void (*isr)(void),
365                          struct stm_gpio *port_rts,
366                          int pin_rts,
367                          struct stm_gpio *port_cts,
368                          int pin_cts)
369 {
370         /* Pull RTS low to note that there's space in the FIFO
371          */
372         ao_enable_output(port_rts, pin_rts, foo, 0);
373         usart->gpio_rts = port_rts;
374         usart->pin_rts = pin_rts;
375         usart->rts = 1;
376
377         ao_exti_setup(port_cts, pin_cts, AO_EXTI_MODE_FALLING|AO_EXTI_PRIORITY_MED, isr);
378         usart->gpio_cts = port_cts;
379         usart->pin_cts = pin_cts;
380 }
381 #endif
382
383 void
384 ao_serial_init(void)
385 {
386 #if HAS_SERIAL_1
387         /*
388          *      TX      RX
389          *      PA9     PA10
390          *      PB6     PB7
391          */
392
393 #if SERIAL_1_PA9_PA10
394         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPAEN);
395
396         stm_afr_set(&stm_gpioa, 9, STM_AFR_AF1);
397         stm_afr_set(&stm_gpioa, 10, STM_AFR_AF1);
398 #else
399 #if SERIAL_1_PB6_PB7
400         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPBEN);
401
402         stm_afr_set(&stm_gpiob, 6, STM_AFR_AF0);
403         stm_afr_set(&stm_gpiob, 7, STM_AFR_AF0);
404 #else
405 #error "No SERIAL_1 port configuration specified"
406 #endif
407 #endif
408         /* Enable USART */
409         stm_rcc.apb2enr |= (1 << STM_RCC_APB2ENR_USART1EN);
410
411         ao_stm_usart1.reg = &stm_usart1;
412         ao_usart_init(&ao_stm_usart1);
413
414         stm_nvic_set_enable(STM_ISR_USART1_POS);
415         stm_nvic_set_priority(STM_ISR_USART1_POS, 4);
416 #if USE_SERIAL_1_STDIN && !DELAY_SERIAL_1_STDIN
417         ao_add_stdio(_ao_serial1_pollchar,
418                      ao_serial1_putchar,
419                      NULL);
420 #endif
421 #endif
422
423 #if HAS_SERIAL_2
424         /*
425          *      TX      RX
426          *      PA2     PA3
427          *      PA14    PA15
428          */
429
430 # if SERIAL_2_PA2_PA3
431         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPAEN);
432
433         stm_afr_set(&stm_gpioa, 2, STM_AFR_AF1);
434         stm_afr_set(&stm_gpioa, 3, STM_AFR_AF1);
435 #  if USE_SERIAL_2_FLOW
436 #   if USE_SERIAL_2_SW_FLOW
437         ao_serial_set_sw_rts_cts(&ao_stm_usart2,
438                                  ao_serial2_cts,
439                                  SERIAL_2_PORT_RTS,
440                                  SERIAL_2_PIN_RTS,
441                                  SERIAL_2_PORT_CTS,
442                                  SERIAL_2_PIN_CTS);
443 #   else
444         stm_afr_set(&stm_gpioa, 0, STM_AFR_AF1);
445         stm_afr_set(&stm_gpioa, 1, STM_AFR_AF1);
446 #   endif
447 #  endif
448 # else
449 #  if SERIAL_2_PA14_PA15
450         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPAEN);
451
452         stm_afr_set(&stm_gpioa, 14, STM_AFR_AF1);
453         stm_afr_set(&stm_gpioa, 15, STM_AFR_AF1);
454 #   if USE_SERIAL_2_FLOW
455 #    error "Don't know how to set flowcontrol for serial 2 on PA14"
456 #   endif
457 #  else
458 #   if SERIAL_2_PA2_PA15
459         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPAEN);
460
461         stm_afr_set(&stm_gpioa, 2, STM_AFR_AF1);
462         stm_afr_set(&stm_gpioa, 15, STM_AFR_AF1);
463 #    if USE_SERIAL_2_FLOW
464 #     error "Don't know how to set flowcontrol for serial 2 on PA2_PA15"
465 #    endif
466 #   else
467 #    error "No SERIAL_2 port configuration specified"
468 #   endif
469 #  endif
470 # endif
471         /* Enable USART */
472         stm_rcc.apb1enr |= (1 << STM_RCC_APB1ENR_USART2EN);
473
474         ao_stm_usart2.reg = &stm_usart2;
475         ao_usart_init(&ao_stm_usart2);
476 # if USE_SERIAL_2_FLOW && !USE_SERIAL_2_SW_FLOW
477         ao_usart_set_flow(&ao_stm_usart2);
478 # endif
479
480         stm_nvic_set_enable(STM_ISR_USART2_POS);
481         stm_nvic_set_priority(STM_ISR_USART2_POS, 4);
482 # if USE_SERIAL_2_STDIN && !DELAY_SERIAL_2_STDIN
483         ao_add_stdio(_ao_serial2_pollchar,
484                      ao_serial2_putchar,
485                      NULL);
486 # endif
487 #endif
488 }