1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /* Copyright (c) 2015-2018 Mellanox Technologies. All rights reserved */
3 
4 #ifndef _MLXSW_CORE_H
5 #define _MLXSW_CORE_H
6 
7 #include <linux/module.h>
8 #include <linux/device.h>
9 #include <linux/slab.h>
10 #include <linux/gfp.h>
11 #include <linux/types.h>
12 #include <linux/skbuff.h>
13 #include <linux/workqueue.h>
14 #include <net/devlink.h>
15 
16 #include "trap.h"
17 #include "reg.h"
18 #include "cmd.h"
19 #include "resources.h"
20 
21 struct mlxsw_core;
22 struct mlxsw_core_port;
23 struct mlxsw_driver;
24 struct mlxsw_bus;
25 struct mlxsw_bus_info;
26 
27 unsigned int mlxsw_core_max_ports(const struct mlxsw_core *mlxsw_core);
28 
29 void *mlxsw_core_driver_priv(struct mlxsw_core *mlxsw_core);
30 
31 bool mlxsw_core_res_query_enabled(const struct mlxsw_core *mlxsw_core);
32 
33 int mlxsw_core_driver_register(struct mlxsw_driver *mlxsw_driver);
34 void mlxsw_core_driver_unregister(struct mlxsw_driver *mlxsw_driver);
35 
36 int mlxsw_core_bus_device_register(const struct mlxsw_bus_info *mlxsw_bus_info,
37 				   const struct mlxsw_bus *mlxsw_bus,
38 				   void *bus_priv, bool reload,
39 				   struct devlink *devlink);
40 void mlxsw_core_bus_device_unregister(struct mlxsw_core *mlxsw_core, bool reload);
41 
42 struct mlxsw_tx_info {
43 	u8 local_port;
44 	bool is_emad;
45 };
46 
47 bool mlxsw_core_skb_transmit_busy(struct mlxsw_core *mlxsw_core,
48 				  const struct mlxsw_tx_info *tx_info);
49 int mlxsw_core_skb_transmit(struct mlxsw_core *mlxsw_core, struct sk_buff *skb,
50 			    const struct mlxsw_tx_info *tx_info);
51 void mlxsw_core_ptp_transmitted(struct mlxsw_core *mlxsw_core,
52 				struct sk_buff *skb, u8 local_port);
53 
54 struct mlxsw_rx_listener {
55 	void (*func)(struct sk_buff *skb, u8 local_port, void *priv);
56 	u8 local_port;
57 	u16 trap_id;
58 	enum mlxsw_reg_hpkt_action action;
59 };
60 
61 struct mlxsw_event_listener {
62 	void (*func)(const struct mlxsw_reg_info *reg,
63 		     char *payload, void *priv);
64 	enum mlxsw_event_trap_id trap_id;
65 };
66 
67 struct mlxsw_listener {
68 	u16 trap_id;
69 	union {
70 		struct mlxsw_rx_listener rx_listener;
71 		struct mlxsw_event_listener event_listener;
72 	} u;
73 	enum mlxsw_reg_hpkt_action action;
74 	enum mlxsw_reg_hpkt_action unreg_action;
75 	u8 trap_group;
76 	bool is_ctrl; /* should go via control buffer or not */
77 	bool is_event;
78 };
79 
80 #define MLXSW_RXL(_func, _trap_id, _action, _is_ctrl, _trap_group,	\
81 		  _unreg_action)					\
82 	{								\
83 		.trap_id = MLXSW_TRAP_ID_##_trap_id,			\
84 		.u.rx_listener =					\
85 		{							\
86 			.func = _func,					\
87 			.local_port = MLXSW_PORT_DONT_CARE,		\
88 			.trap_id = MLXSW_TRAP_ID_##_trap_id,		\
89 		},							\
90 		.action = MLXSW_REG_HPKT_ACTION_##_action,		\
91 		.unreg_action = MLXSW_REG_HPKT_ACTION_##_unreg_action,	\
92 		.trap_group = MLXSW_REG_HTGT_TRAP_GROUP_##_trap_group,	\
93 		.is_ctrl = _is_ctrl,					\
94 		.is_event = false,					\
95 	}
96 
97 #define MLXSW_EVENTL(_func, _trap_id, _trap_group)			\
98 	{								\
99 		.trap_id = MLXSW_TRAP_ID_##_trap_id,			\
100 		.u.event_listener =					\
101 		{							\
102 			.func = _func,					\
103 			.trap_id = MLXSW_TRAP_ID_##_trap_id,		\
104 		},							\
105 		.action = MLXSW_REG_HPKT_ACTION_TRAP_TO_CPU,		\
106 		.trap_group = MLXSW_REG_HTGT_TRAP_GROUP_##_trap_group,	\
107 		.is_ctrl = false,					\
108 		.is_event = true,					\
109 	}
110 
111 int mlxsw_core_rx_listener_register(struct mlxsw_core *mlxsw_core,
112 				    const struct mlxsw_rx_listener *rxl,
113 				    void *priv);
114 void mlxsw_core_rx_listener_unregister(struct mlxsw_core *mlxsw_core,
115 				       const struct mlxsw_rx_listener *rxl,
116 				       void *priv);
117 
118 int mlxsw_core_event_listener_register(struct mlxsw_core *mlxsw_core,
119 				       const struct mlxsw_event_listener *el,
120 				       void *priv);
121 void mlxsw_core_event_listener_unregister(struct mlxsw_core *mlxsw_core,
122 					  const struct mlxsw_event_listener *el,
123 					  void *priv);
124 
125 int mlxsw_core_trap_register(struct mlxsw_core *mlxsw_core,
126 			     const struct mlxsw_listener *listener,
127 			     void *priv);
128 void mlxsw_core_trap_unregister(struct mlxsw_core *mlxsw_core,
129 				const struct mlxsw_listener *listener,
130 				void *priv);
131 
132 typedef void mlxsw_reg_trans_cb_t(struct mlxsw_core *mlxsw_core, char *payload,
133 				  size_t payload_len, unsigned long cb_priv);
134 
135 int mlxsw_reg_trans_query(struct mlxsw_core *mlxsw_core,
136 			  const struct mlxsw_reg_info *reg, char *payload,
137 			  struct list_head *bulk_list,
138 			  mlxsw_reg_trans_cb_t *cb, unsigned long cb_priv);
139 int mlxsw_reg_trans_write(struct mlxsw_core *mlxsw_core,
140 			  const struct mlxsw_reg_info *reg, char *payload,
141 			  struct list_head *bulk_list,
142 			  mlxsw_reg_trans_cb_t *cb, unsigned long cb_priv);
143 int mlxsw_reg_trans_bulk_wait(struct list_head *bulk_list);
144 
145 int mlxsw_reg_query(struct mlxsw_core *mlxsw_core,
146 		    const struct mlxsw_reg_info *reg, char *payload);
147 int mlxsw_reg_write(struct mlxsw_core *mlxsw_core,
148 		    const struct mlxsw_reg_info *reg, char *payload);
149 
150 struct mlxsw_rx_info {
151 	bool is_lag;
152 	union {
153 		u16 sys_port;
154 		u16 lag_id;
155 	} u;
156 	u8 lag_port_index;
157 	int trap_id;
158 };
159 
160 void mlxsw_core_skb_receive(struct mlxsw_core *mlxsw_core, struct sk_buff *skb,
161 			    struct mlxsw_rx_info *rx_info);
162 
163 void mlxsw_core_lag_mapping_set(struct mlxsw_core *mlxsw_core,
164 				u16 lag_id, u8 port_index, u8 local_port);
165 u8 mlxsw_core_lag_mapping_get(struct mlxsw_core *mlxsw_core,
166 			      u16 lag_id, u8 port_index);
167 void mlxsw_core_lag_mapping_clear(struct mlxsw_core *mlxsw_core,
168 				  u16 lag_id, u8 local_port);
169 
170 void *mlxsw_core_port_driver_priv(struct mlxsw_core_port *mlxsw_core_port);
171 int mlxsw_core_port_init(struct mlxsw_core *mlxsw_core, u8 local_port,
172 			 u32 port_number, bool split,
173 			 u32 split_port_subnumber,
174 			 const unsigned char *switch_id,
175 			 unsigned char switch_id_len);
176 void mlxsw_core_port_fini(struct mlxsw_core *mlxsw_core, u8 local_port);
177 void mlxsw_core_port_eth_set(struct mlxsw_core *mlxsw_core, u8 local_port,
178 			     void *port_driver_priv, struct net_device *dev);
179 void mlxsw_core_port_ib_set(struct mlxsw_core *mlxsw_core, u8 local_port,
180 			    void *port_driver_priv);
181 void mlxsw_core_port_clear(struct mlxsw_core *mlxsw_core, u8 local_port,
182 			   void *port_driver_priv);
183 enum devlink_port_type mlxsw_core_port_type_get(struct mlxsw_core *mlxsw_core,
184 						u8 local_port);
185 struct devlink_port *
186 mlxsw_core_port_devlink_port_get(struct mlxsw_core *mlxsw_core,
187 				 u8 local_port);
188 
189 int mlxsw_core_schedule_dw(struct delayed_work *dwork, unsigned long delay);
190 bool mlxsw_core_schedule_work(struct work_struct *work);
191 void mlxsw_core_flush_owq(void);
192 int mlxsw_core_resources_query(struct mlxsw_core *mlxsw_core, char *mbox,
193 			       struct mlxsw_res *res);
194 
195 #define MLXSW_CONFIG_PROFILE_SWID_COUNT 8
196 
197 struct mlxsw_swid_config {
198 	u8	used_type:1,
199 		used_properties:1;
200 	u8	type;
201 	u8	properties;
202 };
203 
204 struct mlxsw_config_profile {
205 	u16	used_max_vepa_channels:1,
206 		used_max_mid:1,
207 		used_max_pgt:1,
208 		used_max_system_port:1,
209 		used_max_vlan_groups:1,
210 		used_max_regions:1,
211 		used_flood_tables:1,
212 		used_flood_mode:1,
213 		used_max_ib_mc:1,
214 		used_max_pkey:1,
215 		used_ar_sec:1,
216 		used_adaptive_routing_group_cap:1,
217 		used_kvd_sizes:1;
218 	u8	max_vepa_channels;
219 	u16	max_mid;
220 	u16	max_pgt;
221 	u16	max_system_port;
222 	u16	max_vlan_groups;
223 	u16	max_regions;
224 	u8	max_flood_tables;
225 	u8	max_vid_flood_tables;
226 	u8	flood_mode;
227 	u8	max_fid_offset_flood_tables;
228 	u16	fid_offset_flood_table_size;
229 	u8	max_fid_flood_tables;
230 	u16	fid_flood_table_size;
231 	u16	max_ib_mc;
232 	u16	max_pkey;
233 	u8	ar_sec;
234 	u16	adaptive_routing_group_cap;
235 	u8	arn;
236 	u32	kvd_linear_size;
237 	u8	kvd_hash_single_parts;
238 	u8	kvd_hash_double_parts;
239 	struct mlxsw_swid_config swid_config[MLXSW_CONFIG_PROFILE_SWID_COUNT];
240 };
241 
242 struct mlxsw_driver {
243 	struct list_head list;
244 	const char *kind;
245 	size_t priv_size;
246 	int (*init)(struct mlxsw_core *mlxsw_core,
247 		    const struct mlxsw_bus_info *mlxsw_bus_info);
248 	void (*fini)(struct mlxsw_core *mlxsw_core);
249 	int (*basic_trap_groups_set)(struct mlxsw_core *mlxsw_core);
250 	int (*port_type_set)(struct mlxsw_core *mlxsw_core, u8 local_port,
251 			     enum devlink_port_type new_type);
252 	int (*port_split)(struct mlxsw_core *mlxsw_core, u8 local_port,
253 			  unsigned int count, struct netlink_ext_ack *extack);
254 	int (*port_unsplit)(struct mlxsw_core *mlxsw_core, u8 local_port,
255 			    struct netlink_ext_ack *extack);
256 	int (*sb_pool_get)(struct mlxsw_core *mlxsw_core,
257 			   unsigned int sb_index, u16 pool_index,
258 			   struct devlink_sb_pool_info *pool_info);
259 	int (*sb_pool_set)(struct mlxsw_core *mlxsw_core,
260 			   unsigned int sb_index, u16 pool_index, u32 size,
261 			   enum devlink_sb_threshold_type threshold_type,
262 			   struct netlink_ext_ack *extack);
263 	int (*sb_port_pool_get)(struct mlxsw_core_port *mlxsw_core_port,
264 				unsigned int sb_index, u16 pool_index,
265 				u32 *p_threshold);
266 	int (*sb_port_pool_set)(struct mlxsw_core_port *mlxsw_core_port,
267 				unsigned int sb_index, u16 pool_index,
268 				u32 threshold, struct netlink_ext_ack *extack);
269 	int (*sb_tc_pool_bind_get)(struct mlxsw_core_port *mlxsw_core_port,
270 				   unsigned int sb_index, u16 tc_index,
271 				   enum devlink_sb_pool_type pool_type,
272 				   u16 *p_pool_index, u32 *p_threshold);
273 	int (*sb_tc_pool_bind_set)(struct mlxsw_core_port *mlxsw_core_port,
274 				   unsigned int sb_index, u16 tc_index,
275 				   enum devlink_sb_pool_type pool_type,
276 				   u16 pool_index, u32 threshold,
277 				   struct netlink_ext_ack *extack);
278 	int (*sb_occ_snapshot)(struct mlxsw_core *mlxsw_core,
279 			       unsigned int sb_index);
280 	int (*sb_occ_max_clear)(struct mlxsw_core *mlxsw_core,
281 				unsigned int sb_index);
282 	int (*sb_occ_port_pool_get)(struct mlxsw_core_port *mlxsw_core_port,
283 				    unsigned int sb_index, u16 pool_index,
284 				    u32 *p_cur, u32 *p_max);
285 	int (*sb_occ_tc_port_bind_get)(struct mlxsw_core_port *mlxsw_core_port,
286 				       unsigned int sb_index, u16 tc_index,
287 				       enum devlink_sb_pool_type pool_type,
288 				       u32 *p_cur, u32 *p_max);
289 	int (*flash_update)(struct mlxsw_core *mlxsw_core,
290 			    const char *file_name, const char *component,
291 			    struct netlink_ext_ack *extack);
292 	void (*txhdr_construct)(struct sk_buff *skb,
293 				const struct mlxsw_tx_info *tx_info);
294 	int (*resources_register)(struct mlxsw_core *mlxsw_core);
295 	int (*kvd_sizes_get)(struct mlxsw_core *mlxsw_core,
296 			     const struct mlxsw_config_profile *profile,
297 			     u64 *p_single_size, u64 *p_double_size,
298 			     u64 *p_linear_size);
299 	int (*params_register)(struct mlxsw_core *mlxsw_core);
300 	void (*params_unregister)(struct mlxsw_core *mlxsw_core);
301 
302 	/* Notify a driver that a timestamped packet was transmitted. Driver
303 	 * is responsible for freeing the passed-in SKB.
304 	 */
305 	void (*ptp_transmitted)(struct mlxsw_core *mlxsw_core,
306 				struct sk_buff *skb, u8 local_port);
307 
308 	u8 txhdr_len;
309 	const struct mlxsw_config_profile *profile;
310 	bool res_query_enabled;
311 };
312 
313 int mlxsw_core_kvd_sizes_get(struct mlxsw_core *mlxsw_core,
314 			     const struct mlxsw_config_profile *profile,
315 			     u64 *p_single_size, u64 *p_double_size,
316 			     u64 *p_linear_size);
317 
318 void mlxsw_core_fw_flash_start(struct mlxsw_core *mlxsw_core);
319 void mlxsw_core_fw_flash_end(struct mlxsw_core *mlxsw_core);
320 
321 u32 mlxsw_core_read_frc_h(struct mlxsw_core *mlxsw_core);
322 u32 mlxsw_core_read_frc_l(struct mlxsw_core *mlxsw_core);
323 
324 bool mlxsw_core_res_valid(struct mlxsw_core *mlxsw_core,
325 			  enum mlxsw_res_id res_id);
326 
327 #define MLXSW_CORE_RES_VALID(mlxsw_core, short_res_id)			\
328 	mlxsw_core_res_valid(mlxsw_core, MLXSW_RES_ID_##short_res_id)
329 
330 u64 mlxsw_core_res_get(struct mlxsw_core *mlxsw_core,
331 		       enum mlxsw_res_id res_id);
332 
333 #define MLXSW_CORE_RES_GET(mlxsw_core, short_res_id)			\
334 	mlxsw_core_res_get(mlxsw_core, MLXSW_RES_ID_##short_res_id)
335 
336 #define MLXSW_BUS_F_TXRX	BIT(0)
337 #define MLXSW_BUS_F_RESET	BIT(1)
338 
339 struct mlxsw_bus {
340 	const char *kind;
341 	int (*init)(void *bus_priv, struct mlxsw_core *mlxsw_core,
342 		    const struct mlxsw_config_profile *profile,
343 		    struct mlxsw_res *res);
344 	void (*fini)(void *bus_priv);
345 	bool (*skb_transmit_busy)(void *bus_priv,
346 				  const struct mlxsw_tx_info *tx_info);
347 	int (*skb_transmit)(void *bus_priv, struct sk_buff *skb,
348 			    const struct mlxsw_tx_info *tx_info);
349 	int (*cmd_exec)(void *bus_priv, u16 opcode, u8 opcode_mod,
350 			u32 in_mod, bool out_mbox_direct,
351 			char *in_mbox, size_t in_mbox_size,
352 			char *out_mbox, size_t out_mbox_size,
353 			u8 *p_status);
354 	u32 (*read_frc_h)(void *bus_priv);
355 	u32 (*read_frc_l)(void *bus_priv);
356 	u8 features;
357 };
358 
359 struct mlxsw_fw_rev {
360 	u16 major;
361 	u16 minor;
362 	u16 subminor;
363 	u16 can_reset_minor;
364 };
365 
366 struct mlxsw_bus_info {
367 	const char *device_kind;
368 	const char *device_name;
369 	struct device *dev;
370 	struct mlxsw_fw_rev fw_rev;
371 	u8 vsd[MLXSW_CMD_BOARDINFO_VSD_LEN];
372 	u8 psid[MLXSW_CMD_BOARDINFO_PSID_LEN];
373 	u8 low_frequency:1,
374 	   read_frc_capable:1;
375 };
376 
377 struct mlxsw_hwmon;
378 
379 #ifdef CONFIG_MLXSW_CORE_HWMON
380 
381 int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
382 		     const struct mlxsw_bus_info *mlxsw_bus_info,
383 		     struct mlxsw_hwmon **p_hwmon);
384 void mlxsw_hwmon_fini(struct mlxsw_hwmon *mlxsw_hwmon);
385 
386 #else
387 
388 static inline int mlxsw_hwmon_init(struct mlxsw_core *mlxsw_core,
389 				   const struct mlxsw_bus_info *mlxsw_bus_info,
390 				   struct mlxsw_hwmon **p_hwmon)
391 {
392 	return 0;
393 }
394 
395 static inline void mlxsw_hwmon_fini(struct mlxsw_hwmon *mlxsw_hwmon)
396 {
397 }
398 
399 #endif
400 
401 struct mlxsw_thermal;
402 
403 #ifdef CONFIG_MLXSW_CORE_THERMAL
404 
405 int mlxsw_thermal_init(struct mlxsw_core *mlxsw_core,
406 		       const struct mlxsw_bus_info *mlxsw_bus_info,
407 		       struct mlxsw_thermal **p_thermal);
408 void mlxsw_thermal_fini(struct mlxsw_thermal *thermal);
409 
410 #else
411 
412 static inline int mlxsw_thermal_init(struct mlxsw_core *mlxsw_core,
413 				     const struct mlxsw_bus_info *mlxsw_bus_info,
414 				     struct mlxsw_thermal **p_thermal)
415 {
416 	return 0;
417 }
418 
419 static inline void mlxsw_thermal_fini(struct mlxsw_thermal *thermal)
420 {
421 }
422 
423 #endif
424 
425 enum mlxsw_devlink_param_id {
426 	MLXSW_DEVLINK_PARAM_ID_BASE = DEVLINK_PARAM_GENERIC_ID_MAX,
427 	MLXSW_DEVLINK_PARAM_ID_ACL_REGION_REHASH_INTERVAL,
428 };
429 
430 struct mlxsw_skb_cb {
431 	struct mlxsw_tx_info tx_info;
432 };
433 
434 static inline struct mlxsw_skb_cb *mlxsw_skb_cb(struct sk_buff *skb)
435 {
436 	BUILD_BUG_ON(sizeof(mlxsw_skb_cb) > sizeof(skb->cb));
437 	return (struct mlxsw_skb_cb *) skb->cb;
438 }
439 
440 #endif
441