Subversion Repositories HelenOS

Rev

Rev 4163 | Rev 4261 | 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 skeleton.
  35.  */
  36.  
  37. #ifndef __NET_NETIF_H__
  38. #define __NET_NETIF_H__
  39.  
  40. #include <rwlock.h>
  41.  
  42. #include "device.h"
  43.  
  44. /** Sends the notification message to the registered network interface layer module.
  45.  *  Wrapper of the async_msg_3().
  46.  *  The first message argument is always the device identifier.
  47.  *  @param device The device specific data. Input parameter.
  48.  *  @param message The message to be sent. Input parameter.
  49.  *  @param arg2 The second message argument. Input parameter.
  50.  *  @param arg3 The third message argument. Input parameter.
  51.  */
  52. #define nil_message( device, message, arg2, arg3 )  \
  53.     if(( device )->nil_phone >= 0 ) async_msg_3(( device )->nil_phone, ( message ), ( device )->device_id, arg2, arg3 )
  54.  
  55. /** Network interface module skeleton global data.
  56.  */
  57. typedef struct netif_globals    netif_globals_t;
  58.  
  59. /** Type definition of the device specific data.
  60.  *  @see netif_device
  61.  */
  62. typedef struct netif_device device_t;
  63.  
  64. /** Type definition of the device specific data pointer.
  65.  *  @see netif_device
  66.  */
  67. typedef device_t *          device_ref;
  68.  
  69. /** Device map.
  70.  *  Maps device identifiers to the network interface device specific data.
  71.  *  @see device.h
  72.  */
  73. DEVICE_MAP_DECLARE( device_map, device_t );
  74.  
  75. /** Network interface device specific data.
  76.  */
  77. struct  netif_device{
  78.     /** Device identifier.
  79.      */
  80.     device_id_t device_id;
  81.     /** Receiving network interface layer phone.
  82.      */
  83.     int     nil_phone;
  84.     /** Actual device state.
  85.      */
  86.     device_state_t  state;
  87.     /** Driver specific data.
  88.      */
  89.     void *      specific;
  90. };
  91.  
  92. /** Network interface module skeleton global data.
  93.  */
  94. struct  netif_globals{
  95.     /** Networking module phone.
  96.      */
  97.     int     networking_phone;
  98.     /** Device map.
  99.      */
  100.     device_map_t    device_map;
  101.     /** Safety lock.
  102.      */
  103.     rwlock_t    lock;
  104. };
  105.  
  106. /** Finds the device specific data.
  107.  *  @param device_id The device identifier. Input parameter.
  108.  *  @param device The device specific data. Output parameter.
  109.  *  @returns EOK on success.
  110.  *  @returns ENOENT if device is not found.
  111.  *  @returns EPERM if the device is not initialized.
  112.  */
  113. int find_device( device_id_t device_id, device_ref * device );
  114.  
  115. /** Clears the usage statistics.
  116.  *  @param stats The usage statistics. Input parameter.
  117.  */
  118. void    null_device_stats( device_stats_ref stats );
  119.  
  120. // prepared for future optimalizations
  121. /** \todo
  122.  */
  123. void    netif_pq_release( packet_id_t packet );
  124.  
  125. /** \todo
  126.  */
  127. packet_t netif_packet_get_1( size_t content );
  128.  
  129. #endif
  130.  
  131. /** @}
  132.  */
  133.  
  134.