Yasushi TAUCHI / Mbed 2 deprecated giken9_HTMLServer_Sample

ソースの整理中ですが、利用はできます。

Dependencies:   EthernetInterface HttpServer TextLCD mbed-rpc mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/include/lwip/dhcp.h@0:7766f6712673, 2014-03-12 (annotated)

Committer:
yueee_yt
Date:
Wed Mar 12 04:19:54 2014 +0000
Revision:
0:7766f6712673
???????????????

Who changed what in which revision?

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