Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
4307 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 ip
30
 *  @{
31
 */
32
 
33
/** @file
4704 mejdrech 34
 *  IP module interface.
4350 mejdrech 35
 *  The same interface is used for standalone remote modules as well as for bundle modules.
36
 *  The standalone remote modules have to be compiled with the ip_remote.c source file.
37
 *  The bundle modules with the ip.c source file.
4307 mejdrech 38
 */
39
 
40
#ifndef __NET_IP_INTERFACE_H__
41
#define __NET_IP_INTERFACE_H__
42
 
43
#include <async.h>
44
 
45
#include <ipc/services.h>
46
 
47
#include "../include/device.h"
48
 
49
#include "../structures/packet/packet.h"
50
 
4575 mejdrech 51
#include "in.h"
4722 mejdrech 52
#include "ip_codes.h"
53
#include "socket_codes.h"
4505 mejdrech 54
 
4704 mejdrech 55
/** @name IP module interface
56
 *  This interface is used by other modules.
57
 */
58
/*@{*/
59
 
4722 mejdrech 60
/** Type definition of the internet pseudo header pointer.
61
 */
62
typedef void *      ip_pseudo_header_ref;
63
 
4505 mejdrech 64
/** The transport layer notification function type definition.
65
 *  Notifies the transport layer modules about the received packet/s.
66
 *  @param device_id The device identifier. Input parameter.
67
 *  @param packet The received packet or the received packet queue. Input parameter.
68
 *  @param receiver The receiving module service. Input parameter.
4707 mejdrech 69
 *  @param error The packet error reporting service. Prefixes the received packet. Input parameter.
4505 mejdrech 70
 *  @returns EOK on success.
71
 */
4707 mejdrech 72
typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver, services_t error );
4505 mejdrech 73
 
4693 mejdrech 74
/** Creates bidirectional connection with the ip module service and registers the message receiver.
4704 mejdrech 75
 *  @param service The IP module service. Input parameter.
4693 mejdrech 76
 *  @param protocol The transport layer protocol. Input parameter.
77
 *  @param me The requesting module service. Input parameter.
78
 *  @param receiver The message receiver. Used for remote connection. Input parameter.
79
 *  @param tl_received_msg The message processing function. Used if bundled together. Input parameter.
80
 *  @returns The phone of the needed service.
81
 *  @returns EOK on success.
82
 *  @returns Other error codes as defined for the bind_service() function.
4350 mejdrech 83
 */
4505 mejdrech 84
int ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg );
4350 mejdrech 85
 
86
/** Registers the new device.
87
 *  Registers itself as the ip packet receiver.
88
 *  If the device uses ARP registers also the new ARP device.
89
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
90
 *  @param device_id The new device identifier. Input parameter.
91
 *  @param netif The underlying device network interface layer service. Input parameter.
92
 *  @returns EOK on success.
93
 *  @returns ENOMEM if there is not enough memory left.
94
 *  @returns EINVAL if the device configuration is invalid.
95
 *  @returns ENOTSUP if the device uses IPv6.
96
 *  @returns ENOTSUP if the device uses DHCP.
97
 *  @returns Other error codes as defined for the net_get_device_conf_req() function.
98
 *  @returns Other error codes as defined for the arp_device_req() function.
99
 */
100
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
101
 
4351 mejdrech 102
/** Sends the packet queue.
4731 mejdrech 103
 *  The packets may get fragmented if needed.
4704 mejdrech 104
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
4351 mejdrech 105
 *  @param device_id The device identifier. Input parameter.
4731 mejdrech 106
 *  @param packet The packet fragments as a~packet queue. All the packets have to have the same destination address. Input parameter.
4351 mejdrech 107
 *  @param sender The sending module service. Input parameter.
4720 mejdrech 108
 *  @param error The packet error reporting service. Prefixes the received packet. Input parameter.
4351 mejdrech 109
 *  @returns EOK on success.
110
 *  @returns Other error codes as defined for the generic_send_msg() function.
4350 mejdrech 111
 */
4707 mejdrech 112
int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender, services_t error );
4350 mejdrech 113
 
114
/** Connects to the IP module.
115
 *  @param service The IP module service. Ignored parameter.
116
 *  @returns The IP module phone on success.
117
 *  @returns 0 if called by the bundle module.
118
 */
4307 mejdrech 119
int ip_connect_module( services_t service );
120
 
4693 mejdrech 121
/** Adds a route to the device routing table.
122
 *  The target network is routed using this device.
4704 mejdrech 123
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
4693 mejdrech 124
 *  @param device_id The device identifier. Input parameter.
125
 *  @param address The target network address. Input parameter.
126
 *  @param netmask The target network mask. Input parameter.
127
 *  @param gateway The target network gateway. Not used if zero. Input parameter.
4505 mejdrech 128
 */
129
int ip_add_route_req( int ip_phone, device_id_t device_id, in_addr_t address, in_addr_t netmask, in_addr_t gateway );
130
 
4693 mejdrech 131
/** Sets the default gateway.
132
 *  This gateway is used if no other route is found.
4704 mejdrech 133
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
4693 mejdrech 134
 *  @param device_id The device identifier. Input parameter.
135
 *  @param gateway The default gateway. Input parameter.
4505 mejdrech 136
 */
137
int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
138
 
4693 mejdrech 139
/** Returns the device packet dimensions for sending.
4704 mejdrech 140
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
4693 mejdrech 141
 *  @param device_id The device identifier. Input parameter.
142
 *  @param addr_len The minimum reserved address length. Output parameter.
143
 *  @param prefix The minimum reserved prefix size. Output parameter.
144
 *  @param content The maximum content size. Output parameter.
145
 *  @param suffix The minimum reserved suffix size. Output parameter.
146
 *  @returns EOK on success.
147
 *  @returns EBADMEM if either one of the parameters is NULL.
148
 *  @returns ENOENT if there is no such device.
149
 *  @returns Other error codes as defined for the generic_packet_size_req() function.
4505 mejdrech 150
 */
151
int ip_packet_size_req( int ip_phone, device_id_t device_id, size_t * addr_len, size_t * prefix, size_t * content, size_t * suffix );
152
 
4707 mejdrech 153
/** Notifies the IP module about the received error notification packet.
154
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
155
 *  @param device_id The device identifier. Input parameter.
156
 *  @param packet The received packet or the received packet queue. Input parameter.
157
 *  @param target The target internetwork module service to be delivered to. Input parameter.
158
 *  @param error The packet error reporting service. Prefixes the received packet. Input parameter.
159
 *  @returns EOK on success.
160
 */
161
int ip_received_error_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t target, services_t error );
162
 
4722 mejdrech 163
/** \todo
164
 */
165
int ip_get_route_req( int ip_phone, ip_protocol_t protocol, const struct sockaddr * destination, socklen_t addrlen, device_id_t * device_id, ip_pseudo_header_ref * header, size_t * headerlen );
166
 
4704 mejdrech 167
/*@}*/
168
 
4307 mejdrech 169
#endif
170
 
171
/** @}
172
 */