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
|
/*
* Copyright © 2012 Keith Packard <keithp@keithp.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
#ifndef _AO_USB_H_
#define _AO_USB_H_
/*
* ao_usb.c
*/
/* Put one character to the USB output queue */
void
ao_usb_putchar(char c);
/* Get one character from the USB input queue */
char
ao_usb_getchar(void);
/* Poll for a charcter on the USB input queue.
* returns AO_READ_AGAIN if none are available
*/
int
ao_usb_pollchar(void);
/* Flush the USB output queue */
void
ao_usb_flush(void);
#if AO_USB_HAS_IN2
void
ao_usb_flush2(void);
void
ao_usb_putchar2(char c);
#endif
#if AO_USB_HAS_IN3
void
ao_usb_flush3(void);
void
ao_usb_putchar3(char c);
#endif
/* Enable the USB controller */
void
ao_usb_enable(void);
/* Disable the USB controller */
void
ao_usb_disable(void);
/* Initialize the USB system */
void
ao_usb_init(void);
extern const uint8_t ao_usb_descriptors [];
#define AO_USB_SETUP_DIR_MASK (0x01 << 7)
#define AO_USB_SETUP_TYPE_MASK (0x03 << 5)
#define AO_USB_SETUP_RECIP_MASK (0x1f)
#define AO_USB_DIR_OUT 0
#define AO_USB_DIR_IN (1 << 7)
#define AO_USB_TYPE_STANDARD 0
#define AO_USB_TYPE_CLASS (1 << 5)
#define AO_USB_TYPE_VENDOR (2 << 5)
#define AO_USB_TYPE_RESERVED (3 << 5)
#define AO_USB_RECIP_DEVICE 0
#define AO_USB_RECIP_INTERFACE 1
#define AO_USB_RECIP_ENDPOINT 2
#define AO_USB_RECIP_OTHER 3
/* standard requests */
#define AO_USB_REQ_GET_STATUS 0x00
#define AO_USB_REQ_CLEAR_FEATURE 0x01
#define AO_USB_REQ_SET_FEATURE 0x03
#define AO_USB_REQ_SET_ADDRESS 0x05
#define AO_USB_REQ_GET_DESCRIPTOR 0x06
#define AO_USB_REQ_SET_DESCRIPTOR 0x07
#define AO_USB_REQ_GET_CONFIGURATION 0x08
#define AO_USB_REQ_SET_CONFIGURATION 0x09
#define AO_USB_REQ_GET_INTERFACE 0x0A
#define AO_USB_REQ_SET_INTERFACE 0x0B
#define AO_USB_REQ_SYNCH_FRAME 0x0C
#define AO_USB_DESC_DEVICE 1
#define AO_USB_DESC_CONFIGURATION 2
#define AO_USB_DESC_STRING 3
#define AO_USB_DESC_INTERFACE 4
#define AO_USB_DESC_ENDPOINT 5
#define AO_USB_DESC_DEVICE_QUALIFIER 6
#define AO_USB_DESC_OTHER_SPEED 7
#define AO_USB_DESC_INTERFACE_POWER 8
#define AO_USB_GET_DESC_TYPE(x) (((x)>>8)&0xFF)
#define AO_USB_GET_DESC_INDEX(x) ((x)&0xFF)
#define AO_USB_CONTROL_EP 0
#define AO_USB_CONTROL_SIZE 32
#define AO_USB_INT_EP 1
#define AO_USB_INT_SIZE 8
#ifndef AO_USB_OUT_EP
#define AO_USB_OUT_EP 4
#define AO_USB_IN_EP 5
#define AO_USB_IN2_EP 6
#define AO_USB_IN3_EP 7
#endif
#ifndef AO_USB_HAS_OUT
#define AO_USB_HAS_OUT 1
#endif
#ifndef AO_USB_HAS_IN
#define AO_USB_HAS_IN 1
#endif
#ifndef AO_USB_HAS_INT
#define AO_USB_HAS_INT 1
#endif
#ifndef AO_USB_HAS_IN2
#define AO_USB_HAS_IN2 0
#endif
#ifndef AO_USB_HAS_IN3
#define AO_USB_HAS_IN3 0
#endif
/*
* USB bulk packets can only come in 8, 16, 32 and 64
* byte sizes, so we'll use 64 for everything
*/
#define AO_USB_IN_SIZE 64
#define AO_USB_OUT_SIZE 64
#define AO_USB_EP0_IDLE 0
#define AO_USB_EP0_DATA_IN 1
#define AO_USB_EP0_DATA_OUT 2
#define AO_USB_EP0_STALL 3
#define LE_WORD(x) ((x)&0xFF),((uint8_t) (((uint16_t) (x))>>8))
/* CDC definitions */
#define AO_USB_CS_INTERFACE 0x24
#define AO_USB_CS_ENDPOINT 0x25
#define AO_USB_SET_LINE_CODING 0x20
#define AO_USB_GET_LINE_CODING 0x21
#define AO_USB_SET_CONTROL_LINE_STATE 0x22
/* Data structure for GET_LINE_CODING / SET_LINE_CODING class requests */
struct ao_usb_line_coding {
uint32_t rate;
uint8_t char_format;
uint8_t parity;
uint8_t data_bits;
} ;
extern struct ao_usb_line_coding ao_usb_line_coding;
extern uint8_t ao_usb_running;
#endif /* _AO_USB_H_ */
|
