1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright 2014-2016 Freescale Semiconductor Inc.
4 * Copyright 2017-2018 NXP
11 /* Data Path L2-Switch API
12 * Contains API for handling DPSW topology and functionality
18 * DPSW general definitions
22 * Maximum number of traffic class priorities
24 #define DPSW_MAX_PRIORITIES 8
26 * Maximum number of interfaces
28 #define DPSW_MAX_IF 64
30 int dpsw_open(struct fsl_mc_io *mc_io,
35 int dpsw_close(struct fsl_mc_io *mc_io,
46 #define DPSW_OPT_FLOODING_DIS 0x0000000000000001ULL
50 #define DPSW_OPT_MULTICAST_DIS 0x0000000000000004ULL
52 * Support control interface
54 #define DPSW_OPT_CTRL_IF_DIS 0x0000000000000010ULL
56 * Disable flooding metering
58 #define DPSW_OPT_FLOODING_METERING_DIS 0x0000000000000020ULL
62 #define DPSW_OPT_METERING_EN 0x0000000000000040ULL
65 * enum dpsw_component_type - component type of a bridge
66 * @DPSW_COMPONENT_TYPE_C_VLAN: A C-VLAN component of an
67 * enterprise VLAN bridge or of a Provider Bridge used
68 * to process C-tagged frames
69 * @DPSW_COMPONENT_TYPE_S_VLAN: An S-VLAN component of a
73 enum dpsw_component_type {
74 DPSW_COMPONENT_TYPE_C_VLAN = 0,
75 DPSW_COMPONENT_TYPE_S_VLAN
78 int dpsw_enable(struct fsl_mc_io *mc_io,
82 int dpsw_disable(struct fsl_mc_io *mc_io,
86 int dpsw_reset(struct fsl_mc_io *mc_io,
91 * DPSW IRQ Index and Events
94 #define DPSW_IRQ_INDEX_IF 0x0000
95 #define DPSW_IRQ_INDEX_L2SW 0x0001
98 * IRQ event - Indicates that the link state changed
100 #define DPSW_IRQ_EVENT_LINK_CHANGED 0x0001
103 * struct dpsw_irq_cfg - IRQ configuration
104 * @addr: Address that must be written to signal a message-based interrupt
105 * @val: Value to write into irq_addr address
106 * @irq_num: A user defined number associated with this IRQ
108 struct dpsw_irq_cfg {
114 int dpsw_set_irq_enable(struct fsl_mc_io *mc_io,
120 int dpsw_set_irq_mask(struct fsl_mc_io *mc_io,
126 int dpsw_get_irq_status(struct fsl_mc_io *mc_io,
132 int dpsw_clear_irq_status(struct fsl_mc_io *mc_io,
139 * struct dpsw_attr - Structure representing DPSW attributes
140 * @id: DPSW object ID
141 * @options: Enable/Disable DPSW features
142 * @max_vlans: Maximum Number of VLANs
143 * @max_meters_per_if: Number of meters per interface
144 * @max_fdbs: Maximum Number of FDBs
145 * @max_fdb_entries: Number of FDB entries for default FDB table;
146 * 0 - indicates default 1024 entries.
147 * @fdb_aging_time: Default FDB aging time for default FDB table;
148 * 0 - indicates default 300 seconds
149 * @max_fdb_mc_groups: Number of multicast groups in each FDB table;
150 * 0 - indicates default 32
151 * @mem_size: DPSW frame storage memory size
152 * @num_ifs: Number of interfaces
153 * @num_vlans: Current number of VLANs
154 * @num_fdbs: Current number of FDBs
155 * @component_type: Component type of this bridge
161 u8 max_meters_per_if;
165 u16 max_fdb_mc_groups;
170 enum dpsw_component_type component_type;
173 int dpsw_get_attributes(struct fsl_mc_io *mc_io,
176 struct dpsw_attr *attr);
179 * enum dpsw_action - Action selection for special/control frames
180 * @DPSW_ACTION_DROP: Drop frame
181 * @DPSW_ACTION_REDIRECT: Redirect frame to control port
184 DPSW_ACTION_DROP = 0,
185 DPSW_ACTION_REDIRECT = 1
189 * Enable auto-negotiation
191 #define DPSW_LINK_OPT_AUTONEG 0x0000000000000001ULL
193 * Enable half-duplex mode
195 #define DPSW_LINK_OPT_HALF_DUPLEX 0x0000000000000002ULL
197 * Enable pause frames
199 #define DPSW_LINK_OPT_PAUSE 0x0000000000000004ULL
201 * Enable a-symmetric pause frames
203 #define DPSW_LINK_OPT_ASYM_PAUSE 0x0000000000000008ULL
206 * struct dpsw_link_cfg - Structure representing DPSW link configuration
208 * @options: Mask of available options; use 'DPSW_LINK_OPT_<X>' values
210 struct dpsw_link_cfg {
215 int dpsw_if_set_link_cfg(struct fsl_mc_io *mc_io,
219 struct dpsw_link_cfg *cfg);
221 * struct dpsw_link_state - Structure representing DPSW link state
223 * @options: Mask of available options; use 'DPSW_LINK_OPT_<X>' values
224 * @up: 0 - covers two cases: down and disconnected, 1 - up
226 struct dpsw_link_state {
232 int dpsw_if_get_link_state(struct fsl_mc_io *mc_io,
236 struct dpsw_link_state *state);
238 int dpsw_if_set_flooding(struct fsl_mc_io *mc_io,
244 int dpsw_if_set_broadcast(struct fsl_mc_io *mc_io,
251 * struct dpsw_tci_cfg - Tag Control Information (TCI) configuration
252 * @pcp: Priority Code Point (PCP): a 3-bit field which refers
253 * to the IEEE 802.1p priority
254 * @dei: Drop Eligible Indicator (DEI): a 1-bit field. May be used
255 * separately or in conjunction with PCP to indicate frames
256 * eligible to be dropped in the presence of congestion
257 * @vlan_id: VLAN Identifier (VID): a 12-bit field specifying the VLAN
258 * to which the frame belongs. The hexadecimal values
259 * of 0x000 and 0xFFF are reserved;
260 * all other values may be used as VLAN identifiers,
261 * allowing up to 4,094 VLANs
263 struct dpsw_tci_cfg {
269 int dpsw_if_set_tci(struct fsl_mc_io *mc_io,
273 const struct dpsw_tci_cfg *cfg);
275 int dpsw_if_get_tci(struct fsl_mc_io *mc_io,
279 struct dpsw_tci_cfg *cfg);
282 * enum dpsw_stp_state - Spanning Tree Protocol (STP) states
283 * @DPSW_STP_STATE_BLOCKING: Blocking state
284 * @DPSW_STP_STATE_LISTENING: Listening state
285 * @DPSW_STP_STATE_LEARNING: Learning state
286 * @DPSW_STP_STATE_FORWARDING: Forwarding state
289 enum dpsw_stp_state {
290 DPSW_STP_STATE_DISABLED = 0,
291 DPSW_STP_STATE_LISTENING = 1,
292 DPSW_STP_STATE_LEARNING = 2,
293 DPSW_STP_STATE_FORWARDING = 3,
294 DPSW_STP_STATE_BLOCKING = 0
298 * struct dpsw_stp_cfg - Spanning Tree Protocol (STP) Configuration
299 * @vlan_id: VLAN ID STP state
302 struct dpsw_stp_cfg {
304 enum dpsw_stp_state state;
307 int dpsw_if_set_stp(struct fsl_mc_io *mc_io,
311 const struct dpsw_stp_cfg *cfg);
314 * enum dpsw_accepted_frames - Types of frames to accept
315 * @DPSW_ADMIT_ALL: The device accepts VLAN tagged, untagged and
316 * priority tagged frames
317 * @DPSW_ADMIT_ONLY_VLAN_TAGGED: The device discards untagged frames or
318 * Priority-Tagged frames received on this interface.
321 enum dpsw_accepted_frames {
323 DPSW_ADMIT_ONLY_VLAN_TAGGED = 3
327 * enum dpsw_counter - Counters types
328 * @DPSW_CNT_ING_FRAME: Counts ingress frames
329 * @DPSW_CNT_ING_BYTE: Counts ingress bytes
330 * @DPSW_CNT_ING_FLTR_FRAME: Counts filtered ingress frames
331 * @DPSW_CNT_ING_FRAME_DISCARD: Counts discarded ingress frame
332 * @DPSW_CNT_ING_MCAST_FRAME: Counts ingress multicast frames
333 * @DPSW_CNT_ING_MCAST_BYTE: Counts ingress multicast bytes
334 * @DPSW_CNT_ING_BCAST_FRAME: Counts ingress broadcast frames
335 * @DPSW_CNT_ING_BCAST_BYTES: Counts ingress broadcast bytes
336 * @DPSW_CNT_EGR_FRAME: Counts egress frames
337 * @DPSW_CNT_EGR_BYTE: Counts egress bytes
338 * @DPSW_CNT_EGR_FRAME_DISCARD: Counts discarded egress frames
339 * @DPSW_CNT_EGR_STP_FRAME_DISCARD: Counts egress STP discarded frames
340 * @DPSW_CNT_ING_NO_BUFF_DISCARD: Counts ingress no buffer discarded frames
343 DPSW_CNT_ING_FRAME = 0x0,
344 DPSW_CNT_ING_BYTE = 0x1,
345 DPSW_CNT_ING_FLTR_FRAME = 0x2,
346 DPSW_CNT_ING_FRAME_DISCARD = 0x3,
347 DPSW_CNT_ING_MCAST_FRAME = 0x4,
348 DPSW_CNT_ING_MCAST_BYTE = 0x5,
349 DPSW_CNT_ING_BCAST_FRAME = 0x6,
350 DPSW_CNT_ING_BCAST_BYTES = 0x7,
351 DPSW_CNT_EGR_FRAME = 0x8,
352 DPSW_CNT_EGR_BYTE = 0x9,
353 DPSW_CNT_EGR_FRAME_DISCARD = 0xa,
354 DPSW_CNT_EGR_STP_FRAME_DISCARD = 0xb,
355 DPSW_CNT_ING_NO_BUFF_DISCARD = 0xc,
358 int dpsw_if_get_counter(struct fsl_mc_io *mc_io,
362 enum dpsw_counter type,
365 int dpsw_if_enable(struct fsl_mc_io *mc_io,
370 int dpsw_if_disable(struct fsl_mc_io *mc_io,
375 int dpsw_if_set_max_frame_length(struct fsl_mc_io *mc_io,
382 * struct dpsw_vlan_cfg - VLAN Configuration
383 * @fdb_id: Forwarding Data Base
385 struct dpsw_vlan_cfg {
389 int dpsw_vlan_add(struct fsl_mc_io *mc_io,
393 const struct dpsw_vlan_cfg *cfg);
396 * struct dpsw_vlan_if_cfg - Set of VLAN Interfaces
397 * @num_ifs: The number of interfaces that are assigned to the egress
399 * @if_id: The set of interfaces that are
400 * assigned to the egress list for this VLAN
402 struct dpsw_vlan_if_cfg {
404 u16 if_id[DPSW_MAX_IF];
407 int dpsw_vlan_add_if(struct fsl_mc_io *mc_io,
411 const struct dpsw_vlan_if_cfg *cfg);
413 int dpsw_vlan_add_if_untagged(struct fsl_mc_io *mc_io,
417 const struct dpsw_vlan_if_cfg *cfg);
419 int dpsw_vlan_remove_if(struct fsl_mc_io *mc_io,
423 const struct dpsw_vlan_if_cfg *cfg);
425 int dpsw_vlan_remove_if_untagged(struct fsl_mc_io *mc_io,
429 const struct dpsw_vlan_if_cfg *cfg);
431 int dpsw_vlan_remove(struct fsl_mc_io *mc_io,
437 * enum dpsw_fdb_entry_type - FDB Entry type - Static/Dynamic
438 * @DPSW_FDB_ENTRY_STATIC: Static entry
439 * @DPSW_FDB_ENTRY_DINAMIC: Dynamic entry
441 enum dpsw_fdb_entry_type {
442 DPSW_FDB_ENTRY_STATIC = 0,
443 DPSW_FDB_ENTRY_DINAMIC = 1
447 * struct dpsw_fdb_unicast_cfg - Unicast entry configuration
448 * @type: Select static or dynamic entry
449 * @mac_addr: MAC address
450 * @if_egress: Egress interface ID
452 struct dpsw_fdb_unicast_cfg {
453 enum dpsw_fdb_entry_type type;
458 int dpsw_fdb_add_unicast(struct fsl_mc_io *mc_io,
462 const struct dpsw_fdb_unicast_cfg *cfg);
464 int dpsw_fdb_remove_unicast(struct fsl_mc_io *mc_io,
468 const struct dpsw_fdb_unicast_cfg *cfg);
470 #define DPSW_FDB_ENTRY_TYPE_DYNAMIC BIT(0)
471 #define DPSW_FDB_ENTRY_TYPE_UNICAST BIT(1)
474 * struct fdb_dump_entry - fdb snapshot entry
475 * @mac_addr: MAC address
476 * @type: bit0 - DINAMIC(1)/STATIC(0), bit1 - UNICAST(1)/MULTICAST(0)
477 * @if_info: unicast - egress interface, multicast - number of egress interfaces
478 * @if_mask: multicast - egress interface mask
480 struct fdb_dump_entry {
487 int dpsw_fdb_dump(struct fsl_mc_io *mc_io,
496 * struct dpsw_fdb_multicast_cfg - Multi-cast entry configuration
497 * @type: Select static or dynamic entry
498 * @mac_addr: MAC address
499 * @num_ifs: Number of external and internal interfaces
500 * @if_id: Egress interface IDs
502 struct dpsw_fdb_multicast_cfg {
503 enum dpsw_fdb_entry_type type;
506 u16 if_id[DPSW_MAX_IF];
509 int dpsw_fdb_add_multicast(struct fsl_mc_io *mc_io,
513 const struct dpsw_fdb_multicast_cfg *cfg);
515 int dpsw_fdb_remove_multicast(struct fsl_mc_io *mc_io,
519 const struct dpsw_fdb_multicast_cfg *cfg);
522 * enum dpsw_fdb_learning_mode - Auto-learning modes
523 * @DPSW_FDB_LEARNING_MODE_DIS: Disable Auto-learning
524 * @DPSW_FDB_LEARNING_MODE_HW: Enable HW auto-Learning
525 * @DPSW_FDB_LEARNING_MODE_NON_SECURE: Enable None secure learning by CPU
526 * @DPSW_FDB_LEARNING_MODE_SECURE: Enable secure learning by CPU
528 * NONE - SECURE LEARNING
529 * SMAC found DMAC found CTLU Action
530 * v v Forward frame to
531 * 1. DMAC destination
532 * - v Forward frame to
533 * 1. DMAC destination
534 * 2. Control interface
535 * v - Forward frame to
536 * 1. Flooding list of interfaces
537 * - - Forward frame to
538 * 1. Flooding list of interfaces
539 * 2. Control interface
541 * SMAC found DMAC found CTLU Action
542 * v v Forward frame to
543 * 1. DMAC destination
544 * - v Forward frame to
545 * 1. Control interface
546 * v - Forward frame to
547 * 1. Flooding list of interfaces
548 * - - Forward frame to
549 * 1. Control interface
551 enum dpsw_fdb_learning_mode {
552 DPSW_FDB_LEARNING_MODE_DIS = 0,
553 DPSW_FDB_LEARNING_MODE_HW = 1,
554 DPSW_FDB_LEARNING_MODE_NON_SECURE = 2,
555 DPSW_FDB_LEARNING_MODE_SECURE = 3
558 int dpsw_fdb_set_learning_mode(struct fsl_mc_io *mc_io,
562 enum dpsw_fdb_learning_mode mode);
565 * struct dpsw_fdb_attr - FDB Attributes
566 * @max_fdb_entries: Number of FDB entries
567 * @fdb_aging_time: Aging time in seconds
568 * @learning_mode: Learning mode
569 * @num_fdb_mc_groups: Current number of multicast groups
570 * @max_fdb_mc_groups: Maximum number of multicast groups
572 struct dpsw_fdb_attr {
575 enum dpsw_fdb_learning_mode learning_mode;
576 u16 num_fdb_mc_groups;
577 u16 max_fdb_mc_groups;
580 int dpsw_get_api_version(struct fsl_mc_io *mc_io,
585 int dpsw_if_get_port_mac_addr(struct fsl_mc_io *mc_io, u32 cmd_flags, u16 token,
586 u16 if_id, u8 mac_addr[6]);
588 int dpsw_if_get_primary_mac_addr(struct fsl_mc_io *mc_io, u32 cmd_flags,
589 u16 token, u16 if_id, u8 mac_addr[6]);
591 int dpsw_if_set_primary_mac_addr(struct fsl_mc_io *mc_io, u32 cmd_flags,
592 u16 token, u16 if_id, u8 mac_addr[6]);
594 #endif /* __FSL_DPSW_H */