Subversion Repositories HelenOS

Rev

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