1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
|
/************************************************************************************
* arch/arm/src/lpc17xx/lpc17_usb.h
*
* Copyright (C) 2010 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************************/
#ifndef __ARCH_ARM_SRC_LPC17XX_LPC17_USB_H
#define __ARCH_ARM_SRC_LPC17XX_LPC17_USB_H
/************************************************************************************
* Included Files
************************************************************************************/
#include <nuttx/config.h>
#include <nuttx/usb/ohci.h>
#include "chip.h"
#include "lpc17_memorymap.h"
/************************************************************************************
* Pre-processor Definitions
************************************************************************************/
/* Register offsets *****************************************************************/
/* USB Host Controller (OHCI) *******************************************************/
/* See include/nuttx/usb/ohci.h */
#define LPC17_USBHOST_MODID_OFFSET 0x00fc /* Module ID/Revision ID */
/* USB OTG Controller ***************************************************************/
/* OTG registers */
#define LPC17_USBOTG_INTST_OFFSET 0x0100 /* OTG Interrupt Status */
#define LPC17_USBOTG_INTEN_OFFSET 0x0104 /* OTG Interrupt Enable */
#define LPC17_USBOTG_INTSET_OFFSET 0x0108 /* OTG Interrupt Set */
#define LPC17_USBOTG_INTCLR_OFFSET 0x010c /* OTG Interrupt Clear */
#define LPC17_USBOTG_STCTRL_OFFSET 0x0110 /* OTG Status and Control */
#define LPC17_USBOTG_TMR_OFFSET 0x0114 /* OTG Timer */
/* USB Device Controller ************************************************************/
/* Device interrupt registers. See also SYSCON_USBINTST in lpc17_syscon.h */
#define LPC17_USBDEV_INTST_OFFSET 0x0200 /* USB Device Interrupt Status */
#define LPC17_USBDEV_INTEN_OFFSET 0x0204 /* USB Device Interrupt Enable */
#define LPC17_USBDEV_INTCLR_OFFSET 0x0208 /* USB Device Interrupt Clear */
#define LPC17_USBDEV_INTSET_OFFSET 0x020c /* USB Device Interrupt Set */
/* SIE Command registers */
#define LPC17_USBDEV_CMDCODE_OFFSET 0x0210 /* USB Command Code */
#define LPC17_USBDEV_CMDDATA_OFFSET 0x0214 /* USB Command Data */
/* USB transfer registers */
#define LPC17_USBDEV_RXDATA_OFFSET 0x0218 /* USB Receive Data */
#define LPC17_USBDEV_RXPLEN_OFFSET 0x0220 /* USB Receive Packet Length */
#define LPC17_USBDEV_TXDATA_OFFSET 0x021c /* USB Transmit Data */
#define LPC17_USBDEV_TXPLEN_OFFSET 0x0224 /* USB Transmit Packet Length */
#define LPC17_USBDEV_CTRL_OFFSET 0x0228 /* USB Control */
/* More Device interrupt registers */
#define LPC17_USBDEV_INTPRI_OFFSET 0x022c /* USB Device Interrupt Priority */
/* Endpoint interrupt registers */
#define LPC17_USBDEV_EPINTST_OFFSET 0x0230 /* USB Endpoint Interrupt Status */
#define LPC17_USBDEV_EPINTEN_OFFSET 0x0234 /* USB Endpoint Interrupt Enable */
#define LPC17_USBDEV_EPINTCLR_OFFSET 0x0238 /* USB Endpoint Interrupt Clear */
#define LPC17_USBDEV_EPINTSET_OFFSET 0x023c /* USB Endpoint Interrupt Set */
#define LPC17_USBDEV_EPINTPRI_OFFSET 0x0240 /* USB Endpoint Priority */
/* Endpoint realization registers */
#define LPC17_USBDEV_REEP_OFFSET 0x0244 /* USB Realize Endpoint */
#define LPC17_USBDEV_EPIND_OFFSET 0x0248 /* USB Endpoint Index */
#define LPC17_USBDEV_MAXPSIZE_OFFSET 0x024c /* USB MaxPacketSize */
/* DMA registers */
#define LPC17_USBDEV_DMARST_OFFSET 0x0250 /* USB DMA Request Status */
#define LPC17_USBDEV_DMARCLR_OFFSET 0x0254 /* USB DMA Request Clear */
#define LPC17_USBDEV_DMARSET_OFFSET 0x0258 /* USB DMA Request Set */
#define LPC17_USBDEV_UDCAH_OFFSET 0x0280 /* USB UDCA Head */
#define LPC17_USBDEV_EPDMAST_OFFSET 0x0284 /* USB Endpoint DMA Status */
#define LPC17_USBDEV_EPDMAEN_OFFSET 0x0288 /* USB Endpoint DMA Enable */
#define LPC17_USBDEV_EPDMADIS_OFFSET 0x028c /* USB Endpoint DMA Disable */
#define LPC17_USBDEV_DMAINTST_OFFSET 0x0290 /* USB DMA Interrupt Status */
#define LPC17_USBDEV_DMAINTEN_OFFSET 0x0294 /* USB DMA Interrupt Enable */
#define LPC17_USBDEV_EOTINTST_OFFSET 0x02a0 /* USB End of Transfer Interrupt Status */
#define LPC17_USBDEV_EOTINTCLR_OFFSET 0x02a4 /* USB End of Transfer Interrupt Clear */
#define LPC17_USBDEV_EOTINTSET_OFFSET 0x02a8 /* USB End of Transfer Interrupt Set */
#define LPC17_USBDEV_NDDRINTST_OFFSET 0x02ac /* USB New DD Request Interrupt Status */
#define LPC17_USBDEV_NDDRINTCLR_OFFSET 0x02b0 /* USB New DD Request Interrupt Clear */
#define LPC17_USBDEV_NDDRINTSET_OFFSET 0x02b4 /* USB New DD Request Interrupt Set */
#define LPC17_USBDEV_SYSERRINTST_OFFSET 0x02b8 /* USB System Error Interrupt Status */
#define LPC17_USBDEV_SYSERRINTCLR_OFFSET 0x02bc /* USB System Error Interrupt Clear */
#define LPC17_USBDEV_SYSERRINTSET_OFFSET 0x02c0 /* USB System Error Interrupt Set */
/* OTG I2C registers ****************************************************************/
#define LPC17_OTGI2C_RX_OFFSET 0x0300 /* I2C Receive */
#define LPC17_OTGI2C_TX_OFFSET 0x0300 /* I2C Transmit */
#define LPC17_OTGI2C_STS_OFFSET 0x0304 /* I2C Status */
#define LPC17_OTGI2C_CTL_OFFSET 0x0308 /* I2C Control */
#define LPC17_OTGI2C_CLKHI_OFFSET 0x030c /* I2C Clock High */
#define LPC17_OTGI2C_CLKLO_OFFSET 0x0310 /* I2C Clock Low */
/* Clock control registers ***********************************************************/
#define LPC17_USBOTG_CLKCTRL_OFFSET 0x0ff4 /* OTG clock controller */
#define LPC17_USBOTG_CLKST_OFFSET 0x0ff8 /* OTG clock status */
#define LPC17_USBDEV_CLKCTRL_OFFSET 0x0ff4 /* USB Clock Control */
#define LPC17_USBDEV_CLKST_OFFSET 0x0ff8 /* USB Clock Status */
/* Register addresses ***************************************************************/
/* USB Host Controller (OHCI) *******************************************************/
/* Control and status registers (section 7.1) */
#define LPC17_USBHOST_HCIREV (LPC17_USB_BASE+OHCI_HCIREV_OFFSET)
#define LPC17_USBHOST_CTRL (LPC17_USB_BASE+OHCI_CTRL_OFFSET)
#define LPC17_USBHOST_CMDST (LPC17_USB_BASE+OHCI_CMDST_OFFSET)
#define LPC17_USBHOST_INTST (LPC17_USB_BASE+OHCI_INTST_OFFSET)
#define LPC17_USBHOST_INTEN (LPC17_USB_BASE+OHCI_INTEN_OFFSET)
#define LPC17_USBHOST_INTDIS (LPC17_USB_BASE+OHCI_INTDIS_OFFSET)
/* Memory pointers (section 7.2) */
#define LPC17_USBHOST_HCCA (LPC17_USB_BASE+OHCI_HCCA_OFFSET)
#define LPC17_USBHOST_PERED (LPC17_USB_BASE+OHCI_PERED_OFFSET)
#define LPC17_USBHOST_CTRLHEADED (LPC17_USB_BASE+OHCI_CTRLHEADED_OFFSET)
#define LPC17_USBHOST_CTRLED (LPC17_USB_BASE+OHCI_CTRLED_OFFSET)
#define LPC17_USBHOST_BULKHEADED (LPC17_USB_BASE+OHCI_BULKHEADED_OFFSET)
#define LPC17_USBHOST_BULKED (LPC17_USB_BASE+OHCI_BULKED_OFFSET)
#define LPC17_USBHOST_DONEHEAD (LPC17_USB_BASE+OHCI_DONEHEAD_OFFSET)
/* Frame counters (section 7.3) */
#define LPC17_USBHOST_FMINT (LPC17_USB_BASE+OHCI_FMINT_OFFSET)
#define LPC17_USBHOST_FMREM (LPC17_USB_BASE+OHCI_FMREM_OFFSET)
#define LPC17_USBHOST_FMNO (LPC17_USB_BASE+OHCI_FMNO_OFFSET)
#define LPC17_USBHOST_PERSTART (LPC17_USB_BASE+OHCI_PERSTART_OFFSET)
/* Root hub ports (section 7.4) */
#define LPC17_USBHOST_LSTHRES (LPC17_USB_BASE+OHCI_LSTHRES_OFFSET)
#define LPC17_USBHOST_RHDESCA (LPC17_USB_BASE+OHCI_RHDESCA_OFFSET)
#define LPC17_USBHOST_RHDESCB (LPC17_USB_BASE+OHCI_RHDESCB_OFFSET)
#define LPC17_USBHOST_RHSTATUS (LPC17_USB_BASE+OHCI_RHSTATUS_OFFSET)
#define LPC17_USBHOST_RHPORTST1 (LPC17_USB_BASE+OHCI_RHPORTST1_OFFSET)
#define LPC17_USBHOST_RHPORTST2 (LPC17_USB_BASE+OHCI_RHPORTST2_OFFSET)
#define LPC17_USBHOST_MODID (LPC17_USB_BASE+LPC17_USBHOST_MODID_OFFSET)
/* USB OTG Controller ***************************************************************/
/* OTG registers */
#define LPC17_USBOTG_INTST (LPC17_USB_BASE+LPC17_USBOTG_INTST_OFFSET)
#define LPC17_USBOTG_INTEN (LPC17_USB_BASE+LPC17_USBOTG_INTEN_OFFSET)
#define LPC17_USBOTG_INTSET (LPC17_USB_BASE+LPC17_USBOTG_INTSET_OFFSET)
#define LPC17_USBOTG_INTCLR (LPC17_USB_BASE+LPC17_USBOTG_INTCLR_OFFSET)
#define LPC17_USBOTG_STCTRL (LPC17_USB_BASE+LPC17_USBOTG_STCTRL_OFFSET)
#define LPC17_USBOTG_TMR (LPC17_USB_BASE+LPC17_USBOTG_TMR_OFFSET)
/* USB Device Controller ************************************************************/
/* Device interrupt registers. See also SYSCON_USBINTST in lpc17_syscon.h */
#define LPC17_USBDEV_INTST (LPC17_USB_BASE+LPC17_USBDEV_INTST_OFFSET)
#define LPC17_USBDEV_INTEN (LPC17_USB_BASE+LPC17_USBDEV_INTEN_OFFSET)
#define LPC17_USBDEV_INTCLR (LPC17_USB_BASE+LPC17_USBDEV_INTCLR_OFFSET)
#define LPC17_USBDEV_INTSET (LPC17_USB_BASE+LPC17_USBDEV_INTSET_OFFSET)
/* SIE Command registers */
#define LPC17_USBDEV_CMDCODE (LPC17_USB_BASE+LPC17_USBDEV_CMDCODE_OFFSET)
#define LPC17_USBDEV_CMDDATA (LPC17_USB_BASE+LPC17_USBDEV_CMDDATA_OFFSET)
/* USB transfer registers */
#define LPC17_USBDEV_RXDATA (LPC17_USB_BASE+LPC17_USBDEV_RXDATA_OFFSET)
#define LPC17_USBDEV_RXPLEN (LPC17_USB_BASE+LPC17_USBDEV_RXPLEN_OFFSET)
#define LPC17_USBDEV_TXDATA (LPC17_USB_BASE+LPC17_USBDEV_TXDATA_OFFSET)
#define LPC17_USBDEV_TXPLEN (LPC17_USB_BASE+LPC17_USBDEV_TXPLEN_OFFSET)
#define LPC17_USBDEV_CTRL (LPC17_USB_BASE+LPC17_USBDEV_CTRL_OFFSET)
/* More Device interrupt registers */
#define LPC17_USBDEV_INTPRI (LPC17_USB_BASE+LPC17_USBDEV_INTPRI_OFFSET)
/* Endpoint interrupt registers */
#define LPC17_USBDEV_EPINTST (LPC17_USB_BASE+LPC17_USBDEV_EPINTST_OFFSET)
#define LPC17_USBDEV_EPINTEN (LPC17_USB_BASE+LPC17_USBDEV_EPINTEN_OFFSET)
#define LPC17_USBDEV_EPINTCLR (LPC17_USB_BASE+LPC17_USBDEV_EPINTCLR_OFFSET)
#define LPC17_USBDEV_EPINTSET (LPC17_USB_BASE+LPC17_USBDEV_EPINTSET_OFFSET)
#define LPC17_USBDEV_EPINTPRI (LPC17_USB_BASE+LPC17_USBDEV_EPINTPRI_OFFSET)
/* Endpoint realization registers */
#define LPC17_USBDEV_REEP (LPC17_USB_BASE+LPC17_USBDEV_REEP_OFFSET)
#define LPC17_USBDEV_EPIND (LPC17_USB_BASE+LPC17_USBDEV_EPIND_OFFSET)
#define LPC17_USBDEV_MAXPSIZE (LPC17_USB_BASE+LPC17_USBDEV_MAXPSIZE_OFFSET)
/* DMA registers */
#define LPC17_USBDEV_DMARST (LPC17_USB_BASE+LPC17_USBDEV_DMARST_OFFSET)
#define LPC17_USBDEV_DMARCLR (LPC17_USB_BASE+LPC17_USBDEV_DMARCLR_OFFSET)
#define LPC17_USBDEV_DMARSET (LPC17_USB_BASE+LPC17_USBDEV_DMARSET_OFFSET)
#define LPC17_USBDEV_UDCAH (LPC17_USB_BASE+LPC17_USBDEV_UDCAH_OFFSET)
#define LPC17_USBDEV_EPDMAST (LPC17_USB_BASE+LPC17_USBDEV_EPDMAST_OFFSET)
#define LPC17_USBDEV_EPDMAEN (LPC17_USB_BASE+LPC17_USBDEV_EPDMAEN_OFFSET)
#define LPC17_USBDEV_EPDMADIS (LPC17_USB_BASE+LPC17_USBDEV_EPDMADIS_OFFSET)
#define LPC17_USBDEV_DMAINTST (LPC17_USB_BASE+LPC17_USBDEV_DMAINTST_OFFSET)
#define LPC17_USBDEV_DMAINTEN (LPC17_USB_BASE+LPC17_USBDEV_DMAINTEN_OFFSET)
#define LPC17_USBDEV_EOTINTST (LPC17_USB_BASE+LPC17_USBDEV_EOTINTST_OFFSET)
#define LPC17_USBDEV_EOTINTCLR (LPC17_USB_BASE+LPC17_USBDEV_EOTINTCLR_OFFSET)
#define LPC17_USBDEV_EOTINTSET (LPC17_USB_BASE+LPC17_USBDEV_EOTINTSET_OFFSET)
#define LPC17_USBDEV_NDDRINTST (LPC17_USB_BASE+LPC17_USBDEV_NDDRINTST_OFFSET)
#define LPC17_USBDEV_NDDRINTCLR (LPC17_USB_BASE+LPC17_USBDEV_NDDRINTCLR_OFFSET)
#define LPC17_USBDEV_NDDRINTSET (LPC17_USB_BASE+LPC17_USBDEV_NDDRINTSET_OFFSET)
#define LPC17_USBDEV_SYSERRINTST (LPC17_USB_BASE+LPC17_USBDEV_SYSERRINTST_OFFSET)
#define LPC17_USBDEV_SYSERRINTCLR (LPC17_USB_BASE+LPC17_USBDEV_SYSERRINTCLR_OFFSET)
#define LPC17_USBDEV_SYSERRINTSET (LPC17_USB_BASE+LPC17_USBDEV_SYSERRINTSET_OFFSET)
/* OTG I2C registers ****************************************************************/
#define LPC17_OTGI2C_RX (LPC17_USB_BASE+LPC17_OTGI2C_RX_OFFSET)
#define LPC17_OTGI2C_TX (LPC17_USB_BASE+LPC17_OTGI2C_TX_OFFSET)
#define LPC17_OTGI2C_STS (LPC17_USB_BASE+LPC17_OTGI2C_STS_OFFSET)
#define LPC17_OTGI2C_CTL (LPC17_USB_BASE+LPC17_OTGI2C_CTL_OFFSET)
#define LPC17_OTGI2C_CLKHI (LPC17_USB_BASE+LPC17_OTGI2C_CLKHI_OFFSET)
#define LPC17_OTGI2C_CLKLO (LPC17_USB_BASE+LPC17_OTGI2C_CLKLO_OFFSET)
/* Clock control registers ***********************************************************/
#define LPC17_USBOTG_CLKCTRL (LPC17_USB_BASE+LPC17_USBOTG_CLKCTRL_OFFSET)
#define LPC17_USBOTG_CLKST (LPC17_USB_BASE+LPC17_USBOTG_CLKST_OFFSET)
#define LPC17_USBDEV_CLKCTRL (LPC17_USB_BASE+LPC17_USBDEV_CLKCTRL_OFFSET)
#define LPC17_USBDEV_CLKST (LPC17_USB_BASE+LPC17_USBDEV_CLKST_OFFSET)
/* Register bit definitions *********************************************************/
/* USB Host Controller (OHCI) *******************************************************/
/* See include/nuttx/usb/ohci.h */
/* Module ID/Revision ID */
#define USBHOST_MODID_VER_SHIFT (0) /* Bits 0-7: Unique version number */
#define USBHOST_MODID_VER_MASK (0xff << USBHOST_MODID_VER_SHIFT)
#define USBHOST_MODID_REV_SHIFT (8) /* Bits 9-15: Unique revision number */
#define USBHOST_MODID_REV_MASK (0xff << USBHOST_MODID_REV_SHIFT)
#define USBHOST_MODID_3505_SHIFT (16) /* Bits 16-31: 0x3505 */
#define USBHOST_MODID_3505_MASK (0xffff << USBHOST_MODID_3505_SHIFT)
# define USBHOST_MODID_3505 (0x3505 << USBHOST_MODID_3505_SHIFT)
/* USB OTG Controller ***************************************************************/
/* OTG registers:
*
* OTG Interrupt Status, OTG Interrupt Enable, OTG Interrupt Set, AND OTG Interrupt
* Clear
*/
#define USBOTG_INT_TMR (1 << 0) /* Bit 0: Timer time-out */
#define USBOTG_INT_REMOVE_PU (1 << 1) /* Bit 1: Remove pull-up */
#define USBOTG_INT_HNP_FAILURE (1 << 2) /* Bit 2: HNP failed */
#define USBOTG_INT_HNP_SUCCESS (1 << 3) /* Bit 3: HNP succeeded */
/* Bits 4-31: Reserved */
/* OTG Status and Control */
#define USBOTG_STCTRL_PORTFUNC_SHIFT (0) /* Bits 0-1: Controls port function */
#define USBOTG_STCTRL_PORTFUNC_MASK (3 << USBOTG_STCTRL_PORTFUNC_SHIFT)
# define USBOTG_STCTRL_PORTFUNC_HNPOK (1 << USBOTG_STCTRL_PORTFUNC_SHIFT) /* HNP suceeded */
#define USBOTG_STCTRL_TMRSCALE_SHIFT (2) /* Bits 2-3: Timer scale selection */
#define USBOTG_STCTRL_TMRSCALE_MASK (3 << USBOTG_STCTRL_TMR_SCALE_SHIFT)
# define USBOTG_STCTRL_TMRSCALE_10US (0 << USBOTG_STCTRL_TMR_SCALE_SHIFT) /* 10uS (100 KHz) */
# define USBOTG_STCTRL_TMRSCALE_100US (1 << USBOTG_STCTRL_TMR_SCALE_SHIFT) /* 100uS (10 KHz) */
# define USBOTG_STCTRL_TMRSCALE_1000US (2 << USBOTG_STCTRL_TMR_SCALE_SHIFT) /* 1000uS (1 KHz) */
#define USBOTG_STCTRL_TMRMODE (1 << 4) /* Bit 4: Timer mode selection */
#define USBOTG_STCTRL_TMREN (1 << 5) /* Bit 5: Timer enable */
#define USBOTG_STCTRL_TMRRST (1 << 6) /* Bit 6: TTimer reset */
/* Bit 7: Reserved */
#define USBOTG_STCTRL_BHNPTRACK (1 << 8) /* Bit 8: Enable HNP tracking for B-device (peripheral) */
#define USBOTG_STCTRL_AHNPTRACK (1 << 9) /* Bit 9: Enable HNP tracking for A-device (host) */
#define USBOTG_STCTRL_PUREMOVED (1 << 10) /* Bit 10: Set when D+ pull-up removed */
/* Bits 11-15: Reserved */
#define USBOTG_STCTRL_TMRCNT_SHIFT (0) /* Bits 16-313: Timer scale selection */
#define USBOTG_STCTRL_TMRCNT_MASK (0ffff << USBOTG_STCTRL_TMR_CNT_SHIFT)
/* OTG Timer */
#define USBOTG_TMR_TIMEOUTCNT_SHIFT (0) /* Bits 0-15: Interrupt when CNT matches this */
#define USBOTG_TMR_TIMEOUTCNT_MASK (0xffff << USBOTG_TMR_TIMEOUTCNT_SHIFT)
/* Bits 16-31: Reserved */
/* USB Device Controller ************************************************************/
/* Device interrupt registers. See also SYSCON_USBINTST in lpc17_syscon.h */
/* USB Device Interrupt Status, USB Device Interrupt Enable, USB Device Interrupt
* Clear, USB Device Interrupt Set, and USB Device Interrupt Priority
*/
#define USBDEV_INT_FRAME (1 << 0) /* Bit 0: frame interrupt (every 1 ms) */
#define USBDEV_INT_EPFAST (1 << 1) /* Bit 1: Fast endpoint interrupt */
#define USBDEV_INT_EPSLOW (1 << 2) /* Bit 2: Slow endpoints interrupt */
#define USBDEV_INT_DEVSTAT (1 << 3) /* Bit 3: Bus reset, suspend change or connect change */
#define USBDEV_INT_CCEMPTY (1 << 4) /* Bit 4: Command code register empty */
#define USBDEV_INT_CDFULL (1 << 5) /* Bit 5: Command data register full */
#define USBDEV_INT_RXENDPKT (1 << 6) /* Bit 6: RX endpoint data transferred */
#define USBDEV_INT_TXENDPKT (1 << 7) /* Bit 7: TX endpoint data tansferred */
#define USBDEV_INT_EPRLZED (1 << 8) /* Bit 8: Endpoints realized */
#define USBDEV_INT_ERRINT (1 << 9) /* Bit 9: Error Interrupt */
/* Bits 10-31: Reserved */
/* SIE Command registers:
*
* USB Command Code
*/
/* Bits 0-7: Reserved */
#define USBDEV_CMDCODE_PHASE_SHIFT (8) /* Bits 8-15: Command phase */
#define USBDEV_CMDCODE_PHASE_MASK (0xff << USBDEV_CMDCODE_PHASE_SHIFT)
# define USBDEV_CMDCODE_PHASE_READ (1 << USBDEV_CMDCODE_PHASE_SHIFT)
# define USBDEV_CMDCODE_PHASE_WRITE (2 << USBDEV_CMDCODE_PHASE_SHIFT)
# define USBDEV_CMDCODE_PHASE_COMMAND (5 << USBDEV_CMDCODE_PHASE_SHIFT)
#define USBDEV_CMDCODE_CMD_SHIFT (16) /* Bits 15-23: Command (READ/COMMAND phases) */
#define USBDEV_CMDCODE_CMD_MASK (0xff << USBDEV_CMDCODE_CMD_SHIFT)
#define USBDEV_CMDCODE_WDATA_SHIFT (16) /* Bits 15-23: Write dagta (WRITE phase) */
#define USBDEV_CMDCODE_WDATA_MASK (0xff << USBDEV_CMDCODE_CMD_SHIFT)
/* Bits 24-31: Reserved */
/* USB Command Data */
#define USBDEV_CMDDATA_SHIFT (0) /* Bits 0-7: Command read data */
#define USBDEV_CMDDATA_MASK (0xff << USBDEV_CMDDATA_SHIFT)
/* Bits 8-31: Reserved */
/* USB transfer registers:
*
* USB Receive Data (Bits 0-31: Received data)
*/
/* USB Receive Packet Length */
#define USBDEV_RXPLEN_SHIFT (0) /* Bits 0-9: Bytes remaining to be read */
#define USBDEV_RXPLEN_MASK (0x3ff << USBDEV_RXPLEN_SHIFT)
#define USBDEV_RXPLEN_DV (1 << 10) /* Bit 10: DV Data valid */
#define USBDEV_RXPLEN_PKTRDY (1 << 11) /* Bit 11: Packet ready for reading */
/* Bits 12-31: Reserved */
/* USB Transmit Data (Bits 0-31: Transmit data) */
/* USB Transmit Packet Length */
#define USBDEV_TXPLEN_SHIFT (0) /* Bits 0-9: Bytes remaining to be written */
#define USBDEV_TXPLEN_MASK (0x3ff << USBDEV_TXPLEN_SHIFT)
/* Bits 10-31: Reserved */
/* USB Control */
#define USBDEV_CTRL_RDEN (1 << 0) /* Bit 0: Read mode control */
#define USBDEV_CTRL_WREN (1 << 1) /* Bit 1: Write mode control */
#define USBDEV_CTRL_LOGEP_SHIFT (2) /* Bits 2-5: Logical Endpoint number */
#define USBDEV_CTRL_LOGEP_MASK (15 << USBDEV_CTRL_LOGEP_SHIFT)
/* Bits 6-31: Reserved */
/* Endpoint interrupt registers:
*
* USB Endpoint Interrupt Status, USB Endpoint Interrupt Enable, USB Endpoint Interrupt
* Clear, USB Endpoint Interrupt Set, and USB Endpoint Priority. Bits correspond
* to on RX or TX value for any of 15 logical endpoints).
*/
#define USBDEV_LOGEPRX(n) (1 << ((n) << 1))
#define USBDEV_LOGEPTX(n) ((1 << ((n) << 1)) + 1)
#define USBDEV_LOGEPRX0 (1 << 0)
#define USBDEV_LOGEPTX0 (1 << 1)
#define USBDEV_LOGEPRX1 (1 << 2)
#define USBDEV_LOGEPTX1 (1 << 3)
#define USBDEV_LOGEPRX2 (1 << 4)
#define USBDEV_LOGEPTX2 (1 << 5)
#define USBDEV_LOGEPRX3 (1 << 6)
#define USBDEV_LOGEPTX3 (1 << 7)
#define USBDEV_LOGEPRX4 (1 << 8)
#define USBDEV_LOGEPTX4 (1 << 9)
#define USBDEV_LOGEPRX5 (1 << 10)
#define USBDEV_LOGEPTX5 (1 << 11)
#define USBDEV_LOGEPRX6 (1 << 12)
#define USBDEV_LOGEPTX6 (1 << 13)
#define USBDEV_LOGEPRX7 (1 << 14)
#define USBDEV_LOGEPTX7 (1 << 15)
#define USBDEV_LOGEPRX8 (1 << 16)
#define USBDEV_LOGEPTX8 (1 << 17)
#define USBDEV_LOGEPRX9 (1 << 18)
#define USBDEV_LOGEPTX9 (1 << 19)
#define USBDEV_LOGEPRX10 (1 << 20)
#define USBDEV_LOGEPTX10 (1 << 21)
#define USBDEV_LOGEPRX11 (1 << 22)
#define USBDEV_LOGEPTX11 (1 << 23)
#define USBDEV_LOGEPRX12 (1 << 24)
#define USBDEV_LOGEPTX12 (1 << 25)
#define USBDEV_LOGEPRX13 (1 << 26)
#define USBDEV_LOGEPTX13 (1 << 27)
#define USBDEV_LOGEPRX14 (1 << 28)
#define USBDEV_LOGEPTX14 (1 << 29)
#define USBDEV_LOGEPRX15 (1 << 30)
#define USBDEV_LOGEPTX15 (1 << 31)
/* Endpoint realization registers:
*
* USB Realize Endpoint (Bits correspond to 1 of 32 physical endpoints)
*/
#define USBDEV_PHYEP(n) (1 << (n))
#define USBDEV_PHYEP0 (1 << 0)
#define USBDEV_PHYEP1 (1 << 1)
#define USBDEV_PHYEP2 (1 << 2)
#define USBDEV_PHYEP3 (1 << 3)
#define USBDEV_PHYEP4 (1 << 4)
#define USBDEV_PHYEP5 (1 << 5)
#define USBDEV_PHYEP6 (1 << 6)
#define USBDEV_PHYEP7 (1 << 7)
#define USBDEV_PHYEP8 (1 << 8)
#define USBDEV_PHYEP9 (1 << 9)
#define USBDEV_PHYEP10 (1 << 10)
#define USBDEV_PHYEP11 (1 << 11)
#define USBDEV_PHYEP12 (1 << 12)
#define USBDEV_PHYEP13 (1 << 13)
#define USBDEV_PHYEP14 (1 << 14)
#define USBDEV_PHYEP15 (1 << 15)
#define USBDEV_PHYEP16 (1 << 16)
#define USBDEV_PHYEP17 (1 << 17)
#define USBDEV_PHYEP18 (1 << 18)
#define USBDEV_PHYEP19 (1 << 19)
#define USBDEV_PHYEP20 (1 << 20)
#define USBDEV_PHYEP21 (1 << 21)
#define USBDEV_PHYEP22 (1 << 22)
#define USBDEV_PHYEP23 (1 << 23)
#define USBDEV_PHYEP24 (1 << 24)
#define USBDEV_PHYEP25 (1 << 25)
#define USBDEV_PHYEP26 (1 << 26)
#define USBDEV_PHYEP27 (1 << 27)
#define USBDEV_PHYEP28 (1 << 28)
#define USBDEV_PHYEP29 (1 << 29)
#define USBDEV_PHYEP30 (1 << 30)
#define USBDEV_PHYEP31 (1 << 31)
/* USB Endpoint Index */
#define USBDEV_EPIND_SHIFT (0) /* Bits 0-4: Physical endpoint number (0-31) */
#define USBDEV_EPIND_MASK (31 << USBDEV_EPIND_SHIFT)
/* Bits 5-31: Reserved */
/* USB MaxPacketSize */
#define USBDEV_MAXPSIZE_SHIFT (0) /* Bits 0-9: Maximum packet size value */
#define USBDEV_MAXPSIZE_MASK (0x3ff << USBDEV_MAXPSIZE_SHIFT)
/* Bits 10-31: Reserved */
/* DMA registers:
*
* USB DMA Request Status, USB DMA Request Clear, and USB DMA Request Set. Registers
* contain bits for each of 32 physical endpoints. Use the USBDEV_PHYEP* definitions
* above. PHYEP0-1 (bits 0-1) must be zero.
*/
/* USB UDCA Head */
/* Bits 0-6: Reserved */
#define USBDEV_UDCAH_SHIFT (7) /* Bits 7-31: UDCA start address */
#define USBDEV_UDCAH_MASK (0x01ffffff << USBDEV_UDCAH_SHIFT)
/* USB Endpoint DMA Status, USB Endpoint DMA Enable, and USB Endpoint DMA Disable.
* Registers contain bits for physical endpoints 2-31. Use the USBDEV_PHYEP*
* definitions above. PHYEP0-1 (bits 0-1) must be zero.
*/
/* USB DMA Interrupt Status and USB DMA Interrupt Enable */
#define USBDEV_DMAINT_EOT (1 << 0) /* Bit 0: End of Transfer Interrupt */
#define USBDEV_DMAINT_NDDR (1 << 1) /* Bit 1: New DD Request Interrupt */
#define USBDEV_DMAINT_ERR (1 << 2) /* Bit 2: System Error Interrupt */
/* Bits 3-31: Reserved */
/* USB End of Transfer Interrupt Status, USB End of Transfer Interrupt Clear, and USB
* End of Transfer Interrupt Set. Registers contain bits for physical endpoints 2-31.
* Use the USBDEV_PHYEP* definitions above. PHYEP0-1 (bits 0-1) must be zero.
*/
/* USB New DD Request Interrupt Status, USB New DD Request Interrupt Clear, and USB
* New DD Request Interrupt Set. Registers contain bits for physical endpoints 2-31.
* Use the USBDEV_PHYEP* definitions above. PHYEP0-1 (bits 0-1) must be zero.
*/
/* USB System Error Interrupt Status, USB System Error Interrupt Clear, USB System
* Error Interrupt Set. Registers contain bits for physical endpoints 2-31. Use
* the USBDEV_PHYEP* definitions above. PHYEP0-1 (bits 0-1) must be zero.
*/
/* OTG I2C registers ****************************************************************/
/* I2C Receive */
#define OTGI2C_RX_DATA_SHIFT (0) /* Bits 0-7: RX data */
#define OTGI2C_RX_DATA_MASK (0xff << OTGI2C_RX_SHIFT)
/* Bits 8-31: Reserved */
/* I2C Transmit */
#define OTGI2C_TX_DATA_SHIFT (0) /* Bits 0-7: TX data */
#define OTGI2C_TX_DATA_MASK (0xff << OTGI2C_TX_DATA_SHIFT)
#define OTGI2C_TX_DATA_START (1 << 8) /* Bit 8: Issue START before transmit */
#define OTGI2C_TX_DATA_STOP (1 << 9) /* Bit 9: Issue STOP before transmit */
/* Bits 3-31: Reserved */
/* I2C Status */
#define OTGI2C_STS_TDI (1 << 0) /* Bit 0: Transaction Done Interrupt */
#define OTGI2C_STS_AFI (1 << 1) /* Bit 1: Arbitration Failure Interrupt */
#define OTGI2C_STS_NAI (1 << 2) /* Bit 2: No Acknowledge Interrupt */
#define OTGI2C_STS_DRMI (1 << 3) /* Bit 3: Master Data Request Interrupt */
#define OTGI2C_STS_DRSI (1 << 4) /* Bit 4: Slave Data Request Interrupt */
#define OTGI2C_STS_ACTIVE (1 << 5) /* Bit 5: Indicates whether the bus is busy */
#define OTGI2C_STS_SCL (1 << 6) /* Bit 6: The current value of the SCL signal */
#define OTGI2C_STS_SDA (1 << 7) /* Bit 7: The current value of the SDA signal */
#define OTGI2C_STS_RFF (1 << 8) /* Bit 8: Receive FIFO Full (RFF) */
#define OTGI2C_STS_RFE (1 << 9) /* Bit 9: Receive FIFO Empty */
#define OTGI2C_STS_TFF (1 << 10) /* Bit 10: Transmit FIFO Full */
#define OTGI2C_STS_TFE (1 << 11) /* Bit 11: Transmit FIFO Empty */
/* Bits 12-31: Reserved */
/* I2C Control */
#define OTGI2C_CTL_TDIE (1 << 0) /* Bit 0: Transmit Done Interrupt Enable */
#define OTGI2C_CTL_AFIE (1 << 1) /* Bit 1: Transmitter Arbitration Failure Interrupt Enable */
#define OTGI2C_CTL_NAIE (1 << 2) /* Bit 2: Transmitter No Acknowledge Interrupt Enable */
#define OTGI2C_CTL_DRMIE (1 << 3) /* Bit 3: Master Transmitter Data Request Interrupt Enable */
#define OTGI2C_CTL_DRSIE (1 << 4) /* Bit 4: Slave Transmitter Data Request Interrupt Enable */
#define OTGI2C_CTL_REFIE (1 << 5) /* Bit 5: Receive FIFO Full Interrupt Enable */
#define OTGI2C_CTL_RFDAIE (1 << 6) /* Bit 6: Receive Data Available Interrupt Enable */
#define OTGI2C_CTL_TFFIE (1 << 7) /* Bit 7: Transmit FIFO Not Full Interrupt Enable */
#define OTGI2C_CTL_SRST (1 << 8) /* Bit 8: Soft reset */
/* Bits 9-31: Reserved */
/* I2C Clock High */
#define OTGI2C_CLKHI_SHIFT (0) /* Bits 0-7: Clock divisor high */
#define OTGI2C_CLKHI_MASK (0xff << OTGI2C_CLKHI_SHIFT)
/* Bits 8-31: Reserved */
/* I2C Clock Low */
#define OTGI2C_CLKLO_SHIFT (0) /* Bits 0-7: Clock divisor high */
#define OTGI2C_CLLO_MASK (0xff << OTGI2C_CLKLO_SHIFT)
/* Bits 8-31: Reserved */
/* Clock control registers ***********************************************************/
/* USB Clock Control (OTG clock controller) and USB Clock Status (OTG clock status) */
#define USBDEV_CLK_HOSTCLK (1 << 0) /* Bit 1: Host clock (OTG only) */
#define USBDEV_CLK_DEVCLK (1 << 1) /* Bit 1: Device clock */
#define USBDEV_CLK_I2CCLK (1 << 2) /* Bit 2: I2C clock (OTG only) */
#define USBDEV_CLK_PORTSELCLK (1 << 3) /* Bit 3: Port select register clock (device only) */
#define USBDEV_CLK_OTGCLK (1 << 3) /* Bit 3: OTG clock (OTG only) */
#define USBDEV_CLK_AHBCLK (1 << 4) /* Bit 4: AHB clock */
/* Bits 5-31: Reserved */
/* Alternate naming */
#define USBOTG_CLK_HOSTCLK USBDEV_CLK_HOSTCLK
#define USBOTG_CLK_DEVCLK USBDEV_CLK_DEVCLK
#define USBOTG_CLK_I2CCLK USBDEV_CLK_I2CCLK
#define USBOTG_CLK_PORTSELCLK USBDEV_CLK_PORTSELCLK
#define USBOTG_CLK_OTGCLK USBDEV_CLK_OTGCLK
#define USBOTG_CLK_AHBCLK USBDEV_CLK_AHBCLK
/* Endpoints *************************************************************************/
#define LPC17_EP0_OUT 0
#define LPC17_EP0_IN 1
#define LPC17_CTRLEP_OUT LPC17_EP0_OUT
#define LPC17_CTRLEP_IN LPC17_EP0_IN
#define LPC17_EP1_OUT 2
#define LPC17_EP1_IN 3
#define LPC17_EP2_OUT 4
#define LPC17_EP2_IN 5
#define LPC17_EP3_OUT 6
#define LPC17_EP3_IN 7
#define LPC17_EP4_OUT 8
#define LPC17_EP4_IN 9
#define LPC17_EP5_OUT 10
#define LPC17_EP5_IN 11
#define LPC17_EP6_OUT 12
#define LPC17_EP6_IN 13
#define LPC17_EP7_OUT 14
#define LPC17_EP7_IN 15
#define LPC17_EP8_OUT 16
#define LPC17_EP8_IN 17
#define LPC17_EP9_OUT 18
#define LPC17_EP9_IN 19
#define LPC17_EP10_OUT 20
#define LPC17_EP10_IN 21
#define LPC17_EP11_OUT 22
#define LPC17_EP11_IN 23
#define LPC17_EP12_OUT 24
#define LPC17_EP12_IN 25
#define LPC17_EP13_OUT 26
#define LPC17_EP13_IN 27
#define LPC17_EP14_OUT 28
#define LPC17_EP14_IN 29
#define LPC17_EP15_OUT 30
#define LPC17_EP15_IN 31
#define LPC17_NUMEPS 32
/* Commands *************************************************************************/
/* USB Command Code Register */
#define CMD_USBDEV_PHASESHIFT (8) /* Bits 8-15: Command phase value */
#define CMD_USBDEV_PHASEMASK (0xff << CMD_USBDEV_PHASESHIFT)
# define CMD_USBDEV_DATAWR (1 << CMD_USBDEV_PHASESHIFT)
# define CMD_USBDEV_DATARD (2 << CMD_USBDEV_PHASESHIFT)
# define CMD_USBDEV_CMDWR (5 << CMD_USBDEV_PHASESHIFT)
#define CMD_USBDEV_CMDSHIFT (16) /* Bits 16-23: Device command/WDATA */
#define CMD_USBDEV_CMDMASK (0xff << CMD_USBDEV_CMDSHIFT)
#define CMD_USBDEV_WDATASHIFT CMD_USBDEV_CMDSHIFT
#define CMD_USBDEV_WDATAMASK CMD_USBDEV_CMDMASK
/* Device Commands */
#define CMD_USBDEV_SETADDRESS (0x00d0)
#define CMD_USBDEV_CONFIG (0x00d8)
#define CMD_USBDEV_SETMODE (0x00f3)
#define CMD_USBDEV_READFRAMENO (0x00f5)
#define CMD_USBDEV_READTESTREG (0x00fd)
#define CMD_USBDEV_SETSTATUS (0x01fe) /* Bit 8 set to distingish get from set */
#define CMD_USBDEV_GETSTATUS (0x00fe)
#define CMD_USBDEV_GETERRORCODE (0x00ff)
#define CMD_USBDEV_READERRORSTATUS (0x00fb)
/* Endpoint Commands */
#define CMD_USBDEV_EPSELECT (0x0000)
#define CMD_USBDEV_EPSELECTCLEAR (0x0040)
#define CMD_USBDEV_EPSETSTATUS (0x0140) /* Bit 8 set to distingish get from selectclear */
#define CMD_USBDEV_EPCLRBUFFER (0x00f2)
#define CMD_USBDEV_EPVALIDATEBUFFER (0x00fa)
/* Command/response bit definitions ********************************************/
/* SETADDRESS (0xd0) command definitions */
#define CMD_USBDEV_SETADDRESS_MASK (0x7f) /* Bits 0-6: Device address */
#define CMD_USBDEV_SETADDRESS_DEVEN (1 << 7) /* Bit 7: Device enable */
/* SETSTATUS (0xfe) and GETSTATUS (0xfe) response: */
#define CMD_STATUS_CONNECT (1 << 0) /* Bit 0: Connected */
#define CMD_STATUS_CONNCHG (1 << 1) /* Bit 1: Connect change */
#define CMD_STATUS_SUSPEND (1 << 2) /* Bit 2: Suspend */
#define CMD_STATUS_SUSPCHG (1 << 3) /* Bit 3: Suspend change */
#define CMD_STATUS_RESET (1 << 4) /* Bit 4: Bus reset bit */
/* EPSELECT (0x00) endpoint status response */
#define CMD_EPSELECT_FE (1 << 0) /* Bit 0: IN empty or OUT full */
#define CMD_EPSELECT_ST (1 << 1) /* Bit 1: Endpoint is stalled */
#define CMD_EPSELECT_STP (1 << 2) /* Bit 2: Last packet was setup */
#define CMD_EPSELECT_PO (1 << 3) /* Bit 3: Previous packet was overwritten */
#define CMD_EPSELECT_EPN (1 << 4) /* Bit 4: NAK sent */
#define CMD_EPSELECT_B1FULL (1 << 5) /* Bit 5: Buffer 1 full */
#define CMD_EPSELECT_B2FULL (1 << 6) /* Bit 6: Buffer 2 full */
/* Bit 7: Reserved */
/* EPSETSTATUS (0x40) command */
#define CMD_SETSTAUS_ST (1 << 0) /* Bit 0: Stalled endpoint bit */
/* Bits 1-4: Reserved */
#define CMD_SETSTAUS_DA (1 << 5) /* Bit 5: Disabled endpoint bit */
#define CMD_SETSTAUS_RFMO (1 << 6) /* Bit 6: Rate feedback mode */
#define CMD_SETSTAUS_CNDST (1 << 7) /* Bit 7: Conditional stall bit */
/* EPCLRBUFFER (0xf2) response */
#define CMD_USBDEV_CLRBUFFER_PO (0x00000001)
/* SETMODE(0xf3) command */
#define CMD_SETMODE_APCLK (1 << 0) /* Bit 0: Always PLL Clock */
#define CMD_SETMODE_INAKCI (1 << 1) /* Bit 1: Interrupt on NAK for Control IN endpoint */
#define CMD_SETMODE_INAKCO (1 << 2) /* Bit 2: Interrupt on NAK for Control OUT endpoint */
#define CMD_SETMODE_INAKII (1 << 3) /* Bit 3: Interrupt on NAK for Interrupt IN endpoint */
#define CMD_SETMODE_INAKIO (1 << 4) /* Bit 4: Interrupt on NAK for Interrupt OUT endpoints */
#define CMD_SETMODE_INAKBI (1 << 5) /* Bit 5: Interrupt on NAK for Bulk IN endpoints */
#define CMD_SETMODE_INAKBO (1 << 6) /* Bit 6: Interrupt on NAK for Bulk OUT endpoints */
/* READERRORSTATUS (0xFb) command */
#define CMD_READERRORSTATUS_PIDERR (1 << 0) /* Bit 0: PID encoding/unknown or Token CRC */
#define CMD_READERRORSTATUS_UEPKT (1 << 1) /* Bit 1: Unexpected Packet */
#define CMD_READERRORSTATUS_DCRC (1 << 2) /* Bit 2: Data CRC error */
#define CMD_READERRORSTATUS_TIMEOUT (1 << 3) /* Bit 3: Time out error */
#define CMD_READERRORSTATUS_EOP (1 << 4) /* Bit 4: End of packet error */
#define CMD_READERRORSTATUS_BOVRN (1 << 5) /* Bit 5: Buffer Overrun */
#define CMD_READERRORSTATUS_BTSTF (1 << 6) /* Bit 6: Bit stuff error */
#define CMD_READERRORSTATUS_TGLERR (1 << 7) /* Bit 7: Wrong toggle in data PID */
#define CMD_READERRORSTATUS_ALLERRS (0xff)
/* DMA ******************************************************************************/
/* The DMA descriptor */
#define USB_DMADESC_NEXTDDPTR 0 /* Offset 0: Next USB descriptor in RAM */
#define USB_DMADESC_CONFIG 1 /* Offset 1: DMA configuration info. */
#define USB_DMADESC_STARTADDR 2 /* Offset 2: DMA start address */
#define USB_DMADESC_STATUS 3 /* Offset 3: DMA status info (read only) */
#define USB_DMADESC_ISOCSIZEADDR 4 /* Offset 4: Isoc. packet size address */
/* Bit settings for CONFIG (offset 1 )*/
#define USB_DMADESC_MODE_SHIFT (0) /* Bits 0-1: DMA mode */
#define USB_DMADESC_MODE_MASK (3 << USB_DMADESC_MODE_SHIFT)
# define USB_DMADESC_MODENORMAL (0 << USB_DMADESC_MODE_SHIFT) /* Mode normal */
# define USB_DMADESC_MODEATLE (1 << USB_DMADESC_MODE_SHIFT) /* ATLE normal */
#define USB_DMADESC_NEXTDDVALID (1 << 2) /* Bit 2: Next descriptor valid */
/* Bit 3: Reserved */
#define USB_DMADESC_ISCOEP (1 << 4) /* Bit 4: ISOC endpoint */
#define USB_DMADESC_PKTSIZE_SHIFT (5) /* Bits 5-15: Max packet size */
#define USB_DMADESC_PKTSIZE_MASK (0x7ff << USB_DMADESC_PKTSIZE_SHIFT)
#define USB_DMADESC_BUFLEN_SHIFT (16) /* Bits 16-31: DMA buffer length */
#define USB_DMADESC_BUFLEN_MASK (0xffff << USB_DMADESC_BUFLEN_SHIFT
/* Bit settings for STATUS (offset 3). All must be initialized to zero. */
#define USB_DMADESC_STATUS_SHIFT (1) /* Bits 1-4: DMA status */
#define USB_DMADESC_STATUS_MASK (15 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_NOTSERVICED (0 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_BEINGSERVICED (1 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_NORMALCOMPLETION (2 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_DATAUNDERRUN (3 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_DATAOVERRUN (8 << USB_DMADESC_STATUS_SHIFT)
# define USB_DMADESC_SYSTEMERROR (9 << USB_DMADESC_STATUS_SHIFT)
#define USB_DMADESC_PKTVALID (1 << 5) /* Bit 5: Packet valid */
#define USB_DMADESC_LSBEXTRACTED (1 << 6) /* Bit 6: LS byte extracted */
#define USB_DMADESC_MSBEXTRACTED (1 << 7) /* Bit 7: MS byte extracted */
#define USB_DMADESC_MSGLENPOS_SHIFT (8) /* Bits 8-13: Message length position */
#define USB_DMADESC_MSGLENPOS_MASK (0x3f << USB_DMADESC_MSGLENPOS_SHIFT)
#define USB_DMADESC_DMACOUNT_SHIFT (16) /* Bits 16-31: DMA count */
#define USB_DMADESC_DMACOUNT_MASK (0xffff << USB_DMADESC_DMACOUNT_SHIFT)
/* DMA packet size format */
#define USB_DMAPKTSIZE_PKTLEN_SHIFT (0) /* Bits 0-15: Packet length */
#define USB_DMAPKTSIZE_PKTLEN_MASK (0xffff << USB_DMAPKTSIZE_PKTLEN_SHIFT)
#define USB_DMAPKTSIZE_PKTVALID (1 << 16) /* Bit 16: Packet valid */
#define USB_DMAPKTSIZE_FRAMENO_SHIFT (17) /* Bit 17-31: Frame number */
#define USB_DMAPKTSIZE_FRAMENO_MASK (0x7fff << USB_DMAPKTSIZE_FRAMENO_SHIFT)
/************************************************************************************
* Public Types
************************************************************************************/
/************************************************************************************
* Public Data
************************************************************************************/
/************************************************************************************
* Public Functions
************************************************************************************/
#endif /* __ARCH_ARM_SRC_LPC17XX_LPC17_USB_H */
|