Changeset 797b704 in mainline for uspace/lib/net/include/il_skel.h

Timestamp:

2011-01-12T14:40:09Z (14 years ago)

Author:

Martin Decky <martin@…>

Branches:

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

Children:

014dd57b

Parents:

73ac2e9

Message:

streamline internetworking layer

• IPC method renaming

NET_IL_DEVICE → NET_IP_DEVICE
NET_IL_PACKET_SPACE → NET_IP_PACKET_SPACE
NET_IL_SEND → NET_IP_SEND

The original methods were actually not generic methods of the IL layer (used by the lower layers), but specific methods of the IP module
and used by the higher layers. The original naming was rather confusing.

• implelement common IL module skeleton
• small improvements in the comments of the NETIF and NIL skeletons
• IL modules now use a separate receiver function for the NET_IL_* calls

File:

• uspace/lib/net/include/il_skel.h (moved) (moved from uspace/lib/net/include/il_local.h ) (1 diff)

uspace/lib/net/include/il_skel.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libnet 
+/** @addtogroup libnet
  * @{
  */
 
-#ifndef LIBNET_IL_LOCAL_H_
-#define LIBNET_IL_LOCAL_H_
+#ifndef LIBNET_IL_SKEL_H_
+#define LIBNET_IL_SKEL_H_
 
+/** @file
+ * Internetwork layer module skeleton.
+ * The skeleton has to be part of each internetwork layer module.
+ */
+
+#include <async.h>
+#include <fibril_synch.h>
 #include <ipc/ipc.h>
-#include <async.h>
+#include <ipc/services.h>
 
-/** Processes the Internet layer module message.
+#include <adt/measured_strings.h>
+#include <net/device.h>
+#include <net/packet.h>
+
+/** Module initialization.
  *
- * @param[in]           callid The message identifier.
- * @param[in]           call The message parameters.
- * @param[out]          answer The message answer parameters.
- * @param[out]          answer_count The last parameter for the actual answer in
- *                      the answer parameter.
- * @return              EOK on success.
- * @return              Other error codes as defined for the arp_message()
- *                      function.
+ * This has to be implemented in user code.
+ *
+ * @param[in] net_phone Networking module phone.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for each specific module
+ *         initialize function.
+ *
+ */
+extern int il_initialize(int net_phone);
+
+/** Process the Internet layer module message.
+ *
+ * This has to be implemented in user code.
+ *
+ * @param[in]  callid Message identifier.
+ * @param[in]  call   Message parameters.
+ * @param[out] answer Answer.
+ * @param[out] count  Number of arguments of the answer.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for the arp_message()
+ *         function.
+ *
  */
 extern int il_module_message(ipc_callid_t callid, ipc_call_t *call,
     ipc_call_t *answer, size_t *answer_count);
 
-/** Starts the Internet layer module.
- *
- * Initializes the client connection servicing function, initializes the module,
- * registers the module service and starts the async manager, processing IPC
- * messages in an infinite loop.
- *
- * @param[in] client_connection The client connection processing function. The
- *                      module skeleton propagates its own one.
- * @return              EOK on successful module termination.
- * @return              Other error codes as defined for the arp_initialize()
- *                      function.
- * @return              Other error codes as defined for the REGISTER_ME() macro
- *                      function.
- */
-extern int il_module_start(async_client_conn_t client_connection);
+extern int il_module_start(int);
 
 #endif