Adam Green / Mbed 2 deprecated WeatherStation

Web server based weather station using Sparkfun Weather Meters.

Dependencies:   FatFileSystem mbed WeatherMeters SDFileSystem

NetStack/lwip/include/lwip/dhcp.h@0:616601bde9fb, 2012-02-23 (annotated)

Committer:
AdamGreen
Date:
Thu Feb 23 21:38:39 2012 +0000
Revision:
0:616601bde9fb

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


AdamGreen

0:616601bde9fb


     1

/** @file





AdamGreen

0:616601bde9fb


     2

 */





AdamGreen

0:616601bde9fb


     3







AdamGreen

0:616601bde9fb


     4

#ifndef __LWIP_DHCP_H__





AdamGreen

0:616601bde9fb


     5

#define __LWIP_DHCP_H__





AdamGreen

0:616601bde9fb


     6







AdamGreen

0:616601bde9fb


     7

#include "lwip/opt.h"





AdamGreen

0:616601bde9fb


     8







AdamGreen

0:616601bde9fb


     9

#if LWIP_DHCP /* don't build if not configured for use in lwipopts.h */





AdamGreen

0:616601bde9fb


    10







AdamGreen

0:616601bde9fb


    11

#include "lwip/netif.h"





AdamGreen

0:616601bde9fb


    12

#include "lwip/udp.h"





AdamGreen

0:616601bde9fb


    13







AdamGreen

0:616601bde9fb


    14

#ifdef __cplusplus





AdamGreen

0:616601bde9fb


    15

