WIZnet / Ethernet

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   W5500

Fork of Ethernet by Raphael Kwon

Embed: (wiki syntax)

« Back to documentation index

wizchip_conf.h File Reference
Data Structures | Typedefs | Enumerations | Functions | Variables

wizchip_conf.h File Reference

WIZCHIP Config Header File. More...

Go to the source code of this file.

Data Structures

struct  __WIZCHIP
 The set of callback functions for W5500:WIZCHIP_IO_Functions W5200:WIZCHIP_IO_Functions_W5200. More...
struct  __WIZCHIP::_CRIS
 The set of critical section callback func. More...
struct  __WIZCHIP::_CS
 The set of select control callback func. More...
union  __WIZCHIP::_IF
 The set of interface IO callback func. More...
struct  wiz_PhyConf_t
 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. More...
struct  wiz_NetInfo_t
 Network Information for WIZCHIP. More...
struct  wiz_NetTimeout_t
 Used in CN_SET_TIMEOUT or CN_GET_TIMEOUT of ctlwizchip() for timeout configruation. More...

Typedefs

typedef struct __WIZCHIP _WIZCHIP
 The set of callback functions for W5500:WIZCHIP_IO_Functions W5200:WIZCHIP_IO_Functions_W5200.
typedef struct wiz_PhyConf_t wiz_PhyConf
 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.
typedef struct wiz_NetInfo_t wiz_NetInfo
 Network Information for WIZCHIP.
typedef struct wiz_NetTimeout_t wiz_NetTimeout
 Used in CN_SET_TIMEOUT or CN_GET_TIMEOUT of ctlwizchip() for timeout configruation.

Enumerations

enum  ctlwizchip_type {
  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, CW_RESET_PHY, CW_SET_PHYCONF, CW_GET_PHYCONF,
  CW_GET_PHYSTATUS, CW_SET_PHYPOWMODE, CW_GET_PHYPOWMODE, CW_GET_PHYLINK
}
 

WIZCHIP control type enumration used in ctlwizchip().

More...
enum  ctlnetwork_type {
  CN_SET_NETINFO, CN_GET_NETINFO, CN_SET_NETMODE, CN_GET_NETMODE,
  CN_SET_TIMEOUT, CN_GET_TIMEOUT
}
 

Network control type enumration used in ctlnetwork().

More...
enum  intr_kind {
  IK_WOL = (1 << 4), IK_PPPOE_TERMINATED = (1 << 5), IK_DEST_UNREACH = (1 << 6), 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),
  IK_SOCK_4 = (1 << 12), IK_SOCK_5 = (1 << 13), IK_SOCK_6 = (1 << 14), IK_SOCK_7 = (1 << 15),
  IK_SOCK_ALL
}
 

Interrupt kind when CW_SET_INTRRUPT, CW_GET_INTERRUPT, CW_SET_INTRMASK and CW_GET_INTRMASK is used in ctlnetwork().

More...
enum  dhcp_mode { NETINFO_STATIC = 1, NETINFO_DHCP }
 

It used in setting dhcp_mode of wiz_NetInfo.

More...
enum  netmode_type { NM_FORCEARP = (1<<1), NM_WAKEONLAN = (1<<5), NM_PINGBLOCK = (1<<4), NM_PPPOE = (1<<3) }
 

Network mode.

More...

Functions

void reg_wizchip_cris_cbfunc (void(*cris_en)(void), void(*cris_ex)(void))
 Registers call back function for critical section of I/O functions such as WIZCHIP_READ, WIZCHIP_WRITE, WIZCHIP_READ_BUF and WIZCHIP_WRITE_BUF.
void reg_wizchip_cs_cbfunc (void(*cs_sel)(void), void(*cs_desel)(void))
 Registers call back function for WIZCHIP select & deselect.
void reg_wizchip_bus_cbfunc (uint8_t(*bus_rb)(uint32_t addr), void(*bus_wb)(uint32_t addr, uint8_t wb))
 Registers call back function for bus interface.
void reg_wizchip_spi_cbfunc (uint8_t(*spi_rb)(void), void(*spi_wb)(uint8_t wb))
 Registers call back function for SPI interface.
int8_t ctlwizchip (ctlwizchip_type cwtype, void *arg)
 Controls to the WIZCHIP.
int8_t ctlnetwork (ctlnetwork_type cntype, void *arg)
 Controls to network.
void wizchip_sw_reset (void)
 Reset WIZCHIP by softly.
int8_t wizchip_init (uint8_t *txsize, uint8_t *rxsize)
 Initializes WIZCHIP with socket buffer size.
