/*****************************************************/
//  W5500_config.h
// brief WIZCHIP Config Header File.
// version 1.0.0
// date 2013/10/21
/*****************************************************/

#ifndef  _WIZCHIP_CONF_H_
#define  _WIZCHIP_CONF_H_

#include <stdint.h>
/**
 * @brief Select WIZCHIP.
 * @todo You should select one, \b 5100, \b 5200, \b 5300, \b 5500 or etc. \n\n
 *       ex> <code> #define \_WIZCHIP_      5500 </code>
 */
#ifndef _WIZCHIP_
#define _WIZCHIP_          5500   // 5100, 5200, 5300, 5500
#endif

#define _WIZCHIP_ID_     "W5500\0"

/**
 * @brief Define interface mode. \n
 * @todo Should select interface mode as chip.
 *        - @ref \_WIZCHIP_IO_MODE_SPI_ \n
 *          -@ref \_WIZCHIP_IO_MODE_SPI_VDM_ : Valid only in @ref \_WIZCHIP_ == 5500 \n
 *          -@ref \_WIZCHIP_IO_MODE_SPI_FDM_ : Valid only in @ref \_WIZCHIP_ == 5500 \n
 *        - @ref \_WIZCHIP_IO_MODE_BUS_ \n
 *          - @ref \_WIZCHIP_IO_MODE_BUS_DIR_ \n
 *          - @ref \_WIZCHIP_IO_MODE_BUS_INDIR_ \n
 *        - Others will be defined in future. \n\n
 *        ex> <code> #define \_WIZCHIP_IO_MODE_ \_WIZCHIP_IO_MODE_SPI_VDM_ </code>
 */

#define _WIZCHIP_SOCK_NUM_   8   ///< The count of independant socket of @b WIZCHIP

/**
 * @ingroup DATA_TYPE
 *  WIZCHIP control type enumration used in @ref ctlwizchip().
 */
typedef enum
{
  CW_RESET_WIZCHIP,   ///< Resets WIZCHIP by softly
  CW_INIT_WIZCHIP,    ///< Initializes to WIZCHIP with SOCKET buffer size 2 or 1 dimension array typed uint8_t.
  CW_GET_INTERRUPT,   ///< Get Interrupt status of WIZCHIP
  CW_CLR_INTERRUPT,   ///< Clears interrupt
  CW_SET_INTRMASK,    ///< Masks interrupt
  CW_GET_INTRMASK,    ///< Get interrupt mask
  CW_SET_INTRTIME,    ///< Set interval time between the current and next interrupt.
  CW_GET_INTRTIME,    ///< Set interval time between the current and next interrupt.
  CW_GET_ID,          ///< Gets WIZCHIP name.

//D20150601 : For no modification your application code
//#if _WIZCHIP_ ==  5500
  CW_RESET_PHY,       ///< Resets internal PHY. Valid Only W5500
  CW_SET_PHYCONF,     ///< When PHY configured by internal register, PHY operation mode (Manual/Auto, 10/100, Half/Full). Valid Only W5000
  CW_GET_PHYCONF,     ///< Get PHY operation mode in internal register. Valid Only W5500
  CW_GET_PHYSTATUS,   ///< Get real PHY status on operating. Valid Only W5500
  CW_SET_PHYPOWMODE,  ///< Set PHY power mode as normal and down when PHYSTATUS.OPMD == 1. Valid Only W5500
//#endif
//D20150601 : For no modification your application code
//#if _WIZCHIP_ == 5200 || _WIZCHIP_ == 5500
  CW_GET_PHYPOWMODE,  ///< Get PHY Power mode as down or normal, Valid Only W5100, W5200
  CW_GET_PHYLINK      ///< Get PHY Link status, Valid Only W5100, W5200
//#endif
} ctlwizchip_type;

/**
 * @ingroup DATA_TYPE
 *  Network control type enumration used in @ref ctlnetwork().
 */
