oc_dhcp.h

Go to the documentation of this file.

#ifndef SYSTEM_CORE_INC_NET_OC_DHCP_H_
#define SYSTEM_CORE_INC_NET_OC_DHCP_H_

#include <oc_stdtypes.h>
#include <oc_compiler.h>
#include <oc_net.h>
#include <oc_netif.h>

#define _________________________________________DEFINITIONS_SECTION________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_DHCP_MAGIC_COOKIE        0x63825363

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_DHCP_END_OPTION          0xFF

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_DHCP_OPTIONS_BUFFER_SIZE     600

#undef  _________________________________________DEFINITIONS_SECTION________________________________________________________________________


#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Dhcp_OperationCode_Request = 1 ,
    oC_Dhcp_OperationCode_Reply   = 2 ,
} oC_Dhcp_OperationCode_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Dhcp_HardwareType_Ethernet                   = 1 ,  
    oC_Dhcp_HardwareType_IEEE802Networks            = 6 ,  
    oC_Dhcp_HardwareType_ARCNET                     = 7 ,  
    oC_Dhcp_HardwareType_LocalTalk                  = 11 , 
    oC_Dhcp_HardwareType_LocalNet                   = 12 , 
    oC_Dhcp_HardwareType_SMDS                       = 14 , 
    oC_Dhcp_HardwareType_FrameRelay                 = 15 , 
    oC_Dhcp_HardwareType_AsynchronousTransferMode   = 16 , 
    oC_Dhcp_HardwareType_HDLC                       = 17 , 
    oC_Dhcp_HardwareType_FibreChannel               = 18 , 
    oC_Dhcp_HardwareType_SerialLine                 = 20 , 
} oC_Dhcp_HardwareType_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Dhcp_Flags_None          = 0 ,     
    oC_Dhcp_Flags_Broadcast     = 0x8000 ,
} oC_Dhcp_Flags_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Dhcp_Option_Pad              = 0 ,                 
    oC_Dhcp_Option_End              = oC_DHCP_END_OPTION ,
    oC_Dhcp_Option_SubnetMask       = 1 ,                 
    oC_Dhcp_Option_TimeOffset       = 2 ,                 
    oC_Dhcp_Option_Router           = 3 ,                 
    oC_Dhcp_Option_DnsServer        = 6 ,                 
    oC_Dhcp_Option_Hostname         = 12 ,                
    oC_Dhcp_Option_DefaultTTL       = 23 ,                
    oC_Dhcp_Option_MTU              = 26 ,                
    oC_Dhcp_Option_Broadcast        = 28 ,                
    oC_Dhcp_Option_TcpTTL           = 37 ,                
    oC_Dhcp_Option_Ntp              = 42 ,                

    oC_Dhcp_Option_RequestedIp      = 50 ,                
    oC_Dhcp_Option_LeaseTime        = 51 ,                
    oC_Dhcp_Option_Overload         = 52 ,                
    oC_Dhcp_Option_ServerId         = 54 ,                
    oC_Dhcp_Option_RequestedList    = 55 ,                
    oC_Dhcp_Option_MessageType      = 53 ,                
    oC_Dhcp_Option_T1RenewalTime    = 58 ,                
    oC_Dhcp_Option_T2RebingingTime  = 59 ,                
    oC_Dhcp_Option_ClientId         = 61 ,                
    oC_Dhcp_Option_TftpServerName   = 66 ,                
    oC_Dhcp_Option_Bootfile         = 67 ,                
} oC_Dhcp_Option_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_Dhcp_OptionLength_SubnetMask         = 4 ,
    oC_Dhcp_OptionLength_TimeOffset         = 4 ,
    oC_Dhcp_OptionLength_RouterMin          = 4 ,
    oC_Dhcp_OptionLength_DnsServerMin       = 4 ,
    oC_Dhcp_OptionLength_HostnameMin        = 1 ,
    oC_Dhcp_OptionLength_DefaultTTL         = 1 ,
    oC_Dhcp_OptionLength_MTU                = 2 ,
    oC_Dhcp_OptionLength_Broadcast          = 4 ,
    oC_Dhcp_OptionLength_TcpTTL             = 1 ,
    oC_Dhcp_OptionLength_NtpMin             = 4 ,

    oC_Dhcp_OptionLength_RequestedIp        = 4 ,
    oC_Dhcp_OptionLength_LeaseTime          = 4 ,
    oC_Dhcp_OptionLength_Overload           = 1 ,
    oC_Dhcp_OptionLength_ServerId           = 4 ,
    oC_Dhcp_OptionLength_RequestedListMin   = 1 ,
    oC_Dhcp_OptionLength_MessageType        = 1 ,
    oC_Dhcp_OptionLength_T1RenevalTime      = 4 ,
    oC_Dhcp_OptionLength_T2RebindingTime    = 4 ,
    oC_Dhcp_OptionLength_ClientIdMin        = 2 ,
    oC_Dhcp_OptionLength_TftpServerNameMin  = 1 ,
    oC_Dhcp_OptionLength_BootfileMin        = 1 ,
} oC_Dhcp_OptionLength_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct PACKED
{
#ifdef LITTLE_ENDIAN
    uint32_t        Operation:8;                          
    uint32_t        HardwareType:8;                       
    uint32_t        HardwareAddressLength:8;              
    uint32_t        Hops:8;                               
    uint32_t        XID;                                  
    uint32_t        Secs:16;                              
    uint32_t        Flags:16;                             
    uint32_t        CIAddr;                               
    uint32_t        YIAddr;                               
    uint32_t        SIAddr;                               
    uint32_t        GIAddr;                               
    uint8_t         CHAddr[16];                           
    char            SName[64];                            
    char            File[128];                            
    uint32_t        MagicCookie;                          
    uint8_t         Options[oC_DHCP_OPTIONS_BUFFER_SIZE]; 

#elif defined(BIG_ENDIAN)
#   error   The structure is not defined for BIG_ENDIAN
#else
#   error   Endianess is not correct
#endif
} oC_Dhcp_Message_t ;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________FUNCTIONS_SECTION__________________________________________________________________________

extern oC_ErrorCode_t oC_Dhcp_SendMessage               ( oC_Netif_t Netif , oC_Dhcp_Message_t * Message    , uint16_t Size, oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_ReceiveMessage            ( oC_Netif_t Netif , oC_Dhcp_Message_t * outMessage , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_RequestIp                 ( oC_Netif_t Netif , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_SendDiscovery             ( oC_Netif_t Netif , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_ReceiveOffer              ( oC_Netif_t Netif , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_SendRequest               ( oC_Netif_t Netif , oC_Time_t Timeout );
extern oC_ErrorCode_t oC_Dhcp_ReceiveAcknowledge        ( oC_Netif_t Netif , oC_Time_t Timeout );

#undef  _________________________________________FUNCTIONS_SECTION__________________________________________________________________________


#endif /* SYSTEM_CORE_INC_NET_OC_DHCP_H_ */