Changes in uspace/lib/net/generic/packet_remote.c [514ee46:b69ceea] in mainline

File:

• uspace/lib/net/generic/packet_remote.c (modified) (5 diffs)

uspace/lib/net/generic/packet_remote.c

@@ -27 +27 @@
  */
 
-/** @addtogroup packet
- *  @{
+/** @addtogroup libnet
+ * @{
  */
 
 /** @file
- *  Packet client interface implementation for remote modules.
- *  @see packet_client.h
+ * Packet client interface implementation for remote modules.
+ * @see packet_client.h
  */
 
@@ -86 +86 @@
 }
 
+/** Translates the packet identifier to the packet reference.
+ *
+ * Tries to find mapping first.
+ * Contacts the packet server to share the packet if the mapping is not present.
+ *
+ * @param[in] phone     The packet server module phone.
+ * @param[out] packet   The packet reference.
+ * @param[in] packet_id The packet identifier.
+ * @returns             EOK on success.
+ * @returns             EINVAL if the packet parameter is NULL.
+ * @returns             Other error codes as defined for the NET_PACKET_GET_SIZE
+ *                      message.
+ * @returns             Other error codes as defined for the packet_return()
+ *                      function.
+ */
 int packet_translate_remote(int phone, packet_ref packet, packet_id_t packet_id)
 {
@@ -110 +125 @@
 }
 
+/** Obtains the packet of the given dimensions.
+ *
+ * Contacts the packet server to return the appropriate packet.
+ *
+ * @param[in] phone     The packet server module phone.
+ * @param[in] addr_len  The source and destination addresses maximal length in
+ *                      bytes.
+ * @param[in] max_prefix The maximal prefix length in bytes.
+ * @param[in] max_content The maximal content length in bytes.
+ * @param[in] max_suffix The maximal suffix length in bytes.
+ * @returns             The packet reference.
+ * @returns             NULL on error.
+ */
 packet_t packet_get_4_remote(int phone, size_t max_content, size_t addr_len,
     size_t max_prefix, size_t max_suffix)
@@ -133 +161 @@
 }
 
+/** Obtains the packet of the given content size.
+ *
+ * Contacts the packet server to return the appropriate packet.
+ *
+ * @param[in] phone     The packet server module phone.
+ * @param[in] content   The maximal content length in bytes.
+ * @returns             The packet reference.
+ * @returns             NULL on error.
+ */
 packet_t packet_get_1_remote(int phone, size_t content)
 {
@@ -154 +191 @@
 }
 
+/** Releases the packet queue.
+ *
+ * All packets in the queue are marked as free for use.
+ * The packet queue may be one packet only.
+ * The module should not use the packets after this point until they are
+ * received or obtained again.
+ *
+ * @param[in] phone     The packet server module phone.
+ * @param[in] packet_id The packet identifier.
+ */
 void pq_release_remote(int phone, packet_id_t packet_id)
 {