-
Notifications
You must be signed in to change notification settings - Fork 109
Expand file tree
/
Copy pathConfigDescriptor.java
More file actions
225 lines (199 loc) · 6.23 KB
/
ConfigDescriptor.java
File metadata and controls
225 lines (199 loc) · 6.23 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
/*
* 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 configuration descriptor.
*
* This descriptor is documented in section 9.6.3 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
*
* @author Klaus Reimer ([email protected])
*/
public final class ConfigDescriptor
{
/** The native pointer to the descriptor structure. */
private long configDescriptorPointer;
/**
* Constructs a new config descriptor which can be passed to the
* {@link LibUsb#getConfigDescriptor(Device, byte, ConfigDescriptor)}
* method.
*/
public ConfigDescriptor()
{
// Empty
}
/**
* Returns the native pointer.
*
* @return The native pointer.
*/
public long getPointer()
{
return this.configDescriptorPointer;
}
/**
* 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_CONFIG}
* in this context.
*
* @return The descriptor type.
*/
public native byte bDescriptorType();
/**
* Returns the total length of data returned for this configuration.
*
* @return The total length of data.
*/
public native short wTotalLength();
/**
* Returns the number of interfaces supported by this configuration.
*
* @return The number of supported interfaces.
*/
public native byte bNumInterfaces();
/**
* Returns the identifier value for this configuration.
*
* @return The identifier value.
*/
public native byte bConfigurationValue();
/**
* Returns the index of string descriptor describing this configuration.
*
* @return The string descriptor index.
*/
public native byte iConfiguration();
/**
* Returns the configuration characteristics.
*
* @return The configuration characteristics.
*/
public native byte bmAttributes();
/**
* Returns the maximum power consumption of the USB device from this bus
* configuration when the device is fully operation. Expressed in units
* of 2 mA when the device is operating in high-speed mode and in units
* of 8 mA when the device is operating in super-speed mode.
*
* @return The maximum power consumption.
*/
public native byte bMaxPower();
/**
* Returns the array with interfaces supported by this configuration.
*
* @return The array with interfaces.
*/
public native Interface[] iface();
/**
* Extra descriptors.
*
* If libusb encounters unknown interface descriptors, it will store them
* here, should you wish to parse them.
*
* @return The extra descriptors.
*/
public native ByteBuffer extra();
/**
* Length of the extra descriptors, in bytes.
*
* @return The extra descriptors length.
*/
public native int extraLength();
/**
* Returns a dump of this descriptor.
*
* @return The descriptor dump.
*/
public String dump()
{
final StringBuilder builder = new StringBuilder();
builder.append(String.format(
"%s" +
" extralen %17d%n" +
" extra:%n" +
"%s",
DescriptorUtils.dump(this),
this.extraLength(),
DescriptorUtils.dump(this.extra()).replaceAll("(?m)^", " ")));
for (final Interface iface : this.iface())
{
builder.append(String.format("%n") + iface.dump());
}
return builder.toString();
}
@Override
public int hashCode()
{
return new HashCodeBuilder()
.append(this.bLength())
.append(this.bDescriptorType())
.append(this.wTotalLength())
.append(this.bNumInterfaces())
.append(this.bConfigurationValue())
.append(this.iConfiguration())
.append(this.bmAttributes())
.append(this.bMaxPower())
.append(this.iface())
.append(this.extra())
.append(this.extraLength())
.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 ConfigDescriptor other = (ConfigDescriptor) obj;
return new EqualsBuilder()
.append(this.bLength(), other.bLength())
.append(this.bDescriptorType(), other.bDescriptorType())
.append(this.wTotalLength(), other.wTotalLength())
.append(this.bNumInterfaces(), other.bNumInterfaces())
.append(this.bConfigurationValue(), other.bConfigurationValue())
.append(this.iConfiguration(), other.iConfiguration())
.append(this.bmAttributes(), other.bmAttributes())
.append(this.bMaxPower(), other.bMaxPower())
.append(this.iface(), other.iface())
.append(this.extra(), other.extra())
.append(this.extraLength(), other.extraLength())
.isEquals();
}
@Override
public String toString()
{
return this.dump();
}
}