Changeset 4687a26c in mainline for uspace/lib/c/include/net/packet_header.h

Timestamp:

2010-11-02T18:29:01Z (13 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

4f35b9ff

Parents:

76e1121f (diff), 28f4adb (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:

• uspace/lib/c/include/net/packet_header.h (moved) (moved from uspace/lib/socket/include/packet/packet_header.h ) (1 diff)

uspace/lib/c/include/net/packet_header.h

@@ -27 +27 @@
  */
 
-/** @addtogroup packet
+/** @addtogroup libc 
  *  @{
  */
 
 /** @file
- *  Packet header.
+ * Packet header.
  */
 
-#ifndef __NET_PACKET_HEADER_H__
-#define __NET_PACKET_HEADER_H__
+#ifndef LIBC_PACKET_HEADER_H_
+#define LIBC_PACKET_HEADER_H_
 
-#include <packet/packet.h>
+#include <net/packet.h>
 
 /** Returns the actual packet data length.
- *  @param[in] header The packet header.
+ * @param[in] header    The packet header.
  */
-#define PACKET_DATA_LENGTH(header)              ((header)->data_end - (header)->data_start)
+#define PACKET_DATA_LENGTH(header) \
+        ((header)->data_end - (header)->data_start)
 
 /** Returns the maximum packet address length.
- *  @param[in] header The packet header.
+ * @param[in] header    The packet header.
  */
-#define PACKET_MAX_ADDRESS_LENGTH(header)               ((header)->dest_addr - (header)->src_addr)
+#define PACKET_MAX_ADDRESS_LENGTH(header) \
+        ((header)->dest_addr - (header)->src_addr)
 
 /** Returns the minimum packet suffix.
- *  @param[in] header The packet header.
+ *  @param[in] header   The packet header.
  */
-#define PACKET_MIN_SUFFIX(header)               ((header)->length - (header)->data_start - (header)->max_content)
+#define PACKET_MIN_SUFFIX(header) \
+        ((header)->length - (header)->data_start - (header)->max_content)
 
-/** Packet integrity check magic value.
- */
+/** Packet integrity check magic value. */
 #define PACKET_MAGIC_VALUE      0x11227788
 
-/** Packet header.
- */
-struct packet{
-        /** Packet identifier.
-         */
+/** Packet header. */
+struct packet {
+        /** Packet identifier. */
         packet_id_t packet_id;
-        /** Packet queue sorting value.
-         *  The packet queue is sorted the ascending order.
+
+        /**
+         * Packet queue sorting value.
+         * The packet queue is sorted the ascending order.
          */
         size_t order;
-        /** Packet metric.
-         */
+
+        /** Packet metric. */
         size_t metric;
-        /** Previous packet in the queue.
-         */
+        /** Previous packet in the queue. */
         packet_id_t previous;
-        /** Next packet in the queue.
-         */
+        /** Next packet in the queue. */
         packet_id_t next;
-        /** Total length of the packet.
-         *  Contains the header, the addresses and the data of the packet.
-         *  Corresponds to the mapped sharable memory block.
+
+        /**
+         * Total length of the packet.
+         * Contains the header, the addresses and the data of the packet.
+         * Corresponds to the mapped sharable memory block.
          */
         size_t length;
-        /** Stored source and destination addresses length.
-         */
+
+        /** Stored source and destination addresses length. */
         size_t addr_len;
-        /** Souce address offset in bytes from the beginning of the packet header.
+
+        /**
+         * Souce address offset in bytes from the beginning of the packet
+         * header.
          */
         size_t src_addr;
-        /** Destination address offset in bytes from the beginning of the packet header.
+
+        /**
+         * Destination address offset in bytes from the beginning of the packet
+         * header.
          */
         size_t dest_addr;
-        /** Reserved data prefix length in bytes.
-         */
+
+        /** Reserved data prefix length in bytes. */
         size_t max_prefix;
-        /** Reserved content length in bytes.
-         */
+        /** Reserved content length in bytes. */
         size_t max_content;
-        /** Actual data start offset in bytes from the beginning of the packet header.
+
+        /**
+         * Actual data start offset in bytes from the beginning of the packet
+         * header.
          */
         size_t data_start;
-        /** Actual data end offset in bytes from the beginning of the packet header.
+
+        /**
+         * Actual data end offset in bytes from the beginning of the packet
+         * header.
          */
         size_t data_end;
-        /** Integrity check magic value.
-         */
+
+        /** Integrity check magic value. */
         int magic_value;
 };
 
 /** Returns whether the packet is valid.
- *  @param[in] packet The packet to be checked.
- *  @returns true if the packet is not NULL and the magic value is correct.
- *  @returns false otherwise.
+ * @param[in] packet    The packet to be checked.
+ * @returns             True if the packet is not NULL and the magic value is
+ *                      correct.
+ * @returns             False otherwise.
  */
-static inline int packet_is_valid(const packet_t packet){
+static inline int packet_is_valid(const packet_t packet)
+{
         return packet && (packet->magic_value == PACKET_MAGIC_VALUE);
 }