Changeset 14f1db0 in mainline for uspace/lib/net/il/ip_remote.c

Timestamp:

2010-04-09T12:54:57Z (14 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

a1caa3c2

Parents:

24ab58b3

Message:

networking overhaul:

• separation of conserns
• removal of (almost all) overlaping symbols, libnetif is not needed anymore
• again, it is possible to build the networking in multiple architecture configurations (however, currently only the bundling netif and nil layers is supported, more to come)
• code style updates and fixes (still a huge amount of work to do)

File:

• uspace/lib/net/il/ip_remote.c (modified) (5 diffs)

uspace/lib/net/il/ip_remote.c

@@ -33 +33 @@
 /** @file
  *
- * IP interface implementation for standalone remote modules.
+ * IP interface implementation for remote modules.
  *
  * @see ip_interface.h
@@ -50 +50 @@
 #include <il_messages.h>
 #include <ip_messages.h>
-
-int ip_add_route_req(int ip_phone, device_id_t device_id, in_addr_t address,
-    in_addr_t netmask, in_addr_t gateway)
+#include <ip_remote.h>
+
+/** Add a route to the device routing table.
+ *
+ * The target network is routed using this device.
+ *
+ * @param[in] ip_phone  The IP module phone used for (semi)remote calls.
+ * @param[in] device_id The device identifier.
+ * @param[in] address   The target network address.
+ * @param[in] netmask   The target network mask.
+ * @param[in] gateway   The target network gateway. Not used if zero.
+ *
+ */
+int ip_add_route_req_remote(int ip_phone, device_id_t device_id,
+    in_addr_t address, in_addr_t netmask, in_addr_t gateway)
 {
         return (int) async_req_4_0(ip_phone, NET_IP_ADD_ROUTE,
@@ -71 +83 @@
 }
 
-int ip_device_req(int ip_phone, device_id_t device_id, services_t service)
-{
-        return generic_device_req(ip_phone, NET_IL_DEVICE, device_id, 0, service);
-}
-
-int ip_get_route_req(int ip_phone, ip_protocol_t protocol,
+/** Register the new device.
+ *
+ * Register itself as the ip packet receiver.
+ * If the device uses ARP registers also the new ARP device.
+ *
+ * @param[in] ip_phone  The IP module phone used for (semi)remote calls.
+ * @param[in] device_id The new device identifier.
+ * @param[in] netif     The underlying device network interface layer service.
+ *
+ * @return EOK on success.
+ * @return ENOMEM if there is not enough memory left.
+ * @return EINVAL if the device configuration is invalid.
+ * @return ENOTSUP if the device uses IPv6.
+ * @return ENOTSUP if the device uses DHCP.
+ * @return Other error codes as defined for the net_get_device_conf_req()
+ *         function.
+ * @return Other error codes as defined for the arp_device_req() function.
+ *
+ */
+int ip_device_req_remote(int ip_phone, device_id_t device_id,
+    services_t service)
+{
+        return generic_device_req_remote(ip_phone, NET_IL_DEVICE, device_id, 0,
+            service);
+}
+
+/** 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.
+ * @param[in]  protocol    The transport protocol.
+ * @param[in]  destination The destination address.
+ * @param[in]  addrlen     The destination address length.
+ * @param[out] device_id   The device identifier.
+ * @param[out] header      The constructed IP pseudo header.
+ * @param[out] headerlen   The IP pseudo header length.
+ *
+ */
+int ip_get_route_req_remote(int ip_phone, ip_protocol_t protocol,
     const struct sockaddr *destination, socklen_t addrlen,
-    device_id_t *device_id, ip_pseudo_header_ref *header, size_t *headerlen)
+    device_id_t *device_id, void **header, size_t *headerlen)
 {
         if ((!destination) || (addrlen == 0))
@@ -95 +139 @@
             && (async_data_read_start(ip_phone, headerlen, sizeof(*headerlen)) == EOK)
             && (*headerlen > 0)) {
-                *header = (ip_pseudo_header_ref) malloc(*headerlen);
+                *header = malloc(*headerlen);
                 if (*header) {
                         if (async_data_read_start(ip_phone, *header, *headerlen) != EOK)
@@ -113 +157 @@
 }
 
-int ip_packet_size_req(int ip_phone, device_id_t device_id,
+/** Return the device packet dimension for sending.
+ *
+ * @param[in]  ip_phone         The IP module phone used for (semi)remote calls.
+ * @param[in]  device_id        The device identifier.
+ * @param[out] packet_dimension The packet dimension.
+ *
+ * @return EOK on success.
+ * @return ENOENT if there is no such device.
+ * @return Other error codes as defined for the
+ *         generic_packet_size_req_remote() function.
+ *
+ */
+int ip_packet_size_req_remote(int ip_phone, device_id_t device_id,
     packet_dimension_ref packet_dimension)
 {
-        return generic_packet_size_req(ip_phone, NET_IL_PACKET_SPACE, device_id,
+        return generic_packet_size_req_remote(ip_phone, NET_IL_PACKET_SPACE, device_id,
             packet_dimension);
 }
 
-int ip_received_error_msg(int ip_phone, device_id_t device_id,
+/** Notify the IP module about the received error notification packet.
+ *
+ * @param[in] ip_phone  The IP module phone used for (semi)remote calls.
+ * @param[in] device_id The device identifier.
+ * @param[in] packet    The received packet or the received packet queue.
+ * @param[in] target    The target internetwork module service to be
+ *                      delivered to.
+ * @param[in] error     The packet error reporting service. Prefixes the
+ *                      received packet.
+ *
+ * @return EOK on success.
+ *
+ */
+int ip_received_error_msg_remote(int ip_phone, device_id_t device_id,
     packet_t packet, services_t target, services_t error)
 {
-        return generic_received_msg(ip_phone, NET_IP_RECEIVED_ERROR, device_id,
-            packet_get_id(packet), target, error);
-}
-
-int ip_send_msg(int ip_phone, device_id_t device_id, packet_t packet,
+        return generic_received_msg_remote(ip_phone, NET_IP_RECEIVED_ERROR,
+            device_id, packet_get_id(packet), target, error);
+}
+
+/** Send the packet queue.
+ *
+ * The packets may get fragmented if needed.
+ *
+ * @param[in] ip_phone  The IP module phone used for (semi)remote calls.
+ * @param[in] device_id The device identifier.
+ * @param[in] packet    The packet fragments as a packet queue. All the
+ *                      packets have to have the same destination address.
+ * @param[in] sender    The sending module service.
+ * @param[in] error     The packet error reporting service. Prefixes the
+ *                      received packet.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for the generic_send_msg() function.
+ *
+ */
+int ip_send_msg_remote(int ip_phone, device_id_t device_id, packet_t packet,
     services_t sender, services_t error)
 {
-        return generic_send_msg(ip_phone, NET_IL_SEND, device_id,
+        return generic_send_msg_remote(ip_phone, NET_IL_SEND, device_id,
             packet_get_id(packet), sender, error);
 }
 
-int ip_set_gateway_req(int ip_phone, device_id_t device_id, in_addr_t gateway)
+/** Set the default gateway.
+ *
+ * This gateway is used if no other route is found.
+ *
+ * @param[in] ip_phone  The IP module phone used for (semi)remote calls.
+ * @param[in] device_id The device identifier.
+ * @param[in] gateway   The default gateway.
+ *
+ */
+int ip_set_gateway_req_remote(int ip_phone, device_id_t device_id,
+    in_addr_t gateway)
 {
         return (int) async_req_2_0(ip_phone, NET_IP_SET_GATEWAY,