void wizchip_clrinterrupt (intr_kind intr)
 Clear Interrupt of WIZCHIP.
intr_kind wizchip_getinterrupt (void)
 Get Interrupt of WIZCHIP.
void wizchip_setinterruptmask (intr_kind intr)
 Mask or Unmask Interrupt of WIZCHIP.
intr_kind wizchip_getinterruptmask (void)
 Get Interrupt mask of WIZCHIP.
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.
void wizphy_setphyconf (wiz_PhyConf *phyconf)
 Set the phy information for WIZCHIP without power mode.
void wizphy_getphyconf (wiz_PhyConf *phyconf)
 Get phy configuration information.
void wizphy_getphystat (wiz_PhyConf *phyconf)
 Get phy status.
int8_t wizphy_setphypmode (uint8_t pmode)
 set the power mode of phy inside WIZCHIP.
void wizchip_setnetinfo (wiz_NetInfo *pnetinfo)
 Set the network information for WIZCHIP.
void wizchip_getnetinfo (wiz_NetInfo *pnetinfo)
 Get the network information for WIZCHIP.
int8_t wizchip_setnetmode (netmode_type netmode)
 Set the network mode such WOL, PPPoE, Ping Block, and etc.
netmode_type wizchip_getnetmode (void)
 Get the network mode such WOL, PPPoE, Ping Block, and etc.
void wizchip_settimeout (wiz_NetTimeout *nettime)
 Set retry time value(RTR) and retry count(RCR).
void wizchip_gettimeout (wiz_NetTimeout *nettime)
 Get retry time value(RTR) and retry count(RCR).

Variables

_WIZCHIP WIZCHIP
 \ref _WIZCHIP instance

Detailed Description

WIZCHIP Config Header File.

Version:
1.0.0
Date:
2013/10/01
Revision history
<2013/10/01> 1st Release
Author:
MidnightCow

Copyright (c) 2013, WIZnet Co., LTD. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the <ORGANIZATION> nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file wizchip_conf.h.

Function Documentation

void reg_wizchip_bus_cbfunc ( uint8_t(*)(uint32_t addr)  bus_rb,
void(*)(uint32_t addr, uint8_t wb)  bus_wb 
)

Registers call back function for bus interface.

Parameters:
bus_rb: callback function to read byte data using system bus
bus_wb: callback function to write byte data using system bus
Note:
If you do not describe or register, null function is called.

Definition at line 140 of file wizchip_conf.c.

void reg_wizchip_cris_cbfunc ( void(*)(void)  cris_en,
void(*)(void)  cris_ex 
)

Registers call back function for critical section of I/O functions such as WIZCHIP_READ, WIZCHIP_WRITE, WIZCHIP_READ_BUF and WIZCHIP_WRITE_BUF.

Parameters:
cris_en: callback function for critical section enter.
cris_ex: callback function for critical section exit.
Note:
If you do not describe or register, default functions(wizchip_cris_enter & wizchip_cris_exit) is called.

Definition at line 112 of file wizchip_conf.c.

void reg_wizchip_cs_cbfunc ( void(*)(void)  cs_sel,
void(*)(void)  cs_desel 
)

Registers call back function for WIZCHIP select & deselect.

Parameters:
cs_sel: callback function for WIZCHIP select
cs_desel: callback fucntion for WIZCHIP deselect
Note:
If you do not describe or register, null function is called.

Definition at line 126 of file wizchip_conf.c.

void reg_wizchip_spi_cbfunc ( uint8_t(*)(void)  spi_rb,
void(*)(uint8_t wb)  spi_wb 
)

Registers call back function for SPI interface.

Parameters:
spi_rb: callback function to read byte usig SPI
spi_wb: callback function to write byte usig SPI
Note:
If you do not describe or register, null function is called.

Definition at line 156 of file wizchip_conf.c.

int8_t wizphy_getphylink ( void   )

get the link status of phy in WIZCHIP. No use in W5100

Definition at line 412 of file wizchip_conf.c.

int8_t wizphy_getphypmode ( void   )

get the power mode of PHY in WIZCHIP. No use in W5100

Definition at line 433 of file wizchip_conf.c.

void wizphy_reset ( void   )

Reset phy. Vailid only in W5500.

Definition at line 454 of file wizchip_conf.c.

Variable Documentation

_WIZCHIP WIZCHIP

\ref _WIZCHIP instance

Definition at line 95 of file wizchip_conf.c.

Generated on Tue Jul 12 2022 17:16:46 by  doxygen 1.7.2