UbixOS  2.0
Data Structures | Macros | Enumerations | Variables
dhcp.h File Reference
#include "net/opt.h"
Include dependency graph for dhcp.h:

Go to the source code of this file.

Data Structures

struct  dhcp_msg
 

Macros

#define DHCP_ACK   5
 
#define DHCP_BOOTREPLY   2
 
#define DHCP_BOOTREQUEST   1
 
#define DHCP_CHADDR_LEN   16U
 
#define DHCP_CLIENT_PORT   68
 
#define DHCP_DECLINE   4
 
#define DHCP_DISCOVER   1
 
#define DHCP_FILE_LEN   128U
 
#define DHCP_FILE_OFS   108U
 
#define DHCP_HTYPE_ETH   1
 
#define DHCP_INFORM   8
 
#define DHCP_MAGIC_COOKIE   0x63825363UL
 
#define DHCP_MIN_OPTIONS_LEN   68U
 
#define DHCP_MSG_LEN   236U
 
#define DHCP_NAK   6
 
#define DHCP_OFFER   2
 
#define DHCP_OPTION_BOOTFILE   67
 
#define DHCP_OPTION_BROADCAST   28
 
#define DHCP_OPTION_CLIENT_ID   61
 
#define DHCP_OPTION_DNS_SERVER   6
 
#define DHCP_OPTION_END   255
 
#define DHCP_OPTION_HOSTNAME   12
 
#define DHCP_OPTION_IP_TTL   23
 
#define DHCP_OPTION_LEASE_TIME   51 /* RFC 2132 9.2, time in seconds, in 4 bytes */
 
#define DHCP_OPTION_MAX_MSG_SIZE   57 /* RFC 2132 9.10, message size accepted >= 576 */
 
#define DHCP_OPTION_MAX_MSG_SIZE_LEN   2
 
#define DHCP_OPTION_MESSAGE_TYPE   53 /* RFC 2132 9.6, important for DHCP */
 
#define DHCP_OPTION_MESSAGE_TYPE_LEN   1
 
#define DHCP_OPTION_MTU   26
 
#define DHCP_OPTION_NTP   42
 
#define DHCP_OPTION_OVERLOAD   52 /* RFC2132 9.3, use file and/or sname field for options */
 
#define DHCP_OPTION_PAD   0
 
#define DHCP_OPTION_PARAMETER_REQUEST_LIST   55 /* RFC 2132 9.8, requested option types */
 
#define DHCP_OPTION_REQUESTED_IP   50 /* RFC 2132 9.1, requested IP address */
 
#define DHCP_OPTION_ROUTER   3
 
#define DHCP_OPTION_SERVER_ID   54 /* RFC 2132 9.7, server IP address */
 
#define DHCP_OPTION_SUBNET_MASK   1 /* RFC 2132 3.3 */
 
#define DHCP_OPTION_T1   58 /* T1 renewal time */
 
#define DHCP_OPTION_T2   59 /* T2 rebinding time */
 
#define DHCP_OPTION_TCP_TTL   37
 
#define DHCP_OPTION_TFTP_SERVERNAME   66
 
#define DHCP_OPTION_US   60
 
#define DHCP_OPTIONS_LEN   DHCP_MIN_OPTIONS_LEN
 
#define DHCP_OPTIONS_OFS   (DHCP_MSG_LEN + 4U) /* 4 byte: cookie */
 
#define DHCP_OVERLOAD_FILE   1
 
#define DHCP_OVERLOAD_NONE   0
 
#define DHCP_OVERLOAD_SNAME   2
 
#define DHCP_OVERLOAD_SNAME_FILE   3
 
#define DHCP_RELEASE   7
 
#define DHCP_REQUEST   3
 
#define DHCP_SERVER_PORT   67
 
#define DHCP_SNAME_LEN   64U
 
#define DHCP_SNAME_OFS   44U
 

Enumerations

enum  dhcp_state_enum_t {
  DHCP_STATE_OFF = 0, DHCP_STATE_REQUESTING = 1, DHCP_STATE_INIT = 2, DHCP_STATE_REBOOTING = 3,
  DHCP_STATE_REBINDING = 4, DHCP_STATE_RENEWING = 5, DHCP_STATE_SELECTING = 6, DHCP_STATE_INFORMING = 7,
  DHCP_STATE_CHECKING = 8, DHCP_STATE_PERMANENT = 9, DHCP_STATE_BOUND = 10, DHCP_STATE_RELEASING = 11,
  DHCP_STATE_BACKING_OFF = 12
}
 

