CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/include/lwip/dhcp.h@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

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