Socket APIs: Common register access functions

Wiznet Socket API

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

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

Macros

#define setMR(mr)   (*((uint8_t*)MR) = mr)
 Set Mode Register. More...
 
#define getMR()   (*(uint8_t*)MR)
 Get MR. More...
 
#define setGAR(gar)   WIZCHIP_WRITE_BUF(GAR,gar,4)
 Set GAR. More...
 
#define getGAR(gar)   WIZCHIP_READ_BUF(GAR,gar,4)
 Get GAR. More...
 
#define setSUBR(subr)   WIZCHIP_WRITE_BUF(SUBR, subr,4)
 Set SUBR. More...
 
#define getSUBR(subr)   WIZCHIP_READ_BUF(SUBR, subr, 4)
 Get SUBR. More...
 
#define setSHAR(shar)   WIZCHIP_WRITE_BUF(SHAR, shar, 6)
 Set SHAR. More...
 
#define getSHAR(shar)   WIZCHIP_READ_BUF(SHAR, shar, 6)
 Get SHAR. More...
 
#define setSIPR(sipr)   WIZCHIP_WRITE_BUF(SIPR, sipr, 4)
 Set SIPR. More...
 
#define getSIPR(sipr)   WIZCHIP_READ_BUF(SIPR, sipr, 4)
 Get SIPR. More...
 
#define setIR(ir)   WIZCHIP_WRITE(IR, (ir & 0xA0))
 Set IR register. More...
 
#define getIR()   (WIZCHIP_READ(IR) & 0xA0)
 Get IR register. More...
 
#define setIMR(imr)   WIZCHIP_WRITE(IMR2, imr & 0xA0)
 Set IMR2 register. More...
 
#define getIMR()   (WIZCHIP_READ(IMR2) & 0xA0)
 Get IMR2 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 getPATR()   (((uint16_t)WIZCHIP_READ(PATR) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PATR,1)))
 Get PATR register. More...
 
#define getPPPALGO()   WIZCHIP_READ(PPPALGO)
 Get PPPALGO register. More...
 
#define getVERSIONR()   WIZCHIP_READ(VERSIONR)
 Get VERSIONR 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 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 setIR2(ir2)   WIZCHIP_WRITE(IR2, ir2)
 Set IR2 register. More...
 
#define getIR2()   WIZCHIP_READ(IR2)
 Get IR2 register. More...
 
#define getPHYSTATUS()   WIZCHIP_READ(PHYSTATUS)
 Get PHYSTATUS register. More...
 
#define setIMR2(imr2)   WIZCHIP_WRITE(_IMR_, imr2)
 Set IMR register. More...
 
#define getIMR2()   WIZCHIP_READ(_IMR_)
 Get IMR register. More...
 

Detailed Description

These are functions to access common registers.

Macro Definition Documentation

#define setMR (   mr)    (*((uint8_t*)MR) = mr)

Set Mode Register.

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

Definition at line 1238 of file w5200.h.

#define getMR ( )    (*(uint8_t*)MR)

Get MR.

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

Definition at line 1250 of file w5200.h.

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

Set GAR.

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

Definition at line 1259 of file w5200.h.

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

Get GAR.

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

Definition at line 1268 of file w5200.h.

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

Set SUBR.

Parameters
(uint8_t*)subrPointer variable to set subnet mask address. It should be allocated 4 bytes.
Note
If subr is null pointer, set the backup subnet to SUBR.
If subr is 0.0.0.0, back up SUBR and clear it.
Otherwize, set subr to SUBR
See also
getSUBR()

Definition at line 1280 of file w5200.h.

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

Get SUBR.

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

Definition at line 1289 of file w5200.h.

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

Set SHAR.

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

Definition at line 1298 of file w5200.h.

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

Get SHAR.

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

Definition at line 1307 of file w5200.h.

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

Set SIPR.

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

Definition at line 1316 of file w5200.h.

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

Get SIPR.

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

Definition at line 1325 of file w5200.h.

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

Set IR register.

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

Definition at line 1334 of file w5200.h.

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

Get IR register.

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

Definition at line 1342 of file w5200.h.

#define setIMR (   imr)    WIZCHIP_WRITE(IMR2, imr & 0xA0)

Set IMR2 register.

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

Definition at line 1356 of file w5200.h.

#define getIMR ( )    (WIZCHIP_READ(IMR2) & 0xA0)

Get IMR2 register.

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

Definition at line 1370 of file w5200.h.

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

Set RTR register.

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

Definition at line 1379 of file w5200.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 1390 of file w5200.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 1399 of file w5200.h.

#define getRCR ( )    WIZCHIP_READ(_RCR_)

Get RCR register.

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

Definition at line 1408 of file w5200.h.

#define getPATR ( )    (((uint16_t)WIZCHIP_READ(PATR) << 8) + WIZCHIP_READ(WIZCHIP_OFFSET_INC(PATR,1)))

Get PATR register.

Returns
uint16_t. Value to set PATR register

Definition at line 1416 of file w5200.h.

#define getPPPALGO ( )    WIZCHIP_READ(PPPALGO)

Get PPPALGO register.

Returns
uint8_t. Value to set PPPALGO register

Definition at line 1424 of file w5200.h.

#define getVERSIONR ( )    WIZCHIP_READ(VERSIONR)

Get VERSIONR register.

Returns
uint8_t. Value to set VERSIONR register

Definition at line 1433 of file w5200.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 1442 of file w5200.h.

#define getPTIMER ( )    WIZCHIP_READ(PTIMER)

Get PTIMER register.

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

Definition at line 1451 of file w5200.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 1460 of file w5200.h.

#define getPMAGIC ( )    WIZCHIP_READ(PMAGIC)

Get PMAGIC register.

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

Definition at line 1469 of file w5200.h.

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

Set INTLEVEL register.

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

Definition at line 1478 of file w5200.h.

Referenced by ctlwizchip().

#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 1488 of file w5200.h.

Referenced by ctlwizchip().

#define setIR2 (   ir2)    WIZCHIP_WRITE(IR2, ir2)

Set IR2 register.

Parameters
(uint8_t)ir2Value to set IR2 register.
See also
getIR2()

Definition at line 1497 of file w5200.h.

#define getIR2 ( )    WIZCHIP_READ(IR2)

Get IR2 register.

Returns
uint8_t. Value of IR2 register.
See also
setIR2()

Definition at line 1507 of file w5200.h.

#define getPHYSTATUS ( )    WIZCHIP_READ(PHYSTATUS)

Get PHYSTATUS register.

Returns
uint8_t. Value to set PHYSTATUS register.

Definition at line 1516 of file w5200.h.

Referenced by wizphy_getphylink(), and wizphy_getphypmode().

#define setIMR2 (   imr2)    WIZCHIP_WRITE(_IMR_, imr2)

Set IMR register.

Parameters
(uint8_t)imr2Value to set IMR2 register.
See also
getIMR2()
Note
If possible, Don't use this function. Instead, Use setSIMR() for compatible with ioLibrary.

Definition at line 1531 of file w5200.h.

#define getIMR2 ( )    WIZCHIP_READ(_IMR_)

Get IMR register.

Returns
uint8_t. Value of IMR2 register.
See also
setIMR2()

Definition at line 1546 of file w5200.h.

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