PER Firmware
Loading...
Searching...
No Matches
Common register access functions

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

Macros

#define setMR(mr)
 Set Mode Register.
 
#define getMR()
 Get Mode Register.
 
#define setGAR(gar)
 Set gateway IP address.
 
#define getGAR(gar)
 Get gateway IP address.
 
#define setSUBR(subr)
 Set subnet mask address.
 
#define getSUBR(subr)
 Get subnet mask address.
 
#define setSHAR(shar)
 Set local MAC address.
 
#define getSHAR(shar)
 Get local MAC address.
 
#define setSIPR(sipr)
 Set local IP address.
 
#define getSIPR(sipr)
 Get local IP address.
 
#define setINTLEVEL(intlevel)
 Set INTLEVEL register.
 
#define getINTLEVEL()
 Get INTLEVEL register.
 
#define setIR(ir)
 Set IR register.
 
#define getIR()
 Get IR register.
 
#define setIMR(imr)
 Set _IMR_ register.
 
#define getIMR()
 Get _IMR_ register.
 
#define setSIR(sir)
 Set SIR register.
 
#define getSIR()
 Get SIR register.
 
#define setSIMR(simr)
 Set SIMR register.
 
#define getSIMR()
 Get SIMR register.
 
#define setRTR(rtr)
 Set _RTR_ register.
 
#define getRTR()
 Get _RTR_ register.
 
#define setRCR(rcr)
 Set _RCR_ register.
 
#define getRCR()
 Get _RCR_ register.
 
#define setPTIMER(ptimer)
 Set PTIMER register.
 
#define getPTIMER()
 Get PTIMER register.
 
#define setPMAGIC(pmagic)
 Set PMAGIC register.
 
#define getPMAGIC()
 Get PMAGIC register.
 
#define setPHAR(phar)
 Set PHAR address.
 
#define getPHAR(phar)
 Get PHAR address.
 
#define setPSID(psid)
 Set PSID register.
 
#define getPSID()
 Get PSID register.
 
#define setPMRU(pmru)
 Set PMRU register.
 
#define getPMRU()
 Get PMRU register.
 
#define getUIPR(uipr)
 Get unreachable IP address.
 
#define getUPORTR()
 Get UPORTR register.
 
#define setPHYCFGR(phycfgr)
 Set PHYCFGR register.
 
#define getPHYCFGR()
 Get PHYCFGR register.
 
#define getVERSIONR()
 Get VERSIONR register.
 

Detailed Description

These are functions to access common registers.

Macro Definition Documentation

◆ getGAR

#define getGAR ( gar)
Value:
void WIZCHIP_READ_BUF(uint32_t AddrSel, uint8_t *pBuf, uint16_t len)
It reads sequence data from registers.
Definition w5500.c:125
#define GAR
Gateway IP Register address(R/W)
Definition w5500.h:217

Get gateway IP address.

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

◆ getIMR

#define getIMR ( )
Value:
uint8_t WIZCHIP_READ(uint32_t AddrSel)
It reads 1 byte value from a register.
Definition w5500.c:65
#define _IMR_
Interrupt mask register(R/W)
Definition w5500.h:282

Get _IMR_ register.

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

◆ getINTLEVEL

#define getINTLEVEL ( )
Value:
(((uint16_t)WIZCHIP_READ(INTLEVEL) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(INTLEVEL, 1)))
#define INTLEVEL
Set Interrupt low level timer register address(R/W)
Definition w5500.h:245

Get INTLEVEL register.

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

◆ getIR

#define getIR ( )
Value:
(WIZCHIP_READ(IR) & 0xF0)
#define IR
Interrupt Register(R/W)
Definition w5500.h:262

Get IR register.

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

◆ getMR

#define getMR ( )
Value:
#define MR
Mode Register address(R/W) MR is used for S/W reset, ping block mode, PPPoE mode and etc.
Definition w5500.h:210

Get Mode Register.

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

◆ getPHAR

#define getPHAR ( phar)
Value:
#define PHAR
PPP Destination MAC Register address(R/W)
Definition w5500.h:342

Get PHAR address.

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

◆ getPHYCFGR

#define getPHYCFGR ( )
Value:
#define PHYCFGR
PHY Status Register(R/W)
Definition w5500.h:381

Get PHYCFGR register.

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

◆ getPMAGIC

#define getPMAGIC ( )
Value:
#define PMAGIC
PPP LCP Magic number register in PPPoE mode(R/W)
Definition w5500.h:335

Get PMAGIC register.

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

◆ getPMRU

#define getPMRU ( )
Value:
(((uint16_t)WIZCHIP_READ(PMRU) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PMRU, 1)))
#define PMRU
PPP Maximum Segment Size(MSS) register(R/W)
Definition w5500.h:356

Get PMRU register.

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

◆ getPSID

#define getPSID ( )
Value:
(((uint16_t)WIZCHIP_READ(PSID) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PSID, 1)))
#define PSID
PPP Session Identification Register(R/W)
Definition w5500.h:349

