freescale/dpaa2/dpsw.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * Copyright 2014-2016 Freescale Semiconductor Inc.
4  * Copyright 2017-2021 NXP
11 /* Data Path L2-Switch API
30  * DPSW_OPT_FLOODING_DIS - Flooding was disabled at device create
34  * DPSW_OPT_MULTICAST_DIS - Multicast was disabled at device create
38  * DPSW_OPT_CTRL_IF_DIS - Control interface support is disabled
43  * enum dpsw_component_type - component type of a bridge
44  * @DPSW_COMPONENT_TYPE_C_VLAN: A C-VLAN component of an
46  *   to process C-tagged frames
47  * @DPSW_COMPONENT_TYPE_S_VLAN: An S-VLAN component of a
57  *  enum dpsw_flooding_cfg - flooding configuration requested
73  * enum dpsw_broadcast_cfg - broadcast configuration requested
97  * DPSW_IRQ_EVENT_LINK_CHANGED - Indicates that the link state changed
102  * DPSW_IRQ_EVENT_ENDPOINT_CHANGED - Indicates a change in endpoint
107  * struct dpsw_irq_cfg - IRQ configuration
108  * @addr:	Address that must be written to signal a message-based interrupt
110  * @irq_num: A user defined number associated with this IRQ
131  * struct dpsw_attr - Structure representing DPSW attributes
134  * @max_vlans: Maximum Number of VLANs
135  * @max_meters_per_if:  Number of meters per interface
136  * @max_fdbs: Maximum Number of FDBs
137  * @max_fdb_entries: Number of FDB entries for default FDB table;
138  *			0 - indicates default 1024 entries.
140  *			0 - indicates default 300 seconds
141  * @max_fdb_mc_groups: Number of multicast groups in each FDB table;
142  *			0 - indicates default 32
143  * @mem_size: DPSW frame storage memory size
144  * @num_ifs: Number of interfaces
145  * @num_vlans: Current number of VLANs
146  * @num_fdbs: Current number of FDBs
148  * @flooding_cfg: Flooding configuration (PER_VLAN - default, PER_FDB)
149  * @broadcast_cfg: Broadcast configuration (PER_OBJECT - default, PER_FDB)
173  * struct dpsw_ctrl_if_attr - Control interface attributes
196  * struct dpsw_ctrl_if_pools_cfg - Control interface buffer pools configuration
197  * @num_dpbp: Number of DPBPs
198  * @pools: Array of buffer pools parameters; The number of valid entries
245  * enum dpsw_action - Action selection for special/control frames
246  * @DPSW_ACTION_DROP: Drop frame
247  * @DPSW_ACTION_REDIRECT: Redirect frame to control port
260  * struct dpsw_link_cfg - Structure representing DPSW link configuration
273  * struct dpsw_link_state - Structure representing DPSW link state
276  * @up: 0 - covers two cases: down and disconnected, 1 - up
288  * struct dpsw_tci_cfg - Tag Control Information (TCI) configuration
289  * @pcp: Priority Code Point (PCP): a 3-bit field which refers
291  * @dei: Drop Eligible Indicator (DEI): a 1-bit field. May be used
294  * @vlan_id: VLAN Identifier (VID): a 12-bit field specifying the VLAN
295  *			to which the frame belongs. The hexadecimal values
313  * enum dpsw_stp_state - Spanning Tree Protocol (STP) states
330  * struct dpsw_stp_cfg - Spanning Tree Protocol (STP) Configuration
343  * enum dpsw_accepted_frames - Types of frames to accept
347  *			Priority-Tagged frames received on this interface.
356  * enum dpsw_counter  - Counters types
360  * @DPSW_CNT_ING_FRAME_DISCARD: Counts discarded ingress frame
395  * struct dpsw_if_attr - Structure representing DPSW interface attributes
396  * @num_tcs: Number of traffic classes
403  *		discards untagged frames or priority-tagged frames received on
405  *		When set to 'DPSW_ADMIT_ALL', untagged frames or priority-
426  * struct dpsw_vlan_cfg - VLAN Configuration
439  * struct dpsw_vlan_if_cfg - Set of VLAN Interfaces
440  * @num_ifs: The number of interfaces that are assigned to the egress
472  * enum dpsw_fdb_entry_type - FDB Entry type - Static/Dynamic
482  * struct dpsw_fdb_unicast_cfg - Unicast entry configuration
503  * struct fdb_dump_entry - fdb snapshot entry
505  * @type: bit0 - DINAMIC(1)/STATIC(0), bit1 - UNICAST(1)/MULTICAST(0)
506  * @if_info: unicast - egress interface, multicast - number of egress interfaces
507  * @if_mask: multicast - egress interface mask
520  * struct dpsw_fdb_multicast_cfg - Multi-cast entry configuration
523  * @num_ifs: Number of external and internal interfaces
540  * enum dpsw_learning_mode - Auto-learning modes
541  * @DPSW_LEARNING_MODE_DIS: Disable Auto-learning
542  * @DPSW_LEARNING_MODE_HW: Enable HW auto-Learning
546  *	NONE - SECURE LEARNING
548  *	v		v	Forward frame to
550  *	-		v	Forward frame to
553  *	v		-	Forward frame to
555  *	-		-	Forward frame to
560  *	v		v		Forward frame to
562  *	-		v		Forward frame to
564  *	v		-		Forward frame to
566  *	-		-		Forward frame to
577  * struct dpsw_fdb_attr - FDB Attributes
578  * @max_fdb_entries: Number of FDB entries
581  * @num_fdb_mc_groups: Current number of multicast groups
582  * @max_fdb_mc_groups: Maximum number of multicast groups
599  * struct dpsw_fdb_cfg  - FDB Configuration
600  * @num_fdb_entries: Number of FDB entries
614  * enum dpsw_flood_type - Define the flood type of a DPSW object
637  * struct dpsw_acl_cfg - ACL Configuration
638  * @max_entries: Number of ACL rules
651  * struct dpsw_acl_if_cfg - List of interfaces to associate with an ACL table
652  * @num_ifs: Number of interfaces
667  * struct dpsw_acl_fields - ACL fields.
673  *		Q-in-Q, IPv4, IPv6, PPPoE
703  * struct dpsw_acl_key - ACL key
705  * @mask: Mask: b'1 - valid, b'0 don't care
713  * enum dpsw_acl_action - action to be run on the ACL rule match
714  * @DPSW_ACL_ACTION_DROP: Drop frame
716  * @DPSW_ACL_ACTION_ACCEPT: Accept frame
727  * struct dpsw_acl_result - ACL action
729  * @if_id:  Interface IDs to redirect frame. Valid only if redirect selected for
738  * struct dpsw_acl_entry_cfg - ACL entry
739  * @key_iova: I/O virtual address of DMA-able memory filled with key after call
762  * enum dpsw_reflection_filter - Filter type for frames to be reflected
774  * struct dpsw_reflection_cfg - Structure representing the mirroring config