[linux-2.6-block.git] / drivers / net / ethernet / mellanox / mlxsw / core.h

/*
 * drivers/net/ethernet/mellanox/mlxsw/core.h
 * Copyright (c) 2015 Mellanox Technologies. All rights reserved.
 * Copyright (c) 2015 Jiri Pirko <jiri@mellanox.com>
 * Copyright (c) 2015 Ido Schimmel <idosch@mellanox.com>
 * Copyright (c) 2015 Elad Raz <eladr@mellanox.com>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _MLXSW_CORE_H
#define _MLXSW_CORE_H

#include <linux/module.h>
#include <linux/device.h>
#include <linux/slab.h>
#include <linux/gfp.h>
#include <linux/types.h>
#include <linux/skbuff.h>
#include <net/devlink.h>

#include "trap.h"
#include "reg.h"

#include "cmd.h"

#define MLXSW_MODULE_ALIAS_PREFIX "mlxsw-driver-"
#define MODULE_MLXSW_DRIVER_ALIAS(kind)	\
	MODULE_ALIAS(MLXSW_MODULE_ALIAS_PREFIX kind)

#define MLXSW_DEVICE_KIND_SWITCHX2 "switchx2"
#define MLXSW_DEVICE_KIND_SPECTRUM "spectrum"

struct mlxsw_core;
struct mlxsw_driver;
struct mlxsw_bus;
struct mlxsw_bus_info;

void *mlxsw_core_driver_priv(struct mlxsw_core *mlxsw_core);

int mlxsw_core_driver_register(struct mlxsw_driver *mlxsw_driver);
void mlxsw_core_driver_unregister(struct mlxsw_driver *mlxsw_driver);

int mlxsw_core_bus_device_register(const struct mlxsw_bus_info *mlxsw_bus_info,
				   const struct mlxsw_bus *mlxsw_bus,
				   void *bus_priv);
void mlxsw_core_bus_device_unregister(struct mlxsw_core *mlxsw_core);

struct mlxsw_tx_info {
	u8 local_port;
	bool is_emad;
};

bool mlxsw_core_skb_transmit_busy(struct mlxsw_core *mlxsw_core,
				  const struct mlxsw_tx_info *tx_info);
int mlxsw_core_skb_transmit(struct mlxsw_core *mlxsw_core, struct sk_buff *skb,
			    const struct mlxsw_tx_info *tx_info);

struct mlxsw_rx_listener {
	void (*func)(struct sk_buff *skb, u8 local_port, void *priv);
	u8 local_port;
	u16 trap_id;
};

struct mlxsw_event_listener {
	void (*func)(const struct mlxsw_reg_info *reg,
		     char *payload, void *priv);
	enum mlxsw_event_trap_id trap_id;
};

int mlxsw_core_rx_listener_register(struct mlxsw_core *mlxsw_core,
				    const struct mlxsw_rx_listener *rxl,
				    void *priv);
void mlxsw_core_rx_listener_unregister(struct mlxsw_core *mlxsw_core,
				       const struct mlxsw_rx_listener *rxl,
				       void *priv);

int mlxsw_core_event_listener_register(struct mlxsw_core *mlxsw_core,
				       const struct mlxsw_event_listener *el,
				       void *priv);
void mlxsw_core_event_listener_unregister(struct mlxsw_core *mlxsw_core,
					  const struct mlxsw_event_listener *el,
					  void *priv);

int mlxsw_reg_query(struct mlxsw_core *mlxsw_core,
		    const struct mlxsw_reg_info *reg, char *payload);
int mlxsw_reg_write(struct mlxsw_core *mlxsw_core,
		    const struct mlxsw_reg_info *reg, char *payload);

struct mlxsw_rx_info {
	bool is_lag;
	union {
		u16 sys_port;
		u16 lag_id;
	} u;
	u8 lag_port_index;
	int trap_id;
};

void mlxsw_core_skb_receive(struct mlxsw_core *mlxsw_core, struct sk_buff *skb,
			    struct mlxsw_rx_info *rx_info);

void mlxsw_core_lag_mapping_set(struct mlxsw_core *mlxsw_core,
				u16 lag_id, u8 port_index, u8 local_port);
u8 mlxsw_core_lag_mapping_get(struct mlxsw_core *mlxsw_core,
			      u16 lag_id, u8 port_index);
void mlxsw_core_lag_mapping_clear(struct mlxsw_core *mlxsw_core,
				  u16 lag_id, u8 local_port);

struct mlxsw_core_port {
	struct devlink_port devlink_port;
};

int mlxsw_core_port_init(struct mlxsw_core *mlxsw_core,
			 struct mlxsw_core_port *mlxsw_core_port, u8 local_port,
			 struct net_device *dev, bool split, u32 split_group);
void mlxsw_core_port_fini(struct mlxsw_core_port *mlxsw_core_port);

#define MLXSW_CONFIG_PROFILE_SWID_COUNT 8

struct mlxsw_swid_config {
	u8	used_type:1,
		used_properties:1;
	u8	type;
	u8	properties;
};

struct mlxsw_config_profile {
	u16	used_max_vepa_channels:1,
		used_max_lag:1,
		used_max_port_per_lag:1,
		used_max_mid:1,
		used_max_pgt:1,
		used_max_system_port:1,
		used_max_vlan_groups:1,
		used_max_regions:1,
		used_flood_tables:1,
		used_flood_mode:1,
		used_max_ib_mc:1,
		used_max_pkey:1,
		used_ar_sec:1,
		used_adaptive_routing_group_cap:1;
	u8	max_vepa_channels;
	u16	max_lag;
	u16	max_port_per_lag;
	u16	max_mid;
	u16	max_pgt;
	u16	max_system_port;
	u16	max_vlan_groups;
	u16	max_regions;
	u8	max_flood_tables;
	u8	max_vid_flood_tables;
	u8	flood_mode;
	u8	max_fid_offset_flood_tables;
	u16	fid_offset_flood_table_size;
	u8	max_fid_flood_tables;
	u16	fid_flood_table_size;
	u16	max_ib_mc;
	u16	max_pkey;
	u8	ar_sec;
	u16	adaptive_routing_group_cap;
	u8	arn;
	struct mlxsw_swid_config swid_config[MLXSW_CONFIG_PROFILE_SWID_COUNT];
};

struct mlxsw_driver {
	struct list_head list;
	const char *kind;
	struct module *owner;
	size_t priv_size;
	int (*init)(struct mlxsw_core *mlxsw_core,
		    const struct mlxsw_bus_info *mlxsw_bus_info);
	void (*fini)(struct mlxsw_core *mlxsw_core);
	int (*port_split)(struct mlxsw_core *mlxsw_core, u8 local_port,
			  unsigned int count);
	int (*port_unsplit)(struct mlxsw_core *mlxsw_core, u8 local_port);
	void (*txhdr_construct)(struct sk_buff *skb,
				const struct mlxsw_tx_info *tx_info);
	u8 txhdr_len;
	const struct mlxsw_config_profile *profile;
};

struct mlxsw_bus {
	const char *kind;
	int (*init)(void *bus_priv, struct mlxsw_core *mlxsw_core,
		    const struct mlxsw_config_profile *profile);
	void (*fini)(void *bus_priv);
	bool (*skb_transmit_busy)(void *bus_priv,
				  const struct mlxsw_tx_info *tx_info);
	int (*skb_transmit)(void *bus_priv, struct sk_buff *skb,
			    const struct mlxsw_tx_info *tx_info);
	int (*cmd_exec)(void *bus_priv, u16 opcode, u8 opcode_mod,
			u32 in_mod, bool out_mbox_direct,
			char *in_mbox, size_t in_mbox_size,
			char *out_mbox, size_t out_mbox_size,
			u8 *p_status);
};

struct mlxsw_bus_info {
	const char *device_kind;
	const char *device_name;
	struct device *dev;
	struct {
		u16 major;
		u16 minor;
		u16 subminor;
	} fw_rev;
	u8 vsd[MLXSW_CMD_BOARDINFO_VSD_LEN];
	u8 psid[MLXSW_CMD_BOARDINFO_PSID_LEN];
};

struct mlxsw_hwmon;

#ifdef CONFIG_MLXSW_CORE_HWMON

int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
		     const struct mlxsw_bus_info *mlxsw_bus_info,
		     struct mlxsw_hwmon **p_hwmon);
void mlxsw_hwmon_fini(struct mlxsw_hwmon *mlxsw_hwmon);

#else

static inline int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
				   const struct mlxsw_bus_info *mlxsw_bus_info,
				   struct mlxsw_hwmon **p_hwmon)
{
	return 0;
}

#endif

#endif
Commit	Line	Data
93c1edb2 JP	1	/*
	2	* drivers/net/ethernet/mellanox/mlxsw/core.h
	3	* Copyright (c) 2015 Mellanox Technologies. All rights reserved.
	4	* Copyright (c) 2015 Jiri Pirko <jiri@mellanox.com>
	5	* Copyright (c) 2015 Ido Schimmel <idosch@mellanox.com>
	6	* Copyright (c) 2015 Elad Raz <eladr@mellanox.com>
	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
	12	* notice, this list of conditions and the following disclaimer.
	13	* 2. Redistributions in binary form must reproduce the above copyright
	14	* notice, this list of conditions and the following disclaimer in the
	15	* documentation and/or other materials provided with the distribution.
	16	* 3. Neither the names of the copyright holders nor the names of its
	17	* contributors may be used to endorse or promote products derived from
	18	* this software without specific prior written permission.
	19	*
	20	* Alternatively, this software may be distributed under the terms of the
	21	* GNU General Public License ("GPL") version 2 as published by the Free
	22	* Software Foundation.
	23	*
	24	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
	25	* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	26	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	27	* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
	28	* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	29	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	30	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	31	* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	32	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	33	* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	34	* POSSIBILITY OF SUCH DAMAGE.
	35	*/
	36
	37	#ifndef _MLXSW_CORE_H
	38	#define _MLXSW_CORE_H
	39
	40	#include <linux/module.h>
	41	#include <linux/device.h>
	42	#include <linux/slab.h>
	43	#include <linux/gfp.h>
	44	#include <linux/types.h>
	45	#include <linux/skbuff.h>
