-
Notifications
You must be signed in to change notification settings - Fork 109
Expand file tree
/
Copy pathDeviceDescriptor.java
More file actions
269 lines (240 loc) · 7.61 KB
/
DeviceDescriptor.java
File metadata and controls
269 lines (240 loc) · 7.61 KB
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
/*
* Copyright 2013 Klaus Reimer <[email protected]>
* See LICENSE.md for licensing information.
*
* Based on libusb <http://libusb.info/>:
*
* Copyright 2001 Johannes Erdfelt <[email protected]>
* Copyright 2007-2009 Daniel Drake <[email protected]>
* Copyright 2010-2012 Peter Stuge <[email protected]>
* Copyright 2008-2013 Nathan Hjelm <[email protected]>
* Copyright 2009-2013 Pete Batard <[email protected]>
* Copyright 2009-2013 Ludovic Rousseau <[email protected]>
* Copyright 2010-2012 Michael Plante <[email protected]>
* Copyright 2011-2013 Hans de Goede <[email protected]>
* Copyright 2012-2013 Martin Pieuchot <[email protected]>
* Copyright 2012-2013 Toby Gray <[email protected]>
*/
package org.usb4java;
import java.nio.ByteBuffer;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
/**
* A structure representing the standard USB device descriptor.
*
* This descriptor is documented in section 9.6.1 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
*
* @author Klaus Reimer ([email protected])
*/
public final class DeviceDescriptor
{
/** The native pointer to the descriptor structure. */
private long deviceDescriptorPointer;
/** The Java ByteBuffer which contains the descriptor structure. */
private final ByteBuffer deviceDescriptorBuffer;
/**
* Constructs a new device descriptor which can be passed to the
* {@link LibUsb#getDeviceDescriptor(Device, DeviceDescriptor)} method.
*/
public DeviceDescriptor()
{
// Assign new buffer.
this.deviceDescriptorBuffer = BufferUtils.allocateByteBuffer(
LibUsb.deviceDescriptorStructSize());
}
/**
* Returns the native pointer.
*
* @return The native pointer.
*/
public long getPointer()
{
return this.deviceDescriptorPointer;
}
/**
* Returns the Java byte buffer which contains the descriptor structure.
*
* @return The descriptor structure buffer.
*/
public ByteBuffer getBuffer()
{
return this.deviceDescriptorBuffer;
}
/**
* Returns the size of this descriptor (in bytes).
*
* @return The size of this descriptor (in bytes).
*/
public native byte bLength();
/**
* Returns the descriptor type. Will have value {@link LibUsb#DT_DEVICE}
* in this context.
*
* @return The descriptor type.
*/
public native byte bDescriptorType();
/**
* Returns the USB specification release number in binary-coded decimal.
* A value of 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc.
*
* @return The USB specification release number.
*/
public native short bcdUSB();
/**
* Returns the USB-IF class code for the device. See LibUSB.CLASS_*
* constants.
*
* @return The USB-IF class code.
*/
public native byte bDeviceClass();
/**
* Returns the USB-IF subclass code for the device, qualified by the
* bDeviceClass value.
*
* @return The USB-IF subclass code.
*/
public native byte bDeviceSubClass();
/**
* Returns the USB-IF protocol code for the device, qualified by the
* bDeviceClass and bDeviceSubClass values.
*
* @return The USB-IF protocol code.
*/
public native byte bDeviceProtocol();
/**
* Returns the maximum packet size for endpoint 0.
*
* @return The maximum packet site for endpoint 0.
*/
public native byte bMaxPacketSize0();
/**
* Returns the USB-IF vendor ID.
*
* @return The vendor ID
*/
public native short idVendor();
/**
* Returns the USB-IF product ID.
*
* @return The product ID.
*/
public native short idProduct();
/**
* Returns the device release number in binary-coded decimal.
*
* @return The device release number.
*/
public native short bcdDevice();
/**
* Returns the index of the string descriptor describing manufacturer.
*
* @return The manufacturer string descriptor index.
*/
public native byte iManufacturer();
/**
* Returns the index of the string descriptor describing product.
*
* @return The product string descriptor index.
*/
public native byte iProduct();
/**
* Returns the index of the string descriptor containing device serial
* number.
*
* @return The serial number string descriptor index.
*/
public native byte iSerialNumber();
/**
* Returns the number of possible configurations.
*
* @return The number of possible configurations.
*/
public native byte bNumConfigurations();
/**
* Returns a dump of this descriptor.
*
* @return The descriptor dump.
*/
public String dump()
{
return this.dump(null);
}
/**
* Returns a dump of this descriptor.
*
* @param handle
* The USB device handle for resolving string descriptors. If
* null then no strings are resolved.
* @return The descriptor dump.
*/
public String dump(final DeviceHandle handle)
{
final String sManufacturer = LibUsb.getStringDescriptor(handle,
this.iManufacturer());
final String sProduct = LibUsb.getStringDescriptor(handle,
this.iProduct());
final String sSerialNumber = LibUsb.getStringDescriptor(handle,
this.iSerialNumber());
return DescriptorUtils.dump(this, sManufacturer, sProduct,
sSerialNumber);
}
@Override
public int hashCode()
{
return new HashCodeBuilder()
.append(this.bLength())
.append(this.bDescriptorType())
.append(this.bcdUSB())
.append(this.bDeviceClass())
.append(this.bDeviceSubClass())
.append(this.bDeviceProtocol())
.append(this.bMaxPacketSize0())
.append(this.idVendor())
.append(this.idProduct())
.append(this.bcdDevice())
.append(this.iManufacturer())
.append(this.iProduct())
.append(this.iSerialNumber())
.append(this.bNumConfigurations())
.toHashCode();
}
@Override
public boolean equals(final Object obj)
{
if (this == obj)
{
return true;
}
if (obj == null)
{
return false;
}
if (this.getClass() != obj.getClass())
{
return false;
}
final DeviceDescriptor other = (DeviceDescriptor) obj;
return new EqualsBuilder()
.append(this.bLength(), other.bLength())
.append(this.bDescriptorType(), other.bDescriptorType())
.append(this.bcdUSB(), other.bcdUSB())
.append(this.bDeviceClass(), other.bDeviceClass())
.append(this.bDeviceSubClass(), other.bDeviceSubClass())
.append(this.bDeviceProtocol(), other.bDeviceProtocol())
.append(this.bMaxPacketSize0(), other.bMaxPacketSize0())
.append(this.idVendor(), other.idVendor())
.append(this.idProduct(), other.idProduct())
.append(this.bcdDevice(), other.bcdDevice())
.append(this.iManufacturer(), other.iManufacturer())
.append(this.iProduct(), other.iProduct())
.append(this.iSerialNumber(), other.iSerialNumber())
.append(this.bNumConfigurations(), other.bNumConfigurations())
.isEquals();
}
@Override
public String toString()
{
return this.dump();
}
}