| 31,6 → 31,10 |
|---|
| */ |
| |
| /** @file |
| * ARP module interface. |
| * The same interface is used for standalone remote modules as well as for bundle modules. |
| * The standalone remote modules have to be compiled with the arp_remote.c source file. |
| * The bundle modules with the arp.c source file. |
| */ |
| |
| #ifndef __NET_ARP_INTERFACE_H__ |
| 40,11 → 44,65 |
|---|
| |
| #include "device.h" |
| |
| /** Registers the new device and the requesting protocol service. |
| * Determines the device broadcast address, its address lengths and packet size. |
| * @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter. |
| * @param device_id The new device identifier. Input parameter. |
| * @param protocol The requesting protocol service. Input parameter. |
| * @param netif The underlying device network interface layer service. Input parameter. |
| * @param address The local requesting protocol address of the device. Input parameter. |
| * @returns EOK on success. |
| * @returns EEXIST if the device is already used. |
| * @returns ENOMEM if there is not enough memory left. |
| * @returns ENOENT if the network interface service is not known. |
| * @returns EREFUSED if the network interface service is not responding. |
| * @returns Other error codes as defined for the nil_packet_get_size() function. |
| * @returns Other error codes as defined for the nil_get_addr() function. |
| * @returns Other error codes as defined for the nil_get_broadcast_addr() function. |
| */ |
| int arp_device_req( int arp_phone, device_id_t device_id, services_t protocol, services_t netif, measured_string_ref address ); |
| |
| /** Translates the given protocol address to the network interface address. |
| * Broadcasts the ARP request if the mapping is not found. |
| * @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter. |
| * @param device_id The device identifier. Input parameter. |
| * @param protocol The requesting protocol service. Input parameter. |
| * @param address The local requesting protocol address. Input parameter. |
| * @param translation The translation of the local protocol address. Output parameter. |
| * @param data The raw translation data container. Output parameter. |
| * @returns EOK on success. |
| * @returns EINVAL if the configuration parameter is NULL. |
| * @returns EINVAL if the count parameter is zero (0). |
| * @returns EBADMEM if the translation or the data parameters are NULL. |
| * @returns ENOENT if the mapping is not found. |
| */ |
| int arp_translate_req( int arp_phone, device_id_t device_id, services_t protocol, measured_string_ref address, measured_string_ref * translation, char ** data ); |
| |
| /** Clears the device cache. |
| * @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter. |
| * @param device_id The device identifier. Input parameter. |
| * @returns EOK on success. |
| * @returns ENOENT if the device is not found. |
| */ |
| int arp_clear_device_req( int arp_phone, device_id_t device_id ); |
| |
| /** Cleans the cache. |
| * @param arp_phone The ARP module phone used for (semi)remote calls. Input parameter. |
| * @returns EOK on success. |
| */ |
| int arp_clean_cache_req( int arp_phone ); |
| |
| /** Connects to the ARP module. |
| * @param service The ARP module service. Ignored parameter. |
| * @returns The ARP module phone on success. |
| * @returns 0 if called by the bundle module. |
| */ |
| int arp_connect_module( services_t service ); |
| |
| /** Returns the ARP task identifier. |
| * @returns The current task identifier if called by the bundle module. |
| * @returns 0 if called by the remote module. |
| */ |
| int arp_task_get_id( void ); |
| |
| #endif |