Subversion Repositories HelenOS

Rev

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

Rev 4307 Rev 4350
Line 30... Line 30...
30 
 *  @{
 30 
 *  @{
31 
 */
 31 
 */
32 
 
 32 
 
33 
/** @file
 33 
/** @file
34 
 *  Network interface module skeleton.
 34 
 *  Network interface module skeleton.
- 
 
 35 
 *  The skeleton has to be part of each network interface module.
- 
 
 36 
 *  The skeleton can be also part of the module bundled with the network interface layer.
35 
 */
 37 
 */
36 
 
 38 
 
37 
#ifndef __NET_NETIF_H__
 39 
#ifndef __NET_NETIF_H__
38 
#define __NET_NETIF_H__
 40 
#define __NET_NETIF_H__
39 
 
 41 
 
Line 112... Line 114...
112 
 *  @param stats The usage statistics. Input parameter.
 114 
 *  @param stats The usage statistics. Input parameter.
113 
 */
 115 
 */
114 
void    null_device_stats( device_stats_ref stats );
 116 
void    null_device_stats( device_stats_ref stats );
115 
 
 117 
 
116 
// prepared for future optimalizations
 118 
// prepared for future optimalizations
117 
/** \todo
 119 
/** Releases the given packet.
- 
 
 120 
 *  @param packet_id The packet identifier. Input parameter.
118 
 */
 121 
 */
119 
void    netif_pq_release( packet_id_t packet );
 122 
void    netif_pq_release( packet_id_t packet_id );
120 
 
 123 
 
- 
 
 124 
/** Allocates new packet to handle the given content size.
- 
 
 125 
 *  @param content The minimum content size. Input parameter.
121 
/** \todo
 126 
 *  @returns The allocated packet.
- 
 
 127 
 *  @returns NULL if there is an error.
122 
 */
 128 
 */
123 
packet_t netif_packet_get_1( size_t content );
 129 
packet_t netif_packet_get_1( size_t content );
124 
 
 130 
 
- 
 
 131 
/** Processes the netif module messages.
- 
 
 132 
 *  @param callid The message identifier. Input parameter.
- 
 
 133 
 *  @param call The message parameters. Input parameter.
- 
 
 134 
 *  @param answer The message answer parameters. Output parameter.
- 
 
 135 
 *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
- 
 
 136 
 *  @returns EOK on success.
- 
 
 137 
 *  @returns ENOTSUP if the message is not known.
- 
 
 138 
 *  @returns Other error codes as defined for each specific module message function.
- 
 
 139 
 *  @see netif_interface.h
- 
 
 140 
 *  @see IS_NET_NETIF_MESSAGE()
- 
 
 141 
 */
125 
int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
 142 
int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
- 
 
 143 
 
- 
 
 144 
/** Initializes the netif module.
- 
 
 145 
 *  The function has to be defined in each module.
- 
 
 146 
 *  @param client_connection The client connection functio to be registered. Input parameter.
- 
 
 147 
 *  @returns EOK on success.
- 
 
 148 
 *  @returns Other error codes as defined for each specific module message function.
- 
 
 149 
 */
126 
int netif_init_module( async_client_conn_t client_connection );
 150 
int netif_init_module( async_client_conn_t client_connection );
- 
 
 151 
 
- 
 
 152 
/** Starts and maintains the netif module until terminated.
- 
 
 153 
 *  @returns EOK after the module is terminated.
- 
 
 154 
 */
127 
int netif_run_module( void );
 155 
int netif_run_module( void );
128 
 
 156 
 
129 
#endif
 157 
#endif
130 
 
 158 
 
131 
/** @}
 159 
/** @}