Rev 4743 | Show entire file | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4743 | Rev 4756 | ||
---|---|---|---|
Line 53... | Line 53... | ||
53 | * This interface is used by other modules. |
53 | * This interface is used by other modules. |
54 | */ |
54 | */ |
55 | /*@{*/ |
55 | /*@{*/ |
56 | 56 | ||
57 | /** Returns the device local hardware address. |
57 | /** Returns the device local hardware address. |
58 | * @param netif_phone The network interface phone. Input parameter. |
58 | * @param[in] netif_phone The network interface phone. |
59 | * @param device_id The device identifier. Input parameter. |
59 | * @param[in] device_id The device identifier. |
60 | * @param address The device local hardware address. Output parameter. |
60 | * @param[out] address The device local hardware address. |
61 | * @param data The address data. Output parameter. |
61 | * @param[out] data The address data. |
62 | * @returns EOK on success. |
62 | * @returns EOK on success. |
63 | * @returns EBADMEM if the address parameter is NULL. |
63 | * @returns EBADMEM if the address parameter is NULL. |
64 | * @returns ENOENT if there no such device. |
64 | * @returns ENOENT if there no such device. |
65 | * @returns Other error codes as defined for the netif_get_addr_message() function. |
65 | * @returns Other error codes as defined for the netif_get_addr_message() function. |
66 | */ |
66 | */ |
67 | int netif_get_addr_req( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data ); |
67 | int netif_get_addr_req( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data ); |
68 | 68 | ||
69 | /** Probes the existence of the device. |
69 | /** Probes the existence of the device. |
70 | * @param netif_phone The network interface phone. Input parameter. |
70 | * @param[in] netif_phone The network interface phone. |
71 | * @param device_id The device identifier. Input parameter. |
71 | * @param[in] device_id The device identifier. |
72 | * @param irq The device interrupt number. Input parameter. |
72 | * @param[in] irq The device interrupt number. |
73 | * @param io The device input/output address. Input parameter. |
73 | * @param[in] io The device input/output address. |
74 | * @returns EOK on success. |
74 | * @returns EOK on success. |
75 | * @returns Other errro codes as defined for the netif_probe_message(). |
75 | * @returns Other errro codes as defined for the netif_probe_message(). |
76 | */ |
76 | */ |
77 | int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io ); |
77 | int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io ); |
78 | 78 | ||
79 | /** Sends the packet queue. |
79 | /** Sends the packet queue. |
80 | * @param netif_phone The network interface phone. Input parameter. |
80 | * @param[in] netif_phone The network interface phone. |
81 | * @param device_id The device identifier. Input parameter. |
81 | * @param[in] device_id The device identifier. |
82 | * @param packet The packet queue. Input parameter. |
82 | * @param[in] packet The packet queue. |
83 | * @param sender The sending module service. Input parameter. |
83 | * @param[in] sender The sending module service. |
84 | * @returns EOK on success. |
84 | * @returns EOK on success. |
85 | * @returns Other error codes as defined for the generic_send_msg() function. |
85 | * @returns Other error codes as defined for the generic_send_msg() function. |
86 | */ |
86 | */ |
87 | int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender ); |
87 | int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender ); |
88 | 88 | ||
89 | /** Starts the device. |
89 | /** Starts the device. |
90 | * @param netif_phone The network interface phone. Input parameter. |
90 | * @param[in] netif_phone The network interface phone. |
91 | * @param device_id The device identifier. Input parameter. |
91 | * @param[in] device_id The device identifier. |
92 | * @returns EOK on success. |
92 | * @returns EOK on success. |
93 | * @returns Other error codes as defined for the find_device() function. |
93 | * @returns Other error codes as defined for the find_device() function. |
94 | * @returns Other error codes as defined for the netif_start_message() function. |
94 | * @returns Other error codes as defined for the netif_start_message() function. |
95 | */ |
95 | */ |
96 | int netif_start_req( int netif_phone, device_id_t device_id ); |
96 | int netif_start_req( int netif_phone, device_id_t device_id ); |
97 | 97 | ||
98 | /** Stops the device. |
98 | /** Stops the device. |
99 | * @param netif_phone The network interface phone. Input parameter. |
99 | * @param[in] netif_phone The network interface phone. |
100 | * @param device_id The device identifier. Input parameter. |
100 | * @param[in] device_id The device identifier. |
101 | * @returns EOK on success. |
101 | * @returns EOK on success. |
102 | * @returns Other error codes as defined for the find_device() function. |
102 | * @returns Other error codes as defined for the find_device() function. |
103 | * @returns Other error codes as defined for the netif_stop_message() function. |
103 | * @returns Other error codes as defined for the netif_stop_message() function. |
104 | */ |
104 | */ |
105 | int netif_stop_req( int netif_phone, device_id_t device_id ); |
105 | int netif_stop_req( int netif_phone, device_id_t device_id ); |
106 | 106 | ||
107 | /** Returns the device usage statistics. |
107 | /** Returns the device usage statistics. |
108 | * @param netif_phone The network interface phone. Input parameter. |
108 | * @param[in] netif_phone The network interface phone. |
109 | * @param device_id The device identifier. Input parameter. |
109 | * @param[in] device_id The device identifier. |
110 | * @param stats The device usage statistics. Output parameter. |
110 | * @param[out] stats The device usage statistics. |
111 | * @returns EOK on success. |
111 | * @returns EOK on success. |
112 | */ |
112 | */ |
113 | int netif_stats_req( int netif_phone, device_id_t device_id, device_stats_ref stats ); |
113 | int netif_stats_req( int netif_phone, device_id_t device_id, device_stats_ref stats ); |
114 | 114 | ||
115 | /** Creates bidirectional connection with the network interface module and registers the message receiver. |
115 | /** Creates bidirectional connection with the network interface module and registers the message receiver. |
116 | * @param service The network interface module service. Input parameter. |
116 | * @param[in] service The network interface module service. |
117 | * @param device_id The device identifier. Input parameter. |
117 | * @param[in] device_id The device identifier. |
118 | * @param me The requesting module service. Input parameter. |
118 | * @param[in] me The requesting module service. |
119 | * @param receiver The message receiver. Input parameter. |
119 | * @param[in] receiver The message receiver. |
120 | * @returns The phone of the needed service. |
120 | * @returns The phone of the needed service. |
121 | * @returns EOK on success. |
121 | * @returns EOK on success. |
122 | * @returns Other error codes as defined for the bind_service() function. |
122 | * @returns Other error codes as defined for the bind_service() function. |
123 | */ |
123 | */ |
124 | int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver ); |
124 | int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver ); |