summaryrefslogtreecommitdiff
path: root/firmware/drivers/usb/arcotg_dcd.h
diff options
context:
space:
mode:
Diffstat (limited to 'firmware/drivers/usb/arcotg_dcd.h')
-rw-r--r--firmware/drivers/usb/arcotg_dcd.h173
1 files changed, 173 insertions, 0 deletions
diff --git a/firmware/drivers/usb/arcotg_dcd.h b/firmware/drivers/usb/arcotg_dcd.h
new file mode 100644
index 0000000000..127ee43efa
--- /dev/null
+++ b/firmware/drivers/usb/arcotg_dcd.h
@@ -0,0 +1,173 @@
1/***************************************************************************
2 * __________ __ ___.
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
7 * \/ \/ \/ \/ \/
8 * $Id: $
9 *
10 * Copyright (C) 2007 by Christian Gmeiner
11 *
12 * Based on code from the Linux Target Image Builder from Freescale
13 * available at http://www.bitshrine.org/ and
14 * http://www.bitshrine.org/gpp/linux-2.6.16-mx31-usb-2.patch
15 * Adapted for Rockbox in January 2007
16 * Original file: drivers/usb/gadget/arcotg_udc.c
17 *
18 * USB Device Controller Driver
19 * Driver for ARC OTG USB module in the i.MX31 platform, etc.
20 *
21 * Copyright 2004-2006 Freescale Semiconductor, Inc. All Rights Reserved.
22 *
23 * Based on mpc-udc.h
24 * Author: Li Yang (leoli@freescale.com)
25 * Jiang Bo (Tanya.jiang@freescale.com)
26 *
27 * All files in this archive are subject to the GNU General Public License.
28 * See the file COPYING in the source tree root for full license agreement.
29 *
30 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
31 * KIND, either express or implied.
32 *
33 ****************************************************************************/
34
35#ifndef _ARCOTG_DCD_H_
36#define _ARCOTG_DCD_H_
37
38#include "usbstack/core.h"
39#include "arcotg_udc.h"
40
41/*-------------------------------------------------------------------------*/
42
43#define ep_is_in(EP) (((EP)->desc->bEndpointAddress & USB_DIR_IN)==USB_DIR_IN)
44
45#define EP_DIR_IN 1
46#define EP_DIR_OUT 0
47
48/*-------------------------------------------------------------------------*/
49
50/* pipe direction macro from device view */
51#define USB_RECV (0) /* OUT EP */
52#define USB_SEND (1) /* IN EP */
53
54/* Shared Bit Masks for Endpoint Queue Head and Endpoint Transfer Descriptor */
55#define TERMINATE (1 << 0)
56#define STATUS_ACTIVE (1 << 7)
57#define STATUS_HALTED (1 << 6)
58#define STATUS_DATA_BUFF_ERR (1 << 5)
59#define STATUS_TRANSACTION_ERR (1 << 4)
60#define INTERRUPT_ON_COMPLETE (1 << 15)
61#define LENGTH_BIT_POS (16)
62#define ADDRESS_MASK (0xFFFFFFE0)
63#define ERROR_MASK (DTD_STATUS_HALTED | \
64 DTD_STATUS_DATA_BUFF_ERR | \
65 DTD_STATUS_TRANSACTION_ERR)
66
67#define RESERVED_FIELDS ((1 << 0) | (1 << 2) | (1 << 4) | \
68 (1 << 8) | (1 << 9) | (1 << 12)| \
69 (1 << 13)| (1 << 14)| (1 << 31))
70
71/* Endpoint Queue Head Bit Masks */
72#define EP_QUEUE_HEAD_MULT_POS (30)
73#define EP_QUEUE_HEAD_ZLT_SEL (0x20000000)
74#define EP_QUEUE_HEAD_MAX_PKT_LEN(ep_info) (((ep_info)>>16)&0x07ff)
75#define EP_QUEUE_HEAD_MULTO (0x00000C00)
76#define EP_QUEUE_CURRENT_OFFSET_MASK (0x00000FFF)
77#define EP_QUEUE_FRINDEX_MASK (0x000007FF)
78#define EP_MAX_LENGTH_TRANSFER (0x4000)
79
80/*-------------------------------------------------------------------------*/
81
82/* ep name is important, it should obey the convention of ep_match() */
83/* even numbered EPs are OUT or setup, odd are IN/INTERRUPT */
84static const char* ep_name[] = {
85 "ep0-control", NULL, /* everyone has ep0 */
86 /* 7 configurable endpoints */
87 "ep1out",
88 "ep1in",
89 "ep2out",
90 "ep2in",
91 "ep3out",
92 "ep3in",
93 "ep4out",
94 "ep4in",
95 "ep5out",
96 "ep5in",
97 "ep6out",
98 "ep6in",
99 "ep7out",
100 "ep7in"
101};
102
103/*-------------------------------------------------------------------------*/
104
105/* Endpoint Transfer Descriptor data struct */
106struct dtd {
107 uint32_t next_dtd; /* Next TD pointer(31-5), T(0) set indicate invalid */
108 uint32_t dtd_token; /* Total bytes (30-16), IOC (15), MultO(11-10), STS (7-0) */
109 uint32_t buf_ptr0; /* Buffer pointer Page 0 */
110 uint32_t buf_ptr1; /* Buffer pointer Page 1 */
111 uint32_t buf_ptr2; /* Buffer pointer Page 2 */
112 uint32_t buf_ptr3; /* Buffer pointer Page 3 */
113 uint32_t buf_ptr4; /* Buffer pointer Page 4 */
114 uint32_t res; /* make it an even 8 words */
115} __attribute((packed));
116
117/* Endpoint Queue Head*/
118struct dqh {
119 uint32_t endpt_cap; /* Mult(31-30) , Zlt(29) , Max Pkt len
120 * and IOS(15) */
121 uint32_t cur_dtd; /* Current dTD Pointer(31-5) */
122 struct dtd dtd_ovrl; /* Transfer descriptor */
123 uint32_t setup_buffer[2]; /* Setup data 8 bytes */
124 uint32_t res2[4]; /* pad out to 64 bytes */
125} __attribute((packed));
126
127#define RESPONSE_SIZE 30
128
129/* our controller struct */
130struct arcotg_dcd {
131 struct usb_ctrlrequest local_setup_buff;
132 struct usb_ep endpoints[USB_MAX_PIPES];
133 struct usb_response response[RESPONSE_SIZE];
134 enum usb_device_state usb_state;
135 enum usb_device_state resume_state;
136 bool stopped;
137};
138
139/*-------------------------------------------------------------------------*/
140
141/* usb_controller functions */
142void usb_arcotg_dcd_init(void);
143void usb_arcotg_dcd_shutdown(void);
144void usb_arcotg_dcd_irq(void);
145void usb_arcotg_dcd_start(void);
146void usb_arcotg_dcd_stop(void);
147
148/* usb controller ops */
149int usb_arcotg_dcd_enable(struct usb_ep* ep);
150int usb_arcotg_dcd_disable(struct usb_ep* ep);
151int usb_arcotg_dcd_set_halt(struct usb_ep* ep, bool halt);
152int usb_arcotg_dcd_send(struct usb_ep* ep, struct usb_response* request);
153int usb_arcotg_dcd_receive(struct usb_ep* ep, struct usb_response* res);
154
155/* interrupt handlers */
156static void setup_received_int(struct usb_ctrlrequest* request);
157static void port_change_int(void);
158static void reset_int(void);
159static void suspend_int(void);
160static void resume_int(void);
161
162/* life cycle */
163static void qh_init(unsigned char ep_num, unsigned char dir, unsigned char ep_type,
164 unsigned int max_pkt_len, unsigned int zlt, unsigned char mult);
165static void td_init(struct dtd* td, void* buffer, uint32_t todo);
166static void ep_setup(unsigned char ep_num, unsigned char dir, unsigned char ep_type);
167
168/* helpers for tx/rx */
169static int td_enqueue(struct dtd* td, struct dqh* qh, unsigned int mask);
170static int td_wait(struct dtd* td, unsigned int mask);
171static int usb_ack(struct usb_ctrlrequest * s, int error);
172
173#endif /*_ARCOTG_DCD_H_*/
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-20 04:09:17 +0000