Changeset 89c57b6 in mainline for uspace/lib/net/include/nil_skel.h

Timestamp:

2011-04-13T14:45:41Z (14 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

88634420

Parents:

cefb126 (diff), 17279ead (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/net/include/nil_skel.h (moved) (moved from uspace/lib/net/include/nil_local.h ) (2 diffs)

uspace/lib/net/include/nil_skel.h

@@ -27 +27 @@
  */
 
-/** @addtogroup net_nil
- *  @{
+/** @addtogroup libnet
+ * @{
  */
 
@@ -36 +36 @@
  */
 
-#ifndef __NET_NIL_LOCAL_H__
-#define __NET_NIL_LOCAL_H__
+#ifndef LIBNET_NIL_SKEL_H_
+#define LIBNET_NIL_SKEL_H_
 
-#include <ipc/ipc.h>
+#include <async.h>
+#include <fibril_synch.h>
+#include <ipc/services.h>
+
+#include <adt/measured_strings.h>
+#include <net/device.h>
+#include <net/packet.h>
 
 /** Module initialization.
  *
- * Is called by the module_start() function.
+ * This has to be implemented in user code.
  *
- * @param[in] net_phone The networking moduel phone.
+ * @param[in] net_phone Networking module phone.
  *
  * @return EOK on success.
- * @return Other error codes as defined for each specific module initialize function.
+ * @return Other error codes as defined for each specific module
+ *         initialize function.
  *
  */
-extern int nil_initialize(int);
+extern int nil_initialize(int net_phone);
 
+/** Notify the network interface layer about the device state change.
+ *
+ * This has to be implemented in user code.
+ *
+ * @param[in] nil_phone Network interface layer phone.
+ * @param[in] device_id Device identifier.
+ * @param[in] state     New device state.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for each specific module
+ *         device state function.
+ *
+ */
 extern int nil_device_state_msg_local(int, device_id_t, int);
-extern int nil_received_msg_local(int, device_id_t, packet_t, services_t);
+
+/** Pass the packet queue to the network interface layer.
+ *
+ * Process and redistribute the received packet queue to the registered
+ * upper layers.
+ *
+ * This has to be implemented in user code.
+ *
+ * @param[in] nil_phone Network interface layer phone.
+ * @param[in] device_id Source device identifier.
+ * @param[in] packet    Received packet or the received packet queue.
+ * @param[in] target    Target service. Ignored parameter.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for each specific module
+ *         received function.
+ *
+ */
+extern int nil_received_msg_local(int, device_id_t, packet_t *, services_t);
 
 /** Message processing function.
  *
- * @param[in]  name         Module name.
- * @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.
+ * This has to be implemented in user code.
+ *
+ * @param[in]  name   Module name.
+ * @param[in]  callid Message identifier.
+ * @param[in]  call   Message parameters.
+ * @param[out] answer Message answer parameters.
+ * @param[out] count  Message answer arguments.
  *
  * @return EOK on success.
  * @return ENOTSUP if the message is not known.
- * @return Other error codes as defined for each specific
- *         module message function.
+ * @return Other error codes as defined for each specific module
+ *         message function.
  *
- * @see nil_interface.h
  * @see IS_NET_NIL_MESSAGE()
  *
  */
-extern int nil_message_standalone(const char *, ipc_callid_t, ipc_call_t *, ipc_call_t *,
-    int *);
+extern int nil_module_message(ipc_callid_t, ipc_call_t *, ipc_call_t *,
+    size_t *);
 
-extern int nil_module_message_standalone(const char *, ipc_callid_t,
-    ipc_call_t *, ipc_call_t *, int *);
-extern int nil_module_start_standalone(async_client_conn_t);
+extern int nil_module_start(int);
 
 #endif