-
Notifications
You must be signed in to change notification settings - Fork 109
Expand file tree
/
Copy pathEndpointDescriptor.java
More file actions
213 lines (191 loc) · 6.04 KB
/
EndpointDescriptor.java
File metadata and controls
213 lines (191 loc) · 6.04 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
/*
* 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 endpoint descriptor.
*
* This descriptor is documented in section 9.6.6 of the USB 3.0 specification.
* All multiple-byte fields are represented in host-endian format.
*
* @author Klaus Reimer ([email protected])
*/
public final class EndpointDescriptor
{
/** The native pointer to the descriptor structure. */
private long endpointDescriptorPointer;
/**
* Package-private constructor to prevent manual instantiation. Endpoint
* descriptors are always created by JNI.
*/
EndpointDescriptor()
{
// Empty
}
/**
* Returns the native pointer.
*
* @return The native pointer.
*/
public long getPointer()
{
return this.endpointDescriptorPointer;
}
/**
* 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_ENDPOINT}
* in this context.
*
* @return The descriptor type.
*/
public native byte bDescriptorType();
/**
* The address of the endpoint described by this descriptor. Bits 0:3 are
* the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction
* (Either {@link LibUsb#ENDPOINT_IN} or {@link LibUsb#ENDPOINT_OUT}).
*
* @return The endpoint address.
*/
public native byte bEndpointAddress();
/**
* Attributes which apply to the endpoint when it is configured using the
* bConfigurationValue. Bits 0:1 determine the transfer type and correspond
* to the LibUsb.TRANSFER_TYPE_* constants. Bits 2:3 are only used for
* isochronous endpoints and correspond to the LibUsb.ISO_SYNC_TYPE_*
* constants. Bits 4:5 are also only used for isochronous endpoints and
* correspond to the LibUsb.ISO_USAGE_TYPE_* constants. Bits 6:7 are
* reserved.
*
* @return The attributes.
*/
public native byte bmAttributes();
/**
* Returns the maximum packet size this endpoint is capable of
* sending/receiving.
*
* @return The maximum packet size.
*/
public native short wMaxPacketSize();
/**
* Returns the interval for polling endpoint for data transfers.
*
* @return The polling interval.
*/
public native byte bInterval();
/**
* For audio devices only: the rate at which synchronization feedback is
* provided.
*
* @return The synchronization feedback rate.
*/
public native byte bRefresh();
/**
* For audio devices only: the address of the synch endpoint.
*
* @return The synch endpoint address.
*/
public native byte bSynchAddress();
/**
* Extra descriptors.
*
* If libusb encounters unknown endpoint 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()
{
return String.format(
"%s" +
" extralen %17d%n" +
" extra:%n" +
"%s",
DescriptorUtils.dump(this),
this.extraLength(),
DescriptorUtils.dump(this.extra()).replaceAll("(?m)^", " "));
}
@Override
public int hashCode()
{
return new HashCodeBuilder()
.append(this.bLength())
.append(this.bDescriptorType())
.append(this.bEndpointAddress())
.append(this.bmAttributes())
.append(this.wMaxPacketSize())
.append(this.bInterval())
.append(this.bRefresh())
.append(this.bSynchAddress())
.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 EndpointDescriptor other = (EndpointDescriptor) obj;
return new EqualsBuilder()
.append(this.bLength(), other.bLength())
.append(this.bDescriptorType(), other.bDescriptorType())
.append(this.bEndpointAddress(), other.bEndpointAddress())
.append(this.bmAttributes(), other.bmAttributes())
.append(this.wMaxPacketSize(), other.wMaxPacketSize())
.append(this.bInterval(), other.bInterval())
.append(this.bRefresh(), other.bRefresh())
.append(this.bSynchAddress(), other.bSynchAddress())
.append(this.extra(), other.extra())
.append(this.extraLength(), other.extraLength())
.isEquals();
}
@Override
public String toString()
{
return this.dump();
}
}