]> sigrok.org Git - sigrok-firmware-fx2lafw.git/blame - include/dscr.inc
GPL headers: Use correct project name.
[sigrok-firmware-fx2lafw.git] / include / dscr.inc
CommitLineData
a4d8b708 1;;
a986cfff 2;; This file is part of the sigrok-firmware-fx2lafw project.
a4d8b708
JH
3;;
4;; Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
5;; Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
6;;
7;; This program is free software; you can redistribute it and/or modify
8;; it under the terms of the GNU General Public License as published by
9;; the Free Software Foundation; either version 2 of the License, or
10;; (at your option) any later version.
11;;
12;; This program is distributed in the hope that it will be useful,
13;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15;; GNU General Public License for more details.
16;;
17;; You should have received a copy of the GNU General Public License
18;; along with this program; if not, write to the Free Software
19;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20;;
21
22.module DEV_DSCR
23
24; Descriptor types
25DSCR_DEVICE_TYPE = 1
26DSCR_CONFIG_TYPE = 2
27DSCR_STRING_TYPE = 3
28DSCR_INTERFACE_TYPE = 4
29DSCR_ENDPOINT_TYPE = 5
30DSCR_DEVQUAL_TYPE = 6
31
32; Descriptor lengths
33DSCR_INTERFACE_LEN = 9
34DSCR_ENDPOINT_LEN = 7
35
36; Endpoint types
37ENDPOINT_TYPE_CONTROL = 0
38ENDPOINT_TYPE_ISO = 1
39ENDPOINT_TYPE_BULK = 2
40ENDPOINT_TYPE_INT = 3
41
42.globl _dev_dscr, _dev_qual_dscr, _highspd_dscr, _fullspd_dscr, _dev_strings, _dev_strings_end
43.area DSCR_AREA (CODE)
44
45; -----------------------------------------------------------------------------
46; Device descriptor
47; -----------------------------------------------------------------------------
48_dev_dscr:
49 .db dev_dscr_end - _dev_dscr
50 .db DSCR_DEVICE_TYPE
51 .dw 0x0002 ; USB 2.0
52 .db 0xff ; Class (vendor specific)
53 .db 0xff ; Subclass (vendor specific)
54 .db 0xff ; Protocol (vendor specific)
55 .db 64 ; Max. EP0 packet size
56 .dw VID ; Manufacturer ID
57 .dw PID ; Product ID
58 .dw 0x0100 ; Product version (0.01)
59 .db 1 ; Manufacturer string index
60 .db 2 ; Product string index
61 .db 0 ; Serial number string index (none)
62 .db 1 ; Number of configurations
63dev_dscr_end:
64
65; -----------------------------------------------------------------------------
66; Device qualifier (for "other device speed")
67; -----------------------------------------------------------------------------
68_dev_qual_dscr:
69 .db dev_qualdscr_end - _dev_qual_dscr
70 .db DSCR_DEVQUAL_TYPE
71 .dw 0x0002 ; USB 2.0
72 .db 0xff ; Class (vendor specific)
73 .db 0xff ; Subclass (vendor specific)
74 .db 0xff ; Protocol (vendor specific)
75 .db 64 ; Max. EP0 packet size
76 .db 1 ; Number of configurations
77 .db 0 ; Extra reserved byte
78dev_qualdscr_end:
79
80; -----------------------------------------------------------------------------
81; High-Speed configuration descriptor
82; -----------------------------------------------------------------------------
83_highspd_dscr:
84 .db highspd_dscr_end - _highspd_dscr
85 .db DSCR_CONFIG_TYPE
86 ; Total length of the configuration (1st line LSB, 2nd line MSB)
87 .db (highspd_dscr_realend - _highspd_dscr) % 256
88 .db (highspd_dscr_realend - _highspd_dscr) / 256
89 .db 1 ; Number of interfaces
90 .db 1 ; Configuration number
91 .db 0 ; Configuration string (none)
92 .db 0x80 ; Attributes (bus powered, no wakeup)
93 .db 0x32 ; Max. power (100mA)
94highspd_dscr_end:
95
96 ; Interfaces (only one in our case)
97 .db DSCR_INTERFACE_LEN
98 .db DSCR_INTERFACE_TYPE
99 .db 0 ; Interface index
100 .db 0 ; Alternate setting index
101 .db 1 ; Number of endpoints
102 .db 0xff ; Class (vendor specific)
103 .db 0xff ; Subclass (vendor specific)
104 .db 0xff ; Protocol (vendor specific)
105 .db 0 ; String index (none)
106
107 ; Endpoint 2 (IN)
108 .db DSCR_ENDPOINT_LEN
109 .db DSCR_ENDPOINT_TYPE
110 .db 0x82 ; EP number (2), direction (IN)
111 .db ENDPOINT_TYPE_BULK ; Endpoint type (bulk)
112 .db 0x00 ; Max. packet size, LSB (512 bytes)
113 .db 0x02 ; Max. packet size, MSB (512 bytes)
114 .db 0x00 ; Polling interval
115
116highspd_dscr_realend:
117
118 .even
119
120; -----------------------------------------------------------------------------
121; Full-Speed configuration descriptor
122; -----------------------------------------------------------------------------
123_fullspd_dscr:
124 .db fullspd_dscr_end - _fullspd_dscr
125 .db DSCR_CONFIG_TYPE
126 ; Total length of the configuration (1st line LSB, 2nd line MSB)
127 .db (fullspd_dscr_realend - _fullspd_dscr) % 256
128 .db (fullspd_dscr_realend - _fullspd_dscr) / 256
129 .db 1 ; Number of interfaces
130 .db 1 ; Configuration number
131 .db 0 ; Configuration string (none)
132 .db 0x80 ; Attributes (bus powered, no wakeup)
133 .db 0x32 ; Max. power (100mA)
134fullspd_dscr_end:
135
136 ; Interfaces (only one in our case)
137 .db DSCR_INTERFACE_LEN
138 .db DSCR_INTERFACE_TYPE
139 .db 0 ; Interface index
140 .db 0 ; Alternate setting index
141 .db 1 ; Number of endpoints
142 .db 0xff ; Class (vendor specific)
143 .db 0xff ; Subclass (vendor specific)
144 .db 0xff ; Protocol (vendor specific)
145 .db 0 ; String index (none)
146
147 ; Endpoint 2 (IN)
148 .db DSCR_ENDPOINT_LEN
149 .db DSCR_ENDPOINT_TYPE
150 .db 0x82 ; EP number (2), direction (IN)
151 .db ENDPOINT_TYPE_BULK ; Endpoint type (bulk)
152 .db 0x40 ; Max. packet size, LSB (64 bytes)
153 .db 0x00 ; Max. packet size, MSB (64 bytes)
154 .db 0x00 ; Polling interval
155
156fullspd_dscr_realend:
157
158 .even
159
160; -----------------------------------------------------------------------------
161; Strings
162; -----------------------------------------------------------------------------
163
164_dev_strings:
165
166; See http://www.usb.org/developers/docs/USB_LANGIDs.pdf for the full list.
167_string0:
168 .db string0end - _string0
169 .db DSCR_STRING_TYPE
170 .db 0x09, 0x04 ; Language code 0x0409 (English, US)
171string0end:
172
173_string1:
174 .db string1end - _string1
175 .db DSCR_STRING_TYPE
176 .ascii 's'
177 .db 0
178 .ascii 'i'
179 .db 0
180 .ascii 'g'
181 .db 0
182 .ascii 'r'
183 .db 0
184 .ascii 'o'
185 .db 0
186 .ascii 'k'
187 .db 0
188string1end:
189
190_string2:
191 .db string2end - _string2
192 .db DSCR_STRING_TYPE
193 .ascii 'f'
194 .db 0
195 .ascii 'x'
196 .db 0
197 .ascii '2'
198 .db 0
199 .ascii 'l'
200 .db 0
201 .ascii 'a'
202 .db 0
203 .ascii 'f'
204 .db 0
205 .ascii 'w'
206 .db 0
207string2end:
208
209_dev_strings_end:
210 .dw 0x0000
211