drivers/net/sfc/sfc_kvargs.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  * Copyright (c) 2016-2017 Solarflare Communications Inc.
   5  * All rights reserved.
   6  *
   7  * This software was jointly developed between OKTET Labs (under contract
   8  * for Solarflare) and Solarflare Communications, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions are met:
  12  *
  13  * 1. Redistributions of source code must retain the above copyright notice,
  14  *    this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright notice,
  16  *    this list of conditions and the following disclaimer in the documentation
  17  *    and/or other materials provided with the distribution.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  29  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef _SFC_KVARGS_H
  33 #define _SFC_KVARGS_H
  34
  35 #include <rte_kvargs.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #define SFC_KVARG_VALUES_BOOL           "[1|y|yes|on|0|n|no|off]"
  42
  43 #define SFC_KVARG_DEBUG_INIT            "debug_init"
  44
  45 #define SFC_KVARG_MCDI_LOGGING          "mcdi_logging"
  46
  47 #define SFC_KVARG_PERF_PROFILE          "perf_profile"
  48
  49 #define SFC_KVARG_PERF_PROFILE_AUTO             "auto"
  50 #define SFC_KVARG_PERF_PROFILE_THROUGHPUT       "throughput"
  51 #define SFC_KVARG_PERF_PROFILE_LOW_LATENCY      "low-latency"
  52 #define SFC_KVARG_VALUES_PERF_PROFILE \
  53         "[" SFC_KVARG_PERF_PROFILE_AUTO "|" \
  54             SFC_KVARG_PERF_PROFILE_THROUGHPUT "|" \
  55             SFC_KVARG_PERF_PROFILE_LOW_LATENCY "]"
  56
  57 #define SFC_KVARG_STATS_UPDATE_PERIOD_MS        "stats_update_period_ms"
  58
  59 #define SFC_KVARG_DATAPATH_EFX          "efx"
  60 #define SFC_KVARG_DATAPATH_EF10         "ef10"
  61 #define SFC_KVARG_DATAPATH_EF10_SIMPLE  "ef10_simple"
  62
  63 #define SFC_KVARG_RX_DATAPATH           "rx_datapath"
  64 #define SFC_KVARG_VALUES_RX_DATAPATH \
  65         "[" SFC_KVARG_DATAPATH_EFX "|" \
  66             SFC_KVARG_DATAPATH_EF10 "]"
  67
  68 #define SFC_KVARG_TX_DATAPATH           "tx_datapath"
  69 #define SFC_KVARG_VALUES_TX_DATAPATH \
  70         "[" SFC_KVARG_DATAPATH_EFX "|" \
  71             SFC_KVARG_DATAPATH_EF10 "|" \
  72             SFC_KVARG_DATAPATH_EF10_SIMPLE "]"
  73
  74 struct sfc_adapter;
  75
  76 int sfc_kvargs_parse(struct sfc_adapter *sa);
  77 void sfc_kvargs_cleanup(struct sfc_adapter *sa);
  78
  79 int sfc_kvargs_process(struct sfc_adapter *sa, const char *key_match,
  80                        arg_handler_t handler, void *opaque_arg);
  81
  82 int sfc_kvarg_bool_handler(const char *key, const char *value_str,
  83                            void *opaque);
  84 int sfc_kvarg_long_handler(const char *key, const char *value_str,
  85                            void *opaque);
  86 int sfc_kvarg_string_handler(const char *key, const char *value_str,
  87                              void *opaque);
  88
  89 #ifdef __cplusplus
  90 }
  91 #endif
  92
  93 #endif  /* _SFC_KVARGS_H */