NXP Semiconductors
Document Number: DPAA2UM
Rev 36, 10/2020
DPAA2 User Manual
(Compatible with MC firmware v10.25.x)
NXP, the NXP logo, Freescale, the Freescale logo, CodeWarrior, Layerscape, PowerQUICC,
QorIQ, CoreNet, and QUICC Engine are trademarks of NXP B.V. All other product or service
names are the property of their respective owners. Arm, Cortex, and TrustZone are
registered trademarks of Arm Limited (or its subsidiaries) in the EU and/or elsewhere. All
rights reserved.
© 2015–2020 NXP B.V.
Information in this document is provided solely to enable system and software implementers
to use NXP products. There are no express or implied copyright licenses granted hereunder
to design or fabricate any integrated circuits based on the information in this document.
NXP reserves the right to make changes without further notice to any products herein. NXP
makes no warranty, representation, or guarantee regarding the suitability of its products for
any particular purpose, nor does NXP assume any liability arising out of the application or
use of any product or circuit, and specifically disclaims any and all liability, including without
limitation consequential or incidental damages.“Typical” parameters that may be provided in
NXP data sheets and/or specifications can and do vary in different applications, and actual
performance may vary over time. All operating parameters, including “typicals,” must be
validated for each customer application by customer’s technical experts. NXP does not
convey any license under its patent rights nor the rights of others. NXP sells products
pursuant to standard terms and conditions of sale, which can be found at the following
address: nxp.com/SalesTermsandConditions.
DPAA2UM
Rev 36, 10/2020
How to Reach Us:
Home Page:
nxp.com
Web Support:
nxp.com/support
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -iii
Contents
Paragraph
Number Title
Page
Number
Rev 36, 10/2020Contents
Chapter 1 Introduction
1.1 Intended audience ............................................................................................................1-2
1.2 Definitions and acronyms ................................................................................................ 1-2
Chapter 2 Overview
2.1 Introduction to DPAA2 objects........................................................................................ 2-1
2.1.1 Network objects ........................................................................................................... 2-2
2.1.1.1 Data Path Network Interface (DPNI) ...................................................................... 2-2
2.1.1.2 Data Path MAC (DPMAC)...................................................................................... 2-2
2.1.1.3 Data Path Switch (DPSW)....................................................................................... 2-2
2.1.1.4 Data Path Demux (DPDMUX)................................................................................ 2-3
2.1.2 DPAA2 infrastructure objects...................................................................................... 2-3
2.1.2.1 Data Path Buffer Pool (DPBP) ................................................................................ 2-4
2.1.2.2 Data Path I/O Portal (DPIO).................................................................................... 2-4
2.1.2.3 Data Path Concentrator (DPCON)........................................................................... 2-4
2.1.3 Accelerator interfaces .................................................................................................. 2-5
2.1.3.1 Data Path Security Interface (DPSECI)................................................................... 2-5
2.1.3.2 Data Path De/Compression Interface (DPDCEI) .................................................... 2-5
2.1.3.3 Data Path DMA Interface (DPDMAI)..................................................................... 2-5
2.1.4 Management and control objects ................................................................................. 2-6
2.1.4.1 Data Path Communication Interface (DPCI)........................................................... 2-6
2.1.4.2 Data Path Resource Container (DPRC)................................................................... 2-6
2.1.4.3 Data Path MC Portal (DPMCP)............................................................................... 2-7
2.1.5 DPAA2 object support per platform ............................................................................ 2-7
2.2 Objects topology and inter-connect ................................................................................. 2-8
2.2.1 Connection and link state........................................................................................... 2-10
2.2.2 Typical object connections......................................................................................... 2-10
2.2.3 How and when to connect.......................................................................................... 2-12
Chapter 3 Boot and Initialization Process
3.1 Loading the MC firmware ............................................................................................... 3-1
3.2 Data Path Configuration (DPC)....................................................................................... 3-1
3.3 Data Path Layout (DPL) .................................................................................................. 3-1
3.4 Starting MC...................................................................................................................... 3-2
3.5 Minimum memory requirements ..................................................................................... 3-3
DPAA2UM, Rev 36, 10/2020
-iv NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
Chapter 4 MC Firmware Versions
4.1 MC global firmware versions .......................................................................................... 4-1
4.2 DPAA2 Object versions................................................................................................... 4-1
4.3 DPAA2 Object Commands .............................................................................................. 4-1
4.4 Recommended user verification ...................................................................................... 4-2
4.5 Firmware command reference ......................................................................................... 4-3
4.5.1 DPMNG_GET_VERSION.......................................................................................... 4-3
4.5.2 DPMNG_GET_SOC_VERSION ................................................................................ 4-5
Chapter 5 Management Command Portals
5.1 Overview of command portals......................................................................................... 5-1
5.2 Command portal usage .................................................................................................... 5-1
5.3 Creating and destroying DPAA2 objects ......................................................................... 5-2
5.4 Command portals memory map....................................................................................... 5-3
5.5 Management command portal definition......................................................................... 5-4
5.6 MC General Command Portals command reference ....................................................... 5-6
5.6.1 DPMNG_GET_CONT_ID .......................................................................................... 5-6
Chapter 6 DPRC: Data Path Resource Container
6.1 DPRC features ................................................................................................................. 6-1
6.2 DPRC functional description ........................................................................................... 6-2
6.2.1 Resource container creation......................................................................................... 6-2
6.2.2 Objects assignment ...................................................................................................... 6-2
6.2.3 Objects discovery......................................................................................................... 6-2
6.3 DPRC command reference .............................................................................................. 6-3
6.3.1 DPRC_OPEN............................................................................................................... 6-3
6.3.2 DPRC_CLOSE ............................................................................................................ 6-4
6.3.3 DPRC_CREATE_CONTAINER ................................................................................. 6-5
6.3.4 DPRC_DESTROY_CONTAINER.............................................................................. 6-7
6.3.5 DPRC_RESET_CONTAINER.................................................................................... 6-8
6.3.6 DPRC_SET_LOCKED.............................................................................................. 6-10
6.3.7 DPRC_SET_IRQ....................................................................................................... 6-11
6.3.8 DPRC_GET_IRQ ...................................................................................................... 6-12
6.3.9 DPRC_SET_IRQ_ENABLE ..................................................................................... 6-14
6.3.10 DPRC_GET_IRQ_ENABLE..................................................................................... 6-15
6.3.11 DPRC_SET_IRQ_MASK ......................................................................................... 6-17
6.3.12 DPRC_GET_IRQ_MASK......................................................................................... 6-18
6.3.13 DPRC_GET_IRQ_STATUS...................................................................................... 6-20
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -v
Contents
Paragraph
Number Title
Page
Number
6.3.14 DPRC_CLEAR_IRQ_STATUS................................................................................. 6-22
6.3.15 DPRC_GET_ATTRIBUTES ..................................................................................... 6-23
6.3.16 DPRC_SET_RES_QUOTA....................................................................................... 6-25
6.3.17 DPRC_GET_RES_QUOTA ...................................................................................... 6-26
6.3.18 DPRC_ASSIGN......................................................................................................... 6-28
6.3.19 DPRC_UNASSIGN................................................................................................... 6-29
6.3.20 DPRC_GET_POOL_COUNT................................................................................... 6-30
6.3.21 DPRC_GET_POOL................................................................................................... 6-32
6.3.22 DPRC_GET_OBJ_COUNT ...................................................................................... 6-34
6.3.23 DPRC_GET_OBJ ...................................................................................................... 6-36
6.3.24 DPRC_GET_OBJ_DESC.......................................................................................... 6-38
6.3.25 DPRC_GET_RES_COUNT ...................................................................................... 6-40
6.3.26 DPRC_GET_RES_IDS ............................................................................................. 6-42
6.3.27 DPRC_GET_OBJ_REGION..................................................................................... 6-44
6.3.28 DPRC_SET_OBJ_LABEL........................................................................................ 6-46
6.3.29 DPRC_SET_OBJ_IRQ.............................................................................................. 6-47
6.3.30 DPRC_GET_OBJ_IRQ ............................................................................................. 6-48
6.3.31 DPRC_CONNECT .................................................................................................... 6-50
6.3.32 DPRC_DISCONNECT.............................................................................................. 6-51
6.3.33 DPRC_GET_CONNECTION ................................................................................... 6-52
6.3.34 DPRC_GET_API_VERSION ................................................................................... 6-54
Chapter 7 DPNI: Data Path Network Interface
7.1 DPNI features .................................................................................................................. 7-1
7.2 DPNI functional description ............................................................................................ 7-3
7.2.1 Ingress frame processing ............................................................................................. 7-3
7.2.2 Egress frame processing .............................................................................................. 7-4
7.2.3 Relationship with DPIO and DPCON objects ............................................................. 7-5
7.2.4 Relationship with DPBP objects.................................................................................. 7-6
7.2.5 Ingress QoS.................................................................................................................. 7-6
7.2.6 Ingress distribution ...................................................................................................... 7-7
7.2.6.1 Building rules for ingress distribution ..................................................................... 7-8
7.2.7 Flow control................................................................................................................. 7-8
7.2.7.1 Flow control configuration ...................................................................................... 7-8
7.2.7.2 Priority flow control configuration.......................................................................... 7-9
7.2.8 Policer .......................................................................................................................... 7-9
7.2.8.1 Metering principles.................................................................................................. 7-9
7.2.8.2 RFC-2698 .............................................................................................................. 7-10
7.2.8.3 RFC-4115............................................................................................................... 7-10
7.2.8.4 Pass-Through ......................................................................................................... 7-10
DPAA2UM, Rev 36, 10/2020
-vi NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
7.3 DPNI command reference ............................................................................................. 7-11
7.3.1 DPNI_CREATE ......................................................................................................... 7-11
7.3.2 DPNI_DESTROY...................................................................................................... 7-15
7.3.3 DPNI_OPEN.............................................................................................................. 7-16
7.3.4 DPNI_CLOSE ........................................................................................................... 7-17
7.3.5 DPNI_ENABLE ........................................................................................................ 7-18
7.3.6 DPNI_DISABLE ....................................................................................................... 7-19
7.3.7 DPNI_IS_ENABLED................................................................................................ 7-20
7.3.8 DPNI_RESET............................................................................................................ 7-22
7.3.9 DPNI_SET_IRQ_ENABLE ...................................................................................... 7-23
7.3.10 DPNI_GET_IRQ_ENABLE...................................................................................... 7-24
7.3.11 DPNI_SET_IRQ_MASK........................................................................................... 7-26
7.3.12 DPNI_GET_IRQ_MASK.......................................................................................... 7-27
7.3.13 DPNI_GET_IRQ_STATUS ....................................................................................... 7-29
7.3.14 DPNI_CLEAR_IRQ_STATUS.................................................................................. 7-31
7.3.15 DPNI_GET_ATTRIBUTES ...................................................................................... 7-32
7.3.16 DPNI_SET_POOLS .................................................................................................. 7-36
7.3.17 DPNI_SET_ERRORS_BEHAVIOR ......................................................................... 7-39
7.3.18 DPNI_SET_BUFFER_LAYOUT.............................................................................. 7-41
7.3.19 DPNI_GET_BUFFER_LAYOUT ............................................................................. 7-44
7.3.20 DPNI_SET_OFFLOAD............................................................................................. 7-46
7.3.21 DPNI_GET_OFFLOAD............................................................................................ 7-47
7.3.22 DPNI_GET_QDID .................................................................................................... 7-49
7.3.23 DPNI_GET_SP_INFO............................................................................................... 7-52
7.3.24 DPNI_GET_TX_DATA_OFFSET ............................................................................ 7-54
7.3.25 DPNI_GET_STATISTICS......................................................................................... 7-56
7.3.26 DPNI_RESET_STATISTICS .................................................................................... 7-59
7.3.27 DPNI_SET_LINK_CFG............................................................................................ 7-60
7.3.28 DPNI_GET_LINK_CFG ........................................................................................... 7-62
7.3.29 DPNI_SET_SINGLE_STEP_CFG............................................................................ 7-64
7.3.30 DPNI_GET_SINGLE_STEP_CGF ........................................................................... 7-65
7.3.31 DPNI_SET_PORT_CFG ........................................................................................... 7-67
7.3.32 DPNI_GET_PORT_CGF........................................................................................... 7-68
7.3.33 DPNI_GET_LINK_STATE ....................................................................................... 7-70
7.3.34 DPNI_SET_TX_SHAPING ...................................................................................... 7-72
7.3.35 DPNI_SET_MAX_FRAME_LENGTH.................................................................... 7-74
7.3.36 DPNI_GET_MAX_FRAME_LENGTH ................................................................... 7-75
7.3.37 DPNI_SET_MULTICAST_PROMISC..................................................................... 7-77
7.3.38 DPNI_GET_MULTICAST_PROMISC .................................................................... 7-78
7.3.39 DPNI_SET_UNICAST_PROMISC .......................................................................... 7-80
7.3.40 DPNI_GET_UNICAST_PROMISC ......................................................................... 7-81
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -vii
Contents
Paragraph
Number Title
Page
Number
7.3.41 DPNI_SET_PRIMARY_MAC_ADDR..................................................................... 7-83
7.3.42 DPNI_GET_PRIMARY_MAC_ADDR.................................................................... 7-84
7.3.43 DPNI_ADD_MAC_ADDR ....................................................................................... 7-86
7.3.44 DPNI_REMOVE_MAC_ADDR............................................................................... 7-87
7.3.45 DPNI_CLEAR_MAC_FILTERS .............................................................................. 7-88
7.3.46 DPNI_GET_PORT_MAC_ADDRESS..................................................................... 7-89
7.3.47 DPNI_ENABLE_VLAN_FILTER............................................................................ 7-91
7.3.48 DPNI_ADD_VLAN_ID ............................................................................................ 7-92
7.3.49 DPNI_REMOVE_VLAN_ID.................................................................................... 7-93
7.3.50 DPNI_CLEAR_VLAN_FILTERS ............................................................................ 7-94
7.3.51 DPNI_SET_TX_PRIORITIES .................................................................................. 7-95
7.3.52 DPNI_SET_RX_TC_DIST ....................................................................................... 7-97
7.3.53 DPNI_SET_RX_TC_POLICING............................................................................ 7-102
7.3.54 DPNI_GET_RX_TC_POLICING........................................................................... 7-104
7.3.55 DPNI_SET_TAILDROP.......................................................................................... 7-107
7.3.56 DPNI_GET_TAILDROP......................................................................................... 7-109
7.3.57 DPNI_SET_EARLY_DROP ....................................................................................7-111
7.3.58 DPNI_GET_EARLY_DROP................................................................................... 7-114
7.3.59 DPNI_SET_QUEUE ............................................................................................... 7-117
7.3.60 DPNI_GET_QUEUE............................................................................................... 7-119
7.3.61 DPNI_SET_TX_CONFIRMATION_MODE.......................................................... 7-122
7.3.62 DPNI_GET_TX_CONFIRMATION_MODE......................................................... 7-123
7.3.63 DPNI_SET_QOS_TABLE ...................................................................................... 7-125
7.3.64 DPNI_ADD_QOS_ENTRY .................................................................................... 7-129
7.3.65 DPNI_REMOVE_QOS_ENTRY ............................................................................ 7-130
7.3.66 DPNI_CLEAR_QOS_TABLE ................................................................................ 7-131
7.3.67 DPNI_ADD_FS_ENTRY........................................................................................ 7-132
7.3.68 DPNI_REMOVE_FS_ENTRY................................................................................ 7-134
7.3.69 DPNI_CLEAR_FS_ENTRIES ................................................................................ 7-135
7.3.70 DPNI_GET_API_VERSION................................................................................... 7-136
7.3.71 DPNI_SET_OPR ..................................................................................................... 7-138
7.3.72 DPNI_GET_OPR..................................................................................................... 7-141
7.3.73 DPNI_SET_CONGESTION_NOTIFICATION...................................................... 7-143
7.3.73.1 Congestion threshold representation.................................................................... 7-143
7.3.74 DPNI_GET_CONGESTION_NOTIFICATION ..................................................... 7-146
7.3.75 DPNI_LOAD_SW_SEQUENCE ............................................................................ 7-148
7.3.76 DPNI_ENABLE_SW_SEQUENCE ....................................................................... 7-149
7.3.77 DPNI_SET_RX_FS_DIST ...................................................................................... 7-151
7.3.78 DPNI_SET_RX_HASH_DIST................................................................................ 7-153
7.3.79 DPNI_ADD_CUSTOM_TPID................................................................................ 7-154
7.3.80 DPNI_REMOVE_CUSTOM_TPID........................................................................ 7-155
DPAA2UM, Rev 36, 10/2020
-viii NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
7.3.81 DPNI_GET_CUSTOM_TPID................................................................................. 7-156
7.3.82 DPNI_DUMP_TABLE............................................................................................ 7-157
Chapter 8 DPBP: Data Path Buffer Pool
8.1 DPBP features .................................................................................................................. 8-1
8.2 DPBP command reference............................................................................................... 8-2
8.2.1 DPBP_OPEN............................................................................................................... 8-2
8.2.2 DPBP_CLOSE............................................................................................................. 8-3
8.2.3 DPBP_CREATE .......................................................................................................... 8-4
8.2.4 DPBP_DESTROY ....................................................................................................... 8-6
8.2.5 DPBP_ENABLE.......................................................................................................... 8-7
8.2.6 DPBP_DISABLE......................................................................................................... 8-8
8.2.7 DPBP_IS_ENABLED ................................................................................................. 8-9
8.2.8 DPBP_RESET ........................................................................................................... 8-11
8.2.9 DPBP_SET_IRQ_ENABLE...................................................................................... 8-12
8.2.10 DPBP_GET_IRQ_ENABLE..................................................................................... 8-13
8.2.11 DPBP_SET_IRQ_MASK.......................................................................................... 8-15
8.2.12 DPBP_GET_IRQ_MASK ......................................................................................... 8-16
8.2.13 DPBP_GET_IRQ_STATUS ...................................................................................... 8-18
8.2.14 DPBP_CLEAR_IRQ_STATUS ................................................................................. 8-20
8.2.15 DPBP_GET_ATTRIBUTES...................................................................................... 8-21
8.2.16 DPBP_SET_NOTIFICATIONS ................................................................................ 8-23
8.2.17 DPBP_GET_NOTIFICATIONS................................................................................ 8-24
8.2.18 DPBP_GET_API_VERSION.................................................................................... 8-26
Chapter 9 DPIO: Data Path I/O
9.1 DPIO features .................................................................................................................. 9-1
9.2 DPIO command reference ............................................................................................... 9-2
9.2.1 DPIO_OPEN................................................................................................................ 9-2
9.2.2 DPIO_CLOSE ............................................................................................................. 9-3
9.2.3 DPIO_CREATE ........................................................................................................... 9-4
9.2.4 DPIO_DESTROY........................................................................................................ 9-6
9.2.5 DPIO_ENABLE .......................................................................................................... 9-7
9.2.6 DPIO_DISABLE ......................................................................................................... 9-8
9.2.7 DPIO_IS_ENABLED.................................................................................................. 9-9
9.2.8 DPIO_RESET............................................................................................................ 9-11
9.2.9 DPIO_SET_IRQ_ENABLE ...................................................................................... 9-12
9.2.10 DPIO_GET_IRQ_ENABLE...................................................................................... 9-13
9.2.11 DPIO_SET_IRQ_MASK........................................................................................... 9-15
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -ix
Contents
Paragraph
Number Title
Page
Number
9.2.12 DPIO_GET_IRQ_MASK.......................................................................................... 9-16
9.2.13 DPIO_GET_IRQ_STATUS ....................................................................................... 9-18
9.2.14 DPIO_CLEAR_IRQ_STATUS.................................................................................. 9-20
9.2.15 DPIO_GET_ATTRIBUTES ...................................................................................... 9-21
9.2.16 DPIO_SET_STASHING_DESTINATION ............................................................... 9-23
9.2.17 DPIO_GET_STASHING_DESTINATION............................................................... 9-24
9.2.18 DPIO_ADD_STATIC_DEQUEUE_CHANNEL ...................................................... 9-26
9.2.19 DPIO_REMOVE_STATIC_DEQUEUE_CHANNEL .............................................. 9-28
9.2.20 DPIO_GET_API_VERSION..................................................................................... 9-29
9.2.21 DPIO_SET_STASHING_DESTINATION_SOURCE ............................................. 9-31
9.2.22 DPIO_GET_STASHING_DESTINATION_SOURCE............................................. 9-32
9.2.23 DPIO_SET_STASHING_DESTINATION_BY_CORE_ID..................................... 9-34
Chapter 10 DPDBG: Data Path Debugging
10.1 DPDBG features ............................................................................................................ 10-1
10.2 DPDBG command reference ......................................................................................... 10-2
10.2.1 DPDBG_OPEN ......................................................................................................... 10-2
10.2.2 DPDBG_CLOSE ....................................................................................................... 10-3
10.2.3 DPDBG_CREATE..................................................................................................... 10-4
10.2.4 DPDBG_DESTROY.................................................................................................. 10-5
10.2.5 DPMAC_DUMP........................................................................................................ 10-6
10.2.6 DPDBG_SET............................................................................................................. 10-7
10.2.7 DPDBG_GET_ATTRIBUTES .................................................................................. 10-8
10.2.8 DPDBG_GET_API_VERSION .............................................................................. 10-10
Chapter 11 DPCON: Data Path Concentrator
11.1 DPCON features ............................................................................................................ 11-1
11.2 DPCON command reference ......................................................................................... 11-2
11.2.1 DPCON_OPEN ......................................................................................................... 11-2
11.2.2 DPCON_CLOSE ....................................................................................................... 11-3
11.2.3 DPCON_CREATE..................................................................................................... 11-4
11.2.4 DPCON_DESTROY.................................................................................................. 11-6
11.2.5 DPCON_ENABLE .................................................................................................... 11-7
11.2.6 DPCON_DISABLE ................................................................................................... 11-8
11.2.7 DPCON_IS_ENABLED............................................................................................ 11-9
11.2.8 DPCON_RESET.......................................................................................................11-11
11.2.9 DPCON_SET_IRQ_ENABLE ................................................................................ 11-12
11.2.10 DPCON_GET_IRQ_ENABLE ............................................................................... 11-13
11.2.11 DPCON_SET_IRQ_MASK .................................................................................... 11-15
DPAA2UM, Rev 36, 10/2020
-x NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
11.2.12 DPCON_GET_IRQ_MASK.................................................................................... 11-16
11.2.13 DPCON_GET_IRQ_STATUS................................................................................. 11-18
11.2.14 DPCON_CLEAR_IRQ_STATUS ........................................................................... 11-20
11.2.15 DPCON_GET_ATTRIBUTES ................................................................................ 11-21
11.2.16 DPCON_SET_NOTIFICATION............................................................................. 11-23
11.2.17 DPCON_GET_API_VERSION .............................................................................. 11-24
Chapter 12 DPCI: Data Path Communication Interface
12.1 DPCI features................................................................................................................. 12-1
12.2 DPCI functional description .......................................................................................... 12-1
12.2.1 Connecting DPCI objects........................................................................................... 12-1
12.2.2 Relationship with DPIO and DPCON objects ........................................................... 12-2
12.2.3 Buffer requirements ................................................................................................... 12-2
12.3 DPCI command reference.............................................................................................. 12-2
12.3.1 DPCI_OPEN.............................................................................................................. 12-3
12.3.2 DPCI_CLOSE............................................................................................................ 12-4
12.3.3 DPCI_CREATE ......................................................................................................... 12-5
12.3.4 DPCI_DESTROY...................................................................................................... 12-7
12.3.5 DPCI_ENABLE......................................................................................................... 12-8
12.3.6 DPCI_DISABLE ....................................................................................................... 12-9
12.3.7 DPCI_IS_ENABLED .............................................................................................. 12-10
12.3.8 DPCI_RESET .......................................................................................................... 12-12
12.3.9 DPCI_SET_IRQ_ENABLE..................................................................................... 12-13
12.3.10 DPCI_GET_IRQ_ENABLE.................................................................................... 12-14
12.3.11 DPCI_SET_IRQ_MASK......................................................................................... 12-16
12.3.12 DPCI_GET_IRQ_MASK ........................................................................................ 12-17
12.3.13 DPCI_GET_IRQ_STATUS ..................................................................................... 12-19
12.3.14 DPCI_CLEAR_IRQ_STATUS................................................................................ 12-21
12.3.15 DPCI_GET_ATTRIBUTES..................................................................................... 12-22
12.3.16 DPCI_GET_PEER_ATTRIBUTES......................................................................... 12-24
12.3.17 DPCI_GET_LINK_STATE ..................................................................................... 12-26
12.3.18 DPCI_SET_RX_QUEUE ........................................................................................ 12-28
12.3.19 DPCI_GET_RX_QUEUE ....................................................................................... 12-29
12.3.20 DPCI_GET_TX_QUEUE........................................................................................ 12-31
12.3.21 DPCI_GET_API_VERSION................................................................................... 12-33
12.3.22 DPCI_SET_OPR ..................................................................................................... 12-35
12.3.23 DPCI_GET_OPR..................................................................................................... 12-37
Chapter 13 DPDMUX: Data Path Network DeMux
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -xi
Contents
Paragraph
Number Title
Page
Number
13.1 DPDMUX features ........................................................................................................ 13-1
13.2 DPDMUX functional description .................................................................................. 13-2
13.2.1 Demux database......................................................................................................... 13-2
13.2.2 Broadcast and multicast support................................................................................ 13-2
13.2.3 Promiscuous interfaces .............................................................................................. 13-2
13.2.4 Frames acceptance policy .......................................................................................... 13-3
13.3 DPDMUX command reference ..................................................................................... 13-3
13.3.1 DPDMUX_OPEN...................................................................................................... 13-4
13.3.2 DPDMUX_CLOSE ................................................................................................... 13-5
13.3.3 DPDMUX_CREATE ................................................................................................. 13-6
13.3.4 DPDMUX_DESTROY.............................................................................................. 13-9
13.3.5 DPDMUX_ENABLE .............................................................................................. 13-10
13.3.6 DPDMUX_DISABLE ............................................................................................. 13-11
13.3.7 DPDMUX_IS_ENABLED...................................................................................... 13-12
13.3.8 DPDMUX_RESET.................................................................................................. 13-13
13.3.9 DPDMUX_SET_IRQ_ENABLE ............................................................................ 13-14
13.3.10 DPDMUX_GET_IRQ_ENABLE............................................................................ 13-15
13.3.11 DPDMUX_SET_IRQ_MASK................................................................................. 13-17
13.3.12 DPDMUX_GET_IRQ_MASK................................................................................ 13-18
13.3.13 DPDMUX_GET_IRQ_STATUS ............................................................................. 13-20
13.3.14 DPDMUX_CLEAR_IRQ_STATUS........................................................................ 13-22
13.3.15 DPDMUX_GET_ATTRIBUTES ............................................................................ 13-23
13.3.16 DPDMUX_SET_MAX_FRAME_LENGTH.......................................................... 13-25
13.3.17 DPDMUX_IF_SET_ACCEPTED_FRAMES......................................................... 13-26
13.3.18 DPDMUX_IF_GET_ATTRIBUTES....................................................................... 13-27
13.3.19 DPDMUX_IF_ENABLE......................................................................................... 13-29
13.3.20 DPDMUX_IF_DISABLE........................................................................................ 13-30
13.3.21 DPDMUX_IF_SET_DEFAULT.............................................................................. 13-31
13.3.22 DPDMUX_IF_GET_DEFAULT ............................................................................. 13-32
13.3.23 DPDMUX_SET_RESETABLE............................................................................... 13-34
13.3.24 DPDMUX_GET_RESETABLE.............................................................................. 13-35
13.3.25 DPDMUX_IF_REMOVE_L2_RULE..................................................................... 13-37
13.3.26 DPDMUX_IF_ADD_L2_RULE ............................................................................. 13-38
13.3.27 DPDMUX_IF_GET_COUNTER............................................................................ 13-39
13.3.28 DPDMUX_UL_RESET_COUNTERS ................................................................... 13-41
13.3.29 DPDMUX_IF_SET_LINK_CFG ............................................................................ 13-42
13.3.30 DPDMUX_IF_GET_LINK_STATE ....................................................................... 13-43
13.3.31 DPDMUX_GET_API_VERSION........................................................................... 13-45
13.3.32 DPDMUX_SET_CUSTOM_KEY .......................................................................... 13-47
13.3.33 DPDMUX_ADD_CUSTOM_CLS_ENTRY........................................................... 13-48
13.3.34 DPDMUX_REMOVE_CUSTOM_CLS_ENTRY .................................................. 13-49
DPAA2UM, Rev 36, 10/2020
-xii NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
13.3.35 DPDMUX_IF_SET_TAILDROP............................................................................ 13-50
13.3.36 DPDMUX_IF_GET_TAILDROP ........................................................................... 13-51
13.3.37 DPDMUX_DUMP_TABLE.................................................................................... 13-53
Chapter 14 DPSW: Data Path L2 Switch
14.1 DPSW features............................................................................................................... 14-1
14.2 DPSW functional description ........................................................................................ 14-2
14.2.1 Creating L2 switch instance....................................................................................... 14-2
14.2.2 VLAN configuration.................................................................................................. 14-2
14.2.3 Learning modes.......................................................................................................... 14-2
14.2.4 FDB configuration ..................................................................................................... 14-3
14.2.5 LAG configuration..................................................................................................... 14-3
14.3 DPSW command reference............................................................................................ 14-5
14.3.1 DPSW_OPEN............................................................................................................ 14-5
14.3.2 DPSW_CLOSE.......................................................................................................... 14-6
14.3.3 DPSW_CREATE ....................................................................................................... 14-7
14.3.4 DPSW_DESTROY.................................................................................................. 14-10
14.3.5 DPSW_ENABLE..................................................................................................... 14-11
14.3.6 DPSW_DISABLE ................................................................................................... 14-12
14.3.7 DPSW_IS_ENABLED ............................................................................................ 14-13
14.3.8 DPSW_RESET ........................................................................................................ 14-15
14.3.9 DPSW_SET_IRQ_ENABLE................................................................................... 14-16
14.3.10 DPSW_GET_IRQ_ENABLE.................................................................................. 14-17
14.3.11 DPSW_SET_IRQ_MASK....................................................................................... 14-19
14.3.12 DPSW_GET_IRQ_MASK ...................................................................................... 14-20
14.3.13 DPSW_GET_IRQ_STATUS ................................................................................... 14-22
14.3.14 DPSW_CLEAR_IRQ_STATUS .............................................................................. 14-24
14.3.15 DPSW_GET_ATTRIBUTES................................................................................... 14-25
14.3.16 DPSW_SET_REFLECTION_IF ............................................................................. 14-27
14.3.17 DPSW_IF_SET_FLOODING ................................................................................. 14-28
14.3.18 DPSW_IF_SET_BROADCAST ............................................................................. 14-29
14.3.19 DPSW_IF_SET_MULTICAST ............................................................................... 14-30
14.3.20 DPSW_IF_SET_TCI ............................................................................................... 14-31
14.3.21 DPSW_IF_GET_TCI............................................................................................... 14-32
14.3.22 DPSW_IF_SET_STP............................................................................................... 14-34
14.3.23 DPSW_IF_SET_ACCEPTED_FRAMES............................................................... 14-35
14.3.24 DPSW_SET_IF_ACCEPT_ALL_VLAN ............................................................... 14-36
14.3.25 DPSW_IF_GET_COUNTER .................................................................................. 14-37
14.3.26 DPSW_IF_SET_COUNTER................................................................................... 14-39
14.3.27 DPSW_IF_SET_TX_SELECTION......................................................................... 14-40
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -xiii
Contents
Paragraph
Number Title
Page
Number
14.3.28 DPSW_IF_ADD_REFLECTION............................................................................ 14-41
14.3.29 DPSW_IF_REMOVE_REFLECTION ................................................................... 14-42
14.3.30 DPSW_IF_SET_FLOODING_METERING........................................................... 14-43
14.3.31 DPSW_IF_SET_METERING................................................................................. 14-44
14.3.32 DPSW_IF_SET_EARLY_DROP ............................................................................ 14-45
14.3.33 DPSW_ADD_CUSTOM_TPID .............................................................................. 14-47
14.3.34 DPSW_REMOVE_CUSTOM_TPID...................................................................... 14-48
14.3.35 DPSW_IF_ENABLE............................................................................................... 14-49
14.3.36 DPSW_IF_DISABLE.............................................................................................. 14-50
14.3.37 DPSW_IF_GET_ATTRIBUTES............................................................................. 14-51
14.3.38 DPSW_IF_SET_MAX_FRAME_LENGTH........................................................... 14-53
14.3.39 DPSW_IF_SET_LINK_CFG .................................................................................. 14-54
14.3.40 DPSW_IF_GET_LINK_STATE.............................................................................. 14-55
14.3.41 DPSW_IF_GET_MAX_FRAME_LENGTH.......................................................... 14-57
14.3.42 DPSW_VLAN_ADD............................................................................................... 14-59
14.3.43 DPSW_VLAN_ADD_IF ......................................................................................... 14-60
14.3.44 DPSW_VLAN_ADD_IF_UNTAGGED ................................................................. 14-61
14.3.45 DPSW_VLAN_ADD_IF_FLOODING................................................................... 14-62
14.3.46 DPSW_VLAN_REMOVE_IF................................................................................. 14-63
14.3.47 DPSW_VLAN_REMOVE_IF_UNTAGGED......................................................... 14-64
14.3.48 DPSW_VLAN_REMOVE_IF_FLOODING .......................................................... 14-65
14.3.49 DPSW_VLAN_REMOVE ...................................................................................... 14-66
14.3.50 DPSW_VLAN_GET_ATTRIBUTES ..................................................................... 14-67
14.3.51 DPSW_VLAN_GET_IF.......................................................................................... 14-69
14.3.52 DPSW_VLAN_GET_IF_FLOODING ................................................................... 14-71
14.3.53 DPSW_VLAN_GET_IF_UNTAGGED.................................................................. 14-73
14.3.54 DPSW_FDB_ADD.................................................................................................. 14-75
14.3.55 DPSW_FDB_REMOVE.......................................................................................... 14-77
14.3.56 DPSW_FDB_ADD_UNICAST............................................................................... 14-78
14.3.57 DPSW_FDB_GET_UNICAST ............................................................................... 14-79
14.3.58 DPSW_FDB_REMOVE_UNICAST ...................................................................... 14-81
14.3.59 DPSW_FDB_ADD_MULTICAST ......................................................................... 14-82
14.3.60 DPSW_FDB_GET_MULTICAST .......................................................................... 14-83
14.3.61 DPSW_FDB_REMOVE_MULTICAST ................................................................. 14-85
14.3.62 DPSW_FDB_SET_LEARNING_MODE ............................................................... 14-86
14.3.63 DPSW_FDB_GET_ATTRIBUTES......................................................................... 14-87
14.3.64 DPSW_ACL_ADD.................................................................................................. 14-89
14.3.65 DPSW_ACL_REMOVE ......................................................................................... 14-91
14.3.66 DPSW_ACL_PREPARE_ENTRY_CFG ................................................................ 14-92
14.3.67 DPSW_ACL_ADD_ENTRY................................................................................... 14-94
14.3.68 DPSW_ACL_REMOVE_ENTRY .......................................................................... 14-95
DPAA2UM, Rev 36, 10/2020
-xiv NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
14.3.69 DPSW_ACL_ADD_IF ............................................................................................ 14-98
14.3.70 DPSW_ACL_REMOVE_IF.................................................................................... 14-99
14.3.71 DPSW_ACL_GET_ATTRIBUTES....................................................................... 14-100
14.3.72 DPSW_CTRL_IF_GET_ATTRIBUTES............................................................... 14-102
14.3.73 DPSW_CTRL_IF_SET_POOLS........................................................................... 14-104
14.3.74 DPSW_CTRL_IF_ENABLE................................................................................. 14-105
14.3.75 DPSW_CTRL_IF_DISABLE................................................................................ 14-106
14.3.76 DPSW_CTRL_IF_SET_QUEUE.......................................................................... 14-107
14.3.77 DPSW_GET_API_VERSION............................................................................... 14-108
14.3.78 DPSW_LAG_SET ................................................................................................. 14-110
14.3.79 DPSW_LAG_GET_CFG........................................................................................14-111
14.3.80 DPSW_IF_SET_TAILDROP ................................................................................ 14-113
14.3.81 DPSW_IF_GET_TAILDROP................................................................................ 14-114
14.3.82 DPSW_DUMP_TABLE ........................................................................................ 14-116
Chapter 15 DPMAC: Data Path MAC
15.1 DPMAC features............................................................................................................ 15-1
15.2 DPMAC command reference......................................................................................... 15-2
15.2.1 DPMAC_OPEN......................................................................................................... 15-2
15.2.2 DPMAC_CLOSE....................................................................................................... 15-3
15.2.3 DPMAC_CREATE .................................................................................................... 15-4
15.2.4 DPMAC_DESTROY................................................................................................. 15-6
15.2.5 DPMAC_SET_IRQ_ENABLE ................................................................................. 15-7
15.2.6 DPMAC_GET_IRQ_ENABLE................................................................................. 15-8
15.2.7 DPMAC_SET_IRQ_MASK.................................................................................... 15-10
15.2.8 DPMAC_GET_IRQ_MASK................................................................................... 15-11
15.2.9 DPMAC_GET_IRQ_STATUS ................................................................................ 15-13
15.2.10 DPMAC_CLEAR_IRQ_STATUS........................................................................... 15-15
15.2.11 DPMAC_GET_ATTRIBUTES ............................................................................... 15-16
15.2.12 DPMAC_SET_PARAMS ........................................................................................ 15-19
15.2.13 DPMAC_MDIO_READ.......................................................................................... 15-20
15.2.14 DPMAC_MDIO_WRITE........................................................................................ 15-22
15.2.15 DPMAC_GET_LINK_CFG .................................................................................... 15-23
15.2.16 DPMAC_SET_LINK_STATE................................................................................. 15-25
15.2.17 DPMAC_GET_COUNTER..................................................................................... 15-26
15.2.18 DPMAC_GET_API_VERSION.............................................................................. 15-28
15.2.19 DPMAC_RESET ..................................................................................................... 15-30
15.2.20 DPMAC_GET_MAC_ADDR................................................................................. 15-31
Chapter 16 DPRTC: Data Path Real Time Clock
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -xv
Contents
Paragraph
Number Title
Page
Number
16.1 DPRTC features ............................................................................................................. 16-1
16.2 DPRTC command reference .......................................................................................... 16-2
16.2.1 DPRTC_OPEN .......................................................................................................... 16-2
16.2.2 DPRTC_CLOSE ........................................................................................................ 16-3
16.2.3 DPRTC_CREATE...................................................................................................... 16-4
16.2.4 DPRTC_DESTROY .................................................................................................. 16-6
16.2.5 DPRTC_SET_IRQ_ENABLE................................................................................... 16-7
16.2.6 DPRTC_GET_IRQ_ENABLE .................................................................................. 16-8
16.2.7 DPRTC_SET_IRQ_MASK ..................................................................................... 16-10
16.2.8 DPRTC_GET_IRQ_MASK..................................................................................... 16-11
16.2.9 DPRTC_GET_IRQ_STATUS.................................................................................. 16-13
16.2.10 DPRTC_CLEAR_IRQ_STATUS ............................................................................ 16-15
16.2.11 DPRTC_GET_ATTRIBUTES ................................................................................. 16-16
16.2.12 DPRTC_SET_CLOCK_OFFSET............................................................................ 16-18
16.2.13 DPRTC_GET_CLOCK_OFFSET........................................................................... 16-19
16.2.14 DPRTC_SET_FREQ_COMPENSATION............................................................... 16-21
16.2.15 DPRTC_GET_FREQ_COMPENSATION.............................................................. 16-22
16.2.16 DPRTC_GET_TIME ............................................................................................... 16-24
16.2.17 DPRTC_SET_TIME................................................................................................ 16-26
16.2.18 DPRTC_SET_ALARM ........................................................................................... 16-27
16.2.19 DPRTC_GET_EXT_TRIGGER_TIMESTAMP ..................................................... 16-28
16.2.20 DPRTC_SET_FIPER_LOOPBACK ....................................................................... 16-30
16.2.21 DPRTC_GET_API_VERSION ............................................................................... 16-31
Chapter 17 DPSECI: Data Path SEC Interface
17.1 DPSECI features ............................................................................................................ 17-1
17.2 DPSECI functional description...................................................................................... 17-1
17.2.1 Setting the DPSECI for SEC operation ..................................................................... 17-1
17.2.2 Relationship with DPIO and DPCON objects ........................................................... 17-2
17.2.3 Buffer requirements ................................................................................................... 17-2
17.3 DPSECI command reference ......................................................................................... 17-3
17.3.1 DPSECI_OPEN ......................................................................................................... 17-3
17.3.2 DPSECI_CLOSE ....................................................................................................... 17-4
17.3.3 DPSECI_CREATE..................................................................................................... 17-5
17.3.4 DPSECI_DESTROY ................................................................................................. 17-7
17.3.5 DPSECI_ENABLE.................................................................................................... 17-8
17.3.6 DPSECI_DISABLE................................................................................................... 17-9
17.3.7 DPSECI_IS_ENABLED ......................................................................................... 17-10
17.3.8 DPSECI_RESET ..................................................................................................... 17-12
17.3.9 DPSECI_SET_IRQ_ENABLE................................................................................ 17-13
DPAA2UM, Rev 36, 10/2020
-xvi NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
17.3.10 DPSECI_GET_IRQ_ENABLE ............................................................................... 17-14
17.3.11 DPSECI_SET_IRQ_MASK .................................................................................... 17-16
17.3.12 DPSECI_GET_IRQ_MASK ................................................................................... 17-17
17.3.13 DPSECI_GET_IRQ_STATUS................................................................................. 17-19
17.3.14 DPSECI_CLEAR_IRQ_STATUS ........................................................................... 17-21
17.3.15 DPSECI_GET_ATTRIBUTES................................................................................ 17-22
17.3.16 DPSECI_SET_OPR................................................................................................. 17-24
17.3.17 DPSECI_GET_OPR ................................................................................................ 17-26
17.3.18 DPSECI_SET_RX_QUEUE ................................................................................... 17-28
17.3.19 DPSECI_GET_RX_QUEUE................................................................................... 17-29
17.3.20 DPSECI_GET_TX_QUEUE................................................................................... 17-31
17.3.21 DPSECI_GET_SEC_ATTR..................................................................................... 17-33
17.3.22 DPSECI_GET_SEC_COUNTERS ......................................................................... 17-35
17.3.23 DPSECI_GET_API_VERSION .............................................................................. 17-37
Chapter 18 DPDCEI: Data Path DCE Interface
18.1 DPDCEI features ........................................................................................................... 18-1
18.2 DPDCEI command reference ........................................................................................ 18-2
18.2.1 DPDCEI_OPEN......................................................................................................... 18-2
18.2.2 DPDCEI_CLOSE ...................................................................................................... 18-3
18.2.3 DPDCEI_CREATE.................................................................................................... 18-4
18.2.4 DPDCEI_DESTROY................................................................................................. 18-6
18.2.5 DPDCEI_ENABLE ................................................................................................... 18-7
18.2.6 DPDCEI_DISABLE .................................................................................................. 18-8
18.2.7 DPDCEI_IS_ENABLED........................................................................................... 18-9
18.2.8 DPDCEI_RESET..................................................................................................... 18-11
18.2.9 DPDCEI_SET_IRQ_ENABLE ............................................................................... 18-12
18.2.10 DPDCEI_GET_IRQ_ENABLE............................................................................... 18-13
18.2.11 DPDCEI_SET_IRQ_MASK ................................................................................... 18-15
18.2.12 DPDCEI_GET_IRQ_MASK................................................................................... 18-16
18.2.13 DPDCEI_GET_IRQ_STATUS................................................................................ 18-18
18.2.14 DPDCEI_CLEAR_IRQ_STATUS........................................................................... 18-20
18.2.15 DPDCEI_GET_ATTRIBUTES ............................................................................... 18-21
18.2.16 DPDCEI_SET_RX_QUEUE................................................................................... 18-23
18.2.17 DPDCEI_GET_RX_QUEUE .................................................................................. 18-24
18.2.18 DPDCEI_GET_TX_QUEUE .................................................................................. 18-26
18.2.19 DPDCEI_GET_API_VERSION ............................................................................. 18-28
Chapter 19 DPDMAI: Data Path DMA Interface
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -xvii
Contents
Paragraph
Number Title
Page
Number
19.1 DPDMAI features .......................................................................................................... 19-1
19.2 DPDMAI command reference ....................................................................................... 19-2
19.2.1 DPDMAI_OPEN ....................................................................................................... 19-2
19.2.2 DPDMAI_CLOSE ..................................................................................................... 19-3
19.2.3 DPDMAI_CREATE................................................................................................... 19-4
19.2.4 DPDMAI_DESTROY ............................................................................................... 19-6
19.2.5 DPDMAI_ENABLE.................................................................................................. 19-7
19.2.6 DPDMAI_DISABLE................................................................................................. 19-8
19.2.7 DPDMAI_IS_ENABLED ......................................................................................... 19-9
19.2.8 DPDMAI_RESET ................................................................................................... 19-11
19.2.9 DPDMAI_SET_IRQ_ENABLE.............................................................................. 19-12
19.2.10 DPDMAI_GET_IRQ_ENABLE ............................................................................. 19-13
19.2.11 DPDMAI_SET_IRQ_MASK .................................................................................. 19-15
19.2.12 DPDMAI_GET_IRQ_MASK ................................................................................. 19-16
19.2.13 DPDMAI_GET_IRQ_STATUS............................................................................... 19-18
19.2.14 DPDMAI_CLEAR_IRQ_STATUS ......................................................................... 19-20
19.2.15 DPDMAI_GET_ATTRIBUTES.............................................................................. 19-21
19.2.16 DPDMAI_SET_RX_QUEUE ................................................................................. 19-23
19.2.17 DPDMAI_GET_RX_QUEUE................................................................................. 19-24
19.2.18 DPDMAI_GET_TX_QUEUE................................................................................. 19-26
19.2.19 DPDMAI_GET_API_VERSION ............................................................................ 19-28
Chapter 20 DPAIOP: Data Path AIOP Control
20.1 DPAIOP features............................................................................................................ 20-1
20.1.1 Resetting the AIOP and reloading applications ......................................................... 20-1
20.2 DPAIOP command reference......................................................................................... 20-3
20.2.1 DPAIOP_OPEN......................................................................................................... 20-3
20.2.2 DPAIOP_CLOSE....................................................................................................... 20-4
20.2.3 DPAIOP_CREATE .................................................................................................... 20-5
20.2.4 DPAIOP_DESTROY................................................................................................. 20-7
20.2.5 DPAIOP_RESET ....................................................................................................... 20-8
20.2.6 DPAIOP_SET_IRQ_ENABLE.................................................................................. 20-9
20.2.7 DPAIOP_GET_IRQ_ENABLE ............................................................................... 20-10
20.2.8 DPAIOP_SET_IRQ_MASK.................................................................................... 20-12
20.2.9 DPAIOP_GET_IRQ_MASK ................................................................................... 20-13
20.2.10 DPAIOP_GET_IRQ_STATUS ................................................................................ 20-15
20.2.11 DPAIOP_CLEAR_IRQ_STATUS ........................................................................... 20-17
20.2.12 DPAIOP_GET_ATTRIBUTES................................................................................ 20-18
20.2.13 DPAIOP_LOAD ...................................................................................................... 20-20
20.2.14 DPAIOP_RUN......................................................................................................... 20-21
DPAA2UM, Rev 36, 10/2020
-xviii NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
20.2.15 DPAIOP_GET_SL_VERSION................................................................................ 20-22
20.2.16 DPAIOP_GET_STATE............................................................................................ 20-24
20.2.17 DPAIOP_SET_TIME_OF_DAY ............................................................................. 20-26
20.2.18 DPAIOP_GET_TIME_OF_DAY............................................................................. 20-27
20.2.19 DPAIOP_GET_API_VERSION.............................................................................. 20-29
20.2.20 DPAIOP_SET_RESETABLE.................................................................................. 20-31
20.2.21 DPAIOP_GET_RESETABLE ................................................................................. 20-32
Chapter 21 DPMCP: Data Path MC Portal
21.1 DPMCP features ............................................................................................................ 21-1
21.2 DPMCP command reference ......................................................................................... 21-2
21.2.1 DPMCP_OPEN ......................................................................................................... 21-2
21.2.2 DPMCP_CLOSE ....................................................................................................... 21-3
21.2.3 DPMCP_CREATE..................................................................................................... 21-4
21.2.4 DPMCP_DESTROY.................................................................................................. 21-6
21.2.5 DPMCP_RESET........................................................................................................ 21-7
21.2.6 DPMCP_SET_IRQ_ENABLE .................................................................................. 21-8
21.2.7 DPMCP_GET_IRQ_ENABLE ................................................................................. 21-9
21.2.8 DPMCP_SET_IRQ_MASK .................................................................................... 21-11
21.2.9 DPMCP_GET_IRQ_MASK.................................................................................... 21-12
21.2.10 DPMCP_GET_IRQ_STATUS................................................................................. 21-14
21.2.11 DPMCP_GET_ATTRIBUTES ................................................................................ 21-16
21.2.12 DPMCP_GET_API_VERSION .............................................................................. 21-18
Chapter 22 DPSPARSER: Data Path Soft Parser
22.1 DPSPARSER features.................................................................................................... 22-1
22.2 DPSPARSER command reference................................................................................. 22-2
22.2.1 DPSPARSER_OPEN................................................................................................. 22-2
22.2.2 DPSPARSER_CLOSE............................................................................................... 22-3
22.2.3 DPSPARSER_CREATE ............................................................................................ 22-4
22.2.4 DPSPARSER_DESTROY......................................................................................... 22-6
22.2.5 DPSPARSER_GET_API_VERSION........................................................................ 22-7
22.2.6 DPSPARSER_APPLY_SPB...................................................................................... 22-9
Chapter 23 Memory Map and Register Definition
23.1 General Control Register 1 (GCR1) .............................................................................. 23-1
23.2 General Status Register (GSR) ...................................................................................... 23-3
23.3 MC Firmware Base Address Low Register (MCFBALR)............................................. 23-4
DPAA2UM, Rev 36, 10/2020
NXP Semiconductors -xix
Contents
Paragraph
Number Title
Page
Number
23.4 MC Firmware Base Address High Register (MCFBAHR) ........................................... 23-4
23.5 MC Firmware Attributes and Partitioning Register (MCFAPR) ................................... 23-5
23.6 Parameter Summary Register (PSR).............................................................................. 23-6
23.7 Block Revision Register 1 (BRR1)................................................................................ 23-6
23.8 Block Revision Register 2 (BRR2)................................................................................ 23-7
Chapter 24 Data Path Layout (DPL) Reference
24.1 High-level DPL structure ............................................................................................... 24-1
24.2 Node: containers ............................................................................................................ 24-2
24.2.1 Child node: dprc......................................................................................................... 24-2
24.2.1.1 Child node: resources ............................................................................................ 24-3
24.2.1.1.1 Child node: res................................................................................................... 24-3
24.2.1.2 Child node: objects ................................................................................................ 24-4
24.2.1.2.1 Child node: obj .................................................................................................. 24-5
24.2.1.2.2 Child Node: obj_set ........................................................................................... 24-5
24.3 Node: objects ................................................................................................................. 24-6
24.3.1 Child node: dpni......................................................................................................... 24-7
24.3.2 Child node: dpio......................................................................................................... 24-7
24.3.3 Child node: dpbp........................................................................................................ 24-8
24.3.4 Child node: dpcon...................................................................................................... 24-8
24.3.5 Child node: dpci......................................................................................................... 24-9
24.3.6 Child node: dpseci ..................................................................................................... 24-9
24.3.7 Child node: dpdmux................................................................................................. 24-10
24.3.8 Child node: dpsw ..................................................................................................... 24-11
24.3.9 Child node: dpmac................................................................................................... 24-12
24.3.10 Child node: dpdcei................................................................................................... 24-12
24.3.11 Child node: dpdmai.................................................................................................. 24-13
24.3.12 Child node: dpmcp................................................................................................... 24-13
24.3.13 Child node: dpaiop................................................................................................... 24-13
24.4 Node: connections........................................................................................................ 24-14
24.4.1 Child node: connection ............................................................................................ 24-14
Chapter 25 Data Path Configuration (DPC) Reference
25.1 High-level DPC structure............................................................................................... 25-1
25.2 Node: mc_general .......................................................................................................... 25-2
25.2.1 Child node: log........................................................................................................... 25-2
25.2.2 Child node: console ................................................................................................... 25-3
25.3 Node: resources.............................................................................................................. 25-4
25.3.1 Child node: icid_pools............................................................................................... 25-4
DPAA2UM, Rev 36, 10/2020
-xx NXP Semiconductors
Contents
Paragraph
Number Title
Page
Number
25.3.1.1 Child node: icid_pool ............................................................................................ 25-4
25.4 Node: controllers............................................................................................................ 25-5
25.4.1 Child node: qbman..................................................................................................... 25-5
25.5 Node: board_info ........................................................................................................... 25-6
25.5.1 Child node: ports........................................................................................................ 25-6
25.5.1.1 Child node: mac..................................................................................................... 25-6
25.6 Node: memory ............................................................................................................... 25-9
Chapter 26 Use case scenarios
26.1 Steps to verify 1000BASE-X on LS1088A QDS .......................................................... 26-1
26.1.1 Preparation ................................................................................................................. 26-1
26.1.1.1 Hardware................................................................................................................ 26-1
26.1.1.2 Software and firmware .......................................................................................... 26-1
26.1.1.3 RCW ...................................................................................................................... 26-1
26.1.1.4 Board setup ............................................................................................................ 26-1
26.1.2 Test procedures .......................................................................................................... 26-1
26.1.2.1 Verify that SGMII MC works with SGMII PHY................................................... 26-1
26.1.2.2 Verify that SGMII MC does not work with 1000BaseX PHY .............................. 26-2
26.1.2.3 Modify DPC for MC to support 1000BaseX......................................................... 26-3
26.2 Steps to verify PHYless on LS1088A QDS................................................................... 26-4
26.2.1 Preparation ................................................................................................................. 26-4
26.2.1.1 Hardware................................................................................................................ 26-4
26.2.1.2 Software and firmware .......................................................................................... 26-4
26.2.1.3 RCW ...................................................................................................................... 26-4
26.2.1.4 Board setup ............................................................................................................ 26-5
26.2.2 Test procedures .......................................................................................................... 26-6
Chapter 27 Logging and Debugging
27.1 MC console in Uboot..................................................................................................... 27-1
27.2 MC/AIOP console in Linux ........................................................................................... 27-2
Chapter 28 Known Limitations
28.1 Reset of MC objects with FQs associated with a channel ............................................. 28-1
28.2 Reconfiguring FQs associated with a channel............................................................... 28-1
28.3 DPSW - Link Aggregation............................................................................................. 28-1
28.4 DPSPARSER ................................................................................................................. 28-1
Appendix A Revision History
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
/
