git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP_130/src/include/lwip/dhcp.h

   1 /** @file\r
   2  */\r
   3 \r
   4 #ifndef __LWIP_DHCP_H__\r
   5 #define __LWIP_DHCP_H__\r
   6 \r
   7 #include "lwip/opt.h"\r
   8 \r
   9 #if LWIP_DHCP /* don't build if not configured for use in lwipopts.h */\r
  10 \r
  11 #include "lwip/netif.h"\r
  12 #include "lwip/udp.h"\r
  13 \r
  14 #ifdef __cplusplus\r
  15 extern "C" {\r
  16 #endif\r
  17 \r
  18 /** period (in seconds) of the application calling dhcp_coarse_tmr() */\r
  19 #define DHCP_COARSE_TIMER_SECS 60\r
  20 /** period (in milliseconds) of the application calling dhcp_coarse_tmr() */\r
  21 #define DHCP_COARSE_TIMER_MSECS (DHCP_COARSE_TIMER_SECS*1000)\r
  22 /** period (in milliseconds) of the application calling dhcp_fine_tmr() */\r
  23 #define DHCP_FINE_TIMER_MSECS 500\r
  24 \r
  25 struct dhcp\r
  26 {\r
  27   /** current DHCP state machine state */\r
  28   u8_t state;\r
  29   /** retries of current request */\r
  30   u8_t tries;\r
  31   /** transaction identifier of last sent request */\r
  32   u32_t xid;\r
  33   /** our connection to the DHCP server */\r
  34   struct udp_pcb *pcb;\r
  35   /** (first) pbuf of incoming msg */\r
  36   struct pbuf *p;\r
  37   /** incoming msg */\r
  38   struct dhcp_msg *msg_in;\r
  39   /** incoming msg options */\r
  40   struct dhcp_msg *options_in;\r
  41   /** ingoing msg options length */\r
  42   u16_t options_in_len;\r
  43 \r
  44   struct pbuf *p_out; /* pbuf of outcoming msg */\r
  45   struct dhcp_msg *msg_out; /* outgoing msg */\r
  46   u16_t options_out_len; /* outgoing msg options length */\r
  47   u16_t request_timeout; /* #ticks with period DHCP_FINE_TIMER_SECS for request timeout */\r
  48   u16_t t1_timeout;  /* #ticks with period DHCP_COARSE_TIMER_SECS for renewal time */\r
  49   u16_t t2_timeout;  /* #ticks with period DHCP_COARSE_TIMER_SECS for rebind time */\r
  50   struct ip_addr server_ip_addr; /* dhcp server address that offered this lease */\r
  51   struct ip_addr offered_ip_addr;\r
  52   struct ip_addr offered_sn_mask;\r
  53   struct ip_addr offered_gw_addr;\r
  54   struct ip_addr offered_bc_addr;\r
  55 #define DHCP_MAX_DNS 2\r
  56   u32_t dns_count; /* actual number of DNS servers obtained */\r
  57   struct ip_addr offered_dns_addr[DHCP_MAX_DNS]; /* DNS server addresses */\r
  58 \r
  59   u32_t offered_t0_lease; /* lease period (in seconds) */\r
  60   u32_t offered_t1_renew; /* recommended renew time (usually 50% of lease period) */\r
  61   u32_t offered_t2_rebind; /* recommended rebind time (usually 66% of lease period)  */\r
  62 #if LWIP_DHCP_AUTOIP_COOP\r
  63   u8_t autoip_coop_state;\r
  64 #endif\r
  65 /** Patch #1308\r
  66  *  TODO: See dhcp.c "TODO"s\r
  67  */\r
  68 #if 0\r
  69   struct ip_addr offered_si_addr;\r
  70   u8_t *boot_file_name;\r
  71 #endif\r
  72 };\r
  73 \r
  74 /* MUST be compiled with "pack structs" or equivalent! */\r
  75 #ifdef PACK_STRUCT_USE_INCLUDES\r
  76 #  include "arch/bpstruct.h"\r
  77 #endif\r
  78 PACK_STRUCT_BEGIN\r
  79 /** minimum set of fields of any DHCP message */\r
  80 struct dhcp_msg\r
  81 {\r
  82   PACK_STRUCT_FIELD(u8_t op);\r
  83   PACK_STRUCT_FIELD(u8_t htype);\r
  84   PACK_STRUCT_FIELD(u8_t hlen);\r
  85   PACK_STRUCT_FIELD(u8_t hops);\r
  86   PACK_STRUCT_FIELD(u32_t xid);\r
  87   PACK_STRUCT_FIELD(u16_t secs);\r
  88   PACK_STRUCT_FIELD(u16_t flags);\r
  89   PACK_STRUCT_FIELD(struct ip_addr ciaddr);\r
  90   PACK_STRUCT_FIELD(struct ip_addr yiaddr);\r
  91   PACK_STRUCT_FIELD(struct ip_addr siaddr);\r
  92   PACK_STRUCT_FIELD(struct ip_addr giaddr);\r
  93 #define DHCP_CHADDR_LEN 16U\r
  94   PACK_STRUCT_FIELD(u8_t chaddr[DHCP_CHADDR_LEN]);\r
  95 #define DHCP_SNAME_LEN 64U\r
  96   PACK_STRUCT_FIELD(u8_t sname[DHCP_SNAME_LEN]);\r
  97 #define DHCP_FILE_LEN 128U\r
  98   PACK_STRUCT_FIELD(u8_t file[DHCP_FILE_LEN]);\r
  99   PACK_STRUCT_FIELD(u32_t cookie);\r
 100 #define DHCP_MIN_OPTIONS_LEN 68U\r
 101 /** make sure user does not configure this too small */\r
 102 #if ((defined(DHCP_OPTIONS_LEN)) && (DHCP_OPTIONS_LEN < DHCP_MIN_OPTIONS_LEN))\r
 103 #  undef DHCP_OPTIONS_LEN\r
 104 #endif\r
 105 /** allow this to be configured in lwipopts.h, but not too small */\r
 106 #if (!defined(DHCP_OPTIONS_LEN))\r
 107 /** set this to be sufficient for your options in outgoing DHCP msgs */\r
 108 #  define DHCP_OPTIONS_LEN DHCP_MIN_OPTIONS_LEN\r
 109 #endif\r
 110   PACK_STRUCT_FIELD(u8_t options[DHCP_OPTIONS_LEN]);\r
 111 } PACK_STRUCT_STRUCT;\r
 112 PACK_STRUCT_END\r
 113 #ifdef PACK_STRUCT_USE_INCLUDES\r
 114 #  include "arch/epstruct.h"\r
 115 #endif\r
 116 \r
 117 /** start DHCP configuration */\r
 118 err_t dhcp_start(struct netif *netif);\r
 119 /** enforce early lease renewal (not needed normally)*/\r
 120 err_t dhcp_renew(struct netif *netif);\r
 121 /** release the DHCP lease, usually called before dhcp_stop()*/\r
 122 err_t dhcp_release(struct netif *netif);\r
 123 /** stop DHCP configuration */\r
 124 void dhcp_stop(struct netif *netif);\r
 125 /** inform server of our manual IP address */\r
 126 void dhcp_inform(struct netif *netif);\r
 127 \r
 128 /** if enabled, check whether the offered IP address is not in use, using ARP */\r
 129 #if DHCP_DOES_ARP_CHECK\r
 130 void dhcp_arp_reply(struct netif *netif, struct ip_addr *addr);\r
 131 #endif\r
 132 \r
 133 /** to be called every minute */\r
 134 void dhcp_coarse_tmr(void);\r
 135 /** to be called every half second */\r
 136 void dhcp_fine_tmr(void);\r
 137 \r
 138 /** DHCP message item offsets and length */\r
 139 #define DHCP_MSG_OFS (UDP_DATA_OFS)\r
 140   #define DHCP_OP_OFS (DHCP_MSG_OFS + 0)\r
 141   #define DHCP_HTYPE_OFS (DHCP_MSG_OFS + 1)\r
 142   #define DHCP_HLEN_OFS (DHCP_MSG_OFS + 2)\r
 143   #define DHCP_HOPS_OFS (DHCP_MSG_OFS + 3)\r
 144   #define DHCP_XID_OFS (DHCP_MSG_OFS + 4)\r
 145   #define DHCP_SECS_OFS (DHCP_MSG_OFS + 8)\r
 146   #define DHCP_FLAGS_OFS (DHCP_MSG_OFS + 10)\r
 147   #define DHCP_CIADDR_OFS (DHCP_MSG_OFS + 12)\r
 148   #define DHCP_YIADDR_OFS (DHCP_MSG_OFS + 16)\r
 149   #define DHCP_SIADDR_OFS (DHCP_MSG_OFS + 20)\r
 150   #define DHCP_GIADDR_OFS (DHCP_MSG_OFS + 24)\r
 151   #define DHCP_CHADDR_OFS (DHCP_MSG_OFS + 28)\r
 152   #define DHCP_SNAME_OFS (DHCP_MSG_OFS + 44)\r
 153   #define DHCP_FILE_OFS (DHCP_MSG_OFS + 108)\r
 154 #define DHCP_MSG_LEN 236\r
 155 \r
 156 #define DHCP_COOKIE_OFS (DHCP_MSG_OFS + DHCP_MSG_LEN)\r
 157 #define DHCP_OPTIONS_OFS (DHCP_MSG_OFS + DHCP_MSG_LEN + 4)\r
 158 \r
 159 #define DHCP_CLIENT_PORT 68\r
 160 #define DHCP_SERVER_PORT 67\r
 161 \r
 162 /** DHCP client states */\r
 163 #define DHCP_REQUESTING 1\r
 164 #define DHCP_INIT 2\r
 165 #define DHCP_REBOOTING 3\r
 166 #define DHCP_REBINDING 4\r
 167 #define DHCP_RENEWING 5\r
 168 #define DHCP_SELECTING 6\r
 169 #define DHCP_INFORMING 7\r
 170 #define DHCP_CHECKING 8\r
 171 #define DHCP_PERMANENT 9\r
 172 #define DHCP_BOUND 10\r
 173 /** not yet implemented #define DHCP_RELEASING 11 */\r
 174 #define DHCP_BACKING_OFF 12\r
 175 #define DHCP_OFF 13\r
 176 \r
 177 /** AUTOIP cooperatation flags */\r
 178 #define DHCP_AUTOIP_COOP_STATE_OFF 0\r
 179 #define DHCP_AUTOIP_COOP_STATE_ON 1\r
 180 \r
 181 #define DHCP_BOOTREQUEST 1\r
 182 #define DHCP_BOOTREPLY 2\r
 183 \r
 184 #define DHCP_DISCOVER 1\r
 185 #define DHCP_OFFER 2\r
 186 #define DHCP_REQUEST 3\r
 187 #define DHCP_DECLINE 4\r
 188 #define DHCP_ACK 5\r
 189 #define DHCP_NAK 6\r
 190 #define DHCP_RELEASE 7\r
 191 #define DHCP_INFORM 8\r
 192 \r
 193 #define DHCP_HTYPE_ETH 1\r
 194 \r
 195 #define DHCP_HLEN_ETH 6\r
 196 \r
 197 #define DHCP_BROADCAST_FLAG 15\r
 198 #define DHCP_BROADCAST_MASK (1 << DHCP_FLAG_BROADCAST)\r
 199 \r
 200 /** BootP options */\r
 201 #define DHCP_OPTION_PAD 0\r
 202 #define DHCP_OPTION_SUBNET_MASK 1 /* RFC 2132 3.3 */\r
 203 #define DHCP_OPTION_ROUTER 3\r
 204 #define DHCP_OPTION_DNS_SERVER 6\r
 205 #define DHCP_OPTION_HOSTNAME 12\r
 206 #define DHCP_OPTION_IP_TTL 23\r
 207 #define DHCP_OPTION_MTU 26\r
 208 #define DHCP_OPTION_BROADCAST 28\r
 209 #define DHCP_OPTION_TCP_TTL 37\r
 210 #define DHCP_OPTION_END 255\r
 211 \r
 212 /** DHCP options */\r
 213 #define DHCP_OPTION_REQUESTED_IP 50 /* RFC 2132 9.1, requested IP address */\r
 214 #define DHCP_OPTION_LEASE_TIME 51 /* RFC 2132 9.2, time in seconds, in 4 bytes */\r
 215 #define DHCP_OPTION_OVERLOAD 52 /* RFC2132 9.3, use file and/or sname field for options */\r
 216 \r
 217 #define DHCP_OPTION_MESSAGE_TYPE 53 /* RFC 2132 9.6, important for DHCP */\r
 218 #define DHCP_OPTION_MESSAGE_TYPE_LEN 1\r
 219 \r
 220 \r
 221 #define DHCP_OPTION_SERVER_ID 54 /* RFC 2132 9.7, server IP address */\r
 222 #define DHCP_OPTION_PARAMETER_REQUEST_LIST 55 /* RFC 2132 9.8, requested option types */\r
 223 \r
 224 #define DHCP_OPTION_MAX_MSG_SIZE 57 /* RFC 2132 9.10, message size accepted >= 576 */\r
 225 #define DHCP_OPTION_MAX_MSG_SIZE_LEN 2\r
 226 \r
 227 #define DHCP_OPTION_T1 58 /* T1 renewal time */\r
 228 #define DHCP_OPTION_T2 59 /* T2 rebinding time */\r
 229 #define DHCP_OPTION_US 60\r
 230 #define DHCP_OPTION_CLIENT_ID 61\r
 231 #define DHCP_OPTION_TFTP_SERVERNAME 66\r
 232 #define DHCP_OPTION_BOOTFILE 67\r
 233 \r
 234 /** possible combinations of overloading the file and sname fields with options */\r
 235 #define DHCP_OVERLOAD_NONE 0\r
 236 #define DHCP_OVERLOAD_FILE 1\r
 237 #define DHCP_OVERLOAD_SNAME  2\r
 238 #define DHCP_OVERLOAD_SNAME_FILE 3\r
 239 \r
 240 #ifdef __cplusplus\r
 241 }\r
 242 #endif\r
 243 \r
 244 #endif /* LWIP_DHCP */\r
 245 \r
 246 #endif /*__LWIP_DHCP_H__*/\r