Embedded WebSockets Experiment

Dependencies:   mbed MD5

Committer:
nandgate
Date:
Tue Jul 26 05:30:53 2011 +0000
Revision:
0:6dee052a3fa4

        

Who changed what in which revision?

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