root/sys/arch/arm/arm/disksubr.c
/*      $NetBSD: disksubr.c,v 1.30 2026/07/15 06:55:57 martin Exp $     */

/*
 * Copyright (c) 1998 Christopher G. Demetriou.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Christopher G. Demetriou
 *      for the NetBSD Project.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Copyright (c) 1982, 1986, 1988 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      from: @(#)ufs_disksubr.c        7.16 (Berkeley) 5/4/91
 */

/*
 * Copyright (c) 1995 Mark Brinicombe
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      from: @(#)ufs_disksubr.c        7.16 (Berkeley) 5/4/91
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: disksubr.c,v 1.30 2026/07/15 06:55:57 martin Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/buf.h>
#include <sys/disklabel.h>
#include <sys/syslog.h>
#include <sys/device.h>
#include <sys/disk.h>

/*
 * Attempt to read a disk label from a device
 * using the indicated strategy routine.
 * The label must be partly set up before this:
 * secpercyl, secsize and anything required for a block i/o read
 * operation in the driver's strategy/start routines
 * must be filled in before calling us.
 *
 * If dos partition table requested, attempt to load it and
 * find disklabel inside a DOS partition. Also, if bad block
 * table needed, attempt to extract it as well. Return buffer
 * for use in signalling errors if requested.
 *
 * Returns null on success and an error string on failure.
 */

const char *
readdisklabel(dev_t dev, void (*strat)(struct buf *),
                struct disklabel *lp, struct cpu_disklabel *osdep)
{
        struct buf *bp;
        struct disklabel *dlp;
        const char *msg = NULL;
        int cyl, netbsdpartoff;

        /* minimal requirements for archetypal disk label */

        if (lp->d_secsize == 0)
                lp->d_secsize = DEV_BSIZE;

        if (lp->d_secperunit == 0)
                lp->d_secperunit = 0x1fffffff;

        if (lp->d_npartitions < RAW_PART + 1)
              lp->d_npartitions = RAW_PART + 1;

        if (lp->d_partitions[RAW_PART].p_size == 0) {
                lp->d_partitions[RAW_PART].p_fstype = FS_UNUSED; 
                lp->d_partitions[RAW_PART].p_offset = 0; 
                lp->d_partitions[RAW_PART].p_size = 0x1fffffff;
        }
        /*
         * Set partition 'a' to be the whole disk.
         * Cleared if we find a netbsd label.
         */
        lp->d_partitions[0].p_size = lp->d_partitions[RAW_PART].p_size;
        lp->d_partitions[0].p_fstype = FS_BSDFFS;

        /* obtain buffer to probe drive with */
    
        bp = geteblk((int)lp->d_secsize);
        
        /* request no partition relocation by driver on I/O operations */

        bp->b_dev = dev;

        /* do netbsd partitions in the process of getting disklabel? */

        netbsdpartoff = 0;
        cyl = LABELSECTOR / lp->d_secpercyl;

        if (osdep) {
                if (filecore_label_read(dev, strat,lp, osdep, &msg, &cyl,
                      &netbsdpartoff) ||
                    mbr_label_read(dev, strat, lp, osdep, &msg, &cyl,
                      &netbsdpartoff)) {
                        if (msg != NULL)
                                goto done;
                } else {
                        /*
                         * We didn't find anything we like; NetBSD native.
                         * netbsdpartoff and cyl should be unchanged.
                         */
                        KASSERT(netbsdpartoff == 0);
                        KASSERT(cyl == (LABELSECTOR / lp->d_secpercyl));
                }
        }

        /* next, dig out disk label */

        bp->b_blkno = netbsdpartoff + LABELSECTOR;
        bp->b_cylinder = bp->b_blkno / lp->d_secpercyl;
        bp->b_bcount = lp->d_secsize;
        bp->b_flags |= B_READ;
        (*strat)(bp);

        /* if successful, locate disk label within block and validate */

        if (biowait(bp)) {
                msg = "disk label I/O error";
                goto done;
        }
        for (dlp = (struct disklabel *)bp->b_data;
            dlp <= (struct disklabel *)((char *)bp->b_data + lp->d_secsize
                - sizeof(*dlp));
            dlp = (struct disklabel *)((char *)dlp + sizeof(long))) {
                if (dlp->d_magic != DISKMAGIC || dlp->d_magic2 != DISKMAGIC) {
                        continue;
                } else if (dlp->d_npartitions > MAXPARTITIONS ||
                           dkcksum(dlp) != 0)
                        msg = "disk label corrupted";
                else {
                        *lp = *dlp;
                        msg = NULL;
                        break;
                }
        }

done:
        brelse(bp, 0);
        return (msg);
}


/*
 * Write disk label back to device after modification.
 */
 
int
writedisklabel(dev_t dev, void (*strat)(struct buf *),
        struct disklabel *lp, struct cpu_disklabel *osdep)
{
        struct buf *bp;
        struct disklabel *dlp;
        int cyl, netbsdpartoff;
        int error = 0, rv;

        /* get a buffer and initialize it */

        bp = geteblk((int)lp->d_secsize);
        bp->b_dev = dev;

        /* do netbsd partitions in the process of getting disklabel? */

        netbsdpartoff = 0;
        cyl = LABELSECTOR / lp->d_secpercyl;

        if (osdep) {
                if ((rv = filecore_label_locate(dev, strat,lp, osdep, &cyl,
                      &netbsdpartoff)) != 0 ||
                    (rv = mbr_label_locate(dev, strat, lp, osdep, &cyl,
                      &netbsdpartoff)) != 0) {
                        if (rv > 0)
                            goto done;
                } else {
                        /*
                         * We didn't find anything we like; NetBSD native.
                         * netbsdpartoff and cyl should be unchanged.
                         */
                        KASSERT(netbsdpartoff == 0);
                        KASSERT(cyl == (LABELSECTOR / lp->d_secpercyl));
                } 
        }

        /* writelabel: */

#ifdef DEBUG_LABEL
        printf("%s: Reading disklabel addr=%08x\n", __func__,
             netbsdpartoff * DEV_BSIZE);
#endif

        /* next, dig out disk label */

        bp->b_blkno = netbsdpartoff + LABELSECTOR;
        bp->b_cylinder = cyl;
        bp->b_bcount = lp->d_secsize;
        bp->b_oflags &= ~(BO_DONE);
        bp->b_flags |= B_READ;
        (*strat)(bp);

        /* if successful, locate disk label within block and validate */

        if ((error = biowait(bp)))
                goto done;
        for (dlp = (struct disklabel *)bp->b_data;
            dlp <= (struct disklabel *)((char *)bp->b_data + lp->d_secsize
                - sizeof(*dlp));
            dlp = (struct disklabel *)((char *)dlp + sizeof(long))) {
                if (dlp->d_magic == DISKMAGIC && dlp->d_magic2 == DISKMAGIC &&
                    dkcksum(dlp) == 0) {
                        *dlp = *lp;
                        bp->b_flags &= ~(B_READ);
                        bp->b_oflags &= ~(BO_DONE);
                        bp->b_flags |= B_WRITE;
                        (*strat)(bp);
                        error = biowait(bp);
                        goto done;
                }
        }

        error = ESRCH;

done:
        brelse(bp, 0);
        return (error);
}

/* End of disksubr.c */