[efi] Add EFI image format and basic runtime environment
[people/sha0/gpxe.git] / src / include / gpxe / features.h
1 #ifndef _GPXE_FEATURES_H
2 #define _GPXE_FEATURES_H
3
4 #include <stdint.h>
5 #include <gpxe/tables.h>
6 #include <gpxe/dhcp.h>
7
8 /** @file
9  *
10  * Feature list
11  *
12  */
13
14 /**
15  * @defgroup featurecat Feature categories
16  * @{
17  */
18
19 #define FEATURE_PROTOCOL                01 /**< Network protocols */
20 #define FEATURE_IMAGE                   02 /**< Image formats */
21 #define FEATURE_MISC                    03 /**< Miscellaneous */
22
23 /** @} */
24
25 /**
26  * @defgroup dhcpfeatures DHCP feature option tags
27  *
28  * DHCP feature option tags are Etherboot encapsulated options in the
29  * range 0x10-0x7f.
30  *
31  * @{
32  */
33
34 #define DHCP_EB_FEATURE_PXE_EXT         0x10 /**< PXE API extensions */
35 #define DHCP_EB_FEATURE_ISCSI           0x11 /**< iSCSI protocol */
36 #define DHCP_EB_FEATURE_AOE             0x12 /**< AoE protocol */
37 #define DHCP_EB_FEATURE_HTTP            0x13 /**< HTTP protocol */
38 #define DHCP_EB_FEATURE_HTTPS           0x14 /**< HTTPS protocol */
39 #define DHCP_EB_FEATURE_TFTP            0x15 /**< TFTP protocol */
40 #define DHCP_EB_FEATURE_FTP             0x16 /**< FTP protocol */
41 #define DHCP_EB_FEATURE_DNS             0x17 /**< DNS protocol */
42 #define DHCP_EB_FEATURE_BZIMAGE         0x18 /**< bzImage format */
43 #define DHCP_EB_FEATURE_MULTIBOOT       0x19 /**< Multiboot format */
44 #define DHCP_EB_FEATURE_SLAM            0x1a /**< SLAM protocol */
45 #define DHCP_EB_FEATURE_NBI             0x20 /**< NBI format */
46 #define DHCP_EB_FEATURE_PXE             0x21 /**< PXE format */
47 #define DHCP_EB_FEATURE_ELF             0x22 /**< ELF format */
48 #define DHCP_EB_FEATURE_COMBOOT         0x23 /**< COMBOOT format */
49 #define DHCP_EB_FEATURE_EFI             0x24 /**< EFI format */
50
51 /** @} */
52
53 /** Declare a feature code for DHCP */
54 #define __dhcp_feature( category )                                          \
55          __table ( uint8_t, dhcp_features, category )
56
57 /** Construct a DHCP feature table entry */
58 #define DHCP_FEATURE( category, feature_opt, version )                      \
59         _DHCP_FEATURE ( category, OBJECT, feature_opt, version )
60 #define _DHCP_FEATURE( category, _name, feature_opt, version )              \
61         __DHCP_FEATURE ( category, _name, feature_opt, version )
62 #define __DHCP_FEATURE( category, _name, feature_opt, version )             \
63         uint8_t __dhcp_feature_ ## _name [] __dhcp_feature ( category ) = { \
64                 feature_opt, DHCP_BYTE ( version )                          \
65         };
66
67 /** A named feature */
68 struct feature {
69         /** Feature name */
70         char *name;
71 };
72
73 /** Declare a named feature */
74 #define __feature_name( category )                                          \
75         __table ( struct feature, features, category )
76
77 /** Construct a named feature */
78 #define FEATURE_NAME( category, text )                                      \
79         _FEATURE_NAME ( category, OBJECT, text )
80 #define _FEATURE_NAME( category, _name, text )                              \
81         __FEATURE_NAME ( category, _name, text )
82 #define __FEATURE_NAME( category, _name, text )                             \
83         struct feature __feature_ ## _name __feature_name ( category ) = {  \
84                 .name = text,                                               \
85         };
86
87 /** Declare a feature */
88 #define FEATURE( category, text, feature_opt, version )                     \
89         FEATURE_NAME ( category, text );                                    \
90         DHCP_FEATURE ( category, feature_opt, version );
91
92 #endif /* _GPXE_FEATURES_H */