2521 lines · 75.3 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0/* * message.c - synchronous message handling * * Released under the GPLv2 only. */ #include <linux/acpi.h>#include <linux/pci.h>	/* for scatterlist macros */#include <linux/usb.h>#include <linux/module.h>#include <linux/of.h>#include <linux/slab.h>#include <linux/mm.h>#include <linux/timer.h>#include <linux/ctype.h>#include <linux/nls.h>#include <linux/device.h>#include <linux/scatterlist.h>#include <linux/usb/cdc.h>#include <linux/usb/quirks.h>#include <linux/usb/hcd.h>	/* for usbcore internals */#include <linux/usb/of.h>#include <asm/byteorder.h> #include "usb.h" static void cancel_async_set_config(struct usb_device *udev); struct api_context {	struct completion	done;	int			status;}; static void usb_api_blocking_completion(struct urb *urb){	struct api_context *ctx = urb->context; 	ctx->status = urb->status;	complete(&ctx->done);}  /* * Starts urb and waits for completion or timeout. * Whether or not the wait is killable depends on the flag passed in. * For example, compare usb_bulk_msg() and usb_bulk_msg_killable(). * * For non-killable waits, we enforce a maximum limit on the timeout value. */static int usb_start_wait_urb(struct urb *urb, int timeout, int *actual_length,		bool killable){	struct api_context ctx;	unsigned long expire;	int retval;	long rc; 	init_completion(&ctx.done);	urb->context = &ctx;	urb->actual_length = 0;	retval = usb_submit_urb(urb, GFP_NOIO);	if (unlikely(retval))		goto out; 	if (!killable && (timeout <= 0 || timeout > USB_MAX_SYNCHRONOUS_TIMEOUT))		timeout = USB_MAX_SYNCHRONOUS_TIMEOUT;	expire = (timeout > 0) ? msecs_to_jiffies(timeout) : MAX_SCHEDULE_TIMEOUT;	if (killable)		rc = wait_for_completion_killable_timeout(&ctx.done, expire);	else		rc = wait_for_completion_timeout(&ctx.done, expire);	if (rc <= 0) {		usb_kill_urb(urb);		if (ctx.status != -ENOENT)			retval = ctx.status;		else if (rc == 0)			retval = -ETIMEDOUT;		else			retval = rc; 		dev_dbg(&urb->dev->dev,			"%s timed out or killed on ep%d%s len=%u/%u\n",			current->comm,			usb_endpoint_num(&urb->ep->desc),			usb_urb_dir_in(urb) ? "in" : "out",			urb->actual_length,			urb->transfer_buffer_length);	} else		retval = ctx.status;out:	if (actual_length)		*actual_length = urb->actual_length; 	usb_free_urb(urb);	return retval;} /*-------------------------------------------------------------------*//* returns status (negative) or length (positive) */static int usb_internal_control_msg(struct usb_device *usb_dev,				    unsigned int pipe,				    struct usb_ctrlrequest *cmd,				    void *data, int len, int timeout){	struct urb *urb;	int retv;	int length; 	urb = usb_alloc_urb(0, GFP_NOIO);	if (!urb)		return -ENOMEM; 	usb_fill_control_urb(urb, usb_dev, pipe, (unsigned char *)cmd, data,			     len, usb_api_blocking_completion, NULL); 	retv = usb_start_wait_urb(urb, timeout, &length, false);	if (retv < 0)		return retv;	else		return length;} /** * usb_control_msg - Builds a control urb, sends it off and waits for completion * @dev: pointer to the usb device to send the message to * @pipe: endpoint "pipe" to send the message to * @request: USB message request value * @requesttype: USB message request type value * @value: USB message value * @index: USB message index value * @data: pointer to the data to send * @size: length in bytes of the data to send * @timeout: time in msecs to wait for the message to complete before timing out * * Context: task context, might sleep. * * This function sends a simple control message to a specified endpoint and * waits for the message to complete, or timeout. * * Don't use this function from within an interrupt context. If you need * an asynchronous message, or need to send a message from within interrupt * context, use usb_submit_urb(). If a thread in your driver uses this call, * make sure your disconnect() method can wait for it to complete. Since you * don't have a handle on the URB used, you can't cancel the request. * * Return: If successful, the number of bytes transferred. Otherwise, a negative * error number. */int usb_control_msg(struct usb_device *dev, unsigned int pipe, __u8 request,		    __u8 requesttype, __u16 value, __u16 index, void *data,		    __u16 size, int timeout){	struct usb_ctrlrequest *dr;	int ret; 	dr = kmalloc_obj(struct usb_ctrlrequest, GFP_NOIO);	if (!dr)		return -ENOMEM; 	dr->bRequestType = requesttype;	dr->bRequest = request;	dr->wValue = cpu_to_le16(value);	dr->wIndex = cpu_to_le16(index);	dr->wLength = cpu_to_le16(size); 	ret = usb_internal_control_msg(dev, pipe, dr, data, size, timeout); 	/* Linger a bit, prior to the next control message. */	if (dev->quirks & USB_QUIRK_DELAY_CTRL_MSG)		msleep(200); 	kfree(dr); 	return ret;}EXPORT_SYMBOL_GPL(usb_control_msg); /** * usb_control_msg_send - Builds a control "send" message, sends it off and waits for completion * @dev: pointer to the usb device to send the message to * @endpoint: endpoint to send the message to * @request: USB message request value * @requesttype: USB message request type value * @value: USB message value * @index: USB message index value * @driver_data: pointer to the data to send * @size: length in bytes of the data to send * @timeout: time in msecs to wait for the message to complete before timing out * @memflags: the flags for memory allocation for buffers * * Context: !in_interrupt () * * This function sends a control message to a specified endpoint that is not * expected to fill in a response (i.e. a "send message") and waits for the * message to complete, or timeout. * * Do not use this function from within an interrupt context. If you need * an asynchronous message, or need to send a message from within interrupt * context, use usb_submit_urb(). If a thread in your driver uses this call, * make sure your disconnect() method can wait for it to complete. Since you * don't have a handle on the URB used, you can't cancel the request. * * The data pointer can be made to a reference on the stack, or anywhere else, * as it will not be modified at all.  This does not have the restriction that * usb_control_msg() has where the data pointer must be to dynamically allocated * memory (i.e. memory that can be successfully DMAed to a device). * * Return: If successful, 0 is returned, Otherwise, a negative error number. */int usb_control_msg_send(struct usb_device *dev, __u8 endpoint, __u8 request,			 __u8 requesttype, __u16 value, __u16 index,			 const void *driver_data, __u16 size, int timeout,			 gfp_t memflags){	unsigned int pipe = usb_sndctrlpipe(dev, endpoint);	int ret;	u8 *data = NULL; 	if (size) {		data = kmemdup(driver_data, size, memflags);		if (!data)			return -ENOMEM;	} 	ret = usb_control_msg(dev, pipe, request, requesttype, value, index,			      data, size, timeout);	kfree(data); 	if (ret < 0)		return ret; 	return 0;}EXPORT_SYMBOL_GPL(usb_control_msg_send); /** * usb_control_msg_recv - Builds a control "receive" message, sends it off and waits for completion * @dev: pointer to the usb device to send the message to * @endpoint: endpoint to send the message to * @request: USB message request value * @requesttype: USB message request type value * @value: USB message value * @index: USB message index value * @driver_data: pointer to the data to be filled in by the message * @size: length in bytes of the data to be received * @timeout: time in msecs to wait for the message to complete before timing out * @memflags: the flags for memory allocation for buffers * * Context: !in_interrupt () * * This function sends a control message to a specified endpoint that is * expected to fill in a response (i.e. a "receive message") and waits for the * message to complete, or timeout. * * Do not use this function from within an interrupt context. If you need * an asynchronous message, or need to send a message from within interrupt * context, use usb_submit_urb(). If a thread in your driver uses this call, * make sure your disconnect() method can wait for it to complete. Since you * don't have a handle on the URB used, you can't cancel the request. * * The data pointer can be made to a reference on the stack, or anywhere else * that can be successfully written to.  This function does not have the * restriction that usb_control_msg() has where the data pointer must be to * dynamically allocated memory (i.e. memory that can be successfully DMAed to a * device). * * The "whole" message must be properly received from the device in order for * this function to be successful.  If a device returns less than the expected * amount of data, then the function will fail.  Do not use this for messages * where a variable amount of data might be returned. * * Return: If successful, 0 is returned, Otherwise, a negative error number. */int usb_control_msg_recv(struct usb_device *dev, __u8 endpoint, __u8 request,			 __u8 requesttype, __u16 value, __u16 index,			 void *driver_data, __u16 size, int timeout,			 gfp_t memflags){	unsigned int pipe = usb_rcvctrlpipe(dev, endpoint);	int ret;	u8 *data; 	if (!size || !driver_data)		return -EINVAL; 	data = kmalloc(size, memflags);	if (!data)		return -ENOMEM; 	ret = usb_control_msg(dev, pipe, request, requesttype, value, index,			      data, size, timeout); 	if (ret < 0)		goto exit; 	if (ret == size) {		memcpy(driver_data, data, size);		ret = 0;	} else {		ret = -EREMOTEIO;	} exit:	kfree(data);	return ret;}EXPORT_SYMBOL_GPL(usb_control_msg_recv); /** * usb_interrupt_msg - Builds an interrupt urb, sends it off and waits for completion * @usb_dev: pointer to the usb device to send the message to * @pipe: endpoint "pipe" to send the message to * @data: pointer to the data to send * @len: length in bytes of the data to send * @actual_length: pointer to a location to put the actual length transferred *	in bytes * @timeout: time in msecs to wait for the message to complete before timing out * * Context: task context, might sleep. * * This function sends a simple interrupt message to a specified endpoint and * waits for the message to complete, or timeout. * * Don't use this function from within an interrupt context. If you need * an asynchronous message, or need to send a message from within interrupt * context, use usb_submit_urb() If a thread in your driver uses this call, * make sure your disconnect() method can wait for it to complete. Since you * don't have a handle on the URB used, you can't cancel the request. * * Return: * If successful, 0. Otherwise a negative error number. The number of actual * bytes transferred will be stored in the @actual_length parameter. */int usb_interrupt_msg(struct usb_device *usb_dev, unsigned int pipe,		      void *data, int len, int *actual_length, int timeout){	return usb_bulk_msg(usb_dev, pipe, data, len, actual_length, timeout);}EXPORT_SYMBOL_GPL(usb_interrupt_msg); /** * usb_bulk_msg - Builds a bulk urb, sends it off and waits for completion * @usb_dev: pointer to the usb device to send the message to * @pipe: endpoint "pipe" to send the message to * @data: pointer to the data to send * @len: length in bytes of the data to send * @actual_length: pointer to a location to put the actual length transferred *	in bytes * @timeout: time in msecs to wait for the message to complete before timing out * * Context: task context, might sleep. * * This function sends a simple bulk message to a specified endpoint * and waits for the message to complete, or timeout. * * Don't use this function from within an interrupt context. If you need * an asynchronous message, or need to send a message from within interrupt * context, use usb_submit_urb() If a thread in your driver uses this call, * make sure your disconnect() method can wait for it to complete. Since you * don't have a handle on the URB used, you can't cancel the request. * * Because there is no usb_interrupt_msg() and no USBDEVFS_INTERRUPT ioctl, * users are forced to abuse this routine by using it to submit URBs for * interrupt endpoints.  We will take the liberty of creating an interrupt URB * (with the default interval) if the target is an interrupt endpoint. * * Return: * If successful, 0. Otherwise a negative error number. The number of actual * bytes transferred will be stored in the @actual_length parameter. * */int usb_bulk_msg(struct usb_device *usb_dev, unsigned int pipe,		 void *data, int len, int *actual_length, int timeout){	struct urb *urb;	struct usb_host_endpoint *ep; 	ep = usb_pipe_endpoint(usb_dev, pipe);	if (!ep || len < 0)		return -EINVAL; 	urb = usb_alloc_urb(0, GFP_KERNEL);	if (!urb)		return -ENOMEM; 	if ((ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==			USB_ENDPOINT_XFER_INT) {		pipe = (pipe & ~(3 << 30)) | (PIPE_INTERRUPT << 30);		usb_fill_int_urb(urb, usb_dev, pipe, data, len,				usb_api_blocking_completion, NULL,				ep->desc.bInterval);	} else		usb_fill_bulk_urb(urb, usb_dev, pipe, data, len,				usb_api_blocking_completion, NULL); 	return usb_start_wait_urb(urb, timeout, actual_length, false);}EXPORT_SYMBOL_GPL(usb_bulk_msg); /** * usb_bulk_msg_killable - Builds a bulk urb, sends it off and waits for completion in a killable state * @usb_dev: pointer to the usb device to send the message to * @pipe: endpoint "pipe" to send the message to * @data: pointer to the data to send * @len: length in bytes of the data to send * @actual_length: pointer to a location to put the actual length transferred *	in bytes * @timeout: time in msecs to wait for the message to complete before *	timing out (if <= 0, the wait is as long as possible) * * Context: task context, might sleep. * * This function is just like usb_blk_msg(), except that it waits in a * killable state and there is no limit on the timeout length. * * Return: * If successful, 0. Otherwise a negative error number. The number of actual * bytes transferred will be stored in the @actual_length parameter. * */int usb_bulk_msg_killable(struct usb_device *usb_dev, unsigned int pipe,		 void *data, int len, int *actual_length, int timeout){	struct urb *urb;	struct usb_host_endpoint *ep; 	ep = usb_pipe_endpoint(usb_dev, pipe);	if (!ep || len < 0)		return -EINVAL; 	urb = usb_alloc_urb(0, GFP_KERNEL);	if (!urb)		return -ENOMEM; 	if ((ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) ==			USB_ENDPOINT_XFER_INT) {		pipe = (pipe & ~(3 << 30)) | (PIPE_INTERRUPT << 30);		usb_fill_int_urb(urb, usb_dev, pipe, data, len,				usb_api_blocking_completion, NULL,				ep->desc.bInterval);	} else		usb_fill_bulk_urb(urb, usb_dev, pipe, data, len,				usb_api_blocking_completion, NULL); 	return usb_start_wait_urb(urb, timeout, actual_length, true);}EXPORT_SYMBOL_GPL(usb_bulk_msg_killable); /*-------------------------------------------------------------------*/ static void sg_clean(struct usb_sg_request *io){	if (io->urbs) {		while (io->entries--)			usb_free_urb(io->urbs[io->entries]);		kfree(io->urbs);		io->urbs = NULL;	}	io->dev = NULL;} static void sg_complete(struct urb *urb){	unsigned long flags;	struct usb_sg_request *io = urb->context;	int status = urb->status; 	spin_lock_irqsave(&io->lock, flags); 	/* In 2.5 we require hcds' endpoint queues not to progress after fault	 * reports, until the completion callback (this!) returns.  That lets	 * device driver code (like this routine) unlink queued urbs first,	 * if it needs to, since the HC won't work on them at all.  So it's	 * not possible for page N+1 to overwrite page N, and so on.	 *	 * That's only for "hard" faults; "soft" faults (unlinks) sometimes	 * complete before the HCD can get requests away from hardware,	 * though never during cleanup after a hard fault.	 */	if (io->status			&& (io->status != -ECONNRESET				|| status != -ECONNRESET)			&& urb->actual_length) {		dev_err(io->dev->bus->controller,			"dev %s ep%d%s scatterlist error %d/%d\n",			io->dev->devpath,			usb_endpoint_num(&urb->ep->desc),			usb_urb_dir_in(urb) ? "in" : "out",			status, io->status);		/* BUG (); */	} 	if (io->status == 0 && status && status != -ECONNRESET) {		int i, found, retval; 		io->status = status; 		/* the previous urbs, and this one, completed already.		 * unlink pending urbs so they won't rx/tx bad data.

Lines 1–500 of 2521.