[mirror_ubuntu-bionic-kernel.git] / drivers / net / bonding / bond_options.h

/*
 * drivers/net/bond/bond_options.h - bonding options
 * Copyright (c) 2013 Nikolay Aleksandrov <nikolay@redhat.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 */

#ifndef _BOND_OPTIONS_H
#define _BOND_OPTIONS_H

#define BOND_OPT_MAX_NAMELEN 32
#define BOND_OPT_VALID(opt) ((opt) < BOND_OPT_LAST)
#define BOND_MODE_ALL_EX(x) (~(x))

/* Option flags:
 * BOND_OPTFLAG_NOSLAVES - check if the bond device is empty before setting
 * BOND_OPTFLAG_IFDOWN - check if the bond device is down before setting
 * BOND_OPTFLAG_RAWVAL - the option parses the value itself
 */
enum {
	BOND_OPTFLAG_NOSLAVES	= BIT(0),
	BOND_OPTFLAG_IFDOWN	= BIT(1),
	BOND_OPTFLAG_RAWVAL	= BIT(2)
};

/* Value type flags:
 * BOND_VALFLAG_DEFAULT - mark the value as default
 * BOND_VALFLAG_(MIN|MAX) - mark the value as min/max
 */
enum {
	BOND_VALFLAG_DEFAULT	= BIT(0),
	BOND_VALFLAG_MIN	= BIT(1),
	BOND_VALFLAG_MAX	= BIT(2)
};

/* Option IDs, their bit positions correspond to their IDs */
enum {
	BOND_OPT_MODE,
	BOND_OPT_PACKETS_PER_SLAVE,
	BOND_OPT_XMIT_HASH,
	BOND_OPT_ARP_VALIDATE,
	BOND_OPT_ARP_ALL_TARGETS,
	BOND_OPT_FAIL_OVER_MAC,
	BOND_OPT_ARP_INTERVAL,
	BOND_OPT_ARP_TARGETS,
	BOND_OPT_DOWNDELAY,
	BOND_OPT_UPDELAY,
	BOND_OPT_LACP_RATE,
	BOND_OPT_MINLINKS,
	BOND_OPT_AD_SELECT,
	BOND_OPT_NUM_PEER_NOTIF,
	BOND_OPT_MIIMON,
	BOND_OPT_PRIMARY,
	BOND_OPT_PRIMARY_RESELECT,
	BOND_OPT_USE_CARRIER,
	BOND_OPT_ACTIVE_SLAVE,
	BOND_OPT_LAST
};

/* This structure is used for storing option values and for passing option
 * values when changing an option. The logic when used as an arg is as follows:
 * - if string != NULL -> parse it, if the opt is RAW type then return it, else
 *   return the parse result
 * - if string == NULL -> parse value
 */
struct bond_opt_value {
	char *string;
	u64 value;
	u32 flags;
};

struct bonding;

struct bond_option {
	int id;
	char *name;
	char *desc;
	u32 flags;

	/* unsuppmodes is used to denote modes in which the option isn't
	 * supported.
	 */
	unsigned long unsuppmodes;
	/* supported values which this option can have, can be a subset of
	 * BOND_OPTVAL_RANGE's value range
	 */
	struct bond_opt_value *values;

	int (*set)(struct bonding *bond, struct bond_opt_value *val);
};

int __bond_opt_set(struct bonding *bond, unsigned int option,
		   struct bond_opt_value *val);
int bond_opt_tryset_rtnl(struct bonding *bond, unsigned int option, char *buf);
struct bond_opt_value *bond_opt_parse(const struct bond_option *opt,
				      struct bond_opt_value *val);
struct bond_option *bond_opt_get(unsigned int option);
struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);

/* This helper is used to initialize a bond_opt_value structure for parameter
 * passing. There should be either a valid string or value, but not both.
 * When value is ULLONG_MAX then string will be used.
 */
static inline void __bond_opt_init(struct bond_opt_value *optval,
				   char *string, u64 value)
{
	memset(optval, 0, sizeof(*optval));
	optval->value = ULLONG_MAX;
	if (value == ULLONG_MAX)
		optval->string = string;
	else
		optval->value = value;
}
#define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
#define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)

