wizchip_conf.h

Go to the documentation of this file.

//*****************************************************************************
//
//
//*****************************************************************************
 
#ifndef _WIZCHIP_CONF_H_
#define _WIZCHIP_CONF_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
#define W5100  5100
#define W5100S 5100 + 5
#define W5200  5200
#define W5300  5300
#define W5500  5500
 
#ifndef _WIZCHIP_
#define _WIZCHIP_ W5500 // W5100, W5100S, W5200, W5300, W5500
#endif
 
#define _WIZCHIP_IO_MODE_NONE_ 0x0000
#define _WIZCHIP_IO_MODE_BUS_  0x0100 
#define _WIZCHIP_IO_MODE_SPI_  0x0200 
//#define _WIZCHIP_IO_MODE_IIC_          0x0400
//#define _WIZCHIP_IO_MODE_SDIO_         0x0800
// Add to
//
 
#define _WIZCHIP_IO_MODE_BUS_DIR_   (_WIZCHIP_IO_MODE_BUS_ + 1) 
#define _WIZCHIP_IO_MODE_BUS_INDIR_ (_WIZCHIP_IO_MODE_BUS_ + 2) 
#define _WIZCHIP_IO_MODE_SPI_VDM_  (_WIZCHIP_IO_MODE_SPI_ + 1) 
#define _WIZCHIP_IO_MODE_SPI_FDM_  (_WIZCHIP_IO_MODE_SPI_ + 2) 
#define _WIZCHIP_IO_MODE_SPI_5500_ (_WIZCHIP_IO_MODE_SPI_ + 3) 
#if (_WIZCHIP_ == W5100)
#define _WIZCHIP_ID_ "W5100\0"
//  #define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_BUS_DIR_
//  #define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_BUS_INDIR_
#define _WIZCHIP_IO_MODE_ _WIZCHIP_IO_MODE_SPI_
 
//A20150601 : Define the unit of IO DATA.
typedef uint8_t iodata_t;
//A20150401 : Indclude W5100.h file
#include "W5100/w5100.h"
 
#elif (_WIZCHIP_ == W5100S)
#define _WIZCHIP_ID_      "W5100S\0"
//  #define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_BUS_INDIR_
//#define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_SPI_5500_
#define _WIZCHIP_IO_MODE_ _WIZCHIP_IO_MODE_SPI_
 
//A20150601 : Define the unit of IO DATA.
typedef uint8_t iodata_t;
//A20150401 : Indclude W5100.h file
#include "W5100S/w5100s.h"
#elif (_WIZCHIP_ == W5200)
#define _WIZCHIP_ID_ "W5200\0"
#ifndef _WIZCHIP_IO_MODE_
// #define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_BUS_INDIR_
#define _WIZCHIP_IO_MODE_ _WIZCHIP_IO_MODE_SPI_
#endif
//A20150601 : Define the unit of IO DATA.
typedef uint8_t iodata_t;
#include "W5200/w5200.h"
#elif (_WIZCHIP_ == W5500)
#define _WIZCHIP_ID_ "W5500\0"
 
#ifndef _WIZCHIP_IO_MODE_
//#define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_SPI_FDM_
#define _WIZCHIP_IO_MODE_ _WIZCHIP_IO_MODE_SPI_VDM_
#endif
//A20150601 : Define the unit of IO DATA.
typedef uint8_t iodata_t;
#include "w5500.h"
#elif (_WIZCHIP_ == W5300)
#define _WIZCHIP_ID_ "W5300\0"
#ifndef _WIZCHIP_IO_MODE_
#define _WIZCHIP_IO_MODE_ _WIZCHIP_IO_MODE_BUS_DIR_
// #define _WIZCHIP_IO_MODE_           _WIZCHIP_IO_MODE_BUS_INDIR_
#endif
 
//A20150601 : Define the unit and bus width of IO DATA.
#ifndef _WIZCHIP_IO_BUS_WIDTH_
#define _WIZCHIP_IO_BUS_WIDTH_ 16 // 8
#endif
#if _WIZCHIP_IO_BUS_WIDTH_ == 8
typedef uint8_t iodata_t;
#elif _WIZCHIP_IO_BUS_WIDTH_ == 16
typedef uint16_t iodata_t;
#else
#error "Unknown _WIZCHIP_IO_BUS_WIDTH_. It should be 8 or 16."
#endif
//
#include "W5300/w5300.h"
#else
#error "Unknown defined _WIZCHIP_. You should define one of 5100, 5200, and 5500 !!!"
#endif
 
#ifndef _WIZCHIP_IO_MODE_
#error "Undefined _WIZCHIP_IO_MODE_. You should define it !!!"
#endif
 
