Mihail Stoyanov / HTTPServer

My fork of the HTTPServer (working)

Dependents:   DGWWebServer LAN2

Core/lwIP/include/lwip/dhcp.h@0:7a64fbb4069d, 2012-08-06 (annotated)

Committer:
screamer
Date:
Mon Aug 06 09:23:14 2012 +0000
Revision:
0:7a64fbb4069d
[mbed] converted /DGWWebServer/HTTPServer

Who changed what in which revision?

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