Socket APIs: Common register access functions

Wiznet Socket API

previous page next page
Macros
Common register access functions
W5500 » WIZCHIP I/O functions

These are functions to access common registers. More...

Macros

#define getSHAR(shar)
 Get local MAC address. More...
 
#define setMR(mr)   WIZCHIP_WRITE(MR,mr)
 Set Mode Register. More...
 
#define getMR()   WIZCHIP_READ(MR)
 Get Mode Register. More...
 
#define setGAR(gar)   WIZCHIP_WRITE_BUF(GAR,gar,4)
 Set gateway IP address. More...
 
#define getGAR(gar)   WIZCHIP_READ_BUF(GAR,gar,4)
 Get gateway IP address. More...
 
#define setSUBR(subr)   WIZCHIP_WRITE_BUF(SUBR, subr,4)
 Set subnet mask address. More...
 
#define getSUBR(subr)   WIZCHIP_READ_BUF(SUBR, subr, 4)
 Get subnet mask address. More...
 
#define setSHAR(shar)   WIZCHIP_WRITE_BUF(SHAR, shar, 6)
 Set local MAC address. More...
 
#define getSHAR(shar)   WIZCHIP_READ_BUF(SHAR, shar, 6)
 Get local MAC address. More...
 
#define setSIPR(sipr)   WIZCHIP_WRITE_BUF(SIPR, sipr, 4)
 Set local IP address. More...
 
#define getSIPR(sipr)   WIZCHIP_READ_BUF(SIPR, sipr, 4)
 Get local IP address. More...
 
#define setINTLEVEL(intlevel)
 Set INTLEVEL register. More...
 
#define getINTLEVEL()   (((uint16_t)WIZCHIP_READ(INTLEVEL) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(INTLEVEL,1)))
 Get INTLEVEL register. More...
 
#define setIR(ir)   WIZCHIP_WRITE(IR, (ir & 0xF0))
 Set IR register. More...
 
#define getIR()   (WIZCHIP_READ(IR) & 0xF0)
 Get IR register. More...
 
#define setIMR(imr)   WIZCHIP_WRITE(_IMR_, imr)
 Set IMR register. More...
 
#define getIMR()   WIZCHIP_READ(_IMR_)
 Get IMR register. More...
 
#define setSIR(sir)   WIZCHIP_WRITE(SIR, sir)
 Set SIR register. More...
 
#define getSIR()   WIZCHIP_READ(SIR)
 Get SIR register. More...
 
#define setSIMR(simr)   WIZCHIP_WRITE(SIMR, simr)
 Set SIMR register. More...
 
#define getSIMR()   WIZCHIP_READ(SIMR)
 Get SIMR register. More...
 
#define setRTR(rtr)
 Set RTR register. More...
 
#define getRTR()   (((uint16_t)WIZCHIP_READ(_RTR_) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(_RTR_,1)))
 Get RTR register. More...
 
#define setRCR(rcr)   WIZCHIP_WRITE(_RCR_, rcr)
 Set RCR register. More...
 
#define getRCR()   WIZCHIP_READ(_RCR_)
 Get RCR register. More...
 
#define setPTIMER(ptimer)   WIZCHIP_WRITE(PTIMER, ptimer)
 Set PTIMER register. More...
 
#define getPTIMER()   WIZCHIP_READ(PTIMER)
 Get PTIMER register. More...
 
#define setPMAGIC(pmagic)   WIZCHIP_WRITE(PMAGIC, pmagic)
 Set PMAGIC register. More...
 
#define getPMAGIC()   WIZCHIP_READ(PMAGIC)
 Get PMAGIC register. More...
 
#define setPHAR(phar)   WIZCHIP_WRITE_BUF(PHAR, phar, 6)
 Set PHAR address. More...
 
#define getPHAR(phar)   WIZCHIP_READ_BUF(PHAR, phar, 6)
 Get PHAR address. More...
 
#define setPSID(psid)
 Set PSID register. More...
 
#define getPSID()   (((uint16_t)WIZCHIP_READ(PSID) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PSID,1)))
 Get PSID register. More...
 
#define setPMRU(pmru)
 Set PMRU register. More...
 
#define getPMRU()   (((uint16_t)WIZCHIP_READ(PMRU) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PMRU,1)))
 Get PMRU register. More...
 
#define getUIPR(uipr)   WIZCHIP_READ_BUF(UIPR,uipr,4)
 Get unreachable IP address. More...
 
#define getUPORTR()   (((uint16_t)WIZCHIP_READ(UPORTR) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(UPORTR,1)))
 Get UPORTR register. More...
 
