Rev 4261 | Rev 4582 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4261 | Rev 4307 | ||
---|---|---|---|
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 | */ |
35 | */ |
36 | 36 | ||
37 | #ifndef __NET_NETIF_H__ |
37 | #ifndef __NET_NETIF_H__ |
38 | #define __NET_NETIF_H__ |
38 | #define __NET_NETIF_H__ |
39 | 39 | ||
- | 40 | #include <async.h> |
|
40 | #include <rwlock.h> |
41 | #include <rwlock.h> |
41 | 42 | ||
- | 43 | #include <ipc/ipc.h> |
|
- | 44 | ||
- | 45 | #include "../err.h" |
|
- | 46 | ||
42 | #include "../include/device.h" |
47 | #include "../include/device.h" |
43 | 48 | ||
- | 49 | #include "../structures/packet/packet.h" |
|
- | 50 | ||
44 | /** Network interface module skeleton global data. |
51 | /** Network interface module skeleton global data. |
45 | */ |
52 | */ |
46 | typedef struct netif_globals netif_globals_t; |
53 | typedef struct netif_globals netif_globals_t; |
47 | 54 | ||
48 | /** Type definition of the device specific data. |
55 | /** Type definition of the device specific data. |
49 | * @see netif_device |
56 | * @see netif_device |
50 | */ |
57 | */ |
51 | typedef struct netif_device device_t; |
58 | typedef struct netif_device device_t; |
52 | 59 | ||
53 | /** Type definition of the device specific data pointer. |
60 | /** Type definition of the device specific data pointer. |
54 | * @see netif_device |
61 | * @see netif_device |
55 | */ |
62 | */ |
56 | typedef device_t * device_ref; |
63 | typedef device_t * device_ref; |
57 | 64 | ||
58 | /** Device map. |
65 | /** Device map. |
59 | * Maps device identifiers to the network interface device specific data. |
66 | * Maps device identifiers to the network interface device specific data. |
60 | * @see device.h |
67 | * @see device.h |
61 | */ |
68 | */ |
62 | DEVICE_MAP_DECLARE( device_map, device_t ); |
69 | DEVICE_MAP_DECLARE( device_map, device_t ); |
63 | 70 | ||
64 | /** Network interface device specific data. |
71 | /** Network interface device specific data. |
65 | */ |
72 | */ |
66 | struct netif_device{ |
73 | struct netif_device{ |
67 | /** Device identifier. |
74 | /** Device identifier. |
68 | */ |
75 | */ |
69 | device_id_t device_id; |
76 | device_id_t device_id; |
70 | /** Receiving network interface layer phone. |
77 | /** Receiving network interface layer phone. |
71 | */ |
78 | */ |
72 | int nil_phone; |
79 | int nil_phone; |
73 | /** Actual device state. |
80 | /** Actual device state. |
74 | */ |
81 | */ |
75 | device_state_t state; |
82 | device_state_t state; |
76 | /** Driver specific data. |
83 | /** Driver specific data. |
77 | */ |
84 | */ |
78 | void * specific; |
85 | void * specific; |
79 | }; |
86 | }; |
80 | 87 | ||
81 | /** Network interface module skeleton global data. |
88 | /** Network interface module skeleton global data. |
82 | */ |
89 | */ |
83 | struct netif_globals{ |
90 | struct netif_globals{ |
84 | /** Networking module phone. |
91 | /** Networking module phone. |
85 | */ |
92 | */ |
86 | int networking_phone; |
93 | int net_phone; |
87 | /** Device map. |
94 | /** Device map. |
88 | */ |
95 | */ |
89 | device_map_t device_map; |
96 | device_map_t device_map; |
90 | /** Safety lock. |
97 | /** Safety lock. |
91 | */ |
98 | */ |
92 | rwlock_t lock; |
99 | rwlock_t lock; |
93 | }; |
100 | }; |
94 | 101 | ||
95 | /** Finds the device specific data. |
102 | /** Finds the device specific data. |
96 | * @param device_id The device identifier. Input parameter. |
103 | * @param device_id The device identifier. Input parameter. |
97 | * @param device The device specific data. Output parameter. |
104 | * @param device The device specific data. Output parameter. |
98 | * @returns EOK on success. |
105 | * @returns EOK on success. |
99 | * @returns ENOENT if device is not found. |
106 | * @returns ENOENT if device is not found. |
100 | * @returns EPERM if the device is not initialized. |
107 | * @returns EPERM if the device is not initialized. |
101 | */ |
108 | */ |
102 | int find_device( device_id_t device_id, device_ref * device ); |
109 | int find_device( device_id_t device_id, device_ref * device ); |
103 | 110 | ||
104 | /** Clears the usage statistics. |
111 | /** Clears the usage statistics. |
105 | * @param stats The usage statistics. Input parameter. |
112 | * @param stats The usage statistics. Input parameter. |
106 | */ |
113 | */ |
107 | void null_device_stats( device_stats_ref stats ); |
114 | void null_device_stats( device_stats_ref stats ); |
108 | 115 | ||
109 | // prepared for future optimalizations |
116 | // prepared for future optimalizations |
110 | /** \todo |
117 | /** \todo |
111 | */ |
118 | */ |
112 | void netif_pq_release( packet_id_t packet ); |
119 | void netif_pq_release( packet_id_t packet ); |
113 | 120 | ||
114 | /** \todo |
121 | /** \todo |
115 | */ |
122 | */ |
116 | packet_t netif_packet_get_1( size_t content ); |
123 | packet_t netif_packet_get_1( size_t content ); |
117 | 124 | ||
- | 125 | int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ); |
|
- | 126 | int netif_init_module( async_client_conn_t client_connection ); |
|
- | 127 | int netif_run_module( void ); |
|
- | 128 | ||
118 | #endif |
129 | #endif |
119 | 130 | ||
120 | /** @} |
131 | /** @} |
121 | */ |
132 | */ |
122 | 133 | ||
123 | 134 |