Variables

PACK_STRUCT_BEGIN struct dhcp_msg PACK_STRUCT_STRUCT
 

Detailed Description

DHCP protocol definitions

Definition in file dhcp.h.

Macro Definition Documentation

◆ DHCP_ACK

#define DHCP_ACK   5

Definition at line 126 of file dhcp.h.

◆ DHCP_BOOTREPLY

#define DHCP_BOOTREPLY   2

Definition at line 119 of file dhcp.h.

◆ DHCP_BOOTREQUEST

#define DHCP_BOOTREQUEST   1

Definition at line 118 of file dhcp.h.

◆ DHCP_CHADDR_LEN

#define DHCP_CHADDR_LEN   16U

Definition at line 52 of file dhcp.h.

◆ DHCP_CLIENT_PORT

#define DHCP_CLIENT_PORT   68

Definition at line 47 of file dhcp.h.

◆ DHCP_DECLINE

#define DHCP_DECLINE   4

Definition at line 125 of file dhcp.h.

◆ DHCP_DISCOVER

#define DHCP_DISCOVER   1

Definition at line 122 of file dhcp.h.

◆ DHCP_FILE_LEN

#define DHCP_FILE_LEN   128U

Definition at line 56 of file dhcp.h.

◆ DHCP_FILE_OFS

#define DHCP_FILE_OFS   108U

Definition at line 55 of file dhcp.h.

◆ DHCP_HTYPE_ETH

#define DHCP_HTYPE_ETH   1

DHCP hardware type, currently only ethernet is supported

Definition at line 132 of file dhcp.h.

◆ DHCP_INFORM

#define DHCP_INFORM   8

Definition at line 129 of file dhcp.h.

◆ DHCP_MAGIC_COOKIE

#define DHCP_MAGIC_COOKIE   0x63825363UL

Definition at line 134 of file dhcp.h.

◆ DHCP_MIN_OPTIONS_LEN

#define DHCP_MIN_OPTIONS_LEN   68U

Definition at line 82 of file dhcp.h.

◆ DHCP_MSG_LEN

#define DHCP_MSG_LEN   236U

Definition at line 57 of file dhcp.h.

◆ DHCP_NAK

#define DHCP_NAK   6

Definition at line 127 of file dhcp.h.

◆ DHCP_OFFER

#define DHCP_OFFER   2

Definition at line 123 of file dhcp.h.

◆ DHCP_OPTION_BOOTFILE

#define DHCP_OPTION_BOOTFILE   67

Definition at line 170 of file dhcp.h.

◆ DHCP_OPTION_BROADCAST

#define DHCP_OPTION_BROADCAST   28

Definition at line 146 of file dhcp.h.

◆ DHCP_OPTION_CLIENT_ID

#define DHCP_OPTION_CLIENT_ID   61

Definition at line 168 of file dhcp.h.

◆ DHCP_OPTION_DNS_SERVER

#define DHCP_OPTION_DNS_SERVER   6

Definition at line 142 of file dhcp.h.

◆ DHCP_OPTION_END

#define DHCP_OPTION_END   255

Definition at line 149 of file dhcp.h.

◆ DHCP_OPTION_HOSTNAME

#define DHCP_OPTION_HOSTNAME   12

Definition at line 143 of file dhcp.h.

◆ DHCP_OPTION_IP_TTL

#define DHCP_OPTION_IP_TTL   23

Definition at line 144 of file dhcp.h.

◆ DHCP_OPTION_LEASE_TIME

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

Definition at line 153 of file dhcp.h.

◆ DHCP_OPTION_MAX_MSG_SIZE

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

Definition at line 162 of file dhcp.h.

◆ DHCP_OPTION_MAX_MSG_SIZE_LEN

#define DHCP_OPTION_MAX_MSG_SIZE_LEN   2

Definition at line 163 of file dhcp.h.

◆ DHCP_OPTION_MESSAGE_TYPE

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

Definition at line 156 of file dhcp.h.

◆ DHCP_OPTION_MESSAGE_TYPE_LEN

#define DHCP_OPTION_MESSAGE_TYPE_LEN   1

Definition at line 157 of file dhcp.h.

◆ DHCP_OPTION_MTU

#define DHCP_OPTION_MTU   26

Definition at line 145 of file dhcp.h.

◆ DHCP_OPTION_NTP