#if _WIZCHIP_IO_MODE_ & _WIZCHIP_IO_MODE_BUS_
//  #define _WIZCHIP_IO_BASE_               0x60000000  // for 5100S IND
#define _WIZCHIP_IO_BASE_ 0x68000000 // for W5300
#elif _WIZCHIP_IO_MODE_ & _WIZCHIP_IO_MODE_SPI_
#define _WIZCHIP_IO_BASE_ 0x00000000 // for 5100S SPI
#endif
 
#ifndef _WIZCHIP_IO_BASE_
#define _WIZCHIP_IO_BASE_ 0x00000000 // 0x8000
#endif
 
//M20150401 : Typing Error
//#if _WIZCHIP_IO_MODE_ & _WIZCHIP_IO_MODE_BUS
#if _WIZCHIP_IO_MODE_ & _WIZCHIP_IO_MODE_BUS_
#ifndef _WIZCHIP_IO_BASE_
#error "You should be define _WIZCHIP_IO_BASE to fit your system memory map."
#endif
#endif
 
#if _WIZCHIP_ >= W5200
#define _WIZCHIP_SOCK_NUM_ 8 
#else
#define _WIZCHIP_SOCK_NUM_ 4 
#endif
 
/********************************************************
* WIZCHIP BASIC IF functions for SPI, SDIO, I2C , ETC.
*********************************************************/
typedef struct __WIZCHIP {
    uint16_t if_mode; 
    uint8_t id[8]; 
 
    struct _CRIS {
        void (*_enter)(void); 
        void (*_exit)(void); 
    } CRIS;
 
    struct _CS {
        void (*_select)(void); 
        void (*_deselect)(void); 
    } CS;
 
    union _IF {
        //M20156501 : Modify the function name for integrating with W5300
        //struct
        //{
        //   uint8_t  (*_read_byte)  (uint32_t AddrSel);
        //   void     (*_write_byte) (uint32_t AddrSel, uint8_t wb);
        //}BUS;
        struct
        {
            iodata_t (*_read_data)(uint32_t AddrSel);
            void (*_write_data)(uint32_t AddrSel, iodata_t wb);
        } BUS;
 
        struct
        {
            uint8_t (*_read_byte)(uint32_t addr);
            void (*_write_byte)(uint32_t addr, uint8_t wb);
            void (*_read_burst)(uint32_t addr, uint8_t* pBuf, uint16_t len);
            void (*_write_burst)(uint32_t addr, uint8_t* pBuf, uint16_t len);
        } SPI;
 
        // To be added
        //
    } IF;
} _WIZCHIP;
 
extern _WIZCHIP WIZCHIP;
 
typedef enum {
    CW_RESET_WIZCHIP, 
    CW_INIT_WIZCHIP, 
    CW_GET_INTERRUPT, 
    CW_CLR_INTERRUPT, 
    CW_SET_INTRMASK, 
    CW_GET_INTRMASK, 
    CW_SET_INTRTIME, 
    CW_GET_INTRTIME, 
    CW_GET_ID, 
 
    //D20150601 : For no modification your application code
    //#if _WIZCHIP_ ==  W5500
    CW_RESET_PHY, 
    CW_SET_PHYCONF, 
    CW_GET_PHYCONF, 
    CW_GET_PHYSTATUS, 
    CW_SET_PHYPOWMODE, 
    //#endif
    //D20150601 : For no modification your application code
    //#if _WIZCHIP_ == W5200 || _WIZCHIP_ == W5500
    CW_GET_PHYPOWMODE, 
    CW_GET_PHYLINK 
    //#endif
} ctlwizchip_type;
 
typedef enum {
    CN_SET_NETINFO, 
    CN_GET_NETINFO, 
    CN_SET_NETMODE, 
    CN_GET_NETMODE, 
    CN_SET_TIMEOUT, 
    CN_GET_TIMEOUT, 
} ctlnetwork_type;
 
typedef enum {
#if _WIZCHIP_ == W5500
    IK_WOL = (1 << 4), 
#elif _WIZCHIP_ == W5300
    IK_FMTU = (1 << 4), 
#endif
 
    IK_PPPOE_TERMINATED = (1 << 5), 
 
#if _WIZCHIP_ != W5200
    IK_DEST_UNREACH = (1 << 6), 
#endif
 
    IK_IP_CONFLICT = (1 << 7), 
 
    IK_SOCK_0 = (1 << 8), 
    IK_SOCK_1 = (1 << 9), 
    IK_SOCK_2 = (1 << 10), 
    IK_SOCK_3 = (1 << 11), 
#if _WIZCHIP_ > W5100S
    IK_SOCK_4 = (1 << 12), 
    IK_SOCK_5 = (1 << 13), 
    IK_SOCK_6 = (1 << 14), 
    IK_SOCK_7 = (1 << 15), 
#endif
 
#if _WIZCHIP_ > W5100S
    IK_SOCK_ALL = (0xFF << 8) 
#else
    IK_SOCK_ALL = (0x0F << 8) 
#endif
} intr_kind;
 
