-
Notifications
You must be signed in to change notification settings - Fork 109
Expand file tree
/
Copy pathControlSetup.java
More file actions
229 lines (210 loc) · 5.39 KB
/
ControlSetup.java
File metadata and controls
229 lines (210 loc) · 5.39 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
/*
* Copyright 2013 Luca Longinotti <[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 java.nio.ByteOrder;
/**
* Setup packet for control transfers.
*
* @author Luca Longinotti ([email protected])
*/
public final class ControlSetup
{
/**
* The native data structure of the setup packet.
*
* USB Control Setup is always 8 bytes long. Structured as follows:
*
* byte 0: bmRequestType
* byte 1: bRequest
* bytes 2-3: wValue (Little Endian)
* bytes 4-5: wIndex (Little Endian)
* bytes 6-7: wLength (Little Endian)
*/
private final ByteBuffer controlSetup;
/**
* Constructs a new control setup packet using the first 8 bytes from the
* specified transfer buffer.
*
* @param buffer
* The transfer buffer.
*/
ControlSetup(final ByteBuffer buffer)
{
if (buffer == null)
{
throw new IllegalArgumentException("buffer cannot be null");
}
this.controlSetup = BufferUtils.slice(buffer, 0,
LibUsb.CONTROL_SETUP_SIZE);
// Control Setup (as all of USB) is Little Endian.
this.controlSetup.order(ByteOrder.LITTLE_ENDIAN);
}
/**
* Returns the request type.
*
* Bits 0:4 determine recipient.
* Bits 5:6 determine type.
* Bit 7 determines data transfer direction.
*
* @return The request type.
*/
public byte bmRequestType()
{
return this.controlSetup.get(0);
}
/**
* Sets the request type.
*
* @param bmRequestType
* The request type to set.
*/
public void setBmRequestType(final byte bmRequestType)
{
this.controlSetup.put(0, bmRequestType);
}
/**
* Returns the request.
*
* If the type bits of {@link #bmRequestType()} are equal to
* {@link LibUsb#REQUEST_TYPE_STANDARD} then this field refers to
* one of the REQUEST_* constants or {@link LibUsb#SET_ISOCH_DELAY}. For
* other cases, use of this field is application-specific.
*
* @return The request.
*/
public byte bRequest()
{
return this.controlSetup.get(1);
}
/**
* Sets the request.
*
* @param bRequest
* The request to set.
*/
public void setBRequest(final byte bRequest)
{
this.controlSetup.put(1, bRequest);
}
/**
* Returns the value.
*
* Varies according to request
*
* @return The value.
*/
public short wValue()
{
return this.controlSetup.getShort(2);
}
/**
* Sets the value.
*
* @param wValue
* The value to set.
*/
public void setWValue(final short wValue)
{
this.controlSetup.putShort(2, wValue);
}
/**
* Returns the index.
*
* Varies according to request, typically used to pass an index or offset
*
* @return The index.
*/
public short wIndex()
{
return this.controlSetup.getShort(4);
}
/**
* Sets the index.
*
* @param wIndex
* The index to set.
*/
public void setWIndex(final short wIndex)
{
this.controlSetup.putShort(4, wIndex);
}
/**
* Returns the number of bytes to transfer.
*
* @return The number of bytes to transfer.
*/
public short wLength()
{
return this.controlSetup.getShort(6);
}
/**
* Sets the number of bytes to transfer.
*
* @param wLength
* The number of bytes to transfer.
*/
public void setWLength(final short wLength)
{
this.controlSetup.putShort(6, wLength);
}
@Override
public int hashCode()
{
final int prime = 31;
int result = 1;
result = (prime * result)
+ ((this.controlSetup == null) ? 0 : this.controlSetup.hashCode());
return result;
}
@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 ControlSetup other = (ControlSetup) obj;
if (this.controlSetup == null)
{
if (other.controlSetup != null)
{
return false;
}
}
else if (!this.controlSetup.equals(other.controlSetup))
{
return false;
}
return true;
}
@Override
public String toString()
{
return String.format("libusb control setup with buffer %s",
this.controlSetup.toString());
}
}