932762b6	46	#include <net/devlink.h>
93c1edb2	47
4ec14b76 IS	48	#include "trap.h"
	49	#include "reg.h"
	50
93c1edb2 JP	51	#include "cmd.h"
	52
	53	#define MLXSW_MODULE_ALIAS_PREFIX "mlxsw-driver-"
	54	#define MODULE_MLXSW_DRIVER_ALIAS(kind) \
	55	MODULE_ALIAS(MLXSW_MODULE_ALIAS_PREFIX kind)
	56
31557f0f	57	#define MLXSW_DEVICE_KIND_SWITCHX2 "switchx2"
56ade8fe	58	#define MLXSW_DEVICE_KIND_SPECTRUM "spectrum"
31557f0f	59
93c1edb2 JP	60	struct mlxsw_core;
	61	struct mlxsw_driver;
	62	struct mlxsw_bus;
	63	struct mlxsw_bus_info;
	64
b2f10571 JP	65	void mlxsw_core_driver_priv(struct mlxsw_core mlxsw_core);
b2f10571 JP	66
93c1edb2 JP	67	int mlxsw_core_driver_register(struct mlxsw_driver *mlxsw_driver);
	68	void mlxsw_core_driver_unregister(struct mlxsw_driver *mlxsw_driver);
	69
	70	int mlxsw_core_bus_device_register(const struct mlxsw_bus_info *mlxsw_bus_info,
	71	const struct mlxsw_bus *mlxsw_bus,
	72	void *bus_priv);
	73	void mlxsw_core_bus_device_unregister(struct mlxsw_core *mlxsw_core);
	74
	75	struct mlxsw_tx_info {
	76	u8 local_port;
	77	bool is_emad;
	78	};
	79