int bond_option_mode_set(struct bonding *bond, struct bond_opt_value *newval);
int bond_option_pps_set(struct bonding *bond, struct bond_opt_value *newval);
int bond_option_xmit_hash_policy_set(struct bonding *bond,
				     struct bond_opt_value *newval);
int bond_option_arp_validate_set(struct bonding *bond,
				 struct bond_opt_value *newval);
int bond_option_arp_all_targets_set(struct bonding *bond,
				    struct bond_opt_value *newval);
int bond_option_fail_over_mac_set(struct bonding *bond,
				  struct bond_opt_value *newval);
int bond_option_arp_interval_set(struct bonding *bond,
				 struct bond_opt_value *newval);
int bond_option_arp_ip_targets_set(struct bonding *bond,
				   struct bond_opt_value *newval);
void bond_option_arp_ip_targets_clear(struct bonding *bond);
int bond_option_downdelay_set(struct bonding *bond,
			      struct bond_opt_value *newval);
int bond_option_updelay_set(struct bonding *bond,
			    struct bond_opt_value *newval);
int bond_option_lacp_rate_set(struct bonding *bond,
			      struct bond_opt_value *newval);
int bond_option_min_links_set(struct bonding *bond,
			      struct bond_opt_value *newval);
int bond_option_ad_select_set(struct bonding *bond,
			      struct bond_opt_value *newval);
int bond_option_num_peer_notif_set(struct bonding *bond,
				   struct bond_opt_value *newval);
int bond_option_miimon_set(struct bonding *bond, struct bond_opt_value *newval);
int bond_option_primary_set(struct bonding *bond,
			    struct bond_opt_value *newval);
int bond_option_primary_reselect_set(struct bonding *bond,
				     struct bond_opt_value *newval);
int bond_option_use_carrier_set(struct bonding *bond,
				struct bond_opt_value *newval);
int bond_option_active_slave_set(struct bonding *bond,
				 struct bond_opt_value *newval);
#endif /* _BOND_OPTIONS_H */
Commit	Line	Data
09117362 NA	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 {
2b3798d5	41	BOND_OPT_MODE,
aa59d851	42	BOND_OPT_PACKETS_PER_SLAVE,
a4b32ce7	43	BOND_OPT_XMIT_HASH,
16228881	44	BOND_OPT_ARP_VALIDATE,
edf36b24	45	BOND_OPT_ARP_ALL_TARGETS,
1df6b6aa	46	BOND_OPT_FAIL_OVER_MAC,
7bdb04ed	47	BOND_OPT_ARP_INTERVAL,
4fb0ef58	48	BOND_OPT_ARP_TARGETS,
25a9b54a	49	BOND_OPT_DOWNDELAY,
e4994612	50	BOND_OPT_UPDELAY,
d3131de7	51	BOND_OPT_LACP_RATE,
633ddc9e	52	BOND_OPT_MINLINKS,
9e5f5eeb	53	BOND_OPT_AD_SELECT,
ef56becb	54	BOND_OPT_NUM_PEER_NOTIF,
b98d9c66	55	BOND_OPT_MIIMON,
180222f0	56	BOND_OPT_PRIMARY,
388d3a6d	57	BOND_OPT_PRIMARY_RESELECT,
0fff0608	58	BOND_OPT_USE_CARRIER,
d1fbd3ed	59	BOND_OPT_ACTIVE_SLAVE,
09117362 NA	60	BOND_OPT_LAST
	61	};
	62
	63	/* This structure is used for storing option values and for passing option
	64	* values when changing an option. The logic when used as an arg is as follows:
	65	* - if string != NULL -> parse it, if the opt is RAW type then return it, else
	66	* return the parse result
	67	* - if string == NULL -> parse value
	68	*/
	69	struct bond_opt_value {
	70	char *string;
	71	u64 value;
	72	u32 flags;
	73	};
	74
	75	struct bonding;
	76
	77	struct bond_option {
	78	int id;
	79	char *name;
	80	char *desc;
	81	u32 flags;
	82
	83	/* unsuppmodes is used to denote modes in which the option isn't
	84	* supported.
	85	*/
	86	unsigned long unsuppmodes;
	87	/* supported values which this option can have, can be a subset of
	88	* BOND_OPTVAL_RANGE's value range
	89	*/
	90	struct bond_opt_value *values;
	91
	92	int (set)(struct bonding bond, struct bond_opt_value *val);
	93	};
	94
	95	int __bond_opt_set(struct bonding *bond, unsigned int option,
	96	struct bond_opt_value *val);
	97	int bond_opt_tryset_rtnl(struct bonding bond, unsigned int option, char buf);
	98	struct bond_opt_value bond_opt_parse(const struct bond_option opt,
	99	struct bond_opt_value *val);
	100	struct bond_option *bond_opt_get(unsigned int option);
	101	struct bond_opt_value *bond_opt_get_val(unsigned int option, u64 val);
	102
	103	/* This helper is used to initialize a bond_opt_value structure for parameter
	104	* passing. There should be either a valid string or value, but not both.
	105	* When value is ULLONG_MAX then string will be used.
	106	*/
	107	static inline void __bond_opt_init(struct bond_opt_value *optval,
	108	char *string, u64 value)
	109	{
	110	memset(optval, 0, sizeof(*optval));
	111	optval->value = ULLONG_MAX;
	112	if (value == ULLONG_MAX)
	113	optval->string = string;
	114	else
	115	optval->value = value;
	116	}
	117	#define bond_opt_initval(optval, value) __bond_opt_init(optval, NULL, value)
	118	#define bond_opt_initstr(optval, str) __bond_opt_init(optval, str, ULLONG_MAX)
