2
* Copyright (c) 2009 Lukas Mejdrech
5
* Redistribution and use in source and binary forms, with or without
6
* modification, are permitted provided that the following conditions
9
* - Redistributions of source code must retain the above copyright
10
* notice, this list of conditions and the following disclaimer.
11
* - Redistributions in binary form must reproduce the above copyright
12
* notice, this list of conditions and the following disclaimer in the
13
* documentation and/or other materials provided with the distribution.
14
* - The name of the author may not be used to endorse or promote products
15
* derived from this software without specific prior written permission.
17
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
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.
39
#ifndef __NET_NETIF_H__
40
#define __NET_NETIF_H__
43
#include <fibril_synch.h>
49
#include "../include/device.h"
51
#include "../structures/packet/packet.h"
53
/** Network interface module skeleton global data.
55
typedef struct netif_globals netif_globals_t;
57
/** Type definition of the device specific data.
60
typedef struct netif_device device_t;
62
/** Type definition of the device specific data pointer.
65
typedef device_t * device_ref;
68
* Maps device identifiers to the network interface device specific data.
71
DEVICE_MAP_DECLARE( device_map, device_t );
73
/** Network interface device specific data.
76
/** Device identifier.
78
device_id_t device_id;
79
/** Receiving network interface layer phone.
82
/** Actual device state.
85
/** Driver specific data.
90
/** Network interface module skeleton global data.
93
/** Networking module phone.
98
device_map_t device_map;
101
fibril_rwlock_t lock;
104
/** Finds the device specific data.
105
* @param[in] device_id The device identifier.
106
* @param[out] device The device specific data.
107
* @returns EOK on success.
108
* @returns ENOENT if device is not found.
109
* @returns EPERM if the device is not initialized.
111
int find_device( device_id_t device_id, device_ref * device );
113
/** Clears the usage statistics.
114
* @param[in] stats The usage statistics.
116
void null_device_stats( device_stats_ref stats );
118
// prepared for future optimalizations
119
/** Releases the given packet.
120
* @param[in] packet_id The packet identifier.
122
void netif_pq_release( packet_id_t packet_id );
124
/** Allocates new packet to handle the given content size.
125
* @param[in] content The minimum content size.
126
* @returns The allocated packet.
127
* @returns NULL if there is an error.
129
packet_t netif_packet_get_1( size_t content );
131
/** Processes the netif module messages.
132
* @param[in] callid The message identifier.
133
* @param[in] call The message parameters.
134
* @param[out] answer The message answer parameters.
135
* @param[out] answer_count The last parameter for the actual answer in the answer 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()
142
int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
144
/** Initializes the netif module.
145
* The function has to be defined in each module.
146
* @param[in] client_connection The client connection functio to be registered.
147
* @returns EOK on success.
148
* @returns Other error codes as defined for each specific module message function.
150
int netif_init_module( async_client_conn_t client_connection );
152
/** Starts and maintains the netif module until terminated.
153
* @returns EOK after the module is terminated.
155
int netif_run_module( void );
added
removed
uspace/srv/net/netif/netif.h