#define PHY_CONFBY_HW     0 
#define PHY_CONFBY_SW     1 
#define PHY_MODE_MANUAL   0 
#define PHY_MODE_AUTONEGO 1 
#define PHY_SPEED_10      0 
#define PHY_SPEED_100     1 
#define PHY_DUPLEX_HALF   0 
#define PHY_DUPLEX_FULL   1 
#define PHY_LINK_OFF      0 
#define PHY_LINK_ON       1 
#define PHY_POWER_NORM    0 
#define PHY_POWER_DOWN    1 
 
#if _WIZCHIP_ == W5100S || _WIZCHIP_ == W5500
typedef struct wiz_PhyConf_t {
    uint8_t by; 
    uint8_t mode; 
    uint8_t speed; 
    uint8_t duplex; 
    //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;
#endif
 
typedef enum {
    NETINFO_STATIC = 1, 
    NETINFO_DHCP 
} dhcp_mode;
 
typedef struct wiz_NetInfo_t {
    uint8_t mac[6]; 
    uint8_t ip[4]; 
    uint8_t sn[4]; 
    uint8_t gw[4]; 
    uint8_t dns[4]; 
    dhcp_mode dhcp; 
} wiz_NetInfo;
 
typedef enum {
#if _WIZCHIP_ == W5500
    NM_FORCEARP = (1 << 1), 
#endif
    NM_WAKEONLAN = (1 << 5), 
    NM_PINGBLOCK = (1 << 4), 
    NM_PPPOE     = (1 << 3), 
} netmode_type;
 
typedef struct wiz_NetTimeout_t {
    uint8_t retry_cnt; 
    uint16_t time_100us; 
} wiz_NetTimeout;
 
void reg_wizchip_cris_cbfunc(void (*cris_en)(void), void (*cris_ex)(void));
 
void reg_wizchip_cs_cbfunc(void (*cs_sel)(void), void (*cs_desel)(void));
 
//M20150601 : For integrating with W5300
//void reg_wizchip_bus_cbfunc(uint8_t (*bus_rb)(uint32_t addr), void (*bus_wb)(uint32_t addr, uint8_t wb));
void reg_wizchip_bus_cbfunc(iodata_t (*bus_rb)(uint32_t addr), void (*bus_wb)(uint32_t addr, iodata_t wb));
 
void reg_wizchip_spi_cbfunc(uint8_t (*spi_rb)(uint32_t addr), void (*spi_wb)(uint32_t addr, uint8_t wb));
 
void reg_wizchip_spiburst_cbfunc(void (*spi_rb)(uint32_t addr, uint8_t* pBuf, uint16_t len), void (*spi_wb)(uint32_t addr, uint8_t* pBuf, uint16_t len));
 
int8_t ctlwizchip(ctlwizchip_type cwtype, void* arg);
 
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().
 */
 
void wizchip_sw_reset(void);
 
int8_t wizchip_init(uint8_t* txsize, uint8_t* rxsize);
 
void wizchip_clrinterrupt(intr_kind intr);
 
intr_kind wizchip_getinterrupt(void);
 
void wizchip_setinterruptmask(intr_kind intr);
 
intr_kind wizchip_getinterruptmask(void);
 
//todo
#if _WIZCHIP_ > W5100
int8_t wizphy_getphylink(void); 
int8_t wizphy_getphypmode(void); 
#endif
 
#if _WIZCHIP_ == W5100S || _WIZCHIP_ == W5500
void wizphy_reset(void); 
void wizphy_setphyconf(wiz_PhyConf* phyconf);
void wizphy_getphyconf(wiz_PhyConf* phyconf);
void wizphy_getphystat(wiz_PhyConf* phyconf);
int8_t wizphy_setphypmode(uint8_t pmode);
#endif
 
void wizchip_setnetinfo(wiz_NetInfo* pnetinfo);
 
void wizchip_getnetinfo(wiz_NetInfo* pnetinfo);
 
int8_t wizchip_setnetmode(netmode_type netmode);
 
netmode_type wizchip_getnetmode(void);
 
void wizchip_settimeout(wiz_NetTimeout* nettime);
 
void wizchip_gettimeout(wiz_NetTimeout* nettime);
#ifdef __cplusplus
}
#endif
 
#endif // _WIZCHIP_CONF_H_