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

Macros
#define	setIR(ir) WIZCHIP_WRITE(IR, ir & 0xF0FF)
	Set Mode Register. More...

#define	getIR() (WIZCHIP_READ(IR) & 0xF0FF)
	Get IR register. More...

#define	setIMR(imr) WIZCHIP_WRITE(_IMR_, imr & 0xF0FF)
	Set IMR register. More...

#define	getIMR() (WIZCHIP_READ(_IMR_) & 0xF0FF)
	Get IMR register. More...

#define	setSHAR(shar)
	Set local MAC address. More...

#define	setGAR(gar)
	Set gateway IP address. More...

#define	getGAR(gar)
	Get gateway IP address. More...

#define	setSUBR(subr)
	Set subnet mask address. More...

#define	getSUBR(subr)
	Get subnet mask address. More...

#define	setSIPR(sipr)
	Set local IP address. More...

#define	getSIPR(sipr)
	Get local IP address. More...

#define	setRTR(rtr) WIZCHIP_WRITE(_RTR_, rtr)
	Set RTR register. More...

#define	getRTR() WIZCHIP_READ(_RTR_)
	Get RTR register. More...

#define	setRCR(rcr) WIZCHIP_WRITE(_RCR_, ((uint16_t)rcr)&0x00FF)
	Set RCR register. More...

#define	getRCR() ((uint8_t)(WIZCHIP_READ(_RCR_) & 0x00FF))
	Get RCR register. More...

#define	setTMS01R(tms01r) WIZCHIP_WRITE(TMS01R,tms01r)
	Set TMS01R register. More...

#define	getTMS01R() WIZCHIP_READ(TMS01R)
	Get TMS01R register. More...

#define	setTMS23R(tms23r) WIZCHIP_WRITE(TMS23R,tms23r)
	Set TMS23R register. More...

#define	getTMS23R() WIZCHIP_READ(TMS23R)
	Get TMS23R register. More...

#define	setTMS45R(tms45r) WIZCHIP_WRITE(TMS45R,tms45r)
	Set TMS45R register. More...

#define	getTMS45R() WIZCHIP_READ(TMS45R)
	Get TMS45R register. More...

#define	setTMS67R(tms67r) WIZCHIP_WRITE(TMS67R,tms67r)
	Set TMS67R register. More...

#define	getTMS67R() WIZCHIP_READ(TMS67R)
	Get TMS67R register. More...

#define	setRMS01R(rms01r) WIZCHIP_WRITE(RMS01R,rms01r)
	Set RMS01R register. More...

#define	getRMS01R() WIZCHIP_READ(RMS01R)
	Get RMS01R register. More...

#define	setRMS23R(rms23r) WIZCHIP_WRITE(RMS23R,rms23r)
	Set RMS23R register. More...

#define	getRMS23R() WIZCHIP_READ(RMS23R)
	Get RMS23R register. More...

#define	setRMS45R(rms45r) WIZCHIP_WRITE(RMS45R,rms45r)
	Set RMS45R register. More...

#define	getRMS45R() WIZCHIP_READ(RMS45R)
	Get RMS45R register. More...

#define	setRMS67R(rms67r) WIZCHIP_WRITE(RMS67R,rms67r)
	Set RMS67R register. More...

#define	getRMS67R() WIZCHIP_READ(RMS67R)
	Get RMS67R register. More...

#define	setMTYPER(mtype) WIZCHIP_WRITE(MTYPER, mtype)
	Set MTYPER register. More...

#define	getMTYPER() WIZCHIP_READ(MTYPER)
	Get MTYPER register. More...

#define	getPATR() WIZCHIP_READ(PATR)
	Get RATR register. More...

#define	setPTIMER(ptimer) WIZCHIP_WRITE(PTIMER, ((uint16_t)ptimer) & 0x00FF)
	Set PTIMER register. More...

#define	getPTIMER() ((uint8_t)(WIZCHIP_READ(PTIMER) & 0x00FF))
	Get PTIMER register. More...

#define	setPMAGIC(pmagic) WIZCHIP_WRITE(PMAGIC, ((uint16_t)pmagic) & 0x00FF)
	Set PMAGIC register. More...

#define	getPMAGIC() ((uint8_t)(WIZCHIP_READ(PMAGIC) & 0x00FF))
	Get PMAGIC register. More...

#define	getPSIDR() WIZCHIP_READ(PSIDR)
	Get PSID register. More...

#define	getPDHAR(pdhar)
	Get PDHAR register. More...

#define	getUIPR(uipr)
	Get unreachable IP address. UIPR. More...

