Rev 4243 | Rev 4307 | 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 | |||
| 4192 | mejdrech | 40 | #include <rwlock.h> |
| 41 | |||
| 4243 | mejdrech | 42 | #include "../include/device.h" |
| 3666 | mejdrech | 43 | |
| 3912 | mejdrech | 44 | /** Network interface module skeleton global data. |
| 45 | */ |
||
| 3846 | mejdrech | 46 | typedef struct netif_globals netif_globals_t; |
| 3666 | mejdrech | 47 | |
| 3912 | mejdrech | 48 | /** Type definition of the device specific data. |
| 49 | * @see netif_device |
||
| 50 | */ |
||
| 51 | typedef struct netif_device device_t; |
||
| 52 | |||
| 53 | /** Type definition of the device specific data pointer. |
||
| 54 | * @see netif_device |
||
| 55 | */ |
||
| 56 | typedef device_t * device_ref; |
||
| 57 | |||
| 58 | /** Device map. |
||
| 59 | * Maps device identifiers to the network interface device specific data. |
||
| 60 | * @see device.h |
||
| 61 | */ |
||
| 3846 | mejdrech | 62 | DEVICE_MAP_DECLARE( device_map, device_t ); |
| 3666 | mejdrech | 63 | |
| 3912 | mejdrech | 64 | /** Network interface device specific data. |
| 65 | */ |
||
| 66 | struct netif_device{ |
||
| 67 | /** Device identifier. |
||
| 68 | */ |
||
| 3846 | mejdrech | 69 | device_id_t device_id; |
| 3912 | mejdrech | 70 | /** Receiving network interface layer phone. |
| 71 | */ |
||
| 3846 | mejdrech | 72 | int nil_phone; |
| 3912 | mejdrech | 73 | /** Actual device state. |
| 74 | */ |
||
| 3846 | mejdrech | 75 | device_state_t state; |
| 3912 | mejdrech | 76 | /** Driver specific data. |
| 77 | */ |
||
| 3846 | mejdrech | 78 | void * specific; |
| 3685 | mejdrech | 79 | }; |
| 80 | |||
| 3912 | mejdrech | 81 | /** Network interface module skeleton global data. |
| 82 | */ |
||
| 3666 | mejdrech | 83 | struct netif_globals{ |
| 3912 | mejdrech | 84 | /** Networking module phone. |
| 85 | */ |
||
| 3846 | mejdrech | 86 | int networking_phone; |
| 3912 | mejdrech | 87 | /** Device map. |
| 88 | */ |
||
| 3846 | mejdrech | 89 | device_map_t device_map; |
| 4192 | mejdrech | 90 | /** Safety lock. |
| 91 | */ |
||
| 92 | rwlock_t lock; |
||
| 3666 | mejdrech | 93 | }; |
| 94 | |||
| 3912 | mejdrech | 95 | /** Finds the device specific data. |
| 96 | * @param device_id The device identifier. Input parameter. |
||
| 97 | * @param device The device specific data. Output parameter. |
||
| 98 | * @returns EOK on success. |
||
| 99 | * @returns ENOENT if device is not found. |
||
| 100 | * @returns EPERM if the device is not initialized. |
||
| 101 | */ |
||
| 3846 | mejdrech | 102 | int find_device( device_id_t device_id, device_ref * device ); |
| 3912 | mejdrech | 103 | |
| 104 | /** Clears the usage statistics. |
||
| 105 | * @param stats The usage statistics. Input parameter. |
||
| 106 | */ |
||
| 3846 | mejdrech | 107 | void null_device_stats( device_stats_ref stats ); |
| 3666 | mejdrech | 108 | |
| 4192 | mejdrech | 109 | // prepared for future optimalizations |
| 110 | /** \todo |
||
| 111 | */ |
||
| 112 | void netif_pq_release( packet_id_t packet ); |
||
| 113 | |||
| 114 | /** \todo |
||
| 115 | */ |
||
| 116 | packet_t netif_packet_get_1( size_t content ); |
||
| 117 | |||
| 3666 | mejdrech | 118 | #endif |
| 119 | |||
| 120 | /** @} |
||
| 121 | */ |
||
| 122 |