Changeset e037e20e in mainline

Timestamp:

2010-10-17T18:48:39Z (14 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

4a3b501

Parents:

c62ae1d6

Message:

Cleanup IP module remote interfaces.

Location:

uspace/lib/net

Files:

• il/ip_remote.c (modified) (6 diffs)
• include/ip_interface.h (modified) (2 diffs)
• include/ip_remote.h (modified) (1 diff)

uspace/lib/net/il/ip_remote.c

@@ -27 +27 @@
  */
 
-/** @addtogroup ip
+/** @addtogroup libnet
  * @{
  */
@@ -72 +72 @@
 }
 
+/** Creates bidirectional connection with the ip module service and registers
+ * the message receiver.
+ *
+ * @param[in] service   The IP module service.
+ * @param[in] protocol  The transport layer protocol.
+ * @param[in] me        The requesting module service.
+ * @param[in] receiver  The message receiver. Used for remote connection.
+ * @returns             The phone of the needed service.
+ * @returns             EOK on success.
+ * @returns             Other error codes as defined for the bind_service()
+ *                      function.
+ */
 int ip_bind_service(services_t service, int protocol, services_t me,
     async_client_conn_t receiver)
@@ -79 +91 @@
 }
 
+/** Connects to the IP module.
+ *
+ * @param service       The IP module service. Ignored parameter.
+ * @returns             The IP module phone on success.
+ */
 int ip_connect_module(services_t service)
 {
@@ -110 +127 @@
 }
 
-/** Return the device identifier and the IP pseudo header based on the destination address.
+/** Return the device identifier and the IP pseudo header based on the
+ * destination address.
  *
  * @param[in]  ip_phone    The IP module phone used for (semi)remote calls.
@@ -137 +155 @@
             (ipcarg_t) protocol, &answer);
         
-        if ((async_data_write_start(ip_phone, destination, addrlen) == EOK)
-            && (async_data_read_start(ip_phone, headerlen, sizeof(*headerlen)) == EOK)
-            && (*headerlen > 0)) {
+        if ((async_data_write_start(ip_phone, destination, addrlen) == EOK) &&
+            (async_data_read_start(ip_phone, headerlen,
+            sizeof(*headerlen)) == EOK) && (*headerlen > 0)) {
                 *header = malloc(*headerlen);
                 if (*header) {
-                        if (async_data_read_start(ip_phone, *header, *headerlen) != EOK)
+                        if (async_data_read_start(ip_phone, *header,
+                            *headerlen) != EOK)
                                 free(*header);
                 }
@@ -173 +192 @@
     packet_dimension_ref packet_dimension)
 {
-        return generic_packet_size_req_remote(ip_phone, NET_IL_PACKET_SPACE, device_id,
-            packet_dimension);
+        return generic_packet_size_req_remote(ip_phone, NET_IL_PACKET_SPACE,
+            device_id, packet_dimension);
 }
 

uspace/lib/net/include/ip_interface.h

@@ -27 +27 @@
  */
 
-/** @addtogroup ip
- *  @{
+/** @addtogroup libnet 
+ * @{
  */
 
-#ifndef __NET_IP_INTERFACE_H__
-#define __NET_IP_INTERFACE_H__
+#ifndef LIBNET_IP_INTERFACE_H_
+#define LIBNET_IP_INTERFACE_H_
 
 #include <net/socket_codes.h>
@@ -55 +55 @@
 
 /** @name IP module interface
- *  This interface is used by other modules.
+ * This interface is used by other modules.
  */
 /*@{*/
 
 /** The transport layer notification function type definition.
- *  Notifies the transport layer modules about the received packet/s.
- *  @param[in] device_id The device identifier.
- *  @param[in] packet The received packet or the received packet queue.
- *  @param[in] receiver The receiving module service.
- *  @param[in] error The packet error reporting service. Prefixes the received packet.
- *  @returns EOK on success.
+ *
+ * Notifies the transport layer modules about the received packet/s.
+ *
+ * @param[in] device_id The device identifier.
+ * @param[in] packet    The received packet or the received packet queue.
+ * @param[in] receiver  The receiving module service.
+ * @param[in] error     The packet error reporting service. Prefixes the
+ *                      received packet.
+ * @returns             EOK on success.
  */
-typedef int     (*tl_received_msg_t)(device_id_t device_id, packet_t packet, services_t receiver, services_t error);
+typedef int (*tl_received_msg_t)(device_id_t device_id, packet_t packet,
+    services_t receiver, services_t error);
 
-/** Creates bidirectional connection with the ip module service and registers the message receiver.
- *  @param[in] service The IP module service.
- *  @param[in] protocol The transport layer protocol.
- *  @param[in] me The requesting module service.
- *  @param[in] receiver The message receiver. Used for remote connection.
- *  @returns The phone of the needed service.
- *  @returns EOK on success.
- *  @returns Other error codes as defined for the bind_service() function.
- */
-extern int ip_bind_service(services_t service, int protocol, services_t me, async_client_conn_t receiver);
-
-/** Connects to the IP module.
- *  @param service The IP module service. Ignored parameter.
- *  @returns The IP module phone on success.
- */
-extern int ip_connect_module(services_t service);
+extern int ip_bind_service(services_t, int, services_t, async_client_conn_t);
+extern int ip_connect_module(services_t);
 
 /*@}*/

uspace/lib/net/include/ip_remote.h

@@ -27 +27 @@
  */
 
-/** @addtogroup ip
+/** @addtogroup libnet
  * @{
  */
 
-#ifndef __NET_IP_REMOTE_H__
-#define __NET_IP_REMOTE_H__
+#ifndef LIBNET_IP_REMOTE_H_
+#define LIBNET_IP_REMOTE_H_
 
 #include <ipc/services.h>