xref: /titanic_50/usr/src/common/net/wanboot/bootinfo.h (revision f38cb554a534c6df738be3f4d23327e69888e634)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2002-2003 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_BOOTINFO_H
28 #define	_BOOTINFO_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/types.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 /*
39  * Names known to bootinfo:
40  */
41 #define	BI_NET_CONFIG_STRATEGY		"net-config-strategy"
42 #define	BI_HOST_IP			"host-ip"
43 #define	BI_SUBNET_MASK			"subnet-mask"
44 #define	BI_ROUTER_IP			"router-ip"
45 #define	BI_HOSTNAME			"hostname"
46 #define	BI_HTTP_PROXY			"http-proxy"
47 #define	BI_CLIENT_ID			"client-id"
48 
49 #if	defined(_BOOT)
50 #define	BI_NETWORK_BOOT_FILE		"network-boot-file"
51 #define	BI_BOOTFILE			"bootfile"
52 #define	BI_BOOTP_RESPONSE		"bootp-response"
53 #define	BI_BOOTSERVER			"bootserver"
54 #define	BI_AES_KEY			"aes"
55 #define	BI_3DES_KEY			"3des"
56 #define	BI_SHA1_KEY			"sha1"
57 #else
58 #define	BI_SYSIDCFG			"sysidcfg"
59 #define	BI_JUMPSCFG			"jumpscfg"
60 #define	BI_ROOTFS_TYPE			"rootfs-type"
61 #define	BI_INTERFACE_NAME		"interface-name"
62 #endif	/* defined(_BOOT) */
63 
64 /*
65  * Possible bootinfo repositories:
66  */
67 #define	BI_R_CHOSEN	0x01		/* /chosen property */
68 #define	BI_R_DHCPOPT	0x02		/* DHCP option */
69 #define	BI_R_BOOTMISC	0x04		/* 'misc' value */
70 
71 #define	BI_R_ALL	(BI_R_CHOSEN|BI_R_DHCPOPT|BI_R_BOOTMISC)
72 
73 /*
74  * bootinfo_get() return values:
75  */
76 typedef enum {
77 	BI_E_SUCCESS,
78 	BI_E_ERROR,
79 	BI_E_ILLNAME,
80 	BI_E_NOVAL,
81 	BI_E_BUF2SMALL,
82 	BI_E_RDONLY
83 } bi_errcode_t;
84 
85 extern boolean_t bootinfo_init(void);
86 extern void bootinfo_end(void);
87 extern bi_errcode_t bootinfo_get(const char *, void *, size_t *, int *);
88 
89 #if	defined(_BOOT)
90 extern int bootinfo_put(const char *, const void *, size_t, int);
91 #endif	/* defined(_BOOT) */
92 
93 #ifdef	__cplusplus
94 }
95 #endif
96 
97 #endif	/* _BOOTINFO_H */
98