 @@ -1,336 +1,336 @@
-/*	$NetBSD: usbdivar.h,v 1.101 2013/01/22 12:40:44 jmcneill Exp $	*/
+/*	$NetBSD: usbdivar.h,v 1.102 2013/01/23 06:53:30 skrll Exp $	*/
 /*
  * Copyright (c) 1998, 2012 The NetBSD Foundation, Inc.
  * All rights reserved.
+ *
  * This code is derived from software contributed to The NetBSD Foundation
  * by Lennart Augustsson (lennart@augustsson.net) at
  * Carlstedt Research & Technology and Matthew R. Green (mrg@eterna.com.au).
+ *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
+ *
  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
 /*
  * Discussion about locking in the USB code:
+ *
  * The host controller presents one lock at IPL_SOFTUSB.
+ *
  * List of hardware interface methods, and whether the lock is held
  * when each is called by this module:
+ *
  *	BUS METHOD		LOCK  NOTES
  *	----------------------- -------	-------------------------
  *	open_pipe		-	might want to take lock?
  *	soft_intr		x
  *	do_poll			-	might want to take lock?
  *	allocm			-
  *	freem			-
  *	allocx			-
  *	freex			-
  *	get_lock 		-	Called at attach time
+ *
  *	PIPE METHOD		LOCK  NOTES
  *	----------------------- -------	-------------------------
  *	transfer		-
  *	start			-	might want to take lock?
  *	abort			x
  *	close			x
  *	cleartoggle		-
  *	done			x
+ *
  * The above semantics are likely to change.  Little performance
  * evaluation has been done on this code and the locking strategy.
+ *
  * USB functions known to expect the lock taken include (this list is
  * probably not exhaustive):
  *    usb_transfer_complete()
  *    usb_insert_transfer()
  *    usb_start_next()
+ *
  */
 #include <sys/callout.h>
 #include <sys/mutex.h>
 #include <sys/bus.h>
 /* From usb_mem.h */
 struct usb_dma_block;
 typedef struct {
 	struct usb_dma_block *block;
 	u_int offs;
 } usb_dma_t;
 struct usbd_xfer;
 struct usbd_pipe;
 struct usbd_endpoint {
 	usb_endpoint_descriptor_t *edesc;
 	int			refcnt;
 	int datatoggle;
 };
 struct usbd_bus_methods {
 	usbd_status	      (*open_pipe)(struct usbd_pipe *pipe);
 	void		      (*soft_intr)(void *);
 	void		      (*do_poll)(struct usbd_bus *);
 	usbd_status	      (*allocm)(struct usbd_bus *, usb_dma_t *,
 					u_int32_t bufsize);
 	void		      (*freem)(struct usbd_bus *, usb_dma_t *);
 	struct usbd_xfer *    (*allocx)(struct usbd_bus *);
 	void		      (*freex)(struct usbd_bus *, struct usbd_xfer *);
 	void		      (*get_lock)(struct usbd_bus *, kmutex_t **);
 };
 struct usbd_pipe_methods {
 	usbd_status	      (*transfer)(usbd_xfer_handle xfer);
 	usbd_status	      (*start)(usbd_xfer_handle xfer);
 	void		      (*abort)(usbd_xfer_handle xfer);
 	void		      (*close)(usbd_pipe_handle pipe);
 	void		      (*cleartoggle)(usbd_pipe_handle pipe);
 	void		      (*done)(usbd_xfer_handle xfer);
 };
 #if 0 /* notyet */
 struct usbd_tt {
 	struct usbd_hub	       *hub;
 };
 #endif
 struct usbd_port {
 	usb_port_status_t	status;
 	u_int16_t		power;	/* mA of current on port */
 	u_int8_t		portno;
 	u_int8_t		restartcnt;
 #define USBD_RESTART_MAX 5
 	u_int8_t		reattach;
 	struct usbd_device     *device;	/* Connected device */
 	struct usbd_device     *parent;	/* The ports hub */
 #if 0
 	struct usbd_tt	       *tt; /* Transaction translator (if any) */
 #endif
 };
 struct usbd_hub {
 	usbd_status	      (*explore)(usbd_device_handle hub);
 	void		       *hubsoftc;
 	usb_hub_descriptor_t	hubdesc;
 	struct usbd_port        ports[1];
 };
 /*****/
 struct usbd_bus {
 	/* Filled by HC driver */
 	void			*hci_private;
 	const struct usbd_bus_methods *methods;
 	u_int32_t		pipe_size; /* size of a pipe struct */
 	/* Filled by usb driver */
 	kmutex_t		*lock;
 	struct usbd_device      *root_hub;
 	usbd_device_handle	devices[USB_MAX_DEVICES];
 	kcondvar_t              needs_explore_cv;
 	char			needs_explore;/* a hub a signalled a change */
 	char			use_polling;
 	device_t		usbctl;
 	struct usb_device_stats	stats;
 	u_int			no_intrs;
 	int			usbrev;	/* USB revision */
 #define USBREV_UNKNOWN	0
 #define USBREV_PRE_1_0	1
 #define USBREV_1_0	2
 #define USBREV_1_1	3
 #define USBREV_2_0	4
 #define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
 	void		       *soft; /* soft interrupt cookie */
 	bus_dma_tag_t		dmatag;	/* DMA tag */
 };
 struct usbd_device {
 	struct usbd_bus	       *bus;           /* our controller */
 	struct usbd_pipe       *default_pipe;  /* pipe 0 */
 	u_int8_t		address;       /* device addess */
 	u_int8_t		config;	       /* current configuration # */
 	u_int8_t		depth;         /* distance from root hub */
 	u_int8_t		speed;         /* low/full/high speed */
 	u_int8_t		self_powered;  /* flag for self powered */
 	u_int16_t		power;         /* mA the device uses */
 	int16_t			langid;	       /* language for strings */
 #define USBD_NOLANG (-1)
 	usb_event_cookie_t	cookie;	       /* unique connection id */
 	struct usbd_port       *powersrc;      /* upstream hub port, or 0 */
 	struct usbd_device     *myhub; 	       /* upstream hub */
 	struct usbd_port       *myhsport;      /* closest high speed port */
 	struct usbd_endpoint	def_ep;	       /* for pipe 0 */
 	usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
 	struct usbd_interface  *ifaces;        /* array of all interfaces */
 	usb_device_descriptor_t ddesc;         /* device descriptor */
 	usb_config_descriptor_t *cdesc;	       /* full config descr */
 	const struct usbd_quirks     *quirks;  /* device quirks, always set */
 	struct usbd_hub	       *hub;           /* only if this is a hub */
 	int			subdevlen;     /* array length of following */
 	device_t	       *subdevs;       /* sub-devices */
 	int			nifaces_claimed; /* number of ifaces in use */
 };
 struct usbd_interface {
 	struct usbd_device     *device;
 	usb_interface_descriptor_t *idesc;
 	int			index;
 	int			altindex;
 	struct usbd_endpoint   *endpoints;
 	void		       *priv;
 	LIST_HEAD(, usbd_pipe)	pipes;
 };
 struct usbd_pipe {
 	struct usbd_interface  *iface;
 	struct usbd_device     *device;
 	struct usbd_endpoint   *endpoint;
 	int			refcnt;
 	char			running;
 	char			aborting;
 	SIMPLEQ_HEAD(, usbd_xfer) queue;
 	LIST_ENTRY(usbd_pipe)	next;
 	struct usb_task		async_task;
 	usbd_xfer_handle	intrxfer; /* used for repeating requests */
 	char			repeat;
 	int			interval;
 	uint8_t			flags;
 	/* Filled by HC driver. */
 	const struct usbd_pipe_methods *methods;
 };
 struct usbd_xfer {
 	struct usbd_pipe       *pipe;
 	void		       *priv;
 	void		       *buffer;
 	kcondvar_t		cv;
 	u_int32_t		length;
 	u_int32_t		actlen;
 	u_int16_t		flags;
 	u_int32_t		timeout;
 	usbd_status		status;
 	usbd_callback		callback;
 	volatile u_int8_t	done;
 	u_int8_t		busy_free;	/* used for DIAGNOSTIC */
 #define XFER_FREE 0x46
 #define XFER_BUSY 0x55
 #define XFER_ONQU 0x9e
 	/* For control pipe */
 	usb_device_request_t	request;
 	/* For isoc */
 	u_int16_t		*frlengths;
 	int			nframes;
 	/* For memory allocation */
 	struct usbd_device     *device;
 	usb_dma_t		dmabuf;
 	u_int8_t		rqflags;
 #define URQ_REQUEST	0x01
 #define URQ_AUTO_DMABUF	0x10
 #define URQ_DEV_DMABUF	0x20
 	SIMPLEQ_ENTRY(usbd_xfer) next;
 	void		       *hcpriv; /* private use by the HC driver */
 	u_int8_t		hcflags; /* private use by the HC driver */
 #define UXFER_ABORTING	0x01	/* xfer is aborting. */
 #define UXFER_ABORTWAIT	0x02	/* abort completion is being awaited. */
 	kcondvar_t		hccv; /* private use by the HC driver */
-        struct callout timeout_handle;
+	struct callout timeout_handle;
 };
 void usbd_init(void);
 void usbd_finish(void);
 #if defined(USB_DEBUG) || defined(EHCI_DEBUG)
 void usbd_dump_iface(struct usbd_interface *iface);
 void usbd_dump_device(struct usbd_device *dev);
 void usbd_dump_endpoint(struct usbd_endpoint *endp);
 void usbd_dump_queue(usbd_pipe_handle pipe);
 void usbd_dump_pipe(usbd_pipe_handle pipe);
 #endif
 /* Routines from usb_subr.c */
 int		usbctlprint(void *, const char *);
 void		usb_delay_ms_locked(usbd_bus_handle, u_int, kmutex_t *);
 void		usb_delay_ms(usbd_bus_handle, u_int);
 void		usbd_delay_ms_locked(usbd_device_handle, u_int, kmutex_t *);
 void		usbd_delay_ms(usbd_device_handle, u_int);
 usbd_status	usbd_reset_port(usbd_device_handle, int, usb_port_status_t *);
 usbd_status	usbd_setup_pipe(usbd_device_handle dev,
 				usbd_interface_handle iface,
 				struct usbd_endpoint *, int,
 				usbd_pipe_handle *pipe);
 usbd_status	usbd_setup_pipe_flags(usbd_device_handle dev,
 				      usbd_interface_handle iface,
 				      struct usbd_endpoint *, int,
 				      usbd_pipe_handle *pipe,
 				      uint8_t flags);
 usbd_status	usbd_new_device(device_t, usbd_bus_handle, int, int, int,
-                                struct usbd_port *);
+				struct usbd_port *);
 usbd_status	usbd_reattach_device(device_t, usbd_device_handle,
-                                     int, const int *);
+				     int, const int *);
 void		usbd_remove_device(usbd_device_handle, struct usbd_port *);
 int		usbd_printBCD(char *, size_t, int);
 usbd_status	usbd_fill_iface_data(usbd_device_handle, int, int);
 void		usb_free_device(usbd_device_handle);
 usbd_status	usb_insert_transfer(usbd_xfer_handle);
 void		usb_transfer_complete(usbd_xfer_handle);
 int		usb_disconnect_port(struct usbd_port *, device_t, int);
 /* Routines from usb.c */
 void		usb_needs_explore(usbd_device_handle);
 void		usb_needs_reattach(usbd_device_handle);
 void		usb_schedsoftintr(struct usbd_bus *);
 /*
  * These macros help while not all host controllers are ported to the MP code.
  */
 #define usbd_mutex_enter(m)	do { \
 	if (m) { \
 		s = -1; \
 		mutex_enter(m); \
 	} else \
 		s = splusb(); \
 } while (0)
 #define usbd_mutex_exit(m)	do { \
 	if (m) { \
 		s = -1; \
 		mutex_exit(m); \
 	} else \
 		splx(s); \
 } while (0)
 #define usbd_lock_pipe(p)	usbd_mutex_enter((p)->device->bus->lock)
 #define usbd_unlock_pipe(p)	usbd_mutex_exit((p)->device->bus->lock)