source: mainline/uspace/srv/net/tl/tcp/tcp_header.h@ 0578271

/*
 * Copyright (c) 2009 Lukas Mejdrech
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup tcp
 * @{
 */

/** @file
 * TCP header definition.
 * Based on the RFC 793.
 */

#ifndef NET_TCP_HEADER_H_
#define NET_TCP_HEADER_H_

#include <sys/types.h>

/** TCP header size in bytes. */
#define TCP_HEADER_SIZE                         sizeof(tcp_header_t)

/** Returns the actual TCP header length in bytes.
 * @param[in] header The TCP packet header.
 */
#define TCP_HEADER_LENGTH(header)               ((header)->header_length * 4U)

/** Returns the TCP header length.
 * @param[in] length The TCP header length in bytes.
 */
#define TCP_COMPUTE_HEADER_LENGTH(length)       ((uint8_t) ((length) / 4U))

/** Type definition of the transmission datagram header.
 * @see tcp_header
 */
typedef struct tcp_header tcp_header_t;

/** Type definition of the transmission datagram header pointer.
 * @see tcp_header
 */
typedef tcp_header_t *tcp_header_ref;

/** Type definition of the transmission datagram header option.
 * @see tcp_option
 */
typedef struct tcp_option tcp_option_t;

/** Type definition of the transmission datagram header option pointer.
 * @see tcp_option
 */
typedef tcp_option_t *tcp_option_ref;

/** Type definition of the Maximum segment size TCP option. */
typedef struct tcp_max_segment_size_option tcp_max_segment_size_option_t;

/** Type definition of the Maximum segment size TCP option pointer.
 * @see tcp_max_segment_size_option
 */
typedef tcp_max_segment_size_option_t *tcp_max_segment_size_option_ref;

/** Transmission datagram header. */
struct tcp_header {
        uint16_t source_port;
        uint16_t destination_port;
        uint32_t sequence_number;
        uint32_t acknowledgement_number;
        
#ifdef ARCH_IS_BIG_ENDIAN
        uint8_t header_length:4;
        uint8_t reserved1:4;
#else
        uint8_t reserved1:4;
        uint8_t header_length:4;
#endif

#ifdef ARCH_IS_BIG_ENDIAN
        uint8_t reserved2:2;
        uint8_t urgent:1;
        uint8_t acknowledge:1;
        uint8_t push:1;
        uint8_t reset:1;
        uint8_t synchronize:1;
        uint8_t finalize:1;
#else
        uint8_t finalize:1;
        uint8_t synchronize:1;
        uint8_t reset:1;
        uint8_t push:1;
        uint8_t acknowledge:1;
        uint8_t urgent:1;
        uint8_t reserved2:2;
#endif

        uint16_t window;
        uint16_t checksum;
        uint16_t urgent_pointer;
} __attribute__ ((packed));

/** Transmission datagram header option. */
struct tcp_option {
        /** Option type. */
        uint8_t type;
        /** Option length. */
        uint8_t length;
};

/** Maximum segment size TCP option. */
struct tcp_max_segment_size_option {
        /** TCP option.
         * @see TCPOPT_MAX_SEGMENT_SIZE
         * @see TCPOPT_MAX_SEGMENT_SIZE_LENGTH
         */
        tcp_option_t option;
        
        /** Maximum segment size in bytes. */
        uint16_t max_segment_size;
} __attribute__ ((packed));

#endif

/** @}
 */