Changeset 614d065 in mainline for uspace/lib/net/generic/net_remote.c

Timestamp:

2010-10-16T14:32:17Z (14 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

9f9c7fd

Parents:

b69ceea

Message:

Cleanup networking module interfaces.

File:

• uspace/lib/net/generic/net_remote.c (modified) (2 diffs)

uspace/lib/net/generic/net_remote.c

@@ -47 +47 @@
 #include <adt/measured_strings.h>
 
-int net_connect_module(services_t service)
+/** Connects to the networking module.
+ *
+ * @returns             The networking module phone on success.
+ */
+int net_connect_module(void)
 {
         return connect_to_service(SERVICE_NETWORKING);
 }
 
+/** Frees the received settings.
+ *
+ * @param[in] settings  The received settings.
+ * @param[in] data      The received settings data.
+ * @see net_get_device_conf_req()
+ * @see net_get_conf_req()
+ */
 void net_free_settings(measured_string_ref settings, char *data)
 {
         if (settings)
                 free(settings);
-
         if (data)
                 free(data);
 }
 
+/** Returns the global configuration.
+ *
+ * The configuration names are read and the appropriate settings are set
+ * instead. Call net_free_settings() function to release the returned
+ * configuration.
+ *
+ * @param[in] net_phone The networking module phone.
+ * @param[in,out] configuration The requested configuration. The names are read
+ * and the appropriate settings are set instead.
+ *
+ * @param[in] count     The configuration entries count.
+ * @param[in,out] data  The configuration and settings data.
+ * @returns             EOK on success.
+ * @returns             EINVAL if the configuration is NULL.
+ * @returns             EINVAL if the count is zero.
+ * @returns             Other error codes as defined for the
+ *                      generic_translate_req() function.
+ */
 int
 net_get_conf_req(int net_phone, measured_string_ref *configuration,
@@ -69 +97 @@
 }
 
+/** Returns the device specific configuration.
+ *
+ * Returns the global configuration if the device specific is not found.
+ * The configuration names are read and the appropriate settings are set
+ * instead. Call net_free_settings() function to release the returned
+ * configuration.
+ *
+ * @param[in] net_phone The networking module phone.
+ * @param[in] device_id The device identifier.
+ * @param[in,out] configuration The requested device configuration. The names
+ *                      are read and the appropriate settings are set instead.
+ * @param[in] count     The configuration entries count.
+ * @param[in,out] data  The configuration and settings data.
+ * @returns             EOK on success.
+ * @returns             EINVAL if the configuration is NULL.
+ * @returns             EINVAL if the count is zero.
+ * @returns             Other error codes as defined for the
+ *                      generic_translate_req() function.
+ */
 int
 net_get_device_conf_req(int net_phone, device_id_t device_id,