Jinbuhm Kim / Mbed 2 deprecated W5500_Driver

Wiznet W5500 driver and TCP/UDP loopback

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

2. WIZnet Extra Functions
Functions

2. WIZnet Extra Functions

These functions is optional function. More...

Functions

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.
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).

Detailed Description

These functions is optional function.

It could be replaced at WIZCHIP I/O function because they were made by WIZCHIP I/O functions.

There are functions of configuring WIZCHIP, network, interrupt, phy, network information and timer.

Function Documentation

int8_t ctlnetwork ( ctlnetwork_type  cntype,
void *  arg 
)

Controls to network.

Controls to network environment, mode, timeout and so on.

Parameters:
cntype: Input. Decides to the control type
arg: Inout. arg type is dependent on cntype.
Returns:
-1 : Fail because of invalid ctlnetwork_type or unsupported ctlnetwork_type in WIZCHIP
0 : Success

Definition at line 180 of file wizchip_conf.c.

int8_t ctlwizchip ( ctlwizchip_type  cwtype,
void *  arg 
)

Controls to the WIZCHIP.

Resets WIZCHIP & internal PHY, Configures PHY mode, Monitor PHY(Link,Speed,Half/Full/Auto), controls interrupt & mask and so on.

Parameters:
cwtype: Decides to the control type
arg: arg type is dependent on cwtype.
Returns:
0 : Success
-1 : Fail because of invalid ctlwizchip_type or unsupported ctlwizchip_type in WIZCHIP

Definition at line 115 of file wizchip_conf.c.

void wizchip_clrinterrupt ( intr_kind  intr )

Clear Interrupt of WIZCHIP.

Parameters:
intr: intr_kind value operated OR. It can type-cast to uint16_t.

Definition at line 250 of file wizchip_conf.c.

intr_kind wizchip_getinterrupt ( void   )

Get Interrupt of WIZCHIP.

Returns:
intr_kind value operated OR. It can type-cast to uint16_t.

Definition at line 259 of file wizchip_conf.c.

intr_kind wizchip_getinterruptmask ( void   )

Get Interrupt mask of WIZCHIP.

Returns:
: The operated OR vaule of intr_kind. It can type-cast to uint16_t.

Definition at line 282 of file wizchip_conf.c.

void wizchip_getnetinfo ( wiz_NetInfo *  pnetinfo )

Get the network information for WIZCHIP.

Parameters:
pnetinfo: wizNetInfo

Definition at line 449 of file wizchip_conf.c.

netmode_type wizchip_getnetmode ( void   )

Get the network mode such WOL, PPPoE, Ping Block, and etc.

Returns:
Value of network mode. Refer to netmode_type.

Definition at line 474 of file wizchip_conf.c.

void wizchip_gettimeout ( wiz_NetTimeout *  nettime )

Get retry time value(RTR) and retry count(RCR).

RTR configures the retransmission timeout period and RCR configures the number of time of retransmission.

Parameters:
nettimeRTR value and RCR value. Refer to wiz_NetTimeout.

Definition at line 485 of file wizchip_conf.c.

int8_t wizchip_init ( uint8_t *  txsize,
uint8_t *  rxsize 
)

Initializes WIZCHIP with socket buffer size.

Parameters:
txsizeSocket tx buffer sizes. If null, initialized the default size 2KB.
rxsizeSocket rx buffer sizes. If null, initialized the default size 2KB.
Returns:
0 : succcess
-1 : fail. Invalid buffer size

Definition at line 223 of file wizchip_conf.c.

void wizchip_setinterruptmask ( intr_kind  intr )

Mask or Unmask Interrupt of WIZCHIP.

Parameters:
intr: intr_kind value operated OR. It can type-cast to uint16_t.

Definition at line 273 of file wizchip_conf.c.

void wizchip_setnetinfo ( wiz_NetInfo *  pnetinfo )

Set the network information for WIZCHIP.

Parameters:
pnetinfo: wizNetInfo

Definition at line 436 of file wizchip_conf.c.

int8_t wizchip_setnetmode ( netmode_type  netmode )

Set the network mode such WOL, PPPoE, Ping Block, and etc.

Parameters:
pnetinfoValue of network mode. Refer to netmode_type.

Definition at line 462 of file wizchip_conf.c.

void wizchip_settimeout ( wiz_NetTimeout *  nettime )

Set retry time value(RTR) and retry count(RCR).

RTR configures the retransmission timeout period and RCR configures the number of time of retransmission.

Parameters:
nettimeRTR value and RCR value. Refer to wiz_NetTimeout.

Definition at line 479 of file wizchip_conf.c.

void wizchip_sw_reset ( void   )

Reset WIZCHIP by softly.

Definition at line 208 of file wizchip_conf.c.

void wizphy_getphyconf ( wiz_PhyConf *  phyconf )

Get phy configuration information.

Parameters:
phyconf: wiz_PhyConf

Definition at line 362 of file wizchip_conf.c.

void wizphy_getphystat ( wiz_PhyConf *  phyconf )

Get phy status.

Parameters:
phyconf: wiz_PhyConf

Definition at line 402 of file wizchip_conf.c.

void wizphy_setphyconf ( wiz_PhyConf *  phyconf )

Set the phy information for WIZCHIP without power mode.

Parameters:
phyconf: wiz_PhyConf

Definition at line 331 of file wizchip_conf.c.

int8_t wizphy_setphypmode ( uint8_t  pmode )

set the power mode of phy inside WIZCHIP.

Refer to PHYCFGR in W5500, PHYSTATUS in W5200

Parameters:
pmodeSettig value of power down mode.

Definition at line 410 of file wizchip_conf.c.

Generated on Tue Jul 12 2022 18:48:22 by  doxygen 1.7.2