#define setPHYCFGR(phycfgr)   WIZCHIP_WRITE(PHYCFGR, phycfgr)
 Set PHYCFGR register. More...
 
#define getPHYCFGR()   WIZCHIP_READ(PHYCFGR)
 Get PHYCFGR register. More...
 
#define getVERSIONR()   WIZCHIP_READ(VERSIONR)
 Get VERSIONR register. More...
 

Detailed Description

These are functions to access common registers.

Macro Definition Documentation

#define getSHAR (   shar)
Value:
{ \
(shar)[0] = (uint8_t)(WIZCHIP_READ(SHAR) >> 8); \
(shar)[1] = (uint8_t)(WIZCHIP_READ(SHAR)); \
(shar)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SHAR,2)) >> 8); \
(shar)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SHAR,2))); \
(shar)[4] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SHAR,4)) >> 8); \
(shar)[5] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SHAR,4))); \
}
SHAR
#define SHAR
Source MAC Register address(R/W)
Definition: w5300.h:267
WIZCHIP_READ
uint16_t WIZCHIP_READ(uint32_t AddrSel)
It reads 1 byte value from a register.
WIZCHIP_OFFSET_INC
#define WIZCHIP_OFFSET_INC(ADDR, N)
Increase offset address.
Definition: w5300.h:60

Get local MAC address.

Parameters
(uint8_t*)sharPointer variable to get local MAC address. It should be allocated 6 bytes.
See also
setSHAR()

Definition at line 1419 of file w5300.h.

#define setMR (   mr)    WIZCHIP_WRITE(MR,mr)

Set Mode Register.

Parameters
(uint8_t)mrThe value to be set.
See also
getMR()

Definition at line 1247 of file w5500.h.

#define getMR ( )    WIZCHIP_READ(MR)

Get Mode Register.

Returns
uint8_t. The value of Mode register.
See also
setMR()

Definition at line 1257 of file w5500.h.

#define setGAR (   gar)    WIZCHIP_WRITE_BUF(GAR,gar,4)

Set gateway IP address.

Parameters
(uint8_t*)garPointer variable to set gateway IP address. It should be allocated 4 bytes.
See also
getGAR()

Definition at line 1266 of file w5500.h.

#define getGAR (   gar)    WIZCHIP_READ_BUF(GAR,gar,4)

Get gateway IP address.

Parameters
(uint8_t*)garPointer variable to get gateway IP address. It should be allocated 4 bytes.
See also
setGAR()

Definition at line 1275 of file w5500.h.

#define setSUBR (   subr)    WIZCHIP_WRITE_BUF(SUBR, subr,4)

Set subnet mask address.

Parameters
(uint8_t*)subrPointer variable to set subnet mask address. It should be allocated 4 bytes.
See also
getSUBR()

Definition at line 1284 of file w5500.h.

#define getSUBR (   subr)    WIZCHIP_READ_BUF(SUBR, subr, 4)

Get subnet mask address.

Parameters
(uint8_t*)subrPointer variable to get subnet mask address. It should be allocated 4 bytes.
See also
setSUBR()

Definition at line 1294 of file w5500.h.

#define setSHAR (   shar)    WIZCHIP_WRITE_BUF(SHAR, shar, 6)

Set local MAC address.

Parameters
(uint8_t*)sharPointer variable to set local MAC address. It should be allocated 6 bytes.
See also
getSHAR()

Definition at line 1303 of file w5500.h.

#define getSHAR (   shar)    WIZCHIP_READ_BUF(SHAR, shar, 6)

Get local MAC address.

Parameters
(uint8_t*)sharPointer variable to get local MAC address. It should be allocated 6 bytes.
See also
setSHAR()

Definition at line 1312 of file w5500.h.

#define setSIPR (   sipr)    WIZCHIP_WRITE_BUF(SIPR, sipr, 4)

Set local IP address.

Parameters
(uint8_t*)siprPointer variable to set local IP address. It should be allocated 4 bytes.
See also
getSIPR()

Definition at line 1321 of file w5500.h.

#define getSIPR (   sipr)    WIZCHIP_READ_BUF(SIPR, sipr, 4)

Get local IP address.

Parameters
(uint8_t*)siprPointer variable to get local IP address. It should be allocated 4 bytes.
See also
setSIPR()

Definition at line 1330 of file w5500.h.

