drivers/net/sfc/sfc_kvargs.h

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