Home | History | Annotate | Line # | Download | only in ata
      1 /*	$NetBSD: ata_raid_via.c,v 1.11 2025/03/11 16:51:31 andvar Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2000,2001,2002 Sren Schmidt <sos (at) FreeBSD.org>
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer,
     12  *    without modification, immediately at the beginning of the file.
     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. The name of the author may not be used to endorse or promote products
     17  *    derived from this software without specific prior written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29  */
     30 
     31 /*
     32  * Support for parsing VIA V-RAID ATA RAID controller configuration blocks.
     33  *
     34  * Adapted to NetBSD by Tim Rightnour (garbled (at) netbsd.org)
     35  */
     36 
     37 #include <sys/cdefs.h>
     38 __KERNEL_RCSID(0, "$NetBSD: ata_raid_via.c,v 1.11 2025/03/11 16:51:31 andvar Exp $");
     39 
     40 #include <sys/param.h>
     41 #include <sys/buf.h>
     42 #include <sys/bufq.h>
     43 #include <sys/conf.h>
     44 #include <sys/device.h>
     45 #include <sys/disk.h>
     46 #include <sys/disklabel.h>
     47 #include <sys/fcntl.h>
     48 #include <sys/vnode.h>
     49 #include <sys/kauth.h>
     50 
     51 #include <miscfs/specfs/specdev.h>
     52 
     53 #include <dev/ata/atareg.h>
     54 #include <dev/ata/atavar.h>
     55 #include <dev/ata/wdvar.h>
     56 
     57 #include <dev/ata/ata_raidreg.h>
     58 #include <dev/ata/ata_raidvar.h>
     59 
     60 #ifdef ATA_RAID_DEBUG
     61 #define	DPRINTF(x)	printf x
     62 #else
     63 #define	DPRINTF(x)	/* nothing */
     64 #endif
     65 
     66 #ifdef ATA_RAID_DEBUG
     67 static const char *
     68 ata_raid_via_type(int type)
     69 {
     70 	static char buffer[16];
     71 
     72 	switch (type) {
     73 	case VIA_T_RAID0:   return "RAID0";
     74 	case VIA_T_RAID1:   return "RAID1";
     75 	case VIA_T_RAID5:   return "RAID5";
     76 	case VIA_T_RAID01:  return "RAID0+1";
     77 	case VIA_T_SPAN:    return "SPAN";
     78 	default:
     79 		snprintf(buffer, sizeof(buffer), "UNKNOWN 0x%02x", type);
     80 		return buffer;
     81 	}
     82 }
     83 
     84 static void
     85 ata_raid_via_print_info(struct via_raid_conf *info)
     86 {
     87 	int i;
     88 
     89 	printf("*************** ATA VIA Metadata ****************\n");
     90 	printf("magic               0x%02x\n", info->magic);
     91 	printf("dummy_0             0x%02x\n", info->dummy_0);
     92 	printf("type                %s\n",
     93 	    ata_raid_via_type(info->type & VIA_T_MASK));
     94 	printf("bootable            %d\n", info->type & VIA_T_BOOTABLE);
     95 	printf("unknown             %d\n", info->type & VIA_T_UNKNOWN);
     96 	printf("disk_index          0x%02x\n", info->disk_index);
     97 	printf("stripe_layout       0x%02x\n", info->stripe_layout);
     98 	printf(" stripe_disks       %d\n", info->stripe_layout & VIA_L_DISKS);
     99 	printf(" stripe_sectors     %d\n",
    100 	    0x08 << ((info->stripe_layout & VIA_L_MASK) >> VIA_L_SHIFT));
    101 	printf("disk_sectors        %ju\n", info->disk_sectors);
    102 	printf("disk_id             0x%08x\n", info->disk_id);
    103 	printf("DISK#   disk_id\n");
    104 	for (i = 0; i < 8; i++) {
    105 	if (info->disks[i])
    106 		printf("  %d    0x%08x\n", i, info->disks[i]);
    107 	}
    108 	printf("checksum            0x%02x\n", info->checksum);
    109 	printf("=================================================\n");
    110 }
    111 #endif
    112 
    113 int
    114 ata_raid_read_config_via(struct wd_softc *sc)
    115 {
    116 	struct dk_softc *dksc = &sc->sc_dksc;
    117 	struct via_raid_conf *info;
    118 	struct vnode *vp;
    119 	int bmajor, error;
    120 	dev_t dev;
    121 	uint32_t drive;
    122 	uint8_t checksum, checksum_alt, byte3, *ptr;
    123 	int count, disk;
    124 	struct ataraid_array_info *aai;
    125 	struct ataraid_disk_info *adi;
    126 
    127 	info = kmem_zalloc(sizeof(*info), KM_SLEEP);
    128 
    129 	bmajor = devsw_name2blk(dksc->sc_xname, NULL, 0);
    130 
    131 	/* Get a vnode for the raw partition of this disk. */
    132 	dev = MAKEDISKDEV(bmajor, device_unit(dksc->sc_dev), RAW_PART);
    133 	error = bdevvp(dev, &vp);
    134 	if (error)
    135 		goto out;
    136 
    137 	vn_lock(vp, LK_EXCLUSIVE | LK_RETRY);
    138 	error = VOP_OPEN(vp, FREAD, NOCRED);
    139 	if (error) {
    140 		vput(vp);
    141 		goto out;
    142 	}
    143 
    144 	error = ata_raid_config_block_rw(vp, VIA_LBA(sc), info,
    145 	    sizeof(*info), B_READ);
    146 	VOP_CLOSE(vp, FREAD, NOCRED);
    147 	vput(vp);
    148 	if (error) {
    149 		aprint_error_dev(dksc->sc_dev,
    150 		    "error %d reading VIA V-RAID config block\n", error);
    151 		goto out;
    152 	}
    153 
    154 #ifdef ATA_RAID_DEBUG
    155 	ata_raid_via_print_info(info);
    156 	printf("MAGIC == 0x%02x\n", info->magic);
    157 #endif
    158 
    159 	/* Check the signature. */
    160 	if (info->magic != VIA_MAGIC) {
    161 		DPRINTF(("%s: VIA V-RAID signature check failed\n",
    162 		    dksc->sc_xname));
    163 		error = ESRCH;
    164 		goto out;
    165 	}
    166 
    167 	/* calculate checksum and compare for valid */
    168 	for (byte3 = 0, checksum = 0, ptr = (uint8_t *)info, count = 0;
    169 	    count < 50; count++)
    170 		if (count == 3)
    171 			byte3 = *ptr++;
    172 		else
    173 			checksum += *ptr++;
    174 	checksum_alt = checksum + (byte3 & ~VIA_T_BOOTABLE);
    175 	checksum += byte3;
    176 	if (checksum != info->checksum && checksum_alt != info->checksum) {
    177 		DPRINTF(("%s: VIA V-RAID checksum failed 0x%02x != "
    178 		    "0x%02x or 0x%02x\n", dksc->sc_xname,
    179 		    info->checksum, checksum, checksum_alt));
    180 		error = ESRCH;
    181 		goto out;
    182 	}
    183 
    184 	/*
    185 	 * Lookup or allocate a new array info structure for
    186 	 * this array. Use the serial number of disk0 as the array#
    187 	 */
    188 	aai = ata_raid_get_array_info(ATA_RAID_TYPE_VIA, info->disks[0]);
    189 
    190 	aai->aai_status = AAI_S_READY;
    191 
    192 	switch (info->type & VIA_T_MASK) {
    193 	case VIA_T_RAID0:
    194 		aai->aai_level = AAI_L_RAID0;
    195 		aai->aai_width = info->stripe_layout & VIA_L_DISKS;
    196 		aai->aai_capacity = aai->aai_width * info->disk_sectors;
    197 		break;
    198 
    199 	case VIA_T_RAID1:
    200 		aai->aai_level = AAI_L_RAID1;
    201 		aai->aai_width = 1;
    202 		aai->aai_capacity = aai->aai_width * info->disk_sectors;
    203 		break;
    204 
    205 	case VIA_T_RAID5:
    206 		aai->aai_level = AAI_L_RAID5;
    207 		aai->aai_width = info->stripe_layout & VIA_L_DISKS;
    208 		aai->aai_capacity = (aai->aai_width - 1) * info->disk_sectors;
    209 		break;
    210 
    211 	case VIA_T_SPAN:
    212 		aai->aai_level = AAI_L_SPAN;
    213 		aai->aai_width = 1;
    214 		aai->aai_capacity += info->disk_sectors; /* XXX ??? */
    215 		break;
    216 
    217 	default:
    218 		aprint_error_dev(dksc->sc_dev,
    219 		    "unknown VIA V-RAID type 0x%02x\n", info->type);
    220 		error = EINVAL;
    221 		goto out;
    222 	}
    223 
    224 	aai->aai_type = ATA_RAID_TYPE_VIA;
    225 	/*
    226 	 * VIA V-RAID supports up to four drives in RAID 0 and JBOD
    227 	 * configurations and up to two drives in a RAID 1 configuration.
    228 	 */
    229 	for (count = 0, disk = 0; disk < 4; disk++)
    230 		if (info->disks[disk])
    231 			count++;
    232 	aai->aai_interleave =
    233 		0x08 << ((info->stripe_layout & VIA_L_MASK) >> VIA_L_SHIFT);
    234 	aai->aai_ndisks = count;
    235 	aai->aai_heads = 255;
    236 	aai->aai_sectors = 63;
    237 	aai->aai_cylinders = aai->aai_capacity / (63 * 255);
    238 	aai->aai_offset = 0;
    239 	aai->aai_reserved = 1;
    240 
    241 	/* XXX - bogus.  RAID1 shouldn't really have an interleave */
    242 	if (aai->aai_interleave == 0)
    243 		aai->aai_interleave = aai->aai_capacity;
    244 
    245 	/*
    246 	 * VIA V-RAID configuration blocks store the disk index as a value
    247 	 * incrementing by 0x04 (0x00, 0x04, 0x08, 0x0C).  Therefore, shift
    248 	 * the value left by 2 to obtain the disk number.
    249 	 */
    250 	drive = info->disk_index >> 2;
    251 	if (drive >= aai->aai_ndisks) {
    252 		aprint_error_dev(dksc->sc_dev,
    253 		    "drive number %d doesn't make sense within %d-disk "
    254 		    "array\n", drive, aai->aai_ndisks);
    255 		error = EINVAL;
    256 		goto out;
    257 	}
    258 
    259 	adi = &aai->aai_disks[drive];
    260 	adi->adi_dev = dksc->sc_dev;
    261 	adi->adi_status = ADI_S_ONLINE | ADI_S_ASSIGNED;
    262 	adi->adi_sectors = aai->aai_capacity;
    263 	adi->adi_compsize = info->disk_sectors;
    264 
    265 	error = 0;
    266 
    267  out:
    268 	kmem_free(info, sizeof(*info));
    269 	return (error);
    270 }
    271