sys/netgraph7/ng_async.h

   1 /*
   2  * ng_async.h
   3  */
   4
   5 /*-
   6  * Copyright (c) 1996-1999 Whistle Communications, Inc.
   7  * All rights reserved.
   8  *
   9  * Subject to the following obligations and disclaimer of warranty, use and
  10  * redistribution of this software, in source or object code forms, with or
  11  * without modifications are expressly permitted by Whistle Communications;
  12  * provided, however, that:
  13  * 1. Any and all reproductions of the source or object code must include the
  14  *    copyright notice above and the following disclaimer of warranties; and
  15  * 2. No rights are granted, in any manner or form, to use Whistle
  16  *    Communications, Inc. trademarks, including the mark "WHISTLE
  17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  18  *    such appears in the above copyright notice or in the software.
  19  *
  20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  36  * OF SUCH DAMAGE.
  37  *
  38  * Author: Archie Cobbs <archie@freebsd.org>
  39  *
  40  * $FreeBSD: src/sys/netgraph/ng_async.h,v 1.11 2005/01/07 01:45:39 imp Exp $
  41  * $DragonFly: src/sys/netgraph7/ng_async.h,v 1.2 2008/06/26 23:05:35 dillon Exp $
  42  * $Whistle: ng_async.h,v 1.5 1999/01/25 01:17:14 archie Exp $
  43  */
  44
  45 #ifndef _NETGRAPH_NG_ASYNC_H_
  46 #define _NETGRAPH_NG_ASYNC_H_
  47
  48 /* Type name and cookie */
  49 #define NG_ASYNC_NODE_TYPE      "async"
  50 #define NGM_ASYNC_COOKIE        886473717
  51
  52 /* Hook names */
  53 #define NG_ASYNC_HOOK_SYNC      "sync"  /* Sync frames */
  54 #define NG_ASYNC_HOOK_ASYNC     "async" /* Async-encoded frames */
  55
  56 /* Maximum receive size bounds (for both sync and async sides) */
  57 #define NG_ASYNC_MIN_MRU        1
  58 #define NG_ASYNC_MAX_MRU        8192
  59 #define NG_ASYNC_DEFAULT_MRU    1600
  60
  61 /* Frame statistics */
  62 struct ng_async_stat {
  63         u_int32_t       syncOctets;
  64         u_int32_t       syncFrames;
  65         u_int32_t       syncOverflows;
  66         u_int32_t       asyncOctets;
  67         u_int32_t       asyncFrames;
  68         u_int32_t       asyncRunts;
  69         u_int32_t       asyncOverflows;
  70         u_int32_t       asyncBadCheckSums;
  71 };
  72
  73 /* Keep this in sync with the above structure definition */
  74 #define NG_ASYNC_STATS_TYPE_INFO        {                       \
  75           { "syncOctets",       &ng_parse_uint32_type   },      \
  76           { "syncFrames",       &ng_parse_uint32_type   },      \
  77           { "syncOverflows",    &ng_parse_uint32_type   },      \
  78           { "asyncOctets",      &ng_parse_uint32_type   },      \
  79           { "asyncFrames",      &ng_parse_uint32_type   },      \
  80           { "asyncRunts",       &ng_parse_uint32_type   },      \
  81           { "asyncOverflows",   &ng_parse_uint32_type   },      \
  82           { "asyncBadCheckSums",&ng_parse_uint32_type   },      \
  83           { NULL }                                              \
  84 }
  85
  86 /* Configuration for this node */
  87 struct ng_async_cfg {
  88         u_char          enabled;        /* Turn encoding on/off */
  89         u_int16_t       amru;           /* Max receive async frame length */
  90         u_int16_t       smru;           /* Max receive sync frame length */
  91         u_int32_t       accm;           /* ACCM encoding */
  92 };
  93
  94 /* Keep this in sync with the above structure definition */
  95 #define NG_ASYNC_CONFIG_TYPE_INFO       {                       \
  96           { "enabled",          &ng_parse_int8_type     },      \
  97           { "amru",             &ng_parse_uint16_type   },      \
  98           { "smru",             &ng_parse_uint16_type   },      \
  99           { "accm",             &ng_parse_hint32_type   },      \
 100           { NULL }                                              \
 101 }
 102
 103 /* Commands */
 104 enum {
 105         NGM_ASYNC_CMD_GET_STATS = 1,    /* returns struct ng_async_stat */
 106         NGM_ASYNC_CMD_CLR_STATS,
 107         NGM_ASYNC_CMD_SET_CONFIG,       /* takes struct ng_async_cfg */
 108         NGM_ASYNC_CMD_GET_CONFIG,       /* returns struct ng_async_cfg */
 109 };
 110
 111 #endif /* _NETGRAPH_NG_ASYNC_H_ */