ata_da.c revision 274260
1/*-
2 * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer,
10 *    without modification, immediately at the beginning of the file.
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#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/10/sys/cam/ata/ata_da.c 274260 2014-11-08 00:47:16Z gnn $");
29
30#include "opt_ada.h"
31
32#include <sys/param.h>
33
34#ifdef _KERNEL
35#include <sys/systm.h>
36#include <sys/kernel.h>
37#include <sys/bio.h>
38#include <sys/sysctl.h>
39#include <sys/taskqueue.h>
40#include <sys/lock.h>
41#include <sys/mutex.h>
42#include <sys/conf.h>
43#include <sys/devicestat.h>
44#include <sys/eventhandler.h>
45#include <sys/malloc.h>
46#include <sys/cons.h>
47#include <sys/proc.h>
48#include <sys/reboot.h>
49#include <geom/geom_disk.h>
50#endif /* _KERNEL */
51
52#ifndef _KERNEL
53#include <stdio.h>
54#include <string.h>
55#endif /* _KERNEL */
56
57#include <cam/cam.h>
58#include <cam/cam_ccb.h>
59#include <cam/cam_periph.h>
60#include <cam/cam_xpt_periph.h>
61#include <cam/cam_sim.h>
62
63#include <cam/ata/ata_all.h>
64
65#include <machine/md_var.h>	/* geometry translation */
66
67#ifdef _KERNEL
68
69#define ATA_MAX_28BIT_LBA               268435455UL
70
71typedef enum {
72	ADA_STATE_RAHEAD,
73	ADA_STATE_WCACHE,
74	ADA_STATE_NORMAL
75} ada_state;
76
77typedef enum {
78	ADA_FLAG_CAN_48BIT	= 0x0002,
79	ADA_FLAG_CAN_FLUSHCACHE	= 0x0004,
80	ADA_FLAG_CAN_NCQ	= 0x0008,
81	ADA_FLAG_CAN_DMA	= 0x0010,
82	ADA_FLAG_NEED_OTAG	= 0x0020,
83	ADA_FLAG_WAS_OTAG	= 0x0040,
84	ADA_FLAG_CAN_TRIM	= 0x0080,
85	ADA_FLAG_OPEN		= 0x0100,
86	ADA_FLAG_SCTX_INIT	= 0x0200,
87	ADA_FLAG_CAN_CFA        = 0x0400,
88	ADA_FLAG_CAN_POWERMGT   = 0x0800,
89	ADA_FLAG_CAN_DMA48	= 0x1000,
90	ADA_FLAG_DIRTY		= 0x2000
91} ada_flags;
92
93typedef enum {
94	ADA_Q_NONE		= 0x00,
95	ADA_Q_4K		= 0x01,
96} ada_quirks;
97
98#define ADA_Q_BIT_STRING	\
99	"\020"			\
100	"\0014K"
101
102typedef enum {
103	ADA_CCB_RAHEAD		= 0x01,
104	ADA_CCB_WCACHE		= 0x02,
105	ADA_CCB_BUFFER_IO	= 0x03,
106	ADA_CCB_DUMP		= 0x05,
107	ADA_CCB_TRIM		= 0x06,
108	ADA_CCB_TYPE_MASK	= 0x0F,
109} ada_ccb_state;
110
111/* Offsets into our private area for storing information */
112#define ccb_state	ppriv_field0
113#define ccb_bp		ppriv_ptr1
114
115struct disk_params {
116	u_int8_t  heads;
117	u_int8_t  secs_per_track;
118	u_int32_t cylinders;
119	u_int32_t secsize;	/* Number of bytes/logical sector */
120	u_int64_t sectors;	/* Total number sectors */
121};
122
123#define TRIM_MAX_BLOCKS	8
124#define TRIM_MAX_RANGES	(TRIM_MAX_BLOCKS * ATA_DSM_BLK_RANGES)
125struct trim_request {
126	uint8_t		data[TRIM_MAX_RANGES * ATA_DSM_RANGE_SIZE];
127	TAILQ_HEAD(, bio) bps;
128};
129
130struct ada_softc {
131	struct	 bio_queue_head bio_queue;
132	struct	 bio_queue_head trim_queue;
133	int	 outstanding_cmds;	/* Number of active commands */
134	int	 refcount;		/* Active xpt_action() calls */
135	ada_state state;
136	ada_flags flags;
137	ada_quirks quirks;
138	int	 sort_io_queue;
139	int	 trim_max_ranges;
140	int	 trim_running;
141	int	 read_ahead;
142	int	 write_cache;
143#ifdef ADA_TEST_FAILURE
144	int      force_read_error;
145	int      force_write_error;
146	int      periodic_read_error;
147	int      periodic_read_count;
148#endif
149	struct	 disk_params params;
150	struct	 disk *disk;
151	struct task		sysctl_task;
152	struct sysctl_ctx_list	sysctl_ctx;
153	struct sysctl_oid	*sysctl_tree;
154	struct callout		sendordered_c;
155	struct trim_request	trim_req;
156};
157
158struct ada_quirk_entry {
159	struct scsi_inquiry_pattern inq_pat;
160	ada_quirks quirks;
161};
162
163static struct ada_quirk_entry ada_quirk_table[] =
164{
165	{
166		/* Hitachi Advanced Format (4k) drives */
167		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Hitachi H??????????E3*", "*" },
168		/*quirks*/ADA_Q_4K
169	},
170	{
171		/* Samsung Advanced Format (4k) drives */
172		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD155UI*", "*" },
173		/*quirks*/ADA_Q_4K
174	},
175	{
176		/* Samsung Advanced Format (4k) drives */
177		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG HD204UI*", "*" },
178		/*quirks*/ADA_Q_4K
179	},
180	{
181		/* Seagate Barracuda Green Advanced Format (4k) drives */
182		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DL*", "*" },
183		/*quirks*/ADA_Q_4K
184	},
185	{
186		/* Seagate Barracuda Advanced Format (4k) drives */
187		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???DM*", "*" },
188		/*quirks*/ADA_Q_4K
189	},
190	{
191		/* Seagate Barracuda Advanced Format (4k) drives */
192		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST????DM*", "*" },
193		/*quirks*/ADA_Q_4K
194	},
195	{
196		/* Seagate Momentus Advanced Format (4k) drives */
197		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500423AS*", "*" },
198		/*quirks*/ADA_Q_4K
199	},
200	{
201		/* Seagate Momentus Advanced Format (4k) drives */
202		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9500424AS*", "*" },
203		/*quirks*/ADA_Q_4K
204	},
205	{
206		/* Seagate Momentus Advanced Format (4k) drives */
207		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640423AS*", "*" },
208		/*quirks*/ADA_Q_4K
209	},
210	{
211		/* Seagate Momentus Advanced Format (4k) drives */
212		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9640424AS*", "*" },
213		/*quirks*/ADA_Q_4K
214	},
215	{
216		/* Seagate Momentus Advanced Format (4k) drives */
217		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750420AS*", "*" },
218		/*quirks*/ADA_Q_4K
219	},
220	{
221		/* Seagate Momentus Advanced Format (4k) drives */
222		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750422AS*", "*" },
223		/*quirks*/ADA_Q_4K
224	},
225	{
226		/* Seagate Momentus Advanced Format (4k) drives */
227		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST9750423AS*", "*" },
228		/*quirks*/ADA_Q_4K
229	},
230	{
231		/* Seagate Momentus Thin Advanced Format (4k) drives */
232		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "ST???LT*", "*" },
233		/*quirks*/ADA_Q_4K
234	},
235	{
236		/* WDC Caviar Green Advanced Format (4k) drives */
237		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RS*", "*" },
238		/*quirks*/ADA_Q_4K
239	},
240	{
241		/* WDC Caviar Green Advanced Format (4k) drives */
242		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD????RX*", "*" },
243		/*quirks*/ADA_Q_4K
244	},
245	{
246		/* WDC Caviar Green Advanced Format (4k) drives */
247		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RS*", "*" },
248		/*quirks*/ADA_Q_4K
249	},
250	{
251		/* WDC Caviar Green Advanced Format (4k) drives */
252		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD??????RX*", "*" },
253		/*quirks*/ADA_Q_4K
254	},
255	{
256		/* WDC Scorpio Black Advanced Format (4k) drives */
257		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PKT*", "*" },
258		/*quirks*/ADA_Q_4K
259	},
260	{
261		/* WDC Scorpio Black Advanced Format (4k) drives */
262		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PKT*", "*" },
263		/*quirks*/ADA_Q_4K
264	},
265	{
266		/* WDC Scorpio Blue Advanced Format (4k) drives */
267		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD???PVT*", "*" },
268		/*quirks*/ADA_Q_4K
269	},
270	{
271		/* WDC Scorpio Blue Advanced Format (4k) drives */
272		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "WDC WD?????PVT*", "*" },
273		/*quirks*/ADA_Q_4K
274	},
275	/* SSDs */
276	{
277		/*
278		 * Corsair Force 2 SSDs
279		 * 4k optimised & trim only works in 4k requests + 4k aligned
280		 */
281		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair CSSD-F*", "*" },
282		/*quirks*/ADA_Q_4K
283	},
284	{
285		/*
286		 * Corsair Force 3 SSDs
287		 * 4k optimised & trim only works in 4k requests + 4k aligned
288		 */
289		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force 3*", "*" },
290		/*quirks*/ADA_Q_4K
291	},
292	{
293		/*
294		 * Corsair Neutron GTX SSDs
295		 * 4k optimised & trim only works in 4k requests + 4k aligned
296		 */
297		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Neutron GTX*", "*" },
298		/*quirks*/ADA_Q_4K
299	},
300	{
301		/*
302		 * Corsair Force GT & GS SSDs
303		 * 4k optimised & trim only works in 4k requests + 4k aligned
304		 */
305		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Corsair Force G*", "*" },
306		/*quirks*/ADA_Q_4K
307	},
308	{
309		/*
310		 * Crucial M4 SSDs
311		 * 4k optimised & trim only works in 4k requests + 4k aligned
312		 */
313		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "M4-CT???M4SSD2*", "*" },
314		/*quirks*/ADA_Q_4K
315	},
316	{
317		/*
318		 * Crucial RealSSD C300 SSDs
319		 * 4k optimised
320		 */
321		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "C300-CTFDDAC???MAG*",
322		"*" }, /*quirks*/ADA_Q_4K
323	},
324	{
325		/*
326		 * Intel 320 Series SSDs
327		 * 4k optimised & trim only works in 4k requests + 4k aligned
328		 */
329		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSA2CW*", "*" },
330		/*quirks*/ADA_Q_4K
331	},
332	{
333		/*
334		 * Intel 330 Series SSDs
335		 * 4k optimised & trim only works in 4k requests + 4k aligned
336		 */
337		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2CT*", "*" },
338		/*quirks*/ADA_Q_4K
339	},
340	{
341		/*
342		 * Intel 510 Series SSDs
343		 * 4k optimised & trim only works in 4k requests + 4k aligned
344		 */
345		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2MH*", "*" },
346		/*quirks*/ADA_Q_4K
347	},
348	{
349		/*
350		 * Intel 520 Series SSDs
351		 * 4k optimised & trim only works in 4k requests + 4k aligned
352		 */
353		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSC2BW*", "*" },
354		/*quirks*/ADA_Q_4K
355	},
356	{
357		/*
358		 * Intel X25-M Series SSDs
359		 * 4k optimised & trim only works in 4k requests + 4k aligned
360		 */
361		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "INTEL SSDSA2M*", "*" },
362		/*quirks*/ADA_Q_4K
363	},
364	{
365		/*
366		 * Kingston E100 Series SSDs
367		 * 4k optimised & trim only works in 4k requests + 4k aligned
368		 */
369		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SE100S3*", "*" },
370		/*quirks*/ADA_Q_4K
371	},
372	{
373		/*
374		 * Kingston HyperX 3k SSDs
375		 * 4k optimised & trim only works in 4k requests + 4k aligned
376		 */
377		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "KINGSTON SH103S3*", "*" },
378		/*quirks*/ADA_Q_4K
379	},
380	{
381		/*
382		 * Marvell SSDs (entry taken from OpenSolaris)
383		 * 4k optimised & trim only works in 4k requests + 4k aligned
384		 */
385		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "MARVELL SD88SA02*", "*" },
386		/*quirks*/ADA_Q_4K
387	},
388	{
389		/*
390		 * OCZ Agility 2 SSDs
391		 * 4k optimised & trim only works in 4k requests + 4k aligned
392		 */
393		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-AGILITY2*", "*" },
394		/*quirks*/ADA_Q_4K
395	},
396	{
397		/*
398		 * OCZ Agility 3 SSDs
399		 * 4k optimised & trim only works in 4k requests + 4k aligned
400		 */
401		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-AGILITY3*", "*" },
402		/*quirks*/ADA_Q_4K
403	},
404	{
405		/*
406		 * OCZ Deneva R Series SSDs
407		 * 4k optimised & trim only works in 4k requests + 4k aligned
408		 */
409		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "DENRSTE251M45*", "*" },
410		/*quirks*/ADA_Q_4K
411	},
412	{
413		/*
414		 * OCZ Vertex 2 SSDs (inc pro series)
415		 * 4k optimised & trim only works in 4k requests + 4k aligned
416		 */
417		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ?VERTEX2*", "*" },
418		/*quirks*/ADA_Q_4K
419	},
420	{
421		/*
422		 * OCZ Vertex 3 SSDs
423		 * 4k optimised & trim only works in 4k requests + 4k aligned
424		 */
425		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX3*", "*" },
426		/*quirks*/ADA_Q_4K
427	},
428	{
429		/*
430		 * OCZ Vertex 4 SSDs
431		 * 4k optimised & trim only works in 4k requests + 4k aligned
432		 */
433		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "OCZ-VERTEX4*", "*" },
434		/*quirks*/ADA_Q_4K
435	},
436	{
437		/*
438		 * Samsung 830 Series SSDs
439		 * 4k optimised
440		 */
441		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG SSD 830 Series*", "*" },
442		/*quirks*/ADA_Q_4K
443	},
444	{
445		/*
446		 * Samsung 840 SSDs
447		 * 4k optimised
448		 */
449		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Samsung SSD 840*", "*" },
450		/*quirks*/ADA_Q_4K
451	},
452	{
453		/*
454		 * Samsung 843T Series SSDs
455		 * 4k optimised
456		 */
457		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG MZ7WD*", "*" },
458		/*quirks*/ADA_Q_4K
459	},
460 	{
461 		/*
462		 * Samsung 850 SSDs
463		 * 4k optimised
464		 */
465		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "Samsung SSD 850*", "*" },
466		/*quirks*/ADA_Q_4K
467	},
468	{
469		/*
470		 * Samsung PM853T Series SSDs
471		 * 4k optimised
472		 */
473		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SAMSUNG MZ7GE*", "*" },
474		/*quirks*/ADA_Q_4K
475	},
476	{
477		/*
478		 * SuperTalent TeraDrive CT SSDs
479		 * 4k optimised & trim only works in 4k requests + 4k aligned
480		 */
481		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "FTM??CT25H*", "*" },
482		/*quirks*/ADA_Q_4K
483	},
484	{
485		/*
486		 * XceedIOPS SATA SSDs
487		 * 4k optimised
488		 */
489		{ T_DIRECT, SIP_MEDIA_FIXED, "*", "SG9XCS2D*", "*" },
490		/*quirks*/ADA_Q_4K
491	},
492	{
493		/* Default */
494		{
495		  T_ANY, SIP_MEDIA_REMOVABLE|SIP_MEDIA_FIXED,
496		  /*vendor*/"*", /*product*/"*", /*revision*/"*"
497		},
498		/*quirks*/0
499	},
500};
501
502static	disk_strategy_t	adastrategy;
503static	dumper_t	adadump;
504static	periph_init_t	adainit;
505static	void		adaasync(void *callback_arg, u_int32_t code,
506				struct cam_path *path, void *arg);
507static	void		adasysctlinit(void *context, int pending);
508static	periph_ctor_t	adaregister;
509static	periph_dtor_t	adacleanup;
510static	periph_start_t	adastart;
511static	periph_oninv_t	adaoninvalidate;
512static	void		adadone(struct cam_periph *periph,
513			       union ccb *done_ccb);
514static  int		adaerror(union ccb *ccb, u_int32_t cam_flags,
515				u_int32_t sense_flags);
516static void		adagetparams(struct cam_periph *periph,
517				struct ccb_getdev *cgd);
518static timeout_t	adasendorderedtag;
519static void		adashutdown(void *arg, int howto);
520static void		adasuspend(void *arg);
521static void		adaresume(void *arg);
522
523#ifndef	ADA_DEFAULT_LEGACY_ALIASES
524#define	ADA_DEFAULT_LEGACY_ALIASES	1
525#endif
526
527#ifndef ADA_DEFAULT_TIMEOUT
528#define ADA_DEFAULT_TIMEOUT 30	/* Timeout in seconds */
529#endif
530
531#ifndef	ADA_DEFAULT_RETRY
532#define	ADA_DEFAULT_RETRY	4
533#endif
534
535#ifndef	ADA_DEFAULT_SEND_ORDERED
536#define	ADA_DEFAULT_SEND_ORDERED	1
537#endif
538
539#ifndef	ADA_DEFAULT_SPINDOWN_SHUTDOWN
540#define	ADA_DEFAULT_SPINDOWN_SHUTDOWN	1
541#endif
542
543#ifndef	ADA_DEFAULT_SPINDOWN_SUSPEND
544#define	ADA_DEFAULT_SPINDOWN_SUSPEND	1
545#endif
546
547#ifndef	ADA_DEFAULT_READ_AHEAD
548#define	ADA_DEFAULT_READ_AHEAD	1
549#endif
550
551#ifndef	ADA_DEFAULT_WRITE_CACHE
552#define	ADA_DEFAULT_WRITE_CACHE	1
553#endif
554
555#define	ADA_RA	(softc->read_ahead >= 0 ? \
556		 softc->read_ahead : ada_read_ahead)
557#define	ADA_WC	(softc->write_cache >= 0 ? \
558		 softc->write_cache : ada_write_cache)
559#define	ADA_SIO	(softc->sort_io_queue >= 0 ? \
560		 softc->sort_io_queue : cam_sort_io_queues)
561
562/*
563 * Most platforms map firmware geometry to actual, but some don't.  If
564 * not overridden, default to nothing.
565 */
566#ifndef ata_disk_firmware_geom_adjust
567#define	ata_disk_firmware_geom_adjust(disk)
568#endif
569
570static int ada_legacy_aliases = ADA_DEFAULT_LEGACY_ALIASES;
571static int ada_retry_count = ADA_DEFAULT_RETRY;
572static int ada_default_timeout = ADA_DEFAULT_TIMEOUT;
573static int ada_send_ordered = ADA_DEFAULT_SEND_ORDERED;
574static int ada_spindown_shutdown = ADA_DEFAULT_SPINDOWN_SHUTDOWN;
575static int ada_spindown_suspend = ADA_DEFAULT_SPINDOWN_SUSPEND;
576static int ada_read_ahead = ADA_DEFAULT_READ_AHEAD;
577static int ada_write_cache = ADA_DEFAULT_WRITE_CACHE;
578
579static SYSCTL_NODE(_kern_cam, OID_AUTO, ada, CTLFLAG_RD, 0,
580            "CAM Direct Access Disk driver");
581SYSCTL_INT(_kern_cam_ada, OID_AUTO, legacy_aliases, CTLFLAG_RW,
582           &ada_legacy_aliases, 0, "Create legacy-like device aliases");
583TUNABLE_INT("kern.cam.ada.legacy_aliases", &ada_legacy_aliases);
584SYSCTL_INT(_kern_cam_ada, OID_AUTO, retry_count, CTLFLAG_RW,
585           &ada_retry_count, 0, "Normal I/O retry count");
586TUNABLE_INT("kern.cam.ada.retry_count", &ada_retry_count);
587SYSCTL_INT(_kern_cam_ada, OID_AUTO, default_timeout, CTLFLAG_RW,
588           &ada_default_timeout, 0, "Normal I/O timeout (in seconds)");
589TUNABLE_INT("kern.cam.ada.default_timeout", &ada_default_timeout);
590SYSCTL_INT(_kern_cam_ada, OID_AUTO, send_ordered, CTLFLAG_RW,
591           &ada_send_ordered, 0, "Send Ordered Tags");
592TUNABLE_INT("kern.cam.ada.send_ordered", &ada_send_ordered);
593SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_shutdown, CTLFLAG_RW,
594           &ada_spindown_shutdown, 0, "Spin down upon shutdown");
595TUNABLE_INT("kern.cam.ada.spindown_shutdown", &ada_spindown_shutdown);
596SYSCTL_INT(_kern_cam_ada, OID_AUTO, spindown_suspend, CTLFLAG_RW,
597           &ada_spindown_suspend, 0, "Spin down upon suspend");
598TUNABLE_INT("kern.cam.ada.spindown_suspend", &ada_spindown_suspend);
599SYSCTL_INT(_kern_cam_ada, OID_AUTO, read_ahead, CTLFLAG_RW,
600           &ada_read_ahead, 0, "Enable disk read-ahead");
601TUNABLE_INT("kern.cam.ada.read_ahead", &ada_read_ahead);
602SYSCTL_INT(_kern_cam_ada, OID_AUTO, write_cache, CTLFLAG_RW,
603           &ada_write_cache, 0, "Enable disk write cache");
604TUNABLE_INT("kern.cam.ada.write_cache", &ada_write_cache);
605
606/*
607 * ADA_ORDEREDTAG_INTERVAL determines how often, relative
608 * to the default timeout, we check to see whether an ordered
609 * tagged transaction is appropriate to prevent simple tag
610 * starvation.  Since we'd like to ensure that there is at least
611 * 1/2 of the timeout length left for a starved transaction to
612 * complete after we've sent an ordered tag, we must poll at least
613 * four times in every timeout period.  This takes care of the worst
614 * case where a starved transaction starts during an interval that
615 * meets the requirement "don't send an ordered tag" test so it takes
616 * us two intervals to determine that a tag must be sent.
617 */
618#ifndef ADA_ORDEREDTAG_INTERVAL
619#define ADA_ORDEREDTAG_INTERVAL 4
620#endif
621
622static struct periph_driver adadriver =
623{
624	adainit, "ada",
625	TAILQ_HEAD_INITIALIZER(adadriver.units), /* generation */ 0
626};
627
628PERIPHDRIVER_DECLARE(ada, adadriver);
629
630static MALLOC_DEFINE(M_ATADA, "ata_da", "ata_da buffers");
631
632static int
633adaopen(struct disk *dp)
634{
635	struct cam_periph *periph;
636	struct ada_softc *softc;
637	int error;
638
639	periph = (struct cam_periph *)dp->d_drv1;
640	if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
641		return(ENXIO);
642	}
643
644	cam_periph_lock(periph);
645	if ((error = cam_periph_hold(periph, PRIBIO|PCATCH)) != 0) {
646		cam_periph_unlock(periph);
647		cam_periph_release(periph);
648		return (error);
649	}
650
651	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
652	    ("adaopen\n"));
653
654	softc = (struct ada_softc *)periph->softc;
655	softc->flags |= ADA_FLAG_OPEN;
656
657	cam_periph_unhold(periph);
658	cam_periph_unlock(periph);
659	return (0);
660}
661
662static int
663adaclose(struct disk *dp)
664{
665	struct	cam_periph *periph;
666	struct	ada_softc *softc;
667	union ccb *ccb;
668	int error;
669
670	periph = (struct cam_periph *)dp->d_drv1;
671	softc = (struct ada_softc *)periph->softc;
672	cam_periph_lock(periph);
673
674	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE | CAM_DEBUG_PERIPH,
675	    ("adaclose\n"));
676
677	/* We only sync the cache if the drive is capable of it. */
678	if ((softc->flags & ADA_FLAG_DIRTY) != 0 &&
679	    (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) != 0 &&
680	    (periph->flags & CAM_PERIPH_INVALID) == 0 &&
681	    cam_periph_hold(periph, PRIBIO) == 0) {
682
683		ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
684		cam_fill_ataio(&ccb->ataio,
685				    1,
686				    adadone,
687				    CAM_DIR_NONE,
688				    0,
689				    NULL,
690				    0,
691				    ada_default_timeout*1000);
692
693		if (softc->flags & ADA_FLAG_CAN_48BIT)
694			ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
695		else
696			ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
697		error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
698		    /*sense_flags*/0, softc->disk->d_devstat);
699
700		if (error != 0)
701			xpt_print(periph->path, "Synchronize cache failed\n");
702		else
703			softc->flags &= ~ADA_FLAG_DIRTY;
704		xpt_release_ccb(ccb);
705		cam_periph_unhold(periph);
706	}
707
708	softc->flags &= ~ADA_FLAG_OPEN;
709
710	while (softc->refcount != 0)
711		cam_periph_sleep(periph, &softc->refcount, PRIBIO, "adaclose", 1);
712	cam_periph_unlock(periph);
713	cam_periph_release(periph);
714	return (0);
715}
716
717static void
718adaschedule(struct cam_periph *periph)
719{
720	struct ada_softc *softc = (struct ada_softc *)periph->softc;
721
722	if (softc->state != ADA_STATE_NORMAL)
723		return;
724
725	/* Check if we have more work to do. */
726	if (bioq_first(&softc->bio_queue) ||
727	    (!softc->trim_running && bioq_first(&softc->trim_queue))) {
728		xpt_schedule(periph, CAM_PRIORITY_NORMAL);
729	}
730}
731
732/*
733 * Actually translate the requested transfer into one the physical driver
734 * can understand.  The transfer is described by a buf and will include
735 * only one physical transfer.
736 */
737static void
738adastrategy(struct bio *bp)
739{
740	struct cam_periph *periph;
741	struct ada_softc *softc;
742
743	periph = (struct cam_periph *)bp->bio_disk->d_drv1;
744	softc = (struct ada_softc *)periph->softc;
745
746	cam_periph_lock(periph);
747
748	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastrategy(%p)\n", bp));
749
750	/*
751	 * If the device has been made invalid, error out
752	 */
753	if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
754		cam_periph_unlock(periph);
755		biofinish(bp, NULL, ENXIO);
756		return;
757	}
758
759	/*
760	 * Place it in the queue of disk activities for this disk
761	 */
762	if (bp->bio_cmd == BIO_DELETE) {
763		KASSERT((softc->flags & ADA_FLAG_CAN_TRIM) ||
764			((softc->flags & ADA_FLAG_CAN_CFA) &&
765			 !(softc->flags & ADA_FLAG_CAN_48BIT)),
766			("BIO_DELETE but no supported TRIM method."));
767		bioq_disksort(&softc->trim_queue, bp);
768	} else {
769		if (ADA_SIO)
770		    bioq_disksort(&softc->bio_queue, bp);
771		else
772		    bioq_insert_tail(&softc->bio_queue, bp);
773	}
774
775	/*
776	 * Schedule ourselves for performing the work.
777	 */
778	adaschedule(periph);
779	cam_periph_unlock(periph);
780
781	return;
782}
783
784static int
785adadump(void *arg, void *virtual, vm_offset_t physical, off_t offset, size_t length)
786{
787	struct	    cam_periph *periph;
788	struct	    ada_softc *softc;
789	u_int	    secsize;
790	union	    ccb ccb;
791	struct	    disk *dp;
792	uint64_t    lba;
793	uint16_t    count;
794	int	    error = 0;
795
796	dp = arg;
797	periph = dp->d_drv1;
798	softc = (struct ada_softc *)periph->softc;
799	cam_periph_lock(periph);
800	secsize = softc->params.secsize;
801	lba = offset / secsize;
802	count = length / secsize;
803
804	if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
805		cam_periph_unlock(periph);
806		return (ENXIO);
807	}
808
809	if (length > 0) {
810		xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
811		ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
812		cam_fill_ataio(&ccb.ataio,
813		    0,
814		    adadone,
815		    CAM_DIR_OUT,
816		    0,
817		    (u_int8_t *) virtual,
818		    length,
819		    ada_default_timeout*1000);
820		if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
821		    (lba + count >= ATA_MAX_28BIT_LBA ||
822		    count >= 256)) {
823			ata_48bit_cmd(&ccb.ataio, ATA_WRITE_DMA48,
824			    0, lba, count);
825		} else {
826			ata_28bit_cmd(&ccb.ataio, ATA_WRITE_DMA,
827			    0, lba, count);
828		}
829		xpt_polled_action(&ccb);
830
831		error = cam_periph_error(&ccb,
832		    0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
833		if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
834			cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
835			    /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
836		if (error != 0)
837			printf("Aborting dump due to I/O error.\n");
838
839		cam_periph_unlock(periph);
840		return (error);
841	}
842
843	if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) {
844		xpt_setup_ccb(&ccb.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
845
846		ccb.ccb_h.ccb_state = ADA_CCB_DUMP;
847		cam_fill_ataio(&ccb.ataio,
848				    0,
849				    adadone,
850				    CAM_DIR_NONE,
851				    0,
852				    NULL,
853				    0,
854				    ada_default_timeout*1000);
855
856		if (softc->flags & ADA_FLAG_CAN_48BIT)
857			ata_48bit_cmd(&ccb.ataio, ATA_FLUSHCACHE48, 0, 0, 0);
858		else
859			ata_28bit_cmd(&ccb.ataio, ATA_FLUSHCACHE, 0, 0, 0);
860		xpt_polled_action(&ccb);
861
862		error = cam_periph_error(&ccb,
863		    0, SF_NO_RECOVERY | SF_NO_RETRY, NULL);
864		if ((ccb.ccb_h.status & CAM_DEV_QFRZN) != 0)
865			cam_release_devq(ccb.ccb_h.path, /*relsim_flags*/0,
866			    /*reduction*/0, /*timeout*/0, /*getcount_only*/0);
867		if (error != 0)
868			xpt_print(periph->path, "Synchronize cache failed\n");
869	}
870	cam_periph_unlock(periph);
871	return (error);
872}
873
874static void
875adainit(void)
876{
877	cam_status status;
878
879	/*
880	 * Install a global async callback.  This callback will
881	 * receive async callbacks like "new device found".
882	 */
883	status = xpt_register_async(AC_FOUND_DEVICE, adaasync, NULL, NULL);
884
885	if (status != CAM_REQ_CMP) {
886		printf("ada: Failed to attach master async callback "
887		       "due to status 0x%x!\n", status);
888	} else if (ada_send_ordered) {
889
890		/* Register our event handlers */
891		if ((EVENTHANDLER_REGISTER(power_suspend, adasuspend,
892					   NULL, EVENTHANDLER_PRI_LAST)) == NULL)
893		    printf("adainit: power event registration failed!\n");
894		if ((EVENTHANDLER_REGISTER(power_resume, adaresume,
895					   NULL, EVENTHANDLER_PRI_LAST)) == NULL)
896		    printf("adainit: power event registration failed!\n");
897		if ((EVENTHANDLER_REGISTER(shutdown_post_sync, adashutdown,
898					   NULL, SHUTDOWN_PRI_DEFAULT)) == NULL)
899		    printf("adainit: shutdown event registration failed!\n");
900	}
901}
902
903/*
904 * Callback from GEOM, called when it has finished cleaning up its
905 * resources.
906 */
907static void
908adadiskgonecb(struct disk *dp)
909{
910	struct cam_periph *periph;
911
912	periph = (struct cam_periph *)dp->d_drv1;
913
914	cam_periph_release(periph);
915}
916
917static void
918adaoninvalidate(struct cam_periph *periph)
919{
920	struct ada_softc *softc;
921
922	softc = (struct ada_softc *)periph->softc;
923
924	/*
925	 * De-register any async callbacks.
926	 */
927	xpt_register_async(0, adaasync, periph, periph->path);
928
929	/*
930	 * Return all queued I/O with ENXIO.
931	 * XXX Handle any transactions queued to the card
932	 *     with XPT_ABORT_CCB.
933	 */
934	bioq_flush(&softc->bio_queue, NULL, ENXIO);
935	bioq_flush(&softc->trim_queue, NULL, ENXIO);
936
937	disk_gone(softc->disk);
938}
939
940static void
941adacleanup(struct cam_periph *periph)
942{
943	struct ada_softc *softc;
944
945	softc = (struct ada_softc *)periph->softc;
946
947	cam_periph_unlock(periph);
948
949	/*
950	 * If we can't free the sysctl tree, oh well...
951	 */
952	if ((softc->flags & ADA_FLAG_SCTX_INIT) != 0
953	    && sysctl_ctx_free(&softc->sysctl_ctx) != 0) {
954		xpt_print(periph->path, "can't remove sysctl context\n");
955	}
956
957	disk_destroy(softc->disk);
958	callout_drain(&softc->sendordered_c);
959	free(softc, M_DEVBUF);
960	cam_periph_lock(periph);
961}
962
963static void
964adaasync(void *callback_arg, u_int32_t code,
965	struct cam_path *path, void *arg)
966{
967	struct ccb_getdev cgd;
968	struct cam_periph *periph;
969	struct ada_softc *softc;
970
971	periph = (struct cam_periph *)callback_arg;
972	switch (code) {
973	case AC_FOUND_DEVICE:
974	{
975		struct ccb_getdev *cgd;
976		cam_status status;
977
978		cgd = (struct ccb_getdev *)arg;
979		if (cgd == NULL)
980			break;
981
982		if (cgd->protocol != PROTO_ATA)
983			break;
984
985		/*
986		 * Allocate a peripheral instance for
987		 * this device and start the probe
988		 * process.
989		 */
990		status = cam_periph_alloc(adaregister, adaoninvalidate,
991					  adacleanup, adastart,
992					  "ada", CAM_PERIPH_BIO,
993					  path, adaasync,
994					  AC_FOUND_DEVICE, cgd);
995
996		if (status != CAM_REQ_CMP
997		 && status != CAM_REQ_INPROG)
998			printf("adaasync: Unable to attach to new device "
999				"due to status 0x%x\n", status);
1000		break;
1001	}
1002	case AC_GETDEV_CHANGED:
1003	{
1004		softc = (struct ada_softc *)periph->softc;
1005		xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1006		cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1007		xpt_action((union ccb *)&cgd);
1008
1009		if ((cgd.ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1010		    (cgd.inq_flags & SID_DMA))
1011			softc->flags |= ADA_FLAG_CAN_DMA;
1012		else
1013			softc->flags &= ~ADA_FLAG_CAN_DMA;
1014		if (cgd.ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1015			softc->flags |= ADA_FLAG_CAN_48BIT;
1016			if (cgd.inq_flags & SID_DMA48)
1017				softc->flags |= ADA_FLAG_CAN_DMA48;
1018			else
1019				softc->flags &= ~ADA_FLAG_CAN_DMA48;
1020		} else
1021			softc->flags &= ~(ADA_FLAG_CAN_48BIT |
1022			    ADA_FLAG_CAN_DMA48);
1023		if ((cgd.ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1024		    (cgd.inq_flags & SID_DMA) && (cgd.inq_flags & SID_CmdQue))
1025			softc->flags |= ADA_FLAG_CAN_NCQ;
1026		else
1027			softc->flags &= ~ADA_FLAG_CAN_NCQ;
1028		if ((cgd.ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1029		    (cgd.inq_flags & SID_DMA))
1030			softc->flags |= ADA_FLAG_CAN_TRIM;
1031		else
1032			softc->flags &= ~ADA_FLAG_CAN_TRIM;
1033
1034		cam_periph_async(periph, code, path, arg);
1035		break;
1036	}
1037	case AC_ADVINFO_CHANGED:
1038	{
1039		uintptr_t buftype;
1040
1041		buftype = (uintptr_t)arg;
1042		if (buftype == CDAI_TYPE_PHYS_PATH) {
1043			struct ada_softc *softc;
1044
1045			softc = periph->softc;
1046			disk_attr_changed(softc->disk, "GEOM::physpath",
1047					  M_NOWAIT);
1048		}
1049		break;
1050	}
1051	case AC_SENT_BDR:
1052	case AC_BUS_RESET:
1053	{
1054		softc = (struct ada_softc *)periph->softc;
1055		cam_periph_async(periph, code, path, arg);
1056		if (softc->state != ADA_STATE_NORMAL)
1057			break;
1058		xpt_setup_ccb(&cgd.ccb_h, periph->path, CAM_PRIORITY_NORMAL);
1059		cgd.ccb_h.func_code = XPT_GDEV_TYPE;
1060		xpt_action((union ccb *)&cgd);
1061		if (ADA_RA >= 0 &&
1062		    cgd.ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD)
1063			softc->state = ADA_STATE_RAHEAD;
1064		else if (ADA_WC >= 0 &&
1065		    cgd.ident_data.support.command1 & ATA_SUPPORT_WRITECACHE)
1066			softc->state = ADA_STATE_WCACHE;
1067		else
1068		    break;
1069		if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1070			softc->state = ADA_STATE_NORMAL;
1071		else
1072			xpt_schedule(periph, CAM_PRIORITY_DEV);
1073	}
1074	default:
1075		cam_periph_async(periph, code, path, arg);
1076		break;
1077	}
1078}
1079
1080static void
1081adasysctlinit(void *context, int pending)
1082{
1083	struct cam_periph *periph;
1084	struct ada_softc *softc;
1085	char tmpstr[80], tmpstr2[80];
1086
1087	periph = (struct cam_periph *)context;
1088
1089	/* periph was held for us when this task was enqueued */
1090	if ((periph->flags & CAM_PERIPH_INVALID) != 0) {
1091		cam_periph_release(periph);
1092		return;
1093	}
1094
1095	softc = (struct ada_softc *)periph->softc;
1096	snprintf(tmpstr, sizeof(tmpstr), "CAM ADA unit %d", periph->unit_number);
1097	snprintf(tmpstr2, sizeof(tmpstr2), "%d", periph->unit_number);
1098
1099	sysctl_ctx_init(&softc->sysctl_ctx);
1100	softc->flags |= ADA_FLAG_SCTX_INIT;
1101	softc->sysctl_tree = SYSCTL_ADD_NODE(&softc->sysctl_ctx,
1102		SYSCTL_STATIC_CHILDREN(_kern_cam_ada), OID_AUTO, tmpstr2,
1103		CTLFLAG_RD, 0, tmpstr);
1104	if (softc->sysctl_tree == NULL) {
1105		printf("adasysctlinit: unable to allocate sysctl tree\n");
1106		cam_periph_release(periph);
1107		return;
1108	}
1109
1110	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1111		OID_AUTO, "read_ahead", CTLFLAG_RW | CTLFLAG_MPSAFE,
1112		&softc->read_ahead, 0, "Enable disk read ahead.");
1113	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1114		OID_AUTO, "write_cache", CTLFLAG_RW | CTLFLAG_MPSAFE,
1115		&softc->write_cache, 0, "Enable disk write cache.");
1116	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1117		OID_AUTO, "sort_io_queue", CTLFLAG_RW | CTLFLAG_MPSAFE,
1118		&softc->sort_io_queue, 0,
1119		"Sort IO queue to try and optimise disk access patterns");
1120#ifdef ADA_TEST_FAILURE
1121	/*
1122	 * Add a 'door bell' sysctl which allows one to set it from userland
1123	 * and cause something bad to happen.  For the moment, we only allow
1124	 * whacking the next read or write.
1125	 */
1126	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1127		OID_AUTO, "force_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1128		&softc->force_read_error, 0,
1129		"Force a read error for the next N reads.");
1130	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1131		OID_AUTO, "force_write_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1132		&softc->force_write_error, 0,
1133		"Force a write error for the next N writes.");
1134	SYSCTL_ADD_INT(&softc->sysctl_ctx, SYSCTL_CHILDREN(softc->sysctl_tree),
1135		OID_AUTO, "periodic_read_error", CTLFLAG_RW | CTLFLAG_MPSAFE,
1136		&softc->periodic_read_error, 0,
1137		"Force a read error every N reads (don't set too low).");
1138#endif
1139	cam_periph_release(periph);
1140}
1141
1142static int
1143adagetattr(struct bio *bp)
1144{
1145	int ret;
1146	struct cam_periph *periph;
1147
1148	periph = (struct cam_periph *)bp->bio_disk->d_drv1;
1149	cam_periph_lock(periph);
1150	ret = xpt_getattr(bp->bio_data, bp->bio_length, bp->bio_attribute,
1151	    periph->path);
1152	cam_periph_unlock(periph);
1153	if (ret == 0)
1154		bp->bio_completed = bp->bio_length;
1155	return ret;
1156}
1157
1158static cam_status
1159adaregister(struct cam_periph *periph, void *arg)
1160{
1161	struct ada_softc *softc;
1162	struct ccb_pathinq cpi;
1163	struct ccb_getdev *cgd;
1164	char   announce_buf[80], buf1[32];
1165	struct disk_params *dp;
1166	caddr_t match;
1167	u_int maxio;
1168	int legacy_id, quirks;
1169
1170	cgd = (struct ccb_getdev *)arg;
1171	if (cgd == NULL) {
1172		printf("adaregister: no getdev CCB, can't register device\n");
1173		return(CAM_REQ_CMP_ERR);
1174	}
1175
1176	softc = (struct ada_softc *)malloc(sizeof(*softc), M_DEVBUF,
1177	    M_NOWAIT|M_ZERO);
1178
1179	if (softc == NULL) {
1180		printf("adaregister: Unable to probe new device. "
1181		    "Unable to allocate softc\n");
1182		return(CAM_REQ_CMP_ERR);
1183	}
1184
1185	bioq_init(&softc->bio_queue);
1186	bioq_init(&softc->trim_queue);
1187
1188	if ((cgd->ident_data.capabilities1 & ATA_SUPPORT_DMA) &&
1189	    (cgd->inq_flags & SID_DMA))
1190		softc->flags |= ADA_FLAG_CAN_DMA;
1191	if (cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) {
1192		softc->flags |= ADA_FLAG_CAN_48BIT;
1193		if (cgd->inq_flags & SID_DMA48)
1194			softc->flags |= ADA_FLAG_CAN_DMA48;
1195	}
1196	if (cgd->ident_data.support.command2 & ATA_SUPPORT_FLUSHCACHE)
1197		softc->flags |= ADA_FLAG_CAN_FLUSHCACHE;
1198	if (cgd->ident_data.support.command1 & ATA_SUPPORT_POWERMGT)
1199		softc->flags |= ADA_FLAG_CAN_POWERMGT;
1200	if ((cgd->ident_data.satacapabilities & ATA_SUPPORT_NCQ) &&
1201	    (cgd->inq_flags & SID_DMA) && (cgd->inq_flags & SID_CmdQue))
1202		softc->flags |= ADA_FLAG_CAN_NCQ;
1203	if ((cgd->ident_data.support_dsm & ATA_SUPPORT_DSM_TRIM) &&
1204	    (cgd->inq_flags & SID_DMA)) {
1205		softc->flags |= ADA_FLAG_CAN_TRIM;
1206		softc->trim_max_ranges = TRIM_MAX_RANGES;
1207		if (cgd->ident_data.max_dsm_blocks != 0) {
1208			softc->trim_max_ranges =
1209			    min(cgd->ident_data.max_dsm_blocks *
1210				ATA_DSM_BLK_RANGES, softc->trim_max_ranges);
1211		}
1212	}
1213	if (cgd->ident_data.support.command2 & ATA_SUPPORT_CFA)
1214		softc->flags |= ADA_FLAG_CAN_CFA;
1215
1216	periph->softc = softc;
1217
1218	/*
1219	 * See if this device has any quirks.
1220	 */
1221	match = cam_quirkmatch((caddr_t)&cgd->ident_data,
1222			       (caddr_t)ada_quirk_table,
1223			       sizeof(ada_quirk_table)/sizeof(*ada_quirk_table),
1224			       sizeof(*ada_quirk_table), ata_identify_match);
1225	if (match != NULL)
1226		softc->quirks = ((struct ada_quirk_entry *)match)->quirks;
1227	else
1228		softc->quirks = ADA_Q_NONE;
1229
1230	bzero(&cpi, sizeof(cpi));
1231	xpt_setup_ccb(&cpi.ccb_h, periph->path, CAM_PRIORITY_NONE);
1232	cpi.ccb_h.func_code = XPT_PATH_INQ;
1233	xpt_action((union ccb *)&cpi);
1234
1235	TASK_INIT(&softc->sysctl_task, 0, adasysctlinit, periph);
1236
1237	/*
1238	 * Register this media as a disk
1239	 */
1240	(void)cam_periph_hold(periph, PRIBIO);
1241	cam_periph_unlock(periph);
1242	snprintf(announce_buf, sizeof(announce_buf),
1243	    "kern.cam.ada.%d.quirks", periph->unit_number);
1244	quirks = softc->quirks;
1245	TUNABLE_INT_FETCH(announce_buf, &quirks);
1246	softc->quirks = quirks;
1247	softc->read_ahead = -1;
1248	snprintf(announce_buf, sizeof(announce_buf),
1249	    "kern.cam.ada.%d.read_ahead", periph->unit_number);
1250	TUNABLE_INT_FETCH(announce_buf, &softc->read_ahead);
1251	softc->write_cache = -1;
1252	snprintf(announce_buf, sizeof(announce_buf),
1253	    "kern.cam.ada.%d.write_cache", periph->unit_number);
1254	TUNABLE_INT_FETCH(announce_buf, &softc->write_cache);
1255	/* Disable queue sorting for non-rotational media by default. */
1256	if (cgd->ident_data.media_rotation_rate == ATA_RATE_NON_ROTATING)
1257		softc->sort_io_queue = 0;
1258	else
1259		softc->sort_io_queue = -1;
1260	adagetparams(periph, cgd);
1261	softc->disk = disk_alloc();
1262	softc->disk->d_rotation_rate = cgd->ident_data.media_rotation_rate;
1263	softc->disk->d_devstat = devstat_new_entry(periph->periph_name,
1264			  periph->unit_number, softc->params.secsize,
1265			  DEVSTAT_ALL_SUPPORTED,
1266			  DEVSTAT_TYPE_DIRECT |
1267			  XPORT_DEVSTAT_TYPE(cpi.transport),
1268			  DEVSTAT_PRIORITY_DISK);
1269	softc->disk->d_open = adaopen;
1270	softc->disk->d_close = adaclose;
1271	softc->disk->d_strategy = adastrategy;
1272	softc->disk->d_getattr = adagetattr;
1273	softc->disk->d_dump = adadump;
1274	softc->disk->d_gone = adadiskgonecb;
1275	softc->disk->d_name = "ada";
1276	softc->disk->d_drv1 = periph;
1277	maxio = cpi.maxio;		/* Honor max I/O size of SIM */
1278	if (maxio == 0)
1279		maxio = DFLTPHYS;	/* traditional default */
1280	else if (maxio > MAXPHYS)
1281		maxio = MAXPHYS;	/* for safety */
1282	if (softc->flags & ADA_FLAG_CAN_48BIT)
1283		maxio = min(maxio, 65536 * softc->params.secsize);
1284	else					/* 28bit ATA command limit */
1285		maxio = min(maxio, 256 * softc->params.secsize);
1286	softc->disk->d_maxsize = maxio;
1287	softc->disk->d_unit = periph->unit_number;
1288	softc->disk->d_flags = DISKFLAG_DIRECT_COMPLETION;
1289	if (softc->flags & ADA_FLAG_CAN_FLUSHCACHE)
1290		softc->disk->d_flags |= DISKFLAG_CANFLUSHCACHE;
1291	if (softc->flags & ADA_FLAG_CAN_TRIM) {
1292		softc->disk->d_flags |= DISKFLAG_CANDELETE;
1293		softc->disk->d_delmaxsize = softc->params.secsize *
1294					    ATA_DSM_RANGE_MAX *
1295					    softc->trim_max_ranges;
1296	} else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1297	    !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1298		softc->disk->d_flags |= DISKFLAG_CANDELETE;
1299		softc->disk->d_delmaxsize = 256 * softc->params.secsize;
1300	} else
1301		softc->disk->d_delmaxsize = maxio;
1302	if ((cpi.hba_misc & PIM_UNMAPPED) != 0)
1303		softc->disk->d_flags |= DISKFLAG_UNMAPPED_BIO;
1304	strlcpy(softc->disk->d_descr, cgd->ident_data.model,
1305	    MIN(sizeof(softc->disk->d_descr), sizeof(cgd->ident_data.model)));
1306	strlcpy(softc->disk->d_ident, cgd->ident_data.serial,
1307	    MIN(sizeof(softc->disk->d_ident), sizeof(cgd->ident_data.serial)));
1308	softc->disk->d_hba_vendor = cpi.hba_vendor;
1309	softc->disk->d_hba_device = cpi.hba_device;
1310	softc->disk->d_hba_subvendor = cpi.hba_subvendor;
1311	softc->disk->d_hba_subdevice = cpi.hba_subdevice;
1312
1313	softc->disk->d_sectorsize = softc->params.secsize;
1314	softc->disk->d_mediasize = (off_t)softc->params.sectors *
1315	    softc->params.secsize;
1316	if (ata_physical_sector_size(&cgd->ident_data) !=
1317	    softc->params.secsize) {
1318		softc->disk->d_stripesize =
1319		    ata_physical_sector_size(&cgd->ident_data);
1320		softc->disk->d_stripeoffset = (softc->disk->d_stripesize -
1321		    ata_logical_sector_offset(&cgd->ident_data)) %
1322		    softc->disk->d_stripesize;
1323	} else if (softc->quirks & ADA_Q_4K) {
1324		softc->disk->d_stripesize = 4096;
1325		softc->disk->d_stripeoffset = 0;
1326	}
1327	softc->disk->d_fwsectors = softc->params.secs_per_track;
1328	softc->disk->d_fwheads = softc->params.heads;
1329	ata_disk_firmware_geom_adjust(softc->disk);
1330
1331	if (ada_legacy_aliases) {
1332#ifdef ATA_STATIC_ID
1333		legacy_id = xpt_path_legacy_ata_id(periph->path);
1334#else
1335		legacy_id = softc->disk->d_unit;
1336#endif
1337		if (legacy_id >= 0) {
1338			snprintf(announce_buf, sizeof(announce_buf),
1339			    "kern.devalias.%s%d",
1340			    softc->disk->d_name, softc->disk->d_unit);
1341			snprintf(buf1, sizeof(buf1),
1342			    "ad%d", legacy_id);
1343			setenv(announce_buf, buf1);
1344		}
1345	} else
1346		legacy_id = -1;
1347	/*
1348	 * Acquire a reference to the periph before we register with GEOM.
1349	 * We'll release this reference once GEOM calls us back (via
1350	 * adadiskgonecb()) telling us that our provider has been freed.
1351	 */
1352	if (cam_periph_acquire(periph) != CAM_REQ_CMP) {
1353		xpt_print(periph->path, "%s: lost periph during "
1354			  "registration!\n", __func__);
1355		cam_periph_lock(periph);
1356		return (CAM_REQ_CMP_ERR);
1357	}
1358	disk_create(softc->disk, DISK_VERSION);
1359	cam_periph_lock(periph);
1360	cam_periph_unhold(periph);
1361
1362	dp = &softc->params;
1363	snprintf(announce_buf, sizeof(announce_buf),
1364		"%juMB (%ju %u byte sectors: %dH %dS/T %dC)",
1365		(uintmax_t)(((uintmax_t)dp->secsize *
1366		dp->sectors) / (1024*1024)),
1367		(uintmax_t)dp->sectors,
1368		dp->secsize, dp->heads,
1369		dp->secs_per_track, dp->cylinders);
1370	xpt_announce_periph(periph, announce_buf);
1371	xpt_announce_quirks(periph, softc->quirks, ADA_Q_BIT_STRING);
1372	if (legacy_id >= 0)
1373		printf("%s%d: Previously was known as ad%d\n",
1374		       periph->periph_name, periph->unit_number, legacy_id);
1375
1376	/*
1377	 * Create our sysctl variables, now that we know
1378	 * we have successfully attached.
1379	 */
1380	if (cam_periph_acquire(periph) == CAM_REQ_CMP)
1381		taskqueue_enqueue(taskqueue_thread, &softc->sysctl_task);
1382
1383	/*
1384	 * Add async callbacks for bus reset and
1385	 * bus device reset calls.  I don't bother
1386	 * checking if this fails as, in most cases,
1387	 * the system will function just fine without
1388	 * them and the only alternative would be to
1389	 * not attach the device on failure.
1390	 */
1391	xpt_register_async(AC_SENT_BDR | AC_BUS_RESET | AC_LOST_DEVICE |
1392	    AC_GETDEV_CHANGED | AC_ADVINFO_CHANGED,
1393	    adaasync, periph, periph->path);
1394
1395	/*
1396	 * Schedule a periodic event to occasionally send an
1397	 * ordered tag to a device.
1398	 */
1399	callout_init_mtx(&softc->sendordered_c, cam_periph_mtx(periph), 0);
1400	callout_reset(&softc->sendordered_c,
1401	    (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1402	    adasendorderedtag, softc);
1403
1404	if (ADA_RA >= 0 &&
1405	    cgd->ident_data.support.command1 & ATA_SUPPORT_LOOKAHEAD) {
1406		softc->state = ADA_STATE_RAHEAD;
1407	} else if (ADA_WC >= 0 &&
1408	    cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1409		softc->state = ADA_STATE_WCACHE;
1410	} else {
1411		softc->state = ADA_STATE_NORMAL;
1412		return(CAM_REQ_CMP);
1413	}
1414	if (cam_periph_acquire(periph) != CAM_REQ_CMP)
1415		softc->state = ADA_STATE_NORMAL;
1416	else
1417		xpt_schedule(periph, CAM_PRIORITY_DEV);
1418	return(CAM_REQ_CMP);
1419}
1420
1421static void
1422ada_dsmtrim(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1423{
1424	struct trim_request *req = &softc->trim_req;
1425	uint64_t lastlba = (uint64_t)-1;
1426	int c, lastcount = 0, off, ranges = 0;
1427
1428	bzero(req, sizeof(*req));
1429	TAILQ_INIT(&req->bps);
1430	do {
1431		uint64_t lba = bp->bio_pblkno;
1432		int count = bp->bio_bcount / softc->params.secsize;
1433
1434		bioq_remove(&softc->trim_queue, bp);
1435
1436		/* Try to extend the previous range. */
1437		if (lba == lastlba) {
1438			c = min(count, ATA_DSM_RANGE_MAX - lastcount);
1439			lastcount += c;
1440			off = (ranges - 1) * ATA_DSM_RANGE_SIZE;
1441			req->data[off + 6] = lastcount & 0xff;
1442			req->data[off + 7] =
1443				(lastcount >> 8) & 0xff;
1444			count -= c;
1445			lba += c;
1446		}
1447
1448		while (count > 0) {
1449			c = min(count, ATA_DSM_RANGE_MAX);
1450			off = ranges * ATA_DSM_RANGE_SIZE;
1451			req->data[off + 0] = lba & 0xff;
1452			req->data[off + 1] = (lba >> 8) & 0xff;
1453			req->data[off + 2] = (lba >> 16) & 0xff;
1454			req->data[off + 3] = (lba >> 24) & 0xff;
1455			req->data[off + 4] = (lba >> 32) & 0xff;
1456			req->data[off + 5] = (lba >> 40) & 0xff;
1457			req->data[off + 6] = c & 0xff;
1458			req->data[off + 7] = (c >> 8) & 0xff;
1459			lba += c;
1460			count -= c;
1461			lastcount = c;
1462			ranges++;
1463			/*
1464			 * Its the caller's responsibility to ensure the
1465			 * request will fit so we don't need to check for
1466			 * overrun here
1467			 */
1468		}
1469		lastlba = lba;
1470		TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1471		bp = bioq_first(&softc->trim_queue);
1472		if (bp == NULL ||
1473		    bp->bio_bcount / softc->params.secsize >
1474		    (softc->trim_max_ranges - ranges) * ATA_DSM_RANGE_MAX)
1475			break;
1476	} while (1);
1477	cam_fill_ataio(ataio,
1478	    ada_retry_count,
1479	    adadone,
1480	    CAM_DIR_OUT,
1481	    0,
1482	    req->data,
1483	    ((ranges + ATA_DSM_BLK_RANGES - 1) /
1484	    ATA_DSM_BLK_RANGES) * ATA_DSM_BLK_SIZE,
1485	    ada_default_timeout * 1000);
1486	ata_48bit_cmd(ataio, ATA_DATA_SET_MANAGEMENT,
1487	    ATA_DSM_TRIM, 0, (ranges + ATA_DSM_BLK_RANGES -
1488	    1) / ATA_DSM_BLK_RANGES);
1489}
1490
1491static void
1492ada_cfaerase(struct ada_softc *softc, struct bio *bp, struct ccb_ataio *ataio)
1493{
1494	struct trim_request *req = &softc->trim_req;
1495	uint64_t lba = bp->bio_pblkno;
1496	uint16_t count = bp->bio_bcount / softc->params.secsize;
1497
1498	bzero(req, sizeof(*req));
1499	TAILQ_INIT(&req->bps);
1500	bioq_remove(&softc->trim_queue, bp);
1501	TAILQ_INSERT_TAIL(&req->bps, bp, bio_queue);
1502
1503	cam_fill_ataio(ataio,
1504	    ada_retry_count,
1505	    adadone,
1506	    CAM_DIR_NONE,
1507	    0,
1508	    NULL,
1509	    0,
1510	    ada_default_timeout*1000);
1511
1512	if (count >= 256)
1513		count = 0;
1514	ata_28bit_cmd(ataio, ATA_CFA_ERASE, 0, lba, count);
1515}
1516
1517static void
1518adastart(struct cam_periph *periph, union ccb *start_ccb)
1519{
1520	struct ada_softc *softc = (struct ada_softc *)periph->softc;
1521	struct ccb_ataio *ataio = &start_ccb->ataio;
1522
1523	CAM_DEBUG(periph->path, CAM_DEBUG_TRACE, ("adastart\n"));
1524
1525	switch (softc->state) {
1526	case ADA_STATE_NORMAL:
1527	{
1528		struct bio *bp;
1529		u_int8_t tag_code;
1530
1531		/* Run TRIM if not running yet. */
1532		if (!softc->trim_running &&
1533		    (bp = bioq_first(&softc->trim_queue)) != 0) {
1534			if (softc->flags & ADA_FLAG_CAN_TRIM) {
1535				ada_dsmtrim(softc, bp, ataio);
1536			} else if ((softc->flags & ADA_FLAG_CAN_CFA) &&
1537			    !(softc->flags & ADA_FLAG_CAN_48BIT)) {
1538				ada_cfaerase(softc, bp, ataio);
1539			} else {
1540				panic("adastart: BIO_DELETE without method, not possible.");
1541			}
1542			softc->trim_running = 1;
1543			start_ccb->ccb_h.ccb_state = ADA_CCB_TRIM;
1544			start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1545			goto out;
1546		}
1547		/* Run regular command. */
1548		bp = bioq_first(&softc->bio_queue);
1549		if (bp == NULL) {
1550			xpt_release_ccb(start_ccb);
1551			break;
1552		}
1553		bioq_remove(&softc->bio_queue, bp);
1554
1555		if ((bp->bio_flags & BIO_ORDERED) != 0
1556		 || (softc->flags & ADA_FLAG_NEED_OTAG) != 0) {
1557			softc->flags &= ~ADA_FLAG_NEED_OTAG;
1558			softc->flags |= ADA_FLAG_WAS_OTAG;
1559			tag_code = 0;
1560		} else {
1561			tag_code = 1;
1562		}
1563		switch (bp->bio_cmd) {
1564		case BIO_WRITE:
1565			softc->flags |= ADA_FLAG_DIRTY;
1566			/* FALLTHROUGH */
1567		case BIO_READ:
1568		{
1569			uint64_t lba = bp->bio_pblkno;
1570			uint16_t count = bp->bio_bcount / softc->params.secsize;
1571#ifdef ADA_TEST_FAILURE
1572			int fail = 0;
1573
1574			/*
1575			 * Support the failure ioctls.  If the command is a
1576			 * read, and there are pending forced read errors, or
1577			 * if a write and pending write errors, then fail this
1578			 * operation with EIO.  This is useful for testing
1579			 * purposes.  Also, support having every Nth read fail.
1580			 *
1581			 * This is a rather blunt tool.
1582			 */
1583			if (bp->bio_cmd == BIO_READ) {
1584				if (softc->force_read_error) {
1585					softc->force_read_error--;
1586					fail = 1;
1587				}
1588				if (softc->periodic_read_error > 0) {
1589					if (++softc->periodic_read_count >=
1590					    softc->periodic_read_error) {
1591						softc->periodic_read_count = 0;
1592						fail = 1;
1593					}
1594				}
1595			} else {
1596				if (softc->force_write_error) {
1597					softc->force_write_error--;
1598					fail = 1;
1599				}
1600			}
1601			if (fail) {
1602				bp->bio_error = EIO;
1603				bp->bio_flags |= BIO_ERROR;
1604				biodone(bp);
1605				xpt_release_ccb(start_ccb);
1606				adaschedule(periph);
1607				return;
1608			}
1609#endif
1610			KASSERT((bp->bio_flags & BIO_UNMAPPED) == 0 ||
1611			    round_page(bp->bio_bcount + bp->bio_ma_offset) /
1612			    PAGE_SIZE == bp->bio_ma_n,
1613			    ("Short bio %p", bp));
1614			cam_fill_ataio(ataio,
1615			    ada_retry_count,
1616			    adadone,
1617			    (bp->bio_cmd == BIO_READ ? CAM_DIR_IN :
1618				CAM_DIR_OUT) | ((bp->bio_flags & BIO_UNMAPPED)
1619				!= 0 ? CAM_DATA_BIO : 0),
1620			    tag_code,
1621			    ((bp->bio_flags & BIO_UNMAPPED) != 0) ? (void *)bp :
1622				bp->bio_data,
1623			    bp->bio_bcount,
1624			    ada_default_timeout*1000);
1625
1626			if ((softc->flags & ADA_FLAG_CAN_NCQ) && tag_code) {
1627				if (bp->bio_cmd == BIO_READ) {
1628					ata_ncq_cmd(ataio, ATA_READ_FPDMA_QUEUED,
1629					    lba, count);
1630				} else {
1631					ata_ncq_cmd(ataio, ATA_WRITE_FPDMA_QUEUED,
1632					    lba, count);
1633				}
1634			} else if ((softc->flags & ADA_FLAG_CAN_48BIT) &&
1635			    (lba + count >= ATA_MAX_28BIT_LBA ||
1636			    count > 256)) {
1637				if (softc->flags & ADA_FLAG_CAN_DMA48) {
1638					if (bp->bio_cmd == BIO_READ) {
1639						ata_48bit_cmd(ataio, ATA_READ_DMA48,
1640						    0, lba, count);
1641					} else {
1642						ata_48bit_cmd(ataio, ATA_WRITE_DMA48,
1643						    0, lba, count);
1644					}
1645				} else {
1646					if (bp->bio_cmd == BIO_READ) {
1647						ata_48bit_cmd(ataio, ATA_READ_MUL48,
1648						    0, lba, count);
1649					} else {
1650						ata_48bit_cmd(ataio, ATA_WRITE_MUL48,
1651						    0, lba, count);
1652					}
1653				}
1654			} else {
1655				if (count == 256)
1656					count = 0;
1657				if (softc->flags & ADA_FLAG_CAN_DMA) {
1658					if (bp->bio_cmd == BIO_READ) {
1659						ata_28bit_cmd(ataio, ATA_READ_DMA,
1660						    0, lba, count);
1661					} else {
1662						ata_28bit_cmd(ataio, ATA_WRITE_DMA,
1663						    0, lba, count);
1664					}
1665				} else {
1666					if (bp->bio_cmd == BIO_READ) {
1667						ata_28bit_cmd(ataio, ATA_READ_MUL,
1668						    0, lba, count);
1669					} else {
1670						ata_28bit_cmd(ataio, ATA_WRITE_MUL,
1671						    0, lba, count);
1672					}
1673				}
1674			}
1675			break;
1676		}
1677		case BIO_FLUSH:
1678			cam_fill_ataio(ataio,
1679			    1,
1680			    adadone,
1681			    CAM_DIR_NONE,
1682			    0,
1683			    NULL,
1684			    0,
1685			    ada_default_timeout*1000);
1686
1687			if (softc->flags & ADA_FLAG_CAN_48BIT)
1688				ata_48bit_cmd(ataio, ATA_FLUSHCACHE48, 0, 0, 0);
1689			else
1690				ata_28bit_cmd(ataio, ATA_FLUSHCACHE, 0, 0, 0);
1691			break;
1692		}
1693		start_ccb->ccb_h.ccb_state = ADA_CCB_BUFFER_IO;
1694		start_ccb->ccb_h.flags |= CAM_UNLOCKED;
1695out:
1696		start_ccb->ccb_h.ccb_bp = bp;
1697		softc->outstanding_cmds++;
1698		softc->refcount++;
1699		cam_periph_unlock(periph);
1700		xpt_action(start_ccb);
1701		cam_periph_lock(periph);
1702		softc->refcount--;
1703
1704		/* May have more work to do, so ensure we stay scheduled */
1705		adaschedule(periph);
1706		break;
1707	}
1708	case ADA_STATE_RAHEAD:
1709	case ADA_STATE_WCACHE:
1710	{
1711		cam_fill_ataio(ataio,
1712		    1,
1713		    adadone,
1714		    CAM_DIR_NONE,
1715		    0,
1716		    NULL,
1717		    0,
1718		    ada_default_timeout*1000);
1719
1720		if (softc->state == ADA_STATE_RAHEAD) {
1721			ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_RA ?
1722			    ATA_SF_ENAB_RCACHE : ATA_SF_DIS_RCACHE, 0, 0);
1723			start_ccb->ccb_h.ccb_state = ADA_CCB_RAHEAD;
1724		} else {
1725			ata_28bit_cmd(ataio, ATA_SETFEATURES, ADA_WC ?
1726			    ATA_SF_ENAB_WCACHE : ATA_SF_DIS_WCACHE, 0, 0);
1727			start_ccb->ccb_h.ccb_state = ADA_CCB_WCACHE;
1728		}
1729		start_ccb->ccb_h.flags |= CAM_DEV_QFREEZE;
1730		xpt_action(start_ccb);
1731		break;
1732	}
1733	}
1734}
1735
1736static void
1737adadone(struct cam_periph *periph, union ccb *done_ccb)
1738{
1739	struct ada_softc *softc;
1740	struct ccb_ataio *ataio;
1741	struct ccb_getdev *cgd;
1742	struct cam_path *path;
1743	int state;
1744
1745	softc = (struct ada_softc *)periph->softc;
1746	ataio = &done_ccb->ataio;
1747	path = done_ccb->ccb_h.path;
1748
1749	CAM_DEBUG(path, CAM_DEBUG_TRACE, ("adadone\n"));
1750
1751	state = ataio->ccb_h.ccb_state & ADA_CCB_TYPE_MASK;
1752	switch (state) {
1753	case ADA_CCB_BUFFER_IO:
1754	case ADA_CCB_TRIM:
1755	{
1756		struct bio *bp;
1757		int error;
1758
1759		cam_periph_lock(periph);
1760		if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1761			error = adaerror(done_ccb, 0, 0);
1762			if (error == ERESTART) {
1763				/* A retry was scheduled, so just return. */
1764				cam_periph_unlock(periph);
1765				return;
1766			}
1767			if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1768				cam_release_devq(path,
1769						 /*relsim_flags*/0,
1770						 /*reduction*/0,
1771						 /*timeout*/0,
1772						 /*getcount_only*/0);
1773		} else {
1774			if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0)
1775				panic("REQ_CMP with QFRZN");
1776			error = 0;
1777		}
1778		bp = (struct bio *)done_ccb->ccb_h.ccb_bp;
1779		bp->bio_error = error;
1780		if (error != 0) {
1781			bp->bio_resid = bp->bio_bcount;
1782			bp->bio_flags |= BIO_ERROR;
1783		} else {
1784			if (state == ADA_CCB_TRIM)
1785				bp->bio_resid = 0;
1786			else
1787				bp->bio_resid = ataio->resid;
1788			if (bp->bio_resid > 0)
1789				bp->bio_flags |= BIO_ERROR;
1790		}
1791		softc->outstanding_cmds--;
1792		if (softc->outstanding_cmds == 0)
1793			softc->flags |= ADA_FLAG_WAS_OTAG;
1794		xpt_release_ccb(done_ccb);
1795		if (state == ADA_CCB_TRIM) {
1796			TAILQ_HEAD(, bio) queue;
1797			struct bio *bp1;
1798
1799			TAILQ_INIT(&queue);
1800			TAILQ_CONCAT(&queue, &softc->trim_req.bps, bio_queue);
1801			softc->trim_running = 0;
1802			adaschedule(periph);
1803			cam_periph_unlock(periph);
1804			while ((bp1 = TAILQ_FIRST(&queue)) != NULL) {
1805				TAILQ_REMOVE(&queue, bp1, bio_queue);
1806				bp1->bio_error = error;
1807				if (error != 0) {
1808					bp1->bio_flags |= BIO_ERROR;
1809					bp1->bio_resid = bp1->bio_bcount;
1810				} else
1811					bp1->bio_resid = 0;
1812				biodone(bp1);
1813			}
1814		} else {
1815			cam_periph_unlock(periph);
1816			biodone(bp);
1817		}
1818		return;
1819	}
1820	case ADA_CCB_RAHEAD:
1821	{
1822		if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1823			if (adaerror(done_ccb, 0, 0) == ERESTART) {
1824out:
1825				/* Drop freeze taken due to CAM_DEV_QFREEZE */
1826				cam_release_devq(path, 0, 0, 0, FALSE);
1827				return;
1828			} else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1829				cam_release_devq(path,
1830				    /*relsim_flags*/0,
1831				    /*reduction*/0,
1832				    /*timeout*/0,
1833				    /*getcount_only*/0);
1834			}
1835		}
1836
1837		/*
1838		 * Since our peripheral may be invalidated by an error
1839		 * above or an external event, we must release our CCB
1840		 * before releasing the reference on the peripheral.
1841		 * The peripheral will only go away once the last reference
1842		 * is removed, and we need it around for the CCB release
1843		 * operation.
1844		 */
1845		cgd = (struct ccb_getdev *)done_ccb;
1846		xpt_setup_ccb(&cgd->ccb_h, path, CAM_PRIORITY_NORMAL);
1847		cgd->ccb_h.func_code = XPT_GDEV_TYPE;
1848		xpt_action((union ccb *)cgd);
1849		if (ADA_WC >= 0 &&
1850		    cgd->ident_data.support.command1 & ATA_SUPPORT_WRITECACHE) {
1851			softc->state = ADA_STATE_WCACHE;
1852			xpt_release_ccb(done_ccb);
1853			xpt_schedule(periph, CAM_PRIORITY_DEV);
1854			goto out;
1855		}
1856		softc->state = ADA_STATE_NORMAL;
1857		xpt_release_ccb(done_ccb);
1858		/* Drop freeze taken due to CAM_DEV_QFREEZE */
1859		cam_release_devq(path, 0, 0, 0, FALSE);
1860		adaschedule(periph);
1861		cam_periph_release_locked(periph);
1862		return;
1863	}
1864	case ADA_CCB_WCACHE:
1865	{
1866		if ((done_ccb->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_CMP) {
1867			if (adaerror(done_ccb, 0, 0) == ERESTART) {
1868				goto out;
1869			} else if ((done_ccb->ccb_h.status & CAM_DEV_QFRZN) != 0) {
1870				cam_release_devq(path,
1871				    /*relsim_flags*/0,
1872				    /*reduction*/0,
1873				    /*timeout*/0,
1874				    /*getcount_only*/0);
1875			}
1876		}
1877
1878		softc->state = ADA_STATE_NORMAL;
1879		/*
1880		 * Since our peripheral may be invalidated by an error
1881		 * above or an external event, we must release our CCB
1882		 * before releasing the reference on the peripheral.
1883		 * The peripheral will only go away once the last reference
1884		 * is removed, and we need it around for the CCB release
1885		 * operation.
1886		 */
1887		xpt_release_ccb(done_ccb);
1888		/* Drop freeze taken due to CAM_DEV_QFREEZE */
1889		cam_release_devq(path, 0, 0, 0, FALSE);
1890		adaschedule(periph);
1891		cam_periph_release_locked(periph);
1892		return;
1893	}
1894	case ADA_CCB_DUMP:
1895		/* No-op.  We're polling */
1896		return;
1897	default:
1898		break;
1899	}
1900	xpt_release_ccb(done_ccb);
1901}
1902
1903static int
1904adaerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
1905{
1906
1907	return(cam_periph_error(ccb, cam_flags, sense_flags, NULL));
1908}
1909
1910static void
1911adagetparams(struct cam_periph *periph, struct ccb_getdev *cgd)
1912{
1913	struct ada_softc *softc = (struct ada_softc *)periph->softc;
1914	struct disk_params *dp = &softc->params;
1915	u_int64_t lbasize48;
1916	u_int32_t lbasize;
1917
1918	dp->secsize = ata_logical_sector_size(&cgd->ident_data);
1919	if ((cgd->ident_data.atavalid & ATA_FLAG_54_58) &&
1920		cgd->ident_data.current_heads && cgd->ident_data.current_sectors) {
1921		dp->heads = cgd->ident_data.current_heads;
1922		dp->secs_per_track = cgd->ident_data.current_sectors;
1923		dp->cylinders = cgd->ident_data.cylinders;
1924		dp->sectors = (u_int32_t)cgd->ident_data.current_size_1 |
1925			  ((u_int32_t)cgd->ident_data.current_size_2 << 16);
1926	} else {
1927		dp->heads = cgd->ident_data.heads;
1928		dp->secs_per_track = cgd->ident_data.sectors;
1929		dp->cylinders = cgd->ident_data.cylinders;
1930		dp->sectors = cgd->ident_data.cylinders * dp->heads * dp->secs_per_track;
1931	}
1932	lbasize = (u_int32_t)cgd->ident_data.lba_size_1 |
1933		  ((u_int32_t)cgd->ident_data.lba_size_2 << 16);
1934
1935	/* use the 28bit LBA size if valid or bigger than the CHS mapping */
1936	if (cgd->ident_data.cylinders == 16383 || dp->sectors < lbasize)
1937		dp->sectors = lbasize;
1938
1939	/* use the 48bit LBA size if valid */
1940	lbasize48 = ((u_int64_t)cgd->ident_data.lba_size48_1) |
1941		    ((u_int64_t)cgd->ident_data.lba_size48_2 << 16) |
1942		    ((u_int64_t)cgd->ident_data.lba_size48_3 << 32) |
1943		    ((u_int64_t)cgd->ident_data.lba_size48_4 << 48);
1944	if ((cgd->ident_data.support.command2 & ATA_SUPPORT_ADDRESS48) &&
1945	    lbasize48 > ATA_MAX_28BIT_LBA)
1946		dp->sectors = lbasize48;
1947}
1948
1949static void
1950adasendorderedtag(void *arg)
1951{
1952	struct ada_softc *softc = arg;
1953
1954	if (ada_send_ordered) {
1955		if (softc->outstanding_cmds > 0) {
1956			if ((softc->flags & ADA_FLAG_WAS_OTAG) == 0)
1957				softc->flags |= ADA_FLAG_NEED_OTAG;
1958			softc->flags &= ~ADA_FLAG_WAS_OTAG;
1959		}
1960	}
1961	/* Queue us up again */
1962	callout_reset(&softc->sendordered_c,
1963	    (ada_default_timeout * hz) / ADA_ORDEREDTAG_INTERVAL,
1964	    adasendorderedtag, softc);
1965}
1966
1967/*
1968 * Step through all ADA peripheral drivers, and if the device is still open,
1969 * sync the disk cache to physical media.
1970 */
1971static void
1972adaflush(void)
1973{
1974	struct cam_periph *periph;
1975	struct ada_softc *softc;
1976	union ccb *ccb;
1977	int error;
1978
1979	CAM_PERIPH_FOREACH(periph, &adadriver) {
1980		softc = (struct ada_softc *)periph->softc;
1981		if (SCHEDULER_STOPPED()) {
1982			/* If we paniced with the lock held, do not recurse. */
1983			if (!cam_periph_owned(periph) &&
1984			    (softc->flags & ADA_FLAG_OPEN)) {
1985				adadump(softc->disk, NULL, 0, 0, 0);
1986			}
1987			continue;
1988		}
1989		cam_periph_lock(periph);
1990		/*
1991		 * We only sync the cache if the drive is still open, and
1992		 * if the drive is capable of it..
1993		 */
1994		if (((softc->flags & ADA_FLAG_OPEN) == 0) ||
1995		    (softc->flags & ADA_FLAG_CAN_FLUSHCACHE) == 0) {
1996			cam_periph_unlock(periph);
1997			continue;
1998		}
1999
2000		ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2001		cam_fill_ataio(&ccb->ataio,
2002				    0,
2003				    adadone,
2004				    CAM_DIR_NONE,
2005				    0,
2006				    NULL,
2007				    0,
2008				    ada_default_timeout*1000);
2009		if (softc->flags & ADA_FLAG_CAN_48BIT)
2010			ata_48bit_cmd(&ccb->ataio, ATA_FLUSHCACHE48, 0, 0, 0);
2011		else
2012			ata_28bit_cmd(&ccb->ataio, ATA_FLUSHCACHE, 0, 0, 0);
2013
2014		error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2015		    /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2016		    softc->disk->d_devstat);
2017		if (error != 0)
2018			xpt_print(periph->path, "Synchronize cache failed\n");
2019		xpt_release_ccb(ccb);
2020		cam_periph_unlock(periph);
2021	}
2022}
2023
2024static void
2025adaspindown(uint8_t cmd, int flags)
2026{
2027	struct cam_periph *periph;
2028	struct ada_softc *softc;
2029	union ccb *ccb;
2030	int error;
2031
2032	CAM_PERIPH_FOREACH(periph, &adadriver) {
2033		/* If we paniced with lock held - not recurse here. */
2034		if (cam_periph_owned(periph))
2035			continue;
2036		cam_periph_lock(periph);
2037		softc = (struct ada_softc *)periph->softc;
2038		/*
2039		 * We only spin-down the drive if it is capable of it..
2040		 */
2041		if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2042			cam_periph_unlock(periph);
2043			continue;
2044		}
2045
2046		if (bootverbose)
2047			xpt_print(periph->path, "spin-down\n");
2048
2049		ccb = cam_periph_getccb(periph, CAM_PRIORITY_NORMAL);
2050		cam_fill_ataio(&ccb->ataio,
2051				    0,
2052				    adadone,
2053				    CAM_DIR_NONE | flags,
2054				    0,
2055				    NULL,
2056				    0,
2057				    ada_default_timeout*1000);
2058		ata_28bit_cmd(&ccb->ataio, cmd, 0, 0, 0);
2059
2060		error = cam_periph_runccb(ccb, adaerror, /*cam_flags*/0,
2061		    /*sense_flags*/ SF_NO_RECOVERY | SF_NO_RETRY,
2062		    softc->disk->d_devstat);
2063		if (error != 0)
2064			xpt_print(periph->path, "Spin-down disk failed\n");
2065		xpt_release_ccb(ccb);
2066		cam_periph_unlock(periph);
2067	}
2068}
2069
2070static void
2071adashutdown(void *arg, int howto)
2072{
2073
2074	adaflush();
2075	if (ada_spindown_shutdown != 0 &&
2076	    (howto & (RB_HALT | RB_POWEROFF)) != 0)
2077		adaspindown(ATA_STANDBY_IMMEDIATE, 0);
2078}
2079
2080static void
2081adasuspend(void *arg)
2082{
2083
2084	adaflush();
2085	if (ada_spindown_suspend != 0)
2086		adaspindown(ATA_SLEEP, CAM_DEV_QFREEZE);
2087}
2088
2089static void
2090adaresume(void *arg)
2091{
2092	struct cam_periph *periph;
2093	struct ada_softc *softc;
2094
2095	if (ada_spindown_suspend == 0)
2096		return;
2097
2098	CAM_PERIPH_FOREACH(periph, &adadriver) {
2099		cam_periph_lock(periph);
2100		softc = (struct ada_softc *)periph->softc;
2101		/*
2102		 * We only spin-down the drive if it is capable of it..
2103		 */
2104		if ((softc->flags & ADA_FLAG_CAN_POWERMGT) == 0) {
2105			cam_periph_unlock(periph);
2106			continue;
2107		}
2108
2109		if (bootverbose)
2110			xpt_print(periph->path, "resume\n");
2111
2112		/*
2113		 * Drop freeze taken due to CAM_DEV_QFREEZE flag set on
2114		 * sleep request.
2115		 */
2116		cam_release_devq(periph->path,
2117			 /*relsim_flags*/0,
2118			 /*openings*/0,
2119			 /*timeout*/0,
2120			 /*getcount_only*/0);
2121
2122		cam_periph_unlock(periph);
2123	}
2124}
2125
2126#endif /* _KERNEL */
2127