usr.bin/mkimg/scheme.h

   1 /*-
   2  * Copyright (c) 2013,2014 Juniper Networks, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _MKIMG_SCHEME_H_
  30 #define _MKIMG_SCHEME_H_
  31
  32 #include <sys/linker_set.h>
  33
  34 enum alias {
  35         ALIAS_NONE,             /* Keep first! */
  36         /* start */
  37         ALIAS_EBR,
  38         ALIAS_EFI,
  39         ALIAS_FAT32,
  40         ALIAS_FREEBSD,
  41         ALIAS_FREEBSD_BOOT,
  42         ALIAS_FREEBSD_NANDFS,
  43         ALIAS_FREEBSD_SWAP,
  44         ALIAS_FREEBSD_UFS,
  45         ALIAS_FREEBSD_VINUM,
  46         ALIAS_FREEBSD_ZFS,
  47         ALIAS_MBR,
  48         /* end */
  49         ALIAS_COUNT             /* Keep last! */
  50 };
  51
  52 struct mkimg_alias {
  53         u_int           alias;
  54         uintptr_t       type;
  55 #define ALIAS_PTR2TYPE(p)       (uintptr_t)(p)
  56 #define ALIAS_INT2TYPE(i)       (i)
  57 #define ALIAS_TYPE2PTR(p)       (void *)(p)
  58 #define ALIAS_TYPE2INT(i)       (i)
  59 };
  60
  61 struct mkimg_scheme {
  62         const char      *name;
  63         const char      *description;
  64         struct mkimg_alias *aliases;
  65         lba_t           (*metadata)(u_int, lba_t);
  66 #define SCHEME_META_IMG_START   1
  67 #define SCHEME_META_IMG_END     2
  68 #define SCHEME_META_PART_BEFORE 3
  69 #define SCHEME_META_PART_AFTER  4
  70         int             (*write)(lba_t, void *);
  71         u_int           nparts;
  72         u_int           labellen;
  73         u_int           bootcode;
  74         u_int           maxsecsz;
  75 };
  76
  77 SET_DECLARE(schemes, struct mkimg_scheme);
  78 #define SCHEME_DEFINE(nm)       DATA_SET(schemes, nm)
  79
  80 int     scheme_select(const char *);
  81 struct mkimg_scheme *scheme_selected(void);
  82
  83 int scheme_bootcode(int fd);
  84 int scheme_check_part(struct part *);
  85 u_int scheme_max_parts(void);
  86 u_int scheme_max_secsz(void);
  87 lba_t scheme_metadata(u_int, lba_t);
  88 int scheme_write(lba_t);
  89
  90 #endif /* _MKIMG_SCHEME_H_ */