typedef enum
{
  CN_SET_NETINFO,  ///< Set Network with @ref wiz_NetInfo
  CN_GET_NETINFO,  ///< Get Network with @ref wiz_NetInfo
  CN_SET_NETMODE,  ///< Set network mode as WOL, PPPoE, Ping Block, and Force ARP mode
  CN_GET_NETMODE,  ///< Get network mode as WOL, PPPoE, Ping Block, and Force ARP mode
  CN_SET_TIMEOUT,  ///< Set network timeout as retry count and time.
  CN_GET_TIMEOUT,  ///< Get network timeout as retry count and time.
} ctlnetwork_type;

/**
 * @ingroup DATA_TYPE
 *  Interrupt kind when CW_SET_INTRRUPT, CW_GET_INTERRUPT, CW_SET_INTRMASK
 *  and CW_GET_INTRMASK is used in @ref ctlnetwork().
 *  It can be used with OR operation.
 */
typedef enum
{
  IK_WOL               = (1 <<  4),  ///< Wake On Lan by receiving the magic packet. Valid in W500.
  IK_PPPOE_TERMINATED  = (1 <<  5),  ///< PPPoE Disconnected
  IK_DEST_UNREACH      = (1 <<  6),  ///< Destination IP & Port Unreachable, No use in W5200
  IK_IP_CONFLICT       = (1 <<  7),  ///< IP conflict occurred
  IK_SOCK_0            = (1 <<  8),  ///< Socket 0 interrupt
  IK_SOCK_1            = (1 <<  9),  ///< Socket 1 interrupt
  IK_SOCK_2            = (1 << 10),  ///< Socket 2 interrupt
  IK_SOCK_3            = (1 << 11),  ///< Socket 3 interrupt
  IK_SOCK_4            = (1 << 12),  ///< Socket 4 interrupt, No use in 5100
  IK_SOCK_5            = (1 << 13),  ///< Socket 5 interrupt, No use in 5100
  IK_SOCK_6            = (1 << 14),  ///< Socket 6 interrupt, No use in 5100
  IK_SOCK_7            = (1 << 15),  ///< Socket 7 interrupt, No use in 5100

  IK_SOCK_ALL          = (0xFF << 8) ///< All Socket interrupt
}intr_kind;

#define PHY_CONFBY_HW            0     ///< Configured PHY operation mode by HW pin
#define PHY_CONFBY_SW            1     ///< Configured PHY operation mode by SW register
#define PHY_MODE_MANUAL          0     ///< Configured PHY operation mode with user setting.
#define PHY_MODE_AUTONEGO        1     ///< Configured PHY operation mode with auto-negotiation
#define PHY_SPEED_10             0     ///< Link Speed 10
#define PHY_SPEED_100            1     ///< Link Speed 100
#define PHY_DUPLEX_HALF          0     ///< Link Half-Duplex
#define PHY_DUPLEX_FULL          1     ///< Link Full-Duplex
#define PHY_LINK_OFF             0     ///< Link Off
#define PHY_LINK_ON              1     ///< Link On
#define PHY_POWER_NORM           0     ///< PHY power normal mode
#define PHY_POWER_DOWN           1     ///< PHY power down mode


/**
 * @ingroup DATA_TYPE
 *  It configures PHY configuration when CW_SET PHYCONF or CW_GET_PHYCONF in W5500,
 *  and it indicates the real PHY status configured by HW or SW in all WIZCHIP. \n
 *  Valid only in W5500.
 */
typedef struct wiz_PhyConf_t
{
  uint8_t by;       ///< set by @ref PHY_CONFBY_HW or @ref PHY_CONFBY_SW
  uint8_t mode;     ///< set by @ref PHY_MODE_MANUAL or @ref PHY_MODE_AUTONEGO
  uint8_t speed;    ///< set by @ref PHY_SPEED_10 or @ref PHY_SPEED_100
  uint8_t duplex;   ///< set by @ref PHY_DUPLEX_HALF @ref PHY_DUPLEX_FULL
  //uint8_t power;  ///< set by @ref PHY_POWER_NORM or @ref PHY_POWER_DOWN
  //uint8_t link;   ///< Valid only in CW_GET_PHYSTATUS. set by @ref PHY_LINK_ON or PHY_DUPLEX_OFF
} wiz_PhyConf;

