61,12 → 61,12 |
/*@{*/ |
|
/** Returns the device local hardware address. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param address The device local hardware address. Output parameter. |
* @param data The address data. Output parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The device identifier. |
* @param[out] address The device local hardware address. |
* @param[out] data The address data. |
* @returns EOK on success. |
* @returns EBADMEM if the address parameter is NULL. |
* @returns EBADMEM if the address parameter and/or the data parameter is NULL. |
* @returns ENOENT if there no such device. |
* @returns Other error codes as defined for the generic_get_addr_req() function. |
*/ |
74,10 → 74,10 |
generic_get_addr_req( nil_phone, NET_NIL_ADDR, device_id, address, data ) |
|
/** Returns the device broadcast hardware address. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param address The device broadcast hardware address. Output parameter. |
* @param data The address data. Output parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The device identifier. |
* @param[out] address The device broadcast hardware address. |
* @param[out] data The address data. |
* @returns EOK on success. |
* @returns EBADMEM if the address parameter is NULL. |
* @returns ENOENT if there no such device. |
87,10 → 87,10 |
generic_get_addr_req( nil_phone, NET_NIL_BROADCAST_ADDR, device_id, address, data ) |
|
/** Sends the packet queue. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param packet The packet queue. Input parameter. |
* @param sender The sending module service. Input parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The device identifier. |
* @param[in] packet The packet queue. |
* @param[in] sender The sending module service. |
* @returns EOK on success. |
* @returns Other error codes as defined for the generic_send_msg() function. |
*/ |
98,12 → 98,12 |
generic_send_msg( nil_phone, NET_NIL_SEND, device_id, packet_get_id( packet ), sender, 0 ) |
|
/** Returns the device packet dimensions for sending. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param addr_len The minimum reserved address length. Output parameter. |
* @param prefix The minimum reserved prefix size. Output parameter. |
* @param content The maximum content size. Output parameter. |
* @param suffix The minimum reserved suffix size. Output parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The device identifier. |
* @param[out] addr_len The minimum reserved address length. |
* @param[out] prefix The minimum reserved prefix size. |
* @param[out] content The maximum content size. |
* @param[out] suffix The minimum reserved suffix size. |
* @returns EOK on success. |
* @returns EBADMEM if either one of the parameters is NULL. |
* @returns ENOENT if there is no such device. |
113,10 → 113,10 |
generic_packet_size_req( nil_phone, NET_NIL_PACKET_SPACE, device_id, addr_len, prefix, content, suffix ) |
|
/** Registers new device or updates the MTU of an existing one. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The new device identifier. Input parameter. |
* @param mtu The device maximum transmission unit. Input parameter. |
* @param netif_service The device driver service. Input parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The new device identifier. |
* @param[in] mtu The device maximum transmission unit. |
* @param[in] netif_service The device driver service. |
* @returns EOK on success. |
* @returns EEXIST if the device with the different service exists. |
* @returns ENOMEM if there is not enough memory left. |
126,9 → 126,9 |
generic_device_req( nil_phone, NET_NIL_DEVICE, device_id, mtu, netif_service ) |
|
/** Notifies the network interface layer about the device state change. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param state The new device state. Input parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The device identifier. |
* @param[in] state The new device state. |
* @returns EOK on success. |
* @returns Other error codes as defined for each specific module device state function. |
*/ |
136,9 → 136,9 |
|
/** Passes the packet queue to the network interface layer. |
* Processes and redistributes the received packet queue to the registered upper layers. |
* @param nil_phone The network interface layer phone. Input parameter. |
* @param device_id The source device identifier. Input parameter. |
* @param packet The received packet or the received packet queue. Input parameter. |
* @param[in] nil_phone The network interface layer phone. |
* @param[in] device_id The source device identifier. |
* @param[in] packet The received packet or the received packet queue. |
* @param target The target service. Ignored parameter. |
* @returns EOK on success. |
* @returns Other error codes as defined for each specific module received function. |
146,10 → 146,10 |
int nil_received_msg( int nil_phone, device_id_t device_id, packet_t packet, services_t target ); |
|
/** Creates bidirectional connection with the network interface layer module and registers the message receiver. |
* @param service The network interface layer module service. Input parameter. |
* @param device_id The device identifier. Input parameter. |
* @param me The requesting module service. Input parameter. |
* @param receiver The message receiver. Input parameter. |
* @param[in] service The network interface layer module service. |
* @param[in] device_id The device identifier. |
* @param[in] me The requesting module service. |
* @param[in] receiver The message receiver. |
* @returns The phone of the needed service. |
* @returns EOK on success. |
* @returns Other error codes as defined for the bind_service() function. |