Rev Author Line No. Line
3328 povik 1 /**
2 * \defgroup uiparch Architecture specific uIP functions
3 * @{
4 *
5 * The functions in the architecture specific module implement the IP
6 * check sum and 32-bit additions.
7 *
8 * The IP checksum calculation is the most computationally expensive
9 * operation in the TCP/IP stack and it therefore pays off to
10 * implement this in efficient assembler. The purpose of the uip-arch
11 * module is to let the checksum functions to be implemented in
12 * architecture specific assembler.
13 *
14 */
15  
16 /**
17 * \file
18 * Declarations of architecture specific functions.
19 * \author Adam Dunkels <adam@dunkels.com>
20 */
21  
22 /*
23 * Copyright (c) 2001, Adam Dunkels.
24 * All rights reserved.
25 *
26 * Redistribution and use in source and binary forms, with or without
27 * modification, are permitted provided that the following conditions
28 * are met:
29 * 1. Redistributions of source code must retain the above copyright
30 * notice, this list of conditions and the following disclaimer.
31 * 2. Redistributions in binary form must reproduce the above copyright
32 * notice, this list of conditions and the following disclaimer in the
33 * documentation and/or other materials provided with the distribution.
34 * 3. The name of the author may not be used to endorse or promote
35 * products derived from this software without specific prior
36 * written permission.
37 *
38 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
39 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
40 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
41 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
42 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
43 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
44 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
45 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
46 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
47 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
48 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49 *
50 * This file is part of the uIP TCP/IP stack.
51 *
52 * $Id: uip_arch.h,v 1.1.2.2 2003/10/06 15:10:22 adam Exp $
53 *
54 */
55  
56 #ifndef __UIP_ARCH_H__
57 #define __UIP_ARCH_H__
58  
59 #include "uip.h"
60  
61 /**
62 * Carry out a 32-bit addition.
63 *
64 * Because not all architectures for which uIP is intended has native
65 * 32-bit arithmetic, uIP uses an external C function for doing the
66 * required 32-bit additions in the TCP protocol processing. This
67 * function should add the two arguments and place the result in the
68 * global variable uip_acc32.
69 *
70 * \note The 32-bit integer pointed to by the op32 parameter and the
71 * result in the uip_acc32 variable are in network byte order (big
72 * endian).
73 *
74 * \param op32 A pointer to a 4-byte array representing a 32-bit
75 * integer in network byte order (big endian).
76 *
77 * \param op16 A 16-bit integer in host byte order.
78 */
79 void uip_add32(u8_t *op32, u16_t op16);
80  
81 /**
82 * Calculate the Internet checksum over a buffer.
83 *
84 * The Internet checksum is the one's complement of the one's
85 * complement sum of all 16-bit words in the buffer.
86 *
87 * See RFC1071.
88 *
89 * \note This function is not called in the current version of uIP,
90 * but future versions might make use of it.
91 *
92 * \param buf A pointer to the buffer over which the checksum is to be
93 * computed.
94 *
95 * \param len The length of the buffer over which the checksum is to
96 * be computed.
97 *
98 * \return The Internet checksum of the buffer.
99 */
100 u16_t uip_chksum(u16_t *buf, u16_t len);
101  
102 /**
103 * Calculate the IP header checksum of the packet header in uip_buf.
104 *
105 * The IP header checksum is the Internet checksum of the 20 bytes of
106 * the IP header.
107 *
108 * \return The IP header checksum of the IP header in the uip_buf
109 * buffer.
110 */
111 u16_t uip_ipchksum(void);
112  
113 /**
114 * Calculate the TCP checksum of the packet in uip_buf and uip_appdata.
115 *
116 * The TCP checksum is the Internet checksum of data contents of the
117 * TCP segment, and a pseudo-header as defined in RFC793.
118 *
119 * \note The uip_appdata pointer that points to the packet data may
120 * point anywhere in memory, so it is not possible to simply calculate
121 * the Internet checksum of the contents of the uip_buf buffer.
122 *
123 * \return The TCP checksum of the TCP segment in uip_buf and pointed
124 * to by uip_appdata.
125 */
126 u16_t uip_tcpchksum(void);
127  
128 /** @} */
129  
130 #endif /* __UIP_ARCH_H__ */