d46899d575c409f149fd7e50767debb0422f24d1
[fw/altos] / src / stmf0 / 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 #include <ao_power.h>
23
24 /* ao_spi_stm.c
25  */
26
27 /* PCLK is set to 48MHz (HCLK 48MHz, HPRE 1, PPRE 1) */
28
29 #define _AO_SPI_SPEED_24MHz     STM_SPI_CR1_BR_PCLK_2
30 #define _AO_SPI_SPEED_12MHz     STM_SPI_CR1_BR_PCLK_4
31 #define _AO_SPI_SPEED_6MHz      STM_SPI_CR1_BR_PCLK_8
32 #define _AO_SPI_SPEED_3MHz      STM_SPI_CR1_BR_PCLK_16
33 #define _AO_SPI_SPEED_1500kHz   STM_SPI_CR1_BR_PCLK_32
34 #define _AO_SPI_SPEED_750kHz    STM_SPI_CR1_BR_PCLK_64
35 #define _AO_SPI_SPEED_375kHz    STM_SPI_CR1_BR_PCLK_128
36 #define _AO_SPI_SPEED_187500Hz  STM_SPI_CR1_BR_PCLK_256
37
38 static inline uint32_t
39 ao_spi_speed(uint32_t hz)
40 {
41         if (hz >=24000000) return _AO_SPI_SPEED_24MHz;
42         if (hz >=12000000) return _AO_SPI_SPEED_12MHz;
43         if (hz >= 6000000) return _AO_SPI_SPEED_6MHz;
44         if (hz >= 3000000) return _AO_SPI_SPEED_3MHz;
45         if (hz >= 1500000) return _AO_SPI_SPEED_1500kHz;
46         if (hz >=  750000) return _AO_SPI_SPEED_750kHz;
47         if (hz >=  375000) return _AO_SPI_SPEED_375kHz;
48         return _AO_SPI_SPEED_187500Hz;
49 }
50
51 #define AO_SPI_CONFIG_1         0x00
52 #define AO_SPI_1_CONFIG_PA5_PA6_PA7     AO_SPI_CONFIG_1
53 #define AO_SPI_2_CONFIG_PB13_PB14_PB15  AO_SPI_CONFIG_1
54
55 #define AO_SPI_CONFIG_2         0x04
56 #define AO_SPI_1_CONFIG_PB3_PB4_PB5     AO_SPI_CONFIG_2
57 #define AO_SPI_2_CONFIG_PD1_PD3_PD4     AO_SPI_CONFIG_2
58
59 #define AO_SPI_CONFIG_3         0x08
60 #define AO_SPI_1_CONFIG_PE13_PE14_PE15  AO_SPI_CONFIG_3
61
62 #define AO_SPI_CONFIG_NONE      0x0c
63
64 #define AO_SPI_INDEX_MASK       0x01
65 #define AO_SPI_CONFIG_MASK      0x0c
66
67 #define AO_SPI_1_PA5_PA6_PA7    (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PA5_PA6_PA7)
68 #define AO_SPI_1_PB3_PB4_PB5    (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PB3_PB4_PB5)
69 #define AO_SPI_1_PE13_PE14_PE15 (STM_SPI_INDEX(1) | AO_SPI_1_CONFIG_PE13_PE14_PE15)
70
71 #define AO_SPI_2_PB13_PB14_PB15 (STM_SPI_INDEX(2) | AO_SPI_2_CONFIG_PB13_PB14_PB15)
72 #define AO_SPI_2_PD1_PD3_PD4    (STM_SPI_INDEX(2) | AO_SPI_2_CONFIG_PD1_PD3_PD4)
73
74 #define AO_SPI_INDEX(id)        ((id) & AO_SPI_INDEX_MASK)
75 #define AO_SPI_CONFIG(id)       ((id) & AO_SPI_CONFIG_MASK)
76 #define AO_SPI_PIN_CONFIG(id)   ((id) & (AO_SPI_INDEX_MASK | AO_SPI_CONFIG_MASK))
77
78 #define AO_SPI_CPOL_BIT         4
79 #define AO_SPI_CPHA_BIT         5
80 #define AO_SPI_CPOL(id)         ((uint32_t) (((id) >> AO_SPI_CPOL_BIT) & 1))
81 #define AO_SPI_CPHA(id)         ((uint32_t) (((id) >> AO_SPI_CPHA_BIT) & 1))
82
83 #define AO_SPI_MAKE_MODE(pol,pha)       (((pol) << AO_SPI_CPOL_BIT) | ((pha) << AO_SPI_CPHA_BIT))
84 #define AO_SPI_MODE_0           AO_SPI_MAKE_MODE(0,0)
85 #define AO_SPI_MODE_1           AO_SPI_MAKE_MODE(0,1)
86 #define AO_SPI_MODE_2           AO_SPI_MAKE_MODE(1,0)
87 #define AO_SPI_MODE_3           AO_SPI_MAKE_MODE(1,1)
88
89 uint8_t
90 ao_spi_try_get(uint8_t spi_index, uint32_t speed, uint8_t task_id);
91
92 void
93 ao_spi_get(uint8_t spi_index, uint32_t speed);
94
95 void
96 ao_spi_put(uint8_t spi_index);
97
98 void
99 ao_spi_send(const void *block, uint16_t len, uint8_t spi_index);
100
101 void
102 ao_spi_send_fixed(uint8_t value, uint16_t len, uint8_t spi_index);
103
104 void
105 ao_spi_send_sync(const void *block, uint16_t len, uint8_t spi_index);
106
107 void
108 ao_spi_start_bytes(uint8_t spi_index);
109
110 void
111 ao_spi_stop_bytes(uint8_t spi_index);
112
113 static inline void
114 ao_spi_send_byte(uint8_t byte, uint8_t spi_index)
115 {
116         struct stm_spi  *stm_spi;
117
118         switch (AO_SPI_INDEX(spi_index)) {
119         case 0:
120                 stm_spi = &stm_spi1;
121                 break;
122         case 1:
123                 stm_spi = &stm_spi2;
124                 break;
125         }
126
127         while (!(stm_spi->sr & (1 << STM_SPI_SR_TXE)))
128                 ;
129         stm_spi->dr = byte;
130         while (!(stm_spi->sr & (1 << STM_SPI_SR_RXNE)))
131                 ;
132         (void) stm_spi->dr;
133 }
134
135 static inline uint8_t
136 ao_spi_recv_byte(uint8_t spi_index)
137 {
138         struct stm_spi  *stm_spi;
139
140         switch (AO_SPI_INDEX(spi_index)) {
141         case 0:
142                 stm_spi = &stm_spi1;
143                 break;
144         case 1:
145                 stm_spi = &stm_spi2;
146                 break;
147         }
148
149         while (!(stm_spi->sr & (1 << STM_SPI_SR_TXE)))
150                 ;
151         stm_spi->dr = 0xff;
152         while (!(stm_spi->sr & (1 << STM_SPI_SR_RXNE)))
153                 ;
154         return stm_spi->dr;
155 }
156
157 void
158 ao_spi_recv(void *block, uint16_t len, uint8_t spi_index);
159
160 void
161 ao_spi_duplex(void *out, void *in, uint16_t len, uint8_t spi_index);
162
163 void
164 ao_spi_init(void);
165
166 #define ao_spi_set_cs(reg,mask) ((reg)->bsrr = ((uint32_t) (mask)) << 16)
167 #define ao_spi_clr_cs(reg,mask) ((reg)->bsrr = (mask))
168
169 #define ao_spi_get_mask(reg,mask,bus, speed) do {               \
170                 ao_spi_get(bus, speed);                         \
171                 ao_spi_set_cs(reg,mask);                        \
172         } while (0)
173
174 static inline uint8_t
175 ao_spi_try_get_mask(struct stm_gpio *reg, uint16_t mask, uint8_t bus, uint32_t speed, uint8_t task_id)
176 {
177         if (!ao_spi_try_get(bus, speed, task_id))
178                 return 0;
179         ao_spi_set_cs(reg, mask);
180         return 1;
181 }
182
183 #define ao_spi_put_mask(reg,mask,bus) do {      \
184                 ao_spi_clr_cs(reg,mask);        \
185                 ao_spi_put(bus);                \
186         } while (0)
187
188 #define ao_spi_get_bit(reg,bit,bus,speed) ao_spi_get_mask(reg,(1<<bit),bus,speed)
189 #define ao_spi_put_bit(reg,bit,bus) ao_spi_put_mask(reg,(1<<bit),bus)
190
191 #if AO_POWER_MANAGEMENT
192 extern struct ao_power  ao_power_gpioa;
193 extern struct ao_power  ao_power_gpiob;
194 extern struct ao_power  ao_power_gpioc;
195 extern struct ao_power  ao_power_gpiof;
196 #endif
197
198 static inline void ao_enable_port(struct stm_gpio *port)
199 {
200         if ((port) == &stm_gpioa) {
201                 stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPAEN);
202                 ao_power_register(&ao_power_gpioa);
203         } else if ((port) == &stm_gpiob) {
204                 stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPBEN);
205                 ao_power_register(&ao_power_gpiob);
206         } else if ((port) == &stm_gpioc) {
207                 stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPCEN);
208                 ao_power_register(&ao_power_gpioc);
209         } else if ((port) == &stm_gpiof) {
210                 stm_rcc.ahbenr |= (1 << STM_RCC_AHBENR_IOPFEN);
211                 ao_power_register(&ao_power_gpiof);
212         }
213 }
214
215 static inline void ao_disable_port(struct stm_gpio *port)
216 {
217         if ((port) == &stm_gpioa) {
218                 stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_IOPAEN);
219                 ao_power_unregister(&ao_power_gpioa);
220         } else if ((port) == &stm_gpiob) {
221                 stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_IOPBEN);
222                 ao_power_unregister(&ao_power_gpiob);
223         } else if ((port) == &stm_gpioc) {
224                 stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_IOPCEN);
225                 ao_power_unregister(&ao_power_gpioc);
226         } else if ((port) == &stm_gpiof) {
227                 stm_rcc.ahbenr &= ~(1 << STM_RCC_AHBENR_IOPFEN);
228                 ao_power_unregister(&ao_power_gpiof);
229         }
230 }
231
232 #define ao_gpio_set(port, bit, v) stm_gpio_set(port, bit, v)
233
234 #define ao_gpio_get(port, bit) stm_gpio_get(port, bit)
235
236 #define ao_enable_output(port,bit,v) do {                       \
237                 ao_enable_port(port);                           \
238                 ao_gpio_set(port, bit, v);                      \
239                 stm_moder_set(port, bit, STM_MODER_OUTPUT);\
240         } while (0)
241
242 #define ao_gpio_set_mode(port,bit,mode) do {                            \
243                 if (mode == AO_EXTI_MODE_PULL_UP)                       \
244                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_UP);    \
245                 else if (mode == AO_EXTI_MODE_PULL_DOWN)                \
246                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_DOWN);  \
247                 else                                                    \
248                         stm_pupdr_set(port, bit, STM_PUPDR_NONE);       \
249         } while (0)
250
251 #define ao_enable_input(port,bit,mode) do {                             \
252                 ao_enable_port(port);                                   \
253                 stm_moder_set(port, bit, STM_MODER_INPUT);              \
254                 ao_gpio_set_mode(port, bit, mode);                      \
255         } while (0)
256
257 #define ao_enable_cs(port,bit) do {                             \
258                 ao_enable_output(port, bit, 1);         \
259         } while (0)
260
261 #define ao_spi_init_cs(port, mask) do {                         \
262                 ao_enable_port(port);                           \
263                 if ((mask) & 0x0001) ao_enable_cs(port, 0);     \
264                 if ((mask) & 0x0002) ao_enable_cs(port, 1);     \
265                 if ((mask) & 0x0004) ao_enable_cs(port, 2);     \
266                 if ((mask) & 0x0008) ao_enable_cs(port, 3);     \
267                 if ((mask) & 0x0010) ao_enable_cs(port, 4);     \
268                 if ((mask) & 0x0020) ao_enable_cs(port, 5);     \
269                 if ((mask) & 0x0040) ao_enable_cs(port, 6);     \
270                 if ((mask) & 0x0080) ao_enable_cs(port, 7);     \
271                 if ((mask) & 0x0100) ao_enable_cs(port, 8);     \
272                 if ((mask) & 0x0200) ao_enable_cs(port, 9);     \
273                 if ((mask) & 0x0400) ao_enable_cs(port, 10);\
274                 if ((mask) & 0x0800) ao_enable_cs(port, 11);\
275                 if ((mask) & 0x1000) ao_enable_cs(port, 12);\
276                 if ((mask) & 0x2000) ao_enable_cs(port, 13);\
277                 if ((mask) & 0x4000) ao_enable_cs(port, 14);\
278                 if ((mask) & 0x8000) ao_enable_cs(port, 15);\
279         } while (0)
280
281 /* ao_dma_stm.c
282  */
283
284 extern uint8_t ao_dma_done[STM_NUM_DMA];
285
286 void
287 ao_dma_set_transfer(uint8_t             index,
288                     volatile void       *peripheral,
289                     void                *memory,
290                     uint16_t            count,
291                     uint32_t            ccr);
292
293 void
294 ao_dma_set_isr(uint8_t index, void (*isr)(int index));
295
296 void
297 ao_dma_start(uint8_t index);
298
299 void
300 ao_dma_done_transfer(uint8_t index);
301
302 void
303 ao_dma_abort(uint8_t index);
304
305 void
306 ao_dma_alloc(uint8_t index);
307
308 void
309 ao_dma_init(void);
310
311 /* ao_i2c_stm.c */
312
313 void
314 ao_i2c_get(uint8_t i2c_index);
315
316 uint8_t
317 ao_i2c_start(uint8_t i2c_index, uint16_t address);
318
319 void
320 ao_i2c_put(uint8_t i2c_index);
321
322 uint8_t
323 ao_i2c_send(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
324
325 uint8_t
326 ao_i2c_recv(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
327
328 void
329 ao_i2c_init(void);
330
331 /* ao_serial_stm.c */
332
333 #if USE_SERIAL_1_FLOW && USE_SERIAL_1_SW_FLOW || USE_SERIAL_2_FLOW && USE_SERIAL_2_SW_FLOW
334 #define HAS_SERIAL_SW_FLOW      1
335 #else
336 #define HAS_SERIAL_SW_FLOW      0
337 #endif
338
339 #if USE_SERIAL_2_FLOW && !USE_SERIAL_2_SW_FLOW
340 #define USE_SERIAL_2_HW_FLOW    1
341 #endif
342
343 #if USE_SERIAL_1_FLOW && !USE_SERIAL_1_SW_FLOW
344 #define USE_SERIAL_1_HW_FLOW    1
345 #endif
346
347 #if USE_SERIAL_1_HW_FLOW || USE_SERIAL_2_HW_FLOW
348 #define HAS_SERIAL_HW_FLOW      1
349 #else
350 #define HAS_SERIAL_HW_FLOW      0
351 #endif
352
353 struct ao_stm_usart {
354         struct ao_fifo          rx_fifo;
355         struct ao_fifo          tx_fifo;
356         struct stm_usart        *reg;
357         uint8_t                 tx_running;
358         uint8_t                 draining;
359 #if HAS_SERIAL_SW_FLOW
360         /* RTS - 0 if we have FIFO space, 1 if not
361          * CTS - 0 if we can send, 0 if not
362          */
363         struct stm_gpio         *gpio_rts;
364         struct stm_gpio         *gpio_cts;
365         uint8_t                 pin_rts;
366         uint8_t                 pin_cts;
367         uint8_t                 rts;
368 #endif
369 };
370
371 #if HAS_SERIAL_1
372 extern struct ao_stm_usart      ao_stm_usart1;
373 #endif
374
375 #if HAS_SERIAL_2
376 extern struct ao_stm_usart      ao_stm_usart2;
377 #endif
378
379 #if HAS_SERIAL_3
380 extern struct ao_stm_usart      ao_stm_usart3;
381 #endif
382
383 #define ARM_PUSH32(stack, val)  (*(--(stack)) = (val))
384
385 typedef uint32_t        ao_arch_irq_t;
386
387 static inline uint32_t
388 ao_arch_irqsave(void) {
389         uint32_t        primask;
390         asm("mrs %0,primask" : "=&r" (primask));
391         ao_arch_block_interrupts();
392         return primask;
393 }
394
395 static inline void
396 ao_arch_irqrestore(uint32_t primask) {
397         asm("msr primask,%0" : : "r" (primask));
398 }
399
400 static inline void
401 ao_arch_memory_barrier(void) {
402         asm volatile("" ::: "memory");
403 }
404
405 #if HAS_TASK
406 static inline void
407 ao_arch_init_stack(struct ao_task *task, uint32_t *sp, void *start)
408 {
409         uint32_t        a = (uint32_t) start;
410         int             i;
411
412         /* Return address (goes into LR) */
413         ARM_PUSH32(sp, a);
414
415         /* Clear register values r0-r7 */
416         i = 8;
417         while (i--)
418                 ARM_PUSH32(sp, 0);
419
420         /* APSR */
421         ARM_PUSH32(sp, 0);
422
423         /* PRIMASK with interrupts enabled */
424         ARM_PUSH32(sp, 0);
425
426         task->sp32 = sp;
427 }
428
429 static inline void ao_arch_save_regs(void) {
430         /* Save general registers */
431         asm("push {r0-r7,lr}\n");
432
433         /* Save APSR */
434         asm("mrs r0,apsr");
435         asm("push {r0}");
436
437         /* Save PRIMASK */
438         asm("mrs r0,primask");
439         asm("push {r0}");
440 }
441
442 static inline void ao_arch_save_stack(void) {
443         uint32_t        *sp;
444         asm("mov %0,sp" : "=&r" (sp) );
445         ao_cur_task->sp32 = (sp);
446         if (sp < &ao_cur_task->stack32[0])
447                 ao_panic (AO_PANIC_STACK);
448 }
449
450 static inline void ao_arch_restore_stack(void) {
451         /* Switch stacks */
452         asm("mov sp, %0" : : "r" (ao_cur_task->sp32) );
453
454         /* Restore PRIMASK */
455         asm("pop {r0}");
456         asm("msr primask,r0");
457
458         /* Restore APSR */
459         asm("pop {r0}");
460         asm("msr apsr_nczvq,r0");
461
462         /* Restore general registers */
463         asm("pop {r0-r7,pc}\n");
464 }
465
466 static inline void ao_sleep_mode(void) {
467
468         /*
469           WFI (Wait for Interrupt) or WFE (Wait for Event) while:
470            – Set SLEEPDEEP in Cortex ® -M0 System Control register
471            – Set PDDS bit in Power Control register (PWR_CR)
472            – Clear WUF bit in Power Control/Status register (PWR_CSR)
473         */
474
475         ao_arch_block_interrupts();
476
477         /* Enable power interface clock */
478         stm_rcc.apb1enr |= (1 << STM_RCC_APB1ENR_PWREN);
479         ao_arch_nop();
480         stm_scb.scr |= (1 << STM_SCB_SCR_SLEEPDEEP);
481         ao_arch_nop();
482         stm_pwr.cr |= (1 << STM_PWR_CR_PDDS) | (1 << STM_PWR_CR_LPDS);
483         ao_arch_nop();
484         stm_pwr.cr |= (1 << STM_PWR_CR_CWUF);
485         ao_arch_nop();
486         ao_arch_nop();
487         ao_arch_nop();
488         ao_arch_nop();
489         ao_arch_nop();
490         asm("wfi");
491         ao_arch_nop();
492 }
493
494 #ifndef HAS_SAMPLE_PROFILE
495 #define HAS_SAMPLE_PROFILE 0
496 #endif
497
498 #if !HAS_SAMPLE_PROFILE
499 #define HAS_ARCH_START_SCHEDULER        1
500
501 static inline void ao_arch_start_scheduler(void) {
502         uint32_t        sp;
503         uint32_t        control;
504
505         asm("mrs %0,msp" : "=&r" (sp));
506         asm("msr psp,%0" : : "r" (sp));
507         asm("mrs %0,control" : "=&r" (control));
508         control |= (1 << 1);
509         asm("msr control,%0" : : "r" (control));
510         asm("isb");
511 }
512 #endif
513
514 #define ao_arch_isr_stack()
515
516 #endif
517
518 #define ao_arch_wait_interrupt() do {                           \
519                 asm("\twfi\n");                                 \
520                 ao_arch_release_interrupts();                   \
521                 asm(".global ao_idle_loc\nao_idle_loc:");       \
522                 ao_arch_block_interrupts();                     \
523         } while (0)
524
525 #define ao_arch_critical(b) do {                        \
526                 uint32_t __mask = ao_arch_irqsave();    \
527                 do { b } while (0);                     \
528                 ao_arch_irqrestore(__mask);             \
529         } while (0)
530
531 /* ao_usb_stm.c */
532
533 #if AO_USB_DIRECTIO
534 uint8_t
535 ao_usb_alloc(uint16_t *buffers[2]);
536
537 uint8_t
538 ao_usb_alloc2(uint16_t *buffers[2]);
539
540 uint8_t
541 ao_usb_write(uint16_t len);
542
543 uint8_t
544 ao_usb_write2(uint16_t len);
545 #endif /* AO_USB_DIRECTIO */
546
547 void start(void);
548
549 void
550 ao_debug_out(char c);
551
552 #endif /* _AO_ARCH_FUNCS_H_ */