307c2431	80	bool mlxsw_core_skb_transmit_busy(struct mlxsw_core *mlxsw_core,
d003462a	81	const struct mlxsw_tx_info *tx_info);
307c2431	82	int mlxsw_core_skb_transmit(struct mlxsw_core mlxsw_core, struct sk_buff skb,
93c1edb2 JP	83	const struct mlxsw_tx_info *tx_info);
	84
	85	struct mlxsw_rx_listener {
	86	void (func)(struct sk_buff skb, u8 local_port, void *priv);
	87	u8 local_port;
	88	u16 trap_id;
	89	};
	90
4ec14b76 IS	91	struct mlxsw_event_listener {
	92	void (func)(const struct mlxsw_reg_info reg,
	93	char payload, void priv);
	94	enum mlxsw_event_trap_id trap_id;
	95	};
	96
93c1edb2 JP	97	int mlxsw_core_rx_listener_register(struct mlxsw_core *mlxsw_core,
	98	const struct mlxsw_rx_listener *rxl,
	99	void *priv);
	100	void mlxsw_core_rx_listener_unregister(struct mlxsw_core *mlxsw_core,
	101	const struct mlxsw_rx_listener *rxl,
	102	void *priv);
	103
4ec14b76 IS	104	int mlxsw_core_event_listener_register(struct mlxsw_core *mlxsw_core,
	105	const struct mlxsw_event_listener *el,
	106	void *priv);
	107	void mlxsw_core_event_listener_unregister(struct mlxsw_core *mlxsw_core,
	108	const struct mlxsw_event_listener *el,
	109	void *priv);
	110
	111	int mlxsw_reg_query(struct mlxsw_core *mlxsw_core,
	112	const struct mlxsw_reg_info reg, char payload);
	113	int mlxsw_reg_write(struct mlxsw_core *mlxsw_core,
	114	const struct mlxsw_reg_info reg, char payload);
	115
