IBM Watson IoT / Mbed OS IBMIoTClientEthernetExample

Contains example code to connect the mbed LPC1768 or FRDM-K64F devices to the IBM Internet of Things Cloud service via ethernet.

Dependencies:   C12832 MQTT LM75B MMA7660

Dependents:   MFT_IoT_demo_USB400 IBM_RFID

EthernetInterface/lwip/include/lwip/dhcp.h@6:37b6d0d56190, 2014-08-20 (annotated)

Committer:
samdanbury
Date:
Wed Aug 20 12:45:14 2014 +0000
Revision:
6:37b6d0d56190
Code completely changed to improve the structure, flow and memory usage of the application

Who changed what in which revision?

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