1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * drivers/net/bond/bond_options.h - bonding options
4*4882a593Smuzhiyun * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
5*4882a593Smuzhiyun */
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun #ifndef _NET_BOND_OPTIONS_H
8*4882a593Smuzhiyun #define _NET_BOND_OPTIONS_H
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #define BOND_OPT_MAX_NAMELEN 32
11*4882a593Smuzhiyun #define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
12*4882a593Smuzhiyun #define BOND_MODE_ALL_EX(x) (~(x))
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun /* Option flags:
15*4882a593Smuzhiyun * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
16*4882a593Smuzhiyun * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
17*4882a593Smuzhiyun * BOND_OPTFLAG_RAWVAL - the option parses the value itself
18*4882a593Smuzhiyun */
19*4882a593Smuzhiyun enum {
20*4882a593Smuzhiyun BOND_OPTFLAG_NOSLAVES = BIT(0),
21*4882a593Smuzhiyun BOND_OPTFLAG_IFDOWN = BIT(1),
22*4882a593Smuzhiyun BOND_OPTFLAG_RAWVAL = BIT(2)
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun /* Value type flags:
26*4882a593Smuzhiyun * BOND_VALFLAG_DEFAULT - mark the value as default
27*4882a593Smuzhiyun * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
28*4882a593Smuzhiyun */
29*4882a593Smuzhiyun enum {
30*4882a593Smuzhiyun BOND_VALFLAG_DEFAULT = BIT(0),
31*4882a593Smuzhiyun BOND_VALFLAG_MIN = BIT(1),
32*4882a593Smuzhiyun BOND_VALFLAG_MAX = BIT(2)
33*4882a593Smuzhiyun };
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun /* Option IDs, their bit positions correspond to their IDs */
36*4882a593Smuzhiyun enum {
37*4882a593Smuzhiyun BOND_OPT_MODE,
38*4882a593Smuzhiyun BOND_OPT_PACKETS_PER_SLAVE,
39*4882a593Smuzhiyun BOND_OPT_XMIT_HASH,
40*4882a593Smuzhiyun BOND_OPT_ARP_VALIDATE,
41*4882a593Smuzhiyun BOND_OPT_ARP_ALL_TARGETS,
42*4882a593Smuzhiyun BOND_OPT_FAIL_OVER_MAC,
43*4882a593Smuzhiyun BOND_OPT_ARP_INTERVAL,
44*4882a593Smuzhiyun BOND_OPT_ARP_TARGETS,
45*4882a593Smuzhiyun BOND_OPT_DOWNDELAY,
46*4882a593Smuzhiyun BOND_OPT_UPDELAY,
47*4882a593Smuzhiyun BOND_OPT_LACP_RATE,
48*4882a593Smuzhiyun BOND_OPT_MINLINKS,
49*4882a593Smuzhiyun BOND_OPT_AD_SELECT,
50*4882a593Smuzhiyun BOND_OPT_NUM_PEER_NOTIF,
51*4882a593Smuzhiyun BOND_OPT_MIIMON,
52*4882a593Smuzhiyun BOND_OPT_PRIMARY,
53*4882a593Smuzhiyun BOND_OPT_PRIMARY_RESELECT,
54*4882a593Smuzhiyun BOND_OPT_USE_CARRIER,
55*4882a593Smuzhiyun BOND_OPT_ACTIVE_SLAVE,
56*4882a593Smuzhiyun BOND_OPT_QUEUE_ID,
57*4882a593Smuzhiyun BOND_OPT_ALL_SLAVES_ACTIVE,
58*4882a593Smuzhiyun BOND_OPT_RESEND_IGMP,
59*4882a593Smuzhiyun BOND_OPT_LP_INTERVAL,
60*4882a593Smuzhiyun BOND_OPT_SLAVES,
61*4882a593Smuzhiyun BOND_OPT_TLB_DYNAMIC_LB,
62*4882a593Smuzhiyun BOND_OPT_AD_ACTOR_SYS_PRIO,
63*4882a593Smuzhiyun BOND_OPT_AD_ACTOR_SYSTEM,
64*4882a593Smuzhiyun BOND_OPT_AD_USER_PORT_KEY,
65*4882a593Smuzhiyun BOND_OPT_NUM_PEER_NOTIF_ALIAS,
66*4882a593Smuzhiyun BOND_OPT_PEER_NOTIF_DELAY,
67*4882a593Smuzhiyun BOND_OPT_LAST
68*4882a593Smuzhiyun };
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun /* This structure is used for storing option values and for passing option
71*4882a593Smuzhiyun * values when changing an option. The logic when used as an arg is as follows:
72*4882a593Smuzhiyun * - if string != NULL -> parse it, if the opt is RAW type then return it, else
73*4882a593Smuzhiyun * return the parse result
74*4882a593Smuzhiyun * - if string == NULL -> parse value
75*4882a593Smuzhiyun */
76*4882a593Smuzhiyun struct bond_opt_value {
77*4882a593Smuzhiyun char *string;
78*4882a593Smuzhiyun u64 value;
79*4882a593Smuzhiyun u32 flags;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun struct bonding;
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun struct bond_option {
85*4882a593Smuzhiyun int id;
86*4882a593Smuzhiyun const char *name;
87*4882a593Smuzhiyun const char *desc;
88*4882a593Smuzhiyun u32 flags;
89*4882a593Smuzhiyun
90*4882a593Smuzhiyun /* unsuppmodes is used to denote modes in which the option isn't
91*4882a593Smuzhiyun * supported.
92*4882a593Smuzhiyun */
93*4882a593Smuzhiyun unsigned long unsuppmodes;
94*4882a593Smuzhiyun /* supported values which this option can have, can be a subset of
95*4882a593Smuzhiyun * BOND_OPTVAL_RANGE's value range
96*4882a593Smuzhiyun */
97*4882a593Smuzhiyun const struct bond_opt_value *values;
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun int (*set)(struct bonding *bond, const struct bond_opt_value *val);
100*4882a593Smuzhiyun };
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun int __bond_opt_set(struct bonding *bond, unsigned int option,
103*4882a593Smuzhiyun struct bond_opt_value *val);
104*4882a593Smuzhiyun int __bond_opt_set_notify(struct bonding *bond, unsigned int option,
105*4882a593Smuzhiyun struct bond_opt_value *val);
106*4882a593Smuzhiyun int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
107*4882a593Smuzhiyun
108*4882a593Smuzhiyun const struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
109*4882a593Smuzhiyun struct bond_opt_value *val);
110*4882a593Smuzhiyun const struct bond_option *bond_opt_get(unsigned int option);
111*4882a593Smuzhiyun const struct bond_option *bond_opt_get_by_name(const char *name);
112*4882a593Smuzhiyun const struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun /* This helper is used to initialize a bond_opt_value structure for parameter
115*4882a593Smuzhiyun * passing. There should be either a valid string or value, but not both.
116*4882a593Smuzhiyun * When value is ULLONG_MAX then string will be used.
117*4882a593Smuzhiyun */
__bond_opt_init(struct bond_opt_value * optval,char * string,u64 value)118*4882a593Smuzhiyun static inline void __bond_opt_init(struct bond_opt_value *optval,
119*4882a593Smuzhiyun char *string, u64 value)
120*4882a593Smuzhiyun {
121*4882a593Smuzhiyun memset(optval, 0, sizeof(*optval));
122*4882a593Smuzhiyun optval->value = ULLONG_MAX;
123*4882a593Smuzhiyun if (value == ULLONG_MAX)
124*4882a593Smuzhiyun optval->string = string;
125*4882a593Smuzhiyun else
126*4882a593Smuzhiyun optval->value = value;
127*4882a593Smuzhiyun }
128*4882a593Smuzhiyun #define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
129*4882a593Smuzhiyun #define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun void bond_option_arp_ip_targets_clear(struct bonding *bond);
132*4882a593Smuzhiyun
133*4882a593Smuzhiyun #endif /* _NET_BOND_OPTIONS_H */
134