extern "C" {





AdamGreen

0:616601bde9fb


    16

#endif





AdamGreen

0:616601bde9fb


    17







AdamGreen

0:616601bde9fb


    18

/** period (in seconds) of the application calling dhcp_coarse_tmr() */





AdamGreen

0:616601bde9fb


    19

#define DHCP_COARSE_TIMER_SECS 60 





AdamGreen

0:616601bde9fb


    20

/** period (in milliseconds) of the application calling dhcp_coarse_tmr() */





AdamGreen

0:616601bde9fb


    21

#define DHCP_COARSE_TIMER_MSECS (DHCP_COARSE_TIMER_SECS * 1000UL)





AdamGreen

0:616601bde9fb


    22

/** period (in milliseconds) of the application calling dhcp_fine_tmr() */





AdamGreen

0:616601bde9fb


    23

#define DHCP_FINE_TIMER_MSECS 500 





AdamGreen

0:616601bde9fb


    24







AdamGreen

0:616601bde9fb


    25

#define DHCP_CHADDR_LEN 16U





AdamGreen

0:616601bde9fb


    26

#define DHCP_SNAME_LEN  64U





AdamGreen

0:616601bde9fb


    27

#define DHCP_FILE_LEN   128U





AdamGreen

0:616601bde9fb


    28







AdamGreen

0:616601bde9fb


    29

struct dhcp





AdamGreen

0:616601bde9fb


    30

{





AdamGreen

0:616601bde9fb


    31

  /** transaction identifier of last sent request */ 





AdamGreen

0:616601bde9fb


    32

  u32_t xid;





AdamGreen

0:616601bde9fb


    33

  /** our connection to the DHCP server */ 





AdamGreen

0:616601bde9fb


    34

  struct udp_pcb *pcb;





AdamGreen

0:616601bde9fb


    35

  /** incoming msg */





AdamGreen

0:616601bde9fb


    36

  struct dhcp_msg *msg_in;





AdamGreen

0:616601bde9fb


    37

  /** current DHCP state machine state */





AdamGreen

0:616601bde9fb


    38

  u8_t state;





AdamGreen

0:616601bde9fb


    39

  /** retries of current request */





AdamGreen

0:616601bde9fb


    40

  u8_t tries;





AdamGreen

0:616601bde9fb


    41

#if LWIP_DHCP_AUTOIP_COOP





AdamGreen

0:616601bde9fb


    42

  u8_t autoip_coop_state;





AdamGreen

0:616601bde9fb


    43

#endif





AdamGreen

0:616601bde9fb


    44

  u8_t subnet_mask_given;





AdamGreen

0:616601bde9fb


    45







AdamGreen

0:616601bde9fb


    46

  struct pbuf *p_out; /* pbuf of outcoming msg */





AdamGreen

0:616601bde9fb


    47

  struct dhcp_msg *msg_out; /* outgoing msg */





AdamGreen

0:616601bde9fb


    48

  u16_t options_out_len; /* outgoing msg options length */





AdamGreen

0:616601bde9fb


    49

  u16_t request_timeout; /* #ticks with period DHCP_FINE_TIMER_SECS for request timeout */





AdamGreen

0:616601bde9fb


    50

  u16_t t1_timeout;  /* #ticks with period DHCP_COARSE_TIMER_SECS for renewal time */





AdamGreen

0:616601bde9fb


    51

  u16_t t2_timeout;  /* #ticks with period DHCP_COARSE_TIMER_SECS for rebind time */





AdamGreen

0:616601bde9fb


    52

  ip_addr_t server_ip_addr; /* dhcp server address that offered this lease */





AdamGreen

0:616601bde9fb


    53

  ip_addr_t offered_ip_addr;





AdamGreen

0:616601bde9fb


    54

  ip_addr_t offered_sn_mask;





AdamGreen

0:616601bde9fb


    55

  ip_addr_t offered_gw_addr;





AdamGreen

0:616601bde9fb


    56

 





AdamGreen

0:616601bde9fb


    57

  u32_t offered_t0_lease; /* lease period (in seconds) */





AdamGreen

0:616601bde9fb


    58

  u32_t offered_t1_renew; /* recommended renew time (usually 50% of lease period) */





AdamGreen

0:616601bde9fb


    59

  u32_t offered_t2_rebind; /* recommended rebind time (usually 66% of lease period)  */





AdamGreen

0:616601bde9fb


    60

  /* @todo: LWIP_DHCP_BOOTP_FILE configuration option?





AdamGreen

0:616601bde9fb


    61

     integrate with possible TFTP-client for booting? */





AdamGreen

0:616601bde9fb


    62

#if LWIP_DHCP_BOOTP_FILE





AdamGreen

0:616601bde9fb


    63

  ip_addr_t offered_si_addr;





AdamGreen

0:616601bde9fb


    64

  char boot_file_name[DHCP_FILE_LEN];





AdamGreen

0:616601bde9fb


    65

#endif /* LWIP_DHCP_BOOTPFILE */





AdamGreen

0:616601bde9fb


    66

};





AdamGreen

0:616601bde9fb


    67







AdamGreen

0:616601bde9fb


    68

/* MUST be compiled with "pack structs" or equivalent! */





AdamGreen

0:616601bde9fb


    69

#ifdef PACK_STRUCT_USE_INCLUDES





AdamGreen

0:616601bde9fb


    70

#  include "arch/bpstruct.h"





AdamGreen

0:616601bde9fb


    71

#endif





AdamGreen

0:616601bde9fb


    72

PACK_STRUCT_BEGIN





AdamGreen

0:616601bde9fb


    73

/** minimum set of fields of any DHCP message */





AdamGreen

0:616601bde9fb


    74

struct dhcp_msg





AdamGreen

0:616601bde9fb


    75

{





AdamGreen

0:616601bde9fb


    76

  PACK_STRUCT_FIELD(u8_t op);





AdamGreen

0:616601bde9fb


    77

  PACK_STRUCT_FIELD(u8_t htype);





AdamGreen

0:616601bde9fb


    78

  PACK_STRUCT_FIELD(u8_t hlen);





AdamGreen

0:616601bde9fb


    79

  PACK_STRUCT_FIELD(u8_t hops);





AdamGreen

0:616601bde9fb


    80

  PACK_STRUCT_FIELD(u32_t xid);





AdamGreen

0:616601bde9fb


    81

  PACK_STRUCT_FIELD(u16_t secs);





AdamGreen

0:616601bde9fb


    82

  PACK_STRUCT_FIELD(u16_t flags);





AdamGreen

0:616601bde9fb


    83

  PACK_STRUCT_FIELD(ip_addr_p_t ciaddr);





AdamGreen

0:616601bde9fb


    84

  PACK_STRUCT_FIELD(ip_addr_p_t yiaddr);





AdamGreen

0:616601bde9fb


    85

  PACK_STRUCT_FIELD(ip_addr_p_t siaddr);





AdamGreen

0:616601bde9fb


    86

  PACK_STRUCT_FIELD(ip_addr_p_t giaddr);





AdamGreen

0:616601bde9fb


    87

  PACK_STRUCT_FIELD(u8_t chaddr[DHCP_CHADDR_LEN]);





AdamGreen

0:616601bde9fb


    88

  PACK_STRUCT_FIELD(u8_t sname[DHCP_SNAME_LEN]);





AdamGreen

0:616601bde9fb


    89

  PACK_STRUCT_FIELD(u8_t file[DHCP_FILE_LEN]);





AdamGreen

0:616601bde9fb


    90

  PACK_STRUCT_FIELD(u32_t cookie);





AdamGreen

0:616601bde9fb


    91

#define DHCP_MIN_OPTIONS_LEN 68U





AdamGreen

0:616601bde9fb


    92

/** make sure user does not configure this too small */





AdamGreen

0:616601bde9fb


    93

#if ((defined(DHCP_OPTIONS_LEN)) && (DHCP_OPTIONS_LEN < DHCP_MIN_OPTIONS_LEN))





AdamGreen

0:616601bde9fb


    94

#  undef DHCP_OPTIONS_LEN





AdamGreen

0:616601bde9fb


    95

#endif





AdamGreen

0:616601bde9fb


    96

/** allow this to be configured in lwipopts.h, but not too small */





AdamGreen

0:616601bde9fb


    97

#if (!defined(DHCP_OPTIONS_LEN))





AdamGreen

0:616601bde9fb


    98

/** set this to be sufficient for your options in outgoing DHCP msgs */





AdamGreen

0:616601bde9fb


    99

#  define DHCP_OPTIONS_LEN DHCP_MIN_OPTIONS_LEN





AdamGreen

0:616601bde9fb


   100

#endif





AdamGreen

0:616601bde9fb


   101

  PACK_STRUCT_FIELD(u8_t options[DHCP_OPTIONS_LEN]);





AdamGreen

0:616601bde9fb


   102

} PACK_STRUCT_STRUCT;





AdamGreen

0:616601bde9fb


   103

PACK_STRUCT_END





AdamGreen

0:616601bde9fb


   104

#ifdef PACK_STRUCT_USE_INCLUDES





AdamGreen

0:616601bde9fb


   105

#  include "arch/epstruct.h"





AdamGreen

0:616601bde9fb


   106

#endif





AdamGreen

0:616601bde9fb


   107







AdamGreen

0:616601bde9fb


   108

void dhcp_set_struct(struct netif *netif, struct dhcp *dhcp);





AdamGreen

0:616601bde9fb


   109

/** start DHCP configuration */





AdamGreen

0:616601bde9fb


   110

err_t dhcp_start(struct netif *netif);





AdamGreen

0:616601bde9fb


   111

/** enforce early lease renewal (not needed normally)*/





AdamGreen

0:616601bde9fb


   112

err_t dhcp_renew(struct netif *netif);





AdamGreen

0:616601bde9fb


   113

/** release the DHCP lease, usually called before dhcp_stop()*/





AdamGreen

0:616601bde9fb


   114

err_t dhcp_release(struct netif *netif);





AdamGreen

0:616601bde9fb


   115

/** stop DHCP configuration */





AdamGreen

0:616601bde9fb


   116

void dhcp_stop(struct netif *netif);





AdamGreen

0:616601bde9fb


   117

/** inform server of our manual IP address */





AdamGreen

0:616601bde9fb


   118

void dhcp_inform(struct netif *netif);





AdamGreen

0:616601bde9fb


   119

/** Handle a possible change in the network configuration */





AdamGreen

0:616601bde9fb


   120

void dhcp_network_changed(struct netif *netif);





AdamGreen

0:616601bde9fb


   121







AdamGreen

0:616601bde9fb


   122

/** if enabled, check whether the offered IP address is not in use, using ARP */





AdamGreen

0:616601bde9fb


   123

#if DHCP_DOES_ARP_CHECK





AdamGreen

0:616601bde9fb


   124

void dhcp_arp_reply(struct netif *netif, ip_addr_t *addr);





AdamGreen

0:616601bde9fb


   125

#endif





AdamGreen

0:616601bde9fb


   126







AdamGreen

0:616601bde9fb


   127

/** to be called every minute */





AdamGreen

0:616601bde9fb


   128

void dhcp_coarse_tmr(void);





AdamGreen

0:616601bde9fb


   129

/** to be called every half second */





AdamGreen

0:616601bde9fb


   130

void dhcp_fine_tmr(void);





AdamGreen

0:616601bde9fb


   131

 





AdamGreen

0:616601bde9fb


   132

/** DHCP message item offsets and length */





AdamGreen

0:616601bde9fb


   133

#define DHCP_OP_OFS       0





AdamGreen

0:616601bde9fb


   134

#define DHCP_HTYPE_OFS    1





AdamGreen

0:616601bde9fb


   135

#define DHCP_HLEN_OFS     2





AdamGreen

0:616601bde9fb


   136

#define DHCP_HOPS_OFS     3





AdamGreen

0:616601bde9fb


   137

#define DHCP_XID_OFS      4





AdamGreen

0:616601bde9fb


   138

#define DHCP_SECS_OFS     8





AdamGreen

0:616601bde9fb


   139

#define DHCP_FLAGS_OFS    10





AdamGreen

0:616601bde9fb


   140

#define DHCP_CIADDR_OFS   12





AdamGreen

0:616601bde9fb


   141

#define DHCP_YIADDR_OFS   16





AdamGreen

0:616601bde9fb


   142

#define DHCP_SIADDR_OFS   20





AdamGreen

0:616601bde9fb


   143

#define DHCP_GIADDR_OFS   24





AdamGreen

0:616601bde9fb


   144

#define DHCP_CHADDR_OFS   28





AdamGreen

0:616601bde9fb


   145

#define DHCP_SNAME_OFS    44





AdamGreen

0:616601bde9fb


   146

#define DHCP_FILE_OFS     108





AdamGreen

0:616601bde9fb


   147

#define DHCP_MSG_LEN      236





AdamGreen

0:616601bde9fb


   148







AdamGreen

0:616601bde9fb


   149

#define DHCP_COOKIE_OFS   DHCP_MSG_LEN





AdamGreen

0:616601bde9fb


   150

#define DHCP_OPTIONS_OFS  (DHCP_MSG_LEN + 4)





AdamGreen

0:616601bde9fb


   151







AdamGreen

0:616601bde9fb


   152

#define DHCP_CLIENT_PORT  68  





AdamGreen

0:616601bde9fb


   153

#define DHCP_SERVER_PORT  67





AdamGreen

0:616601bde9fb


   154







AdamGreen

0:616601bde9fb


   155

/** DHCP client states */





AdamGreen

0:616601bde9fb


   156

#define DHCP_OFF          0





AdamGreen

0:616601bde9fb


   157

#define DHCP_REQUESTING   1





AdamGreen

0:616601bde9fb


   158

#define DHCP_INIT         2





AdamGreen

0:616601bde9fb


   159

#define DHCP_REBOOTING    3





AdamGreen

0:616601bde9fb


   160

#define DHCP_REBINDING    4





AdamGreen

0:616601bde9fb


   161

#define DHCP_RENEWING     5





AdamGreen

0:616601bde9fb


   162

#define DHCP_SELECTING    6





AdamGreen

0:616601bde9fb


   163

#define DHCP_INFORMING    7





AdamGreen

0:616601bde9fb


   164

#define DHCP_CHECKING     8





AdamGreen

0:616601bde9fb


   165

#define DHCP_PERMANENT    9





AdamGreen

0:616601bde9fb


   166

#define DHCP_BOUND        10





AdamGreen

0:616601bde9fb


   167

/** not yet implemented #define DHCP_RELEASING 11 */





AdamGreen

0:616601bde9fb


   168

#define DHCP_BACKING_OFF  12





AdamGreen

0:616601bde9fb


   169







AdamGreen

0:616601bde9fb


   170

/** AUTOIP cooperatation flags */





AdamGreen

0:616601bde9fb


   171

#define DHCP_AUTOIP_COOP_STATE_OFF  0





AdamGreen

0:616601bde9fb


   172

#define DHCP_AUTOIP_COOP_STATE_ON   1





AdamGreen

0:616601bde9fb


   173

 





AdamGreen

0:616601bde9fb


   174

#define DHCP_BOOTREQUEST  1





AdamGreen

0:616601bde9fb


   175

#define DHCP_BOOTREPLY    2





AdamGreen

0:616601bde9fb


   176







AdamGreen

0:616601bde9fb


   177

/** DHCP message types */





AdamGreen

0:616601bde9fb


   178

#define DHCP_DISCOVER 1





AdamGreen

0:616601bde9fb


   179

#define DHCP_OFFER    2





AdamGreen

0:616601bde9fb


   180

#define DHCP_REQUEST  3





AdamGreen

0:616601bde9fb


   181

#define DHCP_DECLINE  4





AdamGreen

0:616601bde9fb


   182

#define DHCP_ACK      5





AdamGreen

0:616601bde9fb


   183

#define DHCP_NAK      6





AdamGreen

0:616601bde9fb


   184

#define DHCP_RELEASE  7





AdamGreen

0:616601bde9fb


   185

#define DHCP_INFORM   8





AdamGreen

0:616601bde9fb


   186







AdamGreen

0:616601bde9fb


   187

/** DHCP hardware type, currently only ethernet is supported */





AdamGreen

0:616601bde9fb


   188

#define DHCP_HTYPE_ETH 1





AdamGreen

0:616601bde9fb


   189







AdamGreen

0:616601bde9fb


   190

#define DHCP_MAGIC_COOKIE 0x63825363UL





AdamGreen

0:616601bde9fb


   191







AdamGreen

0:616601bde9fb


   192

/* This is a list of options for BOOTP and DHCP, see RFC 2132 for descriptions */





AdamGreen

0:616601bde9fb


   193







AdamGreen

0:616601bde9fb


   194

/** BootP options */





AdamGreen

0:616601bde9fb


   195

#define DHCP_OPTION_PAD 0





AdamGreen

0:616601bde9fb


   196

#define DHCP_OPTION_SUBNET_MASK 1 /* RFC 2132 3.3 */





AdamGreen

0:616601bde9fb


   197

#define DHCP_OPTION_ROUTER 3





AdamGreen

0:616601bde9fb


   198

#define DHCP_OPTION_DNS_SERVER 6 





AdamGreen

0:616601bde9fb


   199

#define DHCP_OPTION_HOSTNAME 12





AdamGreen

0:616601bde9fb


   200

#define DHCP_OPTION_IP_TTL 23





AdamGreen

0:616601bde9fb


   201

#define DHCP_OPTION_MTU 26





AdamGreen

0:616601bde9fb


   202

#define DHCP_OPTION_BROADCAST 28





AdamGreen

0:616601bde9fb


   203

#define DHCP_OPTION_TCP_TTL 37





AdamGreen

0:616601bde9fb


   204

#define DHCP_OPTION_END 255





AdamGreen

0:616601bde9fb


   205







AdamGreen

0:616601bde9fb


   206

/** DHCP options */





AdamGreen

0:616601bde9fb


   207

#define DHCP_OPTION_REQUESTED_IP 50 /* RFC 2132 9.1, requested IP address */





AdamGreen

0:616601bde9fb


   208

#define DHCP_OPTION_LEASE_TIME 51 /* RFC 2132 9.2, time in seconds, in 4 bytes */





AdamGreen

0:616601bde9fb


   209

#define DHCP_OPTION_OVERLOAD 52 /* RFC2132 9.3, use file and/or sname field for options */





AdamGreen

0:616601bde9fb


   210







AdamGreen

0:616601bde9fb


   211

#define DHCP_OPTION_MESSAGE_TYPE 53 /* RFC 2132 9.6, important for DHCP */





AdamGreen

0:616601bde9fb


   212

#define DHCP_OPTION_MESSAGE_TYPE_LEN 1





AdamGreen

0:616601bde9fb


   213







AdamGreen

0:616601bde9fb


   214

#define DHCP_OPTION_SERVER_ID 54 /* RFC 2132 9.7, server IP address */





AdamGreen

0:616601bde9fb


   215

#define DHCP_OPTION_PARAMETER_REQUEST_LIST 55 /* RFC 2132 9.8, requested option types */





AdamGreen

0:616601bde9fb


   216







AdamGreen

0:616601bde9fb


   217

#define DHCP_OPTION_MAX_MSG_SIZE 57 /* RFC 2132 9.10, message size accepted >= 576 */





AdamGreen

0:616601bde9fb


   218

#define DHCP_OPTION_MAX_MSG_SIZE_LEN 2





AdamGreen

0:616601bde9fb


   219







AdamGreen

0:616601bde9fb


   220

#define DHCP_OPTION_T1 58 /* T1 renewal time */





AdamGreen

0:616601bde9fb


   221

#define DHCP_OPTION_T2 59 /* T2 rebinding time */





AdamGreen

0:616601bde9fb


   222

#define DHCP_OPTION_US 60





AdamGreen

0:616601bde9fb


   223

#define DHCP_OPTION_CLIENT_ID 61





AdamGreen

0:616601bde9fb


   224

#define DHCP_OPTION_TFTP_SERVERNAME 66





AdamGreen

0:616601bde9fb


   225

#define DHCP_OPTION_BOOTFILE 67





AdamGreen

0:616601bde9fb


   226







AdamGreen

0:616601bde9fb


   227

/** possible combinations of overloading the file and sname fields with options */





AdamGreen

0:616601bde9fb


   228

#define DHCP_OVERLOAD_NONE 0





AdamGreen

0:616601bde9fb


   229

#define DHCP_OVERLOAD_FILE 1





AdamGreen

0:616601bde9fb


   230

#define DHCP_OVERLOAD_SNAME  2





AdamGreen

0:616601bde9fb


   231

#define DHCP_OVERLOAD_SNAME_FILE 3





AdamGreen

0:616601bde9fb


   232







AdamGreen

0:616601bde9fb


   233

#ifdef __cplusplus





AdamGreen

0:616601bde9fb


   234

}





AdamGreen

0:616601bde9fb


   235

#endif





AdamGreen

0:616601bde9fb


   236







AdamGreen

0:616601bde9fb


   237

#endif /* LWIP_DHCP */





AdamGreen

0:616601bde9fb


   238







AdamGreen

0:616601bde9fb


   239

#endif /*__LWIP_DHCP_H__*/