#define	getUPORTR() WIZCHIP_READ(UPORTR)
	Get UPORTR register. More...

#define	getFMTUR() WIZCHIP_READ(FMTUR)
	Get FMTUR register. More...

#define	getPn_BRDYR(p) ((uint8_t)(WIZCHIP_READ(Pn_BRDYR(p)) & 0x00FF))
	Get Pn_BRDYR register. More...

#define	setPn_BRDYR(p, brdyr) WIZCHIP_WRITE(Pn_BRDYR(p), brdyr & 0x00E7)
	Set Pn_BRDYR register. More...

#define	getPn_BDPTHR(p) WIZCHIP_READ(Pn_BDPTHR(p))
	Get Pn_BDPTHR register. More...

#define	setPn_BDPTHR(p, bdpthr) WIZCHIP_WRITE(Pn_BDPTHR(p),bdpthr)
	Set Pn_BDPTHR register. More...

#define	getIDR() WIZCHIP_READ(IDR)
	Get IDR register. More...

Functions
void	setTMSR (uint8_t sn, uint8_t tmsr)
	Set TMSR0 ~ TMSR7 register. More...

uint8_t	getTMSR (uint8_t sn)
	Get TMSR0 ~ TMSR7 register. More...

void	setRMSR (uint8_t sn, uint8_t rmsr)
	Set RMS01R ~ RMS67R register. More...

uint8_t	getRMSR (uint8_t sn)
	Get RMS01R ~ RMS67R register. More...

Detailed Description

These are functions to access common registers.

Macro Definition Documentation

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

Set Mode Register.

Parameters

(

Definition at line 1370 of file w5300.h.

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

Get IR register.

Returns: uint8_t. Value of IR register.

See also: setIR()

Definition at line 1379 of file w5300.h.

#define setIMR ( imr ) WIZCHIP_WRITE(_IMR_, imr & 0xF0FF)

Set IMR register.

Parameters

(uint16_t)imr Value to set IMR register.

See also: getIMR()

Definition at line 1389 of file w5300.h.

#define getIMR ( ) (WIZCHIP_READ(_IMR_) & 0xF0FF)

Get IMR register.

Returns: uint16_t. Value of IR register.

See also: setIMR()

Definition at line 1398 of file w5300.h.

#define setSHAR ( shar )

Value:

{ \
 WIZCHIP_WRITE(SHAR, (((uint16_t)((shar)[0])) << 8) + (((uint16_t)((shar)[1])) & 0x00FF)); \
 WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(SHAR,2), (((uint16_t)((shar)[2])) << 8) + (((uint16_t)((shar)[3])) & 0x00FF)); \
 WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(SHAR,4), (((uint16_t)((shar)[4])) << 8) + (((uint16_t)((shar)[5])) & 0x00FF)); \
 }

Set local MAC address.

Parameters

(uint8_t*)shar Pointer variable to set local MAC address. It should be allocated 6 bytes.

See also: getSHAR()

Definition at line 1407 of file w5300.h.

#define setGAR ( gar )

Value:

{ \
 WIZCHIP_WRITE(GAR, (((uint16_t)((gar)[0])) << 8) + (((uint16_t)((gar)[1])) & 0x00FF)); \
 WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(GAR,2), (((uint16_t)((gar)[2])) << 8) + (((uint16_t)((gar)[3])) & 0x00FF)); \
 }

Set gateway IP address.

Parameters

(uint8_t*)gar Pointer variable to set gateway IP address. It should be allocated 4 bytes.

See also: getGAR()

Definition at line 1434 of file w5300.h.

#define getGAR ( gar )

Value:

{ \
 (gar)[0] = (uint8_t)(WIZCHIP_READ(GAR) >> 8); \
 (gar)[1] = (uint8_t)(WIZCHIP_READ(GAR)); \
 (gar)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(GAR,2)) >> 8); \
 (gar)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(GAR,2))); \
 }

Get gateway IP address.

Parameters

(uint8_t*)gar Pointer variable to get gateway IP address. It should be allocated 4 bytes.

See also: setGAR()

Definition at line 1445 of file w5300.h.

#define setSUBR ( subr )

Value:

{ \
 WIZCHIP_WRITE(SUBR, (((uint16_t)((subr)[0])) << 8) + (((uint16_t)((subr)[1])) & 0x00FF)); \
 WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(SUBR,2), (((uint16_t)((subr)[2])) << 8) + (((uint16_t)((subr)[3])) & 0x00FF)); \
 }

Set subnet mask address.

Parameters

(uint8_t*)subr Pointer variable to set subnet mask address. It should be allocated 4 bytes.

