xref: /netbsd-src/sys/dev/scsipi/atapiconf.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: atapiconf.c,v 1.74 2007/12/09 20:28:22 jmcneill Exp $	*/
2 
3 /*
4  * Copyright (c) 1996, 2001 Manuel Bouyer.  All rights reserved.
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  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *	This product includes software developed by Manuel Bouyer.
17  * 4. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: atapiconf.c,v 1.74 2007/12/09 20:28:22 jmcneill Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/malloc.h>
38 #include <sys/device.h>
39 #include <sys/buf.h>
40 #include <sys/proc.h>
41 #include <sys/kthread.h>
42 
43 #include <dev/scsipi/scsipi_all.h>
44 #include <dev/scsipi/scsipiconf.h>
45 #include <dev/scsipi/atapiconf.h>
46 
47 #include "locators.h"
48 
49 #define SILENT_PRINTF(flags,string) if (!(flags & A_SILENT)) printf string
50 #define MAX_TARGET 1
51 
52 const struct scsipi_periphsw atapi_probe_periphsw = {
53 	NULL,
54 	NULL,
55 	NULL,
56 	NULL,
57 };
58 
59 static int	atapibusmatch(struct device *, struct cfdata *, void *);
60 static void	atapibusattach(struct device *, struct device *, void *);
61 static int	atapibusactivate(struct device *, enum devact);
62 static int	atapibusdetach(struct device *, int flags);
63 
64 static int	atapibussubmatch(struct device *, struct cfdata *,
65 				 const int *, void *);
66 
67 static int	atapi_probe_bus(struct atapibus_softc *, int);
68 
69 static int	atapibusprint(void *, const char *);
70 
71 CFATTACH_DECL(atapibus, sizeof(struct atapibus_softc),
72     atapibusmatch, atapibusattach, atapibusdetach, atapibusactivate);
73 
74 extern struct cfdriver atapibus_cd;
75 
76 static const struct scsi_quirk_inquiry_pattern atapi_quirk_patterns[] = {
77 	{{T_CDROM, T_REMOV,
78 	 "ALPS ELECTRIC CO.,LTD. DC544C", "", "SW03D"},	PQUIRK_NOTUR},
79 	{{T_CDROM, T_REMOV,
80 	 "CR-2801TE", "", "1.07"},		PQUIRK_NOSENSE},
81 	{{T_CDROM, T_REMOV,
82 	 "CREATIVECD3630E", "", "AC101"},	PQUIRK_NOSENSE},
83 	{{T_CDROM, T_REMOV,
84 	 "FX320S", "", "q01"},			PQUIRK_NOSENSE},
85 	{{T_CDROM, T_REMOV,
86 	 "GCD-R580B", "", "1.00"},		PQUIRK_LITTLETOC},
87 	{{T_CDROM, T_REMOV,
88 	 "HITACHI CDR-7730", "", "0008a"},      PQUIRK_NOSENSE},
89 	{{T_CDROM, T_REMOV,
90 	 "MATSHITA CR-574", "", "1.02"},	PQUIRK_NOCAPACITY},
91 	{{T_CDROM, T_REMOV,
92 	 "MATSHITA CR-574", "", "1.06"},	PQUIRK_NOCAPACITY},
93 	{{T_CDROM, T_REMOV,
94 	 "Memorex CRW-2642", "", "1.0g"},	PQUIRK_NOSENSE},
95 	{{T_CDROM, T_REMOV,
96 	 "NEC                 CD-ROM DRIVE:273", "", "4.21"}, PQUIRK_NOTUR},
97 	{{T_CDROM, T_REMOV,
98 	 "SANYO CRD-256P", "", "1.02"},		PQUIRK_NOCAPACITY},
99 	{{T_CDROM, T_REMOV,
100 	 "SANYO CRD-254P", "", "1.02"},		PQUIRK_NOCAPACITY},
101 	{{T_CDROM, T_REMOV,
102 	 "SANYO CRD-S54P", "", "1.08"},		PQUIRK_NOCAPACITY},
103 	{{T_CDROM, T_REMOV,
104 	 "CD-ROM  CDR-S1", "", "1.70"},		PQUIRK_NOCAPACITY}, /* Sanyo */
105 	{{T_CDROM, T_REMOV,
106 	 "CD-ROM  CDR-N16", "", "1.25"},	PQUIRK_NOCAPACITY}, /* Sanyo */
107 };
108 
109 int
110 atapiprint(void *aux, const char *pnp)
111 {
112 	if (pnp)
113 		aprint_normal("atapibus at %s", pnp);
114 	return (UNCONF);
115 }
116 
117 static int
118 atapibusmatch(struct device *parent, struct cfdata *cf,
119     void *aux)
120 {
121 	struct scsipi_channel *chan = aux;
122 
123 	if (chan == NULL)
124 		return (0);
125 
126 	if (chan->chan_bustype->bustype_type != SCSIPI_BUSTYPE_ATAPI)
127 		return (0);
128 
129 	return (1);
130 }
131 
132 static int
133 atapibussubmatch(struct device *parent, struct cfdata *cf,
134     const int *ldesc, void *aux)
135 {
136 	struct scsipibus_attach_args *sa = aux;
137 	struct scsipi_periph *periph = sa->sa_periph;
138 
139 	if (cf->cf_loc[ATAPIBUSCF_DRIVE] != ATAPIBUSCF_DRIVE_DEFAULT &&
140 	    cf->cf_loc[ATAPIBUSCF_DRIVE] != periph->periph_target)
141 		return (0);
142 	return (config_match(parent, cf, aux));
143 }
144 
145 static void
146 atapibusattach(struct device *parent, struct device *self, void *aux)
147 {
148 	struct atapibus_softc *sc = device_private(self);
149 	struct scsipi_channel *chan = aux;
150 
151 	sc->sc_channel = chan;
152 
153 	chan->chan_name = sc->sc_dev.dv_xname;
154 
155 	/* ATAPI has no LUNs. */
156 	chan->chan_nluns = 1;
157 	aprint_naive("\n");
158 	aprint_normal(": %d targets\n", chan->chan_ntargets);
159 
160 	/* Initialize the channel. */
161 	chan->chan_init_cb = NULL;
162 	chan->chan_init_cb_arg = NULL;
163 	scsipi_channel_init(chan);
164 
165 	if (!pmf_device_register(self, NULL, NULL))
166 		aprint_error_dev(self, "couldn't establish power handler\n");
167 
168 	/* Probe the bus for devices. */
169 	atapi_probe_bus(sc, -1);
170 }
171 
172 static int
173 atapibusactivate(struct device *self, enum devact act)
174 {
175 	struct atapibus_softc *sc = device_private(self);
176 	struct scsipi_channel *chan = sc->sc_channel;
177 	struct scsipi_periph *periph;
178 	int target, error = 0, s;
179 
180 	s = splbio();
181 	switch (act) {
182 	case DVACT_ACTIVATE:
183 		error = EOPNOTSUPP;
184 		break;
185 
186 	case DVACT_DEACTIVATE:
187 		for (target = 0; target < chan->chan_ntargets; target++) {
188 			periph = scsipi_lookup_periph(chan, target, 0);
189 			if (periph == NULL)
190 				continue;
191 			error = config_deactivate(periph->periph_dev);
192 			if (error)
193 				goto out;
194 		}
195 		break;
196 	}
197  out:
198 	splx(s);
199 	return (error);
200 }
201 
202 static int
203 atapibusdetach(struct device *self, int flags)
204 {
205 	struct atapibus_softc *sc = device_private(self);
206 	struct scsipi_channel *chan = sc->sc_channel;
207 	struct scsipi_periph *periph;
208 	int target, error;
209 
210 	/*
211 	 * Shut down the channel.
212 	 */
213 	scsipi_channel_shutdown(chan);
214 
215 	/*
216 	 * Now detach all of the periphs.
217 	 */
218 	for (target = 0; target < chan->chan_ntargets; target++) {
219 		periph = scsipi_lookup_periph(chan, target, 0);
220 		if (periph == NULL)
221 			continue;
222 		error = config_detach(periph->periph_dev, flags);
223 		if (error)
224 			return (error);
225 
226 		scsipi_remove_periph(chan, periph);
227 		free(periph, M_DEVBUF);
228 	}
229 	return (0);
230 }
231 
232 static int
233 atapi_probe_bus(struct atapibus_softc *sc, int target)
234 {
235 	struct scsipi_channel *chan = sc->sc_channel;
236 	int maxtarget, mintarget;
237 	int error;
238 	struct atapi_adapter *atapi_adapter;
239 
240 	if (target == -1) {
241 		maxtarget = 1;
242 		mintarget = 0;
243 	} else {
244 		if (target < 0 || target >= chan->chan_ntargets)
245 			return (ENXIO);
246 		maxtarget = mintarget = target;
247 	}
248 
249 	if ((error = scsipi_adapter_addref(chan->chan_adapter)) != 0)
250 		return (error);
251 	atapi_adapter = (struct atapi_adapter*)chan->chan_adapter;
252 	for (target = mintarget; target <= maxtarget; target++)
253 		atapi_adapter->atapi_probe_device(sc, target);
254 	scsipi_adapter_delref(chan->chan_adapter);
255 	return (0);
256 }
257 
258 void *
259 atapi_probe_device(struct atapibus_softc *sc, int target,
260     struct scsipi_periph *periph, struct scsipibus_attach_args *sa)
261 {
262 	struct scsipi_channel *chan = sc->sc_channel;
263 	const struct scsi_quirk_inquiry_pattern *finger;
264 	struct cfdata *cf;
265 	int priority, quirks;
266 
267 	finger = scsipi_inqmatch(
268 	    &sa->sa_inqbuf, (const void *)atapi_quirk_patterns,
269 	    sizeof(atapi_quirk_patterns) /
270 	        sizeof(atapi_quirk_patterns[0]),
271 	    sizeof(atapi_quirk_patterns[0]), &priority);
272 
273 	if (finger != NULL)
274 		quirks = finger->quirks;
275 	else
276 		quirks = 0;
277 
278 	/*
279 	 * Now apply any quirks from the table.
280 	 */
281 	periph->periph_quirks |= quirks;
282 
283 	if ((cf = config_search_ia(atapibussubmatch, &sc->sc_dev,
284 	    "atapibus", sa)) != 0) {
285 		scsipi_insert_periph(chan, periph);
286 		/*
287 		 * XXX Can't assign periph_dev here, because we'll
288 		 * XXX need it before config_attach() returns.  Must
289 		 * XXX assign it in periph driver.
290 		 */
291 		return config_attach(&sc->sc_dev, cf, sa,
292 		    atapibusprint);
293 	} else {
294 		atapibusprint(sa, sc->sc_dev.dv_xname);
295 		printf(" not configured\n");
296 		free(periph, M_DEVBUF);
297 		return NULL;
298 	}
299 }
300 
301 static int
302 atapibusprint(void *aux, const char *pnp)
303 {
304 	struct scsipibus_attach_args *sa = aux;
305 	struct scsipi_inquiry_pattern *inqbuf;
306 	const char *dtype;
307 
308 	if (pnp != NULL)
309 		aprint_normal("%s", pnp);
310 
311 	inqbuf = &sa->sa_inqbuf;
312 
313 	dtype = scsipi_dtype(inqbuf->type & SID_TYPE);
314 	aprint_normal(" drive %d: <%s, %s, %s> %s %s",
315 	    sa->sa_periph->periph_target, inqbuf->vendor,
316 	    inqbuf->product, inqbuf->revision, dtype,
317 	    inqbuf->removable ? "removable" : "fixed");
318 	return (UNCONF);
319 }
320