/**
 * @ingroup DATA_TYPE
 *  It used in setting dhcp_mode of @ref wiz_NetInfo.
 */
typedef enum
{
  NETINFO_STATIC = 1,    ///< Static IP configuration by manually.
  NETINFO_DHCP           ///< Dynamic IP configruation from a DHCP sever
} dhcp_mode;

/**
 * @ingroup DATA_TYPE
 *  Network Information for WIZCHIP
 */
typedef struct wiz_NetInfo_t
{
  uint8_t mac[6];  ///< Source Mac Address
  uint8_t ip[4];   ///< Source IP Address
  uint8_t sn[4];   ///< Subnet Mask
  uint8_t gw[4];   ///< Gateway IP Address
  uint8_t dns[4];  ///< DNS server IP Address
  dhcp_mode dhcp;  ///< 1 - Static, 2 - DHCP
} wiz_NetInfo;

/**
 * @ingroup DATA_TYPE
 *  Network mode
 */
typedef enum
{
  NM_FORCEARP    = (1<<1),  ///< Force to APP send whenever udp data is sent. Valid only in W5500
  NM_WAKEONLAN   = (1<<5),  ///< Wake On Lan
  NM_PINGBLOCK   = (1<<4),  ///< Block ping-request
  NM_PPPOE       = (1<<3),  ///< PPPoE mode
} netmode_type;

/**
 * @ingroup DATA_TYPE
 *  Used in CN_SET_TIMEOUT or CN_GET_TIMEOUT of @ref ctlwizchip() for timeout configruation.
 */
typedef struct wiz_NetTimeout_t
{
  uint8_t  retry_cnt;     ///< retry count
  uint16_t time_100us;    ///< time unit 100us
} wiz_NetTimeout;


/* @ingroup extra_functions
 * @brief Controls to the WIZCHIP.
 * @details Resets WIZCHIP & internal PHY, Configures PHY mode, Monitor PHY(Link,Speed,Half/Full/Auto),
 * controls interrupt & mask and so on.
 * @param cwtype : Decides to the control type
 * @param arg : arg type is dependent on cwtype.
 * @return  0 : Success \n
 *         -1 : Fail because of invalid \ref ctlwizchip_type or unsupported \ref ctlwizchip_type in WIZCHIP
 */
int8_t ctlwizchip (ctlwizchip_type cwtype, void* arg);


/* @ingroup extra_functions
 * @brief Controls to network.
 * @details Controls to network environment, mode, timeout and so on.
 * @param cntype : Input. Decides to the control type
 * @param arg : Inout. arg type is dependent on cntype.
 * @return -1 : Fail because of invalid \ref ctlnetwork_type or unsupported \ref ctlnetwork_type in WIZCHIP \n
 *          0 : Success
 */
int8_t ctlnetwork (ctlnetwork_type cntype, void* arg);



/* The following functions are implemented for internal use.
 * but You can call these functions for code size reduction instead of ctlwizchip() and ctlnetwork().
 */


/* @ingroup extra_functions
 * @brief Reset WIZCHIP by softly.
 */
void w5500cfg_sw_reset (void);


/* @ingroup extra_functions
 * @brief Initializes WIZCHIP with socket buffer size
 * @param txsize Socket tx buffer sizes. If null, initialized the default size 2KB.
 * @param rxsize Socket rx buffer sizes. If null, initialized the default size 2KB.
 * @return 0 : succcess \n
 *        -1 : fail. Invalid buffer size
 */
int8_t w5500cfg_init (uint8_t* txsize, uint8_t* rxsize);


/* @ingroup extra_functions
 * @brief Clear Interrupt of WIZCHIP.
 * @param intr : @ref intr_kind value operated OR. It can type-cast to uint16_t.
 */
void w5500cfg_clrinterrupt (intr_kind intr);


