Subversion Repositories HelenOS

Rev

Rev 4703 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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