dhcpv4.h

Go to the documentation of this file.

//*****************************************************************************
//
//
//*****************************************************************************
#ifndef _DHCP_H_
#define _DHCP_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * @brief
 * @details If you want to display debug & processing message, Define _DHCPV4_DEBUG_
 * @note    If defined, it depends on <stdio.h>
 */
//#define _DHCPV4_DEBUG_
 
 
/* Retry to processing DHCP */
#define MAX_DHCPV4_RETRY          2        
#define DHCPV4_WAIT_TIME          10       
 
 
/* UDP port numbers for DHCP */
#define DHCPV4_SERVER_PORT          67        
#define DHCPV4_CLIENT_PORT         68         
 
 
#define MAGIC_COOKIE             0x63825363  
 
#define DCHPV4_HOST_NAME           "WIZnet\0"
 
/*
 * @brief return value of @ref DHCPv4_run()
 */
enum
{
   DHCPV4_FAILED = 0,  
   DHCPV4_RUNNING,     
   DHCP_IPV4_ASSIGN,   
   DHCP_IPV4_CHANGED,  
   DHCP_IPV4_LEASED,   
   DHCPV4_STOPPED      
};
 
/*
 * @brief DHCP client initialization (outside of the main loop)
 * @param s   - socket number
 * @param buf - buffer for processing DHCP message
 */
void DHCPv4_init(uint8_t s, uint8_t * buf);
 
/*
 * @brief DHCP 1s Tick Timer handler
 * @note SHOULD BE register to your system 1s Tick timer handler
 */
void DHCPv4_time_handler(void);
 
/*
 * @brief Register call back function
 * @param ip_assign   - callback func when IP is assigned from DHCP server first
 * @param ip_update   - callback func when IP is changed
 * @param ip_conflict - callback func when the assigned IP is conflict with others.
 */
void reg_dhcpv4_cbfunc(void(*ip_assign)(void), void(*ip_update)(void), void(*ip_conflict)(void));
 
/*
 * @brief DHCP client in the main loop
 * @return    The value is as the follow \n
 *            @ref DHCPV4_FAILED     \n
 *            @ref DHCPv4_runNING    \n
 *            @ref DHCP_IPV4_ASSIGN  \n
 *            @ref DHCP_IPV4_CHANGED \n
 *            @ref DHCP_IPV4_LEASED  \n
 *            @ref DHCPV4_STOPPED    \n
 *
 * @note This function is always called by you main task.
 */
uint8_t DHCPv4_run(void);
 
/*
 * @brief Stop DHCP processing
 * @note If you want to restart. call DHCPv4_init() and DHCPv4_run()
 */
void    DHCPv4_stop(void);
 
/* Get Network information assigned from DHCP server */
/*
 * @brief Get IP address
 * @param ip  - IP address to be returned
 */
void getIPfromDHCPv4(uint8_t* ip);
/*
 * @brief Get Gateway address
 * @param ip  - Gateway address to be returned
 */
void getGWfromDHCPv4(uint8_t* ip);
/*
 * @brief Get Subnet mask value
 * @param ip  - Subnet mask to be returned
 */
void getSNfromDHCPv4(uint8_t* ip);
/*
 * @brief Get DNS address
 * @param ip  - DNS address to be returned
 */
void getDNSfromDHCPv4(uint8_t* ip);
 
/*
 * @brief Get the leased time by DHCP sever
 * @return unit 1s
 */
uint32_t getDHCPv4Leasetime(void);
 
#ifdef __cplusplus
}
#endif
 
#endif  /* _DHCP_H_ */