Subversion Repositories HelenOS

Rev

Rev 4307 | Rev 4351 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4307 Rev 4350
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
 *  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.
34
 */
38
 */
35
 
39
 
36
#ifndef __NET_IP_INTERFACE_H__
40
#ifndef __NET_IP_INTERFACE_H__
37
#define __NET_IP_INTERFACE_H__
41
#define __NET_IP_INTERFACE_H__
38
 
42
 
39
#include <async.h>
43
#include <async.h>
40
 
44
 
41
#include <ipc/services.h>
45
#include <ipc/services.h>
42
 
46
 
43
#include "../include/device.h"
47
#include "../include/device.h"
44
 
48
 
45
#include "../structures/packet/packet.h"
49
#include "../structures/packet/packet.h"
46
 
50
 
-
 
51
/** \todo
-
 
52
 */
47
int ip_bind_service( services_t service, services_t me, async_client_conn_t receiver );
53
int ip_bind_service( services_t service, services_t me, async_client_conn_t receiver );
-
 
54
 
-
 
55
/** Registers the new device.
-
 
56
 *  Registers itself as the ip packet receiver.
-
 
57
 *  If the device uses ARP registers also the new ARP device.
-
 
58
 *  @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
-
 
59
 *  @param device_id The new device identifier. Input parameter.
-
 
60
 *  @param netif The underlying device network interface layer service. Input parameter.
-
 
61
 *  @returns EOK on success.
-
 
62
 *  @returns ENOMEM if there is not enough memory left.
-
 
63
 *  @returns EINVAL if the device configuration is invalid.
-
 
64
 *  @returns ENOTSUP if the device uses IPv6.
-
 
65
 *  @returns ENOTSUP if the device uses DHCP.
-
 
66
 *  @returns Other error codes as defined for the net_get_device_conf_req() function.
-
 
67
 *  @returns Other error codes as defined for the arp_device_req() function.
-
 
68
 */
48
int ip_device_req( int ip_phone, device_id_t device_id, services_t service );
69
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
-
 
70
 
-
 
71
/** \todo
-
 
72
 */
49
int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
73
int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
-
 
74
 
-
 
75
/** Connects to the IP module.
-
 
76
 *  @param service The IP module service. Ignored parameter.
-
 
77
 *  @returns The IP module phone on success.
-
 
78
 *  @returns 0 if called by the bundle module.
-
 
79
 */
50
int ip_connect_module( services_t service );
80
int ip_connect_module( services_t service );
51
 
81
 
52
#endif
82
#endif
53
 
83
 
54
/** @}
84
/** @}
55
 */
85
 */
56
 
86