See also: getSUBR()

Definition at line 1458 of file w5300.h.

#define getSUBR ( subr )

Value:

{ \
 (subr)[0] = (uint8_t)(WIZCHIP_READ(SUBR) >> 8); \
 (subr)[1] = (uint8_t)(WIZCHIP_READ(SUBR)); \
 (subr)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SUBR,2)) >> 8); \
 (subr)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SUBR,2))); \
 }

Get subnet mask address.

Parameters

(uint8_t*)subr Pointer variable to get subnet mask address. It should be allocated 4 bytes.

See also: setSUBR()

Definition at line 1469 of file w5300.h.

#define setSIPR ( sipr )

Value:

{ \
 WIZCHIP_WRITE(SIPR, (((uint16_t)((sipr)[0])) << 8) + (((uint16_t)((sipr)[1])) & 0x00FF)); \
 WIZCHIP_WRITE(WIZCHIP_OFFSET_INC(SIPR,2), (((uint16_t)((sipr)[2])) << 8) + (((uint16_t)((sipr)[3])) & 0x00FF)); \
 }

Set local IP address.

Parameters

(uint8_t*)sipr Pointer variable to set local IP address. It should be allocated 4 bytes.

See also: getSIPR()

Definition at line 1482 of file w5300.h.

#define getSIPR ( sipr )

Value:

{ \
 (sipr)[0] = (uint8_t)(WIZCHIP_READ(SIPR) >> 8); \
 (sipr)[1] = (uint8_t)(WIZCHIP_READ(SIPR)); \
 (sipr)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SIPR,2)) >> 8); \
 (sipr)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(SIPR,2))); \
 }

Get local IP address.

Parameters

(uint8_t*)sipr Pointer variable to get local IP address. It should be allocated 4 bytes.

See also: setSIPR()

Definition at line 1493 of file w5300.h.

#define setRTR ( rtr ) WIZCHIP_WRITE(_RTR_, rtr)

Set RTR register.

Parameters

(uint16_t)rtr Value to set RTR register.

See also: getRTR()

Definition at line 1507 of file w5300.h.

#define getRTR ( ) WIZCHIP_READ(_RTR_)

Get RTR register.

Returns: uint16_t. Value of RTR register.

See also: setRTR()

Definition at line 1516 of file w5300.h.

#define setRCR ( rcr ) WIZCHIP_WRITE(_RCR_, ((uint16_t)rcr)&0x00FF)

Set RCR register.

Parameters

(uint8_t)rcr Value to set RCR register.

See also: getRCR()

Definition at line 1525 of file w5300.h.

#define getRCR ( ) ((uint8_t)(WIZCHIP_READ(_RCR_) & 0x00FF))

Get RCR register.

Returns: uint8_t. Value of RCR register.

See also: setRCR()

Definition at line 1534 of file w5300.h.

#define setTMS01R ( tms01r ) WIZCHIP_WRITE(TMS01R,tms01r)

Set TMS01R register.

Parameters

(uint16_t)tms01r Value to set TMS01R register. The lower socket memory size is located at MSB of tms01r.

See also: getTMS01R()

Definition at line 1543 of file w5300.h.

#define getTMS01R ( ) WIZCHIP_READ(TMS01R)

Get TMS01R register.

Returns: uint16_t. Value of TMS01R register.

See also: setTMS01R()

Definition at line 1552 of file w5300.h.

#define setTMS23R ( tms23r ) WIZCHIP_WRITE(TMS23R,tms23r)

Set TMS23R register.

Parameters

(uint16_t)tms23r Value to set TMS23R register. The lower socket memory size is located at MSB of tms01r.

See also: getTMS23R()

Definition at line 1561 of file w5300.h.

#define getTMS23R ( ) WIZCHIP_READ(TMS23R)

Get TMS23R register.

Returns: uint16_t. Value of TMS23R register.

See also: setTMS23R()

Definition at line 1570 of file w5300.h.

#define setTMS45R ( tms45r ) WIZCHIP_WRITE(TMS45R,tms45r)

Set TMS45R register.

Parameters

(uint16_t)tms45r Value to set TMS45R register. The lower socket memory size is located at MSB of tms45r.

See also: getTMS45R()

Definition at line 1579 of file w5300.h.

#define getTMS45R ( ) WIZCHIP_READ(TMS45R)

Get TMS45R register.

Returns: uint16_t. Value of TMS45R register.

See also: setTMS45R()

Definition at line 1588 of file w5300.h.

#define setTMS67R ( tms67r ) WIZCHIP_WRITE(TMS67R,tms67r)

