xref: /netbsd-src/sys/dev/scsipi/atapiconf.c (revision dc306354b0b29af51801a7632f1e95265a68cd81)
1 /*	$NetBSD: atapiconf.c,v 1.19 1998/12/21 21:40:12 leo Exp $	*/
2 
3 /*
4  * Copyright (c) 1996 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/types.h>
33 #include <sys/param.h>
34 #include <sys/systm.h>
35 #include <sys/malloc.h>
36 #include <sys/device.h>
37 #include <sys/buf.h>
38 #include <sys/proc.h>
39 
40 #include <dev/ata/atareg.h>
41 #include <dev/ata/atavar.h>
42 #include <dev/scsipi/scsipi_all.h>
43 #include <dev/scsipi/atapi_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 
51 struct atapibus_softc {
52 	struct device sc_dev;
53 	struct scsipi_link *adapter_link;	/* proto supplied by adapter */
54 	struct scsipi_link **sc_link;		/* dynamically allocated */
55 	struct ata_drive_datas *sc_drvs;	/* array supplied by adapter */
56 };
57 
58 int	atapibusmatch __P((struct device *, struct cfdata *, void *));
59 int	atapibussubmatch __P((struct device *, struct cfdata *, void *));
60 void	atapibusattach __P((struct device *, struct device *, void *));
61 int	atapiprint __P((void *, const char *));
62 
63 int	atapi_probe_bus __P((int, int));
64 void	atapi_probedev __P((struct atapibus_softc *, int ));
65 
66 struct cfattach atapibus_ca = {
67 	sizeof(struct atapibus_softc), atapibusmatch, atapibusattach
68 };
69 
70 extern struct cfdriver atapibus_cd;
71 
72 int atapibusprint __P((void *, const char *));
73 
74 struct scsi_quirk_inquiry_pattern atapi_quirk_patterns[] = {
75 	{{T_CDROM, T_REMOV,
76 	 "GCD-R580B", "", "1.00"},                ADEV_LITTLETOC}, /* Goldstar */
77 	{{T_CDROM, T_REMOV,
78 	 "SANYO CRD-256P", "", "1.02"},           ADEV_NOCAPACITY},
79 	{{T_CDROM, T_REMOV,
80 	 "SANYO CRD-254P", "", "1.02"},           ADEV_NOCAPACITY},
81 	{{T_CDROM, T_REMOV,
82 	 "SANYO CRD-S54P", "", "1.08"},           ADEV_NOCAPACITY},
83 	{{T_CDROM, T_REMOV,
84 	 "CD-ROM  CDR-S1", "", "1.70"},           ADEV_NOCAPACITY}, /* Sanyo */
85 	{{T_CDROM, T_REMOV,
86 	 "CD-ROM  CDR-N16", "", "1.25"},          ADEV_NOCAPACITY}, /* Sanyo */
87 	{{T_CDROM, T_REMOV,
88 	 "UJDCD8730", "", "1.14"},                ADEV_NODOORLOCK}, /* Acer */
89 	{{T_CDROM, T_REMOV,
90 	 "ALPS ELECTRIC CO.,LTD. DC544C", "", "SW03D"}, ADEV_NOTUR},
91 	{{T_CDROM, T_REMOV,
92 	 "NEC                 CD-ROM DRIVE:273", "", "4.21"}, ADEV_NOTUR},
93 	{{T_CDROM, T_REMOV,
94 	 "MATSHITA CR-574", "", "1.06"},          ADEV_NOCAPACITY},
95 	{{T_CDROM, T_REMOV,
96 	 "MATSHITA CR-574", "", "1.02"},          ADEV_NOCAPACITY},
97 	{{T_CDROM, T_REMOV,
98 	 "FX320S", "", "q01"},          	ADEV_NOSENSE},
99 };
100 
101 int
102 atapibusmatch(parent, cf, aux)
103 	struct device *parent;
104 	struct cfdata *cf;
105 	void *aux;
106 {
107 	struct ata_atapi_attach *aa_link = aux;
108 
109 	if (aa_link == NULL)
110 		return (0);
111 	if (aa_link->aa_type != T_ATAPI)
112 		return (0);
113 	if (cf->cf_loc[ATAPICF_CHANNEL] != aa_link->aa_channel &&
114 	    cf->cf_loc[ATAPICF_CHANNEL] != ATAPICF_CHANNEL_DEFAULT)
115 	    return 0;
116 	return (1);
117 }
118 
119 int
120 atapibussubmatch(parent, cf, aux)
121 	struct device *parent;
122 	struct cfdata *cf;
123 	void *aux;
124 {
125 	struct scsipibus_attach_args *sa = aux;
126 	struct scsipi_link *sc_link = sa->sa_sc_link;
127 
128 	if (cf->cf_loc[ATAPIBUSCF_DRIVE] != ATAPIBUSCF_DRIVE_DEFAULT &&
129 	    cf->cf_loc[ATAPIBUSCF_DRIVE] != sc_link->scsipi_atapi.drive)
130 		return (0);
131 	return ((*cf->cf_attach->ca_match)(parent, cf, aux));
132 }
133 
134 #if 0
135 void
136 atapi_fixquirk(sc_link)
137 	struct scsipi_link *ad_link;
138 {
139 	struct ataparams *id = &ad_link->id;
140 	struct atapi_quirk_inquiry_pattern *quirk;
141 
142 	/*
143 	 * Clean up the model name, serial and revision numbers.
144 	 */
145 	btrim(id->model, sizeof(id->model));
146 	btrim(id->serial_number, sizeof(id->serial_number));
147 	btrim(id->firmware_revision, sizeof(id->firmware_revision));
148 }
149 #endif
150 
151 void
152 atapibusattach(parent, self, aux)
153 	struct device *parent, *self;
154 	void *aux;
155 {
156 	struct atapibus_softc *sc_ab = (struct atapibus_softc *)self;
157 	struct ata_atapi_attach *aa_link = aux;
158 	struct scsipi_link *sc_link_proto;
159 	int nbytes;
160 
161 	printf("\n");
162 
163 	/* Initialize shared data. */
164 	scsipi_init();
165 
166 	sc_link_proto = malloc(sizeof(struct scsipi_link),
167 	    M_DEVBUF, M_NOWAIT);
168 	if (sc_link_proto == NULL)
169 	    printf("atapibusattach : can't allocate scsipi link proto\n");
170 	memset(sc_link_proto, 0, sizeof(struct scsipi_link));
171 
172 	sc_link_proto->type = BUS_ATAPI;
173 	sc_link_proto->openings = aa_link->aa_openings;
174 	sc_link_proto->scsipi_atapi.channel = aa_link->aa_channel;
175 	sc_link_proto->adapter_softc = parent;
176 	sc_link_proto->adapter = aa_link->aa_bus_private;
177 	sc_link_proto->scsipi_atapi.atapibus = sc_ab->sc_dev.dv_unit;
178 	sc_link_proto->scsipi_cmd = atapi_scsipi_cmd;
179 	sc_link_proto->scsipi_interpret_sense = atapi_interpret_sense;
180 	sc_link_proto->sc_print_addr = atapi_print_addr;
181 
182 
183 	sc_ab->adapter_link = sc_link_proto;
184 	sc_ab->sc_drvs = aa_link->aa_drv_data;
185 
186 	nbytes = 2 * sizeof(struct scsipi_link **);
187 	sc_ab->sc_link = (struct scsipi_link **)malloc(nbytes, M_DEVBUF,
188 	    M_NOWAIT);
189 	if (sc_ab->sc_link == NULL)
190 		panic("scsibusattach: can't allocate target links");
191 	memset(sc_ab->sc_link, 0, nbytes);
192 	atapi_probe_bus(sc_ab->sc_dev.dv_unit, -1);
193 }
194 
195 int
196 atapi_probe_bus(bus, target)
197 	int bus, target;
198 {
199 	int maxtarget, mintarget;
200 	struct atapibus_softc *atapi;
201 	int error;
202 
203 	if (bus < 0 || bus >= atapibus_cd.cd_ndevs)
204 		return (ENXIO);
205 	atapi = atapibus_cd.cd_devs[bus];
206 	if (atapi == NULL)
207 		return (ENXIO);
208 
209 	if (target == -1) {
210 		maxtarget = 1;
211 		mintarget = 0;
212 	} else {
213 		if (target < 0 || target > 1)
214 			return (ENXIO);
215 		maxtarget = mintarget = target;
216 	}
217 	if ((error = scsipi_adapter_addref(atapi->adapter_link)) != 0)
218 		return (error);
219 	for (target = mintarget; target <= maxtarget; target++)
220 		atapi_probedev(atapi, target);
221 	scsipi_adapter_delref(atapi->adapter_link);
222 	return (0);
223 }
224 
225 void
226 atapi_probedev(atapi, target)
227 	struct atapibus_softc *atapi;
228 	int target;
229 {
230 	struct scsipi_link *sc_link;
231 	struct scsipibus_attach_args sa;
232 	struct ataparams ids;
233 	struct ataparams *id = &ids;
234 	struct ata_drive_datas *drvp = &atapi->sc_drvs[target];
235 	struct cfdata *cf;
236 	struct scsi_quirk_inquiry_pattern *finger;
237 	int priority;
238 	char serial_number[21], model[41], firmware_revision[9];
239 
240 	/* skip if already attached */
241 	if (atapi->sc_link[target])
242 		return;
243 
244 	if (wdc_atapi_get_params(atapi->adapter_link, target,
245 	    SCSI_POLL|SCSI_NOSLEEP, id) == COMPLETE) {
246 #ifdef ATAPI_DEBUG_PROBE
247 		printf("%s drive %d: cmdsz 0x%x drqtype 0x%x\n",
248 		    atapi->sc_dev.dv_xname, target,
249 		    id->atap_config & ATAPI_CFG_CMD_MASK,
250 		    id->atap_config & ATAPI_CFG_DRQ_MASK);
251 #endif
252 		/*
253 		 * Allocate a device link and try and attach
254 		 * a driver to this device.  If we fail, free
255 		 * the link.
256 		 */
257 		sc_link = malloc(sizeof(*sc_link), M_DEVBUF, M_NOWAIT);
258 		if (sc_link == NULL) {
259 			printf("%s: can't allocate link for drive %d\n",
260 			    atapi->sc_dev.dv_xname, target);
261 			return;
262 		}
263 		/* Fill in link. */
264 		*sc_link = *atapi->adapter_link;
265 		sc_link->scsipi_atapi.drive = target;
266 		sc_link->device = NULL;
267 		TAILQ_INIT(&sc_link->pending_xfers);
268 #if defined(SCSIDEBUG) && DEBUGTYPE == BUS_ATAPI
269 		if (DEBUGTARGET == -1 || target == DEBUGTARGET)
270 			sc_link->flags |= DEBUGLEVEL;
271 #endif /* SCSIDEBUG */
272 		if ((id->atap_config & ATAPI_CFG_CMD_MASK) == ATAPI_CFG_CMD_16)
273 			sc_link->scsipi_atapi.cap |= ACAP_LEN;
274 		sc_link->scsipi_atapi.cap |=
275 		    (id->atap_config & ATAPI_CFG_DRQ_MASK);
276 		sa.sa_sc_link = sc_link;
277 		sa.sa_inqbuf.type =  ATAPI_CFG_TYPE(id->atap_config);
278 		sa.sa_inqbuf.removable =
279 		    id->atap_config & ATAPI_CFG_REMOV ? T_REMOV : T_FIXED;
280 		if (sa.sa_inqbuf.removable)
281 			sc_link->flags |= SDEV_REMOVABLE;
282 		scsipi_strvis(model, 40, id->atap_model, 40);
283 		scsipi_strvis(serial_number, 20, id->atap_serial, 20);
284 		scsipi_strvis(firmware_revision, 8, id->atap_revision, 8);
285 		sa.sa_inqbuf.vendor = model;
286 		sa.sa_inqbuf.product = serial_number;
287 		sa.sa_inqbuf.revision = firmware_revision;
288 
289 		finger = (struct scsi_quirk_inquiry_pattern *)scsipi_inqmatch(
290 		    &sa.sa_inqbuf, (caddr_t)atapi_quirk_patterns,
291 		    sizeof(atapi_quirk_patterns) /
292 		        sizeof(atapi_quirk_patterns[0]),
293 		    sizeof(atapi_quirk_patterns[0]), &priority);
294 		if (priority != 0)
295 			sc_link->quirks |= finger->quirks;
296 
297 		if ((cf = config_search(atapibussubmatch, &atapi->sc_dev,
298 		    &sa)) != 0) {
299 			atapi->sc_link[target] = sc_link;
300 			drvp->drv_softc = config_attach(&atapi->sc_dev, cf,
301 			    &sa, atapibusprint);
302 			wdc_probe_caps(drvp);
303 			return;
304 		} else {
305 			atapibusprint(&sa, atapi->sc_dev.dv_xname);
306 			printf(" not configured\n");
307 			free(sc_link, M_DEVBUF);
308 			return;
309 		}
310 	}
311 }
312 
313 int
314 atapibusprint(aux, pnp)
315 	void *aux;
316 	const char *pnp;
317 {
318 	struct scsipibus_attach_args *sa = aux;
319 	struct scsipi_inquiry_pattern *inqbuf;
320 	char *dtype;
321 
322 	if (pnp != NULL)
323 		printf("%s", pnp);
324 
325 	inqbuf = &sa->sa_inqbuf;
326 
327 	dtype = scsipi_dtype(inqbuf->type & SID_TYPE);
328 	printf(" drive %d: <%s, %s, %s> type %d %s %s",
329 	    sa->sa_sc_link->scsipi_atapi.drive,inqbuf->vendor,
330 	    inqbuf->product, inqbuf->revision, inqbuf->type, dtype,
331 	    inqbuf->removable ? "removable" : "fixed");
332 	return (UNCONF);
333 }
334