freebsd-skq/sys/dev/usb/usb_port.h
Ian Dowse 0ce606de7c Attempt to fix a number of race conditions in the handling of
transfer timeouts that typically cause a transfer to be completed
twice, resulting in panics and page faults:

 o A transfer completion interrupt could arrive while an abort_task
   event was set up, so the transfer would be aborted after it had
   completed. This is very easy to reproduce. Fix this by setting
   the transfer status to USBD_TIMEOUT before scheduling the
   abort_task so that the transfer completion code will ignore it.

 o The transfer completion code could execute concurrently with the
   timeout callout, leaving the callout blocked (e.g. waiting for
   Giant) while the transfer completion code runs. In this case,
   callout_stop() does not prevent the callout from running, so
   again the timeout code would run after the transfer was complete.
   Handle this case by checking the return value from callout_stop(),
   and ignoring the transfer if the callout could not be removed.

 o Finally, protect against a timeout callout occurring while a
   transfer is being aborted by another process. Here we arrange
   for the timeout processing to ignore the transfer, and use
   callout_drain() to ensure that the callout has really gone before
   completing the transfer.

This was tested by repeatedly performing USB transfers with a timeout
set to approximately the same as the normal transfer completion
time. In the PR below, apparently this occurred by accident with a
particular printer and the default timeout.

PR:		kern/71491
2004-11-09 20:51:32 +00:00

532 lines
15 KiB
C

/* $OpenBSD: usb_port.h,v 1.18 2000/09/06 22:42:10 rahnds Exp $ */
/* $NetBSD: usb_port.h,v 1.54 2002/03/28 21:49:19 ichiro Exp $ */
/* $FreeBSD$ */
/* Also already merged from NetBSD:
* $NetBSD: usb_port.h,v 1.57 2002/09/27 20:42:01 thorpej Exp $
* $NetBSD: usb_port.h,v 1.58 2002/10/01 01:25:26 thorpej Exp $
*/
/*
* Copyright (c) 1998 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.
*
* 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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.
*/
#ifndef _USB_PORT_H
#define _USB_PORT_H
/*
* Macro's to cope with the differences between operating systems.
*/
#if defined(__NetBSD__)
/*
* NetBSD
*/
#include "opt_usbverbose.h"
#define USB_USE_SOFTINTR
#ifdef USB_DEBUG
#define Static
#else
#define Static static
#endif
#define SCSI_MODE_SENSE MODE_SENSE
typedef struct proc *usb_proc_ptr;
typedef struct device *device_ptr_t;
#define USBBASEDEVICE struct device
#define USBDEV(bdev) (&(bdev))
#define USBDEVNAME(bdev) ((bdev).dv_xname)
#define USBDEVUNIT(bdev) ((bdev).dv_unit)
#define USBDEVPTRNAME(bdevptr) ((bdevptr)->dv_xname)
#define USBGETSOFTC(d) ((void *)(d))
#define DECLARE_USB_DMA_T \
struct usb_dma_block; \
typedef struct { \
struct usb_dma_block *block; \
u_int offs; \
} usb_dma_t
typedef struct callout usb_callout_t;
#define usb_callout_init(h) callout_init(&(h))
#define usb_callout(h, t, f, d) callout_reset(&(h), (t), (f), (d))
#define usb_uncallout(h, f, d) callout_stop(&(h))
#define usb_kthread_create1 kthread_create1
#define usb_kthread_create kthread_create
typedef int usb_malloc_type;
#define Ether_ifattach ether_ifattach
#define IF_INPUT(ifp, m) (*(ifp)->if_input)((ifp), (m))
#define logprintf printf
#define USB_DNAME(dname) dname
#define USB_DECLARE_DRIVER(dname) \
int __CONCAT(dname,_match)(struct device *, struct cfdata *, void *); \
void __CONCAT(dname,_attach)(struct device *, struct device *, void *); \
int __CONCAT(dname,_detach)(struct device *, int); \
int __CONCAT(dname,_activate)(struct device *, enum devact); \
\
extern struct cfdriver __CONCAT(dname,_cd); \
\
CFATTACH_DECL(USB_DNAME(dname), \
sizeof(struct ___CONCAT(dname,_softc)), \
___CONCAT(dname,_match), \
___CONCAT(dname,_attach), \
___CONCAT(dname,_detach), \
___CONCAT(dname,_activate))
#define USB_MATCH(dname) \
int __CONCAT(dname,_match)(struct device *parent, struct cfdata *match, void *aux)
#define USB_MATCH_START(dname, uaa) \
struct usb_attach_arg *uaa = aux
#define USB_ATTACH(dname) \
void __CONCAT(dname,_attach)(struct device *parent, struct device *self, void *aux)
#define USB_ATTACH_START(dname, sc, uaa) \
struct __CONCAT(dname,_softc) *sc = \
(struct __CONCAT(dname,_softc) *)self; \
struct usb_attach_arg *uaa = aux
/* Returns from attach */
#define USB_ATTACH_ERROR_RETURN return
#define USB_ATTACH_SUCCESS_RETURN return
#define USB_ATTACH_SETUP
printf("\n%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
#define USB_DETACH(dname) \
int __CONCAT(dname,_detach)(struct device *self, int flags)
#define USB_DETACH_START(dname, sc) \
struct __CONCAT(dname,_softc) *sc = \
(struct __CONCAT(dname,_softc) *)self
#define USB_GET_SC_OPEN(dname, unit, sc) \
if (unit >= __CONCAT(dname,_cd).cd_ndevs) \
return (ENXIO); \
sc = __CONCAT(dname,_cd).cd_devs[unit]; \
if (sc == NULL) \
return (ENXIO)
#define USB_GET_SC(dname, unit, sc) \
sc = __CONCAT(dname,_cd).cd_devs[unit]
#define USB_DO_ATTACH(dev, bdev, parent, args, print, sub) \
(config_found_sm(parent, args, print, sub))
#elif defined(__OpenBSD__)
/*
* OpenBSD
*/
#define Static
typedef struct proc *usb_proc_ptr;
#define UCOMBUSCF_PORTNO -1
#define UCOMBUSCF_PORTNO_DEFAULT -1
#define SCSI_MODE_SENSE MODE_SENSE
#define XS_STS_DONE ITSDONE
#define XS_CTL_POLL SCSI_POLL
#define XS_CTL_DATA_IN SCSI_DATA_IN
#define XS_CTL_DATA_OUT SCSI_DATA_OUT
#define scsipi_adapter scsi_adapter
#define scsipi_cmd scsi_cmd
#define scsipi_device scsi_device
#define scsipi_done scsi_done
#define scsipi_link scsi_link
#define scsipi_minphys scsi_minphys
#define scsipi_sense scsi_sense
#define scsipi_xfer scsi_xfer
#define xs_control flags
#define xs_status status
#define memcpy(d, s, l) bcopy((s),(d),(l))
#define memset(d, v, l) bzero((d),(l))
#define bswap32(x) swap32(x)
#define bswap16(x) swap16(x)
/*
* The UHCI/OHCI controllers are little endian, so on big endian machines
* the data strored in memory needs to be swapped.
*/
#if defined(letoh32)
#define le32toh(x) letoh32(x)
#define le16toh(x) letoh16(x)
#endif
#define usb_kthread_create1 kthread_create
#define usb_kthread_create kthread_create_deferred
#define config_pending_incr()
#define config_pending_decr()
typedef int usb_malloc_type;
#define Ether_ifattach(ifp, eaddr) ether_ifattach(ifp)
#define if_deactivate(x)
#define IF_INPUT(ifp, m) do { \
struct ether_header *eh; \
\
eh = mtod(m, struct ether_header *); \
m_adj(m, sizeof(struct ether_header)); \
ether_input((ifp), (eh), (m)); \
} while (0)
#define usbpoll usbselect
#define uhidpoll uhidselect
#define ugenpoll ugenselect
#define uriopoll urioselect
#define uscannerpoll uscannerselect
#define powerhook_establish(fn, sc) (fn)
#define powerhook_disestablish(hdl)
#define PWR_RESUME 0
#define logprintf printf
#define swap_bytes_change_sign16_le swap_bytes_change_sign16
#define change_sign16_swap_bytes_le change_sign16_swap_bytes
#define change_sign16_le change_sign16
#define realloc usb_realloc
void *usb_realloc(void *, u_int, int, int);
extern int cold;
typedef struct device *device_ptr_t;
#define USBBASEDEVICE struct device
#define USBDEV(bdev) (&(bdev))
#define USBDEVNAME(bdev) ((bdev).dv_xname)
#define USBDEVUNIT(bdev) ((bdev).dv_unit)
#define USBDEVPTRNAME(bdevptr) ((bdevptr)->dv_xname)
#define USBGETSOFTC(d) ((void *)(d))
#define DECLARE_USB_DMA_T \
struct usb_dma_block; \
typedef struct { \
struct usb_dma_block *block; \
u_int offs; \
} usb_dma_t
typedef char usb_callout_t;
#define usb_callout_init(h)
#define usb_callout(h, t, f, d) timeout((f), (d), (t))
#define usb_uncallout(h, f, d) untimeout((f), (d))
#define USB_DECLARE_DRIVER(dname) \
int __CONCAT(dname,_match)(struct device *, void *, void *); \
void __CONCAT(dname,_attach)(struct device *, struct device *, void *); \
int __CONCAT(dname,_detach)(struct device *, int); \
int __CONCAT(dname,_activate)(struct device *, enum devact); \
\
struct cfdriver __CONCAT(dname,_cd) = { \
NULL, #dname, DV_DULL \
}; \
\
const struct cfattach __CONCAT(dname,_ca) = { \
sizeof(struct __CONCAT(dname,_softc)), \
__CONCAT(dname,_match), \
__CONCAT(dname,_attach), \
__CONCAT(dname,_detach), \
__CONCAT(dname,_activate), \
}
#define USB_MATCH(dname) \
int \
__CONCAT(dname,_match)(parent, match, aux) \
struct device *parent; \
void *match; \
void *aux;
#define USB_MATCH_START(dname, uaa) \
struct usb_attach_arg *uaa = aux
#define USB_ATTACH(dname) \
void \
__CONCAT(dname,_attach)(parent, self, aux) \
struct device *parent; \
struct device *self; \
void *aux;
#define USB_ATTACH_START(dname, sc, uaa) \
struct __CONCAT(dname,_softc) *sc = \
(struct __CONCAT(dname,_softc) *)self; \
struct usb_attach_arg *uaa = aux
/* Returns from attach */
#define USB_ATTACH_ERROR_RETURN return
#define USB_ATTACH_SUCCESS_RETURN return
#define USB_ATTACH_SETUP
printf("\n%s: %s\n", USBDEVNAME(sc->sc_dev), devinfo);
#define USB_DETACH(dname) \
int \
__CONCAT(dname,_detach)(self, flags) \
struct device *self; \
int flags;
#define USB_DETACH_START(dname, sc) \
struct __CONCAT(dname,_softc) *sc = \
(struct __CONCAT(dname,_softc) *)self
#define USB_GET_SC_OPEN(dname, unit, sc) \
if (unit >= __CONCAT(dname,_cd).cd_ndevs) \
return (ENXIO); \
sc = __CONCAT(dname,_cd).cd_devs[unit]; \
if (sc == NULL) \
return (ENXIO)
#define USB_GET_SC(dname, unit, sc) \
sc = __CONCAT(dname,_cd).cd_devs[unit]
#define USB_DO_ATTACH(dev, bdev, parent, args, print, sub) \
(config_found_sm(parent, args, print, sub))
#elif defined(__FreeBSD__)
/*
* FreeBSD
*/
#include "opt_usb.h"
#if defined(_KERNEL)
#include <sys/malloc.h>
MALLOC_DECLARE(M_USB);
MALLOC_DECLARE(M_USBDEV);
MALLOC_DECLARE(M_USBHC);
#endif
#define USBVERBOSE
/* We don't use the soft interrupt code in FreeBSD. */
#if 0
#define USB_USE_SOFTINTR
#endif
#define Static static
#define device_ptr_t device_t
#define USBBASEDEVICE device_t
#define USBDEV(bdev) (bdev)
#define USBDEVNAME(bdev) device_get_nameunit(bdev)
#define USBDEVUNIT(bdev) device_get_unit(bdev)
#define USBDEVPTRNAME(bdev) device_get_nameunit(bdev)
#define USBDEVUNIT(bdev) device_get_unit(bdev)
#define USBGETSOFTC(bdev) (device_get_softc(bdev))
#define DECLARE_USB_DMA_T \
struct usb_dma_block; \
typedef struct { \
struct usb_dma_block *block; \
u_int offs; \
u_int len; \
} usb_dma_t
#if __FreeBSD_version >= 500000
typedef struct thread *usb_proc_ptr;
#define uio_procp uio_td
#define usb_kthread_create1(f, s, p, a0, a1) \
kthread_create((f), (s), (p), RFHIGHPID, 0, (a0), (a1))
#define usb_kthread_create2(f, s, p, a0) \
kthread_create((f), (s), (p), RFHIGHPID, 0, (a0))
#define usb_kthread_create kthread_create
#define config_pending_incr()
#define config_pending_decr()
typedef struct callout usb_callout_t;
#define usb_callout_init(h) callout_init(&(h), 0)
#define usb_callout(h, t, f, d) callout_reset(&(h), (t), (f), (d))
#define usb_uncallout(h, f, d) callout_stop(&(h))
#define usb_uncallout_drain(h, f, d) callout_drain(&(h))
#else
typedef struct proc *usb_proc_ptr;
#define PROC_LOCK(p)
#define PROC_UNLOCK(p)
#define usb_kthread_create1(f, s, p, a0, a1) \
kthread_create((f), (s), (p), (a0), (a1))
#define usb_kthread_create2(f, s, p, a0) \
kthread_create((f), (s), (p), (a0))
#define usb_kthread_create kthread_create
#define config_pending_incr()
#define config_pending_decr()
typedef struct callout usb_callout_t;
#define usb_callout_init(h) callout_init(&(h))
#define usb_callout(h, t, f, d) callout_reset(&(h), (t), (f), (d))
#define usb_uncallout(h, f, d) callout_stop(&(h))
#define BUS_DMA_COHERENT 0
#define ETHER_ALIGN 2
#define BPF_MTAP(ifp, m) if ((ifp)->if_bpf) bpf_mtap((ifp), (m));
#endif
#define clalloc(p, s, x) (clist_alloc_cblocks((p), (s), (s)), 0)
#define clfree(p) clist_free_cblocks((p))
#define PWR_RESUME 0
#define PWR_SUSPEND 1
#define config_detach(dev, flag) \
do { \
device_detach(dev); \
free(device_get_ivars(dev), M_USB); \
device_delete_child(device_get_parent(dev), dev); \
} while (0);
typedef struct malloc_type *usb_malloc_type;
#define USB_DECLARE_DRIVER_INIT(dname, init...) \
Static device_probe_t __CONCAT(dname,_match); \
Static device_attach_t __CONCAT(dname,_attach); \
Static device_detach_t __CONCAT(dname,_detach); \
\
Static devclass_t __CONCAT(dname,_devclass); \
\
Static device_method_t __CONCAT(dname,_methods)[] = { \
DEVMETHOD(device_probe, __CONCAT(dname,_match)), \
DEVMETHOD(device_attach, __CONCAT(dname,_attach)), \
DEVMETHOD(device_detach, __CONCAT(dname,_detach)), \
init, \
{0,0} \
}; \
\
Static driver_t __CONCAT(dname,_driver) = { \
#dname, \
__CONCAT(dname,_methods), \
sizeof(struct __CONCAT(dname,_softc)) \
}; \
MODULE_DEPEND(dname, usb, 1, 1, 1)
#define METHODS_NONE {0,0}
#define USB_DECLARE_DRIVER(dname) USB_DECLARE_DRIVER_INIT(dname, METHODS_NONE)
#define USB_MATCH(dname) \
Static int \
__CONCAT(dname,_match)(device_t self)
#define USB_MATCH_START(dname, uaa) \
struct usb_attach_arg *uaa = device_get_ivars(self)
#define USB_MATCH_SETUP \
sc->sc_dev = self
#define USB_ATTACH(dname) \
Static int \
__CONCAT(dname,_attach)(device_t self)
#define USB_ATTACH_START(dname, sc, uaa) \
struct __CONCAT(dname,_softc) *sc = device_get_softc(self); \
struct usb_attach_arg *uaa = device_get_ivars(self)
/* Returns from attach */
#define USB_ATTACH_ERROR_RETURN return ENXIO
#define USB_ATTACH_SUCCESS_RETURN return 0
#define USB_ATTACH_SETUP \
do { \
sc->sc_dev = self; \
device_set_desc_copy(self, devinfo); \
device_printf(self, "%s\n", devinfo); \
} while (0);
#define USB_DETACH(dname) \
Static int \
__CONCAT(dname,_detach)(device_t self)
#define USB_DETACH_START(dname, sc) \
struct __CONCAT(dname,_softc) *sc = device_get_softc(self)
#define USB_GET_SC_OPEN(dname, unit, sc) \
sc = devclass_get_softc(__CONCAT(dname,_devclass), unit); \
if (sc == NULL) \
return (ENXIO)
#define USB_GET_SC(dname, unit, sc) \
sc = devclass_get_softc(__CONCAT(dname,_devclass), unit)
#define USB_DO_ATTACH(dev, bdev, parent, args, print, sub) \
(device_probe_and_attach((bdev)) == 0 ? (bdev) : 0)
/* conversion from one type of queue to the other */
#define SIMPLEQ_REMOVE_HEAD STAILQ_REMOVE_HEAD
#define SIMPLEQ_INSERT_HEAD STAILQ_INSERT_HEAD
#define SIMPLEQ_INSERT_TAIL STAILQ_INSERT_TAIL
#define SIMPLEQ_NEXT STAILQ_NEXT
#define SIMPLEQ_FIRST STAILQ_FIRST
#define SIMPLEQ_HEAD STAILQ_HEAD
#define SIMPLEQ_EMPTY STAILQ_EMPTY
#define SIMPLEQ_FOREACH STAILQ_FOREACH
#define SIMPLEQ_INIT STAILQ_INIT
#define SIMPLEQ_HEAD_INITIALIZER STAILQ_HEAD_INITIALIZER
#define SIMPLEQ_ENTRY STAILQ_ENTRY
#include <sys/syslog.h>
/*
#define logprintf(args...) log(LOG_DEBUG, args)
*/
#define logprintf printf
#ifdef SYSCTL_DECL
SYSCTL_DECL(_hw_usb);
#endif
#endif /* __FreeBSD__ */
#endif /* _USB_PORT_H */