Subversion Repositories HelenOS

Compare Revisions

Ignore whitespace Rev 4755 → Rev 4756

/branches/network/uspace/srv/net/net/net.c
76,7 → 76,7
 
/** Starts the networking module.
* Initializes the client connection serving function, initializes the module, registers the module service and starts the async manager, processing IPC messages in an infinite loop.
* @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
* @param[in] client_connection The client connection processing function. The module skeleton propagates its own one.
* @returns EOK on successful module termination.
* @returns Other error codes as defined for the net_initialize() function.
* @returns Other error codes as defined for the REGISTER_ME() macro function.
94,7 → 94,7
/** Starts the network interface according to its configuration.
* Registers the network interface with the subsystem modules.
* Starts the needed subsystem modules.
* @param netif The network interface specific data.
* @param[in] netif The network interface specific data.
* @returns EOK on success.
* @returns EINVAL if there are some settings missing.
* @returns ENOENT if the internet protocol module is not known.
122,16 → 122,16
 
/** Returns the configured values.
* The network interface configuration is searched first.
* @param netif_conf The network interface configuration setting. Input parameter.
* @param configuration The found configured values. Output parameter.
* @param count The desired settings count. Input parameter.
* @param data The found configuration settings data. Output parameter.
* @param[in] netif_conf The network interface configuration setting.
* @param[out] configuration The found configured values.
* @param[in] count The desired settings count.
* @param[out] data The found configuration settings data.
* @returns EOK.
*/
int net_get_conf( measured_strings_ref netif_conf, measured_string_ref configuration, size_t count, char ** data );
 
/** Initializes the networking module.
* @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
* @param[in] client_connection The client connection processing function. The module skeleton propagates its own one.
* @returns EOK on success.
* @returns ENOMEM if there is not enough memory left.
*/
138,8 → 138,8
int net_initialize( async_client_conn_t client_connection );
 
/** Reads the network interface specific configuration.
* @param name The network interface name. Input parameter.
* @param netif The network interface structure. Input/output parameter.
* @param[in] name The network interface name.
* @param[in,out] netif The network interface structure.
* @returns EOK on success.
* @returns Other error codes as defined for the add_configuration() function.
*/
/branches/network/uspace/srv/net/net/net.h
195,9 → 195,9
};
 
/** Adds the configured setting to the configuration map.
* @param configuration The configuration map. Input parameter.
* @param name The setting name. Input parameter.
* @param value The setting value. Input parameter.
* @param[in] configuration The configuration map.
* @param[in] name The setting name.
* @param[in] value The setting value.
* @returns EOK on success.
* @returns ENOMEM if there is not enough memory left.
*/
204,10 → 204,10
int add_configuration( measured_strings_ref configuration, const char * name, const char * value );
 
/** Processes the networking message.
* @param callid The message identifier. Input parameter.
* @param call The message parameters. Input parameter.
* @param answer The message answer parameters. Output parameter.
* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
* @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.
* @returns EOK on success.
* @returns ENOTSUP if the message is not known.
* @see net_interface.h
216,7 → 216,7
int net_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Initializes the networking module for the chosen subsystem build type.
* @param client_connection The client connection processing function. The module skeleton propagates its own one. Input parameter.
* @param[in] client_connection The client connection processing function. The module skeleton propagates its own one.
* @returns EOK on success.
* @returns ENOMEM if there is not enough memory left.
*/
224,10 → 224,10
 
/** Processes the module message.
* Distributes the message to the right bundled module.
* @param callid The message identifier. Input parameter.
* @param call The message parameters. Input parameter.
* @param answer The message answer parameters. Output parameter.
* @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
* @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.
* @returns EOK on success.
* @returns ENOTSUP if the message is not known.
* @returns Other error codes as defined for each bundled module message function.
235,8 → 235,8
int module_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 
/** Reads the network interface specific configuration for the chosen subsystem build type.
* @param name The network interface name. Input parameter.
* @param netif The network interface structure. Input/output parameter.
* @param[in] name The network interface name.
* @param[in,out] netif The network interface structure.
* @returns EOK on success.
* @returns Other error codes as defined for the add_configuration() function.
*/
/branches/network/uspace/srv/net/net/start/netstart.c
54,8 → 54,8
#define NAME "Networking startup"
 
/** Module entry point.
* @param argc The number of command line parameters. Input parameter.
* @param argv The command line parameters. Input parameter.
* @param[in] argc The number of command line parameters.
* @param[in] argv The command line parameters.
* @returns EOK on success.
* @returns EINVAL if the net module cannot be started.
* @returns Other error codes as defined for the self_test() function.
64,7 → 64,7
int main( int argc, char * argv[] );
 
/** Starts the module.
* @param fname The module absolute name. Input parameter.
* @param[in] fname The module absolute name.
* @returns The started module task identifier.
* @returns Other error codes as defined for the task_spawn() function.
*/