/*
* Copyright (c) 2009 Lukas Mejdrech
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** @addtogroup ip
* @{
*/
/** @file
* Internet protocol interface.
* The same interface is used for standalone remote modules as well as for bundle modules.
* The standalone remote modules have to be compiled with the ip_remote.c source file.
* The bundle modules with the ip.c source file.
*/
#ifndef __NET_IP_INTERFACE_H__
#define __NET_IP_INTERFACE_H__
#include <async.h>
#include <ipc/services.h>
#include "../include/device.h"
#include "../structures/packet/packet.h"
/** \todo
*/
int ip_bind_service( services_t service, services_t me, async_client_conn_t receiver );
/** Registers the new device.
* Registers itself as the ip packet receiver.
* If the device uses ARP registers also the new ARP device.
* @param ip_phone The IP module phone used for (semi)remote calls. Input parameter.
* @param device_id The new device identifier. Input parameter.
* @param netif The underlying device network interface layer service. Input parameter.
* @returns EOK on success.
* @returns ENOMEM if there is not enough memory left.
* @returns EINVAL if the device configuration is invalid.
* @returns ENOTSUP if the device uses IPv6.
* @returns ENOTSUP if the device uses DHCP.
* @returns Other error codes as defined for the net_get_device_conf_req() function.
* @returns Other error codes as defined for the arp_device_req() function.
*/
int ip_device_req( int ip_phone, device_id_t device_id, services_t netif );
/** Sends the packet queue.
* @param ip_phone The internet protocol phone. Input parameter.
* @param device_id The device identifier. Input parameter.
* @param packet The packet queue. Input parameter.
* @param sender The sending module service. Input parameter.
* @returns EOK on success.
* @returns Other error codes as defined for the generic_send_msg() function.
*/
int ip_send_msg( int ip_phone, device_id_t device_id, packet_t packet, services_t sender );
/** Connects to the IP module.
* @param service The IP module service. Ignored parameter.
* @returns The IP module phone on success.
* @returns 0 if called by the bundle module.
*/
int ip_connect_module( services_t service );
#endif
/** @}
*/