Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

lwip/include/lwip/dhcp.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

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