Subversion Repositories HelenOS

Rev

Rev 4350 | 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.
4350 mejdrech 35
 *  The skeleton has to be part of each network interface module.
36
 *  The skeleton can be also part of the module bundled with the network interface layer.
3666 mejdrech 37
 */
38
 
39
#ifndef __NET_NETIF_H__
40
#define __NET_NETIF_H__
41
 
4307 mejdrech 42
#include <async.h>
4582 mejdrech 43
#include <fibril_sync.h>
4192 mejdrech 44
 
4307 mejdrech 45
#include <ipc/ipc.h>
46
 
47
#include "../err.h"
48
 
4243 mejdrech 49
#include "../include/device.h"
3666 mejdrech 50
 
4307 mejdrech 51
#include "../structures/packet/packet.h"
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
    /** Actual device state.
83
     */
3846 mejdrech 84
    device_state_t  state;
3912 mejdrech 85
    /** Driver specific data.
86
     */
3846 mejdrech 87
    void *      specific;
3685 mejdrech 88
};
89
 
3912 mejdrech 90
/** Network interface module skeleton global data.
91
 */
3666 mejdrech 92
struct  netif_globals{
3912 mejdrech 93
    /** Networking module phone.
94
     */
4307 mejdrech 95
    int     net_phone;
3912 mejdrech 96
    /** Device map.
97
     */
3846 mejdrech 98
    device_map_t    device_map;
4192 mejdrech 99
    /** Safety lock.
100
     */
4582 mejdrech 101
    fibril_rwlock_t lock;
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
 
4192 mejdrech 118
// prepared for future optimalizations
4350 mejdrech 119
/** Releases the given packet.
120
 *  @param packet_id The packet identifier. Input parameter.
4192 mejdrech 121
 */
4350 mejdrech 122
void    netif_pq_release( packet_id_t packet_id );
4192 mejdrech 123
 
4350 mejdrech 124
/** Allocates new packet to handle the given content size.
125
 *  @param content The minimum content size. Input parameter.
126
 *  @returns The allocated packet.
127
 *  @returns NULL if there is an error.
4192 mejdrech 128
 */
129
packet_t netif_packet_get_1( size_t content );
130
 
4350 mejdrech 131
/** Processes the netif module messages.
132
 *  @param callid The message identifier. Input parameter.
133
 *  @param call The message parameters. Input parameter.
134
 *  @param answer The message answer parameters. Output parameter.
135
 *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
136
 *  @returns EOK on success.
137
 *  @returns ENOTSUP if the message is not known.
138
 *  @returns Other error codes as defined for each specific module message function.
139
 *  @see netif_interface.h
140
 *  @see IS_NET_NETIF_MESSAGE()
141
 */
4307 mejdrech 142
int netif_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
4350 mejdrech 143
 
144
/** Initializes the netif module.
145
 *  The function has to be defined in each module.
146
 *  @param client_connection The client connection functio to be registered. Input parameter.
147
 *  @returns EOK on success.
148
 *  @returns Other error codes as defined for each specific module message function.
149
 */
4307 mejdrech 150
int netif_init_module( async_client_conn_t client_connection );
4350 mejdrech 151
 
152
/** Starts and maintains the netif module until terminated.
153
 *  @returns EOK after the module is terminated.
154
 */
4307 mejdrech 155
int netif_run_module( void );
156
 
3666 mejdrech 157
#endif
158
 
159
/** @}
160
 */
161