STM32: USB: use generic completion events
[bertos.git] / bertos / cpu / cortex-m3 / drv / usb_stm32.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \brief STM32 USB driver
34  *
35  * \author Andrea Righi <arighi@develer.com>
36  */
37
38 #include "cfg/cfg_usb.h"
39
40 #define LOG_LEVEL  USB_LOG_LEVEL
41 #define LOG_FORMAT USB_LOG_FORMAT
42
43 #include <cfg/log.h>
44 #include <cfg/debug.h>
45 #include <cfg/macros.h>
46 #include <cfg/module.h>
47
48 #include <cpu/irq.h>
49 #include <cpu/power.h>
50
51 #include <drv/irq_cm3.h>
52 #include <drv/gpio_stm32.h>
53 #include <drv/clock_stm32.h>
54 #include <drv/timer.h>
55 #include <drv/usb.h>
56
57 #include <mware/event.h>
58
59 #include <string.h> /* memcpy() */
60
61 #include "usb_stm32.h"
62
63 /* XXX: consider to move this to cfg/macros.h */
64
65 /* XXX: redefine this to make it usable within C expression */
66 #define _MIN(a,b)       (((a) < (b)) ? (a) : (b))
67
68 /* STM32 USB registers */
69 struct stm32_usb
70 {
71         reg32_t EP0R;
72         reg32_t EP1R;
73         reg32_t EP2R;
74         reg32_t EP3R;
75         reg32_t EP4R;
76         reg32_t EP5R;
77         reg32_t EP6R;
78         reg32_t EP7R;
79         reg32_t __reserved[8];
80         reg32_t CNTR;
81         reg32_t ISTR;
82         reg32_t FNR;
83         reg32_t DADDR;
84         reg32_t BTABLE;
85 };
86
87 /* Hardware registers */
88 static struct stm32_usb *usb = (struct stm32_usb *)USB_BASE_ADDR;
89
90 /* Endpoint descriptors: used for handling requests to use with endpoints */
91 static stm32_UsbEp ep_cnfg[EP_MAX_NUM];
92 STATIC_ASSERT(EP_MAX_NUM <= EP_MAX_HW_NUM);
93
94 /* USB EP0 control descriptor */
95 static const UsbEndpointDesc USB_CtrlEpDescr0 =
96 {
97         .bLength = sizeof(USB_CtrlEpDescr0),
98         .bDescriptorType = USB_DT_ENDPOINT,
99         .bEndpointAddress = USB_DIR_OUT | 0,
100         .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
101         .wMaxPacketSize = USB_EP0_MAX_SIZE,
102         .bInterval = 0,
103 };
104
105 /* USB EP1 control descriptor */
106 static const UsbEndpointDesc USB_CtrlEpDescr1 =
107 {
108         .bLength = sizeof(USB_CtrlEpDescr1),
109         .bDescriptorType = USB_DT_ENDPOINT,
110         .bEndpointAddress = USB_DIR_IN | 0,
111         .bmAttributes = USB_ENDPOINT_XFER_CONTROL,
112         .wMaxPacketSize = USB_EP0_MAX_SIZE,
113         .bInterval = 0,
114 };
115
116 /* USB setup packet */
117 static UsbCtrlRequest setup_packet;
118
119 /* USB device controller: max supported interfaces */
120 #define USB_MAX_INTERFACE       1
121
122 /* USB device controller features */
123 #define STM32_UDC_FEATURE_SELFPOWERED   BV(0)
124 #define STM32_UDC_FEATURE_REMOTE_WAKEUP BV(1)
125
126 /* Hardware-specific USB device controller structure */
127 typedef struct stm32_udc
128 {
129         uint8_t state;
130         uint32_t cfg_id;
131         const UsbConfigDesc *cfg;
132         uint32_t interfaces;
133         uint32_t alt[USB_MAX_INTERFACE];
134         uint32_t address;
135         uint8_t feature;
136 } PACKED stm32_udc_t;
137
138 /* Hardware-specific USB Device Controller */
139 static stm32_udc_t udc;
140
141 /* Generic USB Device Controller structure */
142 static UsbDevice *usb_dev;
143
144 /* USB packet memory management: list of allocated chunks */
145 static stm32_UsbMemSlot *mem_use;
146
147 /* USB packet memory management: memory buffer metadata */
148 static stm32_UsbMemSlot memory_buffer[EP_MAX_NUM];
149
150 /* Endpoint TX and RX buffers */
151 /// \cond
152 /* XXX: use the empty cond section to silent a buggy doxygen warning */
153 static size_t rx_size, tx_size;
154
155 #define EP_BUFFER_SIZE _MIN(CONFIG_USB_BUFSIZE, USB_XFER_MAX_SIZE)
156 STATIC_ASSERT(!(EP_BUFFER_SIZE & 0x03));
157
158 static uint8_t ep_buffer[EP_MAX_NUM][EP_BUFFER_SIZE] ALIGNED(4);
159 /// \endcond
160
161 static Event usb_event_done[EP_MAX_SLOTS];
162
163 /* Allocate a free block of the packet memory */
164 static stm32_UsbMemSlot *usb_malloc(void)
165 {
166         unsigned int i;
167
168         for (i = 0; i < countof(memory_buffer); i++)
169                 if (memory_buffer[i].Size == 0)
170                         return &memory_buffer[i];
171         return NULL;
172 }
173
174 /* Release a block of the packet memory */
175 static void usb_free(stm32_UsbMemSlot *pPntr)
176 {
177         pPntr->Size = 0;
178 }
179
180 /* Allocate a free chunk of the packet memory (inside a block) */
181 static bool usb_alloc_buffer(uint16_t *pOffset, uint32_t *size,
182                             int EndPoint)
183 {
184         stm32_UsbMemSlot *mem = mem_use,
185                         *memNext, *mem_useNew;
186         uint32_t max_size = *size;
187
188         /*
189          * Packet size alignment:
190          *  - fine-granularity allocation: size alignment by 2;
191          *  - coarse-granularity allocation: size alignment by 32.
192          */
193         if (max_size < 62)
194                 max_size = ALIGN_UP(max_size, 2);
195         else
196                 max_size = ALIGN_UP(max_size, 32);
197         /*
198          * Finding free memory chunks from the allocated blocks of the USB
199          * packet memory.
200          */
201         *pOffset = 0;
202         while (mem != NULL)
203         {
204                 /* Offset alignment by 4 */
205                 *pOffset = ALIGN_UP(mem->Start + mem->Size, 4);
206                 memNext = mem->next;
207                 if ((mem->next == NULL) ||
208                                 (memNext->Start >=
209                                         *pOffset + max_size))
210                         break;
211                 mem = mem->next;
212         }
213         /* Check for out-of-memory condition */
214         if (UNLIKELY((*pOffset + max_size) >= USB_BDT_OFFSET))
215                 return false;
216         /*
217          * Allocate a new memory block, next to the last allocated block.
218          */
219         mem_useNew = usb_malloc();
220         if (UNLIKELY(mem_useNew == NULL))
221                 return false;
222         /* Insert the block to the list of allocated blocks */
223         if (mem_use == NULL)
224         {
225                 mem_use = mem_useNew;
226                 mem_use->next = NULL;
227         }
228         else
229         {
230                 mem_useNew->next = mem->next;
231                 mem->next = mem_useNew;
232         }
233         /* Update block's metadata */
234         mem_useNew->ep_addr = EndPoint;
235         mem_useNew->Start = *pOffset;
236         mem_useNew->Size = max_size;
237
238         *size = max_size;
239
240         return true;
241 }
242
243 /* Release a chunk of the packet memory (inside a block) */
244 static void usb_free_buffer(int EndPoint)
245 {
246         stm32_UsbMemSlot *mem, *memPrev = NULL;
247         mem = mem_use;
248
249         while (mem != NULL)
250         {
251                 if (mem->ep_addr == EndPoint)
252                 {
253                         if (UNLIKELY(memPrev == NULL))
254                         {
255                                 /* Free the first element of the list */
256                                 mem_use = mem_use->next;
257                                 usb_free(mem);
258                                 mem = mem_use;
259                                 continue;
260                         }
261                         memPrev->next = mem->next;
262                         usb_free(mem);
263                 }
264                 else
265                         memPrev = mem;
266                 mem = memPrev->next;
267         }
268 }
269
270 /*-------------------------------------------------------------------------*/
271
272 /* Connect USB controller */
273 static void usb_connect(void)
274 {
275         stm32_gpioPinWrite((struct stm32_gpio *)GPIOC_BASE, 1 << 11, 0);
276 }
277
278 /* Set USB device address */
279 static void usb_set_address(uint32_t addr)
280 {
281         usb->DADDR = addr | 0x80;
282 }
283
284 /* Suspend USB controller */
285 static void usb_suspend(void)
286 {
287         usb->CNTR |= bmFSUSP | bmLPMODE;
288 }
289
290 /* Resume USB controller */
291 static void usb_resume(void)
292 {
293         uint32_t line_status;
294
295         line_status = usb->FNR & 0xc000;
296         if (!line_status)
297                 return;
298         /* check for noise and eventually return to sleep */
299         if (line_status == 0xc000)
300                 usb_suspend();
301         else
302                 usb->CNTR &= ~(bmFSUSP | bmLPMODE);
303 }
304
305 /* Convert logical EP address to physical EP address */
306 static int usb_ep_logical_to_hw(uint8_t ep_addr)
307 {
308         int addr = (ep_addr & 0x0f) << 1;
309         return (ep_addr & 0x80) ? addr + 1 : addr;
310 }
311
312 /* Set EP address */
313 static void ep_ctrl_set_ea(reg32_t *reg, uint32_t val)
314 {
315         val &= 0x0f;
316         val |= *reg & 0x0700;
317         val |= USB_CTRL_CLEAR_ONLY_MASK;
318         *reg = val;
319 }
320
321 /* Get EP IN status */
322 static uint32_t ep_ctrl_get_stat_tx(reg32_t *reg)
323 {
324         return (*reg & (0x3UL << 4)) >> 4;
325 }
326
327 /* Set EP IN state */
328 static void ep_ctrl_set_stat_tx(reg32_t *reg, stm32_UsbEpState val)
329 {
330         uint32_t state;
331         int i;
332
333         /*
334          * The EP can change state between read and write operations from VALID
335          * to NAK and result of set operation will be invalid.
336          */
337         for (i = 0; i < 2; i++)
338         {
339                 if (ep_ctrl_get_stat_tx(reg) == val)
340                         return;
341                 state = val;
342                 state <<= 4;
343                 state ^= *reg;
344                 state |= USB_CTRL_CLEAR_ONLY_MASK;
345                 /* Clear the toggle bits without STAT_TX (4,5) */
346                 state &= ~0x7040;
347                 *reg = state;
348         }
349 }
350
351 /* Set EP DTOG_TX bit (IN) */
352 static void ep_ctrl_set_dtog_tx(reg32_t *reg, uint32_t val)
353 {
354         val = val ? (*reg ^ (1UL << 6)) : *reg;
355         /* Clear the toggle bits without DTOG_TX (6) */
356         val &= ~0x7030;
357         val |= USB_CTRL_CLEAR_ONLY_MASK;
358         *reg = val;
359 }
360
361 /* Clear EP CTR_TX bit (IN) */
362 static void ep_ctrl_clr_ctr_tx(reg32_t *reg)
363 {
364         uint32_t val = *reg;
365
366         val &= ~(USB_CTRL_TOGGLE_MASK | 1UL << 7);
367         /* Set RX_CTR */
368         val |= 1UL << 15;
369         *reg = val;
370 }
371
372 /* Clear EP CTR_RX bit (OUT) */
373 static void ep_ctrl_clr_ctr_rx(reg32_t *reg)
374 {
375         uint32_t val = *reg;
376         val &= ~(USB_CTRL_TOGGLE_MASK | 1UL << 15);
377         /* Set TX_CTR */
378         val |= 1UL << 7;
379         *reg = val;
380 }
381
382 /* Set EP KIND bit */
383 static void ep_ctrl_set_ep_kind(reg32_t *reg, uint32_t val)
384 {
385         val = val ? (1UL << 8) : 0;
386         val |= *reg & ~(USB_CTRL_TOGGLE_MASK | (1UL << 8));
387         val |= USB_CTRL_CLEAR_ONLY_MASK;
388         *reg = val;
389 }
390
391 /* Set EP type */
392 static int ep_ctrl_set_ep_type(reg32_t *reg, uint8_t val)
393 {
394         uint32_t type;
395
396         if (UNLIKELY(val >= EP_TYPE_MAX))
397         {
398                 ASSERT(0);
399                 return USB_INVAL_ERROR;
400         }
401         type = val;
402         type <<= 9;
403         type |= *reg & ~(USB_CTRL_TOGGLE_MASK | (0x3UL << 9));
404         type |= USB_CTRL_CLEAR_ONLY_MASK;
405         *reg = type;
406
407         return USB_OK;
408 }
409
410 /* Get EP STAT_RX (OUT) */
411 static uint32_t ep_ctrl_get_stat_rx(reg32_t *reg)
412 {
413         uint32_t val = *reg & (0x3UL << 12);
414         return val >> 12;
415 }
416
417 /* Set EP STAT_RX (OUT) */
418 static void ep_ctrl_set_stat_rx(reg32_t *reg, stm32_UsbEpState val)
419 {
420         uint32_t state;
421         int i;
422
423         /*
424          * The EP can change state between read and write operations from VALID
425          * to NAK and result of set operation will be invalid.
426          */
427         for (i = 0; i < 2; i++)
428         {
429                 if (ep_ctrl_get_stat_rx(reg) == val)
430                         return;
431                 state = val;
432                 state <<= 12;
433                 state ^= *reg;
434                 state |= USB_CTRL_CLEAR_ONLY_MASK;
435                 /* Clear the toggle bits without STAT_RX (12,13) */
436                 state &= ~0x4070;
437                 *reg = state;
438         }
439 }
440
441 /* Set DTOG_RX bit */
442 static void ep_ctrl_set_dtog_rx(reg32_t *reg, uint32_t val)
443 {
444         val = val ? (*reg ^ (1UL << 14)) : *reg;
445         /* Clear the toggle bits without DTOG_RX (14) */
446         val &= ~0x3070;
447         val |= USB_CTRL_CLEAR_ONLY_MASK;
448         *reg = val;
449 }
450
451 /* Get EP SETUP bit */
452 static uint32_t ep_ctrl_get_setup(reg32_t *reg)
453 {
454         uint32_t val = *reg & (1UL << 11);
455         return val ? 1 : 0;
456 }
457
458 /* Core endpoint I/O function */
459 static void __usb_ep_io(int EP)
460 {
461         ssize_t Count, CountHold, Offset;
462         uint32_t *pDst, *pSrc, Data;
463         stm32_UsbEp *epd = &ep_cnfg[EP];
464
465         if (UNLIKELY(epd->hw == NULL))
466         {
467                 LOG_ERR("%s: invalid endpoint (EP%d-%s)\n",
468                                 __func__,
469                                 EP >> 1,
470                                 (EP & 0x01) ? "IN" : "OUT");
471                 ASSERT(0);
472                 return;
473         }
474         if (epd->status != BEGIN_SERVICED && epd->status != NO_SERVICED)
475                 return;
476
477         if (EP & 0x01)
478         {
479                 /* EP IN */
480                 Count = epd->size - epd->offset;
481                 while (epd->avail_data)
482                 {
483                         if (!Count && !(epd->flags & STM32_USB_EP_ZERO_PACKET))
484                                 break;
485
486                         /* Set Status */
487                         epd->status = BEGIN_SERVICED;
488                         /* Get data size */
489                         if ((epd->flags & STM32_USB_EP_ZERO_PACKET) &&
490                                         (Count == epd->max_size))
491                                 epd->flags |= STM32_USB_EP_ZERO_PACKET |
492                                                 STM32_USB_EP_ZERO_POSSIBLE;
493
494                         CountHold = Count = MIN(Count, epd->max_size);
495                         if (!Count)
496                                 epd->flags |= STM32_USB_EP_ZERO_PACKET;
497                         Offset = epd->offset;
498                         epd->offset += Count;
499                         switch (epd->type)
500                         {
501                         case USB_ENDPOINT_XFER_CONTROL:
502                         case USB_ENDPOINT_XFER_INT:
503                                 pDst = (uint32_t *)USB_MEM_ADDR(EP_DTB_READ(EP >> 1, ADDR_TX_OFFSET));
504                                 break;
505                         case USB_ENDPOINT_XFER_BULK:
506                                 pDst = (uint32_t *)USB_MEM_ADDR(EP_DTB_READ(EP >> 1, ADDR_TX_OFFSET));
507                                 break;
508                         case USB_ENDPOINT_XFER_ISOC:
509                                 LOG_ERR("%s: isochronous transfer not supported\n",
510                                         __func__);
511                                 /* Fallback to default */
512                         default:
513                                 ASSERT(0);
514                                 return;
515                         }
516
517                         /* Write data to packet memory buffer */
518                         while (Count)
519                         {
520                                 Data = *(epd->write_buffer + Offset++);
521                                 if (--Count)
522                                 {
523                                         Data |= (uint32_t)(*(epd->write_buffer + Offset++)) << 8;
524                                         --Count;
525                                 }
526                                 *pDst++ = Data;
527                         }
528
529                         EP_DTB_WRITE(EP >> 1, COUNT_TX_OFFSET, CountHold);
530                         ep_ctrl_set_stat_tx(epd->hw, EP_VALID);
531
532                         --ep_cnfg[EP].avail_data;
533                         Count = epd->size - epd->offset;
534                 }
535                 if (!Count && !(epd->flags & STM32_USB_EP_ZERO_PACKET))
536                 {
537                         epd->status = COMPLETE;
538                         /* call callback function */
539                         if (epd->complete)
540                                 epd->complete(EP);
541                 }
542         }
543         else
544         {
545                 /* EP OUT */
546                 while (epd->avail_data)
547                 {
548                         /* Get data size and buffer pointer */
549                         switch (epd->type)
550                         {
551                         case USB_ENDPOINT_XFER_CONTROL:
552                         case USB_ENDPOINT_XFER_INT:
553                                 /* Get received bytes number */
554                                 Count = EP_DTB_READ(EP >> 1, COUNT_RX_OFFSET) & 0x3FF;
555                                 /* Get address of the USB packet buffer for corresponding EP */
556                                 pSrc = (uint32_t *)USB_MEM_ADDR(EP_DTB_READ(EP >> 1, ADDR_RX_OFFSET));
557                                 break;
558                         case USB_ENDPOINT_XFER_BULK:
559                                 /* Get received bytes number */
560                                 Count = EP_DTB_READ(EP >> 1, COUNT_RX_OFFSET) & 0x3FF;
561                                 /* Get address of the USB packet buffer for corresponding EP */
562                                 pSrc = (uint32_t *)USB_MEM_ADDR(EP_DTB_READ(EP >> 1, ADDR_RX_OFFSET));
563                                 break;
564                         case USB_ENDPOINT_XFER_ISOC:
565                                 LOG_ERR("%s: isochronous transfer not supported\n",
566                                         __func__);
567                                 /* Fallback to default */
568                         default:
569                                 ASSERT(0);
570                                 return;
571                         }
572
573                         if (Count > (epd->size - epd->offset))
574                         {
575                                 epd->status = BUFFER_OVERRUN;
576                                 epd->size = ep_cnfg[EP].offset;
577                                 break;
578                         }
579                         else if (Count < ep_cnfg[EP].max_size)
580                         {
581                                 epd->status = BUFFER_UNDERRUN;
582                                 epd->size = ep_cnfg[EP].offset + Count;
583                         }
584                         else
585                                 epd->status = BEGIN_SERVICED;
586
587                         Offset = epd->offset;
588                         epd->offset += Count;
589
590                         /* Read data from packet memory buffer */
591                         while (Count)
592                         {
593                                 Data = *pSrc++;
594                                 *(epd->read_buffer + Offset++) = Data;
595                                 if (--Count)
596                                 {
597                                         Data >>= 8;
598                                         *(epd->read_buffer + Offset++) = Data;
599                                         --Count;
600                                 }
601                         }
602
603                         ep_ctrl_set_stat_rx(epd->hw, EP_VALID);
604
605                         --ep_cnfg[EP].avail_data;
606
607                         if (*epd->hw & (1UL << 11))
608                         {
609                                 ep_cnfg[EP].status = SETUP_OVERWRITE;
610                                 return;
611                         }
612                         if (!(Count = (epd->size - epd->offset)))
613                         {
614                                 epd->status = COMPLETE;
615                                 break;
616                         }
617                 }
618                 if (epd->status != BEGIN_SERVICED && epd->status != NO_SERVICED)
619                 {
620                         /* call callback function */
621                         if (epd->complete)
622                                 epd->complete(EP);
623                 }
624         }
625 }
626
627 /*
628  * Return the lower value from Host expected size and size and set a flag
629  * STM32_USB_EP_ZERO_POSSIBLE when size is lower that host expected size.
630  */
631 static size_t usb_size(size_t size, size_t host_size)
632 {
633         if (size < host_size)
634         {
635                 ep_cnfg[CTRL_ENP_IN].flags |= STM32_USB_EP_ZERO_POSSIBLE;
636                 return size;
637         }
638         return host_size;
639 }
640
641 /* Configure an EP descriptor before performing a I/O operation */
642 #define USB_EP_IO(__EP, __op, __buf, __size, __complete)                \
643 ({                                                                      \
644         cpu_flags_t flags;                                              \
645         stm32_UsbIoStatus ret;                                  \
646                                                                         \
647         /* Fill EP descriptor */                                        \
648         IRQ_SAVE_DISABLE(flags);                                        \
649         if (__size < 0)                                                 \
650         {                                                               \
651                 ep_cnfg[__EP].status = NOT_READY;                       \
652                 ep_cnfg[__EP].complete = NULL;                          \
653                 ret = NOT_READY;                                        \
654                 goto out;                                               \
655         }                                                               \
656         if (ep_cnfg[__EP].status == BEGIN_SERVICED)                     \
657         {                                                               \
658                 ret = NOT_READY;                                        \
659                 goto out;                                               \
660         }                                                               \
661         /*                                                              \
662          * NOTE: the write_buffer and read_buffer are actually the      \
663          * same location in memory (it's a union).                      \
664          *                                                              \
665          * We have to do this trick to silent a build warning by        \
666          * casting the I/O buffer to (void *) or (const void *).        \
667          */                                                             \
668         ep_cnfg[__EP].__op ## _buffer = __buf;                          \
669         ep_cnfg[__EP].offset = 0;                                       \
670         ep_cnfg[__EP].size = __size;                                    \
671         ep_cnfg[__EP].complete = __complete;                            \
672         if (!size)                                                      \
673                 ep_cnfg[__EP].flags = STM32_USB_EP_ZERO_PACKET;         \
674         else                                                            \
675                 ep_cnfg[__EP].flags = 0;                                \
676         ep_cnfg[__EP].status = NO_SERVICED;                             \
677                                                                         \
678         /* Perform the I/O operation */                                 \
679         __usb_ep_io(__EP);                                              \
680                                                                         \
681         ret = ep_cnfg[__EP].status;                                     \
682 out:                                                                    \
683         IRQ_RESTORE(flags);                                             \
684         ret;                                                            \
685 })
686
687 /* Configure and endponint and perform a read operation */
688 static stm32_UsbIoStatus
689 __usb_ep_read(int ep, void *buffer, ssize_t size, void (*complete)(int))
690 {
691         if (UNLIKELY((ep >= EP_MAX_NUM) || (ep & 0x01)))
692         {
693                 LOG_ERR("%s: invalid EP number %d\n", __func__, ep);
694                 ASSERT(0);
695                 return STALLED;
696         }
697         if (UNLIKELY((size_t)buffer & 0x03))
698         {
699                 LOG_ERR("%s: unaligned buffer @ %p\n", __func__, buffer);
700                 ASSERT(0);
701                 return STALLED;
702         }
703         return USB_EP_IO(ep, read, buffer, size, complete);
704 }
705
706 /* Configure and endponint and perform a write operation */
707 static stm32_UsbIoStatus
708 __usb_ep_write(int ep, const void *buffer, ssize_t size, void (*complete)(int))
709 {
710         if (UNLIKELY((ep >= EP_MAX_NUM) || !(ep & 0x01)))
711         {
712                 LOG_ERR("%s: invalid EP number %d\n", __func__, ep);
713                 ASSERT(0);
714                 return STALLED;
715         }
716         if (UNLIKELY((size_t)buffer & 0x03))
717         {
718                 LOG_ERR("%s: unaligned buffer @ %p\n", __func__, buffer);
719                 ASSERT(0);
720                 return STALLED;
721         }
722         return USB_EP_IO(ep, write, buffer, size, complete);
723 }
724
725 static void usb_ep_low_level_config(int ep, uint16_t offset, uint16_t size)
726 {
727         stm32_UsbEp *epc = &ep_cnfg[ep];
728
729         /* IN EP */
730         if (ep & 0x01)
731         {
732                 /* Disable EP */
733                 ep_ctrl_set_stat_tx(epc->hw, EP_DISABLED);
734                 /* Clear Tx toggle */
735                 ep_ctrl_set_dtog_tx(epc->hw, 0);
736                 /* Clear Correct Transfer for transmission flag */
737                 ep_ctrl_clr_ctr_tx(epc->hw);
738
739                 /* Update EP description table */
740                 EP_DTB_WRITE(ep >> 1, ADDR_TX_OFFSET, offset);
741                 EP_DTB_WRITE(ep >> 1, COUNT_TX_OFFSET, 0);
742         }
743         /* OUT EP */
744         else
745         {
746                 uint16_t rx_count = 0;
747
748                 /* Disable EP */
749                 ep_ctrl_set_stat_rx(epc->hw, EP_DISABLED);
750                 /* Clear Rx toggle */
751                 ep_ctrl_set_dtog_rx(epc->hw, 0);
752                 /* Clear Correct Transfer for reception flag */
753                 ep_ctrl_clr_ctr_rx(epc->hw);
754                 /* Descriptor block size field */
755                 rx_count |= (size > 62) << 15;
756                 /* Descriptor number of blocks field */
757                 rx_count |= (((size > 62) ?  (size >> 5) - 1 : size >> 1) &
758                                 0x1f) << 10;
759                 /* Update EP description table */
760                 EP_DTB_WRITE(ep >> 1, ADDR_RX_OFFSET, offset);
761                 EP_DTB_WRITE(ep >> 1, COUNT_RX_OFFSET, rx_count);
762         }
763 }
764
765 /* Enable/Disable an endpoint */
766 static int usb_ep_configure(const UsbEndpointDesc *epd, bool enable)
767 {
768         int EP;
769         stm32_UsbEp *ep_hw;
770         reg32_t *hw;
771         uint16_t Offset;
772         uint32_t size;
773
774         EP = usb_ep_logical_to_hw(epd->bEndpointAddress);
775         ep_hw = &ep_cnfg[EP];
776
777         if (enable)
778         {
779                 /*
780                  * Allocate packet memory for EP buffer/s calculate actual size
781                  * only for the OUT EPs.
782                  */
783                 size = epd->wMaxPacketSize;
784                 if (!usb_alloc_buffer(&Offset, &size, EP))
785                         return -USB_MEMORY_FULL;
786
787                 /* Set EP status */
788                 ep_hw->status  = NOT_READY;
789                 /* Init EP flags */
790                 ep_hw->flags = 0;
791
792                 /* Set endpoint type */
793                 ep_hw->type = usb_endpointType(epd);
794                 /* Init EP max packet size */
795                 ep_hw->max_size = epd->wMaxPacketSize;
796
797                 if (EP & 0x01)
798                         ep_hw->avail_data = 1;
799                 else
800                         ep_hw->avail_data = 0;
801                 hw = (reg32_t *)&usb->EP0R;
802                 hw += EP >> 1;
803
804                 /* Set Ep Address */
805                 ep_ctrl_set_ea(hw, EP >> 1);
806                 ep_hw->hw = hw;
807                 LOG_INFO("%s: EP%d-%s configured\n",
808                                 __func__, EP >> 1, EP & 1 ? "IN" : "OUT");
809
810                 /* Low-level endpoint configuration */
811                 usb_ep_low_level_config(EP, Offset, size);
812
813                 /* Set EP Kind & enable */
814                 switch (ep_hw->type)
815                 {
816                 case USB_ENDPOINT_XFER_CONTROL:
817                         LOG_INFO("EP%d: CONTROL IN\n", EP >> 1);
818                         ep_ctrl_set_ep_type(hw, EP_CTRL);
819                         ep_ctrl_set_ep_kind(hw, 0);
820                         break;
821                 case USB_ENDPOINT_XFER_INT:
822                         LOG_INFO("EP%d: INTERRUPT IN\n", EP >> 1);
823                         ep_ctrl_set_ep_type(hw, EP_INTERRUPT);
824                         ep_ctrl_set_ep_kind(hw, 0);
825                         break;
826                 case USB_ENDPOINT_XFER_BULK:
827                         LOG_INFO("EP%d: BULK IN\n", EP >> 1);
828                         ep_ctrl_set_ep_type(hw, EP_BULK);
829                         ep_ctrl_set_ep_kind(hw, 0);
830                         break;
831                 case USB_ENDPOINT_XFER_ISOC:
832                         LOG_ERR("EP%d: ISOCHRONOUS IN: not supported\n", EP >> 1);
833                         /* Fallback to default */
834                 default:
835                         ASSERT(0);
836                         return -USB_NODEV_ERROR;
837                 }
838                 if (EP & 0x01)
839                 {
840                         /* Enable EP */
841                         ep_ctrl_set_stat_tx(hw, EP_NAK);
842                         /* Clear Correct Transfer for transmission flag */
843                         ep_ctrl_clr_ctr_tx(hw);
844                 }
845                 else
846                 {
847                         /* Enable EP */
848                         ep_ctrl_set_stat_rx(hw, EP_VALID);
849                 }
850         }
851         else if (ep_cnfg[EP].hw)
852         {
853                 hw = (reg32_t *)&usb->EP0R;
854                 hw += EP >> 1;
855
856                 /* IN EP */
857                 if (EP & 0x01)
858                 {
859                         /* Disable IN EP */
860                         ep_ctrl_set_stat_tx(hw, EP_DISABLED);
861                         /* Clear Correct Transfer for reception flag */
862                         ep_ctrl_clr_ctr_tx(hw);
863                 }
864                 /* OUT EP */
865                 else
866                 {
867                         /* Disable OUT EP */
868                         ep_ctrl_set_stat_rx(hw, EP_DISABLED);
869                         /* Clear Correct Transfer for reception flag */
870                         ep_ctrl_clr_ctr_rx(hw);
871                 }
872                 /* Release buffer */
873                 usb_free_buffer(EP);
874                 ep_cnfg[EP].hw = NULL;
875         }
876         return 0;
877 }
878
879 /* Get EP stall/unstall */
880 static int usb_ep_get_stall(int EP, bool *pStall)
881 {
882         if (ep_cnfg[EP].hw == NULL)
883                 return -USB_NODEV_ERROR;
884
885         *pStall = (EP & 0x01) ?
886                 (ep_ctrl_get_stat_tx(ep_cnfg[EP].hw) == EP_STALL):  /* IN EP  */
887                 (ep_ctrl_get_stat_rx(ep_cnfg[EP].hw) == EP_STALL);  /* OUT EP */
888
889         return USB_OK;
890 }
891
892 /* Set EP stall/unstall */
893 static int usb_ep_set_stall(int EP, bool Stall)
894 {
895         if (ep_cnfg[EP].hw == NULL)
896                 return -USB_NODEV_ERROR;
897
898         if (Stall)
899         {
900                 ep_cnfg[EP].status = STALLED;
901                 if (EP & 0x01)
902                 {
903                         /* IN EP */
904                         ep_ctrl_set_stat_tx(ep_cnfg[EP].hw, EP_STALL);
905                         ep_cnfg[EP].avail_data = 1;
906                 }
907                 else
908                 {
909                         /* OUT EP */
910                         ep_ctrl_set_stat_rx(ep_cnfg[EP].hw, EP_STALL);
911                         ep_cnfg[EP].avail_data = 0;
912                 }
913         }
914         else
915         {
916                 ep_cnfg[EP].status = NOT_READY;
917                 if(EP & 0x01)
918                 {
919                         /* IN EP */
920                         ep_cnfg[EP].avail_data = 1;
921                         /* reset Data Toggle bit */
922                         ep_ctrl_set_dtog_tx(ep_cnfg[EP].hw, 0);
923                         ep_ctrl_set_stat_tx(ep_cnfg[EP].hw, EP_NAK);
924                 }
925                 else
926                 {
927                         /* OUT EP */
928                         ep_cnfg[EP].avail_data = 0;
929                         /* reset Data Toggle bit */
930                         ep_ctrl_set_dtog_rx(ep_cnfg[EP].hw, 0);
931                         ep_ctrl_set_stat_rx(ep_cnfg[EP].hw, EP_VALID);
932                 }
933         }
934         return USB_OK;
935 }
936
937 /* Stall both directions of the control EP */
938 static void usb_ep_set_stall_ctrl(void)
939 {
940         ep_cnfg[CTRL_ENP_IN].avail_data = 1;
941         ep_cnfg[CTRL_ENP_IN].status = STALLED;
942         ep_cnfg[CTRL_ENP_OUT].avail_data = 0;
943         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
944
945         usb_ep_set_stall(CTRL_ENP_IN, true);
946         usb_ep_set_stall(CTRL_ENP_OUT, true);
947 }
948
949 /*
950  * Find the position of an interface descriptor inside the configuration
951  * descriptor.
952  */
953 static int usb_find_interface(uint32_t num, uint32_t alt)
954 {
955         const UsbInterfaceDesc *id;
956         int i;
957
958         for (i = 0; ; i++)
959         {
960                 /* TODO: support more than one configuration per device */
961                 id = (const UsbInterfaceDesc *)usb_dev->config[i];
962                 if (id == NULL)
963                         break;
964                 if (id->bDescriptorType != USB_DT_INTERFACE)
965                         continue;
966                 if ((id->bInterfaceNumber == num) &&
967                                 (id->bAlternateSetting == alt))
968                         return i;
969         }
970         return -USB_NODEV_ERROR;
971 }
972
973 /*
974  * Configure/deconfigure EPs of a certain interface.
975  */
976 static void
977 usb_configure_ep_interface(unsigned int num, unsigned int alt, bool enable)
978 {
979         const UsbEndpointDesc *epd;
980         int i, start;
981
982         /*
983          * Find the position of the interface descriptor (inside the
984          * configuration descriptor).
985          */
986         start = usb_find_interface(num, alt);
987         if (start < 0)
988         {
989                 LOG_ERR("%s: interface (%u,%u) not found\n",
990                         __func__, num, alt);
991                 return;
992         }
993         /*
994          * Cycle over endpoint descriptors.
995          *
996          * NOTE: the first endpoint descriptor is placed next to the interface
997          * descriptor, so we need to add +1 to the position of the interface
998          * descriptor to find it.
999          */
1000         for (i = start + 1; ; i++)
1001         {
1002                 epd = (const UsbEndpointDesc *)usb_dev->config[i];
1003                 if ((epd == NULL) || (epd->bDescriptorType == USB_DT_INTERFACE))
1004                         break;
1005                 if (epd->bDescriptorType != USB_DT_ENDPOINT)
1006                         continue;
1007                 if (UNLIKELY(usb_ep_configure(epd, enable) < 0))
1008                 {
1009                         LOG_ERR("%s: out of memory, can't initialize EP\n",
1010                                 __func__);
1011                         return;
1012                 }
1013         }
1014 }
1015
1016 /* Set device state */
1017 static void usb_set_device_state(int state)
1018 {
1019         unsigned int i;
1020
1021         LOG_INFO("%s: new state %d\n", __func__, state);
1022
1023         if (udc.state == USB_STATE_CONFIGURED)
1024         {
1025                 /* Deconfigure device */
1026                 for (i = 0; i < udc.interfaces; ++i)
1027                         usb_configure_ep_interface(i,
1028                                 udc.alt[i], false);
1029         }
1030         switch (state)
1031         {
1032         case USB_STATE_ATTACHED:
1033         case USB_STATE_POWERED:
1034         case USB_STATE_DEFAULT:
1035                 usb_set_address(0);
1036                 usb_dev->configured = false;
1037                 udc.address = udc.cfg_id = 0;
1038                 break;
1039         case USB_STATE_ADDRESS:
1040                 udc.cfg_id = 0;
1041                 break;
1042         case USB_STATE_CONFIGURED:
1043                 /* Configure device */
1044                 for (i = 0; i < udc.interfaces; ++i)
1045                         usb_configure_ep_interface(i,
1046                                 udc.alt[i], true);
1047                 break;
1048         default:
1049                 /* Unknown state: disconnected or connection in progress */
1050                 usb_dev->configured = false;
1051                 udc.address = 0;
1052                 udc.cfg_id = 0;
1053                 break;
1054         }
1055         udc.state = state;
1056 }
1057
1058 /* Setup packet: set address status phase end handler */
1059 static void usb_add_status_handler_end(UNUSED_ARG(int, EP))
1060 {
1061         uint16_t w_value;
1062
1063         w_value = usb_le16_to_cpu(setup_packet.wValue);
1064         udc.address = w_value & 0xff;
1065         usb_set_address(udc.address);
1066
1067         if (udc.address)
1068                 usb_set_device_state(USB_STATE_ADDRESS);
1069         else
1070                 usb_set_device_state(USB_STATE_DEFAULT);
1071
1072         __usb_ep_write(CTRL_ENP_IN, NULL, -1, NULL);
1073         __usb_ep_read(CTRL_ENP_OUT, NULL, -1, NULL);
1074 }
1075
1076 /* Prepare status phase */
1077 static void usb_status_phase(bool in)
1078 {
1079         if (in)
1080                 __usb_ep_write(CTRL_ENP_IN, NULL, 0, NULL);
1081 }
1082
1083 /* Setup packet: status phase end handler */
1084 static void usb_status_handler_end(UNUSED_ARG(int, EP))
1085 {
1086         __usb_ep_write(CTRL_ENP_IN, NULL, -1, NULL);
1087         __usb_ep_read(CTRL_ENP_OUT, NULL, -1, NULL);
1088 }
1089
1090 /* Address status handler */
1091 static void usb_status_handler(UNUSED_ARG(int, EP))
1092 {
1093         if (setup_packet.mRequestType & USB_DIR_IN)
1094         {
1095                 usb_status_phase(false);
1096                 ep_cnfg[CTRL_ENP_OUT].complete = usb_status_handler_end;
1097         }
1098         else
1099         {
1100                 usb_status_phase(true);
1101                 ep_cnfg[CTRL_ENP_IN].complete =
1102                         (setup_packet.bRequest == USB_REQ_SET_ADDRESS) ?
1103                                 usb_add_status_handler_end :
1104                                 usb_status_handler_end;
1105         }
1106 }
1107
1108 static void usb_endpointRead_complete(int ep)
1109 {
1110         if (UNLIKELY(ep >= EP_MAX_NUM))
1111         {
1112                 ASSERT(0);
1113                 return;
1114         }
1115         ASSERT(!(ep & 0x01));
1116
1117         event_do(&usb_event_done[ep >> 1]);
1118         rx_size = ep_cnfg[ep].size;
1119 }
1120
1121 ssize_t usb_endpointRead(int ep, void *buffer, ssize_t size)
1122 {
1123         int ep_num = usb_ep_logical_to_hw(ep);
1124         ssize_t max_size = sizeof(ep_buffer[ep_num]);
1125
1126         /* Non-blocking read for EP0 */
1127         if (ep_num == CTRL_ENP_OUT)
1128         {
1129                 size = usb_size(size, usb_le16_to_cpu(setup_packet.wLength));
1130                 if (UNLIKELY(size > max_size))
1131                 {
1132                         LOG_ERR("%s: ep_buffer exceeded, try to enlarge CONFIG_USB_BUFSIZE\n",
1133                                         __func__);
1134                         ASSERT(0);
1135                         return -USB_BUF_OVERFLOW;
1136                 }
1137                 if (!size)
1138                         usb_status_handler(ep_num);
1139                 else
1140                 {
1141                         __usb_ep_read(ep_num, ep_buffer[ep_num], size,
1142                                         usb_status_handler);
1143                         memcpy(buffer, ep_buffer[ep_num], size);
1144                 }
1145                 return size;
1146         }
1147         if (UNLIKELY(!size))
1148                 return 0;
1149         size = MIN(size, max_size);
1150         event_initGeneric(&usb_event_done[ep_num >> 1]);
1151         rx_size = 0;
1152
1153         /* Blocking read */
1154         __usb_ep_read(ep_num, ep_buffer[ep_num], size,
1155                                 usb_endpointRead_complete);
1156         event_wait(&usb_event_done[ep_num >> 1]);
1157         memcpy(buffer, ep_buffer[ep_num], rx_size);
1158
1159         return rx_size;
1160 }
1161
1162 static void usb_endpointWrite_complete(int ep)
1163 {
1164         if (UNLIKELY(ep >= EP_MAX_NUM))
1165         {
1166                 ASSERT(0);
1167                 return;
1168         }
1169         ASSERT(ep & 0x01);
1170
1171         event_do(&usb_event_done[ep >> 1]);
1172         tx_size = ep_cnfg[ep].size;
1173 }
1174
1175 ssize_t usb_endpointWrite(int ep, const void *buffer, ssize_t size)
1176 {
1177         int ep_num = usb_ep_logical_to_hw(ep);
1178         ssize_t max_size = sizeof(ep_buffer[ep_num]);
1179
1180         /* Non-blocking write for EP0 */
1181         if (ep_num == CTRL_ENP_IN)
1182         {
1183                 size = usb_size(size, usb_le16_to_cpu(setup_packet.wLength));
1184                 if (UNLIKELY(size > max_size))
1185                 {
1186                         LOG_ERR("%s: ep_buffer exceeded, try to enlarge CONFIG_USB_BUFSIZE\n",
1187                                         __func__);
1188                         ASSERT(0);
1189                         return -USB_BUF_OVERFLOW;
1190                 }
1191                 if (!size)
1192                         usb_status_handler(ep_num);
1193                 else
1194                 {
1195                         memcpy(ep_buffer[ep_num], buffer, size);
1196                         __usb_ep_write(ep_num, ep_buffer[ep_num], size,
1197                                         usb_status_handler);
1198                 }
1199                 return size;
1200         }
1201         if (UNLIKELY(!size))
1202                 return 0;
1203         size = MIN(size, max_size);
1204         event_initGeneric(&usb_event_done[ep_num >> 1]);
1205         tx_size = 0;
1206
1207         /* Blocking write */
1208         memcpy(ep_buffer[ep_num], buffer, size);
1209         __usb_ep_write(ep_num, ep_buffer[ep_num], size,
1210                                 usb_endpointWrite_complete);
1211         event_wait(&usb_event_done[ep_num >> 1]);
1212
1213         return tx_size;
1214 }
1215
1216 /* Global variable to handle the following non-blocking I/O operations */
1217 static uint32_t InData;
1218
1219 /* Get device status */
1220 static int usb_send_device_status(uint16_t index)
1221 {
1222         if (index)
1223                 return -USB_NODEV_ERROR;
1224
1225         InData = ((uint32_t)udc.feature) & 0xff;
1226         __usb_ep_write(CTRL_ENP_IN,
1227                         (uint8_t *)&InData, sizeof(uint16_t),
1228                         usb_status_handler);
1229         return 0;
1230 }
1231
1232 /* Get interface status */
1233 static int usb_send_interface_status(UNUSED_ARG(uint16_t, index))
1234 {
1235         InData = 0;
1236         __usb_ep_write(CTRL_ENP_IN,
1237                         (uint8_t *)&InData, sizeof(uint16_t),
1238                         usb_status_handler);
1239         return 0;
1240 }
1241
1242 /* Get endpoint status */
1243 static int usb_send_ep_status(uint16_t index)
1244 {
1245         if ((index & 0x7F) > 16)
1246                 return -USB_NODEV_ERROR;
1247
1248         InData = 0;
1249         usb_ep_get_stall(usb_ep_logical_to_hw(index), (bool *)&InData);
1250         __usb_ep_write(CTRL_ENP_IN,
1251                         (uint8_t *)&InData, sizeof(uint16_t),
1252                         usb_status_handler);
1253         return 0;
1254 }
1255
1256 /* USB setup packet: GET_STATUS request handler */
1257 static void usb_get_status_handler(void)
1258 {
1259         uint16_t w_value = usb_le16_to_cpu(setup_packet.wValue);
1260         uint16_t w_index = usb_le16_to_cpu(setup_packet.wIndex);
1261         uint16_t w_length = usb_le16_to_cpu(setup_packet.wLength);
1262
1263         /* GET_STATUS sanity checks */
1264         if (udc.state < USB_STATE_ADDRESS)
1265         {
1266                 LOG_WARN("%s: bad GET_STATUS request (State=%02x)\n",
1267                                 __func__, udc.state);
1268                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1269                 return;
1270         }
1271         if (w_length != 2)
1272         {
1273                 LOG_WARN("%s: bad GET_STATUS request (wLength.Word=%02x)\n",
1274                                 __func__, w_length);
1275                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1276                 return;
1277         }
1278         if (!(setup_packet.mRequestType & USB_DIR_IN))
1279         {
1280                 LOG_WARN("%s: bad GET_STATUS request (mRequestType=%02x)\n",
1281                                 __func__, setup_packet.mRequestType);
1282                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1283                 return;
1284         }
1285         if (w_value)
1286         {
1287                 LOG_WARN("%s: bad GET_STATUS request (wValue=%02x)\n",
1288                                 __func__, w_value);
1289                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1290                 return;
1291         }
1292
1293         /* Process GET_STATUS request */
1294         switch (setup_packet.mRequestType & USB_RECIP_MASK)
1295         {
1296         case USB_RECIP_DEVICE:
1297                 if (usb_send_device_status(w_index) < 0)
1298                 {
1299                         LOG_WARN("%s: GET_STATUS: invalid UsbRecipientDevice\n",
1300                                         __func__);
1301                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1302                         return;
1303                 }
1304                 LOG_INFO("%s: GET_STATUS: mRequestType=%02x (UsbRecipientDevice)\n",
1305                                 __func__, setup_packet.mRequestType);
1306                 break;
1307         case USB_RECIP_INTERFACE:
1308                 if (usb_send_interface_status(w_index) < 0)
1309                 {
1310                         LOG_WARN("%s: GET_STATUS: invalid UsbRecipientInterface\n",
1311                                         __func__);
1312                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1313                         return;
1314                 }
1315                 LOG_INFO("%s: GET_STATUS: mRequestType=%02x (UsbRecipientInterface)\n",
1316                                 __func__, setup_packet.mRequestType);
1317                 break;
1318         case USB_RECIP_ENDPOINT:
1319                 if (usb_send_ep_status(w_index) < 0)
1320                 {
1321                         LOG_WARN("%s: GET_STATUS: invalid UsbRecipientEndpoint\n",
1322                                         __func__);
1323                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1324                         return;
1325                 }
1326                 LOG_INFO("%s: GET_STATUS: mRequestType=%02x (UsbRecipientEndpoint)\n",
1327                                 __func__, setup_packet.mRequestType);
1328                 break;
1329         default:
1330                 LOG_WARN("%s: GET_STATUS: invalid UsbRecipientEndpoint\n",
1331                                 __func__);
1332                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1333                 break;
1334         }
1335 }
1336
1337 static int usb_get_device_descriptor(int id)
1338 {
1339         if (id)
1340                 return -USB_NODEV_ERROR;
1341
1342         usb_dev->device->bMaxPacketSize0 = USB_EP0_MAX_SIZE;
1343         __usb_ep_write(CTRL_ENP_IN, (const uint8_t *)usb_dev->device,
1344                         usb_size(usb_dev->device->bLength,
1345                                 usb_le16_to_cpu(setup_packet.wLength)),
1346                         usb_status_handler);
1347         return 0;
1348 }
1349
1350 /*
1351  * TODO: refactor this part to remove this temporary buffer.
1352  *
1353  * It would be better to define all the USB descriptors in the right order and
1354  * send them as a contiguous buffer directly from the flash / rodata memory.
1355  */
1356 #define USB_BUFSIZE (128)
1357 static uint8_t usb_cfg_buffer[USB_BUFSIZE];
1358 STATIC_ASSERT(USB_BUFSIZE < (1 << (sizeof(uint16_t) * 8)));
1359
1360 static int usb_get_configuration_descriptor(int id)
1361 {
1362         const UsbConfigDesc **config =
1363                         (const UsbConfigDesc **)usb_dev->config;
1364         uint8_t *p = usb_cfg_buffer;
1365         int i;
1366
1367         /* TODO: support more than one configuration per device */
1368         if (UNLIKELY(id > 0))
1369                 return -USB_NODEV_ERROR;
1370
1371         for (i = 0; config[i]; i++)
1372         {
1373                 memcpy(p, config[i], config[i]->bLength);
1374                 p += config[i]->bLength;
1375
1376                 if (UNLIKELY((p - usb_cfg_buffer) > USB_BUFSIZE))
1377                 {
1378                         ASSERT(0);
1379                         return -USB_BUF_OVERFLOW;
1380                 }
1381         }
1382         ((UsbConfigDesc *)usb_cfg_buffer)->wTotalLength =
1383                         usb_cpu_to_le16((uint16_t)(p - usb_cfg_buffer));
1384         __usb_ep_write(CTRL_ENP_IN,
1385                         usb_cfg_buffer,
1386                         usb_size(p - usb_cfg_buffer,
1387                                 usb_le16_to_cpu(setup_packet.wLength)),
1388                         usb_status_handler);
1389         return 0;
1390 }
1391
1392 static int usb_get_string_descriptor(unsigned int id)
1393 {
1394         const UsbStringDesc *lang_str;
1395         unsigned int lang_id, str_id;
1396         uint16_t w_index_lo = usb_le16_to_cpu(setup_packet.wIndex) & 0x00ff;
1397         uint16_t w_index_hi = (usb_le16_to_cpu(setup_packet.wIndex) &
1398                                                 0xff00) >> 8;
1399
1400         ASSERT(usb_dev->strings != NULL);
1401         ASSERT(usb_dev->strings[0] != NULL);
1402
1403         lang_str = usb_dev->strings[0];
1404         if (id)
1405         {
1406                 /* Find Language index */
1407                 for (lang_id = 0; ; lang_id++)
1408                 {
1409                         const UsbStringDesc *str =
1410                                                 usb_dev->strings[lang_id];
1411                         if (UNLIKELY(str == NULL))
1412                                 return -USB_NODEV_ERROR;
1413                         if ((str->data[0] == w_index_lo) &&
1414                                         (str->data[1] == w_index_hi))
1415                                 break;
1416                 }
1417                 /* Check buffer overflow to find string index */
1418                 for (str_id = 0; str_id < id; str_id++)
1419                 {
1420                         lang_str = usb_dev->strings[lang_id + 1 + str_id];
1421                         if (lang_str == NULL)
1422                                 return -USB_NODEV_ERROR;
1423                 }
1424         }
1425         __usb_ep_write(CTRL_ENP_IN,
1426                         lang_str,
1427                         usb_size(lang_str->bLength,
1428                                 usb_le16_to_cpu(setup_packet.wLength)),
1429                         usb_status_handler);
1430         return 0;
1431 }
1432
1433 static void usb_get_descriptor(void)
1434 {
1435         uint16_t w_value_lo = usb_le16_to_cpu(setup_packet.wValue) & 0x00ff;
1436         uint16_t w_value_hi = (usb_le16_to_cpu(setup_packet.wValue) & 0xff00) >> 8;
1437
1438         if (udc.state < USB_STATE_DEFAULT)
1439         {
1440                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1441                 return;
1442         }
1443         switch (w_value_hi)
1444         {
1445         case USB_DT_DEVICE:
1446                 LOG_INFO("%s: GET_DEVICE_DESCRIPTOR: id=%d, state=%d\n",
1447                                 __func__,
1448                                 w_value_lo,
1449                                 udc.state);
1450                 if (usb_get_device_descriptor(w_value_lo) < 0)
1451                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1452                 break;
1453         case USB_DT_CONFIG:
1454                 LOG_INFO("%s: GET_CONFIG_DESCRIPTOR: id=%d, state=%d\n",
1455                                 __func__, w_value_lo, udc.state);
1456                 if (usb_get_configuration_descriptor(w_value_lo) < 0)
1457                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1458                 break;
1459         case USB_DT_STRING:
1460                 LOG_INFO("%s: GET_STRING_DESCRIPTOR: id=%d, state=%d\n",
1461                                 __func__, w_value_lo, udc.state);
1462                 if (usb_get_string_descriptor(w_value_lo) < 0)
1463                         ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1464                 break;
1465         default:
1466                 LOG_WARN("%s: GET_UNKNOWN_DESCRIPTOR: id=%d, state=%d\n",
1467                                 __func__, w_value_lo, udc.state);
1468                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1469                 break;
1470         }
1471 }
1472
1473 /* USB setup packet: class/vendor request handler */
1474 static void usb_event_handler(UsbDevice *dev)
1475 {
1476         /*
1477          * TODO: get the appropriate usb_dev in function of the endpoint
1478          * address.
1479          */
1480         if (dev->event_cb)
1481                 dev->event_cb(&setup_packet);
1482 }
1483
1484 /* USB setup packet: GET_DESCRIPTOR handler */
1485 static void usb_get_descriptor_handler(void)
1486 {
1487         LOG_INFO("%s: GET_DESCRIPTOR: RECIP = %d\n",
1488                         __func__,
1489                         setup_packet.mRequestType & USB_RECIP_MASK);
1490         if ((setup_packet.mRequestType & USB_RECIP_MASK) ==
1491                         USB_RECIP_DEVICE)
1492                 usb_get_descriptor();
1493         /* Getting descriptor for a device is a standard request */
1494         else if ((setup_packet.mRequestType & USB_DIR_MASK) == USB_DIR_IN)
1495                 usb_event_handler(usb_dev);
1496         else
1497                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1498 }
1499
1500 /* USB setup packet: SET_ADDRESS handler */
1501 static void usb_set_address_handler(void)
1502 {
1503         uint16_t w_value = usb_le16_to_cpu(setup_packet.wValue);
1504         uint16_t w_index = usb_le16_to_cpu(setup_packet.wIndex);
1505         uint16_t w_length = usb_le16_to_cpu(setup_packet.wLength);
1506
1507         LOG_INFO("%s: SET_ADDRESS: %d\n",
1508                         __func__, usb_le16_to_cpu(setup_packet.wValue));
1509         if ((udc.state >= USB_STATE_DEFAULT) &&
1510                         ((setup_packet.mRequestType & USB_RECIP_MASK) ==
1511                                         USB_RECIP_DEVICE) &&
1512                         (w_index == 0) && (w_length == 0) && (w_value < 128))
1513                 usb_status_handler(CTRL_ENP_IN);
1514         else
1515                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1516 }
1517
1518 /* USB setup packet: GET_CONFIGURATION handler */
1519 static void usb_get_config_handler(void)
1520 {
1521         uint16_t w_value = usb_le16_to_cpu(setup_packet.wValue);
1522         uint16_t w_index = usb_le16_to_cpu(setup_packet.wIndex);
1523
1524         LOG_INFO("%s: GET_CONFIGURATION\n", __func__);
1525         if ((udc.state >= USB_STATE_ADDRESS) &&
1526                         (w_value == 0) && (w_index == 0) && (w_value == 1))
1527         {
1528                 InData = udc.cfg_id;
1529                 __usb_ep_write(CTRL_ENP_IN, (uint8_t *)&InData, 1, usb_status_handler);
1530         }
1531         else
1532                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1533 }
1534
1535 static const UsbConfigDesc *usb_find_configuration(int num)
1536 {
1537         const UsbConfigDesc *cfg;
1538         int i;
1539
1540         for (i = 0; ; i++)
1541         {
1542                 cfg = (const UsbConfigDesc *)usb_dev->config[i];
1543                 if (cfg == NULL)
1544                         break;
1545                 if (cfg->bDescriptorType != USB_DT_CONFIG)
1546                         continue;
1547                 if (cfg->bConfigurationValue == num)
1548                         return cfg;
1549         }
1550         return NULL;
1551 }
1552
1553 static int usb_set_config_state(uint32_t conf)
1554 {
1555         const UsbConfigDesc *pCnfg;
1556         unsigned int i;
1557
1558         if (conf)
1559         {
1560                 /* Find configuration descriptor */
1561                 pCnfg = usb_find_configuration(conf);
1562                 if (pCnfg == NULL)
1563                         return -USB_NODEV_ERROR;
1564
1565                 /* Reset current configuration */
1566                 usb_set_device_state(USB_STATE_ADDRESS);
1567                 usb_dev->configured = false;
1568                 udc.cfg = pCnfg;
1569
1570                 /* Set Interface and Alternative Setting */
1571                 udc.cfg_id = conf;
1572                 /* Set self-powered state */
1573                 if (pCnfg->bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1574                         udc.feature |= STM32_UDC_FEATURE_SELFPOWERED;
1575
1576                 /* Configure all existing interfaces to alternative setting 0 */
1577                 ASSERT(pCnfg->bNumInterfaces <= USB_MAX_INTERFACE);
1578                 udc.interfaces = pCnfg->bNumInterfaces;
1579                 for (i = 0; i < udc.interfaces; i++)
1580                         udc.alt[i] = 0;
1581                 usb_set_device_state(USB_STATE_CONFIGURED);
1582                 usb_dev->configured = true;
1583                 event_do(&usb_event_done[0]);
1584                 LOG_INFO("%s: device configured\n", __func__);
1585         }
1586         else
1587         {
1588                 usb_dev->configured = false;
1589                 usb_set_device_state(USB_STATE_ADDRESS);
1590         }
1591         return 0;
1592 }
1593
1594 /* USB setup packet: SET_CONFIGURATION handler */
1595 static void usb_set_config_handler(void)
1596 {
1597         uint16_t w_value = usb_le16_to_cpu(setup_packet.wValue);
1598         uint16_t w_index = usb_le16_to_cpu(setup_packet.wIndex);
1599         uint16_t w_length = usb_le16_to_cpu(setup_packet.wLength);
1600
1601         LOG_INFO("%s: SET_CONFIGURATION: %d\n",
1602                         __func__, w_value);
1603         if ((udc.state >= USB_STATE_ADDRESS) &&
1604                         (w_index == 0) && (w_length == 0) &&
1605                         (usb_set_config_state(w_value & 0xff) == 0))
1606                 usb_status_handler(CTRL_ENP_OUT);
1607         else
1608                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1609 }
1610
1611 /* USB setup packet: standard request handler */
1612 static void usb_standard_request_handler(void)
1613 {
1614         switch (setup_packet.bRequest)
1615         {
1616         case USB_REQ_GET_STATUS:
1617                 usb_get_status_handler();
1618                 break;
1619         case USB_REQ_CLEAR_FEATURE:
1620                 LOG_INFO("%s: bRequest=%d (CLEAR_FEATURE)\n",
1621                                 __func__, setup_packet.bRequest);
1622                 break;
1623         case USB_REQ_SET_FEATURE:
1624                 LOG_INFO("%s: bRequest=%d (SET_FEATURE)\n",
1625                                 __func__, setup_packet.bRequest);
1626                 break;
1627         case USB_REQ_SET_ADDRESS:
1628                 usb_set_address_handler();
1629                 break;
1630         case USB_REQ_GET_DESCRIPTOR:
1631                 usb_get_descriptor_handler();
1632                 break;
1633         case USB_REQ_SET_DESCRIPTOR:
1634                 LOG_INFO("%s: bRequest=%d (SET_DESCRIPTOR)\n",
1635                                 __func__, setup_packet.bRequest);
1636                 break;
1637         case USB_REQ_GET_CONFIGURATION:
1638                 usb_get_config_handler();
1639                 break;
1640         case USB_REQ_SET_CONFIGURATION:
1641                 usb_set_config_handler();
1642                 break;
1643         case USB_REQ_GET_INTERFACE:
1644                 LOG_INFO("%s: bRequest=%d (GET_INTERFACE)\n",
1645                                 __func__, setup_packet.bRequest);
1646                 break;
1647         case USB_REQ_SET_INTERFACE:
1648                 LOG_INFO("%s: bRequest=%d (SET_INTERFACE)\n",
1649                                 __func__, setup_packet.bRequest);
1650                 break;
1651         case USB_REQ_SYNCH_FRAME:
1652                 LOG_INFO("%s: bRequest=%d (SYNCH_FRAME)\n",
1653                                 __func__, setup_packet.bRequest);
1654                 break;
1655         default:
1656                 LOG_WARN("%s: bRequest=%d (Unknown)\n",
1657                                 __func__, setup_packet.bRequest);
1658                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1659                 break;
1660         }
1661 }
1662
1663 /* USB setup packet handler */
1664 static void usb_setup_handler(void)
1665 {
1666         switch (setup_packet.mRequestType & USB_TYPE_MASK)
1667         {
1668         /* Standard */
1669         case USB_TYPE_STANDARD:
1670                 LOG_INFO("%s: bmRequestType=%02x (Standard)\n",
1671                                 __func__, setup_packet.mRequestType);
1672                 usb_standard_request_handler();
1673                 break;
1674         /* Class */
1675         case USB_TYPE_CLASS:
1676                 LOG_INFO("%s: bmRequestType=%02x (Class)\n",
1677                                 __func__, setup_packet.mRequestType);
1678                 usb_event_handler(usb_dev);
1679                 break;
1680         /* Vendor */
1681         case USB_TYPE_VENDOR:
1682                 LOG_INFO("%s: bmRequestType=%02x (Vendor)\n",
1683                                 __func__, setup_packet.mRequestType);
1684                 usb_event_handler(usb_dev);
1685                 break;
1686         case USB_TYPE_RESERVED:
1687                 LOG_INFO("%s: bmRequestType=%02x (Reserved)\n",
1688                                 __func__, setup_packet.mRequestType);
1689                 break;
1690         /* Other */
1691         default:
1692                 LOG_WARN("%s: bmRequestType=%02x (Unknown)\n",
1693                                 __func__, setup_packet.mRequestType);
1694                 ep_cnfg[CTRL_ENP_OUT].status = STALLED;
1695                 break;
1696         }
1697 }
1698
1699 /* USB: low-level hardware initialization */
1700 static void usb_hw_reset(void)
1701 {
1702         unsigned int i;
1703         int ret;
1704
1705         /* Initialize endpoint descriptors */
1706         for (i = 0; i < countof(ep_cnfg); i++)
1707                 ep_cnfg[i].hw = NULL;
1708
1709         /* Initialize USB memory */
1710         for (i = 0; i < countof(memory_buffer); i++)
1711                 memory_buffer[i].Size = 0;
1712         usb->BTABLE = USB_BDT_OFFSET;
1713         mem_use = NULL;
1714
1715         /* Endpoint initialization */
1716         ret = usb_ep_configure(&USB_CtrlEpDescr0, true);
1717         if (UNLIKELY(ret < 0))
1718         {
1719                 LOG_WARN("%s: out of memory, cannot initialize EP0\n",
1720                                 __func__);
1721                 return;
1722         }
1723         ret = usb_ep_configure(&USB_CtrlEpDescr1, true);
1724         if (UNLIKELY(ret < 0))
1725         {
1726                 LOG_WARN("%s: out of memory, cannot initialize EP1\n",
1727                                 __func__);
1728                 return;
1729         }
1730
1731         /* Set default address */
1732         usb_set_address(0);
1733
1734         /* Enable all the device interrupts */
1735         usb->CNTR = bmCTRM | bmRESETM | bmSOFM | bmERRM | bmPMAOVRM |
1736                         bmSUSPM | bmWKUPM;
1737 }
1738
1739 /* Handle a correct transfer under ISR */
1740 static void usb_isr_correct_transfer(stm32_usb_irq_status_t interrupt)
1741 {
1742         int EP;
1743         reg32_t *pReg = (reg32_t *)&usb->EP0R;
1744
1745         /* Find corresponding EP */
1746         pReg += interrupt.EP_ID;
1747         EP = (int)(((*pReg & 0x0f) << 1) + (interrupt.DIR ? 0 : 1));
1748         ep_cnfg[EP].avail_data = 1;
1749
1750         ASSERT(ep_cnfg[EP].hw);
1751         /* IN EP */
1752         if (EP & 0x01)
1753                 ep_ctrl_clr_ctr_tx(ep_cnfg[EP].hw);
1754         else
1755                 ep_ctrl_clr_ctr_rx(ep_cnfg[EP].hw);
1756         if (EP == CTRL_ENP_OUT)
1757         {
1758                 /* Determinate type of packet (only for control EP) */
1759                 bool SetupPacket = ep_ctrl_get_setup(ep_cnfg[CTRL_ENP_OUT].hw);
1760
1761                 if (SetupPacket)
1762                 {
1763                         ep_cnfg[CTRL_ENP_IN].avail_data = 1;
1764                         /* init IO to receive Setup packet */
1765                         __usb_ep_write(CTRL_ENP_IN, NULL, -1, NULL);
1766                         __usb_ep_read(CTRL_ENP_OUT, &setup_packet,
1767                                         sizeof(setup_packet), NULL);
1768
1769                         /* reset EP IO ctrl */
1770                         if (setup_packet.mRequestType & USB_DIR_IN)
1771                                 usb_status_handler(CTRL_ENP_OUT);
1772                         usb_setup_handler();
1773                         if (ep_cnfg[CTRL_ENP_OUT].status == STALLED)
1774                                 usb_ep_set_stall_ctrl();
1775                 }
1776                 else
1777                 {
1778                         if (ep_cnfg[CTRL_ENP_OUT].complete &&
1779                                         setup_packet.mRequestType & USB_DIR_IN)
1780                                 ep_cnfg[CTRL_ENP_OUT].complete(CTRL_ENP_OUT);
1781                         else
1782                                 __usb_ep_io(EP);
1783                 }
1784         }
1785         else if (EP == CTRL_ENP_IN)
1786         {
1787                 if (ep_cnfg[CTRL_ENP_IN].complete &&
1788                                 !(setup_packet.mRequestType & USB_DIR_IN))
1789                         ep_cnfg[CTRL_ENP_IN].complete(CTRL_ENP_IN);
1790                 else
1791                         __usb_ep_io(EP);
1792
1793         }
1794         else
1795                 __usb_ep_io(EP);
1796 }
1797
1798 /* USB: interrupt service routine */
1799 static void usb_isr(void)
1800 {
1801         stm32_usb_irq_status_t interrupt;
1802
1803         /* Get masked interrupt flags */
1804         interrupt.status = usb->ISTR;
1805         interrupt.status &= usb->CNTR | 0x1f;
1806
1807         if (interrupt.PMAOVR)
1808         {
1809                 LOG_WARN("%s: DMA overrun / underrun\n", __func__);
1810                 usb->ISTR = ~bmPMAOVRM;
1811         }
1812         if (interrupt.ERR)
1813         {
1814                 LOG_WARN("%s: engine error\n", __func__);
1815                 usb->ISTR = ~bmERRM;
1816         }
1817         if (interrupt.RESET)
1818         {
1819                 LOG_INFO("%s: device reset\n", __func__);
1820                 usb->ISTR = ~bmRESETM;
1821                 usb_hw_reset();
1822                 usb_set_device_state(USB_STATE_DEFAULT);
1823         }
1824         if (interrupt.SOF)
1825         {
1826 #if 0
1827                 /*
1828                  * XXX: disable logging of frame interrupts (too much noise!)
1829                  */
1830                 uint16_t frame_nr = usb->FNR & 0x0fff;
1831                 LOG_INFO("%s: frame %#x\n", __func__, frame_nr);
1832 #endif
1833                 usb->ISTR = ~bmSOFM;
1834         }
1835         if (interrupt.WKUP)
1836         {
1837                 LOG_INFO("%s: wake-up\n", __func__);
1838                 usb->ISTR = ~(bmSUSPM | bmWKUPM);
1839                 usb_resume();
1840         }
1841         if (interrupt.SUSP)
1842         {
1843                 LOG_INFO("%s: suspend\n", __func__);
1844                 usb_suspend();
1845                 usb->ISTR = ~(bmSUSPM | bmWKUPM);
1846         }
1847         if (interrupt.ESOF)
1848         {
1849                 LOG_INFO("%s: expected frame\n", __func__);
1850                 usb->ISTR = ~bmESOFM;
1851         }
1852         if (interrupt.CTR)
1853         {
1854                 usb_isr_correct_transfer(interrupt);
1855         }
1856 }
1857
1858 /* USB: hardware initialization */
1859 static void usb_hw_init(void)
1860 {
1861         /* Enable clocking on the required GPIO pins */
1862         RCC->APB2ENR |= RCC_APB2_GPIOA | RCC_APB2_GPIOC;
1863
1864         /* Make sure that the CAN controller is disabled and held in reset */
1865         RCC->APB1ENR &= ~RCC_APB1_CAN;
1866
1867         /* Configure USB_DM and USB_DP to work as USB lines */
1868         stm32_gpioPinConfig((struct stm32_gpio *)GPIOA_BASE,
1869                         USB_DM_PIN | USB_DP_PIN,
1870                         GPIO_MODE_AF_PP, GPIO_SPEED_50MHZ);
1871         /* Configure USB_DISC to work as USB disconnect */
1872         stm32_gpioPinConfig((struct stm32_gpio *)GPIOC_BASE,
1873                         USB_DISC_PIN,
1874                         GPIO_MODE_OUT_PP, GPIO_SPEED_50MHZ);
1875         stm32_gpioPinWrite((struct stm32_gpio *)GPIOC_BASE,
1876                                 USB_DISC_PIN, 1);
1877
1878         /* Ensure the USB clock is disabled before setting the prescaler */
1879         RCC->APB1ENR &= ~RCC_APB1_USB;
1880
1881         /* Configure USB clock (48MHz) */
1882         *CFGR_USBPRE_BB &= ~RCC_USBCLK_PLLCLK_1DIV5;
1883
1884         /* Activate USB clock */
1885         RCC->APB1ENR |= RCC_APB1_USB;
1886
1887         /* Force USB reset and disable USB interrupts */
1888         usb->CNTR = bmFRES;
1889         timer_delayHp(1);
1890
1891         /* Issue a USB reset */
1892         usb_hw_reset();
1893
1894         /* Clear spurious pending interrupt */
1895         usb->ISTR = 0;
1896
1897         /* Register interrupt handler */
1898         sysirq_setHandler(USB_LP_CAN_RX0_IRQHANDLER, usb_isr);
1899
1900         /* Software connection enable */
1901         usb_connect();
1902 }
1903
1904 /* Initialize the USB controller */
1905 static void usb_init(void)
1906 {
1907         udc.state = USB_STATE_NOTATTACHED;
1908         udc.feature = 0;
1909
1910         usb_hw_init();
1911 }
1912
1913 /* Register an upper layer USB device into the driver */
1914 int usb_deviceRegister(UsbDevice *dev)
1915 {
1916 #if CONFIG_KERN
1917         MOD_CHECK(proc);
1918 #endif
1919         usb_dev = dev;
1920         usb_dev->configured = false;
1921
1922         event_initGeneric(&usb_event_done[0]);
1923         usb_init();
1924         event_wait(&usb_event_done[0]);
1925
1926         return 0;
1927 }