93c1edb2	116	struct mlxsw_rx_info {
8060646a JP	117	bool is_lag;
	118	union {
	119	u16 sys_port;
	120	u16 lag_id;
	121	} u;
	122	u8 lag_port_index;
93c1edb2 JP	123	int trap_id;
	124	};
	125
	126	void mlxsw_core_skb_receive(struct mlxsw_core mlxsw_core, struct sk_buff skb,
	127	struct mlxsw_rx_info *rx_info);
	128
8060646a JP	129	void mlxsw_core_lag_mapping_set(struct mlxsw_core *mlxsw_core,
	130	u16 lag_id, u8 port_index, u8 local_port);
	131	u8 mlxsw_core_lag_mapping_get(struct mlxsw_core *mlxsw_core,
	132	u16 lag_id, u8 port_index);
	133	void mlxsw_core_lag_mapping_clear(struct mlxsw_core *mlxsw_core,
	134	u16 lag_id, u8 local_port);
	135
932762b6 JP	136	struct mlxsw_core_port {
	137	struct devlink_port devlink_port;
	138	};
	139
	140	int mlxsw_core_port_init(struct mlxsw_core *mlxsw_core,
	141	struct mlxsw_core_port *mlxsw_core_port, u8 local_port,
	142	struct net_device *dev, bool split, u32 split_group);
	143	void mlxsw_core_port_fini(struct mlxsw_core_port *mlxsw_core_port);
	144
