Rev 4707 | Rev 4722 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4707 | Rev 4720 | ||
---|---|---|---|
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 | 52 | ||
53 | /** @name IP module interface |
53 | /** @name IP module interface |
54 | * This interface is used by other modules. |
54 | * This interface is used by other modules. |
55 | */ |
55 | */ |
56 | /*@{*/ |
56 | /*@{*/ |
57 | 57 | ||
58 | /** The transport layer notification function type definition. |
58 | /** The transport layer notification function type definition. |
59 | * Notifies the transport layer modules about the received packet/s. |
59 | * Notifies the transport layer modules about the received packet/s. |
60 | * @param device_id The device identifier. Input parameter. |
60 | * @param device_id The device identifier. Input parameter. |
61 | * @param packet The received packet or the received packet queue. Input parameter. |
61 | * @param packet The received packet or the received packet queue. Input parameter. |
62 | * @param receiver The receiving module service. Input parameter. |
62 | * @param receiver The receiving module service. Input parameter. |
63 | * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
63 | * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
64 | * @returns EOK on success. |
64 | * @returns EOK on success. |
65 | */ |
65 | */ |
66 | typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver, services_t error ); |
66 | typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver, services_t error ); |
67 | 67 | ||
68 | /** Creates bidirectional connection with the ip module service and registers the message receiver. |
68 | /** Creates bidirectional connection with the ip module service and registers the message receiver. |
69 | * @param service The IP module service. Input parameter. |
69 | * @param service The IP module service. Input parameter. |
70 | * @param protocol The transport layer protocol. Input parameter. |
70 | * @param protocol The transport layer protocol. Input parameter. |
71 | * @param me The requesting module service. Input parameter. |
71 | * @param me The requesting module service. Input parameter. |
72 | * @param receiver The message receiver. Used for remote connection. Input parameter. |
72 | * @param receiver The message receiver. Used for remote connection. Input parameter. |
73 | * @param tl_received_msg The message processing function. Used if bundled together. Input parameter. |
73 | * @param tl_received_msg The message processing function. Used if bundled together. Input parameter. |
74 | * @returns The phone of the needed service. |
74 | * @returns The phone of the needed service. |
75 | * @returns EOK on success. |
75 | * @returns EOK on success. |
76 | * @returns Other error codes as defined for the bind_service() function. |
76 | * @returns Other error codes as defined for the bind_service() function. |
77 | */ |
77 | */ |
78 | int ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg ); |
78 | int ip_bind_service( services_t service, int protocol, services_t me, async_client_conn_t receiver, tl_received_msg_t tl_received_msg ); |
79 | 79 | ||
80 | /** Registers the new device. |
80 | /** Registers the new device. |
81 | * Registers itself as the ip packet receiver. |
81 | * Registers itself as the ip packet receiver. |
82 | * If the device uses ARP registers also the new ARP device. |
82 | * If the device uses ARP registers also the new ARP device. |
83 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
83 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
84 | * @param device_id The new device identifier. Input parameter. |
84 | * @param device_id The new device identifier. Input parameter. |
85 | * @param netif The underlying device network interface layer service. Input parameter. |
85 | * @param netif The underlying device network interface layer service. Input parameter. |
86 | * @returns EOK on success. |
86 | * @returns EOK on success. |
87 | * @returns ENOMEM if there is not enough memory left. |
87 | * @returns ENOMEM if there is not enough memory left. |
88 | * @returns EINVAL if the device configuration is invalid. |
88 | * @returns EINVAL if the device configuration is invalid. |
89 | * @returns ENOTSUP if the device uses IPv6. |
89 | * @returns ENOTSUP if the device uses IPv6. |
90 | * @returns ENOTSUP if the device uses DHCP. |
90 | * @returns ENOTSUP if the device uses DHCP. |
91 | * @returns Other error codes as defined for the net_get_device_conf_req() function. |
91 | * @returns Other error codes as defined for the net_get_device_conf_req() function. |
92 | * @returns Other error codes as defined for the arp_device_req() function. |
92 | * @returns Other error codes as defined for the arp_device_req() function. |
93 | */ |
93 | */ |
94 | int ip_device_req( int ip_phone, device_id_t device_id, services_t netif ); |
94 | int ip_device_req( int ip_phone, device_id_t device_id, services_t netif ); |
95 | 95 | ||
96 | /** Sends the packet queue. |
96 | /** Sends the packet queue. |
97 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
97 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
98 | * @param device_id The device identifier. Input parameter. |
98 | * @param device_id The device identifier. Input parameter. |
99 | * @param packet The packet queue. Input parameter. |
99 | * @param packet The packet queue. Input parameter. |
100 | * @param sender The sending module service. Input parameter. |
100 | * @param sender The sending module service. Input parameter. |
101 | * @param target The target transport layer module service to be delivered to. Input parameter. |
101 | * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
102 | * @returns EOK on success. |
102 | * @returns EOK on success. |
103 | * @returns Other error codes as defined for the generic_send_msg() function. |
103 | * @returns Other error codes as defined for the generic_send_msg() function. |
104 | */ |
104 | */ |
105 | int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender, services_t error ); |
105 | int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender, services_t error ); |
106 | 106 | ||
107 | /** Connects to the IP module. |
107 | /** Connects to the IP module. |
108 | * @param service The IP module service. Ignored parameter. |
108 | * @param service The IP module service. Ignored parameter. |
109 | * @returns The IP module phone on success. |
109 | * @returns The IP module phone on success. |
110 | * @returns 0 if called by the bundle module. |
110 | * @returns 0 if called by the bundle module. |
111 | */ |
111 | */ |
112 | int ip_connect_module( services_t service ); |
112 | int ip_connect_module( services_t service ); |
113 | 113 | ||
114 | /** Adds a route to the device routing table. |
114 | /** Adds a route to the device routing table. |
115 | * The target network is routed using this device. |
115 | * The target network is routed using this device. |
116 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
116 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
117 | * @param device_id The device identifier. Input parameter. |
117 | * @param device_id The device identifier. Input parameter. |
118 | * @param address The target network address. Input parameter. |
118 | * @param address The target network address. Input parameter. |
119 | * @param netmask The target network mask. Input parameter. |
119 | * @param netmask The target network mask. Input parameter. |
120 | * @param gateway The target network gateway. Not used if zero. Input parameter. |
120 | * @param gateway The target network gateway. Not used if zero. Input parameter. |
121 | */ |
121 | */ |
122 | 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 ); |
122 | 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 ); |
123 | 123 | ||
124 | /** Sets the default gateway. |
124 | /** Sets the default gateway. |
125 | * This gateway is used if no other route is found. |
125 | * This gateway is used if no other route is found. |
126 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
126 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
127 | * @param device_id The device identifier. Input parameter. |
127 | * @param device_id The device identifier. Input parameter. |
128 | * @param gateway The default gateway. Input parameter. |
128 | * @param gateway The default gateway. Input parameter. |
129 | */ |
129 | */ |
130 | int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway ); |
130 | int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway ); |
131 | 131 | ||
132 | /** Returns the device packet dimensions for sending. |
132 | /** Returns the device packet dimensions for sending. |
133 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
133 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
134 | * @param device_id The device identifier. Input parameter. |
134 | * @param device_id The device identifier. Input parameter. |
135 | * @param addr_len The minimum reserved address length. Output parameter. |
135 | * @param addr_len The minimum reserved address length. Output parameter. |
136 | * @param prefix The minimum reserved prefix size. Output parameter. |
136 | * @param prefix The minimum reserved prefix size. Output parameter. |
137 | * @param content The maximum content size. Output parameter. |
137 | * @param content The maximum content size. Output parameter. |
138 | * @param suffix The minimum reserved suffix size. Output parameter. |
138 | * @param suffix The minimum reserved suffix size. Output parameter. |
139 | * @returns EOK on success. |
139 | * @returns EOK on success. |
140 | * @returns EBADMEM if either one of the parameters is NULL. |
140 | * @returns EBADMEM if either one of the parameters is NULL. |
141 | * @returns ENOENT if there is no such device. |
141 | * @returns ENOENT if there is no such device. |
142 | * @returns Other error codes as defined for the generic_packet_size_req() function. |
142 | * @returns Other error codes as defined for the generic_packet_size_req() function. |
143 | */ |
143 | */ |
144 | 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 ); |
144 | 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 ); |
145 | 145 | ||
146 | /** Notifies the IP module about the received error notification packet. |
146 | /** Notifies the IP module about the received error notification packet. |
147 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
147 | * @param ip_phone The IP module phone used for (semi)remote calls. Input parameter. |
148 | * @param device_id The device identifier. Input parameter. |
148 | * @param device_id The device identifier. Input parameter. |
149 | * @param packet The received packet or the received packet queue. Input parameter. |
149 | * @param packet The received packet or the received packet queue. Input parameter. |
150 | * @param target The target internetwork module service to be delivered to. Input parameter. |
150 | * @param target The target internetwork module service to be delivered to. Input parameter. |
151 | * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
151 | * @param error The packet error reporting service. Prefixes the received packet. Input parameter. |
152 | * @returns EOK on success. |
152 | * @returns EOK on success. |
153 | */ |
153 | */ |
154 | int ip_received_error_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ); |
154 | int ip_received_error_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t target, services_t error ); |
155 | 155 | ||
156 | /*@}*/ |
156 | /*@}*/ |
157 | 157 | ||
158 | #endif |
158 | #endif |
159 | 159 | ||
160 | /** @} |
160 | /** @} |
161 | */ |
161 | */ |
162 | 162 |