Subversion Repositories HelenOS

Rev

Rev 4731 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
4192 mejdrech 1 
/*
2 
 * Copyright (c) 2009 Lukas 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 
 
29 
/** @addtogroup netif
30 
 *  @{
31 
 */
32 
 
4350 mejdrech 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 
 
4307 mejdrech 39 
#ifndef __NET_NETIF_MODULE_H__
40 
#define __NET_NETIF_MODULE_H__
4192 mejdrech 41 
 
42 
#include <ipc/ipc.h>
4261 mejdrech 43 
#include <ipc/services.h>
4192 mejdrech 44 
 
45 
#include "../structures/measured_strings.h"
46 
#include "../structures/packet/packet.h"
47 
 
4243 mejdrech 48 
#include "../include/device.h"
4192 mejdrech 49 
 
4350 mejdrech 50 
/** Initializes the specific module.
51 
 */
4243 mejdrech 52 
int netif_initialize( void );
4350 mejdrech 53 
 
54 
/** Probes the existence of the device.
4756 mejdrech 55 
 *  @param[in] device_id The device identifier.
56 
 *  @param[in] irq The device interrupt number.
57 
 *  @param[in] io The device input/output address.
4350 mejdrech 58 
 *  @returns EOK on success.
59 
 *  @returns Other error codes as defined for the find_device() function.
60 
 *  @returns Other error codes as defined for the specific module message implementation.
61 
 */
4243 mejdrech 62 
int netif_probe_message( device_id_t device_id, int irq, int io );
4350 mejdrech 63 
 
64 
/** Sends the packet queue.
4756 mejdrech 65 
 *  @param[in] device_id The device identifier.
66 
 *  @param[in] packet The packet queue.
67 
 *  @param[in] sender The sending module service.
4350 mejdrech 68 
 *  @returns EOK on success.
4731 mejdrech 69 
 *  @returns EFORWARD if the device is not active (in the NETIF_ACTIVE state).
4350 mejdrech 70 
 *  @returns Other error codes as defined for the find_device() function.
71 
 *  @returns Other error codes as defined for the specific module message implementation.
72 
 */
4261 mejdrech 73 
int netif_send_message( device_id_t device_id, packet_t packet, services_t sender );
4350 mejdrech 74 
 
75 
/** Starts the device.
4756 mejdrech 76 
 *  @param[in] device The device structure.
4350 mejdrech 77 
 *  @returns EOK on success.
78 
 *  @returns Other error codes as defined for the find_device() function.
79 
 *  @returns Other error codes as defined for the specific module message implementation.
80 
 */
4261 mejdrech 81 
int netif_start_message( device_ref device );
4350 mejdrech 82 
 
83 
/** Stops the device.
4756 mejdrech 84 
 *  @param[in] device The device structure.
4350 mejdrech 85 
 *  @returns EOK on success.
86 
 *  @returns Other error codes as defined for the find_device() function.
87 
 *  @returns Other error codes as defined for the specific module message implementation.
88 
 */
4261 mejdrech 89 
int netif_stop_message( device_ref device );
4350 mejdrech 90 
 
91 
/** Returns the device local hardware address.
4756 mejdrech 92 
 *  @param[in] device_id The device identifier.
93 
 *  @param[out] address The device local hardware address.
4350 mejdrech 94 
 *  @returns EOK on success.
95 
 *  @returns EBADMEM if the address parameter is NULL.
96 
 *  @returns ENOENT if there no such device.
97 
 *  @returns Other error codes as defined for the find_device() function.
98 
 *  @returns Other error codes as defined for the specific module message implementation.
99 
 */
4243 mejdrech 100 
int netif_get_addr_message( device_id_t device_id, measured_string_ref address );
4350 mejdrech 101 
 
4703 mejdrech 102 
/** Processes the netif driver specific message.
103 
 *  This function is called for uncommon messages received by the netif skeleton.
4756 mejdrech 104 
 *  @param[in] callid The message identifier.
105 
 *  @param[in] call The message parameters.
106 
 *  @param[out] answer The message answer parameters.
107 
 *  @param[out] answer_count The last parameter for the actual answer in the answer parameter.
4703 mejdrech 108 
 *  @returns EOK on success.
109 
 *  @returns ENOTSUP if the message is not known.
110 
 *  @returns Other error codes as defined for the specific module message implementation.
111 
 */
4243 mejdrech 112 
int netif_specific_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
4350 mejdrech 113 
 
114 
/** Returns the device usage statistics.
4756 mejdrech 115 
 *  @param[in] device_id The device identifier.
116 
 *  @param[out] stats The device usage statistics.
4350 mejdrech 117 
 *  @returns EOK on success.
118 
 *  @returns Other error codes as defined for the find_device() function.
119 
 *  @returns Other error codes as defined for the specific module message implementation.
120 
 */
4243 mejdrech 121 
int netif_get_device_stats( device_id_t device_id, device_stats_ref stats );
4192 mejdrech 122 
 
123 
#endif
124 
 
125 
/** @}
126 
 */