|
Detailed Description
uIP is an implementation of the TCP/IP protocol stack intended for small 8-bit and 16-bit microcontrollers.
uIP provides the necessary protocols for Internet communication, with a very small code footprint and RAM requirements - the uIP code size is on the order of a few kilobytes and RAM usage is on the order of a few hundred bytes.
{@
Define Documentation
| #define BUF ((struct uip_tcpip_hdr *)&uip_buf[UIP_LLH_LEN]) |
| #define FBUF ((struct uip_tcpip_hdr *)&uip_reassbuf[0]) |
| #define ICMPBUF ((struct uip_icmpip_hdr *)&uip_buf[UIP_LLH_LEN]) |
| #define UDPBUF ((struct uip_udpip_hdr *)&uip_buf[UIP_LLH_LEN]) |
| #define UIP_APPDATA_SIZE |
The buffer size available for user data in the uip_buf buffer.
This macro holds the available size for user data in the uip_buf buffer. The macro is intended to be used for checking bounds of available user data.
Example:
snprintf(uip_appdata, UIP_APPDATA_SIZE, "%u\n", i);
Typedef Documentation
| typedef u16_t uip_ip4addr_t[2] |
| typedef u16_t uip_ip6addr_t[8] |
| typedef uip_ip4addr_t uip_ipaddr_t |
Function Documentation
Carry out a 32-bit addition.
Because not all architectures for which uIP is intended has native 32-bit arithmetic, uIP uses an external C function for doing the required 32-bit additions in the TCP protocol processing. This function should add the two arguments and place the result in the global variable uip_acc32.
- Note:
- The 32-bit integer pointed to by the op32 parameter and the result in the uip_acc32 variable are in network byte order (big endian).
- Parameters:
-
op32 A pointer to a 4-byte array representing a 32-bit integer in network byte order (big endian). op16 A 16-bit integer in host byte order.
Calculate the Internet checksum over a buffer.
The Internet checksum is the one's complement of the one's complement sum of all 16-bit words in the buffer.
See RFC1071.
- Parameters:
-
buf A pointer to the buffer over which the checksum is to be computed. len The length of the buffer over which the checksum is to be computed.
- Returns:
- The Internet checksum of the buffer.
| struct uip_conn* uip_connect | ( | uip_ipaddr_t * | ripaddr, | |
| u16_t | port | |||
| ) | [read] |
Connect to a remote host using TCP.
This function is used to start a new connection to the specified port on the specied host. It allocates a new connection identifier, sets the connection to the SYN_SENT state and sets the retransmission timer to 0. This will cause a TCP SYN segment to be sent out the next time this connection is periodically processed, which usually is done within 0.5 seconds after the call to uip_connect().
- Note:
- This function is avaliable only if support for active open has been configured by defining UIP_ACTIVE_OPEN to 1 in uipopt.h.
- Since this function requires the port number to be in network byte order, a conversion using HTONS() or htons() is necessary.
uip_ipaddr_t ipaddr; uip_ipaddr(&ipaddr, 192,168,1,2); uip_connect(&ipaddr, HTONS(80));
- Parameters:
-
ripaddr The IP address of the remote hot. port A 16-bit port number in network byte order.
- Returns:
- A pointer to the uIP connection identifier for the new connection, or NULL if no connection could be allocated.
Definition at line 412 of file uip.c.
| void uip_init | ( | void | ) |
| u16_t uip_ipchksum | ( | void | ) |
Calculate the IP header checksum of the packet header in uip_buf.
The IP header checksum is the Internet checksum of the 20 bytes of the IP header.
- Returns:
- The IP header checksum of the IP header in the uip_buf buffer.
| void uip_listen | ( | u16_t | port | ) |
| void uip_process | ( | u8_t | flag | ) |
| void uip_send | ( | const void * | data, | |
| int | len | |||
| ) |
Send data on the current connection.
This function is used to send out a single segment of TCP data. Only applications that have been invoked by uIP for event processing can send data.
The amount of data that actually is sent out after a call to this funcion is determined by the maximum amount of data TCP allows. uIP will automatically crop the data so that only the appropriate amount of data is sent. The function uip_mss() can be used to query uIP for the amount of data that actually will be sent.
- Note:
- This function does not guarantee that the sent data will arrive at the destination. If the data is lost in the network, the application will be invoked with the uip_rexmit() event being set. The application will then have to resend the data using this function.
- Parameters:
-
data A pointer to the data which is to be sent. len The maximum amount of data bytes to be sent.
| void uip_setipid | ( | u16_t | id | ) |
| u16_t uip_tcpchksum | ( | void | ) |
Calculate the TCP checksum of the packet in uip_buf and uip_appdata.
The TCP checksum is the Internet checksum of data contents of the TCP segment, and a pseudo-header as defined in RFC793.
- Returns:
- The TCP checksum of the TCP segment in uip_buf and pointed to by uip_appdata.
| struct uip_udp_conn* uip_udp_new | ( | uip_ipaddr_t * | ripaddr, | |
| u16_t | rport | |||
| ) | [read] |
Set up a new UDP connection.
This function sets up a new UDP connection. The function will automatically allocate an unused local port for the new connection. However, another port can be chosen by using the uip_udp_bind() call, after the uip_udp_new() function has been called.
Example:
uip_ipaddr_t addr; struct uip_udp_conn *c; uip_ipaddr(&addr, 192,168,2,1); c = uip_udp_new(&addr, HTONS(12345)); if(c != NULL) { uip_udp_bind(c, HTONS(12344)); }
- Parameters:
-
ripaddr The IP address of the remote host. rport The remote port number in network byte order.
- Returns:
- The uip_udp_conn structure for the new connection or NULL if no connection could be allocated.
Definition at line 478 of file uip.c.
| u16_t uip_udpchksum | ( | void | ) |
Calculate the UDP checksum of the packet in uip_buf and uip_appdata.
The UDP checksum is the Internet checksum of data contents of the UDP segment, and a pseudo-header as defined in RFC768.
- Returns:
- The UDP checksum of the UDP segment in uip_buf and pointed to by uip_appdata.
| void uip_unlisten | ( | u16_t | port | ) |
Variable Documentation
| u8_t uip_buf [UIP_BUFSIZE + 2] ALIGN_STRUCT_END |
| struct uip_eth_addr PACK_STRUCT_END |
Representation of a 48-bit Ethernet address.
| void* uip_appdata |
Pointer to the application data in the packet buffer.
This pointer points to the application data when the application is called. If the application wishes to send data, the application may use this space to write the data into before calling uip_send().
| void* uip_appdata |
Pointer to the application data in the packet buffer.
This pointer points to the application data when the application is called. If the application wishes to send data, the application may use this space to write the data into before calling uip_send().
| struct uip_eth_addr uip_ethaddr = {{0,0,0,0,0,0}} |
The length of the packet in the uip_buf buffer.
The global variable uip_len holds the length of the packet in the uip_buf buffer.
When the network device driver calls the uIP input function, uip_len should be set to the length of the packet in the uip_buf buffer.
When sending packets, the device driver should use the contents of the uip_len variable to determine the length of the outgoing packet.
| u16_t uip_listenports[UIP_LISTENPORTS] |
| void* uip_sappdata |
| struct uip_udp_conn* uip_udp_conn |
| struct uip_udp_conn* uip_udp_conn |
| struct uip_udp_conn uip_udp_conns[UIP_UDP_CONNS] |
| struct uip_udp_conn uip_udp_conns[UIP_UDP_CONNS] |
