Allowed zero-cost enforced ordering of features in startup banner
[people/xl0/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_NBI             0x20 /**< NBI format */
45 #define DHCP_EB_FEATURE_PXE             0x21 /**< PXE format */
46
47 /** @} */
48
49 /** Declare a feature code for DHCP */
50 #define __dhcp_feature( category )                                          \
51          __table ( uint8_t, dhcp_features, category )
52
53 /** Construct a DHCP feature table entry */
54 #define DHCP_FEATURE( category, feature_opt, version )                      \
55         _DHCP_FEATURE ( category, OBJECT, feature_opt, version )
56 #define _DHCP_FEATURE( category, _name, feature_opt, version )              \
57         __DHCP_FEATURE ( category, _name, feature_opt, version )
58 #define __DHCP_FEATURE( category, _name, feature_opt, version )             \
59         uint8_t __dhcp_feature_ ## _name [] __dhcp_feature ( category ) = { \
60                 feature_opt, DHCP_BYTE ( version )                          \
61         };
62
63 /** A named feature */
64 struct feature {
65         /** Feature name */
66         char *name;
67 };
68
69 /** Declare a named feature */
70 #define __feature_name( category )                                          \
71         __table ( struct feature, features, category )
72
73 /** Construct a named feature */
74 #define FEATURE_NAME( category, text )                                      \
75         _FEATURE_NAME ( category, OBJECT, text )
76 #define _FEATURE_NAME( category, _name, text )                              \
77         __FEATURE_NAME ( category, _name, text )
78 #define __FEATURE_NAME( category, _name, text )                             \
79         struct feature __feature_ ## _name __feature_name ( category ) = {  \
80                 .name = text,                                               \
81         };
82
83 /** Declare a feature */
84 #define FEATURE( category, text, feature_opt, version )                     \
85         FEATURE_NAME ( category, text );                                    \
86         DHCP_FEATURE ( category, feature_opt, version );
87
88 #endif /* _GPXE_FEATURES_H */