2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2003 Paul Saab
4 * Copyright (c) 2003 Vinod Kashyap
5 * Copyright (c) 2000 BSDi
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
29 * $FreeBSD: src/sys/dev/twe/twevar.h,v 1.1.2.8 2004/06/11 18:57:32 vkashyap Exp $
30 * $DragonFly: src/sys/dev/raid/twe/twevar.h,v 1.10 2007/05/15 22:44:11 dillon Exp $
33 #define TWE_DRIVER_VERSION_STRING "1.40.01.002"
34 #define TWE_CDEV_MAJOR 146
35 #define TWED_CDEV_MAJOR 147
39 #define debug(level, fmt, args...) \
41 if (level <= TWE_DEBUG) kprintf("%s: " fmt "\n", __func__ , ##args); \
43 #define debug_called(level) \
45 if (level <= TWE_DEBUG) kprintf("%s: called\n", __func__); \
48 #define debug(level, fmt, args...)
49 #define debug_called(level)
53 * Structure describing a logical unit as attached to the controller
62 int td_sys_unit; /* Unit #, as seen by the system
63 (the 0 in twed0, the 1 in twed1 etc.) */
64 int td_twe_unit; /* Unit #, as seen by us, and our ctlr
65 (index into sc->twe_drive[]) */
67 /* unit state and type */
71 /* handle for attached driver */
82 struct twe_softc *twed_controller; /* parent device softc */
83 struct twe_drive *twed_drive; /* drive data in parent softc */
84 struct disk twed_disk; /* generic disk handle */
85 struct devstat twed_stats; /* accounting */
87 #define TWED_OPEN (1<<0) /* drive is open (can't shut down) */
91 * Per-command control structure.
93 * Note that due to alignment constraints on the tc_command field, this *must* be 64-byte aligned.
94 * We achieve this by placing the command at the beginning of the structure, and using malloc()
95 * to allocate each structure.
99 /* controller command */
100 TWE_Command tr_command; /* command as submitted to controller */
102 /* command payload */
103 void *tr_data; /* data buffer */
104 void *tr_realdata; /* copy of real data buffer pointer for alignment fixup */
107 TAILQ_ENTRY(twe_request) tr_link; /* list linkage */
108 struct twe_softc *tr_sc; /* controller that owns us */
109 int tr_status; /* command status */
110 #define TWE_CMD_SETUP 0 /* being assembled */
111 #define TWE_CMD_BUSY 1 /* submitted to controller */
112 #define TWE_CMD_COMPLETE 2 /* completed by controller (maybe with error) */
113 #define TWE_CMD_ERROR 3 /* encountered error, even before submission to controller */
115 #define TWE_CMD_DATAIN (1<<0)
116 #define TWE_CMD_DATAOUT (1<<1)
117 #define TWE_CMD_ALIGNBUF (1<<2) /* data in bio is misaligned, have to copy to/from private buffer */
118 #define TWE_CMD_SLEEPER (1<<3) /* owner is sleeping on this command */
119 #define TWE_CMD_MAPPED (1<<4) /* cmd has been mapped */
120 #define TWE_CMD_IN_PROGRESS (1<<5) /* bus_dmamap_load returned EINPROGRESS */
121 void (* tr_complete)(struct twe_request *tr); /* completion handler */
122 void *tr_private; /* submitter-private data or wait channel */
124 TWE_PLATFORM_REQUEST /* platform-specific request elements */
128 * Per-controller state.
132 /* controller queues and arrays */
133 TAILQ_HEAD(, twe_request) twe_free; /* command structures available for reuse */
134 twe_bioq twe_bioq; /* outstanding I/O operations */
135 TAILQ_HEAD(, twe_request) twe_ready; /* requests ready for the controller */
136 TAILQ_HEAD(, twe_request) twe_busy; /* requests busy in the controller */
137 TAILQ_HEAD(, twe_request) twe_complete; /* active commands (busy or waiting for completion) */
138 struct twe_request *twe_lookup[TWE_Q_LENGTH]; /* commands indexed by request ID */
139 struct twe_drive twe_drive[TWE_MAX_UNITS]; /* attached drives */
141 /* asynchronous event handling */
142 u_int16_t twe_aen_queue[TWE_Q_LENGTH]; /* AENs queued for userland tool(s) */
143 int twe_aen_head, twe_aen_tail; /* ringbuffer pointers for AEN queue */
144 int twe_wait_aen; /* wait-for-aen notification */
146 /* controller status */
148 #define TWE_STATE_INTEN (1<<0) /* interrupts have been enabled */
149 #define TWE_STATE_SHUTDOWN (1<<1) /* controller is shut down */
150 #define TWE_STATE_OPEN (1<<2) /* control device is open */
151 #define TWE_STATE_SUSPEND (1<<3) /* controller is suspended */
152 #define TWE_STATE_FRZN (1<<4) /* got EINPROGRESS */
153 #define TWE_STATE_CTLR_BUSY (1<<5) /* controller cmd queue full */
155 struct twe_qstat twe_qstat[TWEQ_COUNT]; /* queue statistics */
157 TWE_PLATFORM_SOFTC /* platform-specific softc elements */
161 * Interface betwen driver core and platform-dependant code.
163 extern int twe_setup(struct twe_softc *sc); /* do early driver/controller setup */
164 extern void twe_init(struct twe_softc *sc); /* init controller */
165 extern void twe_deinit(struct twe_softc *sc); /* stop controller */
166 extern void twe_intr(struct twe_softc *sc); /* hardware interrupt signalled */
167 extern void twe_startio(struct twe_softc *sc);
168 extern int twe_start(struct twe_request *tr);
169 extern int twe_dump_blocks(struct twe_softc *sc, int unit, /* crashdump block write */
170 u_int64_t lba, void *data, int nblks);
171 extern int twe_ioctl(struct twe_softc *sc, int cmd,
172 void *addr); /* handle user request */
173 extern void twe_describe_controller(struct twe_softc *sc); /* print controller info */
174 extern char *twe_describe_code(struct twe_code_lookup *table, u_int32_t code);
175 extern void twe_print_controller(struct twe_softc *sc);
176 extern void twe_enable_interrupts(struct twe_softc *sc); /* enable controller interrupts */
177 extern void twe_disable_interrupts(struct twe_softc *sc); /* disable controller interrupts */
179 extern int twe_attach_drive(struct twe_softc *sc,
180 struct twe_drive *dr); /* attach drive when found in twe_init */
181 extern int twe_detach_drive(struct twe_softc *sc,
182 int unit); /* detach drive */
183 extern void twe_clear_pci_parity_error(struct twe_softc *sc);
184 extern void twe_clear_pci_abort(struct twe_softc *sc);
185 extern void twed_intr(twe_bio *bp); /* return bio from core */
186 extern struct twe_request *twe_allocate_request(struct twe_softc *sc);/* allocate request structure */
187 extern int twe_map_request(struct twe_request *tr); /* make request visible to controller, do s/g */
188 extern void twe_unmap_request(struct twe_request *tr); /* cleanup after transfer, unmap */
190 /********************************************************************************
193 #define TWEQ_ADD(sc, qname) \
195 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \
198 if (qs->q_length > qs->q_max) \
199 qs->q_max = qs->q_length; \
202 #define TWEQ_REMOVE(sc, qname) \
204 struct twe_qstat *qs = &(sc)->twe_qstat[qname]; \
207 if (qs->q_length < qs->q_min) \
208 qs->q_min = qs->q_length; \
211 #define TWEQ_INIT(sc, qname) \
213 sc->twe_qstat[qname].q_length = 0; \
214 sc->twe_qstat[qname].q_max = 0; \
215 sc->twe_qstat[qname].q_min = 0xFFFFFFFF; \
219 #define TWEQ_REQUEST_QUEUE(name, index) \
220 static __inline void \
221 twe_initq_ ## name (struct twe_softc *sc) \
223 TAILQ_INIT(&sc->twe_ ## name); \
224 TWEQ_INIT(sc, index); \
226 static __inline void \
227 twe_enqueue_ ## name (struct twe_request *tr) \
230 TAILQ_INSERT_TAIL(&tr->tr_sc->twe_ ## name, tr, tr_link); \
231 TWEQ_ADD(tr->tr_sc, index); \
234 static __inline void \
235 twe_requeue_ ## name (struct twe_request *tr) \
238 TAILQ_INSERT_HEAD(&tr->tr_sc->twe_ ## name, tr, tr_link); \
239 TWEQ_ADD(tr->tr_sc, index); \
242 static __inline struct twe_request * \
243 twe_dequeue_ ## name (struct twe_softc *sc) \
245 struct twe_request *tr; \
248 if ((tr = TAILQ_FIRST(&sc->twe_ ## name)) != NULL) { \
249 TAILQ_REMOVE(&sc->twe_ ## name, tr, tr_link); \
250 TWEQ_REMOVE(sc, index); \
255 static __inline void \
256 twe_remove_ ## name (struct twe_request *tr) \
259 TAILQ_REMOVE(&tr->tr_sc->twe_ ## name, tr, tr_link); \
260 TWEQ_REMOVE(tr->tr_sc, index); \
264 TWEQ_REQUEST_QUEUE(free, TWEQ_FREE)
265 TWEQ_REQUEST_QUEUE(ready, TWEQ_READY)
266 TWEQ_REQUEST_QUEUE(busy, TWEQ_BUSY)
267 TWEQ_REQUEST_QUEUE(complete, TWEQ_COMPLETE)
271 * outstanding bio queue
274 twe_initq_bio(struct twe_softc *sc)
276 bioq_init(&sc->twe_bioq);
277 TWEQ_INIT(sc, TWEQ_BIO);
281 twe_enqueue_bio(struct twe_softc *sc, struct bio *bio)
284 bioq_insert_tail(&sc->twe_bioq, bio);
285 TWEQ_ADD(sc, TWEQ_BIO);
291 twe_dequeue_bio(struct twe_softc *sc)
296 if ((bio = bioq_first(&sc->twe_bioq)) != NULL) {
297 bioq_remove(&sc->twe_bioq, bio);
298 TWEQ_REMOVE(sc, TWEQ_BIO);