src/vlib/defs.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 /*
  16  * defs.h: VLIB generic C definitions
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 #ifndef included_vlib_defs_h
  41 #define included_vlib_defs_h
  42
  43 /* Receive or transmit. */
  44 typedef enum
  45 {
  46   VLIB_RX,
  47   VLIB_TX,
  48   VLIB_N_RX_TX = 2,             /* Used to size arrays. */
  49 } vlib_rx_or_tx_t;
  50
  51
  52 #define vlib_foreach_rx_tx(v) for (v = 0; v < VLIB_N_RX_TX; v++)
  53
  54 /* alias the rx/tx to 'direction' */
  55 typedef vlib_rx_or_tx_t vlib_dir_t;
  56
  57 #define VLIB_N_DIR VLIB_N_RX_TX
  58 #define FOREACH_VLIB_DIR(_dir) \
  59   for (_dir = VLIB_RX; _dir <= VLIB_TX; _dir++)
  60
  61 /* Read/write. */
  62 typedef enum
  63 {
  64   VLIB_READ,
  65   VLIB_WRITE,
  66 } vlib_read_or_write_t;
  67
  68 /* Up/down. */
  69 typedef enum
  70 {
  71   VLIB_DOWN = 0,
  72   VLIB_UP = 1,
  73 } vlib_up_or_down_t;
  74
  75 /* Enable/disable. */
  76 typedef enum
  77 {
  78   VLIB_DISABLE = 0,
  79   VLIB_ENABLE = 1,
  80 } vlib_enable_or_disable_t;
  81
  82 #endif /* included_vlib_defs_h */
  83
  84 /*
  85  * fd.io coding-style-patch-verification: ON
  86  *
  87  * Local Variables:
  88  * eval: (c-set-style "gnu")
  89  * End:
  90  */