drivers/net/bonding/bond_options.h

   1 /*
   2  * drivers/net/bond/bond_options.h - bonding options
   3  * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  */
  10
  11 #ifndef _BOND_OPTIONS_H
  12 #define _BOND_OPTIONS_H
  13
  14 #define BOND_OPT_MAX_NAMELEN 32
  15 #define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
  16 #define BOND_MODE_ALL_EX(x) (~(x))
  17
  18 /* Option flags:
  19  * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
  20  * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
  21  * BOND_OPTFLAG_RAWVAL - the option parses the value itself
  22  */
  23 enum {
  24         BOND_OPTFLAG_NOSLAVES   = BIT(0),
  25         BOND_OPTFLAG_IFDOWN     = BIT(1),
  26         BOND_OPTFLAG_RAWVAL     = BIT(2)
  27 };
  28
  29 /* Value type flags:
  30  * BOND_VALFLAG_DEFAULT - mark the value as default
  31  * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
  32  */
  33 enum {
  34         BOND_VALFLAG_DEFAULT    = BIT(0),
  35         BOND_VALFLAG_MIN        = BIT(1),
  36         BOND_VALFLAG_MAX        = BIT(2)
  37 };
  38
  39 /* Option IDs, their bit positions correspond to their IDs */
  40 enum {
  41         BOND_OPT_MODE,
  42         BOND_OPT_PACKETS_PER_SLAVE,
  43         BOND_OPT_XMIT_HASH,
  44         BOND_OPT_ARP_VALIDATE,
  45         BOND_OPT_ARP_ALL_TARGETS,
  46         BOND_OPT_FAIL_OVER_MAC,
  47         BOND_OPT_ARP_INTERVAL,
  48         BOND_OPT_LAST
  49 };
  50
  51 /* This structure is used for storing option values and for passing option
  52  * values when changing an option. The logic when used as an arg is as follows:
  53  * - if string != NULL -> parse it, if the opt is RAW type then return it, else
  54  *   return the parse result
  55  * - if string == NULL -> parse value
  56  */
  57 struct bond_opt_value {
  58         char *string;
  59         u64 value;
  60         u32 flags;
  61 };
  62
  63 struct bonding;
  64
  65 struct bond_option {
  66         int id;
  67         char *name;
  68         char *desc;
  69         u32 flags;
  70
  71         /* unsuppmodes is used to denote modes in which the option isn't
  72          * supported.
  73          */
  74         unsigned long unsuppmodes;
  75         /* supported values which this option can have, can be a subset of
  76          * BOND_OPTVAL_RANGE's value range
  77          */
  78         struct bond_opt_value *values;
  79
  80         int (*set)(struct bonding *bond, struct bond_opt_value *val);
  81 };
  82
  83 int __bond_opt_set(struct bonding *bond, unsigned int option,
  84                    struct bond_opt_value *val);
  85 int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
  86 struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
  87                                       struct bond_opt_value *val);
  88 struct bond_option *bond_opt_get(unsigned int option);
  89 struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
  90
  91 /* This helper is used to initialize a bond_opt_value structure for parameter
  92  * passing. There should be either a valid string or value, but not both.
  93  * When value is ULLONG_MAX then string will be used.
  94  */
  95 static inline void __bond_opt_init(struct bond_opt_value *optval,
  96                                    char *string, u64 value)
  97 {
  98         memset(optval, 0, sizeof(*optval));
  99         optval->value = ULLONG_MAX;
 100         if (value == ULLONG_MAX)
 101                 optval->string = string;
 102         else
 103                 optval->value = value;
 104 }
 105 #define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
 106 #define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)
 107
 108 int bond_option_mode_set(struct bonding *bond, struct bond_opt_value *newval);
 109 int bond_option_pps_set(struct bonding *bond, struct bond_opt_value *newval);
 110 int bond_option_xmit_hash_policy_set(struct bonding *bond,
 111                                      struct bond_opt_value *newval);
 112 int bond_option_arp_validate_set(struct bonding *bond,
 113                                  struct bond_opt_value *newval);
 114 int bond_option_arp_all_targets_set(struct bonding *bond,
 115                                     struct bond_opt_value *newval);
 116 int bond_option_fail_over_mac_set(struct bonding *bond,
 117                                   struct bond_opt_value *newval);
 118 int bond_option_arp_interval_set(struct bonding *bond,
 119                                  struct bond_opt_value *newval);
 120 #endif /* _BOND_OPTIONS_H */