#define DHCP_OPTION_NTP   42

Definition at line 148 of file dhcp.h.

◆ DHCP_OPTION_OVERLOAD

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

Definition at line 154 of file dhcp.h.

◆ DHCP_OPTION_PAD

#define DHCP_OPTION_PAD   0

Definition at line 139 of file dhcp.h.

◆ DHCP_OPTION_PARAMETER_REQUEST_LIST

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

Definition at line 160 of file dhcp.h.

◆ DHCP_OPTION_REQUESTED_IP

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

Definition at line 152 of file dhcp.h.

◆ DHCP_OPTION_ROUTER

#define DHCP_OPTION_ROUTER   3

Definition at line 141 of file dhcp.h.

◆ DHCP_OPTION_SERVER_ID

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

Definition at line 159 of file dhcp.h.

◆ DHCP_OPTION_SUBNET_MASK

#define DHCP_OPTION_SUBNET_MASK   1 /* RFC 2132 3.3 */

Definition at line 140 of file dhcp.h.

◆ DHCP_OPTION_T1

#define DHCP_OPTION_T1   58 /* T1 renewal time */

Definition at line 165 of file dhcp.h.

◆ DHCP_OPTION_T2

#define DHCP_OPTION_T2   59 /* T2 rebinding time */

Definition at line 166 of file dhcp.h.

◆ DHCP_OPTION_TCP_TTL

#define DHCP_OPTION_TCP_TTL   37

Definition at line 147 of file dhcp.h.

◆ DHCP_OPTION_TFTP_SERVERNAME

#define DHCP_OPTION_TFTP_SERVERNAME   66

Definition at line 169 of file dhcp.h.

◆ DHCP_OPTION_US

#define DHCP_OPTION_US   60

Definition at line 167 of file dhcp.h.

◆ DHCP_OPTIONS_LEN

#define DHCP_OPTIONS_LEN   DHCP_MIN_OPTIONS_LEN

make sure user does not configure this too small allow this to be configured in lwipopts.h, but not too small set this to be sufficient for your options in outgoing DHCP msgs

Definition at line 90 of file dhcp.h.

◆ DHCP_OPTIONS_OFS

#define DHCP_OPTIONS_OFS   (DHCP_MSG_LEN + 4U) /* 4 byte: cookie */

Definition at line 58 of file dhcp.h.

◆ DHCP_OVERLOAD_FILE

#define DHCP_OVERLOAD_FILE   1

Definition at line 174 of file dhcp.h.

◆ DHCP_OVERLOAD_NONE

#define DHCP_OVERLOAD_NONE   0

Definition at line 173 of file dhcp.h.

◆ DHCP_OVERLOAD_SNAME

#define DHCP_OVERLOAD_SNAME   2

Definition at line 175 of file dhcp.h.

◆ DHCP_OVERLOAD_SNAME_FILE

#define DHCP_OVERLOAD_SNAME_FILE   3

Definition at line 176 of file dhcp.h.

◆ DHCP_RELEASE

#define DHCP_RELEASE   7

Definition at line 128 of file dhcp.h.

◆ DHCP_REQUEST

#define DHCP_REQUEST   3

Definition at line 124 of file dhcp.h.

◆ DHCP_SERVER_PORT

#define DHCP_SERVER_PORT   67

Definition at line 48 of file dhcp.h.

◆ DHCP_SNAME_LEN

#define DHCP_SNAME_LEN   64U

Definition at line 54 of file dhcp.h.

◆ DHCP_SNAME_OFS

#define DHCP_SNAME_OFS   44U

Definition at line 53 of file dhcp.h.

Enumeration Type Documentation

◆ dhcp_state_enum_t

enum dhcp_state_enum_t
Enumerator
DHCP_STATE_OFF 
DHCP_STATE_REQUESTING 
DHCP_STATE_INIT 
DHCP_STATE_REBOOTING 
DHCP_STATE_REBINDING 
DHCP_STATE_RENEWING 
DHCP_STATE_SELECTING 
DHCP_STATE_INFORMING 
DHCP_STATE_CHECKING 
DHCP_STATE_PERMANENT 
DHCP_STATE_BOUND 
DHCP_STATE_RELEASING 
DHCP_STATE_BACKING_OFF 

Definition at line 101 of file dhcp.h.

Variable Documentation

◆ PACK_STRUCT_STRUCT

PACK_STRUCT_BEGIN struct dhcp_msg PACK_STRUCT_STRUCT