Arlindo Montagnoli / Mbed 2 deprecated ProjetoBB

ProjetoBB

Dependencies:   F7_Ethernet WebSocketClient mbed mcp3008

Fork of Nucleo_F746ZG_Ethernet by Dieter Graef

F7_Ethernet/lwip/include/lwip/dhcp.h@0:f9b6112278fe, 2016-06-18 (annotated)

Committer:
DieterGraef
Date:
Sat Jun 18 10:49:12 2016 +0000
Revision:
0:f9b6112278fe
Ethernet for the NUCLEO STM32F746 Board Testprogram uses DHCP and NTP to set the clock

Who changed what in which revision?

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