qemu/roms/ipxe/src/include/ipxe/features.h

   1 #ifndef _IPXE_FEATURES_H
   2 #define _IPXE_FEATURES_H
   3
   4 #include <stdint.h>
   5 #include <ipxe/tables.h>
   6 #include <ipxe/dhcp.h>
   7
   8 /** @file
   9  *
  10  * Feature list
  11  *
  12  */
  13
  14 FILE_LICENCE ( GPL2_OR_LATER );
  15
  16 /**
  17  * @defgroup featurecat Feature categories
  18  * @{
  19  */
  20
  21 #define FEATURE_PROTOCOL                01 /**< Network protocols */
  22 #define FEATURE_IMAGE                   02 /**< Image formats */
  23 #define FEATURE_MISC                    03 /**< Miscellaneous */
  24
  25 /** @} */
  26
  27 /**
  28  * @defgroup dhcpfeatures DHCP feature option tags
  29  *
  30  * DHCP feature option tags are Etherboot encapsulated options in the
  31  * range 0x10-0x7f.
  32  *
  33  * @{
  34  */
  35
  36 #define DHCP_EB_FEATURE_PXE_EXT         0x10 /**< PXE API extensions */
  37 #define DHCP_EB_FEATURE_ISCSI           0x11 /**< iSCSI protocol */
  38 #define DHCP_EB_FEATURE_AOE             0x12 /**< AoE protocol */
  39 #define DHCP_EB_FEATURE_HTTP            0x13 /**< HTTP protocol */
  40 #define DHCP_EB_FEATURE_HTTPS           0x14 /**< HTTPS protocol */
  41 #define DHCP_EB_FEATURE_TFTP            0x15 /**< TFTP protocol */
  42 #define DHCP_EB_FEATURE_FTP             0x16 /**< FTP protocol */
  43 #define DHCP_EB_FEATURE_DNS             0x17 /**< DNS protocol */
  44 #define DHCP_EB_FEATURE_BZIMAGE         0x18 /**< bzImage format */
  45 #define DHCP_EB_FEATURE_MULTIBOOT       0x19 /**< Multiboot format */
  46 #define DHCP_EB_FEATURE_SLAM            0x1a /**< SLAM protocol */
  47 #define DHCP_EB_FEATURE_SRP             0x1b /**< SRP protocol */
  48 #define DHCP_EB_FEATURE_NBI             0x20 /**< NBI format */
  49 #define DHCP_EB_FEATURE_PXE             0x21 /**< PXE format */
  50 #define DHCP_EB_FEATURE_ELF             0x22 /**< ELF format */
  51 #define DHCP_EB_FEATURE_COMBOOT         0x23 /**< COMBOOT format */
  52 #define DHCP_EB_FEATURE_EFI             0x24 /**< EFI format */
  53 #define DHCP_EB_FEATURE_FCOE            0x25 /**< FCoE protocol */
  54 #define DHCP_EB_FEATURE_VLAN            0x26 /**< VLAN support */
  55 #define DHCP_EB_FEATURE_MENU            0x27 /**< Menu support */
  56 #define DHCP_EB_FEATURE_SDI             0x28 /**< SDI image support */
  57 #define DHCP_EB_FEATURE_NFS             0x29 /**< NFS protocol */
  58
  59 /** @} */
  60
  61 /** DHCP feature table */
  62 #define DHCP_FEATURES __table ( uint8_t, "dhcp_features" )
  63
  64 /** Declare a feature code for DHCP */
  65 #define __dhcp_feature __table_entry ( DHCP_FEATURES, 01 )
  66
  67 /** Construct a DHCP feature table entry */
  68 #define DHCP_FEATURE( feature_opt, ... )                                    \
  69         _DHCP_FEATURE ( OBJECT, feature_opt, __VA_ARGS__ )
  70 #define _DHCP_FEATURE( _name, feature_opt, ... )                            \
  71         __DHCP_FEATURE ( _name, feature_opt, __VA_ARGS__ )
  72 #define __DHCP_FEATURE( _name, feature_opt, ... )                           \
  73         uint8_t __dhcp_feature_ ## _name [] __dhcp_feature = {              \
  74                 feature_opt, DHCP_OPTION ( __VA_ARGS__ )                    \
  75         };
  76
  77 /** A named feature */
  78 struct feature {
  79         /** Feature name */
  80         char *name;
  81 };
  82
  83 /** Named feature table */
  84 #define FEATURES __table ( struct feature, "features" )
  85
  86 /** Declare a named feature */
  87 #define __feature_name( category ) __table_entry ( FEATURES, category )
  88
  89 /** Construct a named feature */
  90 #define FEATURE_NAME( category, text )                                      \
  91         _FEATURE_NAME ( category, OBJECT, text )
  92 #define _FEATURE_NAME( category, _name, text )                              \
  93         __FEATURE_NAME ( category, _name, text )
  94 #define __FEATURE_NAME( category, _name, text )                             \
  95         struct feature __feature_ ## _name __feature_name ( category ) = {  \
  96                 .name = text,                                               \
  97         };
  98
  99 /** Declare a feature */
 100 #define FEATURE( category, text, feature_opt, version )                     \
 101         FEATURE_NAME ( category, text );                                    \
 102         DHCP_FEATURE ( feature_opt, version );
 103
 104 /** Declare the version number feature */
 105 #define FEATURE_VERSION( ... )                                              \
 106         DHCP_FEATURE ( DHCP_ENCAPSULATED ( DHCP_EB_VERSION ), __VA_ARGS__ )
 107
 108 #endif /* _IPXE_FEATURES_H */