Index: uspace/lib/net/include/netif_interface.h =================================================================== --- uspace/lib/net/include/netif_interface.h (revision 4a3b5011ede16d404bddf14dfb040a5c87b7b1b2) +++ uspace/lib/net/include/netif_interface.h (revision 42a9f27abc46056863f33053b659f04aaccaa036) @@ -27,10 +27,10 @@ */ -/** @addtogroup netif +/** @addtogroup libnet * @{ */ -#ifndef __NET_NETIF_INTERFACE_H__ -#define __NET_NETIF_INTERFACE_H__ +#ifndef LIBNET_NETIF_INTERFACE_H_ +#define LIBNET_NETIF_INTERFACE_H_ #include Index: uspace/lib/net/include/netif_local.h =================================================================== --- uspace/lib/net/include/netif_local.h (revision 4a3b5011ede16d404bddf14dfb040a5c87b7b1b2) +++ uspace/lib/net/include/netif_local.h (revision 42a9f27abc46056863f33053b659f04aaccaa036) @@ -27,5 +27,5 @@ */ -/** @addtogroup netif +/** @addtogroup libnet * @{ */ @@ -36,6 +36,6 @@ */ -#ifndef __NET_NETIF_LOCAL_H__ -#define __NET_NETIF_LOCAL_H__ +#ifndef NET_NETIF_LOCAL_H_ +#define NET_NETIF_LOCAL_H_ #include @@ -43,5 +43,4 @@ #include #include -#include #include @@ -49,7 +48,5 @@ #include -/** Network interface device specific data. - * - */ +/** Network interface device specific data. */ typedef struct { device_id_t device_id; /**< Device identifier. */ @@ -67,7 +64,5 @@ DEVICE_MAP_DECLARE(netif_device_map, netif_device_t); -/** Network interface module skeleton global data. - * - */ +/** Network interface module skeleton global data. */ typedef struct { int net_phone; /**< Networking module phone. */ @@ -81,5 +76,4 @@ * * This function has to be implemented in user code. - * */ extern int netif_initialize(void); @@ -89,13 +83,13 @@ * This has to be implemented in user code. * - * @param[in] device_id The device identifier. - * @param[in] irq The device interrupt number. - * @param[in] io The device input/output address. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device_id The device identifier. + * @param[in] irq The device interrupt number. + * @param[in] io The device input/output address. + * + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_probe_message(device_id_t device_id, int irq, uintptr_t io); @@ -105,14 +99,15 @@ * This has to be implemented in user code. * - * @param[in] device_id The device identifier. - * @param[in] packet The packet queue. - * @param[in] sender The sending module service. - * - * @return EOK on success. - * @return EFORWARD if the device is not active (in the NETIF_ACTIVE state). - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device_id The device identifier. + * @param[in] packet The packet queue. + * @param[in] sender The sending module service. + * + * @return EOK on success. + * @return EFORWARD if the device is not active (in the + * NETIF_ACTIVE state). + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_send_message(device_id_t device_id, packet_t packet, @@ -123,11 +118,11 @@ * This has to be implemented in user code. * - * @param[in] device The device structure. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device The device structure. + * + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_start_message(netif_device_t *device); @@ -137,11 +132,11 @@ * This has to be implemented in user code. * - * @param[in] device The device structure. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device The device structure. + * + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_stop_message(netif_device_t *device); @@ -151,14 +146,14 @@ * This has to be implemented in user code. * - * @param[in] device_id The device identifier. - * @param[out] address The device local hardware address. - * - * @return EOK on success. - * @return EBADMEM if the address parameter is NULL. - * @return ENOENT if there no such device. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device_id The device identifier. + * @param[out] address The device local hardware address. + * + * @return EOK on success. + * @return EBADMEM if the address parameter is NULL. + * @return ENOENT if there no such device. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_get_addr_message(device_id_t device_id, @@ -170,15 +165,14 @@ * skeleton. This has to be implemented in user code. * - * @param[in] callid The message identifier. - * @param[in] call The message parameters. - * @param[out] answer The message answer parameters. + * @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 ENOTSUP if the message is not known. - * @return Other error codes as defined for the specific module message - * implementation. - * + * the answer parameter. + * + * @return EOK on success. + * @return ENOTSUP if the message is not known. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_specific_message(ipc_callid_t callid, ipc_call_t *call, @@ -189,12 +183,12 @@ * This has to be implemented in user code. * - * @param[in] device_id The device identifier. - * @param[out] stats The device usage statistics. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the specific module message - * implementation. - * + * @param[in] device_id The device identifier. + * @param[out] stats The device usage statistics. + * + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the specific module + * message implementation. */ extern int netif_get_device_stats(device_id_t device_id, Index: uspace/lib/net/include/netif_remote.h =================================================================== --- uspace/lib/net/include/netif_remote.h (revision 4a3b5011ede16d404bddf14dfb040a5c87b7b1b2) +++ uspace/lib/net/include/netif_remote.h (revision 42a9f27abc46056863f33053b659f04aaccaa036) @@ -27,14 +27,17 @@ */ -/** @addtogroup netif +/** @addtogroup libnet * @{ */ -#ifndef __NET_NETIF_REMOTE_H__ -#define __NET_NETIF_REMOTE_H__ +#ifndef LIBNET_NETIF_REMOTE_H_ +#define LIBNET_NETIF_REMOTE_H_ +#include #include #include + #include +#include extern int netif_get_addr_req_remote(int, device_id_t, measured_string_ref *, Index: uspace/lib/net/netif/netif_local.c =================================================================== --- uspace/lib/net/netif/netif_local.c (revision 4a3b5011ede16d404bddf14dfb040a5c87b7b1b2) +++ uspace/lib/net/netif/netif_local.c (revision 42a9f27abc46056863f33053b659f04aaccaa036) @@ -27,5 +27,5 @@ */ -/** @addtogroup netif +/** @addtogroup libnet * @{ */ @@ -58,6 +58,5 @@ DEVICE_MAP_IMPLEMENT(netif_device_map, netif_device_t); -/** Network interface global data. - */ +/** Network interface global data. */ netif_globals_t netif_globals; @@ -65,13 +64,13 @@ * * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * @param[in] irq The device interrupt number. - * @param[in] io The device input/output address. - * - * @return EOK on success. - * @return Other errro codes as defined for the netif_probe_message(). - * - */ -int netif_probe_req_local(int netif_phone, device_id_t device_id, int irq, int io) + * @param[in] device_id The device identifier. + * @param[in] irq The device interrupt number. + * @param[in] io The device input/output address. + * @return EOK on success. + * @return Other error codes as defined for the + * netif_probe_message(). + */ +int +netif_probe_req_local(int netif_phone, device_id_t device_id, int irq, int io) { fibril_rwlock_write_lock(&netif_globals.lock); @@ -85,11 +84,10 @@ * * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * @param[in] packet The packet queue. - * @param[in] sender The sending module service. - * - * @return EOK on success. - * @return Other error codes as defined for the generic_send_msg() function. - * + * @param[in] device_id The device identifier. + * @param[in] packet The packet queue. + * @param[in] sender The sending module service. + * @return EOK on success. + * @return Other error codes as defined for the generic_send_msg() + * function. */ int netif_send_msg_local(int netif_phone, device_id_t device_id, @@ -106,10 +104,10 @@ * * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the netif_start_message() function. - * + * @param[in] device_id The device identifier. + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the + * netif_start_message() function. */ int netif_start_req_local(int netif_phone, device_id_t device_id) @@ -141,10 +139,10 @@ * * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * - * @return EOK on success. - * @return Other error codes as defined for the find_device() function. - * @return Other error codes as defined for the netif_stop_message() function. - * + * @param[in] device_id The device identifier. + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the + * netif_stop_message() function. */ int netif_stop_req_local(int netif_phone, device_id_t device_id) @@ -175,10 +173,8 @@ /** Return the device usage statistics. * - * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * @param[out] stats The device usage statistics. - * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[out] stats The device usage statistics. * @return EOK on success. - * */ int netif_stats_req_local(int netif_phone, device_id_t device_id, @@ -194,15 +190,13 @@ /** Return the device local hardware address. * - * @param[in] netif_phone The network interface phone. - * @param[in] device_id The device identifier. - * @param[out] address The device local hardware address. - * @param[out] data The address data. - * - * @return EOK on success. - * @return EBADMEM if the address parameter is NULL. - * @return ENOENT if there no such device. - * @return Other error codes as defined for the netif_get_addr_message() - * function. - * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[out] address The device local hardware address. + * @param[out] data The address data. + * @return EOK on success. + * @return EBADMEM if the address parameter is NULL. + * @return ENOENT if there no such device. + * @return Other error codes as defined for the + * netif_get_addr_message() function. */ int netif_get_addr_req_local(int netif_phone, device_id_t device_id, @@ -211,5 +205,5 @@ ERROR_DECLARE; - if ((!address) || (!data)) + if (!address || !data) return EBADMEM; @@ -231,11 +225,9 @@ /** Find the device specific data. * - * @param[in] device_id The device identifier. - * @param[out] device The device specific data. - * - * @return EOK on success. - * @return ENOENT if device is not found. - * @return EPERM if the device is not initialized. - * + * @param[in] device_id The device identifier. + * @param[out] device The device specific data. + * @return EOK on success. + * @return ENOENT if device is not found. + * @return EPERM if the device is not initialized. */ int find_device(device_id_t device_id, netif_device_t **device) @@ -256,6 +248,5 @@ /** Clear the usage statistics. * - * @param[in] stats The usage statistics. - * + * @param[in] stats The usage statistics. */ void null_device_stats(device_stats_ref stats) @@ -266,11 +257,8 @@ /** Initialize the netif module. * - * @param[in] client_connection The client connection functio to be - * registered. - * - * @return EOK on success. - * @return Other error codes as defined for each specific module - * message function. - * + * @param[in] client_connection The client connection functio to be registered. + * @return EOK on success. + * @return Other error codes as defined for each specific module + * message function. */ int netif_init_module(async_client_conn_t client_connection) @@ -298,6 +286,5 @@ * Prepared for future optimization. * - * @param[in] packet_id The packet identifier. - * + * @param[in] packet_id The packet identifier. */ void netif_pq_release(packet_id_t packet_id) @@ -308,8 +295,7 @@ /** Allocate new packet to handle the given content size. * - * @param[in] content The minimum content size. - * - * @return The allocated packet. - * @return NULL if there is an error. + * @param[in] content The minimum content size. + * @return The allocated packet. + * @return NULL if there is an error. * */ @@ -319,14 +305,13 @@ } -/** Register the device notification receiver, the network interface layer module. - * - * @param[in] name Module name. - * @param[in] device_id The device identifier. - * @param[in] phone The network interface layer module phone. - * - * @return EOK on success. - * @return ENOENT if there is no such device. - * @return ELIMIT if there is another module registered. - * +/** Register the device notification receiver, the network interface layer + * module. + * + * @param[in] name Module name. + * @param[in] device_id The device identifier. + * @param[in] phone The network interface layer module phone. + * @return EOK on success. + * @return ENOENT if there is no such device. + * @return ELIMIT if there is another module registered. */ static int register_message(const char *name, device_id_t device_id, int phone) @@ -347,14 +332,14 @@ /** Process the netif module messages. * - * @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. - * - * @return EOK on success. - * @return ENOTSUP if the message is not known. - * @return Other error codes as defined for each specific module message 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. + * @return EOK on success. + * @return ENOTSUP if the message is not known. + * @return Other error codes as defined for each specific module + * message function. * * @see IS_NET_NETIF_MESSAGE() @@ -373,45 +358,58 @@ *answer_count = 0; switch (IPC_GET_METHOD(*call)) { - case IPC_M_PHONE_HUNGUP: - return EOK; - case NET_NETIF_PROBE: - return netif_probe_req_local(0, IPC_GET_DEVICE(call), - NETIF_GET_IRQ(call), NETIF_GET_IO(call)); - case IPC_M_CONNECT_TO_ME: - fibril_rwlock_write_lock(&netif_globals.lock); - ERROR_CODE = register_message(name, IPC_GET_DEVICE(call), - IPC_GET_PHONE(call)); - fibril_rwlock_write_unlock(&netif_globals.lock); - return ERROR_CODE; - case NET_NETIF_SEND: - ERROR_PROPAGATE(packet_translate_remote(netif_globals.net_phone, - &packet, IPC_GET_PACKET(call))); - return netif_send_msg_local(0, IPC_GET_DEVICE(call), packet, - IPC_GET_SENDER(call)); - case NET_NETIF_START: - return netif_start_req_local(0, IPC_GET_DEVICE(call)); - case NET_NETIF_STATS: - fibril_rwlock_read_lock(&netif_globals.lock); - if (!ERROR_OCCURRED(async_data_read_receive(&callid, &length))) { - if (length < sizeof(device_stats_t)) - ERROR_CODE = EOVERFLOW; - else { - if (!ERROR_OCCURRED(netif_get_device_stats( - IPC_GET_DEVICE(call), &stats))) - ERROR_CODE = async_data_read_finalize(callid, &stats, - sizeof(device_stats_t)); - } - } + case IPC_M_PHONE_HUNGUP: + return EOK; + + case NET_NETIF_PROBE: + return netif_probe_req_local(0, IPC_GET_DEVICE(call), + NETIF_GET_IRQ(call), NETIF_GET_IO(call)); + + case IPC_M_CONNECT_TO_ME: + fibril_rwlock_write_lock(&netif_globals.lock); + ERROR_CODE = register_message(name, IPC_GET_DEVICE(call), + IPC_GET_PHONE(call)); + fibril_rwlock_write_unlock(&netif_globals.lock); + return ERROR_CODE; + + case NET_NETIF_SEND: + ERROR_PROPAGATE(packet_translate_remote(netif_globals.net_phone, + &packet, IPC_GET_PACKET(call))); + return netif_send_msg_local(0, IPC_GET_DEVICE(call), packet, + IPC_GET_SENDER(call)); + + case NET_NETIF_START: + return netif_start_req_local(0, IPC_GET_DEVICE(call)); + + case NET_NETIF_STATS: + fibril_rwlock_read_lock(&netif_globals.lock); + + if (ERROR_OCCURRED(async_data_read_receive(&callid, &length))) { fibril_rwlock_read_unlock(&netif_globals.lock); return ERROR_CODE; - case NET_NETIF_STOP: - return netif_stop_req_local(0, IPC_GET_DEVICE(call)); - case NET_NETIF_GET_ADDR: - fibril_rwlock_read_lock(&netif_globals.lock); - if (!ERROR_OCCURRED(netif_get_addr_message(IPC_GET_DEVICE(call), - &address))) - ERROR_CODE = measured_strings_reply(&address, 1); + } + if (length < sizeof(device_stats_t)) { fibril_rwlock_read_unlock(&netif_globals.lock); - return ERROR_CODE; + return EOVERFLOW; + } + + if (ERROR_NONE(netif_get_device_stats(IPC_GET_DEVICE(call), + &stats))) { + ERROR_CODE = async_data_read_finalize(callid, &stats, + sizeof(device_stats_t)); + } + + fibril_rwlock_read_unlock(&netif_globals.lock); + return ERROR_CODE; + + case NET_NETIF_STOP: + return netif_stop_req_local(0, IPC_GET_DEVICE(call)); + + case NET_NETIF_GET_ADDR: + fibril_rwlock_read_lock(&netif_globals.lock); + if (ERROR_NONE(netif_get_addr_message(IPC_GET_DEVICE(call), + &address))) + ERROR_CODE = measured_strings_reply(&address, 1); + fibril_rwlock_read_unlock(&netif_globals.lock); + return ERROR_CODE; } @@ -421,16 +419,13 @@ /** Start the network interface module. * - * Initialize the client connection serving function, initialize - * the module, registers the module service and start 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 success. - * @return Other error codes as defined for each specific module message - * function. - * + * Initialize the client connection serving function, initialize the module, + * registers the module service and start 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 success. + * @return Other error codes as defined for each specific module + * message function. */ int netif_module_start_standalone(async_client_conn_t client_connection) Index: uspace/lib/net/netif/netif_remote.c =================================================================== --- uspace/lib/net/netif/netif_remote.c (revision 4a3b5011ede16d404bddf14dfb040a5c87b7b1b2) +++ uspace/lib/net/netif/netif_remote.c (revision 42a9f27abc46056863f33053b659f04aaccaa036) @@ -27,5 +27,5 @@ */ -/** @addtogroup netif +/** @addtogroup libnet * @{ */ @@ -35,4 +35,8 @@ */ +#include +#include +#include + #include #include @@ -41,9 +45,18 @@ #include #include -#include #include -#include -#include +/** Return the device local hardware address. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[out] address The device local hardware address. + * @param[out] data The address data. + * @return EOK on success. + * @return EBADMEM if the address parameter is NULL. + * @return ENOENT if there no such device. + * @return Other error codes as defined for the + * netif_get_addr_message() function. + */ int netif_get_addr_req_remote(int netif_phone, device_id_t device_id, measured_string_ref *address, char **data) @@ -53,10 +66,32 @@ } -int netif_probe_req_remote(int netif_phone, device_id_t device_id, int irq, int io) +/** Probe the existence of the device. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[in] irq The device interrupt number. + * @param[in] io The device input/output address. + * @return EOK on success. + * @return Other error codes as defined for the + * netif_probe_message(). + */ +int +netif_probe_req_remote(int netif_phone, device_id_t device_id, int irq, int io) { return async_req_3_0(netif_phone, NET_NETIF_PROBE, device_id, irq, io); } -int netif_send_msg_remote(int netif_phone, device_id_t device_id, packet_t packet, +/** Send the packet queue. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[in] packet The packet queue. + * @param[in] sender The sending module service. + * @return EOK on success. + * @return Other error codes as defined for the generic_send_msg() + * function. + */ +int +netif_send_msg_remote(int netif_phone, device_id_t device_id, packet_t packet, services_t sender) { @@ -65,4 +100,14 @@ } +/** Start the device. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the + * netif_start_message() function. + */ int netif_start_req_remote(int netif_phone, device_id_t device_id) { @@ -70,4 +115,14 @@ } +/** Stop the device. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @return EOK on success. + * @return Other error codes as defined for the find_device() + * function. + * @return Other error codes as defined for the + * netif_stop_message() function. + */ int netif_stop_req_remote(int netif_phone, device_id_t device_id) { @@ -75,4 +130,11 @@ } +/** Return the device usage statistics. + * + * @param[in] netif_phone The network interface phone. + * @param[in] device_id The device identifier. + * @param[out] stats The device usage statistics. + * @return EOK on success. + */ int netif_stats_req_remote(int netif_phone, device_id_t device_id, device_stats_ref stats) @@ -99,11 +161,12 @@ * @param[in] receiver The message receiver. * - * @return The phone of the needed service. - * @return EOK on success. - * @return Other error codes as defined for the bind_service() function. - * + * @return The phone of the needed service. + * @return EOK on success. + * @return Other error codes as defined for the bind_service() + * function. */ -int netif_bind_service_remote(services_t service, device_id_t device_id, services_t me, - async_client_conn_t receiver) +int +netif_bind_service_remote(services_t service, device_id_t device_id, + services_t me, async_client_conn_t receiver) { return bind_service(service, device_id, me, 0, receiver);