dhcp.h
上传用户:yyhongfa
上传日期:2013-01-18
资源大小:267k
文件大小:7k
开发平台:

C/C++

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