Home | History | Annotate | Line # | Download | only in ofwboot
ofdev.c revision 1.21
      1 /*	$NetBSD: ofdev.c,v 1.21 2009/03/14 15:36:14 dsl Exp $	*/
      2 
      3 /*
      4  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
      5  * Copyright (C) 1995, 1996 TooLs GmbH.
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  * 3. All advertising materials mentioning features or use of this software
     17  *    must display the following acknowledgement:
     18  *	This product includes software developed by TooLs GmbH.
     19  * 4. The name of TooLs GmbH may not be used to endorse or promote products
     20  *    derived from this software without specific prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
     23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     25  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
     28  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     30  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     31  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 /*
     34  * Device I/O routines using Open Firmware
     35  */
     36 #include <sys/param.h>
     37 #include <sys/disklabel.h>
     38 #ifdef NETBOOT
     39 #include <netinet/in.h>
     40 #endif
     41 
     42 #include <lib/libsa/stand.h>
     43 #include <lib/libsa/ufs.h>
     44 #include <lib/libsa/cd9660.h>
     45 #ifdef NETBOOT
     46 #include <lib/libsa/nfs.h>
     47 #include <lib/libsa/tftp.h>
     48 #endif
     49 #include <lib/libkern/libkern.h>
     50 
     51 #include <dev/sun/disklabel.h>
     52 #include <dev/raidframe/raidframevar.h>
     53 
     54 #include <machine/promlib.h>
     55 
     56 #include "ofdev.h"
     57 #include "boot.h"
     58 
     59 extern char bootdev[];
     60 
     61 /*
     62  * This is ugly.  A path on a sparc machine is something like this:
     63  *
     64  *	[device] [-<options] [path] [-options] [otherstuff] [-<more options]
     65  *
     66  */
     67 
     68 char *
     69 filename(char *str, char *ppart)
     70 {
     71 	char *cp, *lp;
     72 	char savec;
     73 	int dhandle;
     74 	char devtype[16];
     75 
     76 	lp = str;
     77 	devtype[0] = 0;
     78 	*ppart = '\0';
     79 	for (cp = str; *cp; lp = cp) {
     80 		/* For each component of the path name... */
     81 		while (*++cp && *cp != '/');
     82 		savec = *cp;
     83 		*cp = 0;
     84 		/* ...look whether there is a device with this name */
     85 		dhandle = prom_finddevice(str);
     86 		DPRINTF(("filename: prom_finddevice(%s) returned %x\n",
     87 		       str, dhandle));
     88 		*cp = savec;
     89 		if (dhandle == -1) {
     90 			/*
     91 			 * if not, lp is the delimiter between device and
     92 			 * path.  if the last component was a block device.
     93 			 */
     94 			if (!strcmp(devtype, "block")) {
     95 				/* search for arguments */
     96 				DPRINTF(("filename: hunting for arguments "
     97 				       "in %s\n", lp));
     98 				for (cp = lp; ; ) {
     99 					cp--;
    100 					if (cp < str ||
    101 					    cp[0] == '/' ||
    102 					    (cp[0] == ' ' && (cp+1) != lp &&
    103 					     cp[1] == '-'))
    104 						break;
    105 				}
    106 				if (cp >= str && *cp == '-')
    107 					/* found arguments, make firmware
    108 					   ignore them */
    109 					*cp = 0;
    110 				for (cp = lp; *--cp && *cp != ','
    111 					&& *cp != ':';)
    112 						;
    113 				if (cp[0] == ':' && cp[1] >= 'a' &&
    114 				    cp[1] <= 'a' + MAXPARTITIONS) {
    115 					*ppart = cp[1];
    116 					cp[0] = '\0';
    117 				}
    118 			}
    119 			DPRINTF(("filename: found %s\n",lp));
    120 			return lp;
    121 		} else if (_prom_getprop(dhandle, "device_type", devtype,
    122 				sizeof devtype) < 0)
    123 			devtype[0] = 0;
    124 	}
    125 	DPRINTF(("filename: not found\n",lp));
    126 	return 0;
    127 }
    128 
    129 static int
    130 strategy(void *devdata, int rw, daddr_t blk, size_t size, void *buf, size_t *rsize)
    131 {
    132 	struct of_dev *dev = devdata;
    133 	u_quad_t pos;
    134 	int n;
    135 
    136 	if (rw != F_READ)
    137 		return EPERM;
    138 	if (dev->type != OFDEV_DISK)
    139 		panic("strategy");
    140 
    141 #ifdef NON_DEBUG
    142 	printf("strategy: block %lx, partition offset %lx, blksz %lx\n",
    143 	       (long)blk, (long)dev->partoff, (long)dev->bsize);
    144 	printf("strategy: seek position should be: %lx\n",
    145 	       (long)((blk + dev->partoff) * dev->bsize));
    146 #endif
    147 	pos = (u_quad_t)(blk + dev->partoff) * dev->bsize;
    148 
    149 	for (;;) {
    150 #ifdef NON_DEBUG
    151 		printf("strategy: seeking to %lx\n", (long)pos);
    152 #endif
    153 		if (prom_seek(dev->handle, pos) < 0)
    154 			break;
    155 #ifdef NON_DEBUG
    156 		printf("strategy: reading %lx at %p\n", (long)size, buf);
    157 #endif
    158 		n = prom_read(dev->handle, buf, size);
    159 		if (n == -2)
    160 			continue;
    161 		if (n < 0)
    162 			break;
    163 		*rsize = n;
    164 		return 0;
    165 	}
    166 	return EIO;
    167 }
    168 
    169 static int
    170 devclose(struct open_file *of)
    171 {
    172 	struct of_dev *op = of->f_devdata;
    173 
    174 #ifdef NETBOOT
    175 	if (op->type == OFDEV_NET)
    176 		net_close(op);
    177 #endif
    178 	prom_close(op->handle);
    179 	op->handle = -1;
    180 }
    181 
    182 static struct devsw ofdevsw[1] = {
    183 	"OpenFirmware",
    184 	strategy,
    185 	(int (*)(struct open_file *, ...))nodev,
    186 	devclose,
    187 	noioctl
    188 };
    189 int ndevs = sizeof ofdevsw / sizeof ofdevsw[0];
    190 
    191 #ifdef SPARC_BOOT_UFS
    192 static struct fs_ops file_system_ufs = FS_OPS(ufs);
    193 #endif
    194 #ifdef SPARC_BOOT_CD9660
    195 static struct fs_ops file_system_cd9660 = FS_OPS(cd9660);
    196 #endif
    197 #ifdef NETBOOT
    198 static struct fs_ops file_system_nfs = FS_OPS(nfs);
    199 static struct fs_ops file_system_tftp = FS_OPS(tftp);
    200 #endif
    201 
    202 struct fs_ops file_system[3];
    203 int nfsys;
    204 
    205 static struct of_dev ofdev = {
    206 	-1,
    207 };
    208 
    209 char opened_name[256];
    210 int floppyboot;
    211 
    212 static u_long
    213 get_long(const void *p)
    214 {
    215 	const unsigned char *cp = p;
    216 
    217 	return cp[0] | (cp[1] << 8) | (cp[2] << 16) | (cp[3] << 24);
    218 }
    219 /************************************************************************
    220  *
    221  * The rest of this was taken from arch/sparc64/scsi/sun_disklabel.c
    222  * and then substantially rewritten by Gordon W. Ross
    223  *
    224  ************************************************************************/
    225 
    226 /* What partition types to assume for Sun disklabels: */
    227 static u_char
    228 sun_fstypes[8] = {
    229 	FS_BSDFFS,	/* a */
    230 	FS_SWAP,	/* b */
    231 	FS_OTHER,	/* c - whole disk */
    232 	FS_BSDFFS,	/* d */
    233 	FS_BSDFFS,	/* e */
    234 	FS_BSDFFS,	/* f */
    235 	FS_BSDFFS,	/* g */
    236 	FS_BSDFFS,	/* h */
    237 };
    238 
    239 /*
    240  * Given a SunOS disk label, set lp to a BSD disk label.
    241  * Returns NULL on success, else an error string.
    242  *
    243  * The BSD label is cleared out before this is called.
    244  */
    245 static char *
    246 disklabel_sun_to_bsd(char *cp, struct disklabel *lp)
    247 {
    248 	struct sun_disklabel *sl;
    249 	struct partition *npp;
    250 	struct sun_dkpart *spp;
    251 	int i, secpercyl;
    252 	u_short cksum, *sp1, *sp2;
    253 
    254 	sl = (struct sun_disklabel *)cp;
    255 
    256 	/* Verify the XOR check. */
    257 	sp1 = (u_short *)sl;
    258 	sp2 = (u_short *)(sl + 1);
    259 	cksum = 0;
    260 	while (sp1 < sp2)
    261 		cksum ^= *sp1++;
    262 	if (cksum != 0)
    263 		return("SunOS disk label, bad checksum");
    264 
    265 	/* Format conversion. */
    266 	lp->d_magic = DISKMAGIC;
    267 	lp->d_magic2 = DISKMAGIC;
    268 	memcpy(lp->d_packname, sl->sl_text, sizeof(lp->d_packname));
    269 
    270 	lp->d_secsize = 512;
    271 	lp->d_nsectors   = sl->sl_nsectors;
    272 	lp->d_ntracks    = sl->sl_ntracks;
    273 	lp->d_ncylinders = sl->sl_ncylinders;
    274 
    275 	secpercyl = sl->sl_nsectors * sl->sl_ntracks;
    276 	lp->d_secpercyl  = secpercyl;
    277 	lp->d_secperunit = secpercyl * sl->sl_ncylinders;
    278 
    279 	lp->d_sparespercyl = sl->sl_sparespercyl;
    280 	lp->d_acylinders   = sl->sl_acylinders;
    281 	lp->d_rpm          = sl->sl_rpm;
    282 	lp->d_interleave   = sl->sl_interleave;
    283 
    284 	lp->d_npartitions = 8;
    285 	/* These are as defined in <ufs/ffs/fs.h> */
    286 	lp->d_bbsize = 8192;	/* XXX */
    287 	lp->d_sbsize = 8192;	/* XXX */
    288 
    289 	for (i = 0; i < 8; i++) {
    290 		spp = &sl->sl_part[i];
    291 		npp = &lp->d_partitions[i];
    292 		npp->p_offset = spp->sdkp_cyloffset * secpercyl;
    293 		npp->p_size = spp->sdkp_nsectors;
    294 		DPRINTF(("partition %d start %x size %x\n", i, (int)npp->p_offset, (int)npp->p_size));
    295 		if (npp->p_size == 0) {
    296 			npp->p_fstype = FS_UNUSED;
    297 		} else {
    298 			npp->p_fstype = sun_fstypes[i];
    299 			if (npp->p_fstype == FS_BSDFFS) {
    300 				/*
    301 				 * The sun label does not store the FFS fields,
    302 				 * so just set them with default values here.
    303 				 */
    304 				npp->p_fsize = 1024;
    305 				npp->p_frag = 8;
    306 				npp->p_cpg = 16;
    307 			}
    308 		}
    309 	}
    310 
    311 	lp->d_checksum = 0;
    312 	lp->d_checksum = dkcksum(lp);
    313 	DPRINTF(("disklabel_sun_to_bsd: success!\n"));
    314 	return (NULL);
    315 }
    316 
    317 /*
    318  * Find a valid disklabel.
    319  */
    320 static char *
    321 search_label(struct of_dev *devp, u_long off, char *buf,
    322 	     struct disklabel *lp, u_long off0)
    323 {
    324 	size_t read;
    325 	struct mbr_partition *p;
    326 	int i;
    327 	u_long poff;
    328 	static int recursion;
    329 
    330 	struct disklabel *dlp;
    331 	struct sun_disklabel *slp;
    332 	int error;
    333 
    334 	/* minimal requirements for archtypal disk label */
    335 	if (lp->d_secperunit == 0)
    336 		lp->d_secperunit = 0x1fffffff;
    337 	lp->d_npartitions = 1;
    338 	if (lp->d_partitions[0].p_size == 0)
    339 		lp->d_partitions[0].p_size = 0x1fffffff;
    340 	lp->d_partitions[0].p_offset = 0;
    341 
    342 	if (strategy(devp, F_READ, LABELSECTOR, DEV_BSIZE, buf, &read)
    343 	    || read != DEV_BSIZE)
    344 		return ("Cannot read label");
    345 	/* Check for a NetBSD disk label. */
    346 	dlp = (struct disklabel *) (buf + LABELOFFSET);
    347 	if (dlp->d_magic == DISKMAGIC) {
    348 		if (dkcksum(dlp))
    349 			return ("NetBSD disk label corrupted");
    350 		*lp = *dlp;
    351 		DPRINTF(("search_label: found NetBSD label\n"));
    352 		return (NULL);
    353 	}
    354 
    355 	/* Check for a Sun disk label (for PROM compatibility). */
    356 	slp = (struct sun_disklabel *) buf;
    357 	if (slp->sl_magic == SUN_DKMAGIC)
    358 		return (disklabel_sun_to_bsd(buf, lp));
    359 
    360 
    361 	bzero(buf, sizeof(buf));
    362 	return ("no disk label");
    363 }
    364 
    365 int
    366 devopen(struct open_file *of, const char *name, char **file)
    367 {
    368 	char *cp;
    369 	char partition;
    370 	char fname[256], devname[256];
    371 	union {
    372 		char buf[DEV_BSIZE];
    373 		struct disklabel label;
    374 	} b;
    375 	struct disklabel label;
    376 	int handle, part, try = 0;
    377 	size_t read;
    378 	char *errmsg = NULL, *pp, savedpart = 0;
    379 	int error = 0;
    380 
    381 	if (ofdev.handle != -1)
    382 		panic("devopen");
    383 	if (of->f_flags != F_READ)
    384 		return EPERM;
    385 	DPRINTF(("devopen: you want %s\n", name));
    386 	strcpy(fname, name);
    387 	cp = filename(fname, &partition);
    388 	if (cp) {
    389 		strcpy(b.buf, cp);
    390 		*cp = 0;
    391 	}
    392 	if (!cp || !b.buf[0])
    393 		strcpy(b.buf, DEFAULT_KERNEL);
    394 	if (!*fname)
    395 		strcpy(fname, bootdev);
    396 	strcpy(opened_name, fname);
    397 	if (partition) {
    398 		cp = opened_name + strlen(opened_name);
    399 		*cp++ = ':';
    400 		*cp++ = partition;
    401 		*cp = 0;
    402 	}
    403 	*file = opened_name + strlen(opened_name);
    404 	if (b.buf[0] != '/')
    405 		strcat(opened_name, "/");
    406 	strcat(opened_name, b.buf);
    407 	DPRINTF(("devopen: trying %s\n", fname));
    408 	if ((handle = prom_finddevice(fname)) == -1)
    409 		return ENOENT;
    410 	DPRINTF(("devopen: found %s\n", fname));
    411 	if (_prom_getprop(handle, "name", b.buf, sizeof b.buf) < 0)
    412 		return ENXIO;
    413 	DPRINTF(("devopen: %s is called %s\n", fname, b.buf));
    414 	floppyboot = !strcmp(b.buf, "floppy");
    415 	if (_prom_getprop(handle, "device_type", b.buf, sizeof b.buf) < 0)
    416 		return ENXIO;
    417 	DPRINTF(("devopen: %s is a %s device\n", fname, b.buf));
    418 	if (!strcmp(b.buf, "block")) {
    419 		pp = strrchr(fname, ':');
    420 		if (pp && pp[1] >= 'a' && pp[1] <= 'f' && pp[2] == 0) {
    421 			savedpart = pp[1];
    422 		} else {
    423 			savedpart = 'a';
    424 			handle = prom_open(fname);
    425 			if (handle != -1) {
    426 				OF_instance_to_path(handle, devname,
    427 				    sizeof(devname));
    428 				DPRINTF(("real path: %s\n", devname));
    429 				prom_close(handle);
    430 				pp = devname + strlen(devname);
    431 				if (pp > devname + 3) pp -= 2;
    432 				if (pp[0] == ':')
    433 					savedpart = pp[1];
    434 			}
    435 			pp = fname + strlen(fname);
    436 			pp[0] = ':';
    437 			pp[2] = '\0';
    438 		}
    439 		pp[1] = 'c';
    440 		DPRINTF(("devopen: replacing by whole disk device %s\n",
    441 		    fname));
    442 		if (savedpart)
    443 			partition = savedpart;
    444 	}
    445 
    446 open_again:
    447 	DPRINTF(("devopen: opening %s\n", fname));
    448 	if ((handle = prom_open(fname)) == -1) {
    449 		DPRINTF(("devopen: open of %s failed\n", fname));
    450 		if (pp && savedpart) {
    451 			if (try == 0) {
    452 				pp[0] = '\0';
    453 				try = 1;
    454 			} else {
    455 				pp[0] = ':';
    456 				pp[1] = savedpart;
    457 				pp = NULL;
    458 				savedpart = '\0';
    459 			}
    460 			goto open_again;
    461 		}
    462 		return ENXIO;
    463 	}
    464 	DPRINTF(("devopen: %s is now open\n", fname));
    465 	bzero(&ofdev, sizeof ofdev);
    466 	ofdev.handle = handle;
    467 	if (!strcmp(b.buf, "block")) {
    468 		ofdev.type = OFDEV_DISK;
    469 		ofdev.bsize = DEV_BSIZE;
    470 		/* First try to find a disklabel without MBR partitions */
    471 		DPRINTF(("devopen: trying to read disklabel\n"));
    472 		if (strategy(&ofdev, F_READ,
    473 			     LABELSECTOR, DEV_BSIZE, b.buf, &read) != 0
    474 		    || read != DEV_BSIZE
    475 		    || (errmsg = getdisklabel(b.buf, &label))) {
    476 			if (errmsg) printf("devopen: getdisklabel returned %s\n", errmsg);
    477 			/* Else try MBR partitions */
    478 			errmsg = search_label(&ofdev, 0, b.buf, &label, 0);
    479 			if (errmsg) {
    480 				printf("devopen: search_label returned %s\n", errmsg);
    481 				error = ERDLAB;
    482 			}
    483 			if (error && error != ERDLAB)
    484 				goto bad;
    485 		}
    486 
    487 		if (error == ERDLAB) {
    488 			/* No, label, just use complete disk */
    489 			ofdev.partoff = 0;
    490 			if (pp && savedpart) {
    491 				pp[1] = savedpart;
    492 				prom_close(handle);
    493 				if ((handle = prom_open(fname)) == -1) {
    494 					DPRINTF(("devopen: open of %s failed\n",
    495 						fname));
    496 					return ENXIO;
    497 				}
    498 				ofdev.handle = handle;
    499 				DPRINTF(("devopen: back to original device %s\n",
    500 					fname));
    501 			}
    502 		} else {
    503 			part = partition ? partition - 'a' : 0;
    504 			ofdev.partoff = label.d_partitions[part].p_offset;
    505 			DPRINTF(("devopen: setting partition %d offset %x\n",
    506 			       part, ofdev.partoff));
    507 			if (label.d_partitions[part].p_fstype == FS_RAID) {
    508 				ofdev.partoff += RF_PROTECTED_SECTORS;
    509 				DPRINTF(("devopen: found RAID partition, "
    510 				    "adjusting offset to %x\n", ofdev.partoff));
    511 			}
    512 		}
    513 
    514 		nfsys = 0;
    515 		of->f_dev = ofdevsw;
    516 		of->f_devdata = &ofdev;
    517 #ifdef SPARC_BOOT_UFS
    518 		bcopy(&file_system_ufs, &file_system[nfsys++], sizeof file_system[0]);
    519 #endif
    520 #ifdef SPARC_BOOT_CD9660
    521 		bcopy(&file_system_cd9660, &file_system[nfsys++],
    522 		    sizeof file_system[0]);
    523 #endif
    524 		DPRINTF(("devopen: return 0\n"));
    525 		return 0;
    526 	}
    527 #ifdef NETBOOT
    528 	if (!strcmp(b.buf, "network")) {
    529 		if (error = net_open(&ofdev))
    530 			goto bad;
    531 
    532 		ofdev.type = OFDEV_NET;
    533 		of->f_dev = ofdevsw;
    534 		of->f_devdata = NULL;
    535 
    536 		if (!strncmp(*file,"/tftp:",6)) {
    537 			*file += 6;
    538 			bcopy(&file_system_tftp, &file_system[0], sizeof file_system[0]);
    539 			if (net_tftp_bootp(&of->f_devdata)) {
    540 				net_close(&ofdev);
    541 				goto bad;
    542 			}
    543 		} else {
    544 			bcopy(&file_system_nfs, &file_system[0], sizeof file_system[0]);
    545 			if (error = net_mountroot()) {
    546 				net_close(&ofdev);
    547 				goto bad;
    548 			}
    549 		}
    550 		nfsys = 1;
    551 		return 0;
    552 	}
    553 #endif
    554 	error = EFTYPE;
    555 bad:
    556 	DPRINTF(("devopen: error %d, cannot open device\n", error));
    557 	prom_close(handle);
    558 	ofdev.handle = -1;
    559 	return error;
    560 }
    561