Set TMS67R register.

Parameters

(uint16_t)tms67r Value to set TMS67R register. The lower socket memory size is located at MSB of tms67r.

See also: getTMS67R()

Definition at line 1597 of file w5300.h.

#define getTMS67R ( ) WIZCHIP_READ(TMS67R)

Get TMS67R register.

Returns: uint16_t. Value of TMS67R register.

See also: setTMS67R()

Definition at line 1606 of file w5300.h.

#define setRMS01R ( rms01r ) WIZCHIP_WRITE(RMS01R,rms01r)

Set RMS01R register.

Parameters

(uint16_t)rms01r Value to set RMS01R register. The lower socket memory size is located at MSB of rms01r.

See also: getRMS01R()

Definition at line 1635 of file w5300.h.

#define getRMS01R ( ) WIZCHIP_READ(RMS01R)

Get RMS01R register.

Returns: uint16_t. Value of RMS01R register.

See also: setRMS01R()

Definition at line 1644 of file w5300.h.

#define setRMS23R ( rms23r ) WIZCHIP_WRITE(RMS23R,rms23r)

Set RMS23R register.

Parameters

(uint16_t)rms23r Value to set RMS23R register. The lower socket memory size is located at MSB of rms01r.

See also: getRMS23R()

Definition at line 1653 of file w5300.h.

#define getRMS23R ( ) WIZCHIP_READ(RMS23R)

Get RMS23R register.

Returns: uint16_t. Value of RMS23R register.

See also: setRMS23R()

Definition at line 1662 of file w5300.h.

#define setRMS45R ( rms45r ) WIZCHIP_WRITE(RMS45R,rms45r)

Set RMS45R register.

Parameters

(uint16_t)rms45r Value to set RMS45R register. The lower socket memory size is located at MSB of rms45r.

See also: getRMS45R()

Definition at line 1671 of file w5300.h.

#define getRMS45R ( ) WIZCHIP_READ(RMS45R)

Get RMS45R register.

Returns: uint16_t. Value of RMS45R register.

See also: setRMS45R()

Definition at line 1680 of file w5300.h.

#define setRMS67R ( rms67r ) WIZCHIP_WRITE(RMS67R,rms67r)

Set RMS67R register.

Parameters

(uint16_t)rms67r Value to set RMS67R register. The lower socket memory size is located at MSB of rms67r.

See also: getRMS67R()

Definition at line 1689 of file w5300.h.

#define getRMS67R ( ) WIZCHIP_READ(RMS67R)

Get RMS67R register.

Returns: uint16_t. Value of RMS67R register.

See also: setRMS67R()

Definition at line 1698 of file w5300.h.

#define setMTYPER ( mtype ) WIZCHIP_WRITE(MTYPER, mtype)

Set MTYPER register.

Parameters

(uint16_t)mtyper Value to set MTYPER register.

See also: getMTYPER()

Definition at line 1727 of file w5300.h.

#define getMTYPER ( ) WIZCHIP_READ(MTYPER)

Get MTYPER register.

Returns: uint16_t. Value of MTYPER register.

See also: setMTYPER()

Definition at line 1736 of file w5300.h.

#define getPATR ( ) WIZCHIP_READ(PATR)

Get RATR register.

Returns: uint16_t. Value of PATR register.

Definition at line 1744 of file w5300.h.

#define setPTIMER ( ptimer ) WIZCHIP_WRITE(PTIMER, ((uint16_t)ptimer) & 0x00FF)

Set PTIMER register.

Parameters

(uint8_t)ptimer Value to set PTIMER register.

See also: getPTIMER()

Definition at line 1753 of file w5300.h.

#define getPTIMER ( ) ((uint8_t)(WIZCHIP_READ(PTIMER) & 0x00FF))

Get PTIMER register.

Returns: uint8_t. Value of PTIMER register.

See also: setPTIMER()

Definition at line 1762 of file w5300.h.

#define setPMAGIC ( pmagic ) WIZCHIP_WRITE(PMAGIC, ((uint16_t)pmagic) & 0x00FF)

Set PMAGIC register.

Parameters

(uint8_t)pmagic Value to set PMAGIC register.

See also: getPMAGIC()

Definition at line 1771 of file w5300.h.

#define getPMAGIC ( ) ((uint8_t)(WIZCHIP_READ(PMAGIC) & 0x00FF))

Get PMAGIC register.

Returns: uint8_t. Value of PMAGIC register.

See also: setPMAGIC()

Definition at line 1780 of file w5300.h.

#define getPSIDR ( ) WIZCHIP_READ(PSIDR)

Get PSID register.

