Subversion Repositories HelenOS

Rev

Rev 4350 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  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 netif
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Network interface module interface.
  35.  *  The same interface is used for standalone remote modules as well as for bundle network interface layer modules.
  36.  *  The standalone remote modules have to be compiled with the netif_remote.c source file.
  37.  *  The bundle network interface layer modules are compiled with the netif_nil_bundle.c source file and the choosen network interface layer implementation source file.
  38.  */
  39.  
  40. #ifndef __NET_NETIF_INTERFACE_H__
  41. #define __NET_NETIF_INTERFACE_H__
  42.  
  43. #include <ipc/services.h>
  44.  
  45. #include "../messages.h"
  46.  
  47. #include "../structures/measured_strings.h"
  48. #include "../structures/packet/packet.h"
  49.  
  50. #include "device.h"
  51.  
  52. /** @name Network interface module interface
  53.  *  This interface is used by other modules.
  54.  */
  55. /*@{*/
  56.  
  57. /** Returns the device local hardware address.
  58.  *  @param netif_phone The network interface phone. Input parameter.
  59.  *  @param device_id The device identifier. Input parameter.
  60.  *  @param address The device local hardware address. Output parameter.
  61.  *  @param data The address data. Output parameter.
  62.  *  @returns EOK on success.
  63.  *  @returns EBADMEM if the address parameter is NULL.
  64.  *  @returns ENOENT if there no such device.
  65.  *  @returns Other error codes as defined for the netif_get_addr() function.
  66.  */
  67. int netif_get_addr( int netif_phone, device_id_t device_id, measured_string_ref * address, char ** data );
  68.  
  69. /** Probes the existence of the device.
  70.  *  @param netif_phone The network interface phone. Input parameter.
  71.  *  @param device_id The device identifier. Input parameter.
  72.  *  @param irq The device interrupt number. Input parameter.
  73.  *  @param io The device input/output address. Input parameter.
  74.  *  @returns EOK on success.
  75.  *  @returns Other errro codes as defined for the netif_probe_message().
  76.  */
  77. int netif_probe_req( int netif_phone, device_id_t device_id, int irq, int io );
  78.  
  79. /** Sends the packet queue.
  80.  *  @param netif_phone The network interface phone. Input parameter.
  81.  *  @param device_id The device identifier. Input parameter.
  82.  *  @param packet The packet queue. Input parameter.
  83.  *  @param sender The sending module service. Input parameter.
  84.  *  @returns EOK on success.
  85.  *  @returns Other error codes as defined for the generic_send_msg() function.
  86.  */
  87. int netif_send_msg( int netif_phone, device_id_t device_id, packet_t packet, services_t sender );
  88.  
  89. /** Starts the device.
  90.  *  @param netif_phone The network interface phone. Input parameter.
  91.  *  @param device_id The device identifier. Input parameter.
  92.  *  @returns EOK on success.
  93.  *  @returns Other error codes as defined for the find_device() function.
  94.  *  @returns Other error codes as defined for the netif_start_message() function.
  95.  */
  96. int netif_start_req( int netif_phone, device_id_t device_id );
  97.  
  98. /** Stops the device.
  99.  *  @param netif_phone The network interface phone. Input parameter.
  100.  *  @param device_id The device identifier. Input parameter.
  101.  *  @returns EOK on success.
  102.  *  @returns Other error codes as defined for the find_device() function.
  103.  *  @returns Other error codes as defined for the netif_stop_message() function.
  104.  */
  105. int netif_stop_req( int netif_phone, device_id_t device_id );
  106.  
  107. /** Returns the device usage statistics.
  108.  *  @param netif_phone The network interface phone. Input parameter.
  109.  *  @param device_id The device identifier. Input parameter.
  110.  *  @param stats The device usage statistics. Output parameter.
  111.  *  @returns EOK on success.
  112.  */
  113. int netif_stats_req( int netif_phone, device_id_t device_id, device_stats_ref stats );
  114.  
  115. /** Creates bidirectional connection with the network interface module service and registers the message receiver.
  116.  *  @param service The network interface module service. Input parameter.
  117.  *  @param device_id The device identifier. Input parameter.
  118.  *  @param me The requesting module service. Input parameter.
  119.  *  @param receiver The message receiver. Input parameter.
  120.  *  @returns The phone of the needed service.
  121.  *  @returns EOK on success.
  122.  *  @returns Other error codes as defined for the bind_service() function.
  123.  */
  124. int netif_bind_service( services_t service, device_id_t device_id, services_t me, async_client_conn_t receiver );
  125.  
  126. /*@}*/
  127.  
  128. #endif
  129.  
  130. /** @}
  131.  */
  132.