Rev 4307 | Rev 4703 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 4307 | Rev 4350 | ||
|---|---|---|---|
| 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 |
|
| - | 34 | * Network interface module interface. |
|
| - | 35 | * The interface has to be implemented by each network interface module. |
|
| - | 36 | * The interface is used by the network interface module skeleton. |
|
| - | 37 | */ |
|
| - | 38 | ||
| 33 | #ifndef __NET_NETIF_MODULE_H__ |
39 | #ifndef __NET_NETIF_MODULE_H__ |
| 34 | #define __NET_NETIF_MODULE_H__ |
40 | #define __NET_NETIF_MODULE_H__ |
| 35 | 41 | ||
| 36 | #include <ipc/ipc.h> |
42 | #include <ipc/ipc.h> |
| 37 | #include <ipc/services.h> |
43 | #include <ipc/services.h> |
| 38 | 44 | ||
| 39 | #include "../structures/measured_strings.h" |
45 | #include "../structures/measured_strings.h" |
| 40 | #include "../structures/packet/packet.h" |
46 | #include "../structures/packet/packet.h" |
| 41 | 47 | ||
| 42 | #include "../include/device.h" |
48 | #include "../include/device.h" |
| 43 | 49 | ||
| - | 50 | /** Initializes the specific module. |
|
| - | 51 | */ |
|
| 44 | int netif_initialize( void ); |
52 | int netif_initialize( void ); |
| - | 53 | ||
| - | 54 | /** Automatically probes all known devices. |
|
| - | 55 | */ |
|
| 45 | int netif_probe_auto_message( void ); |
56 | int netif_probe_auto_message( void ); |
| - | 57 | ||
| - | 58 | /** Probes the existence of the device. |
|
| - | 59 | * @param device_id The device identifier. Input parameter. |
|
| - | 60 | * @param irq The device interrupt number. Input parameter. |
|
| - | 61 | * @param io The device input/output address. Input parameter. |
|
| - | 62 | * @returns EOK on success. |
|
| - | 63 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 64 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 65 | */ |
|
| 46 | int netif_probe_message( device_id_t device_id, int irq, int io ); |
66 | int netif_probe_message( device_id_t device_id, int irq, int io ); |
| - | 67 | ||
| - | 68 | /** Sends the packet queue. |
|
| - | 69 | * @param device_id The device identifier. Input parameter. |
|
| - | 70 | * @param packet The packet queue. Input parameter. |
|
| - | 71 | * @param sender The sending module service. Input parameter. |
|
| - | 72 | * @returns EOK on success. |
|
| - | 73 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 74 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 75 | */ |
|
| 47 | int netif_send_message( device_id_t device_id, packet_t packet, services_t sender ); |
76 | int netif_send_message( device_id_t device_id, packet_t packet, services_t sender ); |
| - | 77 | ||
| - | 78 | /** Starts the device. |
|
| - | 79 | * @param device The device structure. Input parameter. |
|
| - | 80 | * @returns EOK on success. |
|
| - | 81 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 82 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 83 | */ |
|
| 48 | int netif_start_message( device_ref device ); |
84 | int netif_start_message( device_ref device ); |
| - | 85 | ||
| - | 86 | /** Stops the device. |
|
| - | 87 | * @param device The device structure. Input parameter. |
|
| - | 88 | * @returns EOK on success. |
|
| - | 89 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 90 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 91 | */ |
|
| 49 | int netif_stop_message( device_ref device ); |
92 | int netif_stop_message( device_ref device ); |
| - | 93 | ||
| - | 94 | /** Returns the device local hardware address. |
|
| - | 95 | * @param device_id The device identifier. Input parameter. |
|
| - | 96 | * @param address The device local hardware address. Output parameter. |
|
| - | 97 | * @returns EOK on success. |
|
| - | 98 | * @returns EBADMEM if the address parameter is NULL. |
|
| - | 99 | * @returns ENOENT if there no such device. |
|
| - | 100 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 101 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 102 | */ |
|
| 50 | int netif_get_addr_message( device_id_t device_id, measured_string_ref address ); |
103 | int netif_get_addr_message( device_id_t device_id, measured_string_ref address ); |
| - | 104 | ||
| 51 | int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ); |
105 | int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count ); |
| - | 106 | ||
| - | 107 | /** Returns the device usage statistics. |
|
| - | 108 | * @param device_id The device identifier. Input parameter. |
|
| - | 109 | * @param stats The device usage statistics. Output parameter. |
|
| - | 110 | * @returns EOK on success. |
|
| - | 111 | * @returns Other error codes as defined for the find_device() function. |
|
| - | 112 | * @returns Other error codes as defined for the specific module message implementation. |
|
| - | 113 | */ |
|
| 52 | int netif_get_device_stats( device_id_t device_id, device_stats_ref stats ); |
114 | int netif_get_device_stats( device_id_t device_id, device_stats_ref stats ); |
| 53 | 115 | ||
| 54 | #endif |
116 | #endif |
| 55 | 117 | ||
| 56 | /** @} |
118 | /** @} |
| 57 | */ |
119 | */ |
| 58 | 120 | ||