Rev 3912 | Rev 4192 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
3666 | mejdrech | 1 | /* |
3912 | mejdrech | 2 | * Copyright (c) 2009 Lukas Mejdrech |
3666 | mejdrech | 3 | * All rights reserved. |
4 | * |
||
5 | * Redistribution and use in source and binary forms, with or without |
||
6 | * modification, are permitted provided that the following conditions |
||
7 | * are met: |
||
8 | * |
||
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. |
||
16 | * |
||
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. |
||
27 | */ |
||
28 | |||
3912 | mejdrech | 29 | /** @addtogroup netif |
30 | * @{ |
||
3666 | mejdrech | 31 | */ |
32 | |||
3912 | mejdrech | 33 | /** @file |
34 | * Network interface module skeleton. |
||
3666 | mejdrech | 35 | */ |
36 | |||
37 | #ifndef __NET_NETIF_H__ |
||
38 | #define __NET_NETIF_H__ |
||
39 | |||
3846 | mejdrech | 40 | #include "device.h" |
3666 | mejdrech | 41 | |
3912 | mejdrech | 42 | /** Sends the notification message to the registered network interface layer module. |
43 | * Wrapper of the async_msg_3(). |
||
44 | * The first message argument is always the device identifier. |
||
45 | * @param device The device specific data. Input parameter. |
||
46 | * @param message The message to be sent. Input parameter. |
||
47 | * @param arg2 The second message argument. Input parameter. |
||
48 | * @param arg3 The third message argument. Input parameter. |
||
49 | */ |
||
50 | #define nil_message( device, message, arg2, arg3 ) \ |
||
3846 | mejdrech | 51 | if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 ) |
3666 | mejdrech | 52 | |
3912 | mejdrech | 53 | /** Network interface module skeleton global data. |
54 | */ |
||
3846 | mejdrech | 55 | typedef struct netif_globals netif_globals_t; |
3666 | mejdrech | 56 | |
3912 | mejdrech | 57 | /** Type definition of the device specific data. |
58 | * @see netif_device |
||
59 | */ |
||
60 | typedef struct netif_device device_t; |
||
61 | |||
62 | /** Type definition of the device specific data pointer. |
||
63 | * @see netif_device |
||
64 | */ |
||
65 | typedef device_t * device_ref; |
||
66 | |||
67 | /** Device map. |
||
68 | * Maps device identifiers to the network interface device specific data. |
||
69 | * @see device.h |
||
70 | */ |
||
3846 | mejdrech | 71 | DEVICE_MAP_DECLARE( device_map, device_t ); |
3666 | mejdrech | 72 | |
3912 | mejdrech | 73 | /** Network interface device specific data. |
74 | */ |
||
75 | struct netif_device{ |
||
76 | /** Device identifier. |
||
77 | */ |
||
3846 | mejdrech | 78 | device_id_t device_id; |
3912 | mejdrech | 79 | /** Receiving network interface layer phone. |
80 | */ |
||
3846 | mejdrech | 81 | int nil_phone; |
3912 | mejdrech | 82 | /** Usage statistics. |
83 | */ |
||
3846 | mejdrech | 84 | device_stats_t stats; |
3912 | mejdrech | 85 | /** Actual device state. |
86 | */ |
||
3846 | mejdrech | 87 | device_state_t state; |
3912 | mejdrech | 88 | /** Driver specific data. |
89 | */ |
||
3846 | mejdrech | 90 | void * specific; |
3685 | mejdrech | 91 | }; |
92 | |||
3912 | mejdrech | 93 | /** Network interface module skeleton global data. |
94 | */ |
||
3666 | mejdrech | 95 | struct netif_globals{ |
3912 | mejdrech | 96 | /** Networking module phone. |
97 | */ |
||
3846 | mejdrech | 98 | int networking_phone; |
3912 | mejdrech | 99 | /** Device map. |
100 | */ |
||
3846 | mejdrech | 101 | device_map_t device_map; |
3666 | mejdrech | 102 | }; |
103 | |||
3912 | mejdrech | 104 | /** Finds the device specific data. |
105 | * @param device_id The device identifier. Input parameter. |
||
106 | * @param device The device specific data. Output parameter. |
||
107 | * @returns EOK on success. |
||
108 | * @returns ENOENT if device is not found. |
||
109 | * @returns EPERM if the device is not initialized. |
||
110 | */ |
||
3846 | mejdrech | 111 | int find_device( device_id_t device_id, device_ref * device ); |
3912 | mejdrech | 112 | |
113 | /** Clears the usage statistics. |
||
114 | * @param stats The usage statistics. Input parameter. |
||
115 | */ |
||
3846 | mejdrech | 116 | void null_device_stats( device_stats_ref stats ); |
3666 | mejdrech | 117 | |
118 | #endif |
||
119 | |||
120 | /** @} |
||
121 | */ |
||
122 |