xref: /netbsd-src/sys/dev/ata/atavar.h (revision f3cfa6f6ce31685c6c4a758bc430e69eb99f50a4)
1 /*	$NetBSD: atavar.h,v 1.103 2019/04/05 21:31:44 bouyer Exp $	*/
2 
3 /*
4  * Copyright (c) 1998, 2001 Manuel Bouyer.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _DEV_ATA_ATAVAR_H_
28 #define	_DEV_ATA_ATAVAR_H_
29 
30 #include <sys/lock.h>
31 #include <sys/queue.h>
32 
33 #include <dev/ata/ataconf.h>
34 
35 /* XXX For scsipi_adapter and scsipi_channel. */
36 #include <dev/scsipi/scsipi_all.h>
37 #include <dev/scsipi/atapiconf.h>
38 
39 /*
40  * Parameters/state needed by the controller to perform an ATA bio.
41  */
42 struct ata_bio {
43 	volatile uint16_t flags;/* cmd flags */
44 /* 			0x0001	free, was ATA_NOSLEEP */
45 #define	ATA_POLL	0x0002	/* poll for completion */
46 #define	ATA_ITSDONE	0x0004	/* the transfer is as done as it gets */
47 #define	ATA_SINGLE	0x0008	/* transfer must be done in singlesector mode */
48 #define	ATA_LBA		0x0010	/* transfer uses LBA addressing */
49 #define	ATA_READ	0x0020	/* transfer is a read (otherwise a write) */
50 #define	ATA_CORR	0x0040	/* transfer had a corrected error */
51 #define	ATA_LBA48	0x0080	/* transfer uses 48-bit LBA addressing */
52 #define	ATA_FUA		0x0100	/* transfer uses FUA */
53 #define	ATA_PRIO_HIGH	0x0200	/* transfer has high priority */
54 	daddr_t		blkno;	/* block addr */
55 	daddr_t		blkdone;/* number of blks transferred */
56 	daddr_t		nblks;	/* number of block currently transferring */
57 	int		nbytes;	/* number of bytes currently transferring */
58 	long		bcount;	/* total number of bytes */
59 	char		*databuf;/* data buffer address */
60 	volatile int	error;
61 #define	NOERROR 	0	/* There was no error (r_error invalid) */
62 #define	ERROR		1	/* check r_error */
63 #define	ERR_DF		2	/* Drive fault */
64 #define	ERR_DMA		3	/* DMA error */
65 #define	TIMEOUT		4	/* device timed out */
66 #define	ERR_NODEV	5	/* device has been gone */
67 #define ERR_RESET	6	/* command was terminated by channel reset */
68 #define REQUEUE		7	/* different xfer failed, requeue command */
69 	uint8_t		r_error;/* copy of error register */
70 	struct buf	*bp;
71 };
72 
73 /*
74  * ATA/ATAPI commands description
75  *
76  * This structure defines the interface between the ATA/ATAPI device driver
77  * and the controller for short commands. It contains the command's parameter,
78  * the length of data to read/write (if any), and a function to call upon
79  * completion.
80  * If no sleep is allowed, the driver can poll for command completion.
81  * Once the command completed, if the error registered is valid, the flag
82  * AT_ERROR is set and the error register value is copied to r_error .
83  * A separate interface is needed for read/write or ATAPI packet commands
84  * (which need multiple interrupts per commands).
85  */
86 struct ata_command {
87 	/* ATA parameters */
88 	uint64_t r_lba;		/* before & after */
89 	uint16_t r_count;	/* before & after */
90 	union {
91 		uint16_t r_features; /* before */
92 		uint8_t r_error; /* after */
93 	};
94 	union {
95 		uint8_t r_command; /* before */
96 		uint8_t r_status; /* after */
97 	};
98 	uint8_t r_device;	/* before & after */
99 
100 	uint8_t r_st_bmask;	/* status register mask to wait for before
101 				   command */
102 	uint8_t r_st_pmask;	/* status register mask to wait for after
103 				   command */
104 	volatile uint16_t flags;
105 
106 #define AT_READ     	0x0001 /* There is data to read */
107 #define AT_WRITE    	0x0002 /* There is data to write (excl. with AT_READ) */
108 #define AT_WAIT     	0x0008 /* wait in controller for command completion */
109 #define AT_POLL     	0x0010 /* poll for command completion (no interrupts) */
110 #define AT_DONE     	0x0020 /* command is done */
111 #define AT_XFDONE   	0x0040 /* data xfer is done */
112 #define AT_ERROR    	0x0080 /* command is done with error */
113 #define AT_TIMEOU   	0x0100 /* command timed out */
114 #define AT_DF       	0x0200 /* Drive fault */
115 #define AT_RESET    	0x0400 /* command terminated by channel reset */
116 #define AT_GONE     	0x0800 /* command terminated because device is gone */
117 #define AT_READREG  	0x1000 /* Read registers on completion */
118 #define AT_LBA      	0x2000 /* LBA28 */
119 #define AT_LBA48   	0x4000 /* LBA48 */
120 
121 	int timeout;		/* timeout (in ms) */
122 	void *data;		/* Data buffer address */
123 	int bcount;		/* number of bytes to transfer */
124 };
125 
126 /* Forward declaration for ata_xfer */
127 struct scsipi_xfer;
128 struct ata_xfer_ops;
129 
130 /*
131  * Description of a command to be handled by an ATA controller.  These
132  * commands are queued in a list.
133  */
134 struct ata_xfer {
135 	int8_t c_slot;			/* queue slot # */
136 
137 	/* Channel and drive that are to process the request. */
138 	struct ata_channel *c_chp;
139 	uint16_t	c_drive;
140 	uint16_t	c_retries;	/* number of xfer retry */
141 
142 	volatile u_int c_flags;		/* command state flags */
143 	void	*c_databuf;		/* pointer to data buffer */
144 	int	c_bcount;		/* byte count left */
145 	int	c_skip;			/* bytes already transferred */
146 #define ATACH_ERR_ST(error, status)	((error) << 8 | (status))
147 #define ATACH_ERR(val)			(((val) >> 8) & 0xff)
148 #define ATACH_ST(val)			(((val) >> 0) & 0xff)
149 
150 	union {
151 		struct ata_bio	c_bio;		/* ATA transfer */
152 		struct ata_command c_ata_c;	/* ATA command */
153 		struct {
154 			struct scsipi_xfer *c_scsipi;	/* SCSI transfer */
155 			int	c_dscpoll; /* counter for dsc polling (ATAPI) */
156 			int	c_lenoff;  /* offset to c_bcount (ATAPI) */
157 		} atapi;
158 	} u;
159 #define c_bio	u.c_bio
160 #define c_ata_c	u.c_ata_c
161 #define c_atapi u.atapi
162 #define c_scsipi c_atapi.c_scsipi
163 
164 	/* Link on the command queue. */
165 	SIMPLEQ_ENTRY(ata_xfer) c_xferchain;
166 	TAILQ_ENTRY(ata_xfer) c_activechain;
167 
168 	/* Links for error handling */
169 	SLIST_ENTRY(ata_xfer) c_retrychain;
170 
171 	/* Low-level protocol handlers. */
172 	const struct ata_xfer_ops *ops;
173 };
174 
175 struct ata_xfer_ops {
176 	int	(*c_start)(struct ata_channel *, struct ata_xfer *);
177 #define ATASTART_STARTED	0	/* xfer started, waiting for intr */
178 #define ATASTART_TH		1	/* xfer needs to be run in thread */
179 #define ATASTART_POLL		2	/* xfer needs to be polled */
180 #define ATASTART_ABORT		3	/* error occurred, abort xfer */
181 	void	(*c_poll)(struct ata_channel *, struct ata_xfer *);
182 	void	(*c_abort)(struct ata_channel *, struct ata_xfer *);
183 	int	(*c_intr)(struct ata_channel *, struct ata_xfer *, int);
184 	void	(*c_kill_xfer)(struct ata_channel *, struct ata_xfer *, int);
185 };
186 
187 /* flags in c_flags */
188 #define	C_ATAPI		0x0001		/* xfer is ATAPI request */
189 #define	C_TIMEOU	0x0002		/* xfer processing timed out */
190 #define	C_POLL		0x0004		/* command is polled */
191 #define	C_DMA		0x0008		/* command uses DMA */
192 #define C_WAIT		0x0010		/* can use kpause */
193 #define C_WAITACT	0x0020		/* wakeup when active */
194 #define C_FREE		0x0040		/* call ata_free_xfer() asap */
195 #define C_PIOBM		0x0080		/* command uses busmastering PIO */
196 #define	C_NCQ		0x0100		/* command is queued  */
197 #define C_SKIP_QUEUE	0x0200		/* skip xfer queue */
198 #define C_WAITTIMO	0x0400		/* race vs. timeout */
199 #define C_CHAOS		0x0800		/* forced error xfer */
200 #define C_RECOVERED	0x1000		/* error recovered, no need for reset */
201 #define C_PRIVATE_ALLOC	0x2000		/* private alloc, skip pool_put() */
202 
203 /* reasons for c_kill_xfer() */
204 #define KILL_GONE 1		/* device is gone while xfer was active */
205 #define KILL_RESET 2		/* xfer was reset */
206 #define KILL_GONE_INACTIVE 3	/* device is gone while xfer was pending */
207 #define KILL_REQUEUE	4	/* xfer must be reissued to device, no err */
208 
209 /*
210  * While hw supports up to 32 tags, in practice we must never
211  * allow 32 active commands, since that would signal same as
212  * channel error. We use slot 32 only for error recovery if available.
213  */
214 #define ATA_MAX_OPENINGS	32
215 #define ATA_REAL_OPENINGS(op)	((op) > 1 ? (op) - 1 : 1)
216 
217 #define ATA_BSIZE		512	/* Standard ATA block size (bytes) */
218 
219 /* Per-channel queue of ata_xfers */
220 #ifndef ATABUS_PRIVATE
221 struct ata_queue;
222 #else
223 struct ata_queue {
224 	int8_t queue_flags;		/* flags for this queue */
225 #define QF_IDLE_WAIT	0x01    	/* someone wants the controller idle */
226 #define QF_NEED_XFER	0x02    	/* someone wants xfer */
227 	int8_t queue_active; 		/* number of active transfers */
228 	uint8_t queue_openings;			/* max number of active xfers */
229 	SIMPLEQ_HEAD(, ata_xfer) queue_xfer; 	/* queue of pending commands */
230 	int queue_freeze; 			/* freeze count for the queue */
231 	kcondvar_t queue_drain;			/* c: waiting of queue drain */
232 	kcondvar_t queue_idle;			/* c: waiting of queue idle */
233 	TAILQ_HEAD(, ata_xfer) active_xfers; 	/* active commands */
234 	uint32_t active_xfers_used;		/* mask of active commands */
235 	uint32_t queue_xfers_avail;		/* available xfers mask */
236 	uint32_t queue_hold;			/* slots held during recovery */
237 	kcondvar_t c_active;		/* somebody actively waiting for xfer */
238 	kcondvar_t c_cmd_finish;	/* somebody waiting for cmd finish */
239 };
240 #endif
241 
242 /* ATA bus instance state information. */
243 struct atabus_softc {
244 	device_t sc_dev;
245 	struct ata_channel *sc_chan;
246 	int sc_flags;
247 #define ATABUSCF_OPEN	0x01
248 };
249 
250 /*
251  * A queue of atabus instances, used to ensure the same bus probe order
252  * for a given hardware configuration at each boot.
253  */
254 struct atabus_initq {
255 	TAILQ_ENTRY(atabus_initq) atabus_initq;
256 	struct atabus_softc *atabus_sc;
257 };
258 
259 /* High-level functions and structures used by both ATA and ATAPI devices */
260 struct ataparams;
261 
262 /* Datas common to drives and controller drivers */
263 struct ata_drive_datas {
264 	uint8_t drive;		/* drive number */
265 	int8_t ata_vers;	/* ATA version supported */
266 	uint16_t drive_flags;	/* bitmask for drives present/absent and cap */
267 #define	ATA_DRIVE_CAP32		0x0001	/* 32-bit transfer capable */
268 #define	ATA_DRIVE_DMA		0x0002
269 #define	ATA_DRIVE_UDMA		0x0004
270 #define	ATA_DRIVE_MODE		0x0008	/* the drive reported its mode */
271 #define	ATA_DRIVE_RESET		0x0010	/* reset the drive state at next xfer */
272 #define	ATA_DRIVE_WAITDRAIN	0x0020	/* device is waiting for the queue to drain */
273 #define	ATA_DRIVE_NOSTREAM	0x0040	/* no stream methods on this drive */
274 #define ATA_DRIVE_ATAPIDSCW	0x0080	/* needs to wait for DSC in phase_complete */
275 #define ATA_DRIVE_WFUA		0x0100	/* drive supports WRITE DMA FUA EXT */
276 #define ATA_DRIVE_NCQ		0x0200	/* drive supports NCQ feature set */
277 #define ATA_DRIVE_NCQ_PRIO	0x0400	/* drive supports NCQ PRIO field */
278 #define ATA_DRIVE_TH_RESET	0x0800	/* drive waits for thread drive reset */
279 
280 	uint8_t drive_type;
281 #define	ATA_DRIVET_NONE		0
282 #define	ATA_DRIVET_ATA		1
283 #define	ATA_DRIVET_ATAPI	2
284 #define	ATA_DRIVET_OLD		3
285 #define	ATA_DRIVET_PM		4
286 
287 	/*
288 	 * Current setting of drive's PIO, DMA and UDMA modes.
289 	 * Is initialised by the disks drivers at attach time, and may be
290 	 * changed later by the controller's code if needed
291 	 */
292 	uint8_t PIO_mode;	/* Current setting of drive's PIO mode */
293 #if NATA_DMA
294 	uint8_t DMA_mode;	/* Current setting of drive's DMA mode */
295 #if NATA_UDMA
296 	uint8_t UDMA_mode;	/* Current setting of drive's UDMA mode */
297 #endif
298 #endif
299 
300 	/* Supported modes for this drive */
301 	uint8_t PIO_cap;	/* supported drive's PIO mode */
302 #if NATA_DMA
303 	uint8_t DMA_cap;	/* supported drive's DMA mode */
304 #if NATA_UDMA
305 	uint8_t UDMA_cap;	/* supported drive's UDMA mode */
306 #endif
307 #endif
308 
309 	/*
310 	 * Drive state.
311 	 * This is reset to 0 after a channel reset.
312 	 */
313 	uint8_t state;
314 
315 #define RESET          0
316 #define READY          1
317 
318 	uint8_t drv_openings;		/* # of command tags */
319 
320 #if NATA_DMA
321 	/* numbers of xfers and DMA errs. Used by ata_dmaerr() */
322 	uint8_t n_dmaerrs;
323 	uint32_t n_xfers;
324 
325 	/* Downgrade after NERRS_MAX errors in at most NXFER xfers */
326 #define NERRS_MAX 4
327 #define NXFER 4000
328 #endif
329 
330 	/* Callbacks into the drive's driver. */
331 	void	(*drv_done)(device_t, struct ata_xfer *); /* xfer is done */
332 
333 	device_t drv_softc;		/* ATA drives softc, if any */
334 	struct ata_channel *chnl_softc;	/* channel softc */
335 
336 	/* Context used for I/O */
337 	struct disklabel *lp;	/* pointer to drive's label info */
338 	uint8_t		multi;	/* # of blocks to transfer in multi-mode */
339 	daddr_t	badsect[127];	/* 126 plus trailing -1 marker */
340 };
341 
342 /* User config flags that force (or disable) the use of a mode */
343 #define ATA_CONFIG_PIO_MODES	0x0007
344 #define ATA_CONFIG_PIO_SET	0x0008
345 #define ATA_CONFIG_PIO_OFF	0
346 #define ATA_CONFIG_DMA_MODES	0x0070
347 #define ATA_CONFIG_DMA_SET	0x0080
348 #define ATA_CONFIG_DMA_DISABLE	0x0070
349 #define ATA_CONFIG_DMA_OFF	4
350 #define ATA_CONFIG_UDMA_MODES	0x0700
351 #define ATA_CONFIG_UDMA_SET	0x0800
352 #define ATA_CONFIG_UDMA_DISABLE	0x0700
353 #define ATA_CONFIG_UDMA_OFF	8
354 
355 /*
356  * ata_bustype.  The first field must be compatible with scsipi_bustype,
357  * as it's used for autoconfig by both ata and atapi drivers.
358  */
359 struct ata_bustype {
360 	int	bustype_type;	/* symbolic name of type */
361 	int	(*ata_bio)(struct ata_drive_datas *, struct ata_xfer *);
362 	void	(*ata_reset_drive)(struct ata_drive_datas *, int, uint32_t *);
363 	void	(*ata_reset_channel)(struct ata_channel *, int);
364 	int	(*ata_exec_command)(struct ata_drive_datas *,
365 				    struct ata_xfer *);
366 
367 #define	ATACMD_COMPLETE		0x01
368 #define	ATACMD_QUEUED		0x02
369 #define	ATACMD_TRY_AGAIN	0x03
370 
371 	int	(*ata_get_params)(struct ata_drive_datas *, uint8_t,
372 				  struct ataparams *);
373 	int	(*ata_addref)(struct ata_drive_datas *);
374 	void	(*ata_delref)(struct ata_drive_datas *);
375 	void	(*ata_killpending)(struct ata_drive_datas *);
376 	void	(*ata_recovery)(struct ata_channel *, int, uint32_t);
377 };
378 
379 /* bustype_type */	/* XXX XXX XXX */
380 /* #define SCSIPI_BUSTYPE_SCSI	0 */
381 /* #define SCSIPI_BUSTYPE_ATAPI	1 */
382 #define	SCSIPI_BUSTYPE_ATA	2
383 
384 /*
385  * Describe an ATA device.  Has to be compatible with scsipi_channel, so
386  * start with a pointer to ata_bustype.
387  */
388 struct ata_device {
389 	const struct ata_bustype *adev_bustype;
390 	int adev_channel;
391 	struct ata_drive_datas *adev_drv_data;
392 };
393 
394 /*
395  * Per-channel data
396  */
397 struct ata_channel {
398 	int ch_channel;			/* location */
399 	struct atac_softc *ch_atac;	/* ATA controller softc */
400 	kmutex_t ch_lock;		/* channel lock - queue */
401 
402 	/* Our state */
403 	volatile int ch_flags;
404 #define ATACH_SHUTDOWN 0x02	/* channel is shutting down */
405 #define ATACH_IRQ_WAIT 0x10	/* controller is waiting for irq */
406 #define ATACH_DMA_WAIT 0x20	/* controller is waiting for DMA */
407 #define ATACH_PIOBM_WAIT 0x40	/* controller is waiting for busmastering PIO */
408 #define	ATACH_DISABLED 0x80	/* channel is disabled */
409 #define ATACH_TH_RUN   0x100	/* the kernel thread is working */
410 #define ATACH_TH_RESET 0x200	/* someone ask the thread to reset */
411 #define ATACH_TH_RESCAN 0x400	/* rescan requested */
412 #define ATACH_NCQ	0x800	/* channel executing NCQ commands */
413 #define ATACH_DMA_BEFORE_CMD	0x01000	/* start DMA first */
414 #define ATACH_TH_DRIVE_RESET	0x02000	/* asked thread to drive(s) reset */
415 #define ATACH_RECOVERING	0x04000	/* channel is recovering */
416 #define ATACH_TH_RECOVERY	0x08000	/* asked thread to run recovery */
417 #define ATACH_DETACHED		0x10000 /* channel was destroyed */
418 
419 #define ATACH_NODRIVE	0xff	/* no drive selected for reset */
420 
421 	/* for the timeout callout */
422 	struct callout c_timo_callout;	/* timeout callout handle */
423 
424 	/* per-drive info */
425 	int ch_ndrives; /* number of entries in ch_drive[] */
426 	struct ata_drive_datas *ch_drive; /* array of ata_drive_datas */
427 
428 	device_t atabus;	/* self */
429 
430 	/* ATAPI children */
431 	device_t atapibus;
432 	struct scsipi_channel ch_atapi_channel;
433 
434 	/*
435 	 * Channel queues.  May be the same for all channels, if hw
436 	 * channels are not independent.
437 	 */
438 	struct ata_queue *ch_queue;
439 
440 	/* The channel kernel thread */
441 	struct lwp *ch_thread;
442 	kcondvar_t ch_thr_idle;		/* thread waiting for work */
443 
444 	/* Number of sata PMP ports, if any */
445 	int ch_satapmp_nports;
446 
447 	/* Recovery buffer */
448 	struct ata_xfer recovery_xfer;
449 	uint8_t recovery_blk[ATA_BSIZE];
450 	uint32_t recovery_tfd;		/* status/err encoded ATACH_ERR_ST() */
451 };
452 
453 /*
454  * ATA controller softc.
455  *
456  * This contains a bunch of generic info that all ATA controllers need
457  * to have.
458  *
459  * XXX There is still some lingering wdc-centricity here.
460  */
461 struct atac_softc {
462 	device_t atac_dev;		/* generic device info */
463 
464 	int	atac_cap;		/* controller capabilities */
465 
466 #define	ATAC_CAP_DATA16	0x0001		/* can do 16-bit data access */
467 #define	ATAC_CAP_DATA32	0x0002		/* can do 32-bit data access */
468 #define	ATAC_CAP_DMA	0x0008		/* can do ATA DMA modes */
469 #define	ATAC_CAP_UDMA	0x0010		/* can do ATA Ultra DMA modes */
470 #define	ATAC_CAP_PIOBM	0x0020		/* can do busmastering PIO transfer */
471 #define	ATAC_CAP_ATA_NOSTREAM 0x0040	/* don't use stream funcs on ATA */
472 #define	ATAC_CAP_ATAPI_NOSTREAM 0x0080	/* don't use stream funcs on ATAPI */
473 #define	ATAC_CAP_NOIRQ	0x1000		/* controller never interrupts */
474 #define	ATAC_CAP_RAID	0x4000		/* controller "supports" RAID */
475 #define ATAC_CAP_NCQ	0x8000		/* controller supports NCQ */
476 
477 	uint8_t	atac_pio_cap;		/* highest PIO mode supported */
478 #if NATA_DMA
479 	uint8_t	atac_dma_cap;		/* highest DMA mode supported */
480 #if NATA_UDMA
481 	uint8_t	atac_udma_cap;		/* highest UDMA mode supported */
482 #endif
483 #endif
484 
485 	/* Array of pointers to channel-specific data. */
486 	struct ata_channel **atac_channels;
487 	int		     atac_nchannels;
488 
489 	const struct ata_bustype *atac_bustype_ata;
490 
491 	/*
492 	 * Glue between ATA and SCSIPI for the benefit of ATAPI.
493 	 *
494 	 * Note: The reference count here is used for both ATA and ATAPI
495 	 * devices.
496 	 */
497 	struct atapi_adapter atac_atapi_adapter;
498 	void (*atac_atapibus_attach)(struct atabus_softc *);
499 
500 	/* Driver callback to probe for drives. */
501 	void (*atac_probe)(struct ata_channel *);
502 
503 	/*
504 	 * Optional callbacks to lock/unlock hardware.
505 	 * Called with channel mutex held.
506 	 */
507 	int  (*atac_claim_hw)(struct ata_channel *, int);
508 	void (*atac_free_hw)(struct ata_channel *);
509 
510 	/*
511 	 * Optional callbacks to set drive mode.  Required for anything
512 	 * but basic PIO operation.
513 	 */
514 	void (*atac_set_modes)(struct ata_channel *);
515 };
516 
517 #ifdef _KERNEL
518 void	ata_channel_attach(struct ata_channel *);
519 void	ata_channel_init(struct ata_channel *);
520 void	ata_channel_detach(struct ata_channel *);
521 void	ata_channel_destroy(struct ata_channel *);
522 int	atabusprint(void *aux, const char *);
523 int	ataprint(void *aux, const char *);
524 
525 int	atabus_alloc_drives(struct ata_channel *, int);
526 void	atabus_free_drives(struct ata_channel *);
527 
528 struct ataparams;
529 int	ata_get_params(struct ata_drive_datas *, uint8_t, struct ataparams *);
530 int	ata_set_mode(struct ata_drive_datas *, uint8_t, uint8_t);
531 int	ata_read_log_ext_ncq(struct ata_drive_datas *, uint8_t, uint8_t *,
532     uint8_t *, uint8_t *);
533 void	ata_recovery_resume(struct ata_channel *, int, int, int);
534 
535 /* return code for these cmds */
536 #define CMD_OK    0
537 #define CMD_ERR   1
538 #define CMD_AGAIN 2
539 
540 struct ata_xfer *ata_get_xfer(struct ata_channel *, bool);
541 void	ata_free_xfer(struct ata_channel *, struct ata_xfer *);
542 void	ata_deactivate_xfer(struct ata_channel *, struct ata_xfer *);
543 void	ata_exec_xfer(struct ata_channel *, struct ata_xfer *);
544 int	ata_xfer_start(struct ata_xfer *xfer);
545 void	ata_wait_cmd(struct ata_channel *, struct ata_xfer *xfer);
546 
547 void	ata_timeout(void *);
548 bool	ata_timo_xfer_check(struct ata_xfer *);
549 void	ata_kill_pending(struct ata_drive_datas *);
550 void	ata_kill_active(struct ata_channel *, int, int);
551 void	ata_thread_run(struct ata_channel *, int, int, int);
552 void	ata_channel_freeze(struct ata_channel *);
553 void	ata_channel_thaw_locked(struct ata_channel *);
554 void	ata_channel_lock(struct ata_channel *);
555 void	ata_channel_unlock(struct ata_channel *);
556 void	ata_channel_lock_owned(struct ata_channel *);
557 
558 int	ata_addref(struct ata_channel *);
559 void	ata_delref(struct ata_channel *);
560 void	atastart(struct ata_channel *);
561 void	ata_print_modes(struct ata_channel *);
562 #if NATA_DMA
563 int	ata_downgrade_mode(struct ata_drive_datas *, int);
564 #endif
565 void	ata_probe_caps(struct ata_drive_datas *);
566 
567 #if NATA_DMA
568 void	ata_dmaerr(struct ata_drive_datas *, int);
569 #endif
570 struct ata_queue *
571 	ata_queue_alloc(uint8_t openings);
572 void	ata_queue_free(struct ata_queue *);
573 struct ata_xfer *
574 	ata_queue_hwslot_to_xfer(struct ata_channel *, int);
575 struct ata_xfer *
576 	ata_queue_get_active_xfer(struct ata_channel *);
577 struct ata_xfer *
578 	ata_queue_get_active_xfer_locked(struct ata_channel *);
579 struct ata_xfer *
580 	ata_queue_drive_active_xfer(struct ata_channel *, int);
581 bool	ata_queue_alloc_slot(struct ata_channel *, uint8_t *, uint8_t);
582 void	ata_queue_free_slot(struct ata_channel *, uint8_t);
583 uint32_t	ata_queue_active(struct ata_channel *);
584 uint8_t	ata_queue_openings(struct ata_channel *);
585 void	ata_queue_hold(struct ata_channel *);
586 void	ata_queue_unhold(struct ata_channel *);
587 
588 void	ata_delay(struct ata_channel *, int, const char *, int);
589 
590 bool	ata_waitdrain_xfer_check(struct ata_channel *, struct ata_xfer *);
591 
592 void	atacmd_toncq(struct ata_xfer *, uint8_t *, uint16_t *, uint16_t *,
593 	    uint8_t *);
594 
595 #ifdef ATADEBUG
596 void	atachannel_debug(struct ata_channel *);
597 #endif
598 
599 #endif /* _KERNEL */
600 
601 #endif /* _DEV_ATA_ATAVAR_H_ */
602