Subversion Repositories HelenOS

Rev

Rev 3912 | Go to most recent revision | Blame | 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.  *  Device identifier, state and usage statistics.
  35.  */
  36.  
  37. #ifndef __NET_DEVICE_ID_TYPE_H__
  38. #define __NET_DEVICE_ID_TYPE_H__
  39.  
  40. #include "../structures/int_map.h"
  41.  
  42. #define DEVICE_MAP_DECLARE  INT_MAP_DECLARE
  43. #define DEVICE_MAP_IMPLEMENT    INT_MAP_IMPLEMENT
  44.  
  45. /** Device identifier type.
  46.  */
  47. typedef int device_id_t;
  48.  
  49. /** Device state type.
  50.  */
  51. typedef enum device_state   device_state_t;
  52.  
  53. /** Type definition of the device usage statistics.
  54.  *  @see device_stats
  55.  */
  56. typedef struct device_stats device_stats_t;
  57.  
  58. /** Type definition of the device usage statistics pointer.
  59.  *  @see device_stats
  60.  */
  61. typedef device_stats_t *    device_stats_ref;
  62.  
  63. /** Device state.
  64.  */
  65. enum    device_state{
  66.     /** Device not present or not initialized.
  67.      */
  68.     NETIF_NULL = 0,
  69.     /** Device present and stopped.
  70.      */
  71.     NETIF_STOPPED,
  72.     /** Device present and active.
  73.      */
  74.     NETIF_ACTIVE,
  75.     /** Device present but unable to transmit.
  76.      */
  77.     NETIF_CARRIER_LOST
  78. };
  79.  
  80. /** \todo
  81.  */
  82. #define NIFF_UP         ( 1 << 0 )
  83. #define NIFF_NOARP      ( 1 << 1 )
  84. #define NIFF_LOOPBACK   ( 1 << 2 )
  85. #define NIFF_BROADCAST  ( 1 << 3 )
  86. #define NIFF_PROMISC    ( 1 << 4 )
  87. #define NIFF_MULTICAST  ( 1 << 5 )
  88.  
  89. /** Device usage statistics.
  90.  *  Based on linux_kernel/include/linux/netdevice.h.
  91.  */
  92. struct  device_stats{
  93.     /** Total packets received.
  94.      */
  95.     unsigned long   rx_packets;
  96.     /** Total packets transmitted.
  97.      */
  98.     unsigned long   tx_packets;
  99.     /** Total bytes received.
  100.      */
  101.     unsigned long   rx_bytes;
  102.     /** Total bytes transmitted.
  103.      */
  104.     unsigned long   tx_bytes;
  105.     /** Bad packets received counter.
  106.      */
  107.     unsigned long   rx_errors;
  108.     /** Packet transmition problems counter.
  109.      */
  110.     unsigned long   tx_errors;
  111.     /** No space in buffers counter.
  112.      */
  113.     unsigned long   rx_dropped;
  114.     /** No space available counter.
  115.      */
  116.     unsigned long   tx_dropped;
  117.     /** Total multicast packets received.
  118.      */
  119.     unsigned long   multicast;
  120.     /** The number of collisions due to congestion on the medium.
  121.      */
  122.     unsigned long   collisions;
  123.  
  124.     /* detailed rx_errors: */
  125.     /** Received packet length error counter.
  126.      */
  127.     unsigned long   rx_length_errors;
  128.     /** Receiver buffer overflow counter.
  129.      */
  130.     unsigned long   rx_over_errors;
  131.     /** Received packet with crc error counter.
  132.      */
  133.     unsigned long   rx_crc_errors;
  134.     /** Received frame alignment error counter.
  135.      */
  136.     unsigned long   rx_frame_errors;
  137.     /** Receiver fifo overrun counter.
  138.      */
  139.     unsigned long   rx_fifo_errors;
  140.     /** Receiver missed packet counter.
  141.      */
  142.     unsigned long   rx_missed_errors;
  143.  
  144.     /* detailed tx_errors */
  145.     /** Transmitter aborted counter.
  146.      */
  147.     unsigned long   tx_aborted_errors;
  148.     /** Transmitter carrier errors counter.
  149.      */
  150.     unsigned long   tx_carrier_errors;
  151.     /** Transmitter fifo overrun counter.
  152.      */
  153.     unsigned long   tx_fifo_errors;
  154.     /** Transmitter carrier errors counter.
  155.      */
  156.     unsigned long   tx_heartbeat_errors;
  157.     /** Transmitter window errors counter.
  158.      */
  159.     unsigned long   tx_window_errors;
  160.  
  161.     /* for cslip etc */
  162.     /** Total compressed packets received.
  163.      */
  164.     unsigned long   rx_compressed;
  165.     /** Total compressed packet transmitted.
  166.      */
  167.     unsigned long   tx_compressed;
  168. };
  169.  
  170. #endif
  171.  
  172. /** @}
  173.  */
  174.  
  175.