Rev 4350 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4350 | Rev 4582 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2009 Lukas Mejdrech |
2 | * Copyright (c) 2009 Lukas Mejdrech |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup netif |
29 | /** @addtogroup netif |
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. |
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. |
36 | * The skeleton can be also part of the module bundled with the network interface layer. |
37 | */ |
37 | */ |
38 | 38 | ||
39 | #ifndef __NET_NETIF_H__ |
39 | #ifndef __NET_NETIF_H__ |
40 | #define __NET_NETIF_H__ |
40 | #define __NET_NETIF_H__ |
41 | 41 | ||
42 | #include <async.h> |
42 | #include <async.h> |
43 | #include <rwlock.h> |
43 | #include <fibril_sync.h> |
44 | 44 | ||
45 | #include <ipc/ipc.h> |
45 | #include <ipc/ipc.h> |
46 | 46 | ||
47 | #include "../err.h" |
47 | #include "../err.h" |
48 | 48 | ||
49 | #include "../include/device.h" |
49 | #include "../include/device.h" |
50 | 50 | ||
51 | #include "../structures/packet/packet.h" |
51 | #include "../structures/packet/packet.h" |
52 | 52 | ||
53 | /** Network interface module skeleton global data. |
53 | /** Network interface module skeleton global data. |
54 | */ |
54 | */ |
55 | typedef struct netif_globals netif_globals_t; |
55 | typedef struct netif_globals netif_globals_t; |
56 | 56 | ||
57 | /** Type definition of the device specific data. |
57 | /** Type definition of the device specific data. |
58 | * @see netif_device |
58 | * @see netif_device |
59 | */ |
59 | */ |
60 | typedef struct netif_device device_t; |
60 | typedef struct netif_device device_t; |
61 | 61 | ||
62 | /** Type definition of the device specific data pointer. |
62 | /** Type definition of the device specific data pointer. |
63 | * @see netif_device |
63 | * @see netif_device |
64 | */ |
64 | */ |
65 | typedef device_t * device_ref; |
65 | typedef device_t * device_ref; |
66 | 66 | ||
67 | /** Device map. |
67 | /** Device map. |
68 | * Maps device identifiers to the network interface device specific data. |
68 | * Maps device identifiers to the network interface device specific data. |
69 | * @see device.h |
69 | * @see device.h |
70 | */ |
70 | */ |
71 | DEVICE_MAP_DECLARE( device_map, device_t ); |
71 | DEVICE_MAP_DECLARE( device_map, device_t ); |
72 | 72 | ||
73 | /** Network interface device specific data. |
73 | /** Network interface device specific data. |
74 | */ |
74 | */ |
75 | struct netif_device{ |
75 | struct netif_device{ |
76 | /** Device identifier. |
76 | /** Device identifier. |
77 | */ |
77 | */ |
78 | device_id_t device_id; |
78 | device_id_t device_id; |
79 | /** Receiving network interface layer phone. |
79 | /** Receiving network interface layer phone. |
80 | */ |
80 | */ |
81 | int nil_phone; |
81 | int nil_phone; |
82 | /** Actual device state. |
82 | /** Actual device state. |
83 | */ |
83 | */ |
84 | device_state_t state; |
84 | device_state_t state; |
85 | /** Driver specific data. |
85 | /** Driver specific data. |
86 | */ |
86 | */ |
87 | void * specific; |
87 | void * specific; |
88 | }; |
88 | }; |
89 | 89 | ||
90 | /** Network interface module skeleton global data. |
90 | /** Network interface module skeleton global data. |
91 | */ |
91 | */ |
92 | struct netif_globals{ |
92 | struct netif_globals{ |
93 | /** Networking module phone. |
93 | /** Networking module phone. |
94 | */ |
94 | */ |
95 | int net_phone; |
95 | int net_phone; |
96 | /** Device map. |
96 | /** Device map. |
97 | */ |
97 | */ |
98 | device_map_t device_map; |
98 | device_map_t device_map; |
99 | /** Safety lock. |
99 | /** Safety lock. |
100 | */ |
100 | */ |
101 | rwlock_t lock; |
101 | fibril_rwlock_t lock; |
102 | }; |
102 | }; |
103 | 103 | ||
104 | /** Finds the device specific data. |
104 | /** Finds the device specific data. |
105 | * @param device_id The device identifier. Input parameter. |
105 | * @param device_id The device identifier. Input parameter. |
106 | * @param device The device specific data. Output parameter. |
106 | * @param device The device specific data. Output parameter. |
107 | * @returns EOK on success. |
107 | * @returns EOK on success. |
108 | * @returns ENOENT if device is not found. |
108 | * @returns ENOENT if device is not found. |
109 | * @returns EPERM if the device is not initialized. |
109 | * @returns EPERM if the device is not initialized. |
110 | */ |
110 | */ |
111 | int find_device( device_id_t device_id, device_ref * device ); |
111 | int find_device( device_id_t device_id, device_ref * device ); |
112 | 112 | ||
113 | /** Clears the usage statistics. |
113 | /** Clears the usage statistics. |
114 | * @param stats The usage statistics. Input parameter. |
114 | * @param stats The usage statistics. Input parameter. |
115 | */ |
115 | */ |
116 | void null_device_stats( device_stats_ref stats ); |
116 | void null_device_stats( device_stats_ref stats ); |
117 | 117 | ||
118 | // prepared for future optimalizations |
118 | // prepared for future optimalizations |
119 | /** Releases the given packet. |
119 | /** Releases the given packet. |
120 | * @param packet_id The packet identifier. Input parameter. |
120 | * @param packet_id The packet identifier. Input parameter. |
121 | */ |
121 | */ |
122 | void netif_pq_release( packet_id_t packet_id ); |
122 | void netif_pq_release( packet_id_t packet_id ); |
123 | 123 | ||
124 | /** Allocates new packet to handle the given content size. |
124 | /** Allocates new packet to handle the given content size. |
125 | * @param content The minimum content size. Input parameter. |
125 | * @param content The minimum content size. Input parameter. |
126 | * @returns The allocated packet. |
126 | * @returns The allocated packet. |
127 | * @returns NULL if there is an error. |
127 | * @returns NULL if there is an error. |
128 | */ |
128 | */ |
129 | packet_t netif_packet_get_1( size_t content ); |
129 | packet_t netif_packet_get_1( size_t content ); |
130 | 130 | ||
131 | /** Processes the netif module messages. |
131 | /** Processes the netif module messages. |
132 | * @param callid The message identifier. Input parameter. |
132 | * @param callid The message identifier. Input parameter. |
133 | * @param call The message parameters. Input parameter. |
133 | * @param call The message parameters. Input parameter. |
134 | * @param answer The message answer parameters. Output 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. |
135 | * @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter. |
136 | * @returns EOK on success. |
136 | * @returns EOK on success. |
137 | * @returns ENOTSUP if the message is not known. |
137 | * @returns ENOTSUP if the message is not known. |
138 | * @returns Other error codes as defined for each specific module message function. |
138 | * @returns Other error codes as defined for each specific module message function. |
139 | * @see netif_interface.h |
139 | * @see netif_interface.h |
140 | * @see IS_NET_NETIF_MESSAGE() |
140 | * @see IS_NET_NETIF_MESSAGE() |
141 | */ |
141 | */ |
142 | 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 | 143 | ||
144 | /** Initializes the netif module. |
144 | /** Initializes the netif module. |
145 | * The function has to be defined in each module. |
145 | * The function has to be defined in each module. |
146 | * @param client_connection The client connection functio to be registered. Input parameter. |
146 | * @param client_connection The client connection functio to be registered. Input parameter. |
147 | * @returns EOK on success. |
147 | * @returns EOK on success. |
148 | * @returns Other error codes as defined for each specific module message function. |
148 | * @returns Other error codes as defined for each specific module message function. |
149 | */ |
149 | */ |
150 | int netif_init_module( async_client_conn_t client_connection ); |
150 | int netif_init_module( async_client_conn_t client_connection ); |
151 | 151 | ||
152 | /** Starts and maintains the netif module until terminated. |
152 | /** Starts and maintains the netif module until terminated. |
153 | * @returns EOK after the module is terminated. |
153 | * @returns EOK after the module is terminated. |
154 | */ |
154 | */ |
155 | int netif_run_module( void ); |
155 | int netif_run_module( void ); |
156 | 156 | ||
157 | #endif |
157 | #endif |
158 | 158 | ||
159 | /** @} |
159 | /** @} |
160 | */ |
160 | */ |
161 | 161 | ||
162 | 162 |