Subversion Repositories HelenOS

Rev

Rev 4505 | Rev 4704 | 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
4350 mejdrech 34
 *  Internet protocol interface.
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"
4505 mejdrech 52
 
53
/** The transport layer notification function type definition.
54
 *  Notifies the transport layer modules about the received packet/s.
55
 *  @param device_id The device identifier. Input parameter.
56
 *  @param packet The received packet or the received packet queue. Input parameter.
57
 *  @param receiver The receiving module service. Input parameter.
58
 *  @returns EOK on success.
59
 */
60
typedef int ( * tl_received_msg_t )( device_id_t device_id, packet_t packet, services_t receiver );
61
 
4350 mejdrech 62
/** \todo
63
 */
4505 mejdrech 64
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 65
 
66
/** Registers the new device.
67
 *  Registers itself as the ip packet receiver.
68
 *  If the device uses ARP registers also the new ARP device.
69
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
70
 *  @param device_id The new device identifier. Input parameter.
71
 *  @param netif The underlying device network interface layer service. Input parameter.
72
 *  @returns EOK on success.
73
 *  @returns ENOMEM if there is not enough memory left.
74
 *  @returns EINVAL if the device configuration is invalid.
75
 *  @returns ENOTSUP if the device uses IPv6.
76
 *  @returns ENOTSUP if the device uses DHCP.
77
 *  @returns Other error codes as defined for the net_get_device_conf_req() function.
78
 *  @returns Other error codes as defined for the arp_device_req() function.
79
 */
80
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
81
 
4351 mejdrech 82
/** Sends the packet queue.
83
 *  @param ip_phone The internet protocol phone. Input parameter.
84
 *  @param device_id The device identifier. Input parameter.
85
 *  @param packet The packet queue. Input parameter.
86
 *  @param sender The sending module service. Input parameter.
87
 *  @returns EOK on success.
88
 *  @returns Other error codes as defined for the generic_send_msg() function.
4350 mejdrech 89
 */
4307 mejdrech 90
int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
4350 mejdrech 91
 
92
/** Connects to the IP module.
93
 *  @param service The IP module service. Ignored parameter.
94
 *  @returns The IP module phone on success.
95
 *  @returns 0 if called by the bundle module.
96
 */
4307 mejdrech 97
int ip_connect_module( services_t service );
98
 
4505 mejdrech 99
/** \todo
100
 */
101
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 );
102
 
103
/** \todo
104
 */
105
int ip_set_gateway_req( int ip_phone, device_id_t device_id, in_addr_t gateway );
106
 
107
/** \todo
108
 */
109
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 );
110
 
4307 mejdrech 111
#endif
112
 
113
/** @}
114
 */