blob: 5e8379b42f479febee701e6f760b8705fc3865c7 [file] [log] [blame]
Greg Kroah-Hartmanaa1f3bb2017-11-03 09:18:41 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * message.c - synchronous message handling
Greg Kroah-Hartmanb65fba32016-10-28 17:16:36 -04004 *
5 * Released under the GPLv2 only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 */
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/pci.h> /* for scatterlist macros */
9#include <linux/usb.h>
10#include <linux/module.h>
11#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/mm.h>
13#include <linux/timer.h>
14#include <linux/ctype.h>
Clemens Ladischa853a3d2009-04-24 10:12:18 +020015#include <linux/nls.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/device.h>
Ralf Baechle11763602007-10-23 20:42:11 +020017#include <linux/scatterlist.h>
Oliver Neukume4c6fb72016-07-14 15:41:30 +020018#include <linux/usb/cdc.h>
Oliver Neukum7ceec1f2007-01-26 14:26:21 +010019#include <linux/usb/quirks.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020020#include <linux/usb/hcd.h> /* for usbcore internals */
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <asm/byteorder.h>
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include "usb.h"
24
Alan Sterndf718962008-12-19 10:27:56 -050025static void cancel_async_set_config(struct usb_device *udev);
26
Alan Stern67f5dde2007-07-24 18:23:23 -040027struct api_context {
28 struct completion done;
29 int status;
30};
31
David Howells7d12e782006-10-05 14:55:46 +010032static void usb_api_blocking_completion(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -070033{
Alan Stern67f5dde2007-07-24 18:23:23 -040034 struct api_context *ctx = urb->context;
35
36 ctx->status = urb->status;
37 complete(&ctx->done);
Linus Torvalds1da177e2005-04-16 15:20:36 -070038}
39
40
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020041/*
42 * Starts urb and waits for completion or timeout. Note that this call
43 * is NOT interruptible. Many device driver i/o requests should be
44 * interruptible and therefore these drivers should implement their
45 * own interruptible routines.
46 */
47static int usb_start_wait_urb(struct urb *urb, int timeout, int *actual_length)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -080048{
Alan Stern67f5dde2007-07-24 18:23:23 -040049 struct api_context ctx;
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020050 unsigned long expire;
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -070051 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Alan Stern67f5dde2007-07-24 18:23:23 -040053 init_completion(&ctx.done);
54 urb->context = &ctx;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 urb->actual_length = 0;
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -070056 retval = usb_submit_urb(urb, GFP_NOIO);
57 if (unlikely(retval))
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020058 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020060 expire = timeout ? msecs_to_jiffies(timeout) : MAX_SCHEDULE_TIMEOUT;
Alan Stern67f5dde2007-07-24 18:23:23 -040061 if (!wait_for_completion_timeout(&ctx.done, expire)) {
62 usb_kill_urb(urb);
63 retval = (ctx.status == -ENOENT ? -ETIMEDOUT : ctx.status);
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020064
65 dev_dbg(&urb->dev->dev,
Roel Kluin71d27182009-03-13 12:19:18 +010066 "%s timed out on ep%d%s len=%u/%u\n",
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020067 current->comm,
Alan Stern5e60a162007-07-30 17:07:21 -040068 usb_endpoint_num(&urb->ep->desc),
69 usb_urb_dir_in(urb) ? "in" : "out",
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020070 urb->actual_length,
71 urb->transfer_buffer_length);
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020072 } else
Alan Stern67f5dde2007-07-24 18:23:23 -040073 retval = ctx.status;
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020074out:
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 if (actual_length)
76 *actual_length = urb->actual_length;
Franck Bui-Huuecdc0a52006-07-12 10:09:41 +020077
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 usb_free_urb(urb);
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -070079 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080}
81
82/*-------------------------------------------------------------------*/
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -080083/* returns status (negative) or length (positive) */
Linus Torvalds1da177e2005-04-16 15:20:36 -070084static int usb_internal_control_msg(struct usb_device *usb_dev,
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -080085 unsigned int pipe,
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 struct usb_ctrlrequest *cmd,
87 void *data, int len, int timeout)
88{
89 struct urb *urb;
90 int retv;
91 int length;
92
93 urb = usb_alloc_urb(0, GFP_NOIO);
94 if (!urb)
95 return -ENOMEM;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -080096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char *)cmd, data,
98 len, usb_api_blocking_completion, NULL);
99
100 retv = usb_start_wait_urb(urb, timeout, &length);
101 if (retv < 0)
102 return retv;
103 else
104 return length;
105}
106
107/**
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800108 * usb_control_msg - Builds a control urb, sends it off and waits for completion
109 * @dev: pointer to the usb device to send the message to
110 * @pipe: endpoint "pipe" to send the message to
111 * @request: USB message request value
112 * @requesttype: USB message request type value
113 * @value: USB message value
114 * @index: USB message index value
115 * @data: pointer to the data to send
116 * @size: length in bytes of the data to send
117 * @timeout: time in msecs to wait for the message to complete before timing
118 * out (if 0 the wait is forever)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 *
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800120 * Context: !in_interrupt ()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 *
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800122 * This function sends a simple control message to a specified endpoint and
123 * waits for the message to complete, or timeout.
124 *
Jaejoong Kim123b7b32017-01-18 15:19:04 +0900125 * Don't use this function from within an interrupt context. If you need
126 * an asynchronous message, or need to send a message from within interrupt
127 * context, use usb_submit_urb(). If a thread in your driver uses this call,
128 * make sure your disconnect() method can wait for it to complete. Since you
129 * don't have a handle on the URB used, you can't cancel the request.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200130 *
131 * Return: If successful, the number of bytes transferred. Otherwise, a negative
132 * error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800134int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request,
135 __u8 requesttype, __u16 value, __u16 index, void *data,
136 __u16 size, int timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137{
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800138 struct usb_ctrlrequest *dr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 int ret;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800140
141 dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 if (!dr)
143 return -ENOMEM;
144
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800145 dr->bRequestType = requesttype;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 dr->bRequest = request;
Harvey Harrisonda2bbdc2008-10-29 14:25:51 -0700147 dr->wValue = cpu_to_le16(value);
148 dr->wIndex = cpu_to_le16(index);
149 dr->wLength = cpu_to_le16(size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 ret = usb_internal_control_msg(dev, pipe, dr, data, size, timeout);
152
153 kfree(dr);
154
155 return ret;
156}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600157EXPORT_SYMBOL_GPL(usb_control_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158
159/**
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -0700160 * usb_interrupt_msg - Builds an interrupt urb, sends it off and waits for completion
161 * @usb_dev: pointer to the usb device to send the message to
162 * @pipe: endpoint "pipe" to send the message to
163 * @data: pointer to the data to send
164 * @len: length in bytes of the data to send
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800165 * @actual_length: pointer to a location to put the actual length transferred
166 * in bytes
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -0700167 * @timeout: time in msecs to wait for the message to complete before
168 * timing out (if 0 the wait is forever)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800169 *
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -0700170 * Context: !in_interrupt ()
171 *
172 * This function sends a simple interrupt message to a specified endpoint and
173 * waits for the message to complete, or timeout.
174 *
Jaejoong Kim123b7b32017-01-18 15:19:04 +0900175 * Don't use this function from within an interrupt context. If you need
176 * an asynchronous message, or need to send a message from within interrupt
177 * context, use usb_submit_urb() If a thread in your driver uses this call,
178 * make sure your disconnect() method can wait for it to complete. Since you
179 * don't have a handle on the URB used, you can't cancel the request.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200180 *
181 * Return:
182 * If successful, 0. Otherwise a negative error number. The number of actual
Masanari Iidae2278672014-02-18 22:54:36 +0900183 * bytes transferred will be stored in the @actual_length parameter.
Greg Kroah-Hartman782a7a62006-05-19 13:20:20 -0700184 */
185int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,
186 void *data, int len, int *actual_length, int timeout)
187{
188 return usb_bulk_msg(usb_dev, pipe, data, len, actual_length, timeout);
189}
190EXPORT_SYMBOL_GPL(usb_interrupt_msg);
191
192/**
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800193 * usb_bulk_msg - Builds a bulk urb, sends it off and waits for completion
194 * @usb_dev: pointer to the usb device to send the message to
195 * @pipe: endpoint "pipe" to send the message to
196 * @data: pointer to the data to send
197 * @len: length in bytes of the data to send
198 * @actual_length: pointer to a location to put the actual length transferred
199 * in bytes
200 * @timeout: time in msecs to wait for the message to complete before
201 * timing out (if 0 the wait is forever)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 *
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800203 * Context: !in_interrupt ()
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 *
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800205 * This function sends a simple bulk message to a specified endpoint
206 * and waits for the message to complete, or timeout.
Alan Sternd09d36a2005-09-26 16:22:45 -0400207 *
Jaejoong Kim123b7b32017-01-18 15:19:04 +0900208 * Don't use this function from within an interrupt context. If you need
209 * an asynchronous message, or need to send a message from within interrupt
210 * context, use usb_submit_urb() If a thread in your driver uses this call,
211 * make sure your disconnect() method can wait for it to complete. Since you
212 * don't have a handle on the URB used, you can't cancel the request.
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800213 *
214 * Because there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl,
215 * users are forced to abuse this routine by using it to submit URBs for
216 * interrupt endpoints. We will take the liberty of creating an interrupt URB
217 * (with the default interval) if the target is an interrupt endpoint.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200218 *
219 * Return:
220 * If successful, 0. Otherwise a negative error number. The number of actual
Rahul Bedarkar025d4432014-01-04 11:24:41 +0530221 * bytes transferred will be stored in the @actual_length parameter.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200222 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800224int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,
225 void *data, int len, int *actual_length, int timeout)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 struct urb *urb;
Alan Sternd09d36a2005-09-26 16:22:45 -0400228 struct usb_host_endpoint *ep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Matthew Wilcoxfe54b052010-04-30 13:11:29 -0600230 ep = usb_pipe_endpoint(usb_dev, pipe);
Alan Sternd09d36a2005-09-26 16:22:45 -0400231 if (!ep || len < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 return -EINVAL;
233
Alan Sternd09d36a2005-09-26 16:22:45 -0400234 urb = usb_alloc_urb(0, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 if (!urb)
236 return -ENOMEM;
237
Alan Sternd09d36a2005-09-26 16:22:45 -0400238 if ((ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==
239 USB_ENDPOINT_XFER_INT) {
240 pipe = (pipe & ~(3 << 30)) | (PIPE_INTERRUPT << 30);
241 usb_fill_int_urb(urb, usb_dev, pipe, data, len,
Alan Stern8d062b92007-04-23 17:30:32 -0400242 usb_api_blocking_completion, NULL,
243 ep->desc.bInterval);
Alan Sternd09d36a2005-09-26 16:22:45 -0400244 } else
245 usb_fill_bulk_urb(urb, usb_dev, pipe, data, len,
246 usb_api_blocking_completion, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 return usb_start_wait_urb(urb, timeout, actual_length);
249}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600250EXPORT_SYMBOL_GPL(usb_bulk_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
252/*-------------------------------------------------------------------*/
253
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800254static void sg_clean(struct usb_sg_request *io)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
256 if (io->urbs) {
257 while (io->entries--)
Tülin İzer085528e2013-05-17 10:32:35 +0300258 usb_free_urb(io->urbs[io->entries]);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800259 kfree(io->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 io->urbs = NULL;
261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 io->dev = NULL;
263}
264
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800265static void sg_complete(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266{
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800267 struct usb_sg_request *io = urb->context;
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700268 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800270 spin_lock(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272 /* In 2.5 we require hcds' endpoint queues not to progress after fault
273 * reports, until the completion callback (this!) returns. That lets
274 * device driver code (like this routine) unlink queued urbs first,
275 * if it needs to, since the HC won't work on them at all. So it's
276 * not possible for page N+1 to overwrite page N, and so on.
277 *
278 * That's only for "hard" faults; "soft" faults (unlinks) sometimes
279 * complete before the HCD can get requests away from hardware,
280 * though never during cleanup after a hard fault.
281 */
282 if (io->status
283 && (io->status != -ECONNRESET
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700284 || status != -ECONNRESET)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 && urb->actual_length) {
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800286 dev_err(io->dev->bus->controller,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 "dev %s ep%d%s scatterlist error %d/%d\n",
288 io->dev->devpath,
Alan Stern5e60a162007-07-30 17:07:21 -0400289 usb_endpoint_num(&urb->ep->desc),
290 usb_urb_dir_in(urb) ? "in" : "out",
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700291 status, io->status);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800292 /* BUG (); */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 }
294
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700295 if (io->status == 0 && status && status != -ECONNRESET) {
296 int i, found, retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700298 io->status = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300 /* the previous urbs, and this one, completed already.
301 * unlink pending urbs so they won't rx/tx bad data.
302 * careful: unlink can sometimes be synchronous...
303 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800304 spin_unlock(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 for (i = 0, found = 0; i < io->entries; i++) {
David Mosberger98b74b02016-03-08 14:42:48 -0700306 if (!io->urbs[i])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 continue;
308 if (found) {
David Mosberger98b74b02016-03-08 14:42:48 -0700309 usb_block_urb(io->urbs[i]);
Tülin İzer085528e2013-05-17 10:32:35 +0300310 retval = usb_unlink_urb(io->urbs[i]);
Greg Kroah-Hartman3fc3e822007-07-18 10:58:02 -0700311 if (retval != -EINPROGRESS &&
312 retval != -ENODEV &&
Alan Sternbcf39852012-03-22 11:00:21 -0400313 retval != -EBUSY &&
314 retval != -EIDRM)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800315 dev_err(&io->dev->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316 "%s, unlink --> %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800317 __func__, retval);
Tülin İzer085528e2013-05-17 10:32:35 +0300318 } else if (urb == io->urbs[i])
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 found = 1;
320 }
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800321 spin_lock(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324 /* on the last completion, signal usb_sg_wait() */
325 io->bytes += urb->actual_length;
326 io->count--;
327 if (!io->count)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800328 complete(&io->complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800330 spin_unlock(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
332
333
334/**
335 * usb_sg_init - initializes scatterlist-based bulk/interrupt I/O request
336 * @io: request block being initialized. until usb_sg_wait() returns,
337 * treat this as a pointer to an opaque block of memory,
338 * @dev: the usb device that will send or receive the data
339 * @pipe: endpoint "pipe" used to transfer the data
340 * @period: polling rate for interrupt endpoints, in frames or
341 * (for high speed endpoints) microframes; ignored for bulk
342 * @sg: scatterlist entries
343 * @nents: how many entries in the scatterlist
344 * @length: how many bytes to send from the scatterlist, or zero to
345 * send every byte identified in the list.
346 * @mem_flags: SLAB_* flags affecting memory allocations in this call
347 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200348 * This initializes a scatter/gather request, allocating resources such as
349 * I/O mappings and urb memory (except maybe memory used by USB controller
350 * drivers).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 *
352 * The request must be issued using usb_sg_wait(), which waits for the I/O to
353 * complete (or to be canceled) and then cleans up all resources allocated by
354 * usb_sg_init().
355 *
356 * The request may be canceled with usb_sg_cancel(), either before or after
357 * usb_sg_wait() is called.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200358 *
359 * Return: Zero for success, else a negative errno value.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800361int usb_sg_init(struct usb_sg_request *io, struct usb_device *dev,
362 unsigned pipe, unsigned period, struct scatterlist *sg,
363 int nents, size_t length, gfp_t mem_flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364{
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800365 int i;
366 int urb_flags;
Sarah Sharpe04748e2009-04-27 19:59:01 -0700367 int use_sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
369 if (!io || !dev || !sg
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800370 || usb_pipecontrol(pipe)
371 || usb_pipeisoc(pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 || nents <= 0)
373 return -EINVAL;
374
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800375 spin_lock_init(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 io->dev = dev;
377 io->pipe = pipe;
Alan Stern0ba169af2010-05-05 15:26:17 -0400378
379 if (dev->bus->sg_tablesize > 0) {
380 use_sg = true;
381 io->entries = 1;
382 } else {
383 use_sg = false;
384 io->entries = nents;
385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387 /* initialize all the urbs we'll use */
Tülin İzera1fefaa2013-05-17 10:33:05 +0300388 io->urbs = kmalloc(io->entries * sizeof(*io->urbs), mem_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 if (!io->urbs)
390 goto nomem;
391
Alan Stern0ba169af2010-05-05 15:26:17 -0400392 urb_flags = URB_NO_INTERRUPT;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800393 if (usb_pipein(pipe))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 urb_flags |= URB_SHORT_NOT_OK;
395
Alan Stern0ba169af2010-05-05 15:26:17 -0400396 for_each_sg(sg, sg, io->entries, i) {
397 struct urb *urb;
398 unsigned len;
399
400 urb = usb_alloc_urb(0, mem_flags);
401 if (!urb) {
402 io->entries = i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 goto nomem;
404 }
Alan Stern0ba169af2010-05-05 15:26:17 -0400405 io->urbs[i] = urb;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Alan Stern0ba169af2010-05-05 15:26:17 -0400407 urb->dev = NULL;
408 urb->pipe = pipe;
409 urb->interval = period;
410 urb->transfer_flags = urb_flags;
411 urb->complete = sg_complete;
412 urb->context = io;
413 urb->sg = sg;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Alan Stern0ba169af2010-05-05 15:26:17 -0400415 if (use_sg) {
416 /* There is no single transfer buffer */
417 urb->transfer_buffer = NULL;
418 urb->num_sgs = nents;
Alan Sternff9c8952010-04-02 13:27:28 -0400419
Alan Stern0ba169af2010-05-05 15:26:17 -0400420 /* A length of zero means transfer the whole sg list */
421 len = length;
422 if (len == 0) {
Alan Stern64d65872010-06-18 10:16:33 -0400423 struct scatterlist *sg2;
424 int j;
425
426 for_each_sg(sg, sg2, nents, j)
427 len += sg2->length;
Sarah Sharpe04748e2009-04-27 19:59:01 -0700428 }
Alan Stern0ba169af2010-05-05 15:26:17 -0400429 } else {
Sarah Sharpe04748e2009-04-27 19:59:01 -0700430 /*
Alan Sternff9c8952010-04-02 13:27:28 -0400431 * Some systems can't use DMA; they use PIO instead.
432 * For their sakes, transfer_buffer is set whenever
433 * possible.
Sarah Sharpe04748e2009-04-27 19:59:01 -0700434 */
Alan Sternff9c8952010-04-02 13:27:28 -0400435 if (!PageHighMem(sg_page(sg)))
Alan Stern0ba169af2010-05-05 15:26:17 -0400436 urb->transfer_buffer = sg_virt(sg);
Pete Zaitcev81bf46f2009-06-11 08:40:39 -0600437 else
Alan Stern0ba169af2010-05-05 15:26:17 -0400438 urb->transfer_buffer = NULL;
Pete Zaitcev81bf46f2009-06-11 08:40:39 -0600439
Alan Sternff9c8952010-04-02 13:27:28 -0400440 len = sg->length;
Sarah Sharpe04748e2009-04-27 19:59:01 -0700441 if (length) {
Dan Carpenteredb2b252011-09-27 09:25:19 +0300442 len = min_t(size_t, len, length);
Sarah Sharpe04748e2009-04-27 19:59:01 -0700443 length -= len;
444 if (length == 0)
445 io->entries = i + 1;
446 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 }
Alan Stern0ba169af2010-05-05 15:26:17 -0400448 urb->transfer_buffer_length = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 }
Alan Stern0ba169af2010-05-05 15:26:17 -0400450 io->urbs[--i]->transfer_flags &= ~URB_NO_INTERRUPT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452 /* transaction state */
Alan Stern580da342008-08-05 13:05:17 -0400453 io->count = io->entries;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 io->status = 0;
455 io->bytes = 0;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800456 init_completion(&io->complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 return 0;
458
459nomem:
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800460 sg_clean(io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 return -ENOMEM;
462}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600463EXPORT_SYMBOL_GPL(usb_sg_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
465/**
466 * usb_sg_wait - synchronously execute scatter/gather request
467 * @io: request block handle, as initialized with usb_sg_init().
468 * some fields become accessible when this call returns.
469 * Context: !in_interrupt ()
470 *
471 * This function blocks until the specified I/O operation completes. It
472 * leverages the grouping of the related I/O requests to get good transfer
473 * rates, by queueing the requests. At higher speeds, such queuing can
474 * significantly improve USB throughput.
475 *
476 * There are three kinds of completion for this function.
Mauro Carvalho Chehabe0c34e92017-04-05 10:23:12 -0300477 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 * (1) success, where io->status is zero. The number of io->bytes
479 * transferred is as requested.
480 * (2) error, where io->status is a negative errno value. The number
481 * of io->bytes transferred before the error is usually less
482 * than requested, and can be nonzero.
Steven Cole093cf722005-05-03 19:07:24 -0600483 * (3) cancellation, a type of error with status -ECONNRESET that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 * is initiated by usb_sg_cancel().
485 *
486 * When this function returns, all memory allocated through usb_sg_init() or
487 * this call will have been freed. The request block parameter may still be
488 * passed to usb_sg_cancel(), or it may be freed. It could also be
489 * reinitialized and then reused.
490 *
491 * Data Transfer Rates:
492 *
493 * Bulk transfers are valid for full or high speed endpoints.
494 * The best full speed data rate is 19 packets of 64 bytes each
495 * per frame, or 1216 bytes per millisecond.
496 * The best high speed data rate is 13 packets of 512 bytes each
497 * per microframe, or 52 KBytes per millisecond.
498 *
499 * The reason to use interrupt transfers through this API would most likely
500 * be to reserve high speed bandwidth, where up to 24 KBytes per millisecond
501 * could be transferred. That capability is less useful for low or full
502 * speed interrupt endpoints, which allow at most one packet per millisecond,
503 * of at most 8 or 64 bytes (respectively).
Sarah Sharp79abb1a2009-04-27 19:58:26 -0700504 *
505 * It is not necessary to call this function to reserve bandwidth for devices
506 * under an xHCI host controller, as the bandwidth is reserved when the
507 * configuration or interface alt setting is selected.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800509void usb_sg_wait(struct usb_sg_request *io)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800511 int i;
512 int entries = io->entries;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
514 /* queue the urbs. */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800515 spin_lock_irq(&io->lock);
Alan Stern8ccef0d2007-06-21 16:26:46 -0400516 i = 0;
517 while (i < entries && !io->status) {
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800518 int retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800520 io->urbs[i]->dev = io->dev;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800521 spin_unlock_irq(&io->lock);
David Mosberger98b74b02016-03-08 14:42:48 -0700522
523 retval = usb_submit_urb(io->urbs[i], GFP_NOIO);
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 switch (retval) {
526 /* maybe we retrying will recover */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800527 case -ENXIO: /* hc didn't queue this one */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 case -EAGAIN:
529 case -ENOMEM:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 retval = 0;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800531 yield();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 break;
533
534 /* no error? continue immediately.
535 *
536 * NOTE: to work better with UHCI (4K I/O buffer may
537 * need 3K of TDs) it may be good to limit how many
538 * URBs are queued at once; N milliseconds?
539 */
540 case 0:
Alan Stern8ccef0d2007-06-21 16:26:46 -0400541 ++i;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800542 cpu_relax();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 break;
544
545 /* fail any uncompleted urbs */
546 default:
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800547 io->urbs[i]->status = retval;
548 dev_dbg(&io->dev->dev, "%s, submit --> %d\n",
Harvey Harrison441b62c2008-03-03 16:08:34 -0800549 __func__, retval);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800550 usb_sg_cancel(io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 }
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800552 spin_lock_irq(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 if (retval && (io->status == 0 || io->status == -ECONNRESET))
554 io->status = retval;
555 }
556 io->count -= entries - i;
557 if (io->count == 0)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800558 complete(&io->complete);
559 spin_unlock_irq(&io->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
561 /* OK, yes, this could be packaged as non-blocking.
562 * So could the submit loop above ... but it's easier to
563 * solve neither problem than to solve both!
564 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800565 wait_for_completion(&io->complete);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800567 sg_clean(io);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600569EXPORT_SYMBOL_GPL(usb_sg_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571/**
572 * usb_sg_cancel - stop scatter/gather i/o issued by usb_sg_wait()
573 * @io: request block, initialized with usb_sg_init()
574 *
575 * This stops a request after it has been started by usb_sg_wait().
576 * It can also prevents one initialized by usb_sg_init() from starting,
577 * so that call just frees resources allocated to the request.
578 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800579void usb_sg_cancel(struct usb_sg_request *io)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800581 unsigned long flags;
David Mosberger5f2e5fb2016-03-08 14:42:49 -0700582 int i, retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800584 spin_lock_irqsave(&io->lock, flags);
David Mosberger5f2e5fb2016-03-08 14:42:49 -0700585 if (io->status) {
586 spin_unlock_irqrestore(&io->lock, flags);
587 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 }
David Mosberger5f2e5fb2016-03-08 14:42:49 -0700589 /* shut everything down */
590 io->status = -ECONNRESET;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800591 spin_unlock_irqrestore(&io->lock, flags);
David Mosberger5f2e5fb2016-03-08 14:42:49 -0700592
593 for (i = io->entries - 1; i >= 0; --i) {
594 usb_block_urb(io->urbs[i]);
595
596 retval = usb_unlink_urb(io->urbs[i]);
597 if (retval != -EINPROGRESS
598 && retval != -ENODEV
599 && retval != -EBUSY
600 && retval != -EIDRM)
601 dev_warn(&io->dev->dev, "%s, unlink --> %d\n",
602 __func__, retval);
603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600605EXPORT_SYMBOL_GPL(usb_sg_cancel);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607/*-------------------------------------------------------------------*/
608
609/**
610 * usb_get_descriptor - issues a generic GET_DESCRIPTOR request
611 * @dev: the device whose descriptor is being retrieved
612 * @type: the descriptor type (USB_DT_*)
613 * @index: the number of the descriptor
614 * @buf: where to put the descriptor
615 * @size: how big is "buf"?
616 * Context: !in_interrupt ()
617 *
618 * Gets a USB descriptor. Convenience functions exist to simplify
619 * getting some types of descriptors. Use
620 * usb_get_string() or usb_string() for USB_DT_STRING.
621 * Device (USB_DT_DEVICE) and configuration descriptors (USB_DT_CONFIG)
622 * are part of the device structure.
623 * In addition to a number of USB-standard descriptors, some
624 * devices also use class-specific or vendor-specific descriptors.
625 *
626 * This call is synchronous, and may not be used in an interrupt context.
627 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200628 * Return: The number of bytes received on success, or else the status code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 * returned by the underlying usb_control_msg() call.
630 */
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800631int usb_get_descriptor(struct usb_device *dev, unsigned char type,
632 unsigned char index, void *buf, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 int i;
635 int result;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800636
637 memset(buf, 0, size); /* Make sure we parse really received data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 for (i = 0; i < 3; ++i) {
Alan Sternc39772d2007-08-20 10:45:28 -0400640 /* retry on length 0 or error; some devices are flakey */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
642 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
643 (type << 8) + index, 0, buf, size,
644 USB_CTRL_GET_TIMEOUT);
Alan Sternc39772d2007-08-20 10:45:28 -0400645 if (result <= 0 && result != -ETIMEDOUT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 continue;
647 if (result > 1 && ((u8 *)buf)[1] != type) {
Alan Stern67f5a4b2009-02-20 16:33:08 -0500648 result = -ENODATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 continue;
650 }
651 break;
652 }
653 return result;
654}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600655EXPORT_SYMBOL_GPL(usb_get_descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656
657/**
658 * usb_get_string - gets a string descriptor
659 * @dev: the device whose string descriptor is being retrieved
660 * @langid: code for language chosen (from string descriptor zero)
661 * @index: the number of the descriptor
662 * @buf: where to put the string
663 * @size: how big is "buf"?
664 * Context: !in_interrupt ()
665 *
666 * Retrieves a string, encoded using UTF-16LE (Unicode, 16 bits per character,
667 * in little-endian byte order).
668 * The usb_string() function will often be a convenient way to turn
669 * these strings into kernel-printable form.
670 *
671 * Strings may be referenced in device, configuration, interface, or other
672 * descriptors, and could also be used in vendor-specific ways.
673 *
674 * This call is synchronous, and may not be used in an interrupt context.
675 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200676 * Return: The number of bytes received on success, or else the status code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 * returned by the underlying usb_control_msg() call.
678 */
Adrian Bunke266a122005-11-08 21:05:43 +0100679static int usb_get_string(struct usb_device *dev, unsigned short langid,
680 unsigned char index, void *buf, int size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
682 int i;
683 int result;
684
685 for (i = 0; i < 3; ++i) {
686 /* retry on length 0 or stall; some devices are flakey */
687 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
688 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
689 (USB_DT_STRING << 8) + index, langid, buf, size,
690 USB_CTRL_GET_TIMEOUT);
Alan Stern67f5a4b2009-02-20 16:33:08 -0500691 if (result == 0 || result == -EPIPE)
692 continue;
693 if (result > 1 && ((u8 *) buf)[1] != USB_DT_STRING) {
694 result = -ENODATA;
695 continue;
696 }
697 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 }
699 return result;
700}
701
702static void usb_try_string_workarounds(unsigned char *buf, int *length)
703{
704 int newlength, oldlength = *length;
705
706 for (newlength = 2; newlength + 1 < oldlength; newlength += 2)
707 if (!isprint(buf[newlength]) || buf[newlength + 1])
708 break;
709
710 if (newlength > 2) {
711 buf[0] = newlength;
712 *length = newlength;
713 }
714}
715
716static int usb_string_sub(struct usb_device *dev, unsigned int langid,
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800717 unsigned int index, unsigned char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718{
719 int rc;
720
721 /* Try to read the string descriptor by asking for the maximum
722 * possible number of bytes */
Oliver Neukum7ceec1f2007-01-26 14:26:21 +0100723 if (dev->quirks & USB_QUIRK_STRING_FETCH_255)
724 rc = -EIO;
725 else
726 rc = usb_get_string(dev, langid, index, buf, 255);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728 /* If that failed try to read the descriptor length, then
729 * ask for just that many bytes */
730 if (rc < 2) {
731 rc = usb_get_string(dev, langid, index, buf, 2);
732 if (rc == 2)
733 rc = usb_get_string(dev, langid, index, buf, buf[0]);
734 }
735
736 if (rc >= 2) {
737 if (!buf[0] && !buf[1])
738 usb_try_string_workarounds(buf, &rc);
739
740 /* There might be extra junk at the end of the descriptor */
741 if (buf[0] < rc)
742 rc = buf[0];
743
744 rc = rc - (rc & 1); /* force a multiple of two */
745 }
746
747 if (rc < 2)
748 rc = (rc < 0 ? rc : -EINVAL);
749
750 return rc;
751}
752
Daniel Mack0cce2ed2009-07-10 11:04:58 +0200753static int usb_get_langid(struct usb_device *dev, unsigned char *tbuf)
754{
755 int err;
756
757 if (dev->have_langid)
758 return 0;
759
760 if (dev->string_langid < 0)
761 return -EPIPE;
762
763 err = usb_string_sub(dev, 0, 0, tbuf);
764
765 /* If the string was reported but is malformed, default to english
766 * (0x0409) */
767 if (err == -ENODATA || (err > 0 && err < 4)) {
768 dev->string_langid = 0x0409;
769 dev->have_langid = 1;
770 dev_err(&dev->dev,
Scot Doyle586af072014-09-25 15:16:48 +0000771 "language id specifier not provided by device, defaulting to English\n");
Daniel Mack0cce2ed2009-07-10 11:04:58 +0200772 return 0;
773 }
774
775 /* In case of all other errors, we assume the device is not able to
776 * deal with strings at all. Set string_langid to -1 in order to
777 * prevent any string to be retrieved from the device */
778 if (err < 0) {
779 dev_err(&dev->dev, "string descriptor 0 read error: %d\n",
780 err);
781 dev->string_langid = -1;
782 return -EPIPE;
783 }
784
785 /* always use the first langid listed */
786 dev->string_langid = tbuf[2] | (tbuf[3] << 8);
787 dev->have_langid = 1;
788 dev_dbg(&dev->dev, "default language 0x%04x\n",
789 dev->string_langid);
790 return 0;
791}
792
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793/**
Clemens Ladischa853a3d2009-04-24 10:12:18 +0200794 * usb_string - returns UTF-8 version of a string descriptor
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 * @dev: the device whose string descriptor is being retrieved
796 * @index: the number of the descriptor
797 * @buf: where to put the string
798 * @size: how big is "buf"?
799 * Context: !in_interrupt ()
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800800 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 * This converts the UTF-16LE encoded strings returned by devices, from
Clemens Ladischa853a3d2009-04-24 10:12:18 +0200802 * usb_get_string_descriptor(), to null-terminated UTF-8 encoded ones
803 * that are more usable in most kernel contexts. Note that this function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 * chooses strings in the first language supported by the device.
805 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 * This call is synchronous, and may not be used in an interrupt context.
807 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200808 * Return: length of the string (>= 0) or usb_control_msg status (< 0).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 */
810int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
811{
812 unsigned char *tbuf;
813 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814
815 if (dev->state == USB_STATE_SUSPENDED)
816 return -EHOSTUNREACH;
817 if (size <= 0 || !buf || !index)
818 return -EINVAL;
819 buf[0] = 0;
Alan Stern74675a52009-04-30 10:08:18 -0400820 tbuf = kmalloc(256, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 if (!tbuf)
822 return -ENOMEM;
823
Daniel Mack0cce2ed2009-07-10 11:04:58 +0200824 err = usb_get_langid(dev, tbuf);
825 if (err < 0)
826 goto errout;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800827
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 err = usb_string_sub(dev, dev->string_langid, index, tbuf);
829 if (err < 0)
830 goto errout;
831
832 size--; /* leave room for trailing NULL char in output buffer */
Alan Stern74675a52009-04-30 10:08:18 -0400833 err = utf16s_to_utf8s((wchar_t *) &tbuf[2], (err - 2) / 2,
834 UTF16_LITTLE_ENDIAN, buf, size);
Clemens Ladischa853a3d2009-04-24 10:12:18 +0200835 buf[err] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
837 if (tbuf[1] != USB_DT_STRING)
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800838 dev_dbg(&dev->dev,
839 "wrong descriptor type %02x for string %d (\"%s\")\n",
840 tbuf[1], index, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
842 errout:
843 kfree(tbuf);
844 return err;
845}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600846EXPORT_SYMBOL_GPL(usb_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Clemens Ladischa853a3d2009-04-24 10:12:18 +0200848/* one UTF-8-encoded 16-bit character has at most three bytes */
849#define MAX_USB_STRING_SIZE (127 * 3 + 1)
850
Alan Stern4f62efe2005-10-24 16:24:14 -0400851/**
852 * usb_cache_string - read a string descriptor and cache it for later use
853 * @udev: the device whose string descriptor is being read
854 * @index: the descriptor index
855 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200856 * Return: A pointer to a kmalloc'ed buffer containing the descriptor string,
857 * or %NULL if the index is 0 or the string could not be read.
Alan Stern4f62efe2005-10-24 16:24:14 -0400858 */
859char *usb_cache_string(struct usb_device *udev, int index)
860{
861 char *buf;
862 char *smallbuf = NULL;
863 int len;
864
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800865 if (index <= 0)
866 return NULL;
867
Oliver Neukumacbe2fe2010-01-12 12:32:50 +0100868 buf = kmalloc(MAX_USB_STRING_SIZE, GFP_NOIO);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800869 if (buf) {
Clemens Ladischa853a3d2009-04-24 10:12:18 +0200870 len = usb_string(udev, index, buf, MAX_USB_STRING_SIZE);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800871 if (len > 0) {
Oliver Neukumacbe2fe2010-01-12 12:32:50 +0100872 smallbuf = kmalloc(++len, GFP_NOIO);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800873 if (!smallbuf)
Alan Stern4f62efe2005-10-24 16:24:14 -0400874 return buf;
875 memcpy(smallbuf, buf, len);
876 }
877 kfree(buf);
878 }
879 return smallbuf;
880}
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882/*
883 * usb_get_device_descriptor - (re)reads the device descriptor (usbcore)
884 * @dev: the device whose device descriptor is being updated
885 * @size: how much of the descriptor to read
886 * Context: !in_interrupt ()
887 *
888 * Updates the copy of the device descriptor stored in the device structure,
Laurent Pinchart6ab16a92006-11-07 10:16:25 +0100889 * which dedicates space for this purpose.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 *
891 * Not exported, only for use by the core. If drivers really want to read
892 * the device descriptor directly, they can call usb_get_descriptor() with
893 * type = USB_DT_DEVICE and index = 0.
894 *
895 * This call is synchronous, and may not be used in an interrupt context.
896 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200897 * Return: The number of bytes received on success, or else the status code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 * returned by the underlying usb_control_msg() call.
899 */
900int usb_get_device_descriptor(struct usb_device *dev, unsigned int size)
901{
902 struct usb_device_descriptor *desc;
903 int ret;
904
905 if (size > sizeof(*desc))
906 return -EINVAL;
907 desc = kmalloc(sizeof(*desc), GFP_NOIO);
908 if (!desc)
909 return -ENOMEM;
910
911 ret = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, size);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800912 if (ret >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 memcpy(&dev->descriptor, desc, size);
914 kfree(desc);
915 return ret;
916}
917
918/**
919 * usb_get_status - issues a GET_STATUS call
920 * @dev: the device whose status is being checked
921 * @type: USB_RECIP_*; for device, interface, or endpoint
922 * @target: zero (for device), else interface or endpoint number
923 * @data: pointer to two bytes of bitmap data
924 * Context: !in_interrupt ()
925 *
926 * Returns device, interface, or endpoint status. Normally only of
927 * interest to see if the device is self powered, or has enabled the
928 * remote wakeup facility; or whether a bulk or interrupt endpoint
929 * is halted ("stalled").
930 *
931 * Bits in these status bitmaps are set using the SET_FEATURE request,
932 * and cleared using the CLEAR_FEATURE request. The usb_clear_halt()
933 * function should be used to clear halt ("stall") status.
934 *
935 * This call is synchronous, and may not be used in an interrupt context.
936 *
Alan Stern15b73362013-07-30 15:35:40 -0400937 * Returns 0 and the status value in *@data (in host byte order) on success,
938 * or else the status code from the underlying usb_control_msg() call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 */
940int usb_get_status(struct usb_device *dev, int type, int target, void *data)
941{
942 int ret;
Alan Stern15b73362013-07-30 15:35:40 -0400943 __le16 *status = kmalloc(sizeof(*status), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
945 if (!status)
946 return -ENOMEM;
947
948 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
949 USB_REQ_GET_STATUS, USB_DIR_IN | type, 0, target, status,
950 sizeof(*status), USB_CTRL_GET_TIMEOUT);
951
Alan Stern15b73362013-07-30 15:35:40 -0400952 if (ret == 2) {
953 *(u16 *) data = le16_to_cpu(*status);
954 ret = 0;
955 } else if (ret >= 0) {
956 ret = -EIO;
957 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 kfree(status);
959 return ret;
960}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -0600961EXPORT_SYMBOL_GPL(usb_get_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
963/**
964 * usb_clear_halt - tells device to clear endpoint halt/stall condition
965 * @dev: device whose endpoint is halted
966 * @pipe: endpoint "pipe" being cleared
967 * Context: !in_interrupt ()
968 *
969 * This is used to clear halt conditions for bulk and interrupt endpoints,
970 * as reported by URB completion status. Endpoints that are halted are
971 * sometimes referred to as being "stalled". Such endpoints are unable
972 * to transmit or receive data until the halt status is cleared. Any URBs
973 * queued for such an endpoint should normally be unlinked by the driver
974 * before clearing the halt condition, as described in sections 5.7.5
975 * and 5.8.5 of the USB 2.0 spec.
976 *
977 * Note that control and isochronous endpoints don't halt, although control
978 * endpoints report "protocol stall" (for unsupported requests) using the
979 * same status code used to report a true stall.
980 *
981 * This call is synchronous, and may not be used in an interrupt context.
982 *
Yacine Belkadi626f0902013-08-02 20:10:04 +0200983 * Return: Zero on success, or else the status code returned by the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 * underlying usb_control_msg() call.
985 */
986int usb_clear_halt(struct usb_device *dev, int pipe)
987{
988 int result;
989 int endp = usb_pipeendpoint(pipe);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -0800990
991 if (usb_pipein(pipe))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 endp |= USB_DIR_IN;
993
994 /* we don't care if it wasn't halted first. in fact some devices
995 * (like some ibmcam model 1 units) seem to expect hosts to make
996 * this request for iso endpoints, which can't halt!
997 */
998 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
999 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
1000 USB_ENDPOINT_HALT, endp, NULL, 0,
1001 USB_CTRL_SET_TIMEOUT);
1002
1003 /* don't un-halt or force to DATA0 except on success */
1004 if (result < 0)
1005 return result;
1006
1007 /* NOTE: seems like Microsoft and Apple don't bother verifying
1008 * the clear "took", so some devices could lock up if you check...
1009 * such as the Hagiwara FlashGate DUAL. So we won't bother.
1010 *
1011 * NOTE: make sure the logic here doesn't diverge much from
1012 * the copy in usb-storage, for as long as we need two copies.
1013 */
1014
David Vrabel3444b262009-04-08 17:36:28 +00001015 usb_reset_endpoint(dev, endp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 return 0;
1018}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001019EXPORT_SYMBOL_GPL(usb_clear_halt);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Alan Stern3b23dd62008-12-05 14:10:34 -05001021static int create_intf_ep_devs(struct usb_interface *intf)
1022{
1023 struct usb_device *udev = interface_to_usbdev(intf);
1024 struct usb_host_interface *alt = intf->cur_altsetting;
1025 int i;
1026
1027 if (intf->ep_devs_created || intf->unregistering)
1028 return 0;
1029
1030 for (i = 0; i < alt->desc.bNumEndpoints; ++i)
1031 (void) usb_create_ep_devs(&intf->dev, &alt->endpoint[i], udev);
1032 intf->ep_devs_created = 1;
1033 return 0;
1034}
1035
1036static void remove_intf_ep_devs(struct usb_interface *intf)
1037{
1038 struct usb_host_interface *alt = intf->cur_altsetting;
1039 int i;
1040
1041 if (!intf->ep_devs_created)
1042 return;
1043
1044 for (i = 0; i < alt->desc.bNumEndpoints; ++i)
1045 usb_remove_ep_devs(&alt->endpoint[i]);
1046 intf->ep_devs_created = 0;
1047}
1048
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049/**
1050 * usb_disable_endpoint -- Disable an endpoint by address
1051 * @dev: the device whose endpoint is being disabled
1052 * @epaddr: the endpoint's address. Endpoint number for output,
1053 * endpoint number + USB_DIR_IN for input
Alan Sternddeac4e2009-01-15 17:03:33 -05001054 * @reset_hardware: flag to erase any endpoint state stored in the
1055 * controller hardware
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 *
Alan Sternddeac4e2009-01-15 17:03:33 -05001057 * Disables the endpoint for URB submission and nukes all pending URBs.
1058 * If @reset_hardware is set then also deallocates hcd/hardware state
1059 * for the endpoint.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 */
Alan Sternddeac4e2009-01-15 17:03:33 -05001061void usb_disable_endpoint(struct usb_device *dev, unsigned int epaddr,
1062 bool reset_hardware)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063{
1064 unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK;
1065 struct usb_host_endpoint *ep;
1066
1067 if (!dev)
1068 return;
1069
1070 if (usb_endpoint_out(epaddr)) {
1071 ep = dev->ep_out[epnum];
Alan Sternddeac4e2009-01-15 17:03:33 -05001072 if (reset_hardware)
1073 dev->ep_out[epnum] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 } else {
1075 ep = dev->ep_in[epnum];
Alan Sternddeac4e2009-01-15 17:03:33 -05001076 if (reset_hardware)
1077 dev->ep_in[epnum] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 }
Alan Sternbdd016b2007-07-30 17:05:22 -04001079 if (ep) {
1080 ep->enabled = 0;
Alan Stern95cf82f2007-09-10 11:33:05 -04001081 usb_hcd_flush_endpoint(dev, ep);
Alan Sternddeac4e2009-01-15 17:03:33 -05001082 if (reset_hardware)
1083 usb_hcd_disable_endpoint(dev, ep);
Alan Sternbdd016b2007-07-30 17:05:22 -04001084 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085}
1086
1087/**
David Vrabel3444b262009-04-08 17:36:28 +00001088 * usb_reset_endpoint - Reset an endpoint's state.
1089 * @dev: the device whose endpoint is to be reset
1090 * @epaddr: the endpoint's address. Endpoint number for output,
1091 * endpoint number + USB_DIR_IN for input
1092 *
1093 * Resets any host-side endpoint state such as the toggle bit,
1094 * sequence number or current window.
1095 */
1096void usb_reset_endpoint(struct usb_device *dev, unsigned int epaddr)
1097{
1098 unsigned int epnum = epaddr & USB_ENDPOINT_NUMBER_MASK;
1099 struct usb_host_endpoint *ep;
1100
1101 if (usb_endpoint_out(epaddr))
1102 ep = dev->ep_out[epnum];
1103 else
1104 ep = dev->ep_in[epnum];
1105 if (ep)
1106 usb_hcd_reset_endpoint(dev, ep);
1107}
1108EXPORT_SYMBOL_GPL(usb_reset_endpoint);
1109
1110
1111/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 * usb_disable_interface -- Disable all endpoints for an interface
1113 * @dev: the device whose interface is being disabled
1114 * @intf: pointer to the interface descriptor
Alan Sternddeac4e2009-01-15 17:03:33 -05001115 * @reset_hardware: flag to erase any endpoint state stored in the
1116 * controller hardware
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 *
1118 * Disables all the endpoints for the interface's current altsetting.
1119 */
Alan Sternddeac4e2009-01-15 17:03:33 -05001120void usb_disable_interface(struct usb_device *dev, struct usb_interface *intf,
1121 bool reset_hardware)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122{
1123 struct usb_host_interface *alt = intf->cur_altsetting;
1124 int i;
1125
1126 for (i = 0; i < alt->desc.bNumEndpoints; ++i) {
1127 usb_disable_endpoint(dev,
Alan Sternddeac4e2009-01-15 17:03:33 -05001128 alt->endpoint[i].desc.bEndpointAddress,
1129 reset_hardware);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 }
1131}
1132
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001133/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 * usb_disable_device - Disable all the endpoints for a USB device
1135 * @dev: the device whose endpoints are being disabled
1136 * @skip_ep0: 0 to disable endpoint 0, 1 to skip it.
1137 *
1138 * Disables all the device's endpoints, potentially including endpoint 0.
1139 * Deallocates hcd/hardware state for the endpoints (nuking all or most
1140 * pending urbs) and usbcore state for the interfaces, so that usbcore
1141 * must usb_set_configuration() before any interfaces could be used.
1142 */
1143void usb_disable_device(struct usb_device *dev, int skip_ep0)
1144{
1145 int i;
Sarah Sharpfccf4e82011-06-05 23:22:22 -07001146 struct usb_hcd *hcd = bus_to_hcd(dev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 /* getting rid of interfaces will disconnect
1149 * any drivers bound to them (a key side effect)
1150 */
1151 if (dev->actconfig) {
Alan Sternca5c4852011-07-06 17:03:45 -04001152 /*
1153 * FIXME: In order to avoid self-deadlock involving the
1154 * bandwidth_mutex, we have to mark all the interfaces
1155 * before unregistering any of them.
1156 */
1157 for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++)
1158 dev->actconfig->interface[i]->unregistering = 1;
1159
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) {
1161 struct usb_interface *interface;
1162
Alan Stern86d30742005-07-29 12:17:16 -07001163 /* remove this interface if it has been registered */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 interface = dev->actconfig->interface[i];
Daniel Ritzd305ef52005-09-22 00:47:24 -07001165 if (!device_is_registered(&interface->dev))
Alan Stern86d30742005-07-29 12:17:16 -07001166 continue;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001167 dev_dbg(&dev->dev, "unregistering interface %s\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +02001168 dev_name(&interface->dev));
Alan Stern3b23dd62008-12-05 14:10:34 -05001169 remove_intf_ep_devs(interface);
Alan Stern1a211752008-07-30 11:31:50 -04001170 device_del(&interface->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 }
1172
1173 /* Now that the interfaces are unbound, nobody should
1174 * try to access them.
1175 */
1176 for (i = 0; i < dev->actconfig->desc.bNumInterfaces; i++) {
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001177 put_device(&dev->actconfig->interface[i]->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 dev->actconfig->interface[i] = NULL;
1179 }
Sarah Sharpf468f7b2013-10-08 08:28:43 -07001180
1181 if (dev->usb2_hw_lpm_enabled == 1)
1182 usb_set_usb2_hardware_lpm(dev, 0);
Sarah Sharp24971912012-07-05 14:09:30 -07001183 usb_unlocked_disable_lpm(dev);
Sarah Sharpf74631e2012-06-25 12:08:08 -07001184 usb_disable_ltm(dev);
Sarah Sharpf468f7b2013-10-08 08:28:43 -07001185
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186 dev->actconfig = NULL;
1187 if (dev->state == USB_STATE_CONFIGURED)
1188 usb_set_device_state(dev, USB_STATE_ADDRESS);
1189 }
Alan Stern80f0cf32010-09-30 15:16:23 -04001190
1191 dev_dbg(&dev->dev, "%s nuking %s URBs\n", __func__,
1192 skip_ep0 ? "non-ep0" : "all");
Sarah Sharpfccf4e82011-06-05 23:22:22 -07001193 if (hcd->driver->check_bandwidth) {
1194 /* First pass: Cancel URBs, leave endpoint pointers intact. */
1195 for (i = skip_ep0; i < 16; ++i) {
1196 usb_disable_endpoint(dev, i, false);
1197 usb_disable_endpoint(dev, i + USB_DIR_IN, false);
1198 }
1199 /* Remove endpoints from the host controller internal state */
Alan Stern8963c482012-04-17 15:22:39 -04001200 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharpfccf4e82011-06-05 23:22:22 -07001201 usb_hcd_alloc_bandwidth(dev, NULL, NULL, NULL);
Alan Stern8963c482012-04-17 15:22:39 -04001202 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharpfccf4e82011-06-05 23:22:22 -07001203 /* Second pass: remove endpoint pointers */
1204 }
Alan Stern80f0cf32010-09-30 15:16:23 -04001205 for (i = skip_ep0; i < 16; ++i) {
1206 usb_disable_endpoint(dev, i, true);
1207 usb_disable_endpoint(dev, i + USB_DIR_IN, true);
1208 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209}
1210
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001211/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 * usb_enable_endpoint - Enable an endpoint for USB communications
1213 * @dev: the device whose interface is being enabled
1214 * @ep: the endpoint
David Vrabel3444b262009-04-08 17:36:28 +00001215 * @reset_ep: flag to reset the endpoint state
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 *
David Vrabel3444b262009-04-08 17:36:28 +00001217 * Resets the endpoint state if asked, and sets dev->ep_{in,out} pointers.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 * For control endpoints, both the input and output sides are handled.
1219 */
Alan Stern2caf7fc2008-12-31 11:31:33 -05001220void usb_enable_endpoint(struct usb_device *dev, struct usb_host_endpoint *ep,
David Vrabel3444b262009-04-08 17:36:28 +00001221 bool reset_ep)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222{
Alan Sternbdd016b2007-07-30 17:05:22 -04001223 int epnum = usb_endpoint_num(&ep->desc);
1224 int is_out = usb_endpoint_dir_out(&ep->desc);
1225 int is_control = usb_endpoint_xfer_control(&ep->desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
David Vrabel3444b262009-04-08 17:36:28 +00001227 if (reset_ep)
1228 usb_hcd_reset_endpoint(dev, ep);
1229 if (is_out || is_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 dev->ep_out[epnum] = ep;
David Vrabel3444b262009-04-08 17:36:28 +00001231 if (!is_out || is_control)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 dev->ep_in[epnum] = ep;
Alan Sternbdd016b2007-07-30 17:05:22 -04001233 ep->enabled = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234}
1235
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001236/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 * usb_enable_interface - Enable all the endpoints for an interface
1238 * @dev: the device whose interface is being enabled
1239 * @intf: pointer to the interface descriptor
David Vrabel3444b262009-04-08 17:36:28 +00001240 * @reset_eps: flag to reset the endpoints' state
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 *
1242 * Enables all the endpoints for the interface's current altsetting.
1243 */
Alan Stern2caf7fc2008-12-31 11:31:33 -05001244void usb_enable_interface(struct usb_device *dev,
David Vrabel3444b262009-04-08 17:36:28 +00001245 struct usb_interface *intf, bool reset_eps)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246{
1247 struct usb_host_interface *alt = intf->cur_altsetting;
1248 int i;
1249
1250 for (i = 0; i < alt->desc.bNumEndpoints; ++i)
David Vrabel3444b262009-04-08 17:36:28 +00001251 usb_enable_endpoint(dev, &alt->endpoint[i], reset_eps);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252}
1253
1254/**
1255 * usb_set_interface - Makes a particular alternate setting be current
1256 * @dev: the device whose interface is being updated
1257 * @interface: the interface being updated
1258 * @alternate: the setting being chosen.
1259 * Context: !in_interrupt ()
1260 *
1261 * This is used to enable data transfers on interfaces that may not
1262 * be enabled by default. Not all devices support such configurability.
1263 * Only the driver bound to an interface may change its setting.
1264 *
1265 * Within any given configuration, each interface may have several
1266 * alternative settings. These are often used to control levels of
1267 * bandwidth consumption. For example, the default setting for a high
1268 * speed interrupt endpoint may not send more than 64 bytes per microframe,
1269 * while interrupt transfers of up to 3KBytes per microframe are legal.
1270 * Also, isochronous endpoints may never be part of an
1271 * interface's default setting. To access such bandwidth, alternate
1272 * interface settings must be made current.
1273 *
1274 * Note that in the Linux USB subsystem, bandwidth associated with
1275 * an endpoint in a given alternate setting is not reserved until an URB
1276 * is submitted that needs that bandwidth. Some other operating systems
1277 * allocate bandwidth early, when a configuration is chosen.
1278 *
1279 * This call is synchronous, and may not be used in an interrupt context.
1280 * Also, drivers must not change altsettings while urbs are scheduled for
1281 * endpoints in that interface; all such urbs must first be completed
1282 * (perhaps forced by unlinking).
1283 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001284 * Return: Zero on success, or else the status code returned by the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 * underlying usb_control_msg() call.
1286 */
1287int usb_set_interface(struct usb_device *dev, int interface, int alternate)
1288{
1289 struct usb_interface *iface;
1290 struct usb_host_interface *alt;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001291 struct usb_hcd *hcd = bus_to_hcd(dev->bus);
Hans de Goede7a7b5622013-11-08 16:37:26 +01001292 int i, ret, manual = 0;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001293 unsigned int epaddr;
1294 unsigned int pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
1296 if (dev->state == USB_STATE_SUSPENDED)
1297 return -EHOSTUNREACH;
1298
1299 iface = usb_ifnum_to_if(dev, interface);
1300 if (!iface) {
1301 dev_dbg(&dev->dev, "selecting invalid interface %d\n",
1302 interface);
1303 return -EINVAL;
1304 }
Alan Sterne534c5b2011-07-01 16:43:02 -04001305 if (iface->unregistering)
1306 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
1308 alt = usb_altnum_to_altsetting(iface, alternate);
1309 if (!alt) {
Thadeu Lima de Souza Cascardo385f6902010-01-17 19:24:03 -02001310 dev_warn(&dev->dev, "selecting invalid altsetting %d\n",
Greg Kroah-Hartman3b6004f2008-08-14 09:37:34 -07001311 alternate);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 return -EINVAL;
1313 }
1314
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001315 /* Make sure we have enough bandwidth for this alternate interface.
1316 * Remove the current alt setting and add the new alt setting.
1317 */
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001318 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp83060952012-05-02 14:25:52 -07001319 /* Disable LPM, and re-enable it once the new alt setting is installed,
1320 * so that the xHCI driver can recalculate the U1/U2 timeouts.
1321 */
1322 if (usb_disable_lpm(dev)) {
1323 dev_err(&iface->dev, "%s Failed to disable LPM\n.", __func__);
1324 mutex_unlock(hcd->bandwidth_mutex);
1325 return -ENOMEM;
1326 }
Hans de Goede7a7b5622013-11-08 16:37:26 +01001327 /* Changing alt-setting also frees any allocated streams */
1328 for (i = 0; i < iface->cur_altsetting->desc.bNumEndpoints; i++)
1329 iface->cur_altsetting->endpoint[i].streams = 0;
1330
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001331 ret = usb_hcd_alloc_bandwidth(dev, NULL, iface->cur_altsetting, alt);
1332 if (ret < 0) {
1333 dev_info(&dev->dev, "Not enough bandwidth for altsetting %d\n",
1334 alternate);
Sarah Sharp83060952012-05-02 14:25:52 -07001335 usb_enable_lpm(dev);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001336 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001337 return ret;
1338 }
1339
Alan Stern392e1d92008-03-11 10:20:12 -04001340 if (dev->quirks & USB_QUIRK_NO_SET_INTF)
1341 ret = -EPIPE;
1342 else
1343 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE,
1345 alternate, interface, NULL, 0, 5000);
1346
1347 /* 9.4.10 says devices don't need this and are free to STALL the
1348 * request if the interface only has one alternate setting.
1349 */
1350 if (ret == -EPIPE && iface->num_altsetting == 1) {
1351 dev_dbg(&dev->dev,
1352 "manual set_interface for iface %d, alt %d\n",
1353 interface, alternate);
1354 manual = 1;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001355 } else if (ret < 0) {
1356 /* Re-instate the old alt setting */
1357 usb_hcd_alloc_bandwidth(dev, NULL, alt, iface->cur_altsetting);
Sarah Sharp83060952012-05-02 14:25:52 -07001358 usb_enable_lpm(dev);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001359 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 return ret;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001361 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001362 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363
1364 /* FIXME drivers shouldn't need to replicate/bugfix the logic here
1365 * when they implement async or easily-killable versions of this or
1366 * other "should-be-internal" functions (like clear_halt).
1367 * should hcd+usbcore postprocess control requests?
1368 */
1369
1370 /* prevent submissions using previous endpoint settings */
Alan Stern3b23dd62008-12-05 14:10:34 -05001371 if (iface->cur_altsetting != alt) {
1372 remove_intf_ep_devs(iface);
Alan Stern0e6c8e82005-10-24 15:33:03 -04001373 usb_remove_sysfs_intf_files(iface);
Alan Stern3b23dd62008-12-05 14:10:34 -05001374 }
Alan Sternddeac4e2009-01-15 17:03:33 -05001375 usb_disable_interface(dev, iface, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 iface->cur_altsetting = alt;
1378
Sarah Sharp83060952012-05-02 14:25:52 -07001379 /* Now that the interface is installed, re-enable LPM. */
1380 usb_unlocked_enable_lpm(dev);
1381
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382 /* If the interface only has one altsetting and the device didn't
David Brownella81e7ec2005-04-18 17:39:25 -07001383 * accept the request, we attempt to carry out the equivalent action
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 * by manually clearing the HALT feature for each endpoint in the
1385 * new altsetting.
1386 */
1387 if (manual) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 for (i = 0; i < alt->desc.bNumEndpoints; i++) {
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001389 epaddr = alt->endpoint[i].desc.bEndpointAddress;
1390 pipe = __create_pipe(dev,
1391 USB_ENDPOINT_NUMBER_MASK & epaddr) |
1392 (usb_endpoint_out(epaddr) ?
1393 USB_DIR_OUT : USB_DIR_IN);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394
1395 usb_clear_halt(dev, pipe);
1396 }
1397 }
1398
1399 /* 9.1.1.5: reset toggles for all endpoints in the new altsetting
1400 *
1401 * Note:
1402 * Despite EP0 is always present in all interfaces/AS, the list of
1403 * endpoints from the descriptor does not contain EP0. Due to its
1404 * omnipresence one might expect EP0 being considered "affected" by
1405 * any SetInterface request and hence assume toggles need to be reset.
1406 * However, EP0 toggles are re-synced for every individual transfer
1407 * during the SETUP stage - hence EP0 toggles are "don't care" here.
1408 * (Likewise, EP0 never "halts" on well designed devices.)
1409 */
Alan Stern2caf7fc2008-12-31 11:31:33 -05001410 usb_enable_interface(dev, iface, true);
Alan Stern3b23dd62008-12-05 14:10:34 -05001411 if (device_is_registered(&iface->dev)) {
Alan Stern0e6c8e82005-10-24 15:33:03 -04001412 usb_create_sysfs_intf_files(iface);
Alan Stern3b23dd62008-12-05 14:10:34 -05001413 create_intf_ep_devs(iface);
1414 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415 return 0;
1416}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001417EXPORT_SYMBOL_GPL(usb_set_interface);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
1419/**
1420 * usb_reset_configuration - lightweight device reset
1421 * @dev: the device whose configuration is being reset
1422 *
1423 * This issues a standard SET_CONFIGURATION request to the device using
1424 * the current configuration. The effect is to reset most USB-related
1425 * state in the device, including interface altsettings (reset to zero),
David Vrabel3444b262009-04-08 17:36:28 +00001426 * endpoint halts (cleared), and endpoint state (only for bulk and interrupt
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427 * endpoints). Other usbcore state is unchanged, including bindings of
1428 * usb device drivers to interfaces.
1429 *
1430 * Because this affects multiple interfaces, avoid using this with composite
1431 * (multi-interface) devices. Instead, the driver for each interface may
David Brownella81e7ec2005-04-18 17:39:25 -07001432 * use usb_set_interface() on the interfaces it claims. Be careful though;
1433 * some devices don't support the SET_INTERFACE request, and others won't
David Vrabel3444b262009-04-08 17:36:28 +00001434 * reset all the interface state (notably endpoint state). Resetting the whole
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 * configuration would affect other drivers' interfaces.
1436 *
1437 * The caller must own the device lock.
1438 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02001439 * Return: Zero on success, else a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001440 */
1441int usb_reset_configuration(struct usb_device *dev)
1442{
1443 int i, retval;
1444 struct usb_host_config *config;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001445 struct usb_hcd *hcd = bus_to_hcd(dev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
1447 if (dev->state == USB_STATE_SUSPENDED)
1448 return -EHOSTUNREACH;
1449
1450 /* caller must have locked the device and must own
1451 * the usb bus readlock (so driver bindings are stable);
1452 * calls during probe() are fine
1453 */
1454
1455 for (i = 1; i < 16; ++i) {
Alan Sternddeac4e2009-01-15 17:03:33 -05001456 usb_disable_endpoint(dev, i, true);
1457 usb_disable_endpoint(dev, i + USB_DIR_IN, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 }
1459
1460 config = dev->actconfig;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001461 retval = 0;
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001462 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp83060952012-05-02 14:25:52 -07001463 /* Disable LPM, and re-enable it once the configuration is reset, so
1464 * that the xHCI driver can recalculate the U1/U2 timeouts.
1465 */
1466 if (usb_disable_lpm(dev)) {
1467 dev_err(&dev->dev, "%s Failed to disable LPM\n.", __func__);
1468 mutex_unlock(hcd->bandwidth_mutex);
1469 return -ENOMEM;
1470 }
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001471 /* Make sure we have enough bandwidth for each alternate setting 0 */
1472 for (i = 0; i < config->desc.bNumInterfaces; i++) {
1473 struct usb_interface *intf = config->interface[i];
1474 struct usb_host_interface *alt;
1475
1476 alt = usb_altnum_to_altsetting(intf, 0);
1477 if (!alt)
1478 alt = &intf->altsetting[0];
1479 if (alt != intf->cur_altsetting)
1480 retval = usb_hcd_alloc_bandwidth(dev, NULL,
1481 intf->cur_altsetting, alt);
1482 if (retval < 0)
1483 break;
1484 }
1485 /* If not, reinstate the old alternate settings */
1486 if (retval < 0) {
1487reset_old_alts:
Roel Kluine4a3d942010-02-18 02:36:23 +01001488 for (i--; i >= 0; i--) {
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001489 struct usb_interface *intf = config->interface[i];
1490 struct usb_host_interface *alt;
1491
1492 alt = usb_altnum_to_altsetting(intf, 0);
1493 if (!alt)
1494 alt = &intf->altsetting[0];
1495 if (alt != intf->cur_altsetting)
1496 usb_hcd_alloc_bandwidth(dev, NULL,
1497 alt, intf->cur_altsetting);
1498 }
Sarah Sharp83060952012-05-02 14:25:52 -07001499 usb_enable_lpm(dev);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001500 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001501 return retval;
1502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1504 USB_REQ_SET_CONFIGURATION, 0,
1505 config->desc.bConfigurationValue, 0,
1506 NULL, 0, USB_CTRL_SET_TIMEOUT);
Alan Stern0e6c8e82005-10-24 15:33:03 -04001507 if (retval < 0)
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001508 goto reset_old_alts;
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001509 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 /* re-init hc/hcd interface/endpoint state */
1512 for (i = 0; i < config->desc.bNumInterfaces; i++) {
1513 struct usb_interface *intf = config->interface[i];
1514 struct usb_host_interface *alt;
1515
1516 alt = usb_altnum_to_altsetting(intf, 0);
1517
1518 /* No altsetting 0? We'll assume the first altsetting.
1519 * We could use a GetInterface call, but if a device is
1520 * so non-compliant that it doesn't have altsetting 0
1521 * then I wouldn't trust its reply anyway.
1522 */
1523 if (!alt)
1524 alt = &intf->altsetting[0];
1525
Alan Stern3b23dd62008-12-05 14:10:34 -05001526 if (alt != intf->cur_altsetting) {
1527 remove_intf_ep_devs(intf);
1528 usb_remove_sysfs_intf_files(intf);
1529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 intf->cur_altsetting = alt;
Alan Stern2caf7fc2008-12-31 11:31:33 -05001531 usb_enable_interface(dev, intf, true);
Alan Stern3b23dd62008-12-05 14:10:34 -05001532 if (device_is_registered(&intf->dev)) {
Alan Stern0e6c8e82005-10-24 15:33:03 -04001533 usb_create_sysfs_intf_files(intf);
Alan Stern3b23dd62008-12-05 14:10:34 -05001534 create_intf_ep_devs(intf);
1535 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 }
Sarah Sharp83060952012-05-02 14:25:52 -07001537 /* Now that the interfaces are installed, re-enable LPM. */
1538 usb_unlocked_enable_lpm(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 return 0;
1540}
Greg Kroah-Hartman782e70c2008-01-25 11:12:21 -06001541EXPORT_SYMBOL_GPL(usb_reset_configuration);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Greg Kroah-Hartmanb0e396e2007-08-02 22:44:27 -06001543static void usb_release_interface(struct device *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544{
1545 struct usb_interface *intf = to_usb_interface(dev);
1546 struct usb_interface_cache *intfc =
1547 altsetting_to_usb_interface_cache(intf->altsetting);
1548
1549 kref_put(&intfc->ref, usb_release_interface_cache);
Alan Stern524134d2015-01-21 14:02:43 -05001550 usb_put_dev(interface_to_usbdev(intf));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 kfree(intf);
1552}
1553
Stefan Kochb3910ce2015-08-25 21:10:08 +02001554/*
1555 * usb_deauthorize_interface - deauthorize an USB interface
1556 *
1557 * @intf: USB interface structure
1558 */
1559void usb_deauthorize_interface(struct usb_interface *intf)
1560{
1561 struct device *dev = &intf->dev;
1562
1563 device_lock(dev->parent);
1564
1565 if (intf->authorized) {
1566 device_lock(dev);
1567 intf->authorized = 0;
1568 device_unlock(dev);
1569
1570 usb_forced_unbind_intf(intf);
1571 }
1572
1573 device_unlock(dev->parent);
1574}
1575
1576/*
1577 * usb_authorize_interface - authorize an USB interface
1578 *
1579 * @intf: USB interface structure
1580 */
1581void usb_authorize_interface(struct usb_interface *intf)
1582{
1583 struct device *dev = &intf->dev;
1584
1585 if (!intf->authorized) {
1586 device_lock(dev);
1587 intf->authorized = 1; /* authorize interface */
1588 device_unlock(dev);
1589 }
1590}
1591
Kay Sievers7eff2e72007-08-14 15:15:12 +02001592static int usb_if_uevent(struct device *dev, struct kobj_uevent_env *env)
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001593{
1594 struct usb_device *usb_dev;
1595 struct usb_interface *intf;
1596 struct usb_host_interface *alt;
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001597
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001598 intf = to_usb_interface(dev);
1599 usb_dev = interface_to_usbdev(intf);
1600 alt = intf->cur_altsetting;
1601
Kay Sievers7eff2e72007-08-14 15:15:12 +02001602 if (add_uevent_var(env, "INTERFACE=%d/%d/%d",
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001603 alt->desc.bInterfaceClass,
1604 alt->desc.bInterfaceSubClass,
1605 alt->desc.bInterfaceProtocol))
1606 return -ENOMEM;
1607
Kay Sievers7eff2e72007-08-14 15:15:12 +02001608 if (add_uevent_var(env,
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001609 "MODALIAS=usb:"
Bjørn Mork81df2d52012-05-18 21:27:43 +02001610 "v%04Xp%04Xd%04Xdc%02Xdsc%02Xdp%02Xic%02Xisc%02Xip%02Xin%02X",
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001611 le16_to_cpu(usb_dev->descriptor.idVendor),
1612 le16_to_cpu(usb_dev->descriptor.idProduct),
1613 le16_to_cpu(usb_dev->descriptor.bcdDevice),
1614 usb_dev->descriptor.bDeviceClass,
1615 usb_dev->descriptor.bDeviceSubClass,
1616 usb_dev->descriptor.bDeviceProtocol,
1617 alt->desc.bInterfaceClass,
1618 alt->desc.bInterfaceSubClass,
Bjørn Mork81df2d52012-05-18 21:27:43 +02001619 alt->desc.bInterfaceProtocol,
1620 alt->desc.bInterfaceNumber))
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001621 return -ENOMEM;
1622
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001623 return 0;
1624}
1625
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001626struct device_type usb_if_device_type = {
1627 .name = "usb_interface",
1628 .release = usb_release_interface,
1629 .uevent = usb_if_uevent,
1630};
1631
Craig W. Nadler165fe972007-06-15 23:14:35 -04001632static struct usb_interface_assoc_descriptor *find_iad(struct usb_device *dev,
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001633 struct usb_host_config *config,
1634 u8 inum)
Craig W. Nadler165fe972007-06-15 23:14:35 -04001635{
1636 struct usb_interface_assoc_descriptor *retval = NULL;
1637 struct usb_interface_assoc_descriptor *intf_assoc;
1638 int first_intf;
1639 int last_intf;
1640 int i;
1641
1642 for (i = 0; (i < USB_MAXIADS && config->intf_assoc[i]); i++) {
1643 intf_assoc = config->intf_assoc[i];
1644 if (intf_assoc->bInterfaceCount == 0)
1645 continue;
1646
1647 first_intf = intf_assoc->bFirstInterface;
1648 last_intf = first_intf + (intf_assoc->bInterfaceCount - 1);
1649 if (inum >= first_intf && inum <= last_intf) {
1650 if (!retval)
1651 retval = intf_assoc;
1652 else
1653 dev_err(&dev->dev, "Interface #%d referenced"
1654 " by multiple IADs\n", inum);
1655 }
1656 }
1657
1658 return retval;
1659}
1660
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001661
1662/*
1663 * Internal function to queue a device reset
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001664 * See usb_queue_reset_device() for more details
1665 */
Felipe Balbi09e81f32009-12-04 15:47:44 +02001666static void __usb_queue_reset_device(struct work_struct *ws)
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001667{
1668 int rc;
1669 struct usb_interface *iface =
1670 container_of(ws, struct usb_interface, reset_ws);
1671 struct usb_device *udev = interface_to_usbdev(iface);
1672
1673 rc = usb_lock_device_for_reset(udev, iface);
1674 if (rc >= 0) {
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001675 usb_reset_device(udev);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001676 usb_unlock_device(udev);
1677 }
Alan Stern524134d2015-01-21 14:02:43 -05001678 usb_put_intf(iface); /* Undo _get_ in usb_queue_reset_device() */
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001679}
1680
1681
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682/*
1683 * usb_set_configuration - Makes a particular device setting be current
1684 * @dev: the device whose configuration is being updated
1685 * @configuration: the configuration being chosen.
1686 * Context: !in_interrupt(), caller owns the device lock
1687 *
1688 * This is used to enable non-default device modes. Not all devices
1689 * use this kind of configurability; many devices only have one
1690 * configuration.
1691 *
Alan Stern3f141e22007-02-08 16:40:43 -05001692 * @configuration is the value of the configuration to be installed.
1693 * According to the USB spec (e.g. section 9.1.1.5), configuration values
1694 * must be non-zero; a value of zero indicates that the device in
1695 * unconfigured. However some devices erroneously use 0 as one of their
1696 * configuration values. To help manage such devices, this routine will
1697 * accept @configuration = -1 as indicating the device should be put in
1698 * an unconfigured state.
1699 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001700 * USB device configurations may affect Linux interoperability,
1701 * power consumption and the functionality available. For example,
1702 * the default configuration is limited to using 100mA of bus power,
1703 * so that when certain device functionality requires more power,
1704 * and the device is bus powered, that functionality should be in some
1705 * non-default device configuration. Other device modes may also be
1706 * reflected as configuration options, such as whether two ISDN
1707 * channels are available independently; and choosing between open
1708 * standard device protocols (like CDC) or proprietary ones.
1709 *
Inaky Perez-Gonzalez16bbab22007-07-31 20:34:01 -07001710 * Note that a non-authorized device (dev->authorized == 0) will only
1711 * be put in unconfigured mode.
1712 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 * Note that USB has an additional level of device configurability,
1714 * associated with interfaces. That configurability is accessed using
1715 * usb_set_interface().
1716 *
1717 * This call is synchronous. The calling context must be able to sleep,
1718 * must own the device lock, and must not hold the driver model's USB
Ming Lei6d243e52008-06-17 23:24:08 +08001719 * bus mutex; usb interface driver probe() methods cannot use this routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 *
1721 * Returns zero on success, or else the status code returned by the
Steven Cole093cf722005-05-03 19:07:24 -06001722 * underlying call that failed. On successful completion, each interface
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 * in the original device configuration has been destroyed, and each one
1724 * in the new configuration has been probed by all relevant usb device
1725 * drivers currently known to the kernel.
1726 */
1727int usb_set_configuration(struct usb_device *dev, int configuration)
1728{
1729 int i, ret;
1730 struct usb_host_config *cp = NULL;
1731 struct usb_interface **new_interfaces = NULL;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001732 struct usb_hcd *hcd = bus_to_hcd(dev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 int n, nintf;
1734
Inaky Perez-Gonzalez16bbab22007-07-31 20:34:01 -07001735 if (dev->authorized == 0 || configuration == -1)
Alan Stern3f141e22007-02-08 16:40:43 -05001736 configuration = 0;
1737 else {
1738 for (i = 0; i < dev->descriptor.bNumConfigurations; i++) {
1739 if (dev->config[i].desc.bConfigurationValue ==
1740 configuration) {
1741 cp = &dev->config[i];
1742 break;
1743 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 }
1745 }
1746 if ((!cp && configuration != 0))
1747 return -EINVAL;
1748
1749 /* The USB spec says configuration 0 means unconfigured.
1750 * But if a device includes a configuration numbered 0,
1751 * we will accept it as a correctly configured state.
Alan Stern3f141e22007-02-08 16:40:43 -05001752 * Use -1 if you really want to unconfigure the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 */
1754 if (cp && configuration == 0)
1755 dev_warn(&dev->dev, "config 0 descriptor??\n");
1756
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 /* Allocate memory for new interfaces before doing anything else,
1758 * so that if we run out then nothing will have changed. */
1759 n = nintf = 0;
1760 if (cp) {
1761 nintf = cp->desc.bNumInterfaces;
1762 new_interfaces = kmalloc(nintf * sizeof(*new_interfaces),
Oliver Neukumacbe2fe2010-01-12 12:32:50 +01001763 GFP_NOIO);
Wolfram Sang93fab792016-08-25 19:39:00 +02001764 if (!new_interfaces)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
1767 for (; n < nintf; ++n) {
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001768 new_interfaces[n] = kzalloc(
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 sizeof(struct usb_interface),
Oliver Neukumacbe2fe2010-01-12 12:32:50 +01001770 GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 if (!new_interfaces[n]) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 ret = -ENOMEM;
1773free_interfaces:
1774 while (--n >= 0)
1775 kfree(new_interfaces[n]);
1776 kfree(new_interfaces);
1777 return ret;
1778 }
1779 }
Alan Stern6ad07122006-06-01 13:59:16 -04001780
Sebastian Andrzej Siewior8d8479d2012-12-18 15:25:46 +01001781 i = dev->bus_mA - usb_get_max_power(dev, cp);
Alan Stern6ad07122006-06-01 13:59:16 -04001782 if (i < 0)
1783 dev_warn(&dev->dev, "new config #%d exceeds power "
1784 "limit by %dmA\n",
1785 configuration, -i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 }
1787
Alan Stern01d883d2006-08-30 15:47:18 -04001788 /* Wake up the device so we can send it the Set-Config request */
Alan Stern94fcda12006-11-20 11:38:46 -05001789 ret = usb_autoresume_device(dev);
Alan Stern01d883d2006-08-30 15:47:18 -04001790 if (ret)
1791 goto free_interfaces;
1792
Thadeu Lima de Souza Cascardo07919712010-08-28 03:06:29 -03001793 /* if it's already configured, clear out old state first.
1794 * getting rid of old interfaces means unbinding their drivers.
1795 */
1796 if (dev->state != USB_STATE_ADDRESS)
1797 usb_disable_device(dev, 1); /* Skip ep0 */
1798
1799 /* Get rid of pending async Set-Config requests for this device */
1800 cancel_async_set_config(dev);
1801
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001802 /* Make sure we have bandwidth (and available HCD resources) for this
1803 * configuration. Remove endpoints from the schedule if we're dropping
1804 * this configuration to set configuration 0. After this point, the
1805 * host controller will not allow submissions to dropped endpoints. If
1806 * this call fails, the device state is unchanged.
1807 */
Alan Stern8963c482012-04-17 15:22:39 -04001808 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp83060952012-05-02 14:25:52 -07001809 /* Disable LPM, and re-enable it once the new configuration is
1810 * installed, so that the xHCI driver can recalculate the U1/U2
1811 * timeouts.
1812 */
Sarah Sharp9cf65992012-07-03 23:22:38 -07001813 if (dev->actconfig && usb_disable_lpm(dev)) {
Sarah Sharp83060952012-05-02 14:25:52 -07001814 dev_err(&dev->dev, "%s Failed to disable LPM\n.", __func__);
1815 mutex_unlock(hcd->bandwidth_mutex);
Sachin Kamatc058f7a2012-11-21 11:01:19 +05301816 ret = -ENOMEM;
1817 goto free_interfaces;
Sarah Sharp83060952012-05-02 14:25:52 -07001818 }
Sarah Sharp3f0479e2009-12-03 09:44:36 -08001819 ret = usb_hcd_alloc_bandwidth(dev, cp, NULL, NULL);
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001820 if (ret < 0) {
Sarah Sharp9cf65992012-07-03 23:22:38 -07001821 if (dev->actconfig)
1822 usb_enable_lpm(dev);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07001823 mutex_unlock(hcd->bandwidth_mutex);
Thadeu Lima de Souza Cascardo07919712010-08-28 03:06:29 -03001824 usb_autosuspend_device(dev);
Sarah Sharp79abb1a2009-04-27 19:58:26 -07001825 goto free_interfaces;
1826 }
1827
Alan Stern36caff52012-11-07 10:31:30 -05001828 /*
1829 * Initialize the new interface structures and the
Alan Stern6ad07122006-06-01 13:59:16 -04001830 * hc/hcd/usbcore interface/endpoint state.
1831 */
1832 for (i = 0; i < nintf; ++i) {
1833 struct usb_interface_cache *intfc;
1834 struct usb_interface *intf;
1835 struct usb_host_interface *alt;
1836
1837 cp->interface[i] = intf = new_interfaces[i];
1838 intfc = cp->intf_cache[i];
1839 intf->altsetting = intfc->altsetting;
1840 intf->num_altsetting = intfc->num_altsetting;
Stefan Koch6b2bd3c2015-08-25 21:10:06 +02001841 intf->authorized = !!HCD_INTF_AUTHORIZED(hcd);
Alan Stern6ad07122006-06-01 13:59:16 -04001842 kref_get(&intfc->ref);
1843
1844 alt = usb_altnum_to_altsetting(intf, 0);
1845
1846 /* No altsetting 0? We'll assume the first altsetting.
1847 * We could use a GetInterface call, but if a device is
1848 * so non-compliant that it doesn't have altsetting 0
1849 * then I wouldn't trust its reply anyway.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 */
Alan Stern6ad07122006-06-01 13:59:16 -04001851 if (!alt)
1852 alt = &intf->altsetting[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Daniel Mackb3a3dd02012-06-12 20:23:52 +02001854 intf->intf_assoc =
1855 find_iad(dev, cp, alt->desc.bInterfaceNumber);
Alan Stern6ad07122006-06-01 13:59:16 -04001856 intf->cur_altsetting = alt;
Alan Stern2caf7fc2008-12-31 11:31:33 -05001857 usb_enable_interface(dev, intf, true);
Alan Stern6ad07122006-06-01 13:59:16 -04001858 intf->dev.parent = &dev->dev;
1859 intf->dev.driver = NULL;
1860 intf->dev.bus = &usb_bus_type;
Kay Sievers9f8b17e2007-03-13 15:59:31 +01001861 intf->dev.type = &usb_if_device_type;
Alan Stern2e5f10e2008-04-30 15:37:19 -04001862 intf->dev.groups = usb_interface_groups;
Roger Quadrosb44bbc42016-09-13 11:16:03 +03001863 /*
1864 * Please refer to usb_alloc_dev() to see why we set
1865 * dma_mask and dma_pfn_offset.
1866 */
Alan Stern6ad07122006-06-01 13:59:16 -04001867 intf->dev.dma_mask = dev->dev.dma_mask;
Roger Quadrosb44bbc42016-09-13 11:16:03 +03001868 intf->dev.dma_pfn_offset = dev->dev.dma_pfn_offset;
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08001869 INIT_WORK(&intf->reset_ws, __usb_queue_reset_device);
Alan Stern0026e002010-09-21 15:01:53 -04001870 intf->minor = -1;
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001871 device_initialize(&intf->dev);
Ming Lei63defa72010-11-15 15:56:54 -05001872 pm_runtime_no_callbacks(&intf->dev);
Kay Sievers0031a062008-05-02 06:02:41 +02001873 dev_set_name(&intf->dev, "%d-%s:%d.%d",
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001874 dev->bus->busnum, dev->devpath,
1875 configuration, alt->desc.bInterfaceNumber);
Alan Stern524134d2015-01-21 14:02:43 -05001876 usb_get_dev(dev);
Alan Stern6ad07122006-06-01 13:59:16 -04001877 }
1878 kfree(new_interfaces);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
Alan Stern36caff52012-11-07 10:31:30 -05001880 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
1881 USB_REQ_SET_CONFIGURATION, 0, configuration, 0,
1882 NULL, 0, USB_CTRL_SET_TIMEOUT);
1883 if (ret < 0 && cp) {
1884 /*
1885 * All the old state is gone, so what else can we do?
1886 * The device is probably useless now anyway.
1887 */
1888 usb_hcd_alloc_bandwidth(dev, NULL, NULL, NULL);
1889 for (i = 0; i < nintf; ++i) {
1890 usb_disable_interface(dev, cp->interface[i], true);
1891 put_device(&cp->interface[i]->dev);
1892 cp->interface[i] = NULL;
1893 }
1894 cp = NULL;
1895 }
1896
1897 dev->actconfig = cp;
1898 mutex_unlock(hcd->bandwidth_mutex);
1899
1900 if (!cp) {
1901 usb_set_device_state(dev, USB_STATE_ADDRESS);
1902
1903 /* Leave LPM disabled while the device is unconfigured. */
1904 usb_autosuspend_device(dev);
1905 return ret;
1906 }
1907 usb_set_device_state(dev, USB_STATE_CONFIGURED);
1908
Alan Stern1662e3a2009-03-18 14:28:53 -04001909 if (cp->string == NULL &&
1910 !(dev->quirks & USB_QUIRK_CONFIG_INTF_STRINGS))
Alan Stern6ad07122006-06-01 13:59:16 -04001911 cp->string = usb_cache_string(dev, cp->desc.iConfiguration);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
Sarah Sharp83060952012-05-02 14:25:52 -07001913 /* Now that the interfaces are installed, re-enable LPM. */
1914 usb_unlocked_enable_lpm(dev);
Sarah Sharpf74631e2012-06-25 12:08:08 -07001915 /* Enable LTM if it was turned off by usb_disable_device. */
1916 usb_enable_ltm(dev);
Sarah Sharp83060952012-05-02 14:25:52 -07001917
Alan Stern6ad07122006-06-01 13:59:16 -04001918 /* Now that all the interfaces are set up, register them
1919 * to trigger binding of drivers to interfaces. probe()
1920 * routines may install different altsettings and may
1921 * claim() any interfaces not yet bound. Many class drivers
1922 * need that: CDC, audio, video, etc.
1923 */
1924 for (i = 0; i < nintf; ++i) {
1925 struct usb_interface *intf = cp->interface[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001927 dev_dbg(&dev->dev,
Alan Stern6ad07122006-06-01 13:59:16 -04001928 "adding %s (config #%d, interface %d)\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +02001929 dev_name(&intf->dev), configuration,
Alan Stern6ad07122006-06-01 13:59:16 -04001930 intf->cur_altsetting->desc.bInterfaceNumber);
Rafael J. Wysocki927bc912010-02-08 19:18:16 +01001931 device_enable_async_suspend(&intf->dev);
Greg Kroah-Hartman3e35bf32008-01-30 15:21:33 -08001932 ret = device_add(&intf->dev);
Alan Stern6ad07122006-06-01 13:59:16 -04001933 if (ret != 0) {
1934 dev_err(&dev->dev, "device_add(%s) --> %d\n",
Kay Sievers7071a3c2008-05-02 06:02:41 +02001935 dev_name(&intf->dev), ret);
Alan Stern6ad07122006-06-01 13:59:16 -04001936 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 }
Alan Stern3b23dd62008-12-05 14:10:34 -05001938 create_intf_ep_devs(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 }
1940
Alan Stern94fcda12006-11-20 11:38:46 -05001941 usb_autosuspend_device(dev);
Alan Stern86d30742005-07-29 12:17:16 -07001942 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943}
Valentina Maneab7945b72014-01-23 23:12:29 +02001944EXPORT_SYMBOL_GPL(usb_set_configuration);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
Alan Sterndf718962008-12-19 10:27:56 -05001946static LIST_HEAD(set_config_list);
1947static DEFINE_SPINLOCK(set_config_lock);
1948
Alan Stern088dc272006-08-21 12:08:19 -04001949struct set_config_request {
1950 struct usb_device *udev;
1951 int config;
1952 struct work_struct work;
Alan Sterndf718962008-12-19 10:27:56 -05001953 struct list_head node;
Alan Stern088dc272006-08-21 12:08:19 -04001954};
1955
1956/* Worker routine for usb_driver_set_configuration() */
David Howellsc4028952006-11-22 14:57:56 +00001957static void driver_set_config_work(struct work_struct *work)
Alan Stern088dc272006-08-21 12:08:19 -04001958{
David Howellsc4028952006-11-22 14:57:56 +00001959 struct set_config_request *req =
1960 container_of(work, struct set_config_request, work);
Alan Sterndf718962008-12-19 10:27:56 -05001961 struct usb_device *udev = req->udev;
Alan Stern088dc272006-08-21 12:08:19 -04001962
Alan Sterndf718962008-12-19 10:27:56 -05001963 usb_lock_device(udev);
1964 spin_lock(&set_config_lock);
1965 list_del(&req->node);
1966 spin_unlock(&set_config_lock);
1967
1968 if (req->config >= -1) /* Is req still valid? */
1969 usb_set_configuration(udev, req->config);
1970 usb_unlock_device(udev);
1971 usb_put_dev(udev);
Alan Stern088dc272006-08-21 12:08:19 -04001972 kfree(req);
1973}
1974
Alan Sterndf718962008-12-19 10:27:56 -05001975/* Cancel pending Set-Config requests for a device whose configuration
1976 * was just changed
1977 */
1978static void cancel_async_set_config(struct usb_device *udev)
1979{
1980 struct set_config_request *req;
1981
1982 spin_lock(&set_config_lock);
1983 list_for_each_entry(req, &set_config_list, node) {
1984 if (req->udev == udev)
1985 req->config = -999; /* Mark as cancelled */
1986 }
1987 spin_unlock(&set_config_lock);
1988}
1989
Alan Stern088dc272006-08-21 12:08:19 -04001990/**
1991 * usb_driver_set_configuration - Provide a way for drivers to change device configurations
1992 * @udev: the device whose configuration is being updated
1993 * @config: the configuration being chosen.
1994 * Context: In process context, must be able to sleep
1995 *
1996 * Device interface drivers are not allowed to change device configurations.
1997 * This is because changing configurations will destroy the interface the
1998 * driver is bound to and create new ones; it would be like a floppy-disk
1999 * driver telling the computer to replace the floppy-disk drive with a
2000 * tape drive!
2001 *
2002 * Still, in certain specialized circumstances the need may arise. This
2003 * routine gets around the normal restrictions by using a work thread to
2004 * submit the change-config request.
2005 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02002006 * Return: 0 if the request was successfully queued, error code otherwise.
Alan Stern088dc272006-08-21 12:08:19 -04002007 * The caller has no way to know whether the queued request will eventually
2008 * succeed.
2009 */
2010int usb_driver_set_configuration(struct usb_device *udev, int config)
2011{
2012 struct set_config_request *req;
2013
2014 req = kmalloc(sizeof(*req), GFP_KERNEL);
2015 if (!req)
2016 return -ENOMEM;
2017 req->udev = udev;
2018 req->config = config;
David Howellsc4028952006-11-22 14:57:56 +00002019 INIT_WORK(&req->work, driver_set_config_work);
Alan Stern088dc272006-08-21 12:08:19 -04002020
Alan Sterndf718962008-12-19 10:27:56 -05002021 spin_lock(&set_config_lock);
2022 list_add(&req->node, &set_config_list);
2023 spin_unlock(&set_config_lock);
2024
Alan Stern088dc272006-08-21 12:08:19 -04002025 usb_get_dev(udev);
Alan Stern1737bf2c2006-12-15 16:04:52 -05002026 schedule_work(&req->work);
Alan Stern088dc272006-08-21 12:08:19 -04002027 return 0;
2028}
2029EXPORT_SYMBOL_GPL(usb_driver_set_configuration);
Oliver Neukume4c6fb72016-07-14 15:41:30 +02002030
2031/**
2032 * cdc_parse_cdc_header - parse the extra headers present in CDC devices
2033 * @hdr: the place to put the results of the parsing
2034 * @intf: the interface for which parsing is requested
2035 * @buffer: pointer to the extra headers to be parsed
2036 * @buflen: length of the extra headers
2037 *
2038 * This evaluates the extra headers present in CDC devices which
2039 * bind the interfaces for data and control and provide details
2040 * about the capabilities of the device.
2041 *
2042 * Return: number of descriptors parsed or -EINVAL
2043 * if the header is contradictory beyond salvage
2044 */
2045
2046int cdc_parse_cdc_header(struct usb_cdc_parsed_header *hdr,
2047 struct usb_interface *intf,
2048 u8 *buffer,
2049 int buflen)
2050{
2051 /* duplicates are ignored */
2052 struct usb_cdc_union_desc *union_header = NULL;
2053
2054 /* duplicates are not tolerated */
2055 struct usb_cdc_header_desc *header = NULL;
2056 struct usb_cdc_ether_desc *ether = NULL;
2057 struct usb_cdc_mdlm_detail_desc *detail = NULL;
2058 struct usb_cdc_mdlm_desc *desc = NULL;
2059
2060 unsigned int elength;
2061 int cnt = 0;
2062
2063 memset(hdr, 0x00, sizeof(struct usb_cdc_parsed_header));
2064 hdr->phonet_magic_present = false;
2065 while (buflen > 0) {
2066 elength = buffer[0];
2067 if (!elength) {
2068 dev_err(&intf->dev, "skipping garbage byte\n");
2069 elength = 1;
2070 goto next_desc;
2071 }
Greg Kroah-Hartman2e1c4232017-09-21 16:58:48 +02002072 if ((buflen < elength) || (elength < 3)) {
2073 dev_err(&intf->dev, "invalid descriptor buffer length\n");
2074 break;
2075 }
Oliver Neukume4c6fb72016-07-14 15:41:30 +02002076 if (buffer[1] != USB_DT_CS_INTERFACE) {
2077 dev_err(&intf->dev, "skipping garbage\n");
2078 goto next_desc;
2079 }
2080
2081 switch (buffer[2]) {
2082 case USB_CDC_UNION_TYPE: /* we've found it */
2083 if (elength < sizeof(struct usb_cdc_union_desc))
2084 goto next_desc;
2085 if (union_header) {
2086 dev_err(&intf->dev, "More than one union descriptor, skipping ...\n");
2087 goto next_desc;
2088 }
2089 union_header = (struct usb_cdc_union_desc *)buffer;
2090 break;
2091 case USB_CDC_COUNTRY_TYPE:
2092 if (elength < sizeof(struct usb_cdc_country_functional_desc))
2093 goto next_desc;
2094 hdr->usb_cdc_country_functional_desc =
2095 (struct usb_cdc_country_functional_desc *)buffer;
2096 break;
2097 case USB_CDC_HEADER_TYPE:
2098 if (elength != sizeof(struct usb_cdc_header_desc))
2099 goto next_desc;
2100 if (header)
2101 return -EINVAL;
2102 header = (struct usb_cdc_header_desc *)buffer;
2103 break;
2104 case USB_CDC_ACM_TYPE:
2105 if (elength < sizeof(struct usb_cdc_acm_descriptor))
2106 goto next_desc;
2107 hdr->usb_cdc_acm_descriptor =
2108 (struct usb_cdc_acm_descriptor *)buffer;
2109 break;
2110 case USB_CDC_ETHERNET_TYPE:
2111 if (elength != sizeof(struct usb_cdc_ether_desc))
2112 goto next_desc;
2113 if (ether)
2114 return -EINVAL;
2115 ether = (struct usb_cdc_ether_desc *)buffer;
2116 break;
2117 case USB_CDC_CALL_MANAGEMENT_TYPE:
2118 if (elength < sizeof(struct usb_cdc_call_mgmt_descriptor))
2119 goto next_desc;
2120 hdr->usb_cdc_call_mgmt_descriptor =
2121 (struct usb_cdc_call_mgmt_descriptor *)buffer;
2122 break;
2123 case USB_CDC_DMM_TYPE:
2124 if (elength < sizeof(struct usb_cdc_dmm_desc))
2125 goto next_desc;
2126 hdr->usb_cdc_dmm_desc =
2127 (struct usb_cdc_dmm_desc *)buffer;
2128 break;
2129 case USB_CDC_MDLM_TYPE:
2130 if (elength < sizeof(struct usb_cdc_mdlm_desc *))
2131 goto next_desc;
2132 if (desc)
2133 return -EINVAL;
2134 desc = (struct usb_cdc_mdlm_desc *)buffer;
2135 break;
2136 case USB_CDC_MDLM_DETAIL_TYPE:
2137 if (elength < sizeof(struct usb_cdc_mdlm_detail_desc *))
2138 goto next_desc;
2139 if (detail)
2140 return -EINVAL;
2141 detail = (struct usb_cdc_mdlm_detail_desc *)buffer;
2142 break;
2143 case USB_CDC_NCM_TYPE:
2144 if (elength < sizeof(struct usb_cdc_ncm_desc))
2145 goto next_desc;
2146 hdr->usb_cdc_ncm_desc = (struct usb_cdc_ncm_desc *)buffer;
2147 break;
2148 case USB_CDC_MBIM_TYPE:
2149 if (elength < sizeof(struct usb_cdc_mbim_desc))
2150 goto next_desc;
2151
2152 hdr->usb_cdc_mbim_desc = (struct usb_cdc_mbim_desc *)buffer;
2153 break;
2154 case USB_CDC_MBIM_EXTENDED_TYPE:
2155 if (elength < sizeof(struct usb_cdc_mbim_extended_desc))
2156 break;
2157 hdr->usb_cdc_mbim_extended_desc =
2158 (struct usb_cdc_mbim_extended_desc *)buffer;
2159 break;
2160 case CDC_PHONET_MAGIC_NUMBER:
2161 hdr->phonet_magic_present = true;
2162 break;
2163 default:
2164 /*
2165 * there are LOTS more CDC descriptors that
2166 * could legitimately be found here.
2167 */
2168 dev_dbg(&intf->dev, "Ignoring descriptor: type %02x, length %ud\n",
2169 buffer[2], elength);
2170 goto next_desc;
2171 }
2172 cnt++;
2173next_desc:
2174 buflen -= elength;
2175 buffer += elength;
2176 }
2177 hdr->usb_cdc_union_desc = union_header;
2178 hdr->usb_cdc_header_desc = header;
2179 hdr->usb_cdc_mdlm_detail_desc = detail;
2180 hdr->usb_cdc_mdlm_desc = desc;
2181 hdr->usb_cdc_ether_desc = ether;
2182 return cnt;
2183}
2184
2185EXPORT_SYMBOL(cdc_parse_cdc_header);