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
|
# Copyright 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""A composite USB gadget is built from multiple USB features.
"""
import gadget
import usb_constants
import usb_descriptors
class CompositeGadget(gadget.Gadget):
"""Basic functionality for a composite USB device.
Composes multiple USB features into a single device.
"""
def __init__(self, device_desc, features):
"""Create a USB gadget device.
Args:
device_desc: USB device descriptor.
features: USB device features.
"""
# dicts mapping interface numbers to features for FS and HS configurations
self._fs_interface_feature_map = {}
self._hs_interface_feature_map = {}
fs_config_desc = usb_descriptors.ConfigurationDescriptor(
bmAttributes=0x80,
MaxPower=50)
hs_config_desc = usb_descriptors.ConfigurationDescriptor(
bmAttributes=0x80,
MaxPower=50)
for feature in features:
for fs_interface in feature.GetFullSpeedInterfaces():
fs_config_desc.AddInterface(fs_interface)
self._fs_interface_feature_map[fs_interface.bInterfaceNumber] = feature
for hs_interface in feature.GetHighSpeedInterfaces():
hs_config_desc.AddInterface(hs_interface)
self._hs_interface_feature_map[hs_interface.bInterfaceNumber] = feature
super(CompositeGadget, self).__init__(
device_desc, fs_config_desc, hs_config_desc)
self._features = features
def Connected(self, chip, speed):
super(CompositeGadget, self).Connected(chip, speed)
for feature in self._features:
feature.Connected(self)
def Disconnected(self):
super(CompositeGadget, self).Disconnected()
for feature in self._features:
feature.Disconnected()
def _GetInterfaceFeatureMap(self):
if self.GetSpeed() == usb_constants.Speed.FULL:
return self._fs_interface_feature_map
elif self.GetSpeed() == usb_constants.Speed.HIGH:
return self._hs_interface_feature_map
else:
raise RuntimeError('Device is not connected.')
def ReceivePacket(self, endpoint, data):
interface = self.GetInterfaceForEndpoint(endpoint)
feature = self._GetInterfaceFeatureMap()[interface]
feature.ReceivePacket(endpoint, data)
def _GetFeatureForIndex(self, recipient, index):
interface = None
if recipient == usb_constants.Recipient.INTERFACE:
interface = index
elif recipient == usb_constants.Recipient.ENDPOINT:
interface = self.GetInterfaceForEndpoint(index)
if interface is not None:
return self._GetInterfaceFeatureMap().get(interface)
return None
def StandardControlRead(self, recipient, request, value, index, length):
response = super(CompositeGadget, self).StandardControlRead(
recipient, request, value, index, length)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.StandardControlRead(
recipient, request, value, index, length)
def StandardControlWrite(self, recipient, request, value, index, data):
response = super(CompositeGadget, self).StandardControlWrite(
recipient, request, value, index, data)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.StandardControlWrite(
recipient, request, value, index, data)
def ClassControlRead(self, recipient, request, value, index, length):
response = super(CompositeGadget, self).ClassControlRead(
recipient, request, value, index, length)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.ClassControlRead(recipient, request, value, index, length)
def ClassControlWrite(self, recipient, request, value, index, data):
response = super(CompositeGadget, self).ClassControlWrite(
recipient, request, value, index, data)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.ClassControlWrite(recipient, request, value, index, data)
def VendorControlRead(self, recipient, request, value, index, length):
response = super(CompositeGadget, self).VendorControlRead(
recipient, request, value, index, length)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.VendorControlRead(recipient, request, value, index, length)
def VendorControlWrite(self, recipient, request, value, index, data):
response = super(CompositeGadget, self).VendorControlWrite(
recipient, request, value, index, data)
if response is not None:
return response
feature = self._GetFeatureForIndex(recipient, index)
if feature:
return feature.VendorControlWrite(recipient, request, value, index, data)
class CompositeFeature(object):
def __init__(self, fs_interface_descs, hs_interface_descs):
self._gadget = None
self._fs_interface_descs = fs_interface_descs
self._hs_interface_descs = hs_interface_descs
def GetFullSpeedInterfaces(self):
return self._fs_interface_descs
def GetHighSpeedInterfaces(self):
return self._hs_interface_descs
def Connected(self, my_gadget):
self._gadget = my_gadget
def Disconnected(self):
self._gadget = None
def IsConnected(self):
return self._gadget is not None
def SendPacket(self, endpoint, data):
if self._gadget is None:
raise RuntimeError('Device is not connected.')
self._gadget.SendPacket(endpoint, data)
def HaltEndpoint(self, endpoint):
if self._gadget is None:
raise RuntimeError('Device is not connected.')
self._gadget.HaltEndpoint(endpoint)
def GetDescriptor(self, recipient, typ, index, lang, length):
_ = recipient, typ, index, lang, length
return None
def StandardControlRead(self, recipient, request, value, index, length):
"""Handle standard USB control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
length: Maximum amount of data the host expects the device to return.
Returns:
A buffer to return to the USB host with len <= length on success or
None to stall the pipe.
"""
_ = recipient, request, value, index, length
return None
def ClassControlRead(self, recipient, request, value, index, length):
"""Handle class-specific control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
length: Maximum amount of data the host expects the device to return.
Returns:
A buffer to return to the USB host with len <= length on success or
None to stall the pipe.
"""
_ = recipient, request, value, index, length
return None
def VendorControlRead(self, recipient, request, value, index, length):
"""Handle vendor-specific control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
length: Maximum amount of data the host expects the device to return.
Returns:
A buffer to return to the USB host with len <= length on success or
None to stall the pipe.
"""
_ = recipient, request, value, index, length
return None
def StandardControlWrite(self, recipient, request, value, index, data):
"""Handle standard USB control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
data: Data stage of the request.
Returns:
True on success, None to stall the pipe.
"""
_ = recipient, request, value, index, data
return None
def ClassControlWrite(self, recipient, request, value, index, data):
"""Handle class-specific control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
data: Data stage of the request.
Returns:
True on success, None to stall the pipe.
"""
_ = recipient, request, value, index, data
return None
def VendorControlWrite(self, recipient, request, value, index, data):
"""Handle vendor-specific control transfers.
Args:
recipient: Request recipient (interface or endpoint)
request: bRequest field of the setup packet.
value: wValue field of the setup packet.
index: wIndex field of the setup packet.
data: Data stage of the request.
Returns:
True on success, None to stall the pipe.
"""
_ = recipient, request, value, index, data
return None
|