93c1edb2 JP	145	#define MLXSW_CONFIG_PROFILE_SWID_COUNT 8
	146
	147	struct mlxsw_swid_config {
	148	u8 used_type:1,
	149	used_properties:1;
	150	u8 type;
	151	u8 properties;
	152	};
	153
	154	struct mlxsw_config_profile {
	155	u16 used_max_vepa_channels:1,
	156	used_max_lag:1,
	157	used_max_port_per_lag:1,
	158	used_max_mid:1,
	159	used_max_pgt:1,
	160	used_max_system_port:1,
	161	used_max_vlan_groups:1,
	162	used_max_regions:1,
	163	used_flood_tables:1,
	164	used_flood_mode:1,
	165	used_max_ib_mc:1,
	166	used_max_pkey:1,
	167	used_ar_sec:1,
	168	used_adaptive_routing_group_cap:1;
	169	u8 max_vepa_channels;
	170	u16 max_lag;
	171	u16 max_port_per_lag;
	172	u16 max_mid;
	173	u16 max_pgt;
	174	u16 max_system_port;
	175	u16 max_vlan_groups;
	176	u16 max_regions;
	177	u8 max_flood_tables;
	178	u8 max_vid_flood_tables;
	179	u8 flood_mode;
12fd35ab IS	180	u8 max_fid_offset_flood_tables;
12fd35ab IS	181	u16 fid_offset_flood_table_size;
453b6a8d IS	182	u8 max_fid_flood_tables;
453b6a8d IS	183	u16 fid_flood_table_size;
93c1edb2 JP	184	u16 max_ib_mc;
	185	u16 max_pkey;
	186	u8 ar_sec;
	187	u16 adaptive_routing_group_cap;
	188	u8 arn;
	189	struct mlxsw_swid_config swid_config[MLXSW_CONFIG_PROFILE_SWID_COUNT];
	190	};
	191
	192	struct mlxsw_driver {
	193	struct list_head list;
	194	const char *kind;
	195	struct module *owner;
	196	size_t priv_size;
b2f10571	197	int (init)(struct mlxsw_core mlxsw_core,
93c1edb2	198	const struct mlxsw_bus_info *mlxsw_bus_info);
b2f10571 JP	199	void (fini)(struct mlxsw_core mlxsw_core);
	200	int (port_split)(struct mlxsw_core mlxsw_core, u8 local_port,
	201	unsigned int count);
	202	int (port_unsplit)(struct mlxsw_core mlxsw_core, u8 local_port);
93c1edb2 JP	203	void (txhdr_construct)(struct sk_buff skb,
	204	const struct mlxsw_tx_info *tx_info);
	205	u8 txhdr_len;
	206	const struct mlxsw_config_profile *profile;
	207	};
	208
	209	struct mlxsw_bus {
	210	const char *kind;
	211	int (init)(void bus_priv, struct mlxsw_core *mlxsw_core,
	212	const struct mlxsw_config_profile *profile);
	213	void (fini)(void bus_priv);
d003462a IS	214	bool (skb_transmit_busy)(void bus_priv,
d003462a IS	215	const struct mlxsw_tx_info *tx_info);
93c1edb2 JP	216	int (skb_transmit)(void bus_priv, struct sk_buff *skb,
	217	const struct mlxsw_tx_info *tx_info);
	218	int (cmd_exec)(void bus_priv, u16 opcode, u8 opcode_mod,
	219	u32 in_mod, bool out_mbox_direct,
	220	char *in_mbox, size_t in_mbox_size,
	221	char *out_mbox, size_t out_mbox_size,
	222	u8 *p_status);
	223	};
	224
	225	struct mlxsw_bus_info {
	226	const char *device_kind;
	227	const char *device_name;
	228	struct device *dev;
	229	struct {
	230	u16 major;
	231	u16 minor;
	232	u16 subminor;
	233	} fw_rev;
	234	u8 vsd[MLXSW_CMD_BOARDINFO_VSD_LEN];
	235	u8 psid[MLXSW_CMD_BOARDINFO_PSID_LEN];
	236	};
	237
89309da3 JP	238	struct mlxsw_hwmon;
	239
	240	#ifdef CONFIG_MLXSW_CORE_HWMON
	241
	242	int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
	243	const struct mlxsw_bus_info *mlxsw_bus_info,
	244	struct mlxsw_hwmon **p_hwmon);
	245	void mlxsw_hwmon_fini(struct mlxsw_hwmon *mlxsw_hwmon);
	246
	247	#else
	248
	249	static inline int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
	250	const struct mlxsw_bus_info *mlxsw_bus_info,
	251	struct mlxsw_hwmon **p_hwmon)
	252	{
	253	return 0;
	254	}
	255
89309da3 JP	256	#endif
89309da3 JP	257
93c1edb2	258	#endif