Subversion Repositories HelenOS

Rev

Rev 4307 | Rev 4703 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4307 Rev 4350
Line 28... Line 28...
28 
 
 28 
 
29 
/** @addtogroup netif
 29 
/** @addtogroup netif
30 
 *  @{
 30 
 *  @{
31 
 */
 31 
 */
32 
 
 32 
 
33 
/**
 - 
 
34 
 * @file
 33 
/** @file
- 
 
 34 
 *  Network interface module interface.
- 
 
 35 
 *  The same interface is used for standalone remote modules as well as for bundle network interface layer modules.
- 
 
 36 
 *  The standalone remote modules have to be compiled with the netif_remote.c source file.
- 
 
 37 
 *  The bundle network interface layer modules are compiled with the netif_nil_bundle.c source file and the choosen network interface layer implementation source file.
35 
 */
 38 
 */
36 
 
 39 
 
37 
#ifndef __NET_NETIF_INTERFACE_H__
 40 
#ifndef __NET_NETIF_INTERFACE_H__
38 
#define __NET_NETIF_INTERFACE_H__
 41 
#define __NET_NETIF_INTERFACE_H__
39 
 
 42 
 
Line 44... Line 47...
44 
#include "../structures/measured_strings.h"
 47 
#include "../structures/measured_strings.h"
45 
#include "../structures/packet/packet.h"
 48 
#include "../structures/packet/packet.h"
46 
 
 49 
 
47 
#include "device.h"
 50 
#include "device.h"
48 
 
 51 
 
- 
 
 52 
/** Returns the device local hardware address.
- 
 
 53 
 *  @param netif_phone The network interface phone. Input parameter.
- 
 
 54 
 *  @param device_id The device identifier. Input parameter.
- 
 
 55 
 *  @param address The device local hardware address. Output parameter.
- 
 
 56 
 *  @param data The address data. Output parameter.
- 
 
 57 
 *  @returns EOK on success.
- 
 
 58 
 *  @returns EBADMEM if the address parameter is NULL.
- 
 
 59 
 *  @returns ENOENT if there no such device.
- 
 
 60 
 *  @returns Other error codes as defined for the netif_get_addr() function.
- 
 
 61 
 */
49 
int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
 62 
int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
- 
 
 63 
 
- 
 
 64 
/** Probes the existence of the device.
- 
 
 65 
 *  @param netif_phone The network interface phone. Input parameter.
- 
 
 66 
 *  @param device_id The device identifier. Input parameter.
- 
 
 67 
 *  @param irq The device interrupt number. Input parameter.
- 
 
 68 
 *  @param io The device input/output address. Input parameter.
- 
 
 69 
 *  @returns EOK on success.
- 
 
 70 
 *  @returns Other errro codes as defined for the netif_probe_message().
- 
 
 71 
 */
50 
int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
 72 
int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
- 
 
 73 
 
- 
 
 74 
/** Sends the packet queue.
- 
 
 75 
 *  @param netif_phone The network interface phone. Input parameter.
- 
 
 76 
 *  @param device_id The device identifier. Input parameter.
- 
 
 77 
 *  @param packet The packet queue. Input parameter.
- 
 
 78 
 *  @param sender The sending module service. Input parameter.
- 
 
 79 
 *  @returns EOK on success.
- 
 
 80 
 *  @returns Other error codes as defined for the generic_send_msg() function.
- 
 
 81 
 */
51 
int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
 82 
int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
- 
 
 83 
 
- 
 
 84 
/** Starts the device.
- 
 
 85 
 *  @param netif_phone The network interface phone. Input parameter.
- 
 
 86 
 *  @param device_id The device identifier. Input parameter.
- 
 
 87 
 *  @returns EOK on success.
- 
 
 88 
 *  @returns Other error codes as defined for the find_device() function.
- 
 
 89 
 *  @returns Other error codes as defined for the netif_start_message() function.
- 
 
 90 
 */
52 
int netif_start_req( int netif_phone, device_id_t device_id );
 91 
int netif_start_req( int netif_phone, device_id_t device_id );
- 
 
 92 
 
- 
 
 93 
/** Stops the device.
- 
 
 94 
 *  @param netif_phone The network interface phone. Input parameter.
- 
 
 95 
 *  @param device_id The device identifier. Input parameter.
- 
 
 96 
 *  @returns EOK on success.
- 
 
 97 
 *  @returns Other error codes as defined for the find_device() function.
- 
 
 98 
 *  @returns Other error codes as defined for the netif_stop_message() function.
- 
 
 99 
 */
53 
int netif_stop_req( int netif_phone, device_id_t device_id );
 100 
int netif_stop_req( int netif_phone, device_id_t device_id );
- 
 
 101 
 
- 
 
 102 
/** Creates bidirectional connection with the network interface module service and registers the message receiver.
- 
 
 103 
 *  @param service The network interface module service. Input parameter.
- 
 
 104 
 *  @param device_id The device identifier. Input parameter.
- 
 
 105 
 *  @param me The requesting module service. Input parameter.
- 
 
 106 
 *  @param receiver The message receiver. Input parameter.
- 
 
 107 
 *  @returns The phone of the needed service.
- 
 
 108 
 *  @returns EOK on success.
- 
 
 109 
 *  @returns Other error codes as defined for the bind_service() function.
- 
 
 110 
 */
54 
int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
 111 
int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
55 
 
 112 
 
56 
#endif
 113 
#endif
57 
 
 114 
 
58 
/** @}
 115 
/** @}