#define setINTLEVEL (   intlevel)
Value:
{\
WIZCHIP_WRITE(INTLEVEL, (uint8_t)(intlevel >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(INTLEVEL,1), (uint8_t) intlevel); \
}
WIZCHIP_OFFSET_INC
#define WIZCHIP_OFFSET_INC(ADDR, N)
Definition: w5500.h:68
WIZCHIP_WRITE
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.
INTLEVEL
#define INTLEVEL
Set Interrupt low level timer register address(R/W)
Definition: w5500.h:249

Set INTLEVEL register.

Parameters
(uint16_t)intlevelValue to set INTLEVEL register.
See also
getINTLEVEL()

Definition at line 1339 of file w5500.h.

#define getINTLEVEL ( )    (((uint16_t)WIZCHIP_READ(INTLEVEL) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(INTLEVEL,1)))

Get INTLEVEL register.

Returns
uint16_t. Value of INTLEVEL register.
See also
setINTLEVEL()

Definition at line 1356 of file w5500.h.

#define setIR (   ir)    WIZCHIP_WRITE(IR, (ir & 0xF0))

Set IR register.

Parameters
(uint8_t)irValue to set IR register.
See also
getIR()

Definition at line 1365 of file w5500.h.

#define getIR ( )    (WIZCHIP_READ(IR) & 0xF0)

Get IR register.

Returns
uint8_t. Value of IR register.
See also
setIR()

Definition at line 1374 of file w5500.h.

#define setIMR (   imr)    WIZCHIP_WRITE(_IMR_, imr)

Set IMR register.

Parameters
(uint8_t)imrValue to set IMR register.
See also
getIMR()

Definition at line 1382 of file w5500.h.

#define getIMR ( )    WIZCHIP_READ(_IMR_)

Get IMR register.

Returns
uint8_t. Value of IMR register.
See also
setIMR()

Definition at line 1391 of file w5500.h.

#define setSIR (   sir)    WIZCHIP_WRITE(SIR, sir)

Set SIR register.

Parameters
(uint8_t)sirValue to set SIR register.
See also
getSIR()

Definition at line 1400 of file w5500.h.

#define getSIR ( )    WIZCHIP_READ(SIR)

Get SIR register.

Returns
uint8_t. Value of SIR register.
See also
setSIR()

Definition at line 1409 of file w5500.h.

#define setSIMR (   simr)    WIZCHIP_WRITE(SIMR, simr)

Set SIMR register.

Parameters
(uint8_t)simrValue to set SIMR register.
See also
getSIMR()

Definition at line 1417 of file w5500.h.

#define getSIMR ( )    WIZCHIP_READ(SIMR)

Get SIMR register.

Returns
uint8_t. Value of SIMR register.
See also
setSIMR()

Definition at line 1426 of file w5500.h.

#define setRTR (   rtr)
Value:
{\
WIZCHIP_WRITE(_RTR_, (uint8_t)(rtr >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(_RTR_,1), (uint8_t) rtr); \
}
WIZCHIP_OFFSET_INC
#define WIZCHIP_OFFSET_INC(ADDR, N)
Definition: w5500.h:68
_RTR_
#define _RTR_
Timeout register address( 1 is 100us )(R/W)
Definition: w5500.h:315
WIZCHIP_WRITE
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.

Set RTR register.

Parameters
(uint16_t)rtrValue to set RTR register.
See also
getRTR()

Definition at line 1435 of file w5500.h.

#define getRTR ( )    (((uint16_t)WIZCHIP_READ(_RTR_) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(_RTR_,1)))

Get RTR register.

Returns
uint16_t. Value of RTR register.
See also
setRTR()

Definition at line 1451 of file w5500.h.

#define setRCR (   rcr)    WIZCHIP_WRITE(_RCR_, rcr)

Set RCR register.

Parameters
(uint8_t)rcrValue to set RCR register.
See also
getRCR()

Definition at line 1461 of file w5500.h.

#define getRCR ( )    WIZCHIP_READ(_RCR_)

Get RCR register.

Returns
uint8_t. Value of RCR register.
See also
setRCR()

Definition at line 1470 of file w5500.h.

#define setPTIMER (   ptimer)    WIZCHIP_WRITE(PTIMER, ptimer)

Set PTIMER register.

Parameters
(uint8_t)ptimerValue to set PTIMER register.
See also
getPTIMER()

Definition at line 1481 of file w5500.h.

#define getPTIMER ( )    WIZCHIP_READ(PTIMER)

Get PTIMER register.

Returns
uint8_t. Value of PTIMER register.
See also
setPTIMER()

Definition at line 1490 of file w5500.h.

#define setPMAGIC (   pmagic)    WIZCHIP_WRITE(PMAGIC, pmagic)

Set PMAGIC register.

Parameters
(uint8_t)pmagicValue to set PMAGIC register.
See also
getPMAGIC()

Definition at line 1499 of file w5500.h.

#define getPMAGIC ( )    WIZCHIP_READ(PMAGIC)

Get PMAGIC register.

Returns
uint8_t. Value of PMAGIC register.
See also
setPMAGIC()

Definition at line 1508 of file w5500.h.

#define setPHAR (   phar)    WIZCHIP_WRITE_BUF(PHAR, phar, 6)

Set PHAR address.

Parameters
(uint8_t*)pharPointer variable to set PPP destination MAC register address. It should be allocated 6 bytes.
See also
getPHAR()

Definition at line 1517 of file w5500.h.

#define getPHAR (   phar)    WIZCHIP_READ_BUF(PHAR, phar, 6)

Get PHAR address.

Parameters
(uint8_t*)pharPointer variable to PPP destination MAC register address. It should be allocated 6 bytes.
See also
setPHAR()

Definition at line 1526 of file w5500.h.

#define setPSID (   psid)
Value:
{\
WIZCHIP_WRITE(PSID, (uint8_t)(psid >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(PSID,1), (uint8_t) psid); \
}
WIZCHIP_OFFSET_INC
#define WIZCHIP_OFFSET_INC(ADDR, N)
Definition: w5500.h:68
WIZCHIP_WRITE
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.
PSID
#define PSID
PPP Session Identification Register(R/W)
Definition: w5500.h:353

Set PSID register.

Parameters
(uint16_t)psidValue to set PSID register.
See also
getPSID()

Definition at line 1535 of file w5500.h.

#define getPSID ( )    (((uint16_t)WIZCHIP_READ(PSID) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PSID,1)))

Get PSID register.

Returns
uint16_t. Value of PSID register.
See also
setPSID()

Definition at line 1552 of file w5500.h.

#define setPMRU (   pmru)
Value:
{ \
WIZCHIP_WRITE(PMRU, (uint8_t)(pmru>>8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(PMRU,1), (uint8_t) pmru); \
}
WIZCHIP_OFFSET_INC
#define WIZCHIP_OFFSET_INC(ADDR, N)
Definition: w5500.h:68
PMRU
#define PMRU
PPP Maximum Segment Size(MSS) register(R/W)
Definition: w5500.h:360
WIZCHIP_WRITE
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.

Set PMRU register.

Parameters
(uint16_t)pmruValue to set PMRU register.
See also
getPMRU()

Definition at line 1561 of file w5500.h.

#define getPMRU ( )    (((uint16_t)WIZCHIP_READ(PMRU) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PMRU,1)))

Get PMRU register.

Returns
uint16_t. Value of PMRU register.
See also
setPMRU()

Definition at line 1577 of file w5500.h.

#define getUIPR (   uipr)    WIZCHIP_READ_BUF(UIPR,uipr,4)

Get unreachable IP address.

Parameters
(uint8_t*)uiprPointer variable to get unreachable IP address. It should be allocated 4 bytes.

Definition at line 1590 of file w5500.h.

#define getUPORTR ( )    (((uint16_t)WIZCHIP_READ(UPORTR) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(UPORTR,1)))

Get UPORTR register.

Returns
uint16_t. Value of UPORTR register.

Definition at line 1603 of file w5500.h.

#define setPHYCFGR (   phycfgr)    WIZCHIP_WRITE(PHYCFGR, phycfgr)

Set PHYCFGR register.

Parameters
(uint8_t)phycfgrValue to set PHYCFGR register.
See also
getPHYCFGR()

Definition at line 1612 of file w5500.h.

Referenced by wizphy_reset(), wizphy_setphyconf(), and wizphy_setphypmode().

#define getPHYCFGR ( )    WIZCHIP_READ(PHYCFGR)

Get PHYCFGR register.

Returns
uint8_t. Value of PHYCFGR register.
See also
setPHYCFGR()

Definition at line 1621 of file w5500.h.

Referenced by wizphy_getphyconf(), wizphy_getphylink(), wizphy_getphypmode(), wizphy_getphystat(), wizphy_reset(), and wizphy_setphypmode().

#define getVERSIONR ( )    WIZCHIP_READ(VERSIONR)

Get VERSIONR register.

Returns
uint8_t. Value of VERSIONR register.

Definition at line 1629 of file w5500.h.

Generated on Wed May 4 2016 16:44:00 for Socket APIs by   doxygen 1.8.9.1
previous page start next page