MQTT client test with W5200 ethernet shield
Dependents: IBMIoTClientEthernetExample_W5200
Fork of W5500Interface by
Diff: WIZnet/W5500.h
- Revision:
- 9:dfffa4d6f022
- Parent:
- 5:8aefaef88f79
- Child:
- 10:713b6d2aaefb
--- a/WIZnet/W5500.h Mon Oct 06 01:37:10 2014 +0000 +++ b/WIZnet/W5500.h Wed Oct 15 06:25:21 2014 +0000 @@ -7,6 +7,59 @@ #define DEFAULT_WAIT_RESP_TIMEOUT 500 +enum Command { + OPEN = 0x01, + LISTEN = 0x02, + CONNECT = 0x04, + DISCON = 0x08, + CLOSE = 0x10, + SEND = 0x20, + SEND_MAC = 0x21, + SEND_KEEP = 0x22, + RECV = 0x40, + +}; + +enum Interrupt { + INT_CON = 0x01, + INT_DISCON = 0x02, + INT_RECV = 0x04, + INT_TIMEOUT = 0x08, + INT_SEND_OK = 0x10, +}; + +enum Status { + SOCK_CLOSED = 0x00, + SOCK_INIT = 0x13, + SOCK_LISTEN = 0x14, + SOCK_SYNSENT = 0x15, + SOCK_ESTABLISHED = 0x17, + SOCK_CLOSE_WAIT = 0x1c, + SOCK_UDP = 0x22, +}; + +typedef enum +{ + + IK_WOL = (1 << 4), ///< Wake On Lan by receiving the magic packet. Valid in W500. + IK_PPPOE_TERMINATED = (1 << 5), ///< PPPoE Disconnected + + IK_DEST_UNREACH = (1 << 6), ///< Destination IP & Port Unreable, No use in W5200 + + IK_IP_CONFLICT = (1 << 7), ///< IP conflict occurred + + IK_SOCK_0 = (1 << 8), ///< Socket 0 interrupt + IK_SOCK_1 = (1 << 9), ///< Socket 1 interrupt + IK_SOCK_2 = (1 << 10), ///< Socket 2 interrupt + IK_SOCK_3 = (1 << 11), ///< Socket 3 interrupt + IK_SOCK_4 = (1 << 12), ///< Socket 4 interrupt, No use in 5100 + IK_SOCK_5 = (1 << 13), ///< Socket 5 interrupt, No use in 5100 + IK_SOCK_6 = (1 << 14), ///< Socket 6 interrupt, No use in 5100 + IK_SOCK_7 = (1 << 15), ///< Socket 7 interrupt, No use in 5100 + + IK_SOCK_ALL = (0xFF << 8) ///< All Socket interrpt + +}intr_kind; #define MAX_SOCK_NUM 8 @@ -15,7 +68,23 @@ #define SUBR 0x0005 #define SHAR 0x0009 #define SIPR 0x000f +#define INTLEVEL 0x0013 +#define IR 0x0015 +#define IMR 0x0016 +#define SIR 0x0017 +#define SIMR 0x0018 +#define RTR 0x0019 +#define RCR 0x001b +#define PTIMER 0x001c +#define PMAGIC 0x001d +#define PHAR 0x001e +#define PSID 0x0024 +#define PMRU 0x0026 +#define UIPR 0x0028 +#define UPORTR 0x002c #define PHYCFGR 0x002e +#define VERSIONR 0x0039 + // W5500 socket register #define Sn_MR 0x0000 @@ -23,14 +92,106 @@ #define Sn_IR 0x0002 #define Sn_SR 0x0003 #define Sn_PORT 0x0004 +#define Sn_DHAR 0x0006 #define Sn_DIPR 0x000c #define Sn_DPORT 0x0010 +#define Sn_MSSR 0x0012 +#define Sn_TOS 0x0015 +#define Sn_TTL 0x0016 #define Sn_RXBUF_SIZE 0x001e #define Sn_TXBUF_SIZE 0x001f #define Sn_TX_FSR 0x0020 +#define Sn_TX_RD 0x0022 #define Sn_TX_WR 0x0024 #define Sn_RX_RSR 0x0026 #define Sn_RX_RD 0x0028 +#define Sn_RX_WR 0x002a +#define Sn_IMR 0x002c +#define Sn_FRAG 0x002d +#define Sn_KPALVTR 0x002f + +//define for Mode Register option value +#define MR_PPPOE 0x08 +#define MR_RST 0x80 + +//Define for Socket Command register option value +#define Sn_CR_OPEN 0x01 +#define Sn_CR_LISTEN 0x02 +#define Sn_CR_CONNECT 0x04 +#define Sn_CR_DISCON 0x08 +#define Sn_CR_CLOSE 0x10 +#define Sn_CR_SEND 0x20 +#define Sn_CR_SEND_MAC 0x21 +#define Sn_CR_SEND_KEEP 0x22 +#define Sn_CR_RECV 0x40 + + +//Define for Socket Mode register option value +#define Sn_MR_CLOSE 0x00 +#define Sn_MR_TCP 0x01 +#define Sn_MR_UDP 0x02 +#define Sn_MR_MACRAW 0x04 +#define Sn_MR_UCASTB 0x10 +#define Sn_MR_ND 0x20 +#define Sn_MR_BCASTB 0x40 +#define Sn_MR_MULTI 0x80 + +#define Sn_IR_SENDOK 0x10 + +//Sn_IR values + +#define Sn_IR_TIMEOUT 0x08 +#define Sn_IR_RECV 0x04 +#define Sn_IR_DISCON 0x02 +#define Sn_IR_CON 0x01 + +/* + * SOCKET FLAG + */ +#define SF_ETHER_OWN (Sn_MR_MFEN) ///< In \ref Sn_MR_MACRAW, Receive only the packet as broadcast, multicast and own packet +#define SF_IGMP_VER2 (Sn_MR_ND) ///< In \ref Sn_MR_UDP with \ref SF_MULTI_ENABLE, Select IGMP version 2. +#define SF_TCP_NODELAY (Sn_MR_ND) ///< In \ref Sn_MR_TCP, Use to nodelayed ack. +#define SF_MULTI_ENABLE (Sn_MR_MULTI) ///< In \ref Sn_MR_UDP, Enable multicast mode. +#define SF_IO_NONBLOCK 0x01 ///< Socket nonblock io mode. It used parameter in \ref socket(). +#define SF_BROAD_BLOCK (Sn_MR_BCASTB) ///< In \ref Sn_MR_UDP or \ref Sn_MR_MACRAW, Block broadcast packet. Valid only in W5500 +#define SF_MULTI_BLOCK (Sn_MR_MMB) ///< In \ref Sn_MR_MACRAW, Block multicast packet. Valid only in W5500 +#define SF_IPv6_BLOCK (Sn_MR_MIP6B) ///< In \ref Sn_MR_MACRAW, Block IPv6 packet. Valid only in W5500 +#define SF_UNI_BLOCK (Sn_MR_UCASTB) ///< In \ref Sn_MR_UDP with \ref SF_MULTI_ENABLE. Valid only in W5500 + +#define SOCK_MACRAW 0x42 + + +/* PHYCFGR register value */ +#define PHYCFGR_RST ~(1<<7) //< For PHY reset, must operate AND mask. +#define PHYCFGR_OPMD (1<<6) // Configre PHY with OPMDC value +#define PHYCFGR_OPMDC_ALLA (7<<3) +#define PHYCFGR_OPMDC_PDOWN (6<<3) +#define PHYCFGR_OPMDC_NA (5<<3) +#define PHYCFGR_OPMDC_100FA (4<<3) +#define PHYCFGR_OPMDC_100F (3<<3) +#define PHYCFGR_OPMDC_100H (2<<3) +#define PHYCFGR_OPMDC_10F (1<<3) +#define PHYCFGR_OPMDC_10H (0<<3) +#define PHYCFGR_DPX_FULL (1<<2) +#define PHYCFGR_DPX_HALF (0<<2) +#define PHYCFGR_SPD_100 (1<<1) +#define PHYCFGR_SPD_10 (0<<1) +#define PHYCFGR_LNK_ON (1<<0) +#define PHYCFGR_LNK_OFF (0<<0) + +//PHY status define +#define PHY_CONFBY_HW 0 ///< Configured PHY operation mode by HW pin +#define PHY_CONFBY_SW 1 ///< Configured PHY operation mode by SW register +#define PHY_MODE_MANUAL 0 ///< Configured PHY operation mode with user setting. +#define PHY_MODE_AUTONEGO 1 ///< Configured PHY operation mode with auto-negotiation +#define PHY_SPEED_10 0 ///< Link Speed 10 +#define PHY_SPEED_100 1 ///< Link Speed 100 +#define PHY_DUPLEX_HALF 0 ///< Link Half-Duplex +#define PHY_DUPLEX_FULL 1 ///< Link Full-Duplex +#define PHY_LINK_OFF 0 ///< Link Off +#define PHY_LINK_ON 1 ///< Link On +#define PHY_POWER_NORM 0 ///< PHY power normal mode +#define PHY_POWER_DOWN 1 ///< PHY power down mode class WIZnet_Chip { public: @@ -113,6 +274,31 @@ * @returns true if successful */ bool is_connected(int socket); + + + int8_t Socket_macraw(uint8_t sn, uint16_t port, uint8_t flag) + { + //CHECK_SOCKNUM(); + + if((flag & 0x06) != 0) return SOCKERR_SOCKFLAG; + + close(sn); + setSn_MR(sn, (Sn_MR_MACRAW | (flag & 0xF0))); + if(!port) + { + port = sock_any_port++; + if(sock_any_port == 0xFFF0) sock_any_port = SOCK_ANY_PORT_NUM; + } + setSn_PORT(sn,port); + setSn_CR(sn,Sn_CR_OPEN); + while(eth->getSn_CR(sn)); + //sock_io_mode |= ((flag & SF_IO_NONBLOCK) << sn); + //sock_is_sending &= ~(1<<sn); + //sock_remained_size[sn] = 0; + //sock_pack_info[sn] = 0; + while(getSn_SR(sn) == SOCK_CLOSED); + return (int8_t)sn; + } /* * Close a tcp connection @@ -209,10 +395,880 @@ } spi_write(addr, cb, buf, sizeof(buf)); } + void reg_rd_ip_byte(uint16_t addr, uint8_t* data) { + spi_read(addr, 0x00, data, 4); + } + + void reg_wr_ip_byte(uint16_t addr, uint8_t* data) { + spi_write(addr, 0x04, data, 4); + } void sreg_ip(int socket, uint16_t addr, const char* ip) { reg_wr_ip(addr, (0x0C + (socket << 5)), ip); } + + +///////////////////////////////// +// Common Register I/O function // +///////////////////////////////// +/** + * @ingroup Common_register_access_function + * @brief Set Mode Register + * @param (uint8_t)mr The value to be set. + * @sa getMR() + */ + void setMR(uint8_t mr) { + reg_wr<uint8_t>(MR,mr); + } + + +/** + * @ingroup Common_register_access_function + * @brief Get Mode Register + * @return uint8_t. The value of Mode register. + * @sa setMR() + */ + uint8_t getMR() { + return reg_rd<uint8_t>(MR); + } + +/** + * @ingroup Common_register_access_function + * @brief Set gateway IP address + * @param (uint8_t*)gar Pointer variable to set gateway IP address. It should be allocated 4 bytes. + * @sa getGAR() + */ + void setGAR(uint8_t * gar) { + reg_wr_ip_byte(GAR,gar); + } + +/** + * @ingroup Common_register_access_function + * @brief Get gateway IP address + * @param (uint8_t*)gar Pointer variable to get gateway IP address. It should be allocated 4 bytes. + * @sa setGAR() + */ + void getGAR(uint8_t * gar) { + reg_rd_ip_byte(GAR,gar); + } + +/** + * @ingroup Common_register_access_function + * @brief Set subnet mask address + * @param (uint8_t*)subr Pointer variable to set subnet mask address. It should be allocated 4 bytes. + * @sa getSUBR() + */ + void setSUBR(uint8_t * subr) { + reg_wr_ip_byte(SUBR, subr); + } + + +/** + * @ingroup Common_register_access_function + * @brief Get subnet mask address + * @param (uint8_t*)subr Pointer variable to get subnet mask address. It should be allocated 4 bytes. + * @sa setSUBR() + */ + void getSUBR(uint8_t * subr) { + reg_rd_ip_byte(SUBR, subr); + } + +/** + * @ingroup Common_register_access_function + * @brief Set local MAC address + * @param (uint8_t*)shar Pointer variable to set local MAC address. It should be allocated 6 bytes. + * @sa getSHAR() + */ + void setSHAR(uint8_t * shar) { + reg_wr_mac(SHAR, shar); + } + +/** + * @ingroup Common_register_access_function + * @brief Get local MAC address + * @param (uint8_t*)shar Pointer variable to get local MAC address. It should be allocated 6 bytes. + * @sa setSHAR() + */ + void getSHAR(uint8_t * shar) { + reg_rd_mac(SHAR, shar); + } + +/** + * @ingroup Common_register_access_function + * @brief Set local IP address + * @param (uint8_t*)sipr Pointer variable to set local IP address. It should be allocated 4 bytes. + * @sa getSIPR() + */ + void setSIPR(uint8_t * sipr) { + reg_wr_ip_byte(SIPR, sipr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get local IP address + * @param (uint8_t*)sipr Pointer variable to get local IP address. It should be allocated 4 bytes. + * @sa setSIPR() + */ + void getSIPR(uint8_t * sipr) { + reg_rd_ip_byte(SIPR, sipr); + } + +/** + * @ingroup Common_register_access_function + * @brief Set INTLEVEL register + * @param (uint16_t)intlevel Value to set @ref INTLEVEL register. + * @sa getINTLEVEL() + */ + void setINTLEVEL(uint16_t intlevel) { + reg_wr<uint16_t>(INTLEVEL, intlevel); + } + + +/** + * @ingroup Common_register_access_function + * @brief Get INTLEVEL register + * @return uint16_t. Value of @ref INTLEVEL register. + * @sa setINTLEVEL() + */ + uint16_t getINTLEVEL() { + return reg_rd<uint16_t>(INTLEVEL); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref IR register + * @param (uint8_t)ir Value to set @ref IR register. + * @sa getIR() + */ + void setIR(uint8_t ir) { + reg_wr<uint8_t>(IR, (ir & 0xF0)); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref IR register + * @return uint8_t. Value of @ref IR register. + * @sa setIR() + */ + uint8_t getIR() { + return reg_rd<uint8_t>(IR & 0xF0); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref IMR register + * @param (uint8_t)imr Value to set @ref IMR register. + * @sa getIMR() + */ + void setIMR(uint8_t imr) { + reg_wr<uint8_t>(IMR, imr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref IMR register + * @return uint8_t. Value of @ref IMR register. + * @sa setIMR() + */ + uint8_t getIMR() { + return reg_rd<uint8_t>(IMR); + } + + +/** + * @ingroup Common_register_access_function + * @brief Set @ref SIR register + * @param (uint8_t)sir Value to set @ref SIR register. + * @sa getSIR() + */ + void setSIR(uint8_t sir) { + reg_wr<uint8_t>(SIR, sir); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref SIR register + * @return uint8_t. Value of @ref SIR register. + * @sa setSIR() + */ + uint8_t getSIR() { + return reg_rd<uint8_t>(SIR); + } +/** + * @ingroup Common_register_access_function + * @brief Set @ref SIMR register + * @param (uint8_t)simr Value to set @ref SIMR register. + * @sa getSIMR() + */ + void setSIMR(uint8_t simr) { + reg_wr<uint8_t>(SIMR, simr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref SIMR register + * @return uint8_t. Value of @ref SIMR register. + * @sa setSIMR() + */ + uint8_t getSIMR() { + return reg_rd<uint8_t>(SIMR); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref RTR register + * @param (uint16_t)rtr Value to set @ref RTR register. + * @sa getRTR() + */ + void setRTR(uint16_t rtr) { + reg_wr<uint16_t>(RTR, rtr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref RTR register + * @return uint16_t. Value of @ref RTR register. + * @sa setRTR() + */ + uint16_t getRTR() { + return reg_rd<uint16_t>(RTR); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref RCR register + * @param (uint8_t)rcr Value to set @ref RCR register. + * @sa getRCR() + */ + void setRCR(uint8_t rcr) { + reg_wr<uint8_t>(RCR, rcr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref RCR register + * @return uint8_t. Value of @ref RCR register. + * @sa setRCR() + */ + uint8_t getRCR() { + return reg_rd<uint8_t>(RCR); + } + +//================================================== test done =========================================================== + +/** + * @ingroup Common_register_access_function + * @brief Set @ref PTIMER register + * @param (uint8_t)ptimer Value to set @ref PTIMER register. + * @sa getPTIMER() + */ + void setPTIMER(uint8_t ptimer) { + reg_wr<uint8_t>(PTIMER, ptimer); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref PTIMER register + * @return uint8_t. Value of @ref PTIMER register. + * @sa setPTIMER() + */ + uint8_t getPTIMER() { + return reg_rd<uint8_t>(PTIMER); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref PMAGIC register + * @param (uint8_t)pmagic Value to set @ref PMAGIC register. + * @sa getPMAGIC() + */ +/* +#define setPMAGIC(pmagic) \ + WIZCHIP_WRITE(PMAGIC, pmagic) +*/ + void setPMAGIC(uint8_t pmagic) { + reg_wr<uint8_t>(PMAGIC, pmagic ); + } +/** + * @ingroup Common_register_access_function + * @brief Get @ref PMAGIC register + * @return uint8_t. Value of @ref PMAGIC register. + * @sa setPMAGIC() + */ +/* +#define getPMAGIC() \ + WIZCHIP_READ(PMAGIC) +*/ + uint8_t getPMAGIC(uint8_t pmagic) { + return reg_rd<uint8_t>(PMAGIC, pmagic); + } +/** + * @ingroup Common_register_access_function + * @brief Set PHAR address + * @param (uint8_t*)phar Pointer variable to set PPP destination MAC register address. It should be allocated 6 bytes. + * @sa getPHAR() + */ + void setPHAR(uint8_t * phar) { + reg_wr_mac(PHAR, phar); + } + +/** + * @ingroup Common_register_access_function + * @brief Get local IP address + * @param (uint8_t*)phar Pointer variable to PPP destination MAC register address. It should be allocated 6 bytes. + * @sa setPHAR() + */ + void getPHAR(uint8_t * phar) { + reg_rd_mac(PHAR, phar); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref PSID register + * @param (uint16_t)psid Value to set @ref PSID register. + * @sa getPSID() + */ + void setPSID(uint16_t psid) { + reg_wr<uint16_t>(PSID, psid ); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref PSID register + * @return uint16_t. Value of @ref PSID register. + * @sa setPSID() + */ +//uint16_t getPSID(void); + uint16_t getPSID() { + return reg_rd<uint16_t>(PSID); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref PMRU register + * @param (uint16_t)pmru Value to set @ref PMRU register. + * @sa getPMRU() + */ + void setPMRU(uint16_t pmru) { + reg_wr<uint16_t>(PMRU, pmru); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref PMRU register + * @return uint16_t. Value of @ref PMRU register. + * @sa setPMRU() + */ + uint16_t getPMRU() { + return reg_rd<uint16_t>(PMRU); + } + +/** + * @ingroup Common_register_access_function + * @brief Get unreachable IP address + * @param (uint8_t*)uipr Pointer variable to get unreachable IP address. It should be allocated 4 bytes. + */ + void getUIPR(uint8_t * uipr) { + reg_rd_ip_byte(UIPR,uipr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref UPORTR register + * @return uint16_t. Value of @ref UPORTR register. + */ + uint16_t getUPORTR() { + return reg_rd<uint16_t>(UPORTR); + } + +/** + * @ingroup Common_register_access_function + * @brief Set @ref PHYCFGR register + * @param (uint8_t)phycfgr Value to set @ref PHYCFGR register. + * @sa getPHYCFGR() + */ + void setPHYCFGR(uint8_t phycfgr) { + reg_wr<uint8_t>(PHYCFGR, phycfgr); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref PHYCFGR register + * @return uint8_t. Value of @ref PHYCFGR register. + * @sa setPHYCFGR() + */ + uint8_t getPHYCFGR() { + return reg_rd<uint8_t>(PHYCFGR); + } + +/** + * @ingroup Common_register_access_function + * @brief Get @ref VERSIONR register + * @return uint8_t. Value of @ref VERSIONR register. + */ + uint8_t getVERSIONR() { + return reg_rd<uint8_t>(VERSIONR); + } + +///////////////////////////////////// + +/////////////////////////////////// +// Socket N register I/O function // +/////////////////////////////////// +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_MR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)mr Value to set @ref Sn_MR + * @sa getSn_MR() + */ + void setSn_MR(uint8_t sn, uint8_t mr) { + sreg<uint8_t>(sn, MR, mr); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_MR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_MR. + * @sa setSn_MR() + */ + uint8_t getSn_MR(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_MR); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_CR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)cr Value to set @ref Sn_CR + * @sa getSn_CR() + */ + void setSn_CR(uint8_t sn, uint8_t cr) { + sreg<uint8_t>(sn, Sn_CR, cr); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_CR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_CR. + * @sa setSn_CR() + */ + uint8_t getSn_CR(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_CR); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_IR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)ir Value to set @ref Sn_IR + * @sa getSn_IR() + */ + void setSn_IR(uint8_t sn, uint8_t ir) { + sreg<uint8_t>(sn, Sn_IR, (ir & 0x1F)); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_IR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_IR. + * @sa setSn_IR() + */ + uint8_t getSn_IR(uint8_t sn) { + return (sreg<uint8_t>(sn, Sn_IR)) & 0x1F; + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_IMR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)imr Value to set @ref Sn_IMR + * @sa getSn_IMR() + */ + void setSn_IMR(uint8_t sn, uint8_t imr) { + sreg<uint8_t>(sn, Sn_IMR, (imr & 0x1F)); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_IMR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_IMR. + * @sa setSn_IMR() + */ + uint8_t getSn_IMR(uint8_t sn) { + return (sreg<uint8_t>(sn, Sn_IMR)) & 0x1F; + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_SR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_SR. + */ + uint8_t getSn_SR(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_SR); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_PORT register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)port Value to set @ref Sn_PORT. + * @sa getSn_PORT() + */ + void setSn_PORT(uint8_t sn, uint16_t port) { + sreg<uint16_t>(sn, Sn_PORT, port ); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_PORT register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_PORT. + * @sa setSn_PORT() + */ + uint16_t getSn_PORT(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_PORT); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_DHAR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t*)dhar Pointer variable to set socket n destination hardware address. It should be allocated 6 bytes. + * @sa getSn_DHAR() + */ + void setSn_DHAR(uint8_t sn, uint8_t * dhar) { + spi_write(Sn_DHAR, (0x0C + (sn << 5)), dhar, 6); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_MR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t*)dhar Pointer variable to get socket n destination hardware address. It should be allocated 6 bytes. + * @sa setSn_DHAR() + */ + void getSn_DHAR(uint8_t sn, uint8_t * dhar) { + spi_read(Sn_DHAR, (0x08 + (sn << 5)), dhar, 6); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_DIPR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t*)dipr Pointer variable to set socket n destination IP address. It should be allocated 4 bytes. + * @sa getSn_DIPR() + */ + void setSn_DIPR(uint8_t sn, uint8_t * dipr) { + spi_write(Sn_DIPR, (0x0C + (sn << 5)), dipr, 4); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_DIPR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t*)dipr Pointer variable to get socket n destination IP address. It should be allocated 4 bytes. + * @sa SetSn_DIPR() + */ + void getSn_DIPR(uint8_t sn, uint8_t * dipr) { + spi_read(Sn_DIPR, (0x08 + (sn << 5)), dipr, 4); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_DPORT register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)dport Value to set @ref Sn_DPORT + * @sa getSn_DPORT() + */ + void setSn_DPORT(uint8_t sn, uint16_t dport) { + sreg<uint16_t>(sn, Sn_DPORT, dport); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_DPORT register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_DPORT. + * @sa setSn_DPORT() + */ + uint16_t getSn_DPORT(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_DPORT); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_MSSR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)mss Value to set @ref Sn_MSSR + * @sa setSn_MSSR() + */ + void setSn_MSSR(uint8_t sn, uint16_t mss) { + sreg<uint16_t>(sn, Sn_MSSR, mss); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_MSSR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_MSSR. + * @sa setSn_MSSR() + */ + uint16_t getSn_MSSR(uint16_t sn) { + return sreg<uint16_t>(sn, Sn_MSSR); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_TOS register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)tos Value to set @ref Sn_TOS + * @sa getSn_TOS() + */ + void setSn_TOS(uint8_t sn, uint8_t tos) { + sreg<uint8_t>(sn, Sn_TOS, tos); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TOS register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of Sn_TOS. + * @sa setSn_TOS() + */ + uint8_t getSn_TOS(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_TOS); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_TTL register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)ttl Value to set @ref Sn_TTL + * @sa getSn_TTL() + */ + void setSn_TTL(uint8_t sn, uint8_t ttl) { + sreg<uint8_t>(sn, Sn_TTL, ttl); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TTL register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_TTL. + * @sa setSn_TTL() + */ + uint8_t getSn_TTL(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_TTL); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_RXBUF_SIZE register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)rxbufsize Value to set @ref Sn_RXBUF_SIZE + * @sa getSn_RXBUF_SIZE() + */ + void setSn_RXBUF_SIZE(uint8_t sn, uint8_t rxbufsize) { + sreg<uint8_t>(sn, Sn_RXBUF_SIZE ,rxbufsize); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_RXBUF_SIZE register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_RXBUF_SIZE. + * @sa setSn_RXBUF_SIZE() + */ + uint8_t getSn_RXBUF_SIZE(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_RXBUF_SIZE); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_TXBUF_SIZE register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)txbufsize Value to set @ref Sn_TXBUF_SIZE + * @sa getSn_TXBUF_SIZE() + */ + void setSn_TXBUF_SIZE(uint8_t sn, uint8_t txbufsize) { + sreg<uint8_t>(sn, Sn_TXBUF_SIZE, txbufsize); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TXBUF_SIZE register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_TXBUF_SIZE. + * @sa setSn_TXBUF_SIZE() + */ + uint8_t getSn_TXBUF_SIZE(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_TXBUF_SIZE); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TX_FSR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_TX_FSR. + */ + uint16_t getSn_TX_FSR(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_TX_FSR); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TX_RD register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_TX_RD. + */ + uint16_t getSn_TX_RD(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_TX_RD); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_TX_WR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)txwr Value to set @ref Sn_TX_WR + * @sa GetSn_TX_WR() + */ + void setSn_TX_WR(uint8_t sn, uint16_t txwr) { + sreg<uint16_t>(sn, Sn_TX_WR, txwr); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_TX_WR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_TX_WR. + * @sa setSn_TX_WR() + */ + uint16_t getSn_TX_WR(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_TX_WR); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_RX_RSR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_RX_RSR. + */ + uint16_t getSn_RX_RSR(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_RX_RSR); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_RX_RD register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)rxrd Value to set @ref Sn_RX_RD + * @sa getSn_RX_RD() + */ + void setSn_RX_RD(uint8_t sn, uint16_t rxrd) { + sreg<uint16_t>(sn, Sn_RX_RD, rxrd); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_RX_RD register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @regurn uint16_t. Value of @ref Sn_RX_RD. + * @sa setSn_RX_RD() + */ + uint16_t getSn_RX_RD(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_RX_RD); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_RX_WR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_RX_WR. + */ + uint16_t getSn_RX_WR(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_RX_WR); + } + + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_FRAG register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint16_t)frag Value to set @ref Sn_FRAG + * @sa getSn_FRAD() + */ + void setSn_FRAG(uint8_t sn, uint16_t frag) { + sreg<uint16_t>(sn, Sn_FRAG, frag ); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_FRAG register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of @ref Sn_FRAG. + * @sa setSn_FRAG() + */ + uint16_t getSn_FRAG(uint8_t sn) { + return sreg<uint16_t>(sn, Sn_FRAG); + } + +/** + * @ingroup Socket_register_access_function + * @brief Set @ref Sn_KPALVTR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @param (uint8_t)kpalvt Value to set @ref Sn_KPALVTR + * @sa getSn_KPALVTR() + */ + void setSn_KPALVTR(uint8_t sn, uint8_t kpalvt) { + sreg<uint8_t>(sn, Sn_KPALVTR, kpalvt); + } + +/** + * @ingroup Socket_register_access_function + * @brief Get @ref Sn_KPALVTR register + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint8_t. Value of @ref Sn_KPALVTR. + * @sa setSn_KPALVTR() + */ + uint8_t getSn_KPALVTR(uint8_t sn) { + return sreg<uint8_t>(sn, Sn_KPALVTR); + } + +////////////////////////////////////// + +///////////////////////////////////// +// Sn_TXBUF & Sn_RXBUF IO function // +///////////////////////////////////// +/** + * @brief Gets the max buffer size of socket sn passed as parameter. + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of Socket n RX max buffer size. + */ + uint16_t getSn_RxMAX(uint8_t sn) { + return (getSn_RXBUF_SIZE(sn) << 10); + } + +/** + * @brief Gets the max buffer size of socket sn passed as parameters. + * @param (uint8_t)sn Socket number. It should be <b>0 ~ 7</b>. + * @return uint16_t. Value of Socket n TX max buffer size. + */ +//uint16_t getSn_TxMAX(uint8_t sn); + uint16_t getSn_TxMAX(uint8_t sn) { + return (getSn_TXBUF_SIZE(sn) << 10); + } protected: uint8_t mac[6];