xref: /freebsd/usr.bin/mkimg/mkimg.h (revision fd45b686f9d92f583366c75b22c04c7ee49709c0)
1 /*-
2  * Copyright (c) 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 
27 #ifndef _MKIMG_MKIMG_H_
28 #define	_MKIMG_MKIMG_H_
29 
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 
33 struct part {
34 	TAILQ_ENTRY(part) link;
35 	char	*alias;		/* Partition type alias. */
36 	char	*contents;	/* Contents/size specification. */
37 	u_int	kind;		/* Content kind. */
38 #define	PART_UNDEF	0
39 #define	PART_KIND_FILE	1
40 #define	PART_KIND_PIPE	2
41 #define	PART_KIND_SIZE	3
42 	u_int	index;		/* Partition index (0-based). */
43 	uintptr_t type;		/* Scheme-specific partition type. */
44 	lba_t	block;		/* Block-offset of partition in image. */
45 	lba_t	size;		/* Size in blocks of partition. */
46 	char	*label;		/* Partition label. */
47 };
48 
49 extern TAILQ_HEAD(partlisthead, part) partlist;
50 extern u_int nparts;
51 
52 extern u_int unit_testing;
53 extern u_int verbose;
54 
55 extern u_int ncyls;
56 extern u_int nheads;
57 extern u_int nsecs;
58 extern u_int secsz;	/* Logical block size. */
59 extern u_int blksz;	/* Physical block size. */
60 extern uint32_t active_partition;
61 
62 static inline lba_t
63 round_block(lba_t n)
64 {
65 	lba_t b = blksz / secsz;
66 	return ((n + b - 1) & ~(b - 1));
67 }
68 
69 static inline lba_t
70 round_cylinder(lba_t n)
71 {
72 	u_int cyl = nsecs * nheads;
73 	u_int r = n % cyl;
74 	return ((r == 0) ? n : n + cyl - r);
75 }
76 
77 static inline lba_t
78 round_track(lba_t n)
79 {
80 	u_int r = n % nsecs;
81 	return ((r == 0) ? n : n + nsecs - r);
82 }
83 
84 #if !defined(SPARSE_WRITE)
85 #define	sparse_write	write
86 #else
87 ssize_t sparse_write(int, const void *, size_t);
88 #endif
89 
90 void mkimg_chs(lba_t, u_int, u_int *, u_int *, u_int *);
91 
92 struct mkimg_uuid {
93 	uint32_t	time_low;
94 	uint16_t	time_mid;
95 	uint16_t	time_hi_and_version;
96 	uint8_t		clock_seq_hi_and_reserved;
97 	uint8_t		clock_seq_low;
98 	uint8_t		node[6];
99 };
100 typedef struct mkimg_uuid mkimg_uuid_t;
101 
102 void mkimg_uuid(mkimg_uuid_t *);
103 void mkimg_uuid_enc(void *, const mkimg_uuid_t *);
104 
105 #ifdef __linux__
106 # if !defined(__unused)
107 #   define __unused __attribute__ ((__unused__))
108 # endif
109 #endif
110 
111 #endif /* _MKIMG_MKIMG_H_ */
112