Changeset 8fb1bf82 in mainline for uspace/srv/net/tl/tcp/tcp_header.h


Ignore:
Timestamp:
2010-11-25T13:42:50Z (14 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
8df8415
Parents:
a93d79a (diff), eb667613 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge mainline changes.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/srv/net/tl/tcp/tcp_header.h

    ra93d79a r8fb1bf82  
    2828
    2929/** @addtogroup tcp
    30  *  @{
     30 * @{
    3131 */
    3232
    3333/** @file
    34  *  TCP header definition.
    35  *  Based on the RFC~793.
     34 * TCP header definition.
     35 * Based on the RFC 793.
    3636 */
    3737
    38 #ifndef __NET_TCP_HEADER_H__
    39 #define __NET_TCP_HEADER_H__
     38#ifndef NET_TCP_HEADER_H_
     39#define NET_TCP_HEADER_H_
    4040
    4141#include <sys/types.h>
    4242
    43 /** TCP header size in bytes.
    44  */
    45 #define TCP_HEADER_SIZE                 sizeof(tcp_header_t)
     43/** TCP header size in bytes. */
     44#define TCP_HEADER_SIZE                         sizeof(tcp_header_t)
    4645
    4746/** Returns the actual TCP header length in bytes.
    48  *  @param[in] header The TCP packet header.
     47 * @param[in] header The TCP packet header.
    4948 */
    50 #define TCP_HEADER_LENGTH(header)               ((header)->header_length * 4u)
     49#define TCP_HEADER_LENGTH(header)               ((header)->header_length * 4U)
    5150
    5251/** Returns the TCP header length.
    53  *  @param[in] length The TCP header length in bytes.
     52 * @param[in] length The TCP header length in bytes.
    5453 */
    55 #define TCP_COMPUTE_HEADER_LENGTH(length)               ((uint8_t) ((length) / 4u))
     54#define TCP_COMPUTE_HEADER_LENGTH(length)       ((uint8_t) ((length) / 4U))
    5655
    5756/** Type definition of the transmission datagram header.
    58  *  @see tcp_header
     57 * @see tcp_header
    5958 */
    60 typedef struct tcp_header       tcp_header_t;
    61 
    62 /** Type definition of the transmission datagram header pointer.
    63  *  @see tcp_header
    64  */
    65 typedef tcp_header_t *          tcp_header_ref;
     59typedef struct tcp_header tcp_header_t;
    6660
    6761/** Type definition of the transmission datagram header option.
    68  *  @see tcp_option
     62 * @see tcp_option
    6963 */
    70 typedef struct tcp_option       tcp_option_t;
     64typedef struct tcp_option tcp_option_t;
    7165
    72 /** Type definition of the transmission datagram header option pointer.
    73  *  @see tcp_option
    74  */
    75 typedef tcp_option_t *          tcp_option_ref;
     66/** Type definition of the Maximum segment size TCP option. */
     67typedef struct tcp_max_segment_size_option tcp_max_segment_size_option_t;
    7668
    77 /** Type definition of the Maximum segment size TCP option.
    78  *  @see ...
    79  */
    80 typedef struct tcp_max_segment_size_option      tcp_max_segment_size_option_t;
    81 
    82 /** Type definition of the Maximum segment size TCP option pointer.
    83  *  @see tcp_max_segment_size_option
    84  */
    85 typedef tcp_max_segment_size_option_t *         tcp_max_segment_size_option_ref;
    86 
    87 /** Transmission datagram header.
    88  */
    89 struct tcp_header{
    90         /** The source port number.
    91          */
     69/** Transmission datagram header. */
     70struct tcp_header {
    9271        uint16_t source_port;
    93         /** The destination port number.
    94          */
    9572        uint16_t destination_port;
    96         /** The sequence number of the first data octet in this segment (except when SYN is present).
    97          *  If SYN is present the sequence number is the initial sequence number (ISN) and the first data octet is ISN+1.
    98          */
    9973        uint32_t sequence_number;
    100         /** If the ACK control bit is set this field contains the value of the next sequence number the sender of the segment is expecting to receive.
    101          *  Once a~connection is established this is always sent.
    102          *  @see acknowledge
    103          */
    10474        uint32_t acknowledgement_number;
     75       
    10576#ifdef ARCH_IS_BIG_ENDIAN
    106         /** The number of 32~bit words in the TCP Header.
    107          *  This indicates where the data begins.
    108          *  The TCP header (even one including options) is an integral number of 32~bits long.
    109          */
    11077        uint8_t header_length:4;
    111         /** Four bits reserved for future use.
    112          *  Must be zero.
    113          */
    11478        uint8_t reserved1:4;
    11579#else
    116         /** Four bits reserved for future use.
    117          *  Must be zero.
    118          */
    11980        uint8_t reserved1:4;
    120         /** The number of 32~bit words in the TCP Header.
    121          *  This indicates where the data begins.
    122          *  The TCP header (even one including options) is an integral number of 32~bits long.
    123          */
    12481        uint8_t header_length:4;
    12582#endif
     83
    12684#ifdef ARCH_IS_BIG_ENDIAN
    127         /** Two bits reserved for future use.
    128          *  Must be zero.
    129          */
    13085        uint8_t reserved2:2;
    131         /** Urgent Pointer field significant.
    132          *  @see tcp_header:urgent_pointer
    133          */
    13486        uint8_t urgent:1;
    135         /** Acknowledgment field significant
    136          *  @see tcp_header:acknowledgement_number
    137          */
    13887        uint8_t acknowledge:1;
    139         /** Push function.
    140          */
    14188        uint8_t push:1;
    142         /** Reset the connection.
    143          */
    14489        uint8_t reset:1;
    145         /** Synchronize the sequence numbers.
    146          */
    14790        uint8_t synchronize:1;
    148         /** No more data from the sender.
    149          */
    15091        uint8_t finalize:1;
    15192#else
    152         /** No more data from the sender.
    153          */
    15493        uint8_t finalize:1;
    155         /** Synchronize the sequence numbers.
    156          */
    15794        uint8_t synchronize:1;
    158         /** Reset the connection.
    159          */
    16095        uint8_t reset:1;
    161         /** Push function.
    162          */
    16396        uint8_t push:1;
    164         /** Acknowledgment field significant.
    165          *  @see tcp_header:acknowledgement_number
    166          */
    16797        uint8_t acknowledge:1;
    168         /** Urgent Pointer field significant.
    169          *  @see tcp_header:urgent_pointer
    170          */
    17198        uint8_t urgent:1;
    172         /** Two bits reserved for future use.
    173          *  Must be zero.
    174          */
    17599        uint8_t reserved2:2;
    176100#endif
    177         /** The number of data octets beginning with the one indicated in the acknowledgment field which the sender of this segment is willing to accept.
    178          *  @see tcp_header:acknowledge
    179          */
     101
    180102        uint16_t window;
    181         /** The checksum field is the 16~bit one's complement of the one's complement sum of all 16~bit words in the header and text.
    182          *  If a~segment contains an odd number of header and text octets to be checksummed, the last octet is padded on the right with zeros to form a~16~bit word for checksum purposes.
    183          *  The pad is not transmitted as part of the segment.
    184          *  While computing the checksum, the checksum field itself is replaced with zeros.
    185          *  The checksum also coves a~pseudo header conceptually.
    186          *  The pseudo header conceptually prefixed to the TCP header contains the source address, the destination address, the protocol, and the TCP length.
    187          *  This information gives protection against misrouted datagrams.
    188          *  If the computed checksum is zero, it is transmitted as all ones (the equivalent in one's complement arithmetic).
    189          */
    190103        uint16_t checksum;
    191         /** This field communicates the current value of the urgent pointer as a~positive offset from the sequence number in this segment.
    192          *  The urgent pointer points to the sequence number of the octet following the urgent data.
    193          *  This field is only be interpreted in segments with the URG control bit set.
    194          *  @see tcp_header:urgent
    195          */
    196104        uint16_t urgent_pointer;
    197105} __attribute__ ((packed));
    198106
    199 /** Transmission datagram header option.
    200  */
    201 struct tcp_option{
    202         /** Option type.
    203          */
     107/** Transmission datagram header option. */
     108struct tcp_option {
     109        /** Option type. */
    204110        uint8_t type;
    205         /** Option length.
    206          */
     111        /** Option length. */
    207112        uint8_t length;
    208113};
    209114
    210 /** Maximum segment size TCP option.
    211  */
    212 struct tcp_max_segment_size_option{
     115/** Maximum segment size TCP option. */
     116struct tcp_max_segment_size_option {
    213117        /** TCP option.
    214          *  @see TCPOPT_MAX_SEGMENT_SIZE
    215          *  @see TCPOPT_MAX_SEGMENT_SIZE_LENGTH
     118         * @see TCPOPT_MAX_SEGMENT_SIZE
     119         * @see TCPOPT_MAX_SEGMENT_SIZE_LENGTH
    216120         */
    217121        tcp_option_t option;
    218         /** Maximum segment size in bytes.
    219         */
     122       
     123        /** Maximum segment size in bytes. */
    220124        uint16_t max_segment_size;
    221125} __attribute__ ((packed));
Note: See TracChangeset for help on using the changeset viewer.