Returns: uint16_t. Value of PSID register.

Definition at line 1788 of file w5300.h.

#define getPDHAR ( pdhar )

Value:

{ \
 (pdhar)[0] = (uint8_t)(WIZCHIP_READ(PDHAR) >> 8); \
 (pdhar)[1] = (uint8_t)(WIZCHIP_READ(PDHAR)); \
 (pdhar)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(PDHAR,2)) >> 8); \
 (pdhar)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(PDHAR,2))); \
 (pdhar)[4] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(PDHAR,4)) >> 8); \
 (pdhar)[5] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(PDHAR,4))); \
 }

Get PDHAR register.

Parameters

(uint8_t*)pdhar Pointer variable to PPP destination MAC register address. It should be allocated 6 bytes.

Definition at line 1796 of file w5300.h.

#define getUIPR ( uipr )

Value:

{ \
 (uipr)[0] = (uint8_t)(WIZCHIP_READ(UIPR) >> 8); \
 (uipr)[1] = (uint8_t)(WIZCHIP_READ(UIPR)); \
 (uipr)[2] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(UIPR,2)) >> 8); \
 (uipr)[3] = (uint8_t)(WIZCHIP_READ(WIZCHIP_OFFSET_INC(UIPR,2))); \
 }

Get unreachable IP address. UIPR.

Parameters

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

Definition at line 1810 of file w5300.h.

#define getUPORTR ( ) WIZCHIP_READ(UPORTR)

Get UPORTR register.

Returns: uint16_t. Value of UPORTR register.

Definition at line 1822 of file w5300.h.

#define getFMTUR ( ) WIZCHIP_READ(FMTUR)

Get FMTUR register.

Returns: uint16_t. Value of FMTUR register.

Definition at line 1830 of file w5300.h.

#define getPn_BRDYR ( p ) ((uint8_t)(WIZCHIP_READ(Pn_BRDYR(p)) & 0x00FF))

Get Pn_BRDYR register.

Returns: uint8_t. Value of Pn_BRDYR register.

Definition at line 1839 of file w5300.h.

#define setPn_BRDYR	(	p,
		brdyr
	)	WIZCHIP_WRITE(Pn_BRDYR(p), brdyr & 0x00E7)

Set Pn_BRDYR register.

Parameters

p	Pin number (p = 0,1,2,3)
brdyr	Set a value Pn_BRDYR(p).

Definition at line 1848 of file w5300.h.

#define getPn_BDPTHR ( p ) WIZCHIP_READ(Pn_BDPTHR(p))

Get Pn_BDPTHR register.

Parameters

p	Pin number (p = 0,1,2,3)

Returns: uint16_t. Value of Pn_BDPTHR register.

Definition at line 1857 of file w5300.h.

#define setPn_BDPTHR	(	p,
		bdpthr
	)	WIZCHIP_WRITE(Pn_BDPTHR(p),bdpthr)

Set Pn_BDPTHR register.

Parameters

p	Pin number (p = 0,1,2,3)
bdpthr	Value of Pn_BDPTHR

Definition at line 1866 of file w5300.h.

#define getIDR ( ) WIZCHIP_READ(IDR)

Get IDR register.

Returns: uint16_t. Always 0x5300.

Definition at line 1875 of file w5300.h.

Function Documentation

void setTMSR	(	uint8_t	sn,
		uint8_t	tmsr
	)

Set TMSR0 ~ TMSR7 register.

Parameters

(uint8_t)sn	Socket number. It should be 0 ~ 7.
(uint8_t)tmsr	Value to set TMSR0 ~TMSR7 register.

See also: getTMSR()

uint8_t getTMSR ( uint8_t sn )

Get TMSR0 ~ TMSR7 register.

Parameters

(uint8_t)sn Socket number. It should be 0 ~ 7.

Returns: uint8_t. Value of TMSR0 ~ TMSR7

See also: getTMSR()

void setRMSR	(	uint8_t	sn,
		uint8_t	rmsr
	)

Set RMS01R ~ RMS67R register.

Parameters

(uint8_t)sn	Socket number. It should be 0 ~ 7.
(uint8_t)rmsr	Value to set RMSR0 ~RMSR7 register.

See also: getTMSR()

uint8_t getRMSR ( uint8_t sn )

Get RMS01R ~ RMS67R register.

Parameters

(uint8_t)sn Socket number. It shoudl be 0 ~ 7.

Returns: uint8_t. Value of RMSR0 ~ RMSR7 register.

See also: setRMSR()

Socket APIs: Common register access functions

Wiznet Socket API

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation

Get in touch