522059bc3d2193510e54d431d0bd9fd6e9bd45d5
[fw/altos] / src / stm / ao_arch_funcs.h
1 /*
2  * Copyright © 2012 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  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  */
18
19 #ifndef _AO_ARCH_FUNCS_H_
20 #define _AO_ARCH_FUNCS_H_
21
22 /* ao_spi_stm.c
23  */
24
25 /* PCLK is set to 16MHz (HCLK 32MHz, APB prescaler 2) */
26
27 #define AO_SPI_SPEED_8MHz       STM_SPI_CR1_BR_PCLK_2
28 #define AO_SPI_SPEED_4MHz       STM_SPI_CR1_BR_PCLK_4
29 #define AO_SPI_SPEED_2MHz       STM_SPI_CR1_BR_PCLK_8
30 #define AO_SPI_SPEED_1MHz       STM_SPI_CR1_BR_PCLK_16
31 #define AO_SPI_SPEED_500kHz     STM_SPI_CR1_BR_PCLK_32
32 #define AO_SPI_SPEED_250kHz     STM_SPI_CR1_BR_PCLK_64
33 #define AO_SPI_SPEED_125kHz     STM_SPI_CR1_BR_PCLK_128
34 #define AO_SPI_SPEED_62500Hz    STM_SPI_CR1_BR_PCLK_256
35
36 #define AO_SPI_SPEED_FAST       AO_SPI_SPEED_8MHz
37
38 /* Companion bus wants something no faster than 200kHz */
39
40 #define AO_SPI_SPEED_200kHz     AO_SPI_SPEED_125kHz
41
42 #define AO_SPI_CONFIG_1         0x00
43 #define AO_SPI_1_CONFIG_PA5_PA6_PA7     AO_SPI_CONFIG_1
44 #define AO_SPI_2_CONFIG_PB13_PB14_PB15  AO_SPI_CONFIG_1
45
46 #define AO_SPI_CONFIG_2         0x04
47 #define AO_SPI_1_CONFIG_PB3_PB4_PB5     AO_SPI_CONFIG_2
48 #define AO_SPI_2_CONFIG_PD1_PD3_PD4     AO_SPI_CONFIG_2
49
50 #define AO_SPI_CONFIG_3         0x08
51 #define AO_SPI_1_CONFIG_PE13_PE14_PE15  AO_SPI_CONFIG_3
52
53 #define AO_SPI_CONFIG_NONE      0x0c
54
55 #define AO_SPI_INDEX_MASK       0x01
56 #define AO_SPI_CONFIG_MASK      0x0c
57
58 #define AO_SPI_1_PA5_PA6_PA7    (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PA5_PA6_PA7)
59 #define AO_SPI_1_PB3_PB4_PB5    (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PB3_PB4_PB5)
60 #define AO_SPI_1_PE13_PE14_PE15 (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PE13_PE14_PE15)
61
62 #define AO_SPI_2_PB13_PB14_PB15 (STM_SPI_INDEX(2) | AO_SPI_2_CONFIG_PB13_PB14_PB15)
63 #define AO_SPI_2_PD1_PD3_PD4    (STM_SPI_INDEX(2) | AO_SPI_2_CONFIG_PD1_PD3_PD4)
64
65 #define AO_SPI_INDEX(id)        ((id) & AO_SPI_INDEX_MASK)
66 #define AO_SPI_CONFIG(id)       ((id) & AO_SPI_CONFIG_MASK)
67
68 uint8_t
69 ao_spi_try_get(uint8_t spi_index, uint32_t speed, uint8_t task_id);
70
71 void
72 ao_spi_get(uint8_t spi_index, uint32_t speed);
73
74 void
75 ao_spi_put(uint8_t spi_index);
76
77 void
78 ao_spi_send(const void *block, uint16_t len, uint8_t spi_index);
79
80 void
81 ao_spi_send_fixed(uint8_t value, uint16_t len, uint8_t spi_index);
82
83 void
84 ao_spi_send_sync(const void *block, uint16_t len, uint8_t spi_index);
85
86 void
87 ao_spi_start_bytes(uint8_t spi_index);
88
89 void
90 ao_spi_stop_bytes(uint8_t spi_index);
91
92 static inline void
93 ao_spi_send_byte(uint8_t byte, uint8_t spi_index)
94 {
95         struct stm_spi  *stm_spi;
96
97         switch (AO_SPI_INDEX(spi_index)) {
98         case 0:
99                 stm_spi = &stm_spi1;
100                 break;
101         case 1:
102                 stm_spi = &stm_spi2;
103                 break;
104         }
105
106         while (!(stm_spi->sr & (1 << STM_SPI_SR_TXE)))
107                 ;
108         stm_spi->dr = byte;
109         while (!(stm_spi->sr & (1 << STM_SPI_SR_RXNE)))
110                 ;
111         (void) stm_spi->dr;
112 }
113
114 static inline uint8_t
115 ao_spi_recv_byte(uint8_t spi_index)
116 {
117         struct stm_spi  *stm_spi;
118
119         switch (AO_SPI_INDEX(spi_index)) {
120         case 0:
121                 stm_spi = &stm_spi1;
122                 break;
123         case 1:
124                 stm_spi = &stm_spi2;
125                 break;
126         }
127
128         while (!(stm_spi->sr & (1 << STM_SPI_SR_TXE)))
129                 ;
130         stm_spi->dr = 0xff;
131         while (!(stm_spi->sr & (1 << STM_SPI_SR_RXNE)))
132                 ;
133         return stm_spi->dr;
134 }
135
136 void
137 ao_spi_recv(void *block, uint16_t len, uint8_t spi_index);
138
139 void
140 ao_spi_duplex(const void *out, void *in, uint16_t len, uint8_t spi_index);
141
142 extern uint16_t ao_spi_speed[STM_NUM_SPI];
143
144 void
145 ao_spi_init(void);
146
147 #define ao_spi_set_cs(reg,mask) ((reg)->bsrr = ((uint32_t) (mask)) << 16)
148 #define ao_spi_clr_cs(reg,mask) ((reg)->bsrr = (mask))
149
150 #define ao_spi_get_mask(reg,mask,bus, speed) do {               \
151                 ao_spi_get(bus, speed);                         \
152                 ao_spi_set_cs(reg,mask);                        \
153         } while (0)
154
155 static inline uint8_t
156 ao_spi_try_get_mask(struct stm_gpio *reg, uint16_t mask, uint8_t bus, uint32_t speed, uint8_t task_id)
157 {
158         if (!ao_spi_try_get(bus, speed, task_id))
159                 return 0;
160         ao_spi_set_cs(reg, mask);
161         return 1;
162 }
163
164 #define ao_spi_put_mask(reg,mask,bus) do {      \
165                 ao_spi_clr_cs(reg,mask);        \
166                 ao_spi_put(bus);                \
167         } while (0)
168
169 #define ao_spi_get_bit(reg,bit,pin,bus,speed) ao_spi_get_mask(reg,(1<<bit),bus,speed)
170 #define ao_spi_put_bit(reg,bit,pin,bus) ao_spi_put_mask(reg,(1<<bit),bus)
171
172 #define ao_enable_port(port) do {                                       \
173                 if ((port) == &stm_gpioa)                               \
174                         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_GPIOAEN); \
175                 else if ((port) == &stm_gpiob)                          \
176                         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_GPIOBEN); \
177                 else if ((port) == &stm_gpioc)                          \
178                         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_GPIOCEN); \
179                 else if ((port) == &stm_gpiod)                          \
180                         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_GPIODEN); \
181                 else if ((port) == &stm_gpioe)                          \
182                         stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_GPIOEEN); \
183         } while (0)
184
185 #define ao_disable_port(port) do {                                      \
186                 if ((port) == &stm_gpioa)                               \
187                         stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_GPIOAEN); \
188                 else if ((port) == &stm_gpiob)                          \
189                         stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_GPIOBEN); \
190                 else if ((port) == &stm_gpioc)                          \
191                         stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_GPIOCEN); \
192                 else if ((port) == &stm_gpiod)                          \
193                         stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_GPIODEN); \
194                 else if ((port) == &stm_gpioe)                          \
195                         stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_GPIOEEN); \
196         } while (0)
197
198
199 #define ao_gpio_set(port, bit, pin, v) stm_gpio_set(port, bit, v)
200
201 #define ao_gpio_get(port, bit, pin) stm_gpio_get(port, bit)
202
203 #define ao_gpio_set_bits(port, bits) stm_gpio_set_bits(port, bits)
204
205 #define ao_gpio_set_mask(port, bits, mask) stm_gpio_set_mask(port, bits, mask)
206
207 #define ao_gpio_clr_bits(port, bits) stm_gpio_clr_bits(port, bits);
208
209 #define ao_gpio_get_all(port) stm_gpio_get_all(port)
210
211 #define ao_enable_output(port,bit,pin,v) do {                   \
212                 ao_enable_port(port);                           \
213                 ao_gpio_set(port, bit, pin, v);                 \
214                 stm_moder_set(port, bit, STM_MODER_OUTPUT);\
215         } while (0)
216
217 #define ao_enable_output_mask(port,bits,mask) do {              \
218                 ao_enable_port(port);                           \
219                 ao_gpio_set_mask(port, bits, mask);             \
220                 ao_set_output_mask(port, mask);                 \
221         } while (0)
222
223 #define AO_OUTPUT_PUSH_PULL     STM_OTYPER_PUSH_PULL
224 #define AO_OUTPUT_OPEN_DRAIN    STM_OTYPER_OPEN_DRAIN
225
226 #define ao_gpio_set_output_mode(port,bit,pin,mode) \
227         stm_otyper_set(port, pin, mode)
228
229 #define ao_gpio_set_mode(port,bit,mode) do {                            \
230                 if (mode == AO_EXTI_MODE_PULL_UP)                       \
231                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_UP);    \
232                 else if (mode == AO_EXTI_MODE_PULL_DOWN)                \
233                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_DOWN);  \
234                 else                                                    \
235                         stm_pupdr_set(port, bit, STM_PUPDR_NONE);       \
236         } while (0)
237
238 #define ao_gpio_set_mode_mask(port,mask,mode) do {                      \
239                 if (mode == AO_EXTI_MODE_PULL_UP)                       \
240                         stm_pupdr_set_mask(port, mask, STM_PUPDR_PULL_UP); \
241                 else if (mode == AO_EXTI_MODE_PULL_DOWN)                \
242                         stm_pupdr_set_mask(port, mask, STM_PUPDR_PULL_DOWN); \
243                 else                                                    \
244                         stm_pupdr_set_mask(port, mask, STM_PUPDR_NONE); \
245         } while (0)
246
247 #define ao_set_input(port, bit) do {                            \
248                 stm_moder_set(port, bit, STM_MODER_INPUT);      \
249         } while (0)
250
251 #define ao_set_output(port, bit, pin, v) do {                   \
252                 ao_gpio_set(port, bit, pin, v);                 \
253                 stm_moder_set(port, bit, STM_MODER_OUTPUT);     \
254         } while (0)
255
256 #define ao_set_output_mask(port, mask) do {                     \
257                 stm_moder_set_mask(port, mask, STM_MODER_OUTPUT);       \
258         } while (0)
259
260 #define ao_set_input_mask(port, mask) do {                              \
261                 stm_moder_set_mask(port, mask, STM_MODER_INPUT);        \
262         } while (0)
263
264 #define ao_enable_input(port,bit,mode) do {                             \
265                 ao_enable_port(port);                                   \
266                 ao_set_input(port, bit);                                \
267                 ao_gpio_set_mode(port, bit, mode);                      \
268         } while (0)
269
270 #define ao_enable_input_mask(port,mask,mode) do {       \
271                 ao_enable_port(port);                   \
272                 ao_gpio_set_mode_mask(port, mask, mode);        \
273                 ao_set_input_mask(port, mask);          \
274         } while (0)
275
276 #define _ao_enable_cs(port, bit) do {                           \
277                 stm_gpio_set((port), bit, 1);                   \
278                 stm_moder_set((port), bit, STM_MODER_OUTPUT);   \
279         } while (0)
280
281 #define ao_enable_cs(port,bit) do {                             \
282                 ao_enable_port(port);                           \
283                 _ao_enable_cs(port, bit);                       \
284         } while (0)
285
286 #define ao_spi_init_cs(port, mask) do {                         \
287                 ao_enable_port(port);                           \
288                 if ((mask) & 0x0001) _ao_enable_cs(port, 0);    \
289                 if ((mask) & 0x0002) _ao_enable_cs(port, 1);    \
290                 if ((mask) & 0x0004) _ao_enable_cs(port, 2);    \
291                 if ((mask) & 0x0008) _ao_enable_cs(port, 3);    \
292                 if ((mask) & 0x0010) _ao_enable_cs(port, 4);    \
293                 if ((mask) & 0x0020) _ao_enable_cs(port, 5);    \
294                 if ((mask) & 0x0040) _ao_enable_cs(port, 6);    \
295                 if ((mask) & 0x0080) _ao_enable_cs(port, 7);    \
296                 if ((mask) & 0x0100) _ao_enable_cs(port, 8);    \
297                 if ((mask) & 0x0200) _ao_enable_cs(port, 9);    \
298                 if ((mask) & 0x0400) _ao_enable_cs(port, 10);\
299                 if ((mask) & 0x0800) _ao_enable_cs(port, 11);\
300                 if ((mask) & 0x1000) _ao_enable_cs(port, 12);\
301                 if ((mask) & 0x2000) _ao_enable_cs(port, 13);\
302                 if ((mask) & 0x4000) _ao_enable_cs(port, 14);\
303                 if ((mask) & 0x8000) _ao_enable_cs(port, 15);\
304         } while (0)
305
306 /* ao_dma_stm.c
307  */
308
309 extern uint8_t ao_dma_done[STM_NUM_DMA];
310
311 void
312 ao_dma_set_transfer(uint8_t             index,
313                     volatile void       *peripheral,
314                     void                *memory,
315                     uint16_t            count,
316                     uint32_t            ccr);
317
318 void
319 ao_dma_set_isr(uint8_t index, void (*isr)(int index));
320
321 void
322 ao_dma_start(uint8_t index);
323
324 void
325 ao_dma_done_transfer(uint8_t index);
326
327 void
328 ao_dma_alloc(uint8_t index);
329
330 void
331 ao_dma_init(void);
332
333 /* ao_i2c_stm.c */
334
335 void
336 ao_i2c_get(uint8_t i2c_index);
337
338 uint8_t
339 ao_i2c_start(uint8_t i2c_index, uint16_t address);
340
341 void
342 ao_i2c_put(uint8_t i2c_index);
343
344 uint8_t
345 ao_i2c_send(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
346
347 uint8_t
348 ao_i2c_recv(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
349
350 void
351 ao_i2c_init(void);
352
353 #if USE_SERIAL_1_SW_FLOW || USE_SERIAL_2_SW_FLOW || USE_SERIAL_3_SW_FLOW
354 #define HAS_SERIAL_SW_FLOW 1
355 #else
356 #define HAS_SERIAL_SW_FLOW 0
357 #endif
358
359 #if USE_SERIAL_1_FLOW && !USE_SERIAL_1_SW_FLOW || USE_SERIAL_2_FLOW && !USE_SERIAL_2_SW_FLOW || USE_SERIAL_3_FLOW && !USE_SERIAL_3_SW_FLOW
360 #define HAS_SERIAL_HW_FLOW 1
361 #else
362 #define HAS_SERIAL_HW_FLOW 0
363 #endif
364
365 /* ao_serial_stm.c */
366 struct ao_stm_usart {
367         struct ao_fifo          rx_fifo;
368         struct ao_fifo          tx_fifo;
369         struct stm_usart        *reg;
370         uint8_t                 tx_running;
371         uint8_t                 draining;
372 #if HAS_SERIAL_SW_FLOW
373         /* RTS - 0 if we have FIFO space, 1 if not
374          * CTS - 0 if we can send, 0 if not
375          */
376         struct stm_gpio         *gpio_rts;
377         struct stm_gpio         *gpio_cts;
378         uint8_t                 pin_rts;
379         uint8_t                 pin_cts;
380         uint8_t                 rts;
381 #endif
382 };
383
384 #if HAS_SERIAL_1
385 extern struct ao_stm_usart      ao_stm_usart1;
386 #endif
387
388 #if HAS_SERIAL_2
389 extern struct ao_stm_usart      ao_stm_usart2;
390 #endif
391
392 #if HAS_SERIAL_3
393 extern struct ao_stm_usart      ao_stm_usart3;
394 #endif
395
396 #define ARM_PUSH32(stack, val)  (*(--(stack)) = (val))
397
398 typedef uint32_t        ao_arch_irq_t;
399
400 static inline void
401 ao_arch_block_interrupts(void) {
402 #ifdef AO_NONMASK_INTERRUPTS
403         asm("msr basepri,%0" : : "r" (AO_STM_NVIC_BASEPRI_MASK));
404 #else
405         asm("cpsid i");
406 #endif
407 }
408
409 static inline void
410 ao_arch_release_interrupts(void) {
411 #ifdef AO_NONMASK_INTERRUPTS
412         asm("msr basepri,%0" : : "r" (0x0));
413 #else
414         asm("cpsie i");
415 #endif
416 }
417
418 static inline uint32_t
419 ao_arch_irqsave(void) {
420         uint32_t        val;
421 #ifdef AO_NONMASK_INTERRUPTS
422         asm("mrs %0,basepri" : "=r" (val));
423 #else
424         asm("mrs %0,primask" : "=r" (val));
425 #endif
426         ao_arch_block_interrupts();
427         return val;
428 }
429
430 static inline void
431 ao_arch_irqrestore(uint32_t basepri) {
432 #ifdef AO_NONMASK_INTERRUPTS
433         asm("msr basepri,%0" : : "r" (basepri));
434 #else
435         asm("msr primask,%0" : : "r" (basepri));
436 #endif
437 }
438
439 static inline void
440 ao_arch_memory_barrier() {
441         asm volatile("" ::: "memory");
442 }
443
444 static inline void
445 ao_arch_irq_check(void) {
446 #ifdef AO_NONMASK_INTERRUPTS
447         uint32_t        basepri;
448         asm("mrs %0,basepri" : "=r" (basepri));
449         if (basepri == 0)
450                 ao_panic(AO_PANIC_IRQ);
451 #else
452         uint32_t        primask;
453         asm("mrs %0,primask" : "=r" (primask));
454         if ((primask & 1) == 0)
455                 ao_panic(AO_PANIC_IRQ);
456 #endif
457 }
458
459 #if HAS_TASK
460 static inline void
461 ao_arch_init_stack(struct ao_task *task, void *start)
462 {
463         uint32_t        *sp = (uint32_t *) ((void*) task->stack + AO_STACK_SIZE);
464         uint32_t        a = (uint32_t) start;
465         int             i;
466
467         /* Return address (goes into LR) */
468         ARM_PUSH32(sp, a);
469
470         /* Clear register values r0-r12 */
471         i = 13;
472         while (i--)
473                 ARM_PUSH32(sp, 0);
474
475         /* APSR */
476         ARM_PUSH32(sp, 0);
477
478         /* BASEPRI with interrupts enabled */
479         ARM_PUSH32(sp, 0);
480
481         task->sp = sp;
482 }
483
484 static inline void ao_arch_save_regs(void) {
485         /* Save general registers */
486         asm("push {r0-r12,lr}\n");
487
488         /* Save APSR */
489         asm("mrs r0,apsr");
490         asm("push {r0}");
491
492 #ifdef AO_NONMASK_INTERRUPTS
493         /* Save BASEPRI */
494         asm("mrs r0,basepri");
495 #else
496         /* Save PRIMASK */
497         asm("mrs r0,primask");
498 #endif
499         asm("push {r0}");
500 }
501
502 static inline void ao_arch_save_stack(void) {
503         uint32_t        *sp;
504         asm("mov %0,sp" : "=&r" (sp) );
505         ao_cur_task->sp = (sp);
506 }
507
508 static inline void ao_arch_restore_stack(void) {
509         /* Switch stacks */
510         asm("mov sp, %0" : : "r" (ao_cur_task->sp) );
511
512 #ifdef AO_NONMASK_INTERRUPTS
513         /* Restore BASEPRI */
514         asm("pop {r0}");
515         asm("msr basepri,r0");
516 #else
517         /* Restore PRIMASK */
518         asm("pop {r0}");
519         asm("msr primask,r0");
520 #endif
521
522         /* Restore APSR */
523         asm("pop {r0}");
524         asm("msr apsr_nczvq,r0");
525
526         /* Restore general registers */
527         asm("pop {r0-r12,lr}\n");
528
529         /* Return to calling function */
530         asm("bx lr");
531 }
532
533 #ifndef HAS_SAMPLE_PROFILE
534 #define HAS_SAMPLE_PROFILE 0
535 #endif
536
537 #if DEBUG
538 #define HAS_ARCH_VALIDATE_CUR_STACK     1
539
540 static inline void
541 ao_validate_cur_stack(void)
542 {
543         uint8_t         *psp;
544
545         asm("mrs %0,psp" : "=&r" (psp));
546         if (ao_cur_task &&
547             psp <= ao_cur_task->stack &&
548             psp >= ao_cur_task->stack - 256)
549                 ao_panic(AO_PANIC_STACK);
550 }
551 #endif
552
553 #if !HAS_SAMPLE_PROFILE
554 #define HAS_ARCH_START_SCHEDULER        1
555
556 static inline void ao_arch_start_scheduler(void) {
557         uint32_t        sp;
558         uint32_t        control;
559
560         asm("mrs %0,msp" : "=&r" (sp));
561         asm("msr psp,%0" : : "r" (sp));
562         asm("mrs %0,control" : "=r" (control));
563         control |= (1 << 1);
564         asm("msr control,%0" : : "r" (control));
565         asm("isb");
566 }
567 #endif
568
569 #define ao_arch_isr_stack()
570
571 #endif
572
573 static inline void
574 ao_arch_wait_interrupt(void) {
575 #ifdef AO_NONMASK_INTERRUPTS
576         asm(
577             "dsb\n"                     /* Serialize data */
578             "isb\n"                     /* Serialize instructions */
579             "cpsid i\n"                 /* Block all interrupts */
580             "msr basepri,%0\n"          /* Allow all interrupts through basepri */
581             "wfi\n"                     /* Wait for an interrupt */
582             "cpsie i\n"                 /* Allow all interrupts */
583             "msr basepri,%1\n"          /* Block interrupts through basepri */
584             : : "r" (0), "r" (AO_STM_NVIC_BASEPRI_MASK));
585 #else
586         asm("\twfi\n");
587         ao_arch_release_interrupts();
588         ao_arch_block_interrupts();
589 #endif
590 }
591
592 #define ao_arch_critical(b) do {                        \
593                 uint32_t __mask = ao_arch_irqsave();    \
594                 do { b } while (0);                     \
595                 ao_arch_irqrestore(__mask);             \
596         } while (0)
597
598 #endif /* _AO_ARCH_FUNCS_H_ */