Dependents:   SNMPAgent HTTPServer think_speak_a cyassl-client ... more

Committer:
mamezu
Date:
Thu Dec 09 01:33:56 2010 +0000
Revision:
0:0f6c82fcde82

        

Who changed what in which revision?

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