2b3798d5 NA	119
2b3798d5 NA	120	int bond_option_mode_set(struct bonding bond, struct bond_opt_value newval);
aa59d851	121	int bond_option_pps_set(struct bonding bond, struct bond_opt_value newval);
a4b32ce7 NA	122	int bond_option_xmit_hash_policy_set(struct bonding *bond,
a4b32ce7 NA	123	struct bond_opt_value *newval);
16228881 NA	124	int bond_option_arp_validate_set(struct bonding *bond,
16228881 NA	125	struct bond_opt_value *newval);
edf36b24 NA	126	int bond_option_arp_all_targets_set(struct bonding *bond,
edf36b24 NA	127	struct bond_opt_value *newval);
1df6b6aa NA	128	int bond_option_fail_over_mac_set(struct bonding *bond,
1df6b6aa NA	129	struct bond_opt_value *newval);
7bdb04ed NA	130	int bond_option_arp_interval_set(struct bonding *bond,
7bdb04ed NA	131	struct bond_opt_value *newval);
4fb0ef58 NA	132	int bond_option_arp_ip_targets_set(struct bonding *bond,
	133	struct bond_opt_value *newval);
	134	void bond_option_arp_ip_targets_clear(struct bonding *bond);
25a9b54a NA	135	int bond_option_downdelay_set(struct bonding *bond,
25a9b54a NA	136	struct bond_opt_value *newval);
e4994612 NA	137	int bond_option_updelay_set(struct bonding *bond,
e4994612 NA	138	struct bond_opt_value *newval);
d3131de7 NA	139	int bond_option_lacp_rate_set(struct bonding *bond,
d3131de7 NA	140	struct bond_opt_value *newval);
633ddc9e NA	141	int bond_option_min_links_set(struct bonding *bond,
633ddc9e NA	142	struct bond_opt_value *newval);
9e5f5eeb NA	143	int bond_option_ad_select_set(struct bonding *bond,
9e5f5eeb NA	144	struct bond_opt_value *newval);
ef56becb NA	145	int bond_option_num_peer_notif_set(struct bonding *bond,
ef56becb NA	146	struct bond_opt_value *newval);
b98d9c66	147	int bond_option_miimon_set(struct bonding bond, struct bond_opt_value newval);
180222f0 NA	148	int bond_option_primary_set(struct bonding *bond,
180222f0 NA	149	struct bond_opt_value *newval);
388d3a6d NA	150	int bond_option_primary_reselect_set(struct bonding *bond,
388d3a6d NA	151	struct bond_opt_value *newval);
0fff0608 NA	152	int bond_option_use_carrier_set(struct bonding *bond,
0fff0608 NA	153	struct bond_opt_value *newval);
d1fbd3ed NA	154	int bond_option_active_slave_set(struct bonding *bond,
d1fbd3ed NA	155	struct bond_opt_value *newval);
09117362	156	#endif /* _BOND_OPTIONS_H */