update chopstx
[gnuk/neug.git] / src / sys.c
1 /*
2  * sys.c - system routines for the initial page for STM32F103.
3  *
4  * Copyright (C) 2013, 2014, 2015 Flying Stone Technology
5  * Author: NIIBE Yutaka <gniibe@fsij.org>
6  *
7  * Copying and distribution of this file, with or without modification,
8  * are permitted in any medium without royalty provided the copyright
9  * notice and this notice are preserved.  This file is offered as-is,
10  * without any warranty.
11  *
12  * When the flash ROM is protected, we cannot modify the initial page.
13  * We put some system routines (which is useful for any program) here.
14  */
15
16 #include <stdint.h>
17 #include <stdlib.h>
18 #include "board.h"
19
20 #include "clk_gpio_init.c"
21
22 #define CORTEX_PRIORITY_BITS    4
23 #define CORTEX_PRIORITY_MASK(n)  ((n) << (8 - CORTEX_PRIORITY_BITS))
24 #define USB_LP_CAN1_RX0_IRQn     20
25 #define STM32_USB_IRQ_PRIORITY   11
26
27 struct NVIC {
28   uint32_t ISER[8];
29   uint32_t unused1[24];
30   uint32_t ICER[8];
31   uint32_t unused2[24];
32   uint32_t ISPR[8];
33   uint32_t unused3[24];
34   uint32_t ICPR[8];
35   uint32_t unused4[24];
36   uint32_t IABR[8];
37   uint32_t unused5[56];
38   uint32_t IPR[60];
39 };
40
41 static struct NVIC *const NVICBase = ((struct NVIC *const)0xE000E100);
42 #define NVIC_ISER(n)    (NVICBase->ISER[n >> 5])
43 #define NVIC_ICPR(n)    (NVICBase->ICPR[n >> 5])
44 #define NVIC_IPR(n)     (NVICBase->IPR[n >> 2])
45
46 static void
47 nvic_enable_vector (uint32_t n, uint32_t prio)
48 {
49   unsigned int sh = (n & 3) << 3;
50
51   NVIC_IPR (n) = (NVIC_IPR(n) & ~(0xFF << sh)) | (prio << sh);
52   NVIC_ICPR (n) = 1 << (n & 0x1F);
53   NVIC_ISER (n) = 1 << (n & 0x1F);
54 }
55
56 static void
57 usb_cable_config (int enable)
58 {
59 #if defined(GPIO_USB_SET_TO_ENABLE)
60   if (enable)
61     GPIO_USB->BSRR = (1 << GPIO_USB_SET_TO_ENABLE);
62   else
63     GPIO_USB->BRR = (1 << GPIO_USB_SET_TO_ENABLE);
64 #elif defined(GPIO_USB_CLEAR_TO_ENABLE)
65   if (enable)
66     GPIO_USB->BRR = (1 << GPIO_USB_CLEAR_TO_ENABLE);
67   else
68     GPIO_USB->BSRR = (1 << GPIO_USB_CLEAR_TO_ENABLE);
69 #else
70   (void)enable;
71 #endif
72 }
73
74 void
75 set_led (int on)
76 {
77 #if defined(GPIO_LED_CLEAR_TO_EMIT)
78   if (on)
79     GPIO_LED->BRR = (1 << GPIO_LED_CLEAR_TO_EMIT);
80   else
81     GPIO_LED->BSRR = (1 << GPIO_LED_CLEAR_TO_EMIT);
82 #else
83   if (on)
84     GPIO_LED->BSRR = (1 << GPIO_LED_SET_TO_EMIT);
85   else
86     GPIO_LED->BRR = (1 << GPIO_LED_SET_TO_EMIT);
87 #endif
88 }
89
90 static void wait (int count)
91 {
92   int i;
93
94   for (i = 0; i < count; i++)
95     asm volatile ("" : : "r" (i) : "memory");
96 }
97
98
99 static void
100 usb_lld_sys_shutdown (void)
101 {
102   RCC->APB1ENR &= ~RCC_APB1ENR_USBEN;
103   RCC->APB1RSTR = RCC_APB1RSTR_USBRST;
104   usb_cable_config (0);
105 }
106
107 static void
108 usb_lld_sys_init (void)
109 {
110   if ((RCC->APB1ENR & RCC_APB1ENR_USBEN)
111       && (RCC->APB1RSTR & RCC_APB1RSTR_USBRST) == 0)
112     /* Make sure the device is disconnected, even after core reset.  */
113     {
114       usb_lld_sys_shutdown ();
115       /* Disconnect requires SE0 (>= 2.5uS).  */
116       wait (300);
117     }
118
119   usb_cable_config (1);
120   RCC->APB1ENR |= RCC_APB1ENR_USBEN;
121   nvic_enable_vector (USB_LP_CAN1_RX0_IRQn,
122                       CORTEX_PRIORITY_MASK (STM32_USB_IRQ_PRIORITY));
123   /*
124    * Note that we also have other IRQ(s):
125    *    USB_HP_CAN1_TX_IRQn (for double-buffered or isochronous)
126    *    USBWakeUp_IRQn (suspend/resume)
127    */
128   RCC->APB1RSTR = RCC_APB1RSTR_USBRST;
129   RCC->APB1RSTR = 0;
130 }
131
132 #define FLASH_KEY1               0x45670123UL
133 #define FLASH_KEY2               0xCDEF89ABUL
134
135 enum flash_status
136 {
137   FLASH_BUSY = 1,
138   FLASH_ERROR_PG,
139   FLASH_ERROR_WRP,
140   FLASH_COMPLETE,
141   FLASH_TIMEOUT
142 };
143
144 static void __attribute__ ((used))
145 flash_unlock (void)
146 {
147   FLASH->KEYR = FLASH_KEY1;
148   FLASH->KEYR = FLASH_KEY2;
149 }
150
151
152 #define intr_disable()  asm volatile ("cpsid   i" : : : "memory")
153 #define intr_enable()  asm volatile ("cpsie   i" : : : "memory")
154
155 #define FLASH_SR_BSY            0x01
156 #define FLASH_SR_PGERR          0x04
157 #define FLASH_SR_WRPRTERR       0x10
158 #define FLASH_SR_EOP            0x20
159
160 #define FLASH_CR_PG     0x0001
161 #define FLASH_CR_PER    0x0002
162 #define FLASH_CR_MER    0x0004
163 #define FLASH_CR_OPTPG  0x0010
164 #define FLASH_CR_OPTER  0x0020
165 #define FLASH_CR_STRT   0x0040
166 #define FLASH_CR_LOCK   0x0080
167 #define FLASH_CR_OPTWRE 0x0200
168 #define FLASH_CR_ERRIE  0x0400
169 #define FLASH_CR_EOPIE  0x1000
170
171 static int
172 flash_wait_for_last_operation (uint32_t timeout)
173 {
174   int status;
175
176   do
177     {
178       status = FLASH->SR;
179       if (--timeout == 0)
180         break;
181     }
182   while ((status & FLASH_SR_BSY) != 0);
183
184   return status & (FLASH_SR_BSY|FLASH_SR_PGERR|FLASH_SR_WRPRTERR);
185 }
186
187 #define FLASH_PROGRAM_TIMEOUT 0x00010000
188 #define FLASH_ERASE_TIMEOUT   0x01000000
189
190 static int
191 flash_program_halfword (uint32_t addr, uint16_t data)
192 {
193   int status;
194
195   status = flash_wait_for_last_operation (FLASH_PROGRAM_TIMEOUT);
196
197   intr_disable ();
198   if (status == 0)
199     {
200       FLASH->CR |= FLASH_CR_PG;
201
202       *(volatile uint16_t *)addr = data;
203
204       status = flash_wait_for_last_operation (FLASH_PROGRAM_TIMEOUT);
205       FLASH->CR &= ~FLASH_CR_PG;
206     }
207   intr_enable ();
208
209   return status;
210 }
211
212 static int
213 flash_erase_page (uint32_t addr)
214 {
215   int status;
216
217   status = flash_wait_for_last_operation (FLASH_ERASE_TIMEOUT);
218
219   intr_disable ();
220   if (status == 0)
221     {
222       FLASH->CR |= FLASH_CR_PER;
223       FLASH->AR = addr;
224       FLASH->CR |= FLASH_CR_STRT;
225
226       status = flash_wait_for_last_operation (FLASH_ERASE_TIMEOUT);
227       FLASH->CR &= ~FLASH_CR_PER;
228     }
229   intr_enable ();
230
231   return status;
232 }
233
234 static int
235 flash_check_blank (const uint8_t *p_start, size_t size)
236 {
237   const uint8_t *p;
238
239   for (p = p_start; p < p_start + size; p++)
240     if (*p != 0xff)
241       return 0;
242
243   return 1;
244 }
245
246 #define FLASH_START_ADDR 0x08000000 /* Fixed for all STM32F1.  */
247 #define FLASH_OFFSET     0x1000     /* First pages are not-writable.  */
248 #define FLASH_START      (FLASH_START_ADDR+FLASH_OFFSET)
249 #define CHIP_ID_REG      ((uint32_t *)0xe0042000)
250 #define FLASH_SIZE_REG   ((uint16_t *)0x1ffff7e0)
251
252 static int
253 flash_write (uint32_t dst_addr, const uint8_t *src, size_t len)
254 {
255   int status;
256   uint32_t flash_end = FLASH_START_ADDR + (*FLASH_SIZE_REG)*1024;
257
258   if (dst_addr < FLASH_START || dst_addr + len > flash_end)
259     return 0;
260
261   while (len)
262     {
263       uint16_t hw = *src++;
264
265       hw |= (*src++ << 8);
266       status = flash_program_halfword (dst_addr, hw);
267       if (status != 0)
268         return 0;               /* error return */
269
270       dst_addr += 2;
271       len -= 2;
272     }
273
274   return 1;
275 }
276
277 #define OPTION_BYTES_ADDR 0x1ffff800
278
279 static int
280 flash_protect (void)
281 {
282   int status;
283   uint32_t option_bytes_value;
284
285   status = flash_wait_for_last_operation (FLASH_ERASE_TIMEOUT);
286
287   intr_disable ();
288   if (status == 0)
289     {
290       FLASH->OPTKEYR = FLASH_KEY1;
291       FLASH->OPTKEYR = FLASH_KEY2;
292
293       FLASH->CR |= FLASH_CR_OPTER;
294       FLASH->CR |= FLASH_CR_STRT;
295
296       status = flash_wait_for_last_operation (FLASH_ERASE_TIMEOUT);
297       FLASH->CR &= ~FLASH_CR_OPTER;
298     }
299   intr_enable ();
300
301   if (status != 0)
302     return 0;
303
304   option_bytes_value = *(uint32_t *)OPTION_BYTES_ADDR;
305   return (option_bytes_value & 0xff) == 0xff ? 1 : 0;
306 }
307
308 static void __attribute__((naked))
309 flash_erase_all_and_exec (void (*entry)(void))
310 {
311   uint32_t addr = FLASH_START;
312   uint32_t end = FLASH_START_ADDR + (*FLASH_SIZE_REG)*1024;
313   uint32_t page_size = 1024;
314   int r;
315
316   if (((*CHIP_ID_REG) & 0xfff) == 0x0414)
317     page_size = 2048;
318
319   while (addr < end)
320     {
321       r = flash_erase_page (addr);
322       if (r != 0)
323         break;
324
325       addr += page_size;
326     }
327
328   if (addr >= end)
329     (*entry) ();
330
331   for (;;);
332 }
333
334 struct SCB
335 {
336   volatile uint32_t CPUID;
337   volatile uint32_t ICSR;
338   volatile uint32_t VTOR;
339   volatile uint32_t AIRCR;
340   volatile uint32_t SCR;
341   volatile uint32_t CCR;
342   volatile uint8_t  SHP[12];
343   volatile uint32_t SHCSR;
344   volatile uint32_t CFSR;
345   volatile uint32_t HFSR;
346   volatile uint32_t DFSR;
347   volatile uint32_t MMFAR;
348   volatile uint32_t BFAR;
349   volatile uint32_t AFSR;
350   volatile uint32_t PFR[2];
351   volatile uint32_t DFR;
352   volatile uint32_t ADR;
353   volatile uint32_t MMFR[4];
354   volatile uint32_t ISAR[5];
355 };
356
357 #define SCS_BASE        (0xE000E000)
358 #define SCB_BASE        (SCS_BASE +  0x0D00)
359 static struct SCB *const SCB = ((struct SCB *const) SCB_BASE);
360
361 #define SYSRESETREQ 0x04
362 static void
363 nvic_system_reset (void)
364 {
365   SCB->AIRCR = (0x05FA0000 | (SCB->AIRCR & 0x70) | SYSRESETREQ);
366   asm volatile ("dsb");
367   for (;;);
368 }
369
370 static void __attribute__ ((naked))
371 reset (void)
372 {
373   extern const unsigned long *FT0, *FT1, *FT2;
374
375   /*
376    * This code may not be at the start of flash ROM, because of DFU.
377    * So, we take the address from PC.
378    */
379   asm volatile ("cpsid  i\n\t"          /* Mask all interrupts. */
380                 "ldr    r0, 1f\n\t"     /* r0 = SCR */
381                 "mov    r1, pc\n\t"     /* r1 = (PC + 0x1000) & ~0x0fff */
382                 "mov    r2, #0x1000\n\t"
383                 "add    r1, r1, r2\n\t"
384                 "sub    r2, r2, #1\n\t"
385                 "bic    r1, r1, r2\n\t"
386                 "str    r1, [r0, #8]\n\t"       /* Set SCR->VCR */
387                 "ldr    r0, [r1], #4\n\t"
388                 "msr    MSP, r0\n\t"    /* Main (exception handler) stack. */
389                 "ldr    r0, [r1]\n\t"   /* Reset handler.                  */
390                 "bx     r0\n\t"
391                 ".align 2\n"
392         "1:     .word   0xe000ed00"
393                 : /* no output */ : /* no input */ : "memory");
394
395   /* Never reach here. */
396   /* Artificial entry to refer FT0, FT1, and FT2.  */
397   asm volatile (""
398                 : : "r" (FT0), "r" (FT1), "r" (FT2));
399 }
400
401 typedef void (*handler)(void);
402 extern uint8_t __ram_end__;
403
404 handler vector[] __attribute__ ((section(".vectors"))) = {
405   (handler)&__ram_end__,
406   reset,
407   (handler)set_led,
408   flash_unlock,
409   (handler)flash_program_halfword,
410   (handler)flash_erase_page,
411   (handler)flash_check_blank,
412   (handler)flash_write,
413   (handler)flash_protect,
414   (handler)flash_erase_all_and_exec,
415   usb_lld_sys_init,
416   usb_lld_sys_shutdown,
417   nvic_system_reset,
418   clock_init,
419   gpio_init,
420   NULL,
421 };
422
423 const uint8_t sys_version[8] __attribute__((section(".sys.version"))) = {
424   3*2+2,             /* bLength */
425   0x03,              /* bDescriptorType = USB_STRING_DESCRIPTOR_TYPE */
426   /* sys version: "2.1" */
427   '2', 0, '.', 0, '1', 0,
428 };
429
430 const uint32_t __attribute__((section(".sys.board_id")))
431 sys_board_id = BOARD_ID;
432
433 const uint8_t __attribute__((section(".sys.board_name")))
434 sys_board_name[] = BOARD_NAME;