xref: /dragonfly/sys/dev/raid/twe/twe_compat.h (revision 19fe1c42)
1 /*-
2  * Copyright (c) 2000 Michael Smith
3  * Copyright (c) 2003 Paul Saab
4  * Copyright (c) 2003 Vinod Kashyap
5  * Copyright (c) 2000 BSDi
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: src/sys/dev/twe/twe_compat.h,v 1.1.2.5 2004/04/07 22:18:00 vkashyap Exp $
30  * $DragonFly: src/sys/dev/raid/twe/twe_compat.h,v 1.17 2008/06/10 17:20:52 dillon Exp $
31  */
32 /*
33  * Portability and compatibility interfaces.
34  */
35 
36 #if defined(__FreeBSD__) || defined(__DragonFly__)
37 /******************************************************************************
38  * FreeBSD-4 or DragonFly
39  */
40 #define TWE_SUPPORTED_PLATFORM
41 
42 #include <sys/param.h>
43 #include <sys/cons.h>
44 #include <sys/systm.h>
45 #include <sys/malloc.h>
46 #include <sys/kernel.h>
47 #include <sys/sysctl.h>
48 #include <sys/bus.h>
49 #include <sys/conf.h>
50 #include <sys/disk.h>
51 #include <sys/stat.h>
52 #include <sys/rman.h>
53 #include <sys/devicestat.h>
54 #include <sys/thread2.h>
55 
56 #include <machine/md_var.h>
57 
58 #include <vm/vm.h>
59 #include <vm/pmap.h>
60 
61 #include <bus/pci/pcireg.h>
62 #include <bus/pci/pcivar.h>
63 
64 /*
65  * These macros allows us to build a version of the driver which can
66  * safely be loaded into a kernel which already contains a 'twe' driver,
67  * and which will override it in all things.
68  *
69  * All public symbols must be listed here.
70  */
71 #ifdef TWE_OVERRIDE
72 /* public symbols defined in twe.c */
73 #define twe_setup			Xtwe_setup
74 #define twe_init			Xtwe_init
75 #define twe_deinit			Xtwe_deinit
76 #define twe_intr			Xtwe_intr
77 #define twe_startio			Xtwe_startio
78 #define twe_dump_blocks			Xtwe_dump_blocks
79 #define twe_ioctl			Xtwe_ioctl
80 #define twe_enable_interrupts		Xtwe_enable_interrupts
81 #define twe_disable_interrupts		Xtwe_disable_interrupts
82 #define twe_describe_controller		Xtwe_describe_controller
83 #define twe_describe_code		Xtwe_describe_code
84 #define twe_print_controller		Xtwe_print_controller
85 
86 /* public symbols defined in twe_freebsd.c */
87 #define twe_attach_drive		Xtwe_attach_drive
88 #define twe_clear_pci_parity_error	Xtwe_clear_pci_parity_error
89 #define twe_clear_pci_abort		Xtwe_clear_pci_abort
90 #define twed_intr			Xtwed_intr
91 #define twe_allocate_request		Xtwe_allocate_request
92 #define twe_map_request			Xtwe_map_request
93 #define twe_unmap_request		Xtwe_unmap_request
94 
95 /* public symbols defined in twe_tables.h */
96 #define twe_table_status		Xtwe_table_status
97 #define twe_table_unitstate		Xtwe_table_unitstate
98 #define twe_table_unittype		Xtwe_table_unittype
99 #define twe_table_aen			Xtwe_table_aen
100 #define twe_table_opcode		Xtwe_table_opcode
101 
102 #define TWE_MALLOC_CLASS		M_XTWE
103 
104 #else /* TWE_OVERRIDE */
105 
106 #define TWE_MALLOC_CLASS		M_TWE
107 
108 #endif /* TWE_OVERRIDE */
109 
110 /*
111  * Wrappers for bus-space actions
112  */
113 #define TWE_CONTROL(sc, val)		bus_space_write_4(sc->twe_btag, sc->twe_bhandle, 0x0, (u_int32_t)val)
114 #define TWE_STATUS(sc)			(u_int32_t)bus_space_read_4(sc->twe_btag, sc->twe_bhandle, 0x4)
115 #define TWE_COMMAND_QUEUE(sc, val)	bus_space_write_4(sc->twe_btag, sc->twe_bhandle, 0x8, (u_int32_t)val)
116 #define TWE_RESPONSE_QUEUE(sc)		(TWE_Response_Queue)bus_space_read_4(sc->twe_btag, sc->twe_bhandle, 0xc)
117 
118 /*
119  * FreeBSD-specific softc elements
120  */
121 #define TWE_PLATFORM_SOFTC								\
122     device_t			twe_dev;		/* bus device */		\
123     cdev_t			twe_dev_t;		/* control device */		\
124     struct resource		*twe_io;		/* register interface window */	\
125     bus_space_handle_t		twe_bhandle;		/* bus space handle */		\
126     bus_space_tag_t		twe_btag;		/* bus space tag */		\
127     bus_dma_tag_t		twe_parent_dmat;	/* parent DMA tag */		\
128     bus_dma_tag_t		twe_buffer_dmat;	/* data buffer DMA tag */	\
129     struct resource		*twe_irq;		/* interrupt */			\
130     void			*twe_intr;		/* interrupt handle */		\
131     struct intr_config_hook	twe_ich;		/* delayed-startup hook */	\
132     struct sysctl_ctx_list	sysctl_ctx;						\
133     struct sysctl_oid		*sysctl_tree;
134 
135 /*
136  * FreeBSD-specific request elements
137  */
138 #define TWE_PLATFORM_REQUEST										\
139     bus_dmamap_t		tr_cmdmap;	/* DMA map for command */				\
140     u_int32_t			tr_cmdphys;	/* address of command in controller space */		\
141     bus_dmamap_t		tr_dmamap;	/* DMA map for data */					\
142     u_int32_t			tr_dataphys;	/* data buffer base address in controller space */
143 
144 /*
145  * Output identifying the controller/disk
146  */
147 #define twe_printf(sc, fmt, args...)	device_printf(sc->twe_dev, fmt , ##args)
148 #define twed_printf(twed, fmt, args...)	device_printf(twed->twed_dev, fmt , ##args)
149 
150 #if defined(__DragonFly__) || __FreeBSD_version < 500003
151 # include <machine/clock.h>
152 
153 #ifndef __DragonFly__
154 # define INTR_ENTROPY			0
155 #endif
156 
157 # include <sys/buf.h>			/* old buf style */
158 # include <sys/buf2.h>  		/* bufq stuff */
159 #define FREEBSD_4
160 typedef struct bio			twe_bio;
161 typedef struct bio_queue_head		twe_bioq;
162 #else
163 # include <sys/bio.h>
164 typedef struct bio			twe_bio;
165 typedef struct bio_queue_head		twe_bioq;
166 # define TWE_BIO_QINIT(bq)		bioq_init(&bq);
167 # define TWE_BIO_QINSERT(bq, bp)	bioqdisksort(&bq, bp)
168 # define TWE_BIO_QFIRST(bq)		bioq_first(&bq)
169 # define TWE_BIO_QREMOVE(bq, bp)	bioq_remove(&bq, bp)
170 # define TWE_BIO_IS_READ(bp)		((bp)->bio_cmd == BIO_READ)
171 # define TWE_BIO_DATA(bp)		(bp)->bio_data
172 # define TWE_BIO_LENGTH(bp)		(bp)->bio_bcount
173 # define TWE_BIO_LBA(bp)		(bp)->bio_pblkno
174 # define TWE_BIO_SOFTC(bp)		(bp)->bio_dev->si_drv1
175 # define TWE_BIO_UNIT(bp)		((struct twed_softc *)(TWE_BIO_SOFTC(bp)))->twed_drive->td_twe_unit
176 # define TWE_BIO_SET_ERROR(bp, err)	do { (bp)->bio_error = err; (bp)->bio_flags |= BIO_ERROR;} while(0)
177 # define TWE_BIO_HAS_ERROR(bp)		((bp)->bio_flags & BIO_ERROR)
178 # define TWE_BIO_RESID(bp)		(bp)->bio_resid
179 # define TWE_BIO_DONE(bp)		biodone(bp)
180 # define TWE_BIO_STATS_START(bp)	devstat_start_transaction(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats)
181 # define TWE_BIO_STATS_END(bp)		devstat_end_transaction_bio(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats, bp)
182 #endif
183 
184 #endif /* FreeBSD or DragonFly */
185 
186 #ifndef TWE_SUPPORTED_PLATFORM
187 #error platform not supported
188 #endif
189