Rev 3912 | Rev 4192 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 3912 | Rev 4163 | ||
---|---|---|---|
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 "device.h" |
40 | #include "device.h" |
41 | 41 | ||
42 | /** Sends the notification message to the registered network interface layer module. |
42 | /** Sends the notification message to the registered network interface layer module. |
43 | * Wrapper of the async_msg_3(). |
43 | * Wrapper of the async_msg_3(). |
44 | * The first message argument is always the device identifier. |
44 | * The first message argument is always the device identifier. |
45 | * @param device The device specific data. Input parameter. |
45 | * @param device The device specific data. Input parameter. |
46 | * @param message The message to be sent. Input parameter. |
46 | * @param message The message to be sent. Input parameter. |
47 | * @param arg2 The second message argument. Input parameter. |
47 | * @param arg2 The second message argument. Input parameter. |
48 | * @param arg3 The third message argument. Input parameter. |
48 | * @param arg3 The third message argument. Input parameter. |
49 | */ |
49 | */ |
50 | #define nil_message( device, message, arg2, arg3 ) \ |
50 | #define nil_message( device, message, arg2, arg3 ) \ |
51 | if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 ) |
51 | if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 ) |
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 | /** Usage statistics. |
82 | /** Usage statistics. |
83 | */ |
83 | */ |
84 | device_stats_t stats; |
84 | device_stats_t stats; |
85 | /** Actual device state. |
85 | /** Actual device state. |
86 | */ |
86 | */ |
87 | device_state_t state; |
87 | device_state_t state; |
88 | // TODO needed? |
- | |
89 | /** Various device flags. |
- | |
90 | */ |
- | |
91 | int flags; |
- | |
92 | /** Maximum transmission unit. |
- | |
93 | * The maximum packet content to be transmited. |
- | |
94 | */ |
- | |
95 | size_t mtu; |
- | |
96 | /** Driver specific data. |
88 | /** Driver specific data. |
97 | */ |
89 | */ |
98 | void * specific; |
90 | void * specific; |
99 | }; |
91 | }; |
100 | 92 | ||
101 | /** Network interface module skeleton global data. |
93 | /** Network interface module skeleton global data. |
102 | */ |
94 | */ |
103 | struct netif_globals{ |
95 | struct netif_globals{ |
104 | /** Networking module phone. |
96 | /** Networking module phone. |
105 | */ |
97 | */ |
106 | int networking_phone; |
98 | int networking_phone; |
107 | /** Device map. |
99 | /** Device map. |
108 | */ |
100 | */ |
109 | device_map_t device_map; |
101 | device_map_t device_map; |
110 | }; |
102 | }; |
111 | 103 | ||
112 | /** Finds the device specific data. |
104 | /** Finds the device specific data. |
113 | * @param device_id The device identifier. Input parameter. |
105 | * @param device_id The device identifier. Input parameter. |
114 | * @param device The device specific data. Output parameter. |
106 | * @param device The device specific data. Output parameter. |
115 | * @returns EOK on success. |
107 | * @returns EOK on success. |
116 | * @returns ENOENT if device is not found. |
108 | * @returns ENOENT if device is not found. |
117 | * @returns EPERM if the device is not initialized. |
109 | * @returns EPERM if the device is not initialized. |
118 | */ |
110 | */ |
119 | int find_device( device_id_t device_id, device_ref * device ); |
111 | int find_device( device_id_t device_id, device_ref * device ); |
120 | 112 | ||
121 | /** Clears the usage statistics. |
113 | /** Clears the usage statistics. |
122 | * @param stats The usage statistics. Input parameter. |
114 | * @param stats The usage statistics. Input parameter. |
123 | */ |
115 | */ |
124 | void null_device_stats( device_stats_ref stats ); |
116 | void null_device_stats( device_stats_ref stats ); |
125 | 117 | ||
126 | #endif |
118 | #endif |
127 | 119 | ||
128 | /** @} |
120 | /** @} |
129 | */ |
121 | */ |
130 | 122 | ||
131 | 123 |