Subversion Repositories HelenOS

Rev

Rev 4731 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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