]>
Commit | Line | Data |
---|---|---|
aa1f3bb5 | 1 | // SPDX-License-Identifier: GPL-2.0 |
1da177e4 LT |
2 | /* |
3 | * message.c - synchronous message handling | |
b65fba3d GKH |
4 | * |
5 | * Released under the GPLv2 only. | |
1da177e4 LT |
6 | */ |
7 | ||
1da177e4 LT |
8 | #include <linux/pci.h> /* for scatterlist macros */ |
9 | #include <linux/usb.h> | |
10 | #include <linux/module.h> | |
11 | #include <linux/slab.h> | |
1da177e4 LT |
12 | #include <linux/mm.h> |
13 | #include <linux/timer.h> | |
14 | #include <linux/ctype.h> | |
a853a3d4 | 15 | #include <linux/nls.h> |
1da177e4 | 16 | #include <linux/device.h> |
11763609 | 17 | #include <linux/scatterlist.h> |
e4c6fb77 | 18 | #include <linux/usb/cdc.h> |
7ceec1f1 | 19 | #include <linux/usb/quirks.h> |
27729aad | 20 | #include <linux/usb/hcd.h> /* for usbcore internals */ |
1a7e3948 | 21 | #include <linux/usb/of.h> |
1da177e4 LT |
22 | #include <asm/byteorder.h> |
23 | ||
1da177e4 LT |
24 | #include "usb.h" |
25 | ||
df718962 AS |
26 | static void cancel_async_set_config(struct usb_device *udev); |
27 | ||
67f5dde3 AS |
28 | struct api_context { |
29 | struct completion done; | |
30 | int status; | |
31 | }; | |
32 | ||
7d12e780 | 33 | static void usb_api_blocking_completion(struct urb *urb) |
1da177e4 | 34 | { |
67f5dde3 AS |
35 | struct api_context *ctx = urb->context; |
36 | ||
37 | ctx->status = urb->status; | |
38 | complete(&ctx->done); | |
1da177e4 LT |
39 | } |
40 | ||
41 | ||
ecdc0a59 FBH |
42 | /* |
43 | * Starts urb and waits for completion or timeout. Note that this call | |
44 | * is NOT interruptible. Many device driver i/o requests should be | |
45 | * interruptible and therefore these drivers should implement their | |
46 | * own interruptible routines. | |
47 | */ | |
48 | static int usb_start_wait_urb(struct urb *urb, int timeout, int *actual_length) | |
3e35bf39 | 49 | { |
67f5dde3 | 50 | struct api_context ctx; |
ecdc0a59 | 51 | unsigned long expire; |
3fc3e826 | 52 | int retval; |
1da177e4 | 53 | |
67f5dde3 AS |
54 | init_completion(&ctx.done); |
55 | urb->context = &ctx; | |
1da177e4 | 56 | urb->actual_length = 0; |
3fc3e826 GKH |
57 | retval = usb_submit_urb(urb, GFP_NOIO); |
58 | if (unlikely(retval)) | |
ecdc0a59 | 59 | goto out; |
1da177e4 | 60 | |
ecdc0a59 | 61 | expire = timeout ? msecs_to_jiffies(timeout) : MAX_SCHEDULE_TIMEOUT; |
67f5dde3 AS |
62 | if (!wait_for_completion_timeout(&ctx.done, expire)) { |
63 | usb_kill_urb(urb); | |
64 | retval = (ctx.status == -ENOENT ? -ETIMEDOUT : ctx.status); | |
ecdc0a59 FBH |
65 | |
66 | dev_dbg(&urb->dev->dev, | |
71d2718f | 67 | "%s timed out on ep%d%s len=%u/%u\n", |
ecdc0a59 | 68 | current->comm, |
5e60a161 AS |
69 | usb_endpoint_num(&urb->ep->desc), |
70 | usb_urb_dir_in(urb) ? "in" : "out", | |
ecdc0a59 FBH |
71 | urb->actual_length, |
72 | urb->transfer_buffer_length); | |
ecdc0a59 | 73 | } else |
67f5dde3 | 74 | retval = ctx.status; |
ecdc0a59 | 75 | out: |
1da177e4 LT |
76 | if (actual_length) |
77 | *actual_length = urb->actual_length; | |
ecdc0a59 | 78 | |
1da177e4 | 79 | usb_free_urb(urb); |
3fc3e826 | 80 | return retval; |
1da177e4 LT |
81 | } |
82 | ||
83 | /*-------------------------------------------------------------------*/ | |
3e35bf39 | 84 | /* returns status (negative) or length (positive) */ |
1da177e4 | 85 | static int usb_internal_control_msg(struct usb_device *usb_dev, |
3e35bf39 | 86 | unsigned int pipe, |
1da177e4 LT |
87 | struct usb_ctrlrequest *cmd, |
88 | void *data, int len, int timeout) | |
89 | { | |
90 | struct urb *urb; | |
91 | int retv; | |
92 | int length; | |
93 | ||
94 | urb = usb_alloc_urb(0, GFP_NOIO); | |
95 | if (!urb) | |
96 | return -ENOMEM; | |
3e35bf39 | 97 | |
1da177e4 LT |
98 | usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char *)cmd, data, |
99 | len, usb_api_blocking_completion, NULL); | |
100 | ||
101 | retv = usb_start_wait_urb(urb, timeout, &length); | |
102 | if (retv < 0) | |
103 | return retv; | |
104 | else | |
105 | return length; | |
106 | } | |
107 | ||
108 | /** | |
3e35bf39 GKH |
109 | * usb_control_msg - Builds a control urb, sends it off and waits for completion |
110 | * @dev: pointer to the usb device to send the message to | |
111 | * @pipe: endpoint "pipe" to send the message to | |
112 | * @request: USB message request value | |
113 | * @requesttype: USB message request type value | |
114 | * @value: USB message value | |
115 | * @index: USB message index value | |
116 | * @data: pointer to the data to send | |
117 | * @size: length in bytes of the data to send | |
118 | * @timeout: time in msecs to wait for the message to complete before timing | |
119 | * out (if 0 the wait is forever) | |
120 | * | |
121 | * Context: !in_interrupt () | |
122 | * | |
123 | * This function sends a simple control message to a specified endpoint and | |
124 | * waits for the message to complete, or timeout. | |
125 | * | |
123b7b30 JK |
126 | * Don't use this function from within an interrupt context. If you need |
127 | * an asynchronous message, or need to send a message from within interrupt | |
128 | * context, use usb_submit_urb(). If a thread in your driver uses this call, | |
129 | * make sure your disconnect() method can wait for it to complete. Since you | |
130 | * don't have a handle on the URB used, you can't cancel the request. | |
626f090c YB |
131 | * |
132 | * Return: If successful, the number of bytes transferred. Otherwise, a negative | |
133 | * error number. | |
1da177e4 | 134 | */ |
3e35bf39 GKH |
135 | int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request, |
136 | __u8 requesttype, __u16 value, __u16 index, void *data, | |
137 | __u16 size, int timeout) | |
1da177e4 | 138 | { |
3e35bf39 | 139 | struct usb_ctrlrequest *dr; |
1da177e4 | 140 | int ret; |
3e35bf39 GKH |
141 | |
142 | dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_NOIO); | |
1da177e4 LT |
143 | if (!dr) |
144 | return -ENOMEM; | |
145 | ||
3e35bf39 | 146 | dr->bRequestType = requesttype; |
1da177e4 | 147 | dr->bRequest = request; |
da2bbdcc HH |
148 | dr->wValue = cpu_to_le16(value); |
149 | dr->wIndex = cpu_to_le16(index); | |
150 | dr->wLength = cpu_to_le16(size); | |
1da177e4 | 151 | |
1da177e4 LT |
152 | ret = usb_internal_control_msg(dev, pipe, dr, data, size, timeout); |
153 | ||
154 | kfree(dr); | |
155 | ||
156 | return ret; | |
157 | } | |
782e70c6 | 158 | EXPORT_SYMBOL_GPL(usb_control_msg); |
1da177e4 | 159 | |
782a7a63 GKH |
160 | /** |
161 | * usb_interrupt_msg - Builds an interrupt urb, sends it off and waits for completion | |
162 | * @usb_dev: pointer to the usb device to send the message to | |
163 | * @pipe: endpoint "pipe" to send the message to | |
164 | * @data: pointer to the data to send | |
165 | * @len: length in bytes of the data to send | |
3e35bf39 GKH |
166 | * @actual_length: pointer to a location to put the actual length transferred |
167 | * in bytes | |
782a7a63 GKH |
168 | * @timeout: time in msecs to wait for the message to complete before |
169 | * timing out (if 0 the wait is forever) | |
3e35bf39 | 170 | * |
782a7a63 GKH |
171 | * Context: !in_interrupt () |
172 | * | |
173 | * This function sends a simple interrupt message to a specified endpoint and | |
174 | * waits for the message to complete, or timeout. | |
175 | * | |
123b7b30 JK |
176 | * Don't use this function from within an interrupt context. If you need |
177 | * an asynchronous message, or need to send a message from within interrupt | |
178 | * context, use usb_submit_urb() If a thread in your driver uses this call, | |
179 | * make sure your disconnect() method can wait for it to complete. Since you | |
180 | * don't have a handle on the URB used, you can't cancel the request. | |
626f090c YB |
181 | * |
182 | * Return: | |
183 | * If successful, 0. Otherwise a negative error number. The number of actual | |
e227867f | 184 | * bytes transferred will be stored in the @actual_length parameter. |
782a7a63 GKH |
185 | */ |
186 | int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe, | |
187 | void *data, int len, int *actual_length, int timeout) | |
188 | { | |
189 | return usb_bulk_msg(usb_dev, pipe, data, len, actual_length, timeout); | |
190 | } | |
191 | EXPORT_SYMBOL_GPL(usb_interrupt_msg); | |
192 | ||
1da177e4 | 193 | /** |
3e35bf39 GKH |
194 | * usb_bulk_msg - Builds a bulk urb, sends it off and waits for completion |
195 | * @usb_dev: pointer to the usb device to send the message to | |
196 | * @pipe: endpoint "pipe" to send the message to | |
197 | * @data: pointer to the data to send | |
198 | * @len: length in bytes of the data to send | |
199 | * @actual_length: pointer to a location to put the actual length transferred | |
200 | * in bytes | |
201 | * @timeout: time in msecs to wait for the message to complete before | |
202 | * timing out (if 0 the wait is forever) | |
203 | * | |
204 | * Context: !in_interrupt () | |
205 | * | |
206 | * This function sends a simple bulk message to a specified endpoint | |
207 | * and waits for the message to complete, or timeout. | |
208 | * | |
123b7b30 JK |
209 | * Don't use this function from within an interrupt context. If you need |
210 | * an asynchronous message, or need to send a message from within interrupt | |
211 | * context, use usb_submit_urb() If a thread in your driver uses this call, | |
212 | * make sure your disconnect() method can wait for it to complete. Since you | |
213 | * don't have a handle on the URB used, you can't cancel the request. | |
3e35bf39 GKH |
214 | * |
215 | * Because there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl, | |
216 | * users are forced to abuse this routine by using it to submit URBs for | |
217 | * interrupt endpoints. We will take the liberty of creating an interrupt URB | |
218 | * (with the default interval) if the target is an interrupt endpoint. | |
626f090c YB |
219 | * |
220 | * Return: | |
221 | * If successful, 0. Otherwise a negative error number. The number of actual | |
025d4430 | 222 | * bytes transferred will be stored in the @actual_length parameter. |
626f090c | 223 | * |
1da177e4 | 224 | */ |
3e35bf39 GKH |
225 | int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe, |
226 | void *data, int len, int *actual_length, int timeout) | |
1da177e4 LT |
227 | { |
228 | struct urb *urb; | |
d09d36a9 | 229 | struct usb_host_endpoint *ep; |
1da177e4 | 230 | |
fe54b058 | 231 | ep = usb_pipe_endpoint(usb_dev, pipe); |
d09d36a9 | 232 | if (!ep || len < 0) |
1da177e4 LT |
233 | return -EINVAL; |
234 | ||
d09d36a9 | 235 | urb = usb_alloc_urb(0, GFP_KERNEL); |
1da177e4 LT |
236 | if (!urb) |
237 | return -ENOMEM; | |
238 | ||
d09d36a9 AS |
239 | if ((ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == |
240 | USB_ENDPOINT_XFER_INT) { | |
241 | pipe = (pipe & ~(3 << 30)) | (PIPE_INTERRUPT << 30); | |
242 | usb_fill_int_urb(urb, usb_dev, pipe, data, len, | |
8d062b9a AS |
243 | usb_api_blocking_completion, NULL, |
244 | ep->desc.bInterval); | |
d09d36a9 AS |
245 | } else |
246 | usb_fill_bulk_urb(urb, usb_dev, pipe, data, len, | |
247 | usb_api_blocking_completion, NULL); | |
1da177e4 LT |
248 | |
249 | return usb_start_wait_urb(urb, timeout, actual_length); | |
250 | } | |
782e70c6 | 251 | EXPORT_SYMBOL_GPL(usb_bulk_msg); |
1da177e4 LT |
252 | |
253 | /*-------------------------------------------------------------------*/ | |
254 | ||
3e35bf39 | 255 | static void sg_clean(struct usb_sg_request *io) |
1da177e4 LT |
256 | { |
257 | if (io->urbs) { | |
258 | while (io->entries--) | |
085528e5 | 259 | usb_free_urb(io->urbs[io->entries]); |
3e35bf39 | 260 | kfree(io->urbs); |
1da177e4 LT |
261 | io->urbs = NULL; |
262 | } | |
1da177e4 LT |
263 | io->dev = NULL; |
264 | } | |
265 | ||
3e35bf39 | 266 | static void sg_complete(struct urb *urb) |
1da177e4 | 267 | { |
3e35bf39 | 268 | struct usb_sg_request *io = urb->context; |
3fc3e826 | 269 | int status = urb->status; |
1da177e4 | 270 | |
3e35bf39 | 271 | spin_lock(&io->lock); |
1da177e4 LT |
272 | |
273 | /* In 2.5 we require hcds' endpoint queues not to progress after fault | |
274 | * reports, until the completion callback (this!) returns. That lets | |
275 | * device driver code (like this routine) unlink queued urbs first, | |
276 | * if it needs to, since the HC won't work on them at all. So it's | |
277 | * not possible for page N+1 to overwrite page N, and so on. | |
278 | * | |
279 | * That's only for "hard" faults; "soft" faults (unlinks) sometimes | |
280 | * complete before the HCD can get requests away from hardware, | |
281 | * though never during cleanup after a hard fault. | |
282 | */ | |
283 | if (io->status | |
284 | && (io->status != -ECONNRESET | |
3fc3e826 | 285 | || status != -ECONNRESET) |
1da177e4 | 286 | && urb->actual_length) { |
3e35bf39 | 287 | dev_err(io->dev->bus->controller, |
1da177e4 LT |
288 | "dev %s ep%d%s scatterlist error %d/%d\n", |
289 | io->dev->devpath, | |
5e60a161 AS |
290 | usb_endpoint_num(&urb->ep->desc), |
291 | usb_urb_dir_in(urb) ? "in" : "out", | |
3fc3e826 | 292 | status, io->status); |
3e35bf39 | 293 | /* BUG (); */ |
1da177e4 LT |
294 | } |
295 | ||
3fc3e826 GKH |
296 | if (io->status == 0 && status && status != -ECONNRESET) { |
297 | int i, found, retval; | |
1da177e4 | 298 | |
3fc3e826 | 299 | io->status = status; |
1da177e4 LT |
300 | |
301 | /* the previous urbs, and this one, completed already. | |
302 | * unlink pending urbs so they won't rx/tx bad data. | |
303 | * careful: unlink can sometimes be synchronous... | |
304 | */ | |
3e35bf39 | 305 | spin_unlock(&io->lock); |
1da177e4 | 306 | for (i = 0, found = 0; i < io->entries; i++) { |
98b74b0e | 307 | if (!io->urbs[i]) |
1da177e4 LT |
308 | continue; |
309 | if (found) { | |
98b74b0e | 310 | usb_block_urb(io->urbs[i]); |
085528e5 | 311 | retval = usb_unlink_urb(io->urbs[i]); |
3fc3e826 GKH |
312 | if (retval != -EINPROGRESS && |
313 | retval != -ENODEV && | |
bcf39853 AS |
314 | retval != -EBUSY && |
315 | retval != -EIDRM) | |
3e35bf39 | 316 | dev_err(&io->dev->dev, |
1da177e4 | 317 | "%s, unlink --> %d\n", |
441b62c1 | 318 | __func__, retval); |
085528e5 | 319 | } else if (urb == io->urbs[i]) |
1da177e4 LT |
320 | found = 1; |
321 | } | |
3e35bf39 | 322 | spin_lock(&io->lock); |
1da177e4 | 323 | } |
1da177e4 LT |
324 | |
325 | /* on the last completion, signal usb_sg_wait() */ | |
326 | io->bytes += urb->actual_length; | |
327 | io->count--; | |
328 | if (!io->count) | |
3e35bf39 | 329 | complete(&io->complete); |
1da177e4 | 330 | |
3e35bf39 | 331 | spin_unlock(&io->lock); |
1da177e4 LT |
332 | } |
333 | ||
334 | ||
335 | /** | |
336 | * usb_sg_init - initializes scatterlist-based bulk/interrupt I/O request | |
337 | * @io: request block being initialized. until usb_sg_wait() returns, | |
338 | * treat this as a pointer to an opaque block of memory, | |
339 | * @dev: the usb device that will send or receive the data | |
340 | * @pipe: endpoint "pipe" used to transfer the data | |
341 | * @period: polling rate for interrupt endpoints, in frames or | |
342 | * (for high speed endpoints) microframes; ignored for bulk | |
343 | * @sg: scatterlist entries | |
344 | * @nents: how many entries in the scatterlist | |
345 | * @length: how many bytes to send from the scatterlist, or zero to | |
346 | * send every byte identified in the list. | |
347 | * @mem_flags: SLAB_* flags affecting memory allocations in this call | |
348 | * | |
626f090c YB |
349 | * This initializes a scatter/gather request, allocating resources such as |
350 | * I/O mappings and urb memory (except maybe memory used by USB controller | |
351 | * drivers). | |
1da177e4 LT |
352 | * |
353 | * The request must be issued using usb_sg_wait(), which waits for the I/O to | |
354 | * complete (or to be canceled) and then cleans up all resources allocated by | |
355 | * usb_sg_init(). | |
356 | * | |
357 | * The request may be canceled with usb_sg_cancel(), either before or after | |
358 | * usb_sg_wait() is called. | |
626f090c YB |
359 | * |
360 | * Return: Zero for success, else a negative errno value. | |
1da177e4 | 361 | */ |
3e35bf39 GKH |
362 | int usb_sg_init(struct usb_sg_request *io, struct usb_device *dev, |
363 | unsigned pipe, unsigned period, struct scatterlist *sg, | |
364 | int nents, size_t length, gfp_t mem_flags) | |
1da177e4 | 365 | { |
3e35bf39 GKH |
366 | int i; |
367 | int urb_flags; | |
e04748e3 | 368 | int use_sg; |
1da177e4 LT |
369 | |
370 | if (!io || !dev || !sg | |
3e35bf39 GKH |
371 | || usb_pipecontrol(pipe) |
372 | || usb_pipeisoc(pipe) | |
1da177e4 LT |
373 | || nents <= 0) |
374 | return -EINVAL; | |
375 | ||
3e35bf39 | 376 | spin_lock_init(&io->lock); |
1da177e4 LT |
377 | io->dev = dev; |
378 | io->pipe = pipe; | |
1da177e4 | 379 | |
4c1bd3d7 | 380 | if (dev->bus->sg_tablesize > 0) { |
e04748e3 | 381 | use_sg = true; |
0ba169af | 382 | io->entries = 1; |
e04748e3 | 383 | } else { |
e04748e3 | 384 | use_sg = false; |
0ba169af | 385 | io->entries = nents; |
e04748e3 | 386 | } |
0ba169af AS |
387 | |
388 | /* initialize all the urbs we'll use */ | |
a1fefaab | 389 | io->urbs = kmalloc(io->entries * sizeof(*io->urbs), mem_flags); |
1da177e4 LT |
390 | if (!io->urbs) |
391 | goto nomem; | |
392 | ||
0ba169af | 393 | urb_flags = URB_NO_INTERRUPT; |
3e35bf39 | 394 | if (usb_pipein(pipe)) |
1da177e4 LT |
395 | urb_flags |= URB_SHORT_NOT_OK; |
396 | ||
0ba169af AS |
397 | for_each_sg(sg, sg, io->entries, i) { |
398 | struct urb *urb; | |
399 | unsigned len; | |
ff9c895f | 400 | |
0ba169af AS |
401 | urb = usb_alloc_urb(0, mem_flags); |
402 | if (!urb) { | |
403 | io->entries = i; | |
404 | goto nomem; | |
e04748e3 | 405 | } |
0ba169af AS |
406 | io->urbs[i] = urb; |
407 | ||
408 | urb->dev = NULL; | |
409 | urb->pipe = pipe; | |
410 | urb->interval = period; | |
411 | urb->transfer_flags = urb_flags; | |
412 | urb->complete = sg_complete; | |
413 | urb->context = io; | |
414 | urb->sg = sg; | |
415 | ||
416 | if (use_sg) { | |
417 | /* There is no single transfer buffer */ | |
418 | urb->transfer_buffer = NULL; | |
419 | urb->num_sgs = nents; | |
420 | ||
421 | /* A length of zero means transfer the whole sg list */ | |
422 | len = length; | |
423 | if (len == 0) { | |
64d65872 AS |
424 | struct scatterlist *sg2; |
425 | int j; | |
426 | ||
427 | for_each_sg(sg, sg2, nents, j) | |
428 | len += sg2->length; | |
e04748e3 | 429 | } |
0ba169af | 430 | } else { |
e04748e3 | 431 | /* |
ff9c895f AS |
432 | * Some systems can't use DMA; they use PIO instead. |
433 | * For their sakes, transfer_buffer is set whenever | |
434 | * possible. | |
e04748e3 | 435 | */ |
ff9c895f | 436 | if (!PageHighMem(sg_page(sg))) |
0ba169af | 437 | urb->transfer_buffer = sg_virt(sg); |
81bf46f3 | 438 | else |
0ba169af | 439 | urb->transfer_buffer = NULL; |
81bf46f3 | 440 | |
ff9c895f | 441 | len = sg->length; |
e04748e3 | 442 | if (length) { |
edb2b255 | 443 | len = min_t(size_t, len, length); |
e04748e3 SS |
444 | length -= len; |
445 | if (length == 0) | |
446 | io->entries = i + 1; | |
447 | } | |
1da177e4 | 448 | } |
0ba169af | 449 | urb->transfer_buffer_length = len; |
1da177e4 | 450 | } |
0ba169af | 451 | io->urbs[--i]->transfer_flags &= ~URB_NO_INTERRUPT; |
1da177e4 LT |
452 | |
453 | /* transaction state */ | |
580da348 | 454 | io->count = io->entries; |
1da177e4 LT |
455 | io->status = 0; |
456 | io->bytes = 0; | |
3e35bf39 | 457 | init_completion(&io->complete); |
1da177e4 LT |
458 | return 0; |
459 | ||
460 | nomem: | |
3e35bf39 | 461 | sg_clean(io); |
1da177e4 LT |
462 | return -ENOMEM; |
463 | } | |
782e70c6 | 464 | EXPORT_SYMBOL_GPL(usb_sg_init); |
1da177e4 LT |
465 | |
466 | /** | |
467 | * usb_sg_wait - synchronously execute scatter/gather request | |
468 | * @io: request block handle, as initialized with usb_sg_init(). | |
469 | * some fields become accessible when this call returns. | |
470 | * Context: !in_interrupt () | |
471 | * | |
472 | * This function blocks until the specified I/O operation completes. It | |
473 | * leverages the grouping of the related I/O requests to get good transfer | |
474 | * rates, by queueing the requests. At higher speeds, such queuing can | |
475 | * significantly improve USB throughput. | |
476 | * | |
477 | * There are three kinds of completion for this function. | |
e0c34e90 | 478 | * |
1da177e4 LT |
479 | * (1) success, where io->status is zero. The number of io->bytes |
480 | * transferred is as requested. | |
481 | * (2) error, where io->status is a negative errno value. The number | |
482 | * of io->bytes transferred before the error is usually less | |
483 | * than requested, and can be nonzero. | |
093cf723 | 484 | * (3) cancellation, a type of error with status -ECONNRESET that |
1da177e4 LT |
485 | * is initiated by usb_sg_cancel(). |
486 | * | |
487 | * When this function returns, all memory allocated through usb_sg_init() or | |
488 | * this call will have been freed. The request block parameter may still be | |
489 | * passed to usb_sg_cancel(), or it may be freed. It could also be | |
490 | * reinitialized and then reused. | |
491 | * | |
492 | * Data Transfer Rates: | |
493 | * | |
494 | * Bulk transfers are valid for full or high speed endpoints. | |
495 | * The best full speed data rate is 19 packets of 64 bytes each | |
496 | * per frame, or 1216 bytes per millisecond. | |
497 | * The best high speed data rate is 13 packets of 512 bytes each | |
498 | * per microframe, or 52 KBytes per millisecond. | |
499 | * | |
500 | * The reason to use interrupt transfers through this API would most likely | |
501 | * be to reserve high speed bandwidth, where up to 24 KBytes per millisecond | |
502 | * could be transferred. That capability is less useful for low or full | |
503 | * speed interrupt endpoints, which allow at most one packet per millisecond, | |
504 | * of at most 8 or 64 bytes (respectively). | |
79abb1ab SS |
505 | * |
506 | * It is not necessary to call this function to reserve bandwidth for devices | |
507 | * under an xHCI host controller, as the bandwidth is reserved when the | |
508 | * configuration or interface alt setting is selected. | |
1da177e4 | 509 | */ |
3e35bf39 | 510 | void usb_sg_wait(struct usb_sg_request *io) |
1da177e4 | 511 | { |
3e35bf39 GKH |
512 | int i; |
513 | int entries = io->entries; | |
1da177e4 LT |
514 | |
515 | /* queue the urbs. */ | |
3e35bf39 | 516 | spin_lock_irq(&io->lock); |
8ccef0df AS |
517 | i = 0; |
518 | while (i < entries && !io->status) { | |
3e35bf39 | 519 | int retval; |
1da177e4 | 520 | |
3e35bf39 | 521 | io->urbs[i]->dev = io->dev; |
3e35bf39 | 522 | spin_unlock_irq(&io->lock); |
98b74b0e DM |
523 | |
524 | retval = usb_submit_urb(io->urbs[i], GFP_NOIO); | |
525 | ||
1da177e4 LT |
526 | switch (retval) { |
527 | /* maybe we retrying will recover */ | |
3e35bf39 | 528 | case -ENXIO: /* hc didn't queue this one */ |
1da177e4 LT |
529 | case -EAGAIN: |
530 | case -ENOMEM: | |
1da177e4 | 531 | retval = 0; |
3e35bf39 | 532 | yield(); |
1da177e4 LT |
533 | break; |
534 | ||
535 | /* no error? continue immediately. | |
536 | * | |
537 | * NOTE: to work better with UHCI (4K I/O buffer may | |
538 | * need 3K of TDs) it may be good to limit how many | |
539 | * URBs are queued at once; N milliseconds? | |
540 | */ | |
541 | case 0: | |
8ccef0df | 542 | ++i; |
3e35bf39 | 543 | cpu_relax(); |
1da177e4 LT |
544 | break; |
545 | ||
546 | /* fail any uncompleted urbs */ | |
547 | default: | |
3e35bf39 GKH |
548 | io->urbs[i]->status = retval; |
549 | dev_dbg(&io->dev->dev, "%s, submit --> %d\n", | |
441b62c1 | 550 | __func__, retval); |
3e35bf39 | 551 | usb_sg_cancel(io); |
1da177e4 | 552 | } |
3e35bf39 | 553 | spin_lock_irq(&io->lock); |
1da177e4 LT |
554 | if (retval && (io->status == 0 || io->status == -ECONNRESET)) |
555 | io->status = retval; | |
556 | } | |
557 | io->count -= entries - i; | |
558 | if (io->count == 0) | |
3e35bf39 GKH |
559 | complete(&io->complete); |
560 | spin_unlock_irq(&io->lock); | |
1da177e4 LT |
561 | |
562 | /* OK, yes, this could be packaged as non-blocking. | |
563 | * So could the submit loop above ... but it's easier to | |
564 | * solve neither problem than to solve both! | |
565 | */ | |
3e35bf39 | 566 | wait_for_completion(&io->complete); |
1da177e4 | 567 | |
3e35bf39 | 568 | sg_clean(io); |
1da177e4 | 569 | } |
782e70c6 | 570 | EXPORT_SYMBOL_GPL(usb_sg_wait); |
1da177e4 LT |
571 | |
572 | /** | |
573 | * usb_sg_cancel - stop scatter/gather i/o issued by usb_sg_wait() | |
574 | * @io: request block, initialized with usb_sg_init() | |
575 | * | |
576 | * This stops a request after it has been started by usb_sg_wait(). | |
577 | * It can also prevents one initialized by usb_sg_init() from starting, | |
578 | * so that call just frees resources allocated to the request. | |
579 | */ | |
3e35bf39 | 580 | void usb_sg_cancel(struct usb_sg_request *io) |
1da177e4 | 581 | { |
3e35bf39 | 582 | unsigned long flags; |
5f2e5fb8 | 583 | int i, retval; |
1da177e4 | 584 | |
3e35bf39 | 585 | spin_lock_irqsave(&io->lock, flags); |
5f2e5fb8 DM |
586 | if (io->status) { |
587 | spin_unlock_irqrestore(&io->lock, flags); | |
588 | return; | |
589 | } | |
590 | /* shut everything down */ | |
591 | io->status = -ECONNRESET; | |
592 | spin_unlock_irqrestore(&io->lock, flags); | |
1da177e4 | 593 | |
5f2e5fb8 DM |
594 | for (i = io->entries - 1; i >= 0; --i) { |
595 | usb_block_urb(io->urbs[i]); | |
1da177e4 | 596 | |
5f2e5fb8 DM |
597 | retval = usb_unlink_urb(io->urbs[i]); |
598 | if (retval != -EINPROGRESS | |
599 | && retval != -ENODEV | |
600 | && retval != -EBUSY | |
601 | && retval != -EIDRM) | |
602 | dev_warn(&io->dev->dev, "%s, unlink --> %d\n", | |
603 | __func__, retval); | |
1da177e4 | 604 | } |
1da177e4 | 605 | } |
782e70c6 | 606 | EXPORT_SYMBOL_GPL(usb_sg_cancel); |
1da177e4 LT |
607 | |
608 | /*-------------------------------------------------------------------*/ | |
609 | ||
610 | /** | |
611 | * usb_get_descriptor - issues a generic GET_DESCRIPTOR request | |
612 | * @dev: the device whose descriptor is being retrieved | |
613 | * @type: the descriptor type (USB_DT_*) | |
614 | * @index: the number of the descriptor | |
615 | * @buf: where to put the descriptor | |
616 | * @size: how big is "buf"? | |
617 | * Context: !in_interrupt () | |
618 | * | |
619 | * Gets a USB descriptor. Convenience functions exist to simplify | |
620 | * getting some types of descriptors. Use | |
621 | * usb_get_string() or usb_string() for USB_DT_STRING. | |
622 | * Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG) | |
623 | * are part of the device structure. | |
624 | * In addition to a number of USB-standard descriptors, some | |
625 | * devices also use class-specific or vendor-specific descriptors. | |
626 | * | |
627 | * This call is synchronous, and may not be used in an interrupt context. | |
628 | * | |
626f090c | 629 | * Return: The number of bytes received on success, or else the status code |
1da177e4 LT |
630 | * returned by the underlying usb_control_msg() call. |
631 | */ | |
3e35bf39 GKH |
632 | int usb_get_descriptor(struct usb_device *dev, unsigned char type, |
633 | unsigned char index, void *buf, int size) | |
1da177e4 LT |
634 | { |
635 | int i; | |
636 | int result; | |
3e35bf39 GKH |
637 | |
638 | memset(buf, 0, size); /* Make sure we parse really received data */ | |
1da177e4 LT |
639 | |
640 | for (i = 0; i < 3; ++i) { | |
c39772d8 | 641 | /* retry on length 0 or error; some devices are flakey */ |
1da177e4 LT |
642 | result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), |
643 | USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, | |
644 | (type << 8) + index, 0, buf, size, | |
645 | USB_CTRL_GET_TIMEOUT); | |
c39772d8 | 646 | if (result <= 0 && result != -ETIMEDOUT) |
1da177e4 LT |
647 | continue; |
648 | if (result > 1 && ((u8 *)buf)[1] != type) { | |
67f5a4ba | 649 | result = -ENODATA; |
1da177e4 LT |
650 | continue; |
651 | } | |
652 | break; | |
653 | } | |
654 | return result; | |
655 | } | |
782e70c6 | 656 | EXPORT_SYMBOL_GPL(usb_get_descriptor); |
1da177e4 LT |
657 | |
658 | /** | |
659 | * usb_get_string - gets a string descriptor | |
660 | * @dev: the device whose string descriptor is being retrieved | |
661 | * @langid: code for language chosen (from string descriptor zero) | |
662 | * @index: the number of the descriptor | |
663 | * @buf: where to put the string | |
664 | * @size: how big is "buf"? | |
665 | * Context: !in_interrupt () | |
666 | * | |
667 | * Retrieves a string, encoded using UTF-16LE (Unicode, 16 bits per character, | |
668 | * in little-endian byte order). | |
669 | * The usb_string() function will often be a convenient way to turn | |
670 | * these strings into kernel-printable form. | |
671 | * | |
672 | * Strings may be referenced in device, configuration, interface, or other | |
673 | * descriptors, and could also be used in vendor-specific ways. | |
674 | * | |
675 | * This call is synchronous, and may not be used in an interrupt context. | |
676 | * | |
626f090c | 677 | * Return: The number of bytes received on success, or else the status code |
1da177e4 LT |
678 | * returned by the underlying usb_control_msg() call. |
679 | */ | |
e266a124 AB |
680 | static int usb_get_string(struct usb_device *dev, unsigned short langid, |
681 | unsigned char index, void *buf, int size) | |
1da177e4 LT |
682 | { |
683 | int i; | |
684 | int result; | |
685 | ||
686 | for (i = 0; i < 3; ++i) { | |
687 | /* retry on length 0 or stall; some devices are flakey */ | |
688 | result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), | |
689 | USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, | |
690 | (USB_DT_STRING << 8) + index, langid, buf, size, | |
691 | USB_CTRL_GET_TIMEOUT); | |
67f5a4ba AS |
692 | if (result == 0 || result == -EPIPE) |
693 | continue; | |
694 | if (result > 1 && ((u8 *) buf)[1] != USB_DT_STRING) { | |
695 | result = -ENODATA; | |
696 | continue; | |
697 | } | |
698 | break; | |
1da177e4 LT |
699 | } |
700 | return result; | |
701 | } | |
702 | ||
703 | static void usb_try_string_workarounds(unsigned char *buf, int *length) | |
704 | { | |
705 | int newlength, oldlength = *length; | |
706 | ||
707 | for (newlength = 2; newlength + 1 < oldlength; newlength += 2) | |
708 | if (!isprint(buf[newlength]) || buf[newlength + 1]) | |
709 | break; | |
710 | ||
711 | if (newlength > 2) { | |
712 | buf[0] = newlength; | |
713 | *length = newlength; | |
714 | } | |
715 | } | |
716 | ||
717 | static int usb_string_sub(struct usb_device *dev, unsigned int langid, | |
3e35bf39 | 718 | unsigned int index, unsigned char *buf) |
1da177e4 LT |
719 | { |
720 | int rc; | |
721 | ||
722 | /* Try to read the string descriptor by asking for the maximum | |
723 | * possible number of bytes */ | |
7ceec1f1 ON |
724 | if (dev->quirks & USB_QUIRK_STRING_FETCH_255) |
725 | rc = -EIO; | |
726 | else | |
727 | rc = usb_get_string(dev, langid, index, buf, 255); | |
1da177e4 LT |
728 | |
729 | /* If that failed try to read the descriptor length, then | |
730 | * ask for just that many bytes */ | |
731 | if (rc < 2) { | |
732 | rc = usb_get_string(dev, langid, index, buf, 2); | |
733 | if (rc == 2) | |
734 | rc = usb_get_string(dev, langid, index, buf, buf[0]); | |
735 | } | |
736 | ||
737 | if (rc >= 2) { | |
738 | if (!buf[0] && !buf[1]) | |
739 | usb_try_string_workarounds(buf, &rc); | |
740 | ||
741 | /* There might be extra junk at the end of the descriptor */ | |
742 | if (buf[0] < rc) | |
743 | rc = buf[0]; | |
744 | ||
745 | rc = rc - (rc & 1); /* force a multiple of two */ | |
746 | } | |
747 | ||
748 | if (rc < 2) | |
749 | rc = (rc < 0 ? rc : -EINVAL); | |
750 | ||
751 | return rc; | |
752 | } | |
753 | ||
0cce2eda DM |
754 | static int usb_get_langid(struct usb_device *dev, unsigned char *tbuf) |
755 | { | |
756 | int err; | |
757 | ||
758 | if (dev->have_langid) | |
759 | return 0; | |
760 | ||
761 | if (dev->string_langid < 0) | |
762 | return -EPIPE; | |
763 | ||
764 | err = usb_string_sub(dev, 0, 0, tbuf); | |
765 | ||
766 | /* If the string was reported but is malformed, default to english | |
767 | * (0x0409) */ | |
768 | if (err == -ENODATA || (err > 0 && err < 4)) { | |
769 | dev->string_langid = 0x0409; | |
770 | dev->have_langid = 1; | |
771 | dev_err(&dev->dev, | |
586af079 | 772 | "language id specifier not provided by device, defaulting to English\n"); |
0cce2eda DM |
773 | return 0; |
774 | } | |
775 | ||
776 | /* In case of all other errors, we assume the device is not able to | |
777 | * deal with strings at all. Set string_langid to -1 in order to | |
778 | * prevent any string to be retrieved from the device */ | |
779 | if (err < 0) { | |
2124c888 | 780 | dev_info(&dev->dev, "string descriptor 0 read error: %d\n", |
0cce2eda DM |
781 | err); |
782 | dev->string_langid = -1; | |
783 | return -EPIPE; | |
784 | } | |
785 | ||
786 | /* always use the first langid listed */ | |
787 | dev->string_langid = tbuf[2] | (tbuf[3] << 8); | |
788 | dev->have_langid = 1; | |
789 | dev_dbg(&dev->dev, "default language 0x%04x\n", | |
790 | dev->string_langid); | |
791 | return 0; | |
792 | } | |
793 | ||
1da177e4 | 794 | /** |
a853a3d4 | 795 | * usb_string - returns UTF-8 version of a string descriptor |
1da177e4 LT |
796 | * @dev: the device whose string descriptor is being retrieved |
797 | * @index: the number of the descriptor | |
798 | * @buf: where to put the string | |
799 | * @size: how big is "buf"? | |
800 | * Context: !in_interrupt () | |
3e35bf39 | 801 | * |
1da177e4 | 802 | * This converts the UTF-16LE encoded strings returned by devices, from |
a853a3d4 CL |
803 | * usb_get_string_descriptor(), to null-terminated UTF-8 encoded ones |
804 | * that are more usable in most kernel contexts. Note that this function | |
1da177e4 LT |
805 | * chooses strings in the first language supported by the device. |
806 | * | |
1da177e4 LT |
807 | * This call is synchronous, and may not be used in an interrupt context. |
808 | * | |
626f090c | 809 | * Return: length of the string (>= 0) or usb_control_msg status (< 0). |
1da177e4 LT |
810 | */ |
811 | int usb_string(struct usb_device *dev, int index, char *buf, size_t size) | |
812 | { | |
813 | unsigned char *tbuf; | |
814 | int err; | |
1da177e4 LT |
815 | |
816 | if (dev->state == USB_STATE_SUSPENDED) | |
817 | return -EHOSTUNREACH; | |
818 | if (size <= 0 || !buf || !index) | |
819 | return -EINVAL; | |
820 | buf[0] = 0; | |
74675a58 | 821 | tbuf = kmalloc(256, GFP_NOIO); |
1da177e4 LT |
822 | if (!tbuf) |
823 | return -ENOMEM; | |
824 | ||
0cce2eda DM |
825 | err = usb_get_langid(dev, tbuf); |
826 | if (err < 0) | |
827 | goto errout; | |
3e35bf39 | 828 | |
1da177e4 LT |
829 | err = usb_string_sub(dev, dev->string_langid, index, tbuf); |
830 | if (err < 0) | |
831 | goto errout; | |
832 | ||
833 | size--; /* leave room for trailing NULL char in output buffer */ | |
74675a58 AS |
834 | err = utf16s_to_utf8s((wchar_t *) &tbuf[2], (err - 2) / 2, |
835 | UTF16_LITTLE_ENDIAN, buf, size); | |
a853a3d4 | 836 | buf[err] = 0; |
1da177e4 LT |
837 | |
838 | if (tbuf[1] != USB_DT_STRING) | |
3e35bf39 GKH |
839 | dev_dbg(&dev->dev, |
840 | "wrong descriptor type %02x for string %d (\"%s\")\n", | |
841 | tbuf[1], index, buf); | |
1da177e4 LT |
842 | |
843 | errout: | |
844 | kfree(tbuf); | |
845 | return err; | |
846 | } | |
782e70c6 | 847 | EXPORT_SYMBOL_GPL(usb_string); |
1da177e4 | 848 | |
a853a3d4 CL |
849 | /* one UTF-8-encoded 16-bit character has at most three bytes */ |
850 | #define MAX_USB_STRING_SIZE (127 * 3 + 1) | |
851 | ||
4f62efe6 AS |
852 | /** |
853 | * usb_cache_string - read a string descriptor and cache it for later use | |
854 | * @udev: the device whose string descriptor is being read | |
855 | * @index: the descriptor index | |
856 | * | |
626f090c YB |
857 | * Return: A pointer to a kmalloc'ed buffer containing the descriptor string, |
858 | * or %NULL if the index is 0 or the string could not be read. | |
4f62efe6 AS |
859 | */ |
860 | char *usb_cache_string(struct usb_device *udev, int index) | |
861 | { | |
862 | char *buf; | |
863 | char *smallbuf = NULL; | |
864 | int len; | |
865 | ||
3e35bf39 GKH |
866 | if (index <= 0) |
867 | return NULL; | |
868 | ||
acbe2feb | 869 | buf = kmalloc(MAX_USB_STRING_SIZE, GFP_NOIO); |
3e35bf39 | 870 | if (buf) { |
a853a3d4 | 871 | len = usb_string(udev, index, buf, MAX_USB_STRING_SIZE); |
3e35bf39 | 872 | if (len > 0) { |
acbe2feb | 873 | smallbuf = kmalloc(++len, GFP_NOIO); |
3e35bf39 | 874 | if (!smallbuf) |
4f62efe6 AS |
875 | return buf; |
876 | memcpy(smallbuf, buf, len); | |
877 | } | |
878 | kfree(buf); | |
879 | } | |
880 | return smallbuf; | |
881 | } | |
882 | ||
1da177e4 LT |
883 | /* |
884 | * usb_get_device_descriptor - (re)reads the device descriptor (usbcore) | |
885 | * @dev: the device whose device descriptor is being updated | |
886 | * @size: how much of the descriptor to read | |
887 | * Context: !in_interrupt () | |
888 | * | |
889 | * Updates the copy of the device descriptor stored in the device structure, | |
6ab16a90 | 890 | * which dedicates space for this purpose. |
1da177e4 LT |
891 | * |
892 | * Not exported, only for use by the core. If drivers really want to read | |
893 | * the device descriptor directly, they can call usb_get_descriptor() with | |
894 | * type = USB_DT_DEVICE and index = 0. | |
895 | * | |
896 | * This call is synchronous, and may not be used in an interrupt context. | |
897 | * | |
626f090c | 898 | * Return: The number of bytes received on success, or else the status code |
1da177e4 LT |
899 | * returned by the underlying usb_control_msg() call. |
900 | */ | |
901 | int usb_get_device_descriptor(struct usb_device *dev, unsigned int size) | |
902 | { | |
903 | struct usb_device_descriptor *desc; | |
904 | int ret; | |
905 | ||
906 | if (size > sizeof(*desc)) | |
907 | return -EINVAL; | |
908 | desc = kmalloc(sizeof(*desc), GFP_NOIO); | |
909 | if (!desc) | |
910 | return -ENOMEM; | |
911 | ||
912 | ret = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, size); | |
3e35bf39 | 913 | if (ret >= 0) |
1da177e4 LT |
914 | memcpy(&dev->descriptor, desc, size); |
915 | kfree(desc); | |
916 | return ret; | |
917 | } | |
918 | ||
919 | /** | |
920 | * usb_get_status - issues a GET_STATUS call | |
921 | * @dev: the device whose status is being checked | |
3c377ef1 | 922 | * @recip: USB_RECIP_*; for device, interface, or endpoint |
2e43f0fe | 923 | * @type: USB_STATUS_TYPE_*; for standard or PTM status types |
1da177e4 LT |
924 | * @target: zero (for device), else interface or endpoint number |
925 | * @data: pointer to two bytes of bitmap data | |
926 | * Context: !in_interrupt () | |
927 | * | |
928 | * Returns device, interface, or endpoint status. Normally only of | |
929 | * interest to see if the device is self powered, or has enabled the | |
930 | * remote wakeup facility; or whether a bulk or interrupt endpoint | |
931 | * is halted ("stalled"). | |
932 | * | |
933 | * Bits in these status bitmaps are set using the SET_FEATURE request, | |
934 | * and cleared using the CLEAR_FEATURE request. The usb_clear_halt() | |
935 | * function should be used to clear halt ("stall") status. | |
936 | * | |
937 | * This call is synchronous, and may not be used in an interrupt context. | |
938 | * | |
15b7336e AS |
939 | * Returns 0 and the status value in *@data (in host byte order) on success, |
940 | * or else the status code from the underlying usb_control_msg() call. | |
1da177e4 | 941 | */ |
2e43f0fe FB |
942 | int usb_get_status(struct usb_device *dev, int recip, int type, int target, |
943 | void *data) | |
1da177e4 LT |
944 | { |
945 | int ret; | |
2e43f0fe FB |
946 | void *status; |
947 | int length; | |
948 | ||
949 | switch (type) { | |
950 | case USB_STATUS_TYPE_STANDARD: | |
951 | length = 2; | |
952 | break; | |
953 | case USB_STATUS_TYPE_PTM: | |
954 | if (recip != USB_RECIP_DEVICE) | |
955 | return -EINVAL; | |
956 | ||
957 | length = 4; | |
958 | break; | |
959 | default: | |
960 | return -EINVAL; | |
961 | } | |
1da177e4 | 962 | |
2e43f0fe | 963 | status = kmalloc(length, GFP_KERNEL); |
1da177e4 LT |
964 | if (!status) |
965 | return -ENOMEM; | |
966 | ||
967 | ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), | |
3c377ef1 | 968 | USB_REQ_GET_STATUS, USB_DIR_IN | recip, USB_STATUS_TYPE_STANDARD, |
2e43f0fe FB |
969 | target, status, length, USB_CTRL_GET_TIMEOUT); |
970 | ||
971 | switch (ret) { | |
972 | case 4: | |
973 | if (type != USB_STATUS_TYPE_PTM) { | |
974 | ret = -EIO; | |
975 | break; | |
976 | } | |
977 | ||
978 | *(u32 *) data = le32_to_cpu(*(__le32 *) status); | |
d656fa32 | 979 | ret = 0; |
2e43f0fe FB |
980 | break; |
981 | case 2: | |
982 | if (type != USB_STATUS_TYPE_STANDARD) { | |
983 | ret = -EIO; | |
984 | break; | |
985 | } | |
1da177e4 | 986 | |
2e43f0fe | 987 | *(u16 *) data = le16_to_cpu(*(__le16 *) status); |
d656fa32 | 988 | ret = 0; |
2e43f0fe FB |
989 | break; |
990 | default: | |
15b7336e AS |
991 | ret = -EIO; |
992 | } | |
2e43f0fe | 993 | |
1da177e4 LT |
994 | kfree(status); |
995 | return ret; | |
996 | } | |
782e70c6 | 997 | EXPORT_SYMBOL_GPL(usb_get_status); |
1da177e4 LT |
998 | |
999 | /** | |
1000 | * usb_clear_halt - tells device to clear endpoint halt/stall condition | |
1001 | * @dev: device whose endpoint is halted | |
1002 | * @pipe: endpoint "pipe" being cleared | |
1003 | * Context: !in_interrupt () | |
1004 | * | |
1005 | * This is used to clear halt conditions for bulk and interrupt endpoints, | |
1006 | * as reported by URB completion status. Endpoints that are halted are | |
1007 | * sometimes referred to as being "stalled". Such endpoints are unable | |
1008 | * to transmit or receive data until the halt status is cleared. Any URBs | |
1009 | * queued for such an endpoint should normally be unlinked by the driver | |
1010 | * before clearing the halt condition, as described in sections 5.7.5 | |
1011 | * and 5.8.5 of the USB 2.0 spec. | |
1012 | * | |
1013 | * Note that control and isochronous endpoints don't halt, although control | |
1014 | * endpoints report "protocol stall" (for unsupported requests) using the | |
1015 | * same status code used to report a true stall. | |
1016 | * | |
1017 | * This call is synchronous, and may not be used in an interrupt context. | |
1018 | * | |
626f090c | 1019 | * Return: Zero on success, or else the status code returned by the |
1da177e4 LT |
1020 | * underlying usb_control_msg() call. |
1021 | */ | |
1022 | int usb_clear_halt(struct usb_device *dev, int pipe) | |
1023 | { | |
1024 | int result; | |
1025 | int endp = usb_pipeendpoint(pipe); | |
3e35bf39 GKH |
1026 | |
1027 | if (usb_pipein(pipe)) | |
1da177e4 LT |
1028 | endp |= USB_DIR_IN; |
1029 | ||
1030 | /* we don't care if it wasn't halted first. in fact some devices | |
1031 | * (like some ibmcam model 1 units) seem to expect hosts to make | |
1032 | * this request for iso endpoints, which can't halt! | |
1033 | */ | |
1034 | result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), | |
1035 | USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, | |
1036 | USB_ENDPOINT_HALT, endp, NULL, 0, | |
1037 | USB_CTRL_SET_TIMEOUT); | |
1038 | ||
1039 | /* don't un-halt or force to DATA0 except on success */ | |
1040 | if (result < 0) | |
1041 | return result; | |
1042 | ||
1043 | /* NOTE: seems like Microsoft and Apple don't bother verifying | |
1044 | * the clear "took", so some devices could lock up if you check... | |
1045 | * such as the Hagiwara FlashGate DUAL. So we won't bother. | |
1046 | * | |
1047 | * NOTE: make sure the logic here doesn't diverge much from | |
1048 | * the copy in usb-storage, for as long as we need two copies. | |
1049 | */ | |
1050 | ||
3444b26a | 1051 | usb_reset_endpoint(dev, endp); |
1da177e4 LT |
1052 | |
1053 | return 0; | |
1054 | } | |
782e70c6 | 1055 | EXPORT_SYMBOL_GPL(usb_clear_halt); |
1da177e4 | 1056 | |
3b23dd6f AS |
1057 | static int create_intf_ep_devs(struct usb_interface *intf) |
1058 | { | |
1059 | struct usb_device *udev = interface_to_usbdev(intf); | |
1060 | struct usb_host_interface *alt = intf->cur_altsetting; | |
1061 | int i; | |
1062 | ||
1063 | if (intf->ep_devs_created || intf->unregistering) | |
1064 | return 0; | |
1065 | ||
1066 | for (i = 0; i < alt->desc.bNumEndpoints; ++i) | |
1067 | (void) usb_create_ep_devs(&intf->dev, &alt->endpoint[i], udev); | |
1068 | intf->ep_devs_created = 1; | |
1069 | return 0; | |
1070 | } | |
1071 | ||
1072 | static void remove_intf_ep_devs(struct usb_interface *intf) | |
1073 | { | |
1074 | struct usb_host_interface *alt = intf->cur_altsetting; | |
1075 | int i; | |
1076 | ||
1077 | if (!intf->ep_devs_created) | |
1078 | return; | |
1079 | ||
1080 | for (i = 0; i < alt->desc.bNumEndpoints; ++i) | |
1081 | usb_remove_ep_devs(&alt->endpoint[i]); | |
1082 | intf->ep_devs_created = 0; | |
1083 | } | |
1084 | ||
1da177e4 LT |
1085 | /** |
1086 | * usb_disable_endpoint -- Disable an endpoint by address | |
1087 | * @dev: the device whose endpoint is being disabled | |
1088 | * @epaddr: the endpoint's address. Endpoint number for output, | |
1089 | * endpoint number + USB_DIR_IN for input | |
ddeac4e7 AS |
1090 | * @reset_hardware: flag to erase any endpoint state stored in the |
1091 | * controller hardware | |
1da177e4 | 1092 | * |
ddeac4e7 AS |
1093 | * Disables the endpoint for URB submission and nukes all pending URBs. |
1094 | * If @reset_hardware is set then also deallocates hcd/hardware state | |
1095 | * for the endpoint. | |
1da177e4 | 1096 | */ |
ddeac4e7 AS |
1097 | void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr, |
1098 | bool reset_hardware) | |
1da177e4 LT |
1099 | { |
1100 | unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK; | |
1101 | struct usb_host_endpoint *ep; | |
1102 | ||
1103 | if (!dev) | |
1104 | return; | |
1105 | ||
1106 | if (usb_endpoint_out(epaddr)) { | |
1107 | ep = dev->ep_out[epnum]; | |
ddeac4e7 AS |
1108 | if (reset_hardware) |
1109 | dev->ep_out[epnum] = NULL; | |
1da177e4 LT |
1110 | } else { |
1111 | ep = dev->ep_in[epnum]; | |
ddeac4e7 AS |
1112 | if (reset_hardware) |
1113 | dev->ep_in[epnum] = NULL; | |
1da177e4 | 1114 | } |
bdd016ba AS |
1115 | if (ep) { |
1116 | ep->enabled = 0; | |
95cf82f9 | 1117 | usb_hcd_flush_endpoint(dev, ep); |
ddeac4e7 AS |
1118 | if (reset_hardware) |
1119 | usb_hcd_disable_endpoint(dev, ep); | |
bdd016ba | 1120 | } |
1da177e4 LT |
1121 | } |
1122 | ||
3444b26a DV |
1123 | /** |
1124 | * usb_reset_endpoint - Reset an endpoint's state. | |
1125 | * @dev: the device whose endpoint is to be reset | |
1126 | * @epaddr: the endpoint's address. Endpoint number for output, | |
1127 | * endpoint number + USB_DIR_IN for input | |
1128 | * | |
1129 | * Resets any host-side endpoint state such as the toggle bit, | |
1130 | * sequence number or current window. | |
1131 | */ | |
1132 | void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr) | |
1133 | { | |
1134 | unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK; | |
1135 | struct usb_host_endpoint *ep; | |
1136 | ||
1137 | if (usb_endpoint_out(epaddr)) | |
1138 | ep = dev->ep_out[epnum]; | |
1139 | else | |
1140 | ep = dev->ep_in[epnum]; | |
1141 | if (ep) | |
1142 | usb_hcd_reset_endpoint(dev, ep); | |
1143 | } | |
1144 | EXPORT_SYMBOL_GPL(usb_reset_endpoint); | |
1145 | ||
1146 | ||
1da177e4 LT |
1147 | /** |
1148 | * usb_disable_interface -- Disable all endpoints for an interface | |
1149 | * @dev: the device whose interface is being disabled | |
1150 | * @intf: pointer to the interface descriptor | |
ddeac4e7 AS |
1151 | * @reset_hardware: flag to erase any endpoint state stored in the |
1152 | * controller hardware | |
1da177e4 LT |
1153 | * |
1154 | * Disables all the endpoints for the interface's current altsetting. | |
1155 | */ | |
ddeac4e7 AS |
1156 | void usb_disable_interface(struct usb_device *dev, struct usb_interface *intf, |
1157 | bool reset_hardware) | |
1da177e4 LT |
1158 | { |
1159 | struct usb_host_interface *alt = intf->cur_altsetting; | |
1160 | int i; | |
1161 | ||
1162 | for (i = 0; i < alt->desc.bNumEndpoints; ++i) { | |
1163 | usb_disable_endpoint(dev, | |
ddeac4e7 AS |
1164 | alt->endpoint[i].desc.bEndpointAddress, |
1165 | reset_hardware); | |
1da177e4 LT |
1166 | } |
1167 | } | |
1168 | ||
3e35bf39 | 1169 | /** |
1da177e4 LT |
1170 | * usb_disable_device - Disable all the endpoints for a USB device |
1171 | * @dev: the device whose endpoints are being disabled | |
1172 | * @skip_ep0: 0 to disable endpoint 0, 1 to skip it. | |
1173 | * | |
1174 | * Disables all the device's endpoints, potentially including endpoint 0. | |
1175 | * Deallocates hcd/hardware state for the endpoints (nuking all or most | |
1176 | * pending urbs) and usbcore state for the interfaces, so that usbcore | |
1177 | * must usb_set_configuration() before any interfaces could be used. | |
1178 | */ | |
1179 | void usb_disable_device(struct usb_device *dev, int skip_ep0) | |
1180 | { | |
1181 | int i; | |
fccf4e86 | 1182 | struct usb_hcd *hcd = bus_to_hcd(dev->bus); |
1da177e4 | 1183 | |
1da177e4 LT |
1184 | /* getting rid of interfaces will disconnect |
1185 | * any drivers bound to them (a key side effect) | |
1186 | */ | |
1187 | if (dev->actconfig) { | |
ca5c485f AS |
1188 | /* |
1189 | * FIXME: In order to avoid self-deadlock involving the | |
1190 | * bandwidth_mutex, we have to mark all the interfaces | |
1191 | * before unregistering any of them. | |
1192 | */ | |
1193 | for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) | |
1194 | dev->actconfig->interface[i]->unregistering = 1; | |
1195 | ||
1da177e4 LT |
1196 | for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) { |
1197 | struct usb_interface *interface; | |
1198 | ||
86d30741 | 1199 | /* remove this interface if it has been registered */ |
1da177e4 | 1200 | interface = dev->actconfig->interface[i]; |
d305ef5d | 1201 | if (!device_is_registered(&interface->dev)) |
86d30741 | 1202 | continue; |
3e35bf39 | 1203 | dev_dbg(&dev->dev, "unregistering interface %s\n", |
7071a3ce | 1204 | dev_name(&interface->dev)); |
3b23dd6f | 1205 | remove_intf_ep_devs(interface); |
1a21175a | 1206 | device_del(&interface->dev); |
1da177e4 LT |
1207 | } |
1208 | ||
1209 | /* Now that the interfaces are unbound, nobody should | |
1210 | * try to access them. | |
1211 | */ | |
1212 | for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) { | |
3e35bf39 | 1213 | put_device(&dev->actconfig->interface[i]->dev); |
1da177e4 LT |
1214 | dev->actconfig->interface[i] = NULL; |
1215 | } | |
f468f7b9 SS |
1216 | |
1217 | if (dev->usb2_hw_lpm_enabled == 1) | |
1218 | usb_set_usb2_hardware_lpm(dev, 0); | |
24971912 | 1219 | usb_unlocked_disable_lpm(dev); |
f74631e3 | 1220 | usb_disable_ltm(dev); |
f468f7b9 | 1221 | |
1da177e4 LT |
1222 | dev->actconfig = NULL; |
1223 | if (dev->state == USB_STATE_CONFIGURED) | |
1224 | usb_set_device_state(dev, USB_STATE_ADDRESS); | |
1225 | } | |
80f0cf39 AS |
1226 | |
1227 | dev_dbg(&dev->dev, "%s nuking %s URBs\n", __func__, | |
1228 | skip_ep0 ? "non-ep0" : "all"); | |
fccf4e86 SS |
1229 | if (hcd->driver->check_bandwidth) { |
1230 | /* First pass: Cancel URBs, leave endpoint pointers intact. */ | |
1231 | for (i = skip_ep0; i < 16; ++i) { | |
1232 | usb_disable_endpoint(dev, i, false); | |
1233 | usb_disable_endpoint(dev, i + USB_DIR_IN, false); | |
1234 | } | |
1235 | /* Remove endpoints from the host controller internal state */ | |
8963c487 | 1236 | mutex_lock(hcd->bandwidth_mutex); |
fccf4e86 | 1237 | usb_hcd_alloc_bandwidth(dev, NULL, NULL, NULL); |
8963c487 | 1238 | mutex_unlock(hcd->bandwidth_mutex); |
fccf4e86 SS |
1239 | /* Second pass: remove endpoint pointers */ |
1240 | } | |
80f0cf39 AS |
1241 | for (i = skip_ep0; i < 16; ++i) { |
1242 | usb_disable_endpoint(dev, i, true); | |
1243 | usb_disable_endpoint(dev, i + USB_DIR_IN, true); | |
1244 | } | |
1da177e4 LT |
1245 | } |
1246 | ||
3e35bf39 | 1247 | /** |
1da177e4 LT |
1248 | * usb_enable_endpoint - Enable an endpoint for USB communications |
1249 | * @dev: the device whose interface is being enabled | |
1250 | * @ep: the endpoint | |
3444b26a | 1251 | * @reset_ep: flag to reset the endpoint state |
1da177e4 | 1252 | * |
3444b26a | 1253 | * Resets the endpoint state if asked, and sets dev->ep_{in,out} pointers. |
1da177e4 LT |
1254 | * For control endpoints, both the input and output sides are handled. |
1255 | */ | |
2caf7fcd | 1256 | void usb_enable_endpoint(struct usb_device *dev, struct usb_host_endpoint *ep, |
3444b26a | 1257 | bool reset_ep) |
1da177e4 | 1258 | { |
bdd016ba AS |
1259 | int epnum = usb_endpoint_num(&ep->desc); |
1260 | int is_out = usb_endpoint_dir_out(&ep->desc); | |
1261 | int is_control = usb_endpoint_xfer_control(&ep->desc); | |
1da177e4 | 1262 | |
3444b26a DV |
1263 | if (reset_ep) |
1264 | usb_hcd_reset_endpoint(dev, ep); | |
1265 | if (is_out || is_control) | |
1da177e4 | 1266 | dev->ep_out[epnum] = ep; |
3444b26a | 1267 | if (!is_out || is_control) |
1da177e4 | 1268 | dev->ep_in[epnum] = ep; |
bdd016ba | 1269 | ep->enabled = 1; |
1da177e4 LT |
1270 | } |
1271 | ||
3e35bf39 | 1272 | /** |
1da177e4 LT |
1273 | * usb_enable_interface - Enable all the endpoints for an interface |
1274 | * @dev: the device whose interface is being enabled | |
1275 | * @intf: pointer to the interface descriptor | |
3444b26a | 1276 | * @reset_eps: flag to reset the endpoints' state |
1da177e4 LT |
1277 | * |
1278 | * Enables all the endpoints for the interface's current altsetting. | |
1279 | */ | |
2caf7fcd | 1280 | void usb_enable_interface(struct usb_device *dev, |
3444b26a | 1281 | struct usb_interface *intf, bool reset_eps) |
1da177e4 LT |
1282 | { |
1283 | struct usb_host_interface *alt = intf->cur_altsetting; | |
1284 | int i; | |
1285 | ||
1286 | for (i = 0; i < alt->desc.bNumEndpoints; ++i) | |
3444b26a | 1287 | usb_enable_endpoint(dev, &alt->endpoint[i], reset_eps); |
1da177e4 LT |
1288 | } |
1289 | ||
1290 | /** | |
1291 | * usb_set_interface - Makes a particular alternate setting be current | |
1292 | * @dev: the device whose interface is being updated | |
1293 | * @interface: the interface being updated | |
1294 | * @alternate: the setting being chosen. | |
1295 | * Context: !in_interrupt () | |
1296 | * | |
1297 | * This is used to enable data transfers on interfaces that may not | |
1298 | * be enabled by default. Not all devices support such configurability. | |
1299 | * Only the driver bound to an interface may change its setting. | |
1300 | * | |
1301 | * Within any given configuration, each interface may have several | |
1302 | * alternative settings. These are often used to control levels of | |
1303 | * bandwidth consumption. For example, the default setting for a high | |
1304 | * speed interrupt endpoint may not send more than 64 bytes per microframe, | |
1305 | * while interrupt transfers of up to 3KBytes per microframe are legal. | |
1306 | * Also, isochronous endpoints may never be part of an | |
1307 | * interface's default setting. To access such bandwidth, alternate | |
1308 | * interface settings must be made current. | |
1309 | * | |
1310 | * Note that in the Linux USB subsystem, bandwidth associated with | |
1311 | * an endpoint in a given alternate setting is not reserved until an URB | |
1312 | * is submitted that needs that bandwidth. Some other operating systems | |
1313 | * allocate bandwidth early, when a configuration is chosen. | |
1314 | * | |
1315 | * This call is synchronous, and may not be used in an interrupt context. | |
1316 | * Also, drivers must not change altsettings while urbs are scheduled for | |
1317 | * endpoints in that interface; all such urbs must first be completed | |
1318 | * (perhaps forced by unlinking). | |
1319 | * | |
626f090c | 1320 | * Return: Zero on success, or else the status code returned by the |
1da177e4 LT |
1321 | * underlying usb_control_msg() call. |
1322 | */ | |
1323 | int usb_set_interface(struct usb_device *dev, int interface, int alternate) | |
1324 | { | |
1325 | struct usb_interface *iface; | |
1326 | struct usb_host_interface *alt; | |
3f0479e0 | 1327 | struct usb_hcd *hcd = bus_to_hcd(dev->bus); |
7a7b562d | 1328 | int i, ret, manual = 0; |
3e35bf39 GKH |
1329 | unsigned int epaddr; |
1330 | unsigned int pipe; | |
1da177e4 LT |
1331 | |
1332 | if (dev->state == USB_STATE_SUSPENDED) | |
1333 | return -EHOSTUNREACH; | |
1334 | ||
1335 | iface = usb_ifnum_to_if(dev, interface); | |
1336 | if (!iface) { | |
1337 | dev_dbg(&dev->dev, "selecting invalid interface %d\n", | |
1338 | interface); | |
1339 | return -EINVAL; | |
1340 | } | |
e534c5b8 AS |
1341 | if (iface->unregistering) |
1342 | return -ENODEV; | |
1da177e4 LT |
1343 | |
1344 | alt = usb_altnum_to_altsetting(iface, alternate); | |
1345 | if (!alt) { | |
385f690b | 1346 | dev_warn(&dev->dev, "selecting invalid altsetting %d\n", |
3b6004f3 | 1347 | alternate); |
1da177e4 LT |
1348 | return -EINVAL; |
1349 | } | |
1350 | ||
3f0479e0 SS |
1351 | /* Make sure we have enough bandwidth for this alternate interface. |
1352 | * Remove the current alt setting and add the new alt setting. | |
1353 | */ | |
d673bfcb | 1354 | mutex_lock(hcd->bandwidth_mutex); |
8306095f SS |
1355 | /* Disable LPM, and re-enable it once the new alt setting is installed, |
1356 | * so that the xHCI driver can recalculate the U1/U2 timeouts. | |
1357 | */ | |
1358 | if (usb_disable_lpm(dev)) { | |
1ccc417e | 1359 | dev_err(&iface->dev, "%s Failed to disable LPM\n", __func__); |
8306095f SS |
1360 | mutex_unlock(hcd->bandwidth_mutex); |
1361 | return -ENOMEM; | |
1362 | } | |
7a7b562d HG |
1363 | /* Changing alt-setting also frees any allocated streams */ |
1364 | for (i = 0; i < iface->cur_altsetting->desc.bNumEndpoints; i++) | |
1365 | iface->cur_altsetting->endpoint[i].streams = 0; | |
1366 | ||
3f0479e0 SS |
1367 | ret = usb_hcd_alloc_bandwidth(dev, NULL, iface->cur_altsetting, alt); |
1368 | if (ret < 0) { | |
1369 | dev_info(&dev->dev, "Not enough bandwidth for altsetting %d\n", | |
1370 | alternate); | |
8306095f | 1371 | usb_enable_lpm(dev); |
d673bfcb | 1372 | mutex_unlock(hcd->bandwidth_mutex); |
3f0479e0 SS |
1373 | return ret; |
1374 | } | |
1375 | ||
392e1d98 AS |
1376 | if (dev->quirks & USB_QUIRK_NO_SET_INTF) |
1377 | ret = -EPIPE; | |
1378 | else | |
1379 | ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), | |
1da177e4 LT |
1380 | USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, |
1381 | alternate, interface, NULL, 0, 5000); | |
1382 | ||
1383 | /* 9.4.10 says devices don't need this and are free to STALL the | |
1384 | * request if the interface only has one alternate setting. | |
1385 | */ | |
1386 | if (ret == -EPIPE && iface->num_altsetting == 1) { | |
1387 | dev_dbg(&dev->dev, | |
1388 | "manual set_interface for iface %d, alt %d\n", | |
1389 | interface, alternate); | |
1390 | manual = 1; | |
3f0479e0 SS |
1391 | } else if (ret < 0) { |
1392 | /* Re-instate the old alt setting */ | |
1393 | usb_hcd_alloc_bandwidth(dev, NULL, alt, iface->cur_altsetting); | |
8306095f | 1394 | usb_enable_lpm(dev); |
d673bfcb | 1395 | mutex_unlock(hcd->bandwidth_mutex); |
1da177e4 | 1396 | return ret; |
3f0479e0 | 1397 | } |
d673bfcb | 1398 | mutex_unlock(hcd->bandwidth_mutex); |
1da177e4 LT |
1399 | |
1400 | /* FIXME drivers shouldn't need to replicate/bugfix the logic here | |
1401 | * when they implement async or easily-killable versions of this or | |
1402 | * other "should-be-internal" functions (like clear_halt). | |
1403 | * should hcd+usbcore postprocess control requests? | |
1404 | */ | |
1405 | ||
1406 | /* prevent submissions using previous endpoint settings */ | |
3b23dd6f AS |
1407 | if (iface->cur_altsetting != alt) { |
1408 | remove_intf_ep_devs(iface); | |
0e6c8e8d | 1409 | usb_remove_sysfs_intf_files(iface); |
3b23dd6f | 1410 | } |
ddeac4e7 | 1411 | usb_disable_interface(dev, iface, true); |
1da177e4 | 1412 | |
1da177e4 LT |
1413 | iface->cur_altsetting = alt; |
1414 | ||
8306095f SS |
1415 | /* Now that the interface is installed, re-enable LPM. */ |
1416 | usb_unlocked_enable_lpm(dev); | |
1417 | ||
1da177e4 | 1418 | /* If the interface only has one altsetting and the device didn't |
a81e7ecc | 1419 | * accept the request, we attempt to carry out the equivalent action |
1da177e4 LT |
1420 | * by manually clearing the HALT feature for each endpoint in the |
1421 | * new altsetting. | |
1422 | */ | |
1423 | if (manual) { | |
1da177e4 | 1424 | for (i = 0; i < alt->desc.bNumEndpoints; i++) { |
3e35bf39 GKH |
1425 | epaddr = alt->endpoint[i].desc.bEndpointAddress; |
1426 | pipe = __create_pipe(dev, | |
1427 | USB_ENDPOINT_NUMBER_MASK & epaddr) | | |
1428 | (usb_endpoint_out(epaddr) ? | |
1429 | USB_DIR_OUT : USB_DIR_IN); | |
1da177e4 LT |
1430 | |
1431 | usb_clear_halt(dev, pipe); | |
1432 | } | |
1433 | } | |
1434 | ||
1435 | /* 9.1.1.5: reset toggles for all endpoints in the new altsetting | |
1436 | * | |
1437 | * Note: | |
1438 | * Despite EP0 is always present in all interfaces/AS, the list of | |
1439 | * endpoints from the descriptor does not contain EP0. Due to its | |
1440 | * omnipresence one might expect EP0 being considered "affected" by | |
1441 | * any SetInterface request and hence assume toggles need to be reset. | |
1442 | * However, EP0 toggles are re-synced for every individual transfer | |
1443 | * during the SETUP stage - hence EP0 toggles are "don't care" here. | |
1444 | * (Likewise, EP0 never "halts" on well designed devices.) | |
1445 | */ | |
2caf7fcd | 1446 | usb_enable_interface(dev, iface, true); |
3b23dd6f | 1447 | if (device_is_registered(&iface->dev)) { |
0e6c8e8d | 1448 | usb_create_sysfs_intf_files(iface); |
3b23dd6f AS |
1449 | create_intf_ep_devs(iface); |
1450 | } | |
1da177e4 LT |
1451 | return 0; |
1452 | } | |
782e70c6 | 1453 | EXPORT_SYMBOL_GPL(usb_set_interface); |
1da177e4 LT |
1454 | |
1455 | /** | |
1456 | * usb_reset_configuration - lightweight device reset | |
1457 | * @dev: the device whose configuration is being reset | |
1458 | * | |
1459 | * This issues a standard SET_CONFIGURATION request to the device using | |
1460 | * the current configuration. The effect is to reset most USB-related | |
1461 | * state in the device, including interface altsettings (reset to zero), | |
3444b26a | 1462 | * endpoint halts (cleared), and endpoint state (only for bulk and interrupt |
1da177e4 LT |
1463 | * endpoints). Other usbcore state is unchanged, including bindings of |
1464 | * usb device drivers to interfaces. | |
1465 | * | |
1466 | * Because this affects multiple interfaces, avoid using this with composite | |
1467 | * (multi-interface) devices. Instead, the driver for each interface may | |
a81e7ecc DB |
1468 | * use usb_set_interface() on the interfaces it claims. Be careful though; |
1469 | * some devices don't support the SET_INTERFACE request, and others won't | |
3444b26a | 1470 | * reset all the interface state (notably endpoint state). Resetting the whole |
1da177e4 LT |
1471 | * configuration would affect other drivers' interfaces. |
1472 | * | |
1473 | * The caller must own the device lock. | |
1474 | * | |
626f090c | 1475 | * Return: Zero on success, else a negative error code. |
1da177e4 LT |
1476 | */ |
1477 | int usb_reset_configuration(struct usb_device *dev) | |
1478 | { | |
1479 | int i, retval; | |
1480 | struct usb_host_config *config; | |
3f0479e0 | 1481 | struct usb_hcd *hcd = bus_to_hcd(dev->bus); |
1da177e4 LT |
1482 | |
1483 | if (dev->state == USB_STATE_SUSPENDED) | |
1484 | return -EHOSTUNREACH; | |
1485 | ||
1486 | /* caller must have locked the device and must own | |
1487 | * the usb bus readlock (so driver bindings are stable); | |
1488 | * calls during probe() are fine | |
1489 | */ | |
1490 | ||
1491 | for (i = 1; i < 16; ++i) { | |
ddeac4e7 AS |
1492 | usb_disable_endpoint(dev, i, true); |
1493 | usb_disable_endpoint(dev, i + USB_DIR_IN, true); | |
1da177e4 LT |
1494 | } |
1495 | ||
1496 | config = dev->actconfig; | |
3f0479e0 | 1497 | retval = 0; |
d673bfcb | 1498 | mutex_lock(hcd->bandwidth_mutex); |
8306095f SS |
1499 | /* Disable LPM, and re-enable it once the configuration is reset, so |
1500 | * that the xHCI driver can recalculate the U1/U2 timeouts. | |
1501 | */ | |
1502 | if (usb_disable_lpm(dev)) { | |
1ccc417e | 1503 | dev_err(&dev->dev, "%s Failed to disable LPM\n", __func__); |
8306095f SS |
1504 | mutex_unlock(hcd->bandwidth_mutex); |
1505 | return -ENOMEM; | |
1506 | } | |
3f0479e0 SS |
1507 | /* Make sure we have enough bandwidth for each alternate setting 0 */ |
1508 | for (i = 0; i < config->desc.bNumInterfaces; i++) { | |
1509 | struct usb_interface *intf = config->interface[i]; | |
1510 | struct usb_host_interface *alt; | |
1511 | ||
1512 | alt = usb_altnum_to_altsetting(intf, 0); | |
1513 | if (!alt) | |
1514 | alt = &intf->altsetting[0]; | |
1515 | if (alt != intf->cur_altsetting) | |
1516 | retval = usb_hcd_alloc_bandwidth(dev, NULL, | |
1517 | intf->cur_altsetting, alt); | |
1518 | if (retval < 0) | |
1519 | break; | |
1520 | } | |
1521 | /* If not, reinstate the old alternate settings */ | |
1522 | if (retval < 0) { | |
1523 | reset_old_alts: | |
e4a3d946 | 1524 | for (i--; i >= 0; i--) { |
3f0479e0 SS |
1525 | struct usb_interface *intf = config->interface[i]; |
1526 | struct usb_host_interface *alt; | |
1527 | ||
1528 | alt = usb_altnum_to_altsetting(intf, 0); | |
1529 | if (!alt) | |
1530 | alt = &intf->altsetting[0]; | |
1531 | if (alt != intf->cur_altsetting) | |
1532 | usb_hcd_alloc_bandwidth(dev, NULL, | |
1533 | alt, intf->cur_altsetting); | |
1534 | } | |
8306095f | 1535 | usb_enable_lpm(dev); |
d673bfcb | 1536 | mutex_unlock(hcd->bandwidth_mutex); |
3f0479e0 SS |
1537 | return retval; |
1538 | } | |
1da177e4 LT |
1539 | retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), |
1540 | USB_REQ_SET_CONFIGURATION, 0, | |
1541 | config->desc.bConfigurationValue, 0, | |
1542 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
0e6c8e8d | 1543 | if (retval < 0) |
3f0479e0 | 1544 | goto reset_old_alts; |
d673bfcb | 1545 | mutex_unlock(hcd->bandwidth_mutex); |
1da177e4 | 1546 | |
1da177e4 LT |
1547 | /* re-init hc/hcd interface/endpoint state */ |
1548 | for (i = 0; i < config->desc.bNumInterfaces; i++) { | |
1549 | struct usb_interface *intf = config->interface[i]; | |
1550 | struct usb_host_interface *alt; | |
1551 | ||
1552 | alt = usb_altnum_to_altsetting(intf, 0); | |
1553 | ||
1554 | /* No altsetting 0? We'll assume the first altsetting. | |
1555 | * We could use a GetInterface call, but if a device is | |
1556 | * so non-compliant that it doesn't have altsetting 0 | |
1557 | * then I wouldn't trust its reply anyway. | |
1558 | */ | |
1559 | if (!alt) | |
1560 | alt = &intf->altsetting[0]; | |
1561 | ||
3b23dd6f AS |
1562 | if (alt != intf->cur_altsetting) { |
1563 | remove_intf_ep_devs(intf); | |
1564 | usb_remove_sysfs_intf_files(intf); | |
1565 | } | |
1da177e4 | 1566 | intf->cur_altsetting = alt; |
2caf7fcd | 1567 | usb_enable_interface(dev, intf, true); |
3b23dd6f | 1568 | if (device_is_registered(&intf->dev)) { |
0e6c8e8d | 1569 | usb_create_sysfs_intf_files(intf); |
3b23dd6f AS |
1570 | create_intf_ep_devs(intf); |
1571 | } | |
1da177e4 | 1572 | } |
8306095f SS |
1573 | /* Now that the interfaces are installed, re-enable LPM. */ |
1574 | usb_unlocked_enable_lpm(dev); | |
1da177e4 LT |
1575 | return 0; |
1576 | } | |
782e70c6 | 1577 | EXPORT_SYMBOL_GPL(usb_reset_configuration); |
1da177e4 | 1578 | |
b0e396e3 | 1579 | static void usb_release_interface(struct device *dev) |
1da177e4 LT |
1580 | { |
1581 | struct usb_interface *intf = to_usb_interface(dev); | |
1582 | struct usb_interface_cache *intfc = | |
1583 | altsetting_to_usb_interface_cache(intf->altsetting); | |
1584 | ||
1585 | kref_put(&intfc->ref, usb_release_interface_cache); | |
524134d4 | 1586 | usb_put_dev(interface_to_usbdev(intf)); |
1a7e3948 | 1587 | of_node_put(dev->of_node); |
1da177e4 LT |
1588 | kfree(intf); |
1589 | } | |
1590 | ||
b3910cef SK |
1591 | /* |
1592 | * usb_deauthorize_interface - deauthorize an USB interface | |
1593 | * | |
1594 | * @intf: USB interface structure | |
1595 | */ | |
1596 | void usb_deauthorize_interface(struct usb_interface *intf) | |
1597 | { | |
1598 | struct device *dev = &intf->dev; | |
1599 | ||
1600 | device_lock(dev->parent); | |
1601 | ||
1602 | if (intf->authorized) { | |
1603 | device_lock(dev); | |
1604 | intf->authorized = 0; | |
1605 | device_unlock(dev); | |
1606 | ||
1607 | usb_forced_unbind_intf(intf); | |
1608 | } | |
1609 | ||
1610 | device_unlock(dev->parent); | |
1611 | } | |
1612 | ||
1613 | /* | |
1614 | * usb_authorize_interface - authorize an USB interface | |
1615 | * | |
1616 | * @intf: USB interface structure | |
1617 | */ | |
1618 | void usb_authorize_interface(struct usb_interface *intf) | |
1619 | { | |
1620 | struct device *dev = &intf->dev; | |
1621 | ||
1622 | if (!intf->authorized) { | |
1623 | device_lock(dev); | |
1624 | intf->authorized = 1; /* authorize interface */ | |
1625 | device_unlock(dev); | |
1626 | } | |
1627 | } | |
1628 | ||
7eff2e7a | 1629 | static int usb_if_uevent(struct device *dev, struct kobj_uevent_env *env) |
9f8b17e6 KS |
1630 | { |
1631 | struct usb_device *usb_dev; | |
1632 | struct usb_interface *intf; | |
1633 | struct usb_host_interface *alt; | |
9f8b17e6 | 1634 | |
9f8b17e6 KS |
1635 | intf = to_usb_interface(dev); |
1636 | usb_dev = interface_to_usbdev(intf); | |
1637 | alt = intf->cur_altsetting; | |
1638 | ||
7eff2e7a | 1639 | if (add_uevent_var(env, "INTERFACE=%d/%d/%d", |
9f8b17e6 KS |
1640 | alt->desc.bInterfaceClass, |
1641 | alt->desc.bInterfaceSubClass, | |
1642 | alt->desc.bInterfaceProtocol)) | |
1643 | return -ENOMEM; | |
1644 | ||
7eff2e7a | 1645 | if (add_uevent_var(env, |
3e35bf39 | 1646 | "MODALIAS=usb:" |
81df2d59 | 1647 | "v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02Xin%02X", |
9f8b17e6 KS |
1648 | le16_to_cpu(usb_dev->descriptor.idVendor), |
1649 | le16_to_cpu(usb_dev->descriptor.idProduct), | |
1650 | le16_to_cpu(usb_dev->descriptor.bcdDevice), | |
1651 | usb_dev->descriptor.bDeviceClass, | |
1652 | usb_dev->descriptor.bDeviceSubClass, | |
1653 | usb_dev->descriptor.bDeviceProtocol, | |
1654 | alt->desc.bInterfaceClass, | |
1655 | alt->desc.bInterfaceSubClass, | |
81df2d59 BM |
1656 | alt->desc.bInterfaceProtocol, |
1657 | alt->desc.bInterfaceNumber)) | |
9f8b17e6 KS |
1658 | return -ENOMEM; |
1659 | ||
9f8b17e6 KS |
1660 | return 0; |
1661 | } | |
1662 | ||
9f8b17e6 KS |
1663 | struct device_type usb_if_device_type = { |
1664 | .name = "usb_interface", | |
1665 | .release = usb_release_interface, | |
1666 | .uevent = usb_if_uevent, | |
1667 | }; | |
1668 | ||
165fe97e | 1669 | static struct usb_interface_assoc_descriptor *find_iad(struct usb_device *dev, |
3e35bf39 GKH |
1670 | struct usb_host_config *config, |
1671 | u8 inum) | |
165fe97e CN |
1672 | { |
1673 | struct usb_interface_assoc_descriptor *retval = NULL; | |
1674 | struct usb_interface_assoc_descriptor *intf_assoc; | |
1675 | int first_intf; | |
1676 | int last_intf; | |
1677 | int i; | |
1678 | ||
1679 | for (i = 0; (i < USB_MAXIADS && config->intf_assoc[i]); i++) { | |
1680 | intf_assoc = config->intf_assoc[i]; | |
1681 | if (intf_assoc->bInterfaceCount == 0) | |
1682 | continue; | |
1683 | ||
1684 | first_intf = intf_assoc->bFirstInterface; | |
1685 | last_intf = first_intf + (intf_assoc->bInterfaceCount - 1); | |
1686 | if (inum >= first_intf && inum <= last_intf) { | |
1687 | if (!retval) | |
1688 | retval = intf_assoc; | |
1689 | else | |
1690 | dev_err(&dev->dev, "Interface #%d referenced" | |
1691 | " by multiple IADs\n", inum); | |
1692 | } | |
1693 | } | |
1694 | ||
1695 | return retval; | |
1696 | } | |
1697 | ||
dc023dce IPG |
1698 | |
1699 | /* | |
1700 | * Internal function to queue a device reset | |
dc023dce IPG |
1701 | * See usb_queue_reset_device() for more details |
1702 | */ | |
09e81f3d | 1703 | static void __usb_queue_reset_device(struct work_struct *ws) |
dc023dce IPG |
1704 | { |
1705 | int rc; | |
1706 | struct usb_interface *iface = | |
1707 | container_of(ws, struct usb_interface, reset_ws); | |
1708 | struct usb_device *udev = interface_to_usbdev(iface); | |
1709 | ||
1710 | rc = usb_lock_device_for_reset(udev, iface); | |
1711 | if (rc >= 0) { | |
dc023dce | 1712 | usb_reset_device(udev); |
dc023dce IPG |
1713 | usb_unlock_device(udev); |
1714 | } | |
524134d4 | 1715 | usb_put_intf(iface); /* Undo _get_ in usb_queue_reset_device() */ |
dc023dce IPG |
1716 | } |
1717 | ||
1718 | ||
1da177e4 LT |
1719 | /* |
1720 | * usb_set_configuration - Makes a particular device setting be current | |
1721 | * @dev: the device whose configuration is being updated | |
1722 | * @configuration: the configuration being chosen. | |
1723 | * Context: !in_interrupt(), caller owns the device lock | |
1724 | * | |
1725 | * This is used to enable non-default device modes. Not all devices | |
1726 | * use this kind of configurability; many devices only have one | |
1727 | * configuration. | |
1728 | * | |
3f141e2a AS |
1729 | * @configuration is the value of the configuration to be installed. |
1730 | * According to the USB spec (e.g. section 9.1.1.5), configuration values | |
1731 | * must be non-zero; a value of zero indicates that the device in | |
1732 | * unconfigured. However some devices erroneously use 0 as one of their | |
1733 | * configuration values. To help manage such devices, this routine will | |
1734 | * accept @configuration = -1 as indicating the device should be put in | |
1735 | * an unconfigured state. | |
1736 | * | |
1da177e4 LT |
1737 | * USB device configurations may affect Linux interoperability, |
1738 | * power consumption and the functionality available. For example, | |
1739 | * the default configuration is limited to using 100mA of bus power, | |
1740 | * so that when certain device functionality requires more power, | |
1741 | * and the device is bus powered, that functionality should be in some | |
1742 | * non-default device configuration. Other device modes may also be | |
1743 | * reflected as configuration options, such as whether two ISDN | |
1744 | * channels are available independently; and choosing between open | |
1745 | * standard device protocols (like CDC) or proprietary ones. | |
1746 | * | |
16bbab29 IPG |
1747 | * Note that a non-authorized device (dev->authorized == 0) will only |
1748 | * be put in unconfigured mode. | |
1749 | * | |
1da177e4 LT |
1750 | * Note that USB has an additional level of device configurability, |
1751 | * associated with interfaces. That configurability is accessed using | |
1752 | * usb_set_interface(). | |
1753 | * | |
1754 | * This call is synchronous. The calling context must be able to sleep, | |
1755 | * must own the device lock, and must not hold the driver model's USB | |
6d243e5c | 1756 | * bus mutex; usb interface driver probe() methods cannot use this routine. |
1da177e4 LT |
1757 | * |
1758 | * Returns zero on success, or else the status code returned by the | |
093cf723 | 1759 | * underlying call that failed. On successful completion, each interface |
1da177e4 LT |
1760 | * in the original device configuration has been destroyed, and each one |
1761 | * in the new configuration has been probed by all relevant usb device | |
1762 | * drivers currently known to the kernel. | |
1763 | */ | |
1764 | int usb_set_configuration(struct usb_device *dev, int configuration) | |
1765 | { | |
1766 | int i, ret; | |
1767 | struct usb_host_config *cp = NULL; | |
1768 | struct usb_interface **new_interfaces = NULL; | |
3f0479e0 | 1769 | struct usb_hcd *hcd = bus_to_hcd(dev->bus); |
1da177e4 LT |
1770 | int n, nintf; |
1771 | ||
16bbab29 | 1772 | if (dev->authorized == 0 || configuration == -1) |
3f141e2a AS |
1773 | configuration = 0; |
1774 | else { | |
1775 | for (i = 0; i < dev->descriptor.bNumConfigurations; i++) { | |
1776 | if (dev->config[i].desc.bConfigurationValue == | |
1777 | configuration) { | |
1778 | cp = &dev->config[i]; | |
1779 | break; | |
1780 | } | |
1da177e4 LT |
1781 | } |
1782 | } | |
1783 | if ((!cp && configuration != 0)) | |
1784 | return -EINVAL; | |
1785 | ||
1786 | /* The USB spec says configuration 0 means unconfigured. | |
1787 | * But if a device includes a configuration numbered 0, | |
1788 | * we will accept it as a correctly configured state. | |
3f141e2a | 1789 | * Use -1 if you really want to unconfigure the device. |
1da177e4 LT |
1790 | */ |
1791 | if (cp && configuration == 0) | |
1792 | dev_warn(&dev->dev, "config 0 descriptor??\n"); | |
1793 | ||
1da177e4 LT |
1794 | /* Allocate memory for new interfaces before doing anything else, |
1795 | * so that if we run out then nothing will have changed. */ | |
1796 | n = nintf = 0; | |
1797 | if (cp) { | |
1798 | nintf = cp->desc.bNumInterfaces; | |
1799 | new_interfaces = kmalloc(nintf * sizeof(*new_interfaces), | |
acbe2feb | 1800 | GFP_NOIO); |
93fab795 | 1801 | if (!new_interfaces) |
1da177e4 | 1802 | return -ENOMEM; |
1da177e4 LT |
1803 | |
1804 | for (; n < nintf; ++n) { | |
0a1ef3b5 | 1805 | new_interfaces[n] = kzalloc( |
1da177e4 | 1806 | sizeof(struct usb_interface), |
acbe2feb | 1807 | GFP_NOIO); |
1da177e4 | 1808 | if (!new_interfaces[n]) { |
1da177e4 LT |
1809 | ret = -ENOMEM; |
1810 | free_interfaces: | |
1811 | while (--n >= 0) | |
1812 | kfree(new_interfaces[n]); | |
1813 | kfree(new_interfaces); | |
1814 | return ret; | |
1815 | } | |
1816 | } | |
1da177e4 | 1817 | |
8d8479db | 1818 | i = dev->bus_mA - usb_get_max_power(dev, cp); |
f48219db HS |
1819 | if (i < 0) |
1820 | dev_warn(&dev->dev, "new config #%d exceeds power " | |
1821 | "limit by %dmA\n", | |
1822 | configuration, -i); | |
1823 | } | |
55c52718 | 1824 | |
01d883d4 | 1825 | /* Wake up the device so we can send it the Set-Config request */ |
94fcda1f | 1826 | ret = usb_autoresume_device(dev); |
01d883d4 AS |
1827 | if (ret) |
1828 | goto free_interfaces; | |
1829 | ||
0791971b TLSC |
1830 | /* if it's already configured, clear out old state first. |
1831 | * getting rid of old interfaces means unbinding their drivers. | |
1832 | */ | |
1833 | if (dev->state != USB_STATE_ADDRESS) | |
1834 | usb_disable_device(dev, 1); /* Skip ep0 */ | |
1835 | ||
1836 | /* Get rid of pending async Set-Config requests for this device */ | |
1837 | cancel_async_set_config(dev); | |
1838 | ||
79abb1ab SS |
1839 | /* Make sure we have bandwidth (and available HCD resources) for this |
1840 | * configuration. Remove endpoints from the schedule if we're dropping | |
1841 | * this configuration to set configuration 0. After this point, the | |
1842 | * host controller will not allow submissions to dropped endpoints. If | |
1843 | * this call fails, the device state is unchanged. | |
1844 | */ | |
8963c487 | 1845 | mutex_lock(hcd->bandwidth_mutex); |
8306095f SS |
1846 | /* Disable LPM, and re-enable it once the new configuration is |
1847 | * installed, so that the xHCI driver can recalculate the U1/U2 | |
1848 | * timeouts. | |
1849 | */ | |
9cf65991 | 1850 | if (dev->actconfig && usb_disable_lpm(dev)) { |
1ccc417e | 1851 | dev_err(&dev->dev, "%s Failed to disable LPM\n", __func__); |
8306095f | 1852 | mutex_unlock(hcd->bandwidth_mutex); |
c058f7ab SK |
1853 | ret = -ENOMEM; |
1854 | goto free_interfaces; | |
8306095f | 1855 | } |
3f0479e0 | 1856 | ret = usb_hcd_alloc_bandwidth(dev, cp, NULL, NULL); |
79abb1ab | 1857 | if (ret < 0) { |
9cf65991 SS |
1858 | if (dev->actconfig) |
1859 | usb_enable_lpm(dev); | |
d673bfcb | 1860 | mutex_unlock(hcd->bandwidth_mutex); |
0791971b | 1861 | usb_autosuspend_device(dev); |
79abb1ab SS |
1862 | goto free_interfaces; |
1863 | } | |
1864 | ||
36caff5d AS |
1865 | /* |
1866 | * Initialize the new interface structures and the | |
6ad07129 AS |
1867 | * hc/hcd/usbcore interface/endpoint state. |
1868 | */ | |
1869 | for (i = 0; i < nintf; ++i) { | |
1870 | struct usb_interface_cache *intfc; | |
1871 | struct usb_interface *intf; | |
1872 | struct usb_host_interface *alt; | |
1a7e3948 | 1873 | u8 ifnum; |
1da177e4 | 1874 | |
6ad07129 AS |
1875 | cp->interface[i] = intf = new_interfaces[i]; |
1876 | intfc = cp->intf_cache[i]; | |
1877 | intf->altsetting = intfc->altsetting; | |
1878 | intf->num_altsetting = intfc->num_altsetting; | |
6b2bd3c8 | 1879 | intf->authorized = !!HCD_INTF_AUTHORIZED(hcd); |
6ad07129 | 1880 | kref_get(&intfc->ref); |
1da177e4 | 1881 | |
6ad07129 AS |
1882 | alt = usb_altnum_to_altsetting(intf, 0); |
1883 | ||
1884 | /* No altsetting 0? We'll assume the first altsetting. | |
1885 | * We could use a GetInterface call, but if a device is | |
1886 | * so non-compliant that it doesn't have altsetting 0 | |
1887 | * then I wouldn't trust its reply anyway. | |
1da177e4 | 1888 | */ |
6ad07129 AS |
1889 | if (!alt) |
1890 | alt = &intf->altsetting[0]; | |
1891 | ||
1a7e3948 JH |
1892 | ifnum = alt->desc.bInterfaceNumber; |
1893 | intf->intf_assoc = find_iad(dev, cp, ifnum); | |
6ad07129 | 1894 | intf->cur_altsetting = alt; |
2caf7fcd | 1895 | usb_enable_interface(dev, intf, true); |
6ad07129 | 1896 | intf->dev.parent = &dev->dev; |
1a7e3948 JH |
1897 | if (usb_of_has_combined_node(dev)) { |
1898 | device_set_of_node_from_dev(&intf->dev, &dev->dev); | |
1899 | } else { | |
1900 | intf->dev.of_node = usb_of_get_interface_node(dev, | |
1901 | configuration, ifnum); | |
1902 | } | |
6ad07129 AS |
1903 | intf->dev.driver = NULL; |
1904 | intf->dev.bus = &usb_bus_type; | |
9f8b17e6 | 1905 | intf->dev.type = &usb_if_device_type; |
2e5f10e4 | 1906 | intf->dev.groups = usb_interface_groups; |
b44bbc46 RQ |
1907 | /* |
1908 | * Please refer to usb_alloc_dev() to see why we set | |
1909 | * dma_mask and dma_pfn_offset. | |
1910 | */ | |
6ad07129 | 1911 | intf->dev.dma_mask = dev->dev.dma_mask; |
b44bbc46 | 1912 | intf->dev.dma_pfn_offset = dev->dev.dma_pfn_offset; |
dc023dce | 1913 | INIT_WORK(&intf->reset_ws, __usb_queue_reset_device); |
0026e005 | 1914 | intf->minor = -1; |
3e35bf39 | 1915 | device_initialize(&intf->dev); |
63defa73 | 1916 | pm_runtime_no_callbacks(&intf->dev); |
1a7e3948 JH |
1917 | dev_set_name(&intf->dev, "%d-%s:%d.%d", dev->bus->busnum, |
1918 | dev->devpath, configuration, ifnum); | |
524134d4 | 1919 | usb_get_dev(dev); |
6ad07129 AS |
1920 | } |
1921 | kfree(new_interfaces); | |
1922 | ||
36caff5d AS |
1923 | ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), |
1924 | USB_REQ_SET_CONFIGURATION, 0, configuration, 0, | |
1925 | NULL, 0, USB_CTRL_SET_TIMEOUT); | |
1926 | if (ret < 0 && cp) { | |
1927 | /* | |
1928 | * All the old state is gone, so what else can we do? | |
1929 | * The device is probably useless now anyway. | |
1930 | */ | |
1931 | usb_hcd_alloc_bandwidth(dev, NULL, NULL, NULL); | |
1932 | for (i = 0; i < nintf; ++i) { | |
1933 | usb_disable_interface(dev, cp->interface[i], true); | |
1934 | put_device(&cp->interface[i]->dev); | |
1935 | cp->interface[i] = NULL; | |
1936 | } | |
1937 | cp = NULL; | |
1938 | } | |
1939 | ||
1940 | dev->actconfig = cp; | |
1941 | mutex_unlock(hcd->bandwidth_mutex); | |
1942 | ||
1943 | if (!cp) { | |
1944 | usb_set_device_state(dev, USB_STATE_ADDRESS); | |
1945 | ||
1946 | /* Leave LPM disabled while the device is unconfigured. */ | |
1947 | usb_autosuspend_device(dev); | |
1948 | return ret; | |
1949 | } | |
1950 | usb_set_device_state(dev, USB_STATE_CONFIGURED); | |
1951 | ||
1662e3a7 AS |
1952 | if (cp->string == NULL && |
1953 | !(dev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS)) | |
6ad07129 AS |
1954 | cp->string = usb_cache_string(dev, cp->desc.iConfiguration); |
1955 | ||
8306095f SS |
1956 | /* Now that the interfaces are installed, re-enable LPM. */ |
1957 | usb_unlocked_enable_lpm(dev); | |
f74631e3 SS |
1958 | /* Enable LTM if it was turned off by usb_disable_device. */ |
1959 | usb_enable_ltm(dev); | |
8306095f | 1960 | |
6ad07129 AS |
1961 | /* Now that all the interfaces are set up, register them |
1962 | * to trigger binding of drivers to interfaces. probe() | |
1963 | * routines may install different altsettings and may | |
1964 | * claim() any interfaces not yet bound. Many class drivers | |
1965 | * need that: CDC, audio, video, etc. | |
1966 | */ | |
1967 | for (i = 0; i < nintf; ++i) { | |
1968 | struct usb_interface *intf = cp->interface[i]; | |
1969 | ||
3e35bf39 | 1970 | dev_dbg(&dev->dev, |
6ad07129 | 1971 | "adding %s (config #%d, interface %d)\n", |
7071a3ce | 1972 | dev_name(&intf->dev), configuration, |
6ad07129 | 1973 | intf->cur_altsetting->desc.bInterfaceNumber); |
927bc916 | 1974 | device_enable_async_suspend(&intf->dev); |
3e35bf39 | 1975 | ret = device_add(&intf->dev); |
6ad07129 AS |
1976 | if (ret != 0) { |
1977 | dev_err(&dev->dev, "device_add(%s) --> %d\n", | |
7071a3ce | 1978 | dev_name(&intf->dev), ret); |
6ad07129 | 1979 | continue; |
1da177e4 | 1980 | } |
3b23dd6f | 1981 | create_intf_ep_devs(intf); |
1da177e4 LT |
1982 | } |
1983 | ||
94fcda1f | 1984 | usb_autosuspend_device(dev); |
86d30741 | 1985 | return 0; |
1da177e4 | 1986 | } |
b7945b77 | 1987 | EXPORT_SYMBOL_GPL(usb_set_configuration); |
1da177e4 | 1988 | |
df718962 AS |
1989 | static LIST_HEAD(set_config_list); |
1990 | static DEFINE_SPINLOCK(set_config_lock); | |
1991 | ||
088dc270 AS |
1992 | struct set_config_request { |
1993 | struct usb_device *udev; | |
1994 | int config; | |
1995 | struct work_struct work; | |
df718962 | 1996 | struct list_head node; |
088dc270 AS |
1997 | }; |
1998 | ||
1999 | /* Worker routine for usb_driver_set_configuration() */ | |
c4028958 | 2000 | static void driver_set_config_work(struct work_struct *work) |
088dc270 | 2001 | { |
c4028958 DH |
2002 | struct set_config_request *req = |
2003 | container_of(work, struct set_config_request, work); | |
df718962 | 2004 | struct usb_device *udev = req->udev; |
088dc270 | 2005 | |
df718962 AS |
2006 | usb_lock_device(udev); |
2007 | spin_lock(&set_config_lock); | |
2008 | list_del(&req->node); | |
2009 | spin_unlock(&set_config_lock); | |
2010 | ||
2011 | if (req->config >= -1) /* Is req still valid? */ | |
2012 | usb_set_configuration(udev, req->config); | |
2013 | usb_unlock_device(udev); | |
2014 | usb_put_dev(udev); | |
088dc270 AS |
2015 | kfree(req); |
2016 | } | |
2017 | ||
df718962 AS |
2018 | /* Cancel pending Set-Config requests for a device whose configuration |
2019 | * was just changed | |
2020 | */ | |
2021 | static void cancel_async_set_config(struct usb_device *udev) | |
2022 | { | |
2023 | struct set_config_request *req; | |
2024 | ||
2025 | spin_lock(&set_config_lock); | |
2026 | list_for_each_entry(req, &set_config_list, node) { | |
2027 | if (req->udev == udev) | |
2028 | req->config = -999; /* Mark as cancelled */ | |
2029 | } | |
2030 | spin_unlock(&set_config_lock); | |
2031 | } | |
2032 | ||
088dc270 AS |
2033 | /** |
2034 | * usb_driver_set_configuration - Provide a way for drivers to change device configurations | |
2035 | * @udev: the device whose configuration is being updated | |
2036 | * @config: the configuration being chosen. | |
2037 | * Context: In process context, must be able to sleep | |
2038 | * | |
2039 | * Device interface drivers are not allowed to change device configurations. | |
2040 | * This is because changing configurations will destroy the interface the | |
2041 | * driver is bound to and create new ones; it would be like a floppy-disk | |
2042 | * driver telling the computer to replace the floppy-disk drive with a | |
2043 | * tape drive! | |
2044 | * | |
2045 | * Still, in certain specialized circumstances the need may arise. This | |
2046 | * routine gets around the normal restrictions by using a work thread to | |
2047 | * submit the change-config request. | |
2048 | * | |
626f090c | 2049 | * Return: 0 if the request was successfully queued, error code otherwise. |
088dc270 AS |
2050 | * The caller has no way to know whether the queued request will eventually |
2051 | * succeed. | |
2052 | */ | |
2053 | int usb_driver_set_configuration(struct usb_device *udev, int config) | |
2054 | { | |
2055 | struct set_config_request *req; | |
2056 | ||
2057 | req = kmalloc(sizeof(*req), GFP_KERNEL); | |
2058 | if (!req) | |
2059 | return -ENOMEM; | |
2060 | req->udev = udev; | |
2061 | req->config = config; | |
c4028958 | 2062 | INIT_WORK(&req->work, driver_set_config_work); |
088dc270 | 2063 | |
df718962 AS |
2064 | spin_lock(&set_config_lock); |
2065 | list_add(&req->node, &set_config_list); | |
2066 | spin_unlock(&set_config_lock); | |
2067 | ||
088dc270 | 2068 | usb_get_dev(udev); |
1737bf2c | 2069 | schedule_work(&req->work); |
088dc270 AS |
2070 | return 0; |
2071 | } | |
2072 | EXPORT_SYMBOL_GPL(usb_driver_set_configuration); | |
e4c6fb77 ON |
2073 | |
2074 | /** | |
2075 | * cdc_parse_cdc_header - parse the extra headers present in CDC devices | |
2076 | * @hdr: the place to put the results of the parsing | |
2077 | * @intf: the interface for which parsing is requested | |
2078 | * @buffer: pointer to the extra headers to be parsed | |
2079 | * @buflen: length of the extra headers | |
2080 | * | |
2081 | * This evaluates the extra headers present in CDC devices which | |
2082 | * bind the interfaces for data and control and provide details | |
2083 | * about the capabilities of the device. | |
2084 | * | |
2085 | * Return: number of descriptors parsed or -EINVAL | |
2086 | * if the header is contradictory beyond salvage | |
2087 | */ | |
2088 | ||
2089 | int cdc_parse_cdc_header(struct usb_cdc_parsed_header *hdr, | |
2090 | struct usb_interface *intf, | |
2091 | u8 *buffer, | |
2092 | int buflen) | |
2093 | { | |
2094 | /* duplicates are ignored */ | |
2095 | struct usb_cdc_union_desc *union_header = NULL; | |
2096 | ||
2097 | /* duplicates are not tolerated */ | |
2098 | struct usb_cdc_header_desc *header = NULL; | |
2099 | struct usb_cdc_ether_desc *ether = NULL; | |
2100 | struct usb_cdc_mdlm_detail_desc *detail = NULL; | |
2101 | struct usb_cdc_mdlm_desc *desc = NULL; | |
2102 | ||
2103 | unsigned int elength; | |
2104 | int cnt = 0; | |
2105 | ||
2106 | memset(hdr, 0x00, sizeof(struct usb_cdc_parsed_header)); | |
2107 | hdr->phonet_magic_present = false; | |
2108 | while (buflen > 0) { | |
2109 | elength = buffer[0]; | |
2110 | if (!elength) { | |
2111 | dev_err(&intf->dev, "skipping garbage byte\n"); | |
2112 | elength = 1; | |
2113 | goto next_desc; | |
2114 | } | |
2e1c4239 GKH |
2115 | if ((buflen < elength) || (elength < 3)) { |
2116 | dev_err(&intf->dev, "invalid descriptor buffer length\n"); | |
2117 | break; | |
2118 | } | |
e4c6fb77 ON |
2119 | if (buffer[1] != USB_DT_CS_INTERFACE) { |
2120 | dev_err(&intf->dev, "skipping garbage\n"); | |
2121 | goto next_desc; | |
2122 | } | |
2123 | ||
2124 | switch (buffer[2]) { | |
2125 | case USB_CDC_UNION_TYPE: /* we've found it */ | |
2126 | if (elength < sizeof(struct usb_cdc_union_desc)) | |
2127 | goto next_desc; | |
2128 | if (union_header) { | |
2129 | dev_err(&intf->dev, "More than one union descriptor, skipping ...\n"); | |
2130 | goto next_desc; | |
2131 | } | |
2132 | union_header = (struct usb_cdc_union_desc *)buffer; | |
2133 | break; | |
2134 | case USB_CDC_COUNTRY_TYPE: | |
2135 | if (elength < sizeof(struct usb_cdc_country_functional_desc)) | |
2136 | goto next_desc; | |
2137 | hdr->usb_cdc_country_functional_desc = | |
2138 | (struct usb_cdc_country_functional_desc *)buffer; | |
2139 | break; | |
2140 | case USB_CDC_HEADER_TYPE: | |
2141 | if (elength != sizeof(struct usb_cdc_header_desc)) | |
2142 | goto next_desc; | |
2143 | if (header) | |
2144 | return -EINVAL; | |
2145 | header = (struct usb_cdc_header_desc *)buffer; | |
2146 | break; | |
2147 | case USB_CDC_ACM_TYPE: | |
2148 | if (elength < sizeof(struct usb_cdc_acm_descriptor)) | |
2149 | goto next_desc; | |
2150 | hdr->usb_cdc_acm_descriptor = | |
2151 | (struct usb_cdc_acm_descriptor *)buffer; | |
2152 | break; | |
2153 | case USB_CDC_ETHERNET_TYPE: | |
2154 | if (elength != sizeof(struct usb_cdc_ether_desc)) | |
2155 | goto next_desc; | |
2156 | if (ether) | |
2157 | return -EINVAL; | |
2158 | ether = (struct usb_cdc_ether_desc *)buffer; | |
2159 | break; | |
2160 | case USB_CDC_CALL_MANAGEMENT_TYPE: | |
2161 | if (elength < sizeof(struct usb_cdc_call_mgmt_descriptor)) | |
2162 | goto next_desc; | |
2163 | hdr->usb_cdc_call_mgmt_descriptor = | |
2164 | (struct usb_cdc_call_mgmt_descriptor *)buffer; | |
2165 | break; | |
2166 | case USB_CDC_DMM_TYPE: | |
2167 | if (elength < sizeof(struct usb_cdc_dmm_desc)) | |
2168 | goto next_desc; | |
2169 | hdr->usb_cdc_dmm_desc = | |
2170 | (struct usb_cdc_dmm_desc *)buffer; | |
2171 | break; | |
2172 | case USB_CDC_MDLM_TYPE: | |
2173 | if (elength < sizeof(struct usb_cdc_mdlm_desc *)) | |
2174 | goto next_desc; | |
2175 | if (desc) | |
2176 | return -EINVAL; | |
2177 | desc = (struct usb_cdc_mdlm_desc *)buffer; | |
2178 | break; | |
2179 | case USB_CDC_MDLM_DETAIL_TYPE: | |
2180 | if (elength < sizeof(struct usb_cdc_mdlm_detail_desc *)) | |
2181 | goto next_desc; | |
2182 | if (detail) | |
2183 | return -EINVAL; | |
2184 | detail = (struct usb_cdc_mdlm_detail_desc *)buffer; | |
2185 | break; | |
2186 | case USB_CDC_NCM_TYPE: | |
2187 | if (elength < sizeof(struct usb_cdc_ncm_desc)) | |
2188 | goto next_desc; | |
2189 | hdr->usb_cdc_ncm_desc = (struct usb_cdc_ncm_desc *)buffer; | |
2190 | break; | |
2191 | case USB_CDC_MBIM_TYPE: | |
2192 | if (elength < sizeof(struct usb_cdc_mbim_desc)) | |
2193 | goto next_desc; | |
2194 | ||
2195 | hdr->usb_cdc_mbim_desc = (struct usb_cdc_mbim_desc *)buffer; | |
2196 | break; | |
2197 | case USB_CDC_MBIM_EXTENDED_TYPE: | |
2198 | if (elength < sizeof(struct usb_cdc_mbim_extended_desc)) | |
2199 | break; | |
2200 | hdr->usb_cdc_mbim_extended_desc = | |
2201 | (struct usb_cdc_mbim_extended_desc *)buffer; | |
2202 | break; | |
2203 | case CDC_PHONET_MAGIC_NUMBER: | |
2204 | hdr->phonet_magic_present = true; | |
2205 | break; | |
2206 | default: | |
2207 | /* | |
2208 | * there are LOTS more CDC descriptors that | |
2209 | * could legitimately be found here. | |
2210 | */ | |
2211 | dev_dbg(&intf->dev, "Ignoring descriptor: type %02x, length %ud\n", | |
2212 | buffer[2], elength); | |
2213 | goto next_desc; | |
2214 | } | |
2215 | cnt++; | |
2216 | next_desc: | |
2217 | buflen -= elength; | |
2218 | buffer += elength; | |
2219 | } | |
2220 | hdr->usb_cdc_union_desc = union_header; | |
2221 | hdr->usb_cdc_header_desc = header; | |
2222 | hdr->usb_cdc_mdlm_detail_desc = detail; | |
2223 | hdr->usb_cdc_mdlm_desc = desc; | |
2224 | hdr->usb_cdc_ether_desc = ether; | |
2225 | return cnt; | |
2226 | } | |
2227 | ||
2228 | EXPORT_SYMBOL(cdc_parse_cdc_header); |