Switch from GPLv2 to GPLv2+
[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(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_clr_bits(port, bits) stm_gpio_clr_bits(port, bits);
206
207
208 #define ao_enable_output(port,bit,pin,v) do {                   \
209                 ao_enable_port(port);                           \
210                 ao_gpio_set(port, bit, pin, v);                 \
211                 stm_moder_set(port, bit, STM_MODER_OUTPUT);\
212         } while (0)
213
214 #define ao_gpio_set_mode(port,bit,mode) do {                            \
215                 if (mode == AO_EXTI_MODE_PULL_UP)                       \
216                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_UP);    \
217                 else if (mode == AO_EXTI_MODE_PULL_DOWN)                \
218                         stm_pupdr_set(port, bit, STM_PUPDR_PULL_DOWN);  \
219                 else                                                    \
220                         stm_pupdr_set(port, bit, STM_PUPDR_NONE);       \
221         } while (0)
222         
223 #define ao_enable_input(port,bit,mode) do {                             \
224                 ao_enable_port(port);                                   \
225                 stm_moder_set(port, bit, STM_MODER_INPUT);              \
226                 ao_gpio_set_mode(port, bit, mode);                      \
227         } while (0)
228
229 #define ao_enable_cs(port,bit) do {                             \
230                 stm_gpio_set((port), bit, 1);                   \
231                 stm_moder_set((port), bit, STM_MODER_OUTPUT);   \
232         } while (0)
233
234 #define ao_spi_init_cs(port, mask) do {                         \
235                 ao_enable_port(port);                           \
236                 if ((mask) & 0x0001) ao_enable_cs(port, 0);     \
237                 if ((mask) & 0x0002) ao_enable_cs(port, 1);     \
238                 if ((mask) & 0x0004) ao_enable_cs(port, 2);     \
239                 if ((mask) & 0x0008) ao_enable_cs(port, 3);     \
240                 if ((mask) & 0x0010) ao_enable_cs(port, 4);     \
241                 if ((mask) & 0x0020) ao_enable_cs(port, 5);     \
242                 if ((mask) & 0x0040) ao_enable_cs(port, 6);     \
243                 if ((mask) & 0x0080) ao_enable_cs(port, 7);     \
244                 if ((mask) & 0x0100) ao_enable_cs(port, 8);     \
245                 if ((mask) & 0x0200) ao_enable_cs(port, 9);     \
246                 if ((mask) & 0x0400) ao_enable_cs(port, 10);\
247                 if ((mask) & 0x0800) ao_enable_cs(port, 11);\
248                 if ((mask) & 0x1000) ao_enable_cs(port, 12);\
249                 if ((mask) & 0x2000) ao_enable_cs(port, 13);\
250                 if ((mask) & 0x4000) ao_enable_cs(port, 14);\
251                 if ((mask) & 0x8000) ao_enable_cs(port, 15);\
252         } while (0)
253
254 /* ao_dma_stm.c
255  */
256
257 extern uint8_t ao_dma_done[STM_NUM_DMA];
258
259 void
260 ao_dma_set_transfer(uint8_t             index,
261                     volatile void       *peripheral,
262                     void                *memory,
263                     uint16_t            count,
264                     uint32_t            ccr);
265
266 void
267 ao_dma_set_isr(uint8_t index, void (*isr)(int index));
268
269 void
270 ao_dma_start(uint8_t index);
271
272 void
273 ao_dma_done_transfer(uint8_t index);
274
275 void
276 ao_dma_alloc(uint8_t index);
277
278 void
279 ao_dma_init(void);
280
281 /* ao_i2c_stm.c */
282
283 void
284 ao_i2c_get(uint8_t i2c_index);
285
286 uint8_t
287 ao_i2c_start(uint8_t i2c_index, uint16_t address);
288
289 void
290 ao_i2c_put(uint8_t i2c_index);
291
292 uint8_t
293 ao_i2c_send(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
294
295 uint8_t
296 ao_i2c_recv(void *block, uint16_t len, uint8_t i2c_index, uint8_t stop);
297
298 void
299 ao_i2c_init(void);
300
301 #if USE_SERIAL_1_SW_FLOW || USE_SERIAL_2_SW_FLOW || USE_SERIAL_3_SW_FLOW
302 #define HAS_SERIAL_SW_FLOW 1
303 #else
304 #define HAS_SERIAL_SW_FLOW 0
305 #endif
306
307 #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
308 #define HAS_SERIAL_HW_FLOW 1
309 #else
310 #define HAS_SERIAL_HW_FLOW 0
311 #endif
312
313 /* ao_serial_stm.c */
314 struct ao_stm_usart {
315         struct ao_fifo          rx_fifo;
316         struct ao_fifo          tx_fifo;
317         struct stm_usart        *reg;
318         uint8_t                 tx_running;
319         uint8_t                 draining;
320 #if HAS_SERIAL_SW_FLOW
321         /* RTS - 0 if we have FIFO space, 1 if not
322          * CTS - 0 if we can send, 0 if not
323          */
324         struct stm_gpio         *gpio_rts;
325         struct stm_gpio         *gpio_cts;
326         uint8_t                 pin_rts;
327         uint8_t                 pin_cts;
328         uint8_t                 rts;
329 #endif
330 };
331
332 #if HAS_SERIAL_1
333 extern struct ao_stm_usart      ao_stm_usart1;
334 #endif
335
336 #if HAS_SERIAL_2
337 extern struct ao_stm_usart      ao_stm_usart2;
338 #endif
339
340 #if HAS_SERIAL_3
341 extern struct ao_stm_usart      ao_stm_usart3;
342 #endif
343
344 #define ARM_PUSH32(stack, val)  (*(--(stack)) = (val))
345
346 typedef uint32_t        ao_arch_irq_t;
347
348 static inline uint32_t
349 ao_arch_irqsave(void) {
350         uint32_t        primask;
351         asm("mrs %0,primask" : "=&r" (primask));
352         ao_arch_block_interrupts();
353         return primask;
354 }
355
356 static inline void
357 ao_arch_irqrestore(uint32_t primask) {
358         asm("msr primask,%0" : : "r" (primask));
359 }
360
361 static inline void
362 ao_arch_memory_barrier() {
363         asm volatile("" ::: "memory");
364 }
365
366 static inline void
367 ao_arch_irq_check(void) {
368         uint32_t        primask;
369         asm("mrs %0,primask" : "=&r" (primask));
370         if ((primask & 1) == 0)
371                 ao_panic(AO_PANIC_IRQ);
372 }
373
374 #if HAS_TASK
375 static inline void
376 ao_arch_init_stack(struct ao_task *task, void *start)
377 {
378         uint32_t        *sp = (uint32_t *) (task->stack + AO_STACK_SIZE);
379         uint32_t        a = (uint32_t) start;
380         int             i;
381
382         /* Return address (goes into LR) */
383         ARM_PUSH32(sp, a);
384
385         /* Clear register values r0-r12 */
386         i = 13;
387         while (i--)
388                 ARM_PUSH32(sp, 0);
389
390         /* APSR */
391         ARM_PUSH32(sp, 0);
392
393         /* PRIMASK with interrupts enabled */
394         ARM_PUSH32(sp, 0);
395
396         task->sp = sp;
397 }
398
399 static inline void ao_arch_save_regs(void) {
400         /* Save general registers */
401         asm("push {r0-r12,lr}\n");
402
403         /* Save APSR */
404         asm("mrs r0,apsr");
405         asm("push {r0}");
406
407         /* Save PRIMASK */
408         asm("mrs r0,primask");
409         asm("push {r0}");
410 }
411
412 static inline void ao_arch_save_stack(void) {
413         uint32_t        *sp;
414         asm("mov %0,sp" : "=&r" (sp) );
415         ao_cur_task->sp = (sp);
416         if ((uint8_t *) sp < &ao_cur_task->stack[0])
417                 ao_panic (AO_PANIC_STACK);
418 }
419
420 static inline void ao_arch_restore_stack(void) {
421         uint32_t        sp;
422         sp = (uint32_t) ao_cur_task->sp;
423
424         /* Switch stacks */
425         asm("mov sp, %0" : : "r" (sp) );
426
427         /* Restore PRIMASK */
428         asm("pop {r0}");
429         asm("msr primask,r0");
430
431         /* Restore APSR */
432         asm("pop {r0}");
433         asm("msr apsr_nczvq,r0");
434
435         /* Restore general registers */
436         asm("pop {r0-r12,lr}\n");
437
438         /* Return to calling function */
439         asm("bx lr");
440 }
441
442 #ifndef HAS_SAMPLE_PROFILE
443 #define HAS_SAMPLE_PROFILE 0
444 #endif
445
446 #if DEBUG
447 #define HAS_ARCH_VALIDATE_CUR_STACK     1
448
449 static inline void
450 ao_validate_cur_stack(void)
451 {
452         uint8_t         *psp;
453
454         asm("mrs %0,psp" : "=&r" (psp));
455         if (ao_cur_task &&
456             psp <= ao_cur_task->stack &&
457             psp >= ao_cur_task->stack - 256)
458                 ao_panic(AO_PANIC_STACK);
459 }
460 #endif
461
462 #if !HAS_SAMPLE_PROFILE
463 #define HAS_ARCH_START_SCHEDULER        1
464
465 static inline void ao_arch_start_scheduler(void) {
466         uint32_t        sp;
467         uint32_t        control;
468
469         asm("mrs %0,msp" : "=&r" (sp));
470         asm("msr psp,%0" : : "r" (sp));
471         asm("mrs %0,control" : "=&r" (control));
472         control |= (1 << 1);
473         asm("msr control,%0" : : "r" (control));
474         asm("isb");
475 }
476 #endif
477
478 #define ao_arch_isr_stack()
479
480 #endif
481
482 #define ao_arch_wait_interrupt() do {                           \
483                 asm("\twfi\n");                                 \
484                 ao_arch_release_interrupts();                   \
485                 asm(".global ao_idle_loc\nao_idle_loc:");       \
486                 ao_arch_block_interrupts();                     \
487         } while (0)
488
489 #define ao_arch_critical(b) do {                        \
490                 uint32_t __mask = ao_arch_irqsave();    \
491                 do { b } while (0);                     \
492                 ao_arch_irqrestore(__mask);             \
493         } while (0)
494
495 #endif /* _AO_ARCH_FUNCS_H_ */