Subversion Repositories HelenOS

Rev

Rev 4351 | Rev 4582 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3846 mejdrech 1
/*
3912 mejdrech 2
 * Copyright (c) 2009 Lukas Mejdrech
3846 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 arp
30
 *  @{
31
 */
32
 
33
/** @file
3912 mejdrech 34
 *  ARP module.
3846 mejdrech 35
 */
36
 
37
#ifndef __NET_ARP_H__
38
#define __NET_ARP_H__
39
 
3991 mejdrech 40
#include <rwlock.h>
41
 
3846 mejdrech 42
#include <ipc/ipc.h>
4261 mejdrech 43
#include <ipc/services.h>
3846 mejdrech 44
 
4243 mejdrech 45
#include "../../include/device.h"
4558 mejdrech 46
#include "../../include/hardware.h"
3846 mejdrech 47
 
3886 mejdrech 48
#include "../../structures/generic_char_map.h"
49
#include "../../structures/int_map.h"
50
#include "../../structures/measured_strings.h"
3846 mejdrech 51
 
3912 mejdrech 52
 
53
/** Type definition of the ARP global data.
54
 *  @see arp_globals
55
 */
3846 mejdrech 56
typedef struct arp_globals  arp_globals_t;
3912 mejdrech 57
 
58
/** Type definition of the ARP device specific data.
59
 *  @see arp_device
60
 */
3846 mejdrech 61
typedef struct arp_device   arp_device_t;
3912 mejdrech 62
 
63
/** Type definition of the ARP device specific data pointer.
64
 *  @see arp_device
65
 */
3846 mejdrech 66
typedef arp_device_t *      arp_device_ref;
3912 mejdrech 67
 
68
/** Type definition of the ARP protocol specific data.
69
 *  @see arp_proto
70
 */
3846 mejdrech 71
typedef struct arp_proto    arp_proto_t;
3912 mejdrech 72
 
73
/** Type definition of the ARP protocol specific data pointer.
74
 *  @see arp_proto
75
 */
3846 mejdrech 76
typedef arp_proto_t *       arp_proto_ref;
77
 
3912 mejdrech 78
/** ARP address cache.
79
 *  Maps devices to the ARP device specific data.
80
 *  @see device.h
81
 */
3846 mejdrech 82
DEVICE_MAP_DECLARE( arp_cache, arp_device_t )
83
 
3912 mejdrech 84
/** ARP protocol map.
85
 *  Maps protocol identifiers to the ARP protocol specific data.
86
 *  @see int_map.h
87
 */
3846 mejdrech 88
INT_MAP_DECLARE( arp_protos, arp_proto_t )
89
 
3912 mejdrech 90
/** ARP address map.
91
 *  Translates addresses.
92
 *  @see generic_char_map.h
93
 */
3846 mejdrech 94
GENERIC_CHAR_MAP_DECLARE( arp_addr, measured_string_t )
95
 
3912 mejdrech 96
/** ARP device specific data.
97
 */
3846 mejdrech 98
struct arp_device{
3912 mejdrech 99
    /** Device identifier.
100
     */
3846 mejdrech 101
    device_id_t         device_id;
3912 mejdrech 102
    /** Hardware type.
103
     */
4558 mejdrech 104
    hw_type_t           hardware;
3912 mejdrech 105
    /** Reserved packet prefix length.
106
     */
4261 mejdrech 107
    size_t              prefix;
3912 mejdrech 108
    /** Maximal packet content length.
109
     */
4261 mejdrech 110
    size_t              content;
3912 mejdrech 111
    /** Reserved packet suffix length.
112
     */
4261 mejdrech 113
    size_t              suffix;
3912 mejdrech 114
    /** Packet address length.
115
     *  The hardware address length is used.
116
     */
4261 mejdrech 117
    size_t              addr_len;
3912 mejdrech 118
    /** Actual device hardware address.
119
     */
3846 mejdrech 120
    measured_string_ref addr;
3912 mejdrech 121
    /** Actual device hardware address data.
122
     */
3846 mejdrech 123
    char *              addr_data;
3912 mejdrech 124
    /** Broadcast device hardware address.
125
     */
3846 mejdrech 126
    measured_string_ref broadcast_addr;
3912 mejdrech 127
    /** Broadcast device hardware address data.
128
     */
3846 mejdrech 129
    char *              broadcast_data;
3912 mejdrech 130
    /** Device driver service.
131
     */
3846 mejdrech 132
    services_t          service;
3912 mejdrech 133
    /** Driver phone.
134
     */
3846 mejdrech 135
    int                 phone;
3912 mejdrech 136
    /** Protocol map.
137
     *  Address map for each protocol.
138
     */
3846 mejdrech 139
    arp_protos_t        protos;
140
};
141
 
3912 mejdrech 142
/** ARP protocol specific data.
143
 */
3846 mejdrech 144
struct arp_proto{
3912 mejdrech 145
    /** Protocol service.
146
     */
3846 mejdrech 147
    services_t          service;
3912 mejdrech 148
    /** Actual device protocol address.
149
     */
3846 mejdrech 150
    measured_string_ref addr;
3912 mejdrech 151
    /** Actual device protocol address data.
152
     */
3846 mejdrech 153
    char *              addr_data;
3912 mejdrech 154
    /** Address map.
155
     */
3846 mejdrech 156
    arp_addr_t          addresses;
157
};
158
 
3912 mejdrech 159
/** ARP global data.
160
 */
3846 mejdrech 161
struct  arp_globals{
3912 mejdrech 162
    /** Networking module phone.
163
     */
4307 mejdrech 164
    int         net_phone;
3991 mejdrech 165
    /** Safety lock.
166
     */
167
    rwlock_t        lock;
3912 mejdrech 168
    /** ARP address cache.
169
     */
3846 mejdrech 170
    arp_cache_t cache;
4351 mejdrech 171
    /** The client connection processing function.
172
     *  The module skeleton propagates its own one.
173
     */
174
    async_client_conn_t client_connection;
3846 mejdrech 175
};
176
 
177
#endif
178
 
179
/** @}
180
 */