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