/* @ingroup extra_functions
 * @brief Get Interrupt of WIZCHIP.
 * @return @ref intr_kind value operated OR. It can type-cast to uint16_t.
 */
intr_kind w5500cfg_getinterrupt (void);


/* @ingroup extra_functions
 * @brief Mask or Unmask Interrupt of WIZCHIP.
 * @param intr : @ref intr_kind value operated OR. It can type-cast to uint16_t.
 */
void w5500cfg_setinterruptmask (intr_kind intr);


/* @ingroup extra_functions
 * @brief Get Interrupt mask of WIZCHIP.
 * @return : The operated OR vaule of @ref intr_kind. It can type-cast to uint16_t.
 */
intr_kind w5500cfg_getinterruptmask (void);

int8_t wizphy_getphylink(void);              ///< get the link status of phy in WIZCHIP. No use in W5100
int8_t wizphy_getphypmode(void);             ///< get the power mode of PHY in WIZCHIP. No use in W5100

void   wizphy_reset(void);                   ///< Reset phy. Vailid only in W5500

/* @ingroup extra_functions
 * @brief Set the phy information for WIZCHIP without power mode
 * @param phyconf : @ref wiz_PhyConf
 */
void   wizphy_setphyconf(wiz_PhyConf* phyconf);

/* @ingroup extra_functions
 * @brief Get phy configuration information.
 * @param phyconf : @ref wiz_PhyConf
 */
void   wizphy_getphyconf(wiz_PhyConf* phyconf);

/* @ingroup extra_functions
 * @brief Get phy status.
 * @param phyconf : @ref wiz_PhyConf
 */
void   wizphy_getphystat(wiz_PhyConf* phyconf);

/* @ingroup extra_functions
 * @brief set the power mode of phy inside WIZCHIP. Refer to @ref PHYCFGR in W5500, @ref PHYSTATUS in W5200
 * @param pmode Settig value of power down mode.
 */
   int8_t wizphy_setphypmode(uint8_t pmode);

/* @ingroup extra_functions
 * @brief Set the network information for WIZCHIP
 * @param pnetinfo : @ref wizNetInfo
 */
void w5500cfg_setnetinfo(wiz_NetInfo* pnetinfo);


/* @ingroup extra_functions
 * @brief Get the network information for WIZCHIP
 * @param pnetinfo : @ref wizNetInfo
 */
void w5500cfg_getnetinfo(wiz_NetInfo* pnetinfo);


/* @ingroup extra_functions
 * @brief Set the network mode such WOL, PPPoE, Ping Block, and etc.
 * @param pnetinfo Value of network mode. Refer to @ref netmode_type.
 */
int8_t w5500cfg_setnetmode(netmode_type netmode);


/* @ingroup extra_functions
 * @brief Get the network mode such WOL, PPPoE, Ping Block, and etc.
 * @return Value of network mode. Refer to @ref netmode_type.
 */
netmode_type w5500cfg_getnetmode(void);


/* @ingroup extra_functions
 * @brief Set retry time value(@ref _RTR_) and retry count(@ref _RCR_).
 * @details @ref _RTR_ configures the retransmission timeout period and @ref _RCR_ configures the number of time of retransmission.
 * @param nettime @ref _RTR_ value and @ref _RCR_ value. Refer to @ref wiz_NetTimeout.
 */
void w5500cfg_settimeout(wiz_NetTimeout* nettime);


/* @ingroup extra_functions
 * @brief Get retry time value(@ref _RTR_) and retry count(@ref _RCR_).
 * @details @ref _RTR_ configures the retransmission timeout period and @ref _RCR_ configures the number of time of retransmission.
 * @param nettime @ref _RTR_ value and @ref _RCR_ value. Refer to @ref wiz_NetTimeout.
 */
void w5500cfg_gettimeout(wiz_NetTimeout* nettime);

#endif   // _WIZCHIP_CONF_H_

/* ----------------------------------------------*/
/* -------- End of file W5500_config.h --------- */
/* ----------------------------------------------*/