Get PSID register.

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

◆ getPTIMER

#define getPTIMER ( )
Value:
#define PTIMER
PPP LCP Request Timer register in PPPoE mode(R/W)
Definition w5500.h:328

Get PTIMER register.

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

◆ getRCR

#define getRCR ( )
Value:
#define _RCR_
Retry count register(R/W)
Definition w5500.h:321

Get _RCR_ register.

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

◆ getRTR

#define getRTR ( )
Value:
(((uint16_t)WIZCHIP_READ(_RTR_) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(_RTR_, 1)))
#define _RTR_
Timeout register address( 1 is 100us )(R/W)
Definition w5500.h:311

Get _RTR_ register.

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

◆ getSHAR

#define getSHAR ( shar)
Value:
#define SHAR
Source MAC Register address(R/W)
Definition w5500.h:231

Get local MAC address.

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

◆ getSIMR

#define getSIMR ( )
Value:
#define SIMR
Socket Interrupt Mask Register(R/W)
Definition w5500.h:299

Get SIMR register.

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

◆ getSIPR

#define getSIPR ( sipr)
Value:
#define SIPR
Source IP Register address(R/W)
Definition w5500.h:238

Get local IP address.

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

◆ getSIR

#define getSIR ( )
Value:
#define SIR
Socket Interrupt Register(R/W)
Definition w5500.h:290

Get SIR register.

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

◆ getSUBR

#define getSUBR ( subr)
Value:
#define SUBR
Subnet mask Register address(R/W)
Definition w5500.h:224

Get subnet mask address.

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

◆ getUIPR

#define getUIPR ( uipr)
Value:
#define UIPR
Unreachable IP register address in UDP mode(R)
Definition w5500.h:365

Get unreachable IP address.

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

◆ getUPORTR

#define getUPORTR ( )
Value:
(((uint16_t)WIZCHIP_READ(UPORTR) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(UPORTR, 1)))
#define UPORTR
Unreachable Port register address in UDP mode(R)
Definition w5500.h:374

Get UPORTR register.

Returns
uint16_t. Value of UPORTR register.

◆ getVERSIONR

#define getVERSIONR ( )
Value:
#define VERSIONR
chip version register address(R)
Definition w5500.h:399

Get VERSIONR register.

Returns
uint8_t. Value of VERSIONR register.

◆ setGAR

#define setGAR ( gar)
Value:
void WIZCHIP_WRITE_BUF(uint32_t AddrSel, uint8_t *pBuf, uint16_t len)
It writes sequence data to registers.
Definition w5500.c:155

Set gateway IP address.

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

◆ setIMR

#define setIMR ( imr)
Value:
void WIZCHIP_WRITE(uint32_t AddrSel, uint8_t wb)
It writes 1 byte value to a register.
Definition w5500.c:95

Set _IMR_ register.

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

◆ setINTLEVEL

#define setINTLEVEL ( intlevel)
Value:
{ \
WIZCHIP_WRITE(INTLEVEL, (uint8_t)(intlevel >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(INTLEVEL, 1), (uint8_t)intlevel); \
}

Set INTLEVEL register.

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

◆ setIR

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

Set IR register.

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

◆ setMR

#define setMR ( mr)
Value:

Set Mode Register.

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

◆ setPHAR

#define setPHAR ( phar)
Value:

Set PHAR address.

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

◆ setPHYCFGR

#define setPHYCFGR ( phycfgr)
Value:

Set PHYCFGR register.

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

◆ setPMAGIC

#define setPMAGIC ( pmagic)
Value:

Set PMAGIC register.

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

◆ setPMRU

#define setPMRU ( pmru)
Value:
{ \
WIZCHIP_WRITE(PMRU, (uint8_t)(pmru >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(PMRU, 1), (uint8_t)pmru); \
}

Set PMRU register.

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

◆ setPSID

#define setPSID ( psid)
Value:
{ \
WIZCHIP_WRITE(PSID, (uint8_t)(psid >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(PSID, 1), (uint8_t)psid); \
}

Set PSID register.

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

◆ setPTIMER

#define setPTIMER ( ptimer)
Value:

Set PTIMER register.

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

◆ setRCR

#define setRCR ( rcr)
Value:

Set _RCR_ register.

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

◆ setRTR

#define setRTR ( rtr)
Value:
{ \
WIZCHIP_WRITE(_RTR_, (uint8_t)(rtr >> 8)); \
WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(_RTR_, 1), (uint8_t)rtr); \
}

Set _RTR_ register.

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

◆ setSHAR

#define setSHAR ( shar)
Value:

Set local MAC address.

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

◆ setSIMR

#define setSIMR ( simr)
Value:

Set SIMR register.

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

◆ setSIPR

#define setSIPR ( sipr)
Value:

Set local IP address.

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

◆ setSIR

#define setSIR ( sir)
Value:

Set SIR register.

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

◆ setSUBR

#define setSUBR ( subr)
Value:

Set subnet mask address.

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