USB cleanup ideas

[Hasso Tepper <hasso@xxxxxxxxx>]

While looking at improving some USB stuff I noticed how many obfuscating
macros are used in the code. Although I can see how it was meant to make
sharing of code easier between BSDs, it isn't the case any mode - FreeBSD
and OpenBSD already removed most of these macros. So, I'd like to do some
cleaning at first to ease bringing in changes from other BSDs - ie. nuke
this obfuscating stuff.

For start I cleaned up sys/bus/usb/usb_port.h. I don't think that it
makes much sense to have the code not used by us in headers (see attached
patch). I intend to continue with mechanical cleanup at first: nuke
device_ptr_t, USBBASEDEVICE, USBDEV etc. Or is there any objections?

Note, that I don't intend to remove macros from usb_port.h header itself.
Having these macros in the header makes still sense for porting drivers
from NetBSD, compiling older out of tree drivers etc.

Also, if someone steps up and says "this is something for me and I'd like
to work on this", I'd be more than happy - I have plenty of other ideas -
http://wiki.dragonflybsd.org/index.cgi/HassoTODOs ;).


-- 
Hasso Tepper

# HG changeset patch
# User Hasso Tepper <hasso@estpak.ee>
# Date 1182756467 -10800
# Node ID a4a087865dd718a73d8b3c17a55c2103adc3c8c0
# Parent  ba495143ec7048f30d44373e3310ea564b0eb166
Clean up sys/bus/usb/usb_port.h. Remove Net/Free/OpenBSD and other not
used code. Also remove memset/memcpy defines.

diff -r ba495143ec70 -r a4a087865dd7 sys/bus/usb/usb_port.h
--- a/sys/bus/usb/usb_port.h	Sun Jun 24 21:55:08 2007 +0300
+++ b/sys/bus/usb/usb_port.h	Mon Jun 25 10:27:47 2007 +0300
@@ -51,18 +51,13 @@
 #define _USB_PORT_H
 
 /*
- * Macro's to cope with the differences between operating systems.
- */
-
-#if defined(__NetBSD__)
-/*
- * NetBSD
- */
-
-#include "opt_usbverbose.h"
+ * Macros to ease the import of USB drivers from other BSD systems.
+ */
+
+#include "opt_usb.h"
 
 #if defined(_KERNEL)
-#include <sys/mallocvar.h>
+#include <sys/malloc.h>
 
 MALLOC_DECLARE(M_USB);
 MALLOC_DECLARE(M_USBDEV);
@@ -70,285 +65,7 @@ MALLOC_DECLARE(M_USBHC);
 
 #endif
 
-#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 struct malloc_type *usb_malloc_type;
-
-#define Ether_ifattach ether_ifattach
-
-#define logprintf kprintf
-
-#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 kprintf("\n")
-
-#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_loc(parent, (args)->port == 0 ? "usb" : "uhub", \
-			     NULL, 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 ether_ifattach
-#define if_deactivate(x)
-
-#define	usbpoll			usbselect
-#define	uhidpoll		uhidselect
-#define	ugenpoll		ugenselect
-#define uscannerpoll		uscannerselect
-
-#define powerhook_establish(fn, sc) (fn)
-#define powerhook_disestablish(hdl)
-#define PWR_RESUME 0
-
-#define logprintf kprintf
-
-#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 kprintf("\n")
-
-#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(__DragonFly__)
-/***************************************************************************
- *					DRAGONFLY
- */
-#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. */
-/* #undef USB_USE_SOFTINTR */
 
 #define Static static
 
@@ -377,10 +94,6 @@ MALLOC_DECLARE(M_USBHC);
 
 typedef struct thread *usb_proc_ptr;
 
-/* XXX Change this when FreeBSD has memset */
-#define memcpy(d, s, l)         bcopy((s),(d),(l))
-#define memset(d, v, l)         bzero((d),(l))
-
 #define	config_pending_incr()
 #define	config_pending_decr()
 
@@ -453,7 +166,7 @@ __CONCAT(dname,_attach)(device_t self)
         struct usb_attach_arg *uaa = device_get_ivars(self)
 
 /* Returns from attach */
-#define USB_ATTACH_ERROR_RETURN	return ENXIO
+#define USB_ATTACH_ERROR_RETURN		return ENXIO
 #define USB_ATTACH_SUCCESS_RETURN	return 0
 
 #define USB_ATTACH_SETUP \
@@ -491,201 +204,11 @@ __CONCAT(dname,_detach)(device_t self)
 #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		kprintf
 
 #ifdef SYSCTL_DECL
 SYSCTL_DECL(_hw_usb);
 #endif
 
-#elif defined(__FreeBSD__) || defined(__DragonFly__)
-/***************************************************************************
- *					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 defined(__FreeBSD__) && __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))
-#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))
-#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) device_delete_child(device_get_parent(dev), dev)
-
-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 \
-	sc->sc_dev = self; \
-	device_set_desc_copy(self, devinfo)
-
-#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		kprintf
-
-#ifdef SYSCTL_DECL
-SYSCTL_DECL(_hw_usb);
-#endif
-
-#endif /* __FreeBSD__ */
-
 #endif /* _USB_PORT_H */