sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftargetO/translations/zh_CN/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetO/translations/zh_TW/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetO/translations/it_IT/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetO/translations/ja_JP/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetO/translations/ko_KR/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftargetO/translations/sp_SP/networking/device_drivers/ethernet/freescale/dpaa2/overviewmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h4This data file has been placed in the public domain.h]h4This data file has been placed in the public domain.}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhho/srv/docbuild/lib/venvs/build-kernel-docs/lib64/python3.9/site-packages/docutils/parsers/rst/include/isonum.txthKubh)}(hDerived from the Unicode character mappings available from . Processed by unicode2rstsubs.py, part of Docutils: .h]hDerived from the Unicode character mappings available from . Processed by unicode2rstsubs.py, part of Docutils: .}hhsbah}(h]h ]h"]h$]h&]hhuh1hhhhhhhhKubhsubstitution_definition)}(h*.. |amp| unicode:: U+00026 .. AMPERSANDh]h&}hhsbah}(h]h ]h"]ampah$]h&]uh1hhhhKhhhhubh)}(h+.. |apos| unicode:: U+00027 .. APOSTROPHEh]h'}hhsbah}(h]h ]h"]aposah$]h&]uh1hhhhKhhhhubh)}(h).. |ast| unicode:: U+0002A .. ASTERISKh]h*}hhsbah}(h]h ]h"]astah$]h&]uh1hhhhK hhhhubh)}(h+.. |brvbar| unicode:: U+000A6 .. BROKEN BARh]h¦}hhsbah}(h]h ]h"]brvbarah$]h&]uh1hhhhK hhhhubh)}(h0.. |bsol| unicode:: U+0005C .. REVERSE SOLIDUSh]h\}hjsbah}(h]h ]h"]bsolah$]h&]uh1hhhhK hhhhubh)}(h*.. |cent| unicode:: U+000A2 .. CENT SIGNh]h¢}hjsbah}(h]h ]h"]centah$]h&]uh1hhhhK hhhhubh)}(h&.. |colon| unicode:: U+0003A .. COLONh]h:}hjsbah}(h]h ]h"]colonah$]h&]uh1hhhhK hhhhubh)}(h&.. |comma| unicode:: U+0002C .. COMMAh]h,}hj-sbah}(h]h ]h"]commaah$]h&]uh1hhhhKhhhhubh)}(h... |commat| unicode:: U+00040 .. COMMERCIAL ATh]h@}hj<sbah}(h]h ]h"]commatah$]h&]uh1hhhhKhhhhubh)}(h/.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGNh]h©}hjKsbah}(h]h ]h"]copyah$]h&]uh1hhhhKhhhhubh)}(h... |curren| unicode:: U+000A4 .. CURRENCY SIGNh]h¤}hjZsbah}(h]h ]h"]currenah$]h&]uh1hhhhKhhhhubh)}(h0.. |darr| unicode:: U+02193 .. DOWNWARDS ARROWh]h↓}hjisbah}(h]h ]h"]darrah$]h&]uh1hhhhKhhhhubh)}(h,.. |deg| unicode:: U+000B0 .. DEGREE SIGNh]h°}hjxsbah}(h]h ]h"]degah$]h&]uh1hhhhKhhhhubh)}(h... |divide| unicode:: U+000F7 .. DIVISION SIGNh]h÷}hjsbah}(h]h ]h"]divideah$]h&]uh1hhhhKhhhhubh)}(h,.. |dollar| unicode:: U+00024 .. DOLLAR SIGNh]h$}hjsbah}(h]h ]h"]dollarah$]h&]uh1hhhhKhhhhubh)}(h,.. |equals| unicode:: U+0003D .. EQUALS SIGNh]h=}hjsbah}(h]h ]h"]equalsah$]h&]uh1hhhhKhhhhubh)}(h1.. |excl| unicode:: U+00021 .. EXCLAMATION MARKh]h!}hjsbah}(h]h ]h"]exclah$]h&]uh1hhhhKhhhhubh)}(h9.. |frac12| unicode:: U+000BD .. VULGAR FRACTION ONE HALFh]h½}hjsbah}(h]h ]h"]frac12ah$]h&]uh1hhhhKhhhhubh)}(h<.. |frac14| unicode:: U+000BC .. VULGAR FRACTION ONE QUARTERh]h¼}hjsbah}(h]h ]h"]frac14ah$]h&]uh1hhhhKhhhhubh)}(h;.. |frac18| unicode:: U+0215B .. VULGAR FRACTION ONE EIGHTHh]h⅛}hjsbah}(h]h ]h"]frac18ah$]h&]uh1hhhhKhhhhubh)}(h?.. |frac34| unicode:: U+000BE .. VULGAR FRACTION THREE QUARTERSh]h¾}hjsbah}(h]h ]h"]frac34ah$]h&]uh1hhhhKhhhhubh)}(h>.. |frac38| unicode:: U+0215C .. VULGAR FRACTION THREE EIGHTHSh]h⅜}hjsbah}(h]h ]h"]frac38ah$]h&]uh1hhhhKhhhhubh)}(h=.. |frac58| unicode:: U+0215D .. VULGAR FRACTION FIVE EIGHTHSh]h⅝}hjsbah}(h]h ]h"]frac58ah$]h&]uh1hhhhKhhhhubh)}(h>.. |frac78| unicode:: U+0215E .. VULGAR FRACTION SEVEN EIGHTHSh]h⅞}hjsbah}(h]h ]h"]frac78ah$]h&]uh1hhhhKhhhhubh)}(h2.. |gt| unicode:: U+0003E .. GREATER-THAN SIGNh]h>}hj,sbah}(h]h ]h"]gtah$]h&]uh1hhhhKhhhhubh)}(h9.. |half| unicode:: U+000BD .. VULGAR FRACTION ONE HALFh]h½}hj;sbah}(h]h ]h"]halfah$]h&]uh1hhhhK hhhhubh)}(h/.. |horbar| unicode:: U+02015 .. HORIZONTAL BARh]h―}hjJsbah}(h]h ]h"]horbarah$]h&]uh1hhhhK!hhhhubh)}(h'.. |hyphen| unicode:: U+02010 .. HYPHENh]h‐}hjYsbah}(h]h ]h"]hyphenah$]h&]uh1hhhhK"hhhhubh)}(h:.. |iexcl| unicode:: U+000A1 .. INVERTED EXCLAMATION MARKh]h¡}hjhsbah}(h]h ]h"]iexclah$]h&]uh1hhhhK#hhhhubh)}(h7.. |iquest| unicode:: U+000BF .. INVERTED QUESTION MARKh]h¿}hjwsbah}(h]h ]h"]iquestah$]h&]uh1hhhhK$hhhhubh)}(hJ.. |laquo| unicode:: U+000AB .. LEFT-POINTING DOUBLE ANGLE QUOTATION MARKh]h«}hjsbah}(h]h ]h"]laquoah$]h&]uh1hhhhK%hhhhubh)}(h0.. |larr| unicode:: U+02190 .. LEFTWARDS ARROWh]h←}hjsbah}(h]h ]h"]larrah$]h&]uh1hhhhK&hhhhubh)}(h3.. |lcub| unicode:: U+0007B .. LEFT CURLY BRACKETh]h{}hjsbah}(h]h ]h"]lcubah$]h&]uh1hhhhK'hhhhubh)}(h;.. |ldquo| unicode:: U+0201C .. LEFT DOUBLE QUOTATION MARKh]h“}hjsbah}(h]h ]h"]ldquoah$]h&]uh1hhhhK(hhhhubh)}(h).. |lowbar| unicode:: U+0005F .. LOW LINEh]h_}hjsbah}(h]h ]h"]lowbarah$]h&]uh1hhhhK)hhhhubh)}(h1.. |lpar| unicode:: U+00028 .. LEFT PARENTHESISh]h(}hjsbah}(h]h ]h"]lparah$]h&]uh1hhhhK*hhhhubh)}(h4.. |lsqb| unicode:: U+0005B .. LEFT SQUARE BRACKETh]h[}hjsbah}(h]h ]h"]lsqbah$]h&]uh1hhhhK+hhhhubh)}(h;.. |lsquo| unicode:: U+02018 .. LEFT SINGLE QUOTATION MARKh]h‘}hjsbah}(h]h ]h"]lsquoah$]h&]uh1hhhhK,hhhhubh)}(h/.. |lt| unicode:: U+0003C .. LESS-THAN SIGNh]h<}hjsbah}(h]h ]h"]ltah$]h&]uh1hhhhK-hhhhubh)}(h+.. |micro| unicode:: U+000B5 .. MICRO SIGNh]hµ}hj sbah}(h]h ]h"]microah$]h&]uh1hhhhK.hhhhubh)}(h+.. |middot| unicode:: U+000B7 .. MIDDLE DOTh]h·}hjsbah}(h]h ]h"]middotah$]h&]uh1hhhhK/hhhhubh)}(h/.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACEh]h }hj+sbah}(h]h ]h"]nbspah$]h&]uh1hhhhK0hhhhubh)}(h).. |not| unicode:: U+000AC .. NOT SIGNh]h¬}hj:sbah}(h]h ]h"]notah$]h&]uh1hhhhK1hhhhubh)}(h,.. |num| unicode:: U+00023 .. NUMBER SIGNh]h#}hjIsbah}(h]h ]h"]numah$]h&]uh1hhhhK2hhhhubh)}(h).. |ohm| unicode:: U+02126 .. OHM SIGNh]hΩ}hjXsbah}(h]h ]h"]ohmah$]h&]uh1hhhhK3hhhhubh)}(h;.. |ordf| unicode:: U+000AA .. FEMININE ORDINAL INDICATORh]hª}hjgsbah}(h]h ]h"]ordfah$]h&]uh1hhhhK4hhhhubh)}(h<.. |ordm| unicode:: U+000BA .. MASCULINE ORDINAL INDICATORh]hº}hjvsbah}(h]h ]h"]ordmah$]h&]uh1hhhhK5hhhhubh)}(h-.. |para| unicode:: U+000B6 .. PILCROW SIGNh]h¶}hjsbah}(h]h ]h"]paraah$]h&]uh1hhhhK6hhhhubh)}(h-.. |percnt| unicode:: U+00025 .. PERCENT SIGNh]h%}hjsbah}(h]h ]h"]percntah$]h&]uh1hhhhK7hhhhubh)}(h*.. |period| unicode:: U+0002E .. FULL STOPh]h.}hjsbah}(h]h ]h"]periodah$]h&]uh1hhhhK8hhhhubh)}(h*.. |plus| unicode:: U+0002B .. PLUS SIGNh]h+}hjsbah}(h]h ]h"]plusah$]h&]uh1hhhhK9hhhhubh)}(h0.. |plusmn| unicode:: U+000B1 .. PLUS-MINUS SIGNh]h±}hjsbah}(h]h ]h"]plusmnah$]h&]uh1hhhhK:hhhhubh)}(h+.. |pound| unicode:: U+000A3 .. POUND SIGNh]h£}hjsbah}(h]h ]h"]poundah$]h&]uh1hhhhK;hhhhubh)}(h... |quest| unicode:: U+0003F .. QUESTION MARKh]h?}hjsbah}(h]h ]h"]questah$]h&]uh1hhhhKhhhhubh)}(h1.. |rarr| unicode:: U+02192 .. RIGHTWARDS ARROWh]h→}hj sbah}(h]h ]h"]rarrah$]h&]uh1hhhhK?hhhhubh)}(h4.. |rcub| unicode:: U+0007D .. RIGHT CURLY BRACKETh]h}}hjsbah}(h]h ]h"]rcubah$]h&]uh1hhhhK@hhhhubh)}(h<.. |rdquo| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARKh]h”}hj*sbah}(h]h ]h"]rdquoah$]h&]uh1hhhhKAhhhhubh)}(h0.. |reg| unicode:: U+000AE .. REGISTERED SIGNh]h®}hj9sbah}(h]h ]h"]regah$]h&]uh1hhhhKBhhhhubh)}(h2.. |rpar| unicode:: U+00029 .. RIGHT PARENTHESISh]h)}hjHsbah}(h]h ]h"]rparah$]h&]uh1hhhhKChhhhubh)}(h5.. |rsqb| unicode:: U+0005D .. RIGHT SQUARE BRACKETh]h]}hjWsbah}(h]h ]h"]rsqbah$]h&]uh1hhhhKDhhhhubh)}(h<.. |rsquo| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARKh]h’}hjfsbah}(h]h ]h"]rsquoah$]h&]uh1hhhhKEhhhhubh)}(h-.. |sect| unicode:: U+000A7 .. SECTION SIGNh]h§}hjusbah}(h]h ]h"]sectah$]h&]uh1hhhhKFhhhhubh)}(h*.. |semi| unicode:: U+0003B .. SEMICOLONh]h;}hjsbah}(h]h ]h"]semiah$]h&]uh1hhhhKGhhhhubh)}(h,.. |shy| unicode:: U+000AD .. SOFT HYPHENh]h­}hjsbah}(h]h ]h"]shyah$]h&]uh1hhhhKHhhhhubh)}(h(.. |sol| unicode:: U+0002F .. SOLIDUSh]h/}hjsbah}(h]h ]h"]solah$]h&]uh1hhhhKIhhhhubh)}(h,.. |sung| unicode:: U+0266A .. EIGHTH NOTEh]h♪}hjsbah}(h]h ]h"]sungah$]h&]uh1hhhhKJhhhhubh)}(h0.. |sup1| unicode:: U+000B9 .. SUPERSCRIPT ONEh]h¹}hjsbah}(h]h ]h"]sup1ah$]h&]uh1hhhhKKhhhhubh)}(h0.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWOh]h²}hjsbah}(h]h ]h"]sup2ah$]h&]uh1hhhhKLhhhhubh)}(h2.. |sup3| unicode:: U+000B3 .. SUPERSCRIPT THREEh]h³}hjsbah}(h]h ]h"]sup3ah$]h&]uh1hhhhKMhhhhubh)}(h4.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGNh]h×}hjsbah}(h]h ]h"]timesah$]h&]uh1hhhhKNhhhhubh)}(h0.. |trade| unicode:: U+02122 .. TRADE MARK SIGNh]h™}hjsbah}(h]h ]h"]tradeah$]h&]uh1hhhhKOhhhhubh)}(h... |uarr| unicode:: U+02191 .. UPWARDS ARROWh]h↑}hj sbah}(h]h ]h"]uarrah$]h&]uh1hhhhKPhhhhubh)}(h... |verbar| unicode:: U+0007C .. VERTICAL LINEh]h|}hjsbah}(h]h ]h"]verbarah$]h&]uh1hhhhKQhhhhubh)}(h*.. |yen| unicode:: U+000A5 .. YEN SIGN h]h¥}hj)sbah}(h]h ]h"]yenah$]h&]uh1hhhhKRhhhhubhsection)}(hhh](htitle)}(h9DPAA2 (Data Path Acceleration Architecture Gen2) Overviewh]h9DPAA2 (Data Path Acceleration Architecture Gen2) Overview}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj:hhhi/var/lib/git/docbuild/linux/Documentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rsthKubh field_list)}(hhh](hfield)}(hhh](h field_name)}(h Copyrighth]h Copyright}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jXhjUhjMhKubh field_body)}(h(|copy| 2015 Freescale Semiconductor Inc.h]h paragraph)}(hjlh](h©}(hjphhhNhNubh" 2015 Freescale Semiconductor Inc.}(hjphhhNhNubeh}(h]h ]h"]h$]h&]uh1jnhjMhKhjjubah}(h]h ]h"]h$]h&]uh1jhhjUubeh}(h]h ]h"]h$]h&]uh1jShjMhKhjPhhubjT)}(hhh](jY)}(h Copyrighth]h Copyright}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jXhjhjMhKubji)}(h|copy| 2018 NXP h]jo)}(h|copy| 2018 NXPh](h©}(hjhhhNhNubh 2018 NXP}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1jhhjubeh}(h]h ]h"]h$]h&]uh1jShjMhKhjPhhubeh}(h]h ]h"]h$]h&]uh1jNhj:hhhjMhKubjo)}(hvThis document provides an overview of the Freescale DPAA2 architecture and how it is integrated into the Linux kernel.h]hvThis document provides an overview of the Freescale DPAA2 architecture and how it is integrated into the Linux kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhK hj:hhubj9)}(hhh](j>)}(h Introductionh]h Introduction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(hX!DPAA2 is a hardware architecture designed for high-speeed network packet processing. DPAA2 consists of sophisticated mechanisms for processing Ethernet packets, queue management, buffer management, autonomous L2 switching, virtual Ethernet bridging, and accelerator (e.g. crypto) sharing.h]hX!DPAA2 is a hardware architecture designed for high-speeed network packet processing. DPAA2 consists of sophisticated mechanisms for processing Ethernet packets, queue management, buffer management, autonomous L2 switching, virtual Ethernet bridging, and accelerator (e.g. crypto) sharing.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubjo)}(hXA DPAA2 hardware component called the Management Complex (or MC) manages the DPAA2 hardware resources. The MC provides an object-based abstraction for software drivers to use the DPAA2 hardware. The MC uses DPAA2 hardware resources such as queues, buffer pools, and network ports to create functional objects/devices such as network interfaces, an L2 switch, or accelerator instances. The MC provides memory-mapped I/O command interfaces (MC portals) which DPAA2 software drivers use to operate on DPAA2 objects.h]hXA DPAA2 hardware component called the Management Complex (or MC) manages the DPAA2 hardware resources. The MC provides an object-based abstraction for software drivers to use the DPAA2 hardware. The MC uses DPAA2 hardware resources such as queues, buffer pools, and network ports to create functional objects/devices such as network interfaces, an L2 switch, or accelerator instances. The MC provides memory-mapped I/O command interfaces (MC portals) which DPAA2 software drivers use to operate on DPAA2 objects.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubjo)}(hSThe diagram below shows an overview of the DPAA2 resource management architecture::h]hRThe diagram below shows an overview of the DPAA2 resource management architecture:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubh literal_block)}(hX+--------------------------------------+ | OS | | DPAA2 drivers | | | | +-----------------------------|--------+ | | (create,discover,connect | config,use,destroy) | DPAA2 | +------------------------| mc portal |-+ | | | | +- - - - - - - - - - - - -V- - -+ | | | | | | | Management Complex (MC) | | | | | | | +- - - - - - - - - - - - - - - -+ | | | | Hardware Hardware | | Resources Objects | | --------- ------- | | -queues -DPRC | | -buffer pools -DPMCP | | -Eth MACs/ports -DPIO | | -network interface -DPNI | | profiles -DPMAC | | -queue portals -DPBP | | -MC portals ... | | ... | | | +--------------------------------------+h]hX+--------------------------------------+ | OS | | DPAA2 drivers | | | | +-----------------------------|--------+ | | (create,discover,connect | config,use,destroy) | DPAA2 | +------------------------| mc portal |-+ | | | | +- - - - - - - - - - - - -V- - -+ | | | | | | | Management Complex (MC) | | | | | | | +- - - - - - - - - - - - - - - -+ | | | | Hardware Hardware | | Resources Objects | | --------- ------- | | -queues -DPRC | | -buffer pools -DPMCP | | -Eth MACs/ports -DPIO | | -network interface -DPNI | | profiles -DPMAC | | -queue portals -DPBP | | -MC portals ... | | ... | | | +--------------------------------------+}hjsbah}(h]h ]h"]h$]h&]hhuh1jhjMhK"hjhhubjo)}(hThe MC mediates operations such as create, discover, connect, configuration, and destroy. Fast-path operations on data, such as packet transmit/receive, are not mediated by the MC and are done directly using memory mapped regions in DPIO objects.h]hThe MC mediates operations such as create, discover, connect, configuration, and destroy. Fast-path operations on data, such as packet transmit/receive, are not mediated by the MC and are done directly using memory mapped regions in DPIO objects.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKChjhhubeh}(h] introductionah ]h"] introductionah$]h&]uh1j8hj:hhhjMhKubj9)}(hhh](j>)}(hOverview of DPAA2 Objectsh]hOverview of DPAA2 Objects}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj5hhhjMhKJubjo)}(hThe section provides a brief overview of some key DPAA2 objects. A simple scenario is described illustrating the objects involved in creating a network interfaces.h]hThe section provides a brief overview of some key DPAA2 objects. A simple scenario is described illustrating the objects involved in creating a network interfaces.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKLhj5hhubj9)}(hhh](j>)}(h"DPRC (Datapath Resource Container)h]h"DPRC (Datapath Resource Container)}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjThhhjMhKQubjo)}(hA DPRC is a container object that holds all the other types of DPAA2 objects. In the example diagram below there are 8 objects of 5 types (DPMCP, DPIO, DPBP, DPNI, and DPMAC) in the container.h]hA DPRC is a container object that holds all the other types of DPAA2 objects. In the example diagram below there are 8 objects of 5 types (DPMCP, DPIO, DPBP, DPNI, and DPMAC) in the container.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKShjThhubj)}(hX+---------------------------------------------------------+ | DPRC | | | | +-------+ +-------+ +-------+ +-------+ +-------+ | | | DPMCP | | DPIO | | DPBP | | DPNI | | DPMAC | | | +-------+ +-------+ +-------+ +---+---+ +---+---+ | | | DPMCP | | DPIO | | | +-------+ +-------+ | | | DPMCP | | | +-------+ | | | +---------------------------------------------------------+h]hX+---------------------------------------------------------+ | DPRC | | | | +-------+ +-------+ +-------+ +-------+ +-------+ | | | DPMCP | | DPIO | | DPBP | | DPNI | | DPMAC | | | +-------+ +-------+ +-------+ +---+---+ +---+---+ | | | DPMCP | | DPIO | | | +-------+ +-------+ | | | DPMCP | | | +-------+ | | | +---------------------------------------------------------+}hjssbah}(h]h ]h"]h$]h&]hhuh1jhjMhKZhjThhubjo)}(hFrom the point of view of an OS, a DPRC behaves similar to a plug and play bus, like PCI. DPRC commands can be used to enumerate the contents of the DPRC, discover the hardware objects present (including mappable regions and interrupts).h]hFrom the point of view of an OS, a DPRC behaves similar to a plug and play bus, like PCI. DPRC commands can be used to enumerate the contents of the DPRC, discover the hardware objects present (including mappable regions and interrupts).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKghjThhubj)}(hDPRC.1 (bus) | +--+--------+-------+-------+-------+ | | | | | DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 DPMCP.2 DPIO.2 DPMCP.3h]hDPRC.1 (bus) | +--+--------+-------+-------+-------+ | | | | | DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 DPMCP.2 DPIO.2 DPMCP.3}hjsbah}(h]h ]h"]h$]h&]hhuh1jhjMhKnhjThhubjo)}(hHardware objects can be created and destroyed dynamically, providing the ability to hot plug/unplug objects in and out of the DPRC.h]hHardware objects can be created and destroyed dynamically, providing the ability to hot plug/unplug objects in and out of the DPRC.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKvhjThhubjo)}(hX^A DPRC has a mappable MMIO region (an MC portal) that can be used to send MC commands. It has an interrupt for status events (like hotplug). All objects in a container share the same hardware "isolation context". This means that with respect to an IOMMU the isolation granularity is at the DPRC (container) level, not at the individual object level.h]hXbA DPRC has a mappable MMIO region (an MC portal) that can be used to send MC commands. It has an interrupt for status events (like hotplug). All objects in a container share the same hardware “isolation context”. This means that with respect to an IOMMU the isolation granularity is at the DPRC (container) level, not at the individual object level.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKyhjThhubjo)}(hvDPRCs can be defined statically and populated with objects via a config file passed to the MC when firmware starts it.h]hvDPRCs can be defined statically and populated with objects via a config file passed to the MC when firmware starts it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjThhubeh}(h] dprc-datapath-resource-containerah ]h"]"dprc (datapath resource container)ah$]h&]uh1j8hj5hhhjMhKQubj9)}(hhh](j>)}(h/DPAA2 Objects for an Ethernet Network Interfaceh]h/DPAA2 Objects for an Ethernet Network Interface}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(hXA typical Ethernet NIC is monolithic-- the NIC device contains TX/RX queuing mechanisms, configuration mechanisms, buffer management, physical ports, and interrupts. DPAA2 uses a more granular approach utilizing multiple hardware objects. Each object provides specialized functions. Groups of these objects are used by software to provide Ethernet network interface functionality. This approach provides efficient use of finite hardware resources, flexibility, and performance advantages.h]hXA typical Ethernet NIC is monolithic-- the NIC device contains TX/RX queuing mechanisms, configuration mechanisms, buffer management, physical ports, and interrupts. DPAA2 uses a more granular approach utilizing multiple hardware objects. Each object provides specialized functions. Groups of these objects are used by software to provide Ethernet network interface functionality. This approach provides efficient use of finite hardware resources, flexibility, and performance advantages.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubjo)}(hpThe diagram below shows the objects needed for a simple network interface configuration on a system with 2 CPUs.h]hpThe diagram below shows the objects needed for a simple network interface configuration on a system with 2 CPUs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubj)}(hX#+---+---+ +---+---+ CPU0 CPU1 +---+---+ +---+---+ | | +---+---+ +---+---+ DPIO DPIO +---+---+ +---+---+ \ / \ / \ / +---+---+ DPNI --- DPBP,DPMCP +---+---+ | | +---+---+ DPMAC +---+---+ | port/PHYh]hX#+---+---+ +---+---+ CPU0 CPU1 +---+---+ +---+---+ | | +---+---+ +---+---+ DPIO DPIO +---+---+ +---+---+ \ / \ / \ / +---+---+ DPNI --- DPBP,DPMCP +---+---+ | | +---+---+ DPMAC +---+---+ | port/PHY}hjsbah}(h]h ]h"]h$]h&]hhuh1jhjMhKhjhhubjo)}(hBelow the objects are described. For each object a brief description is provided along with a summary of the kinds of operations the object supports and a summary of key resources of the object (MMIO regions and IRQs).h]hBelow the objects are described. For each object a brief description is provided along with a summary of the kinds of operations the object supports and a summary of key resources of the object (MMIO regions and IRQs).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubj9)}(hhh](j>)}(hDPMAC (Datapath Ethernet MAC)h]hDPMAC (Datapath Ethernet MAC)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(hRepresents an Ethernet MAC, a hardware device that connects to an Ethernet PHY and allows physical transmission and reception of Ethernet frames.h]hRepresents an Ethernet MAC, a hardware device that connects to an Ethernet PHY and allows physical transmission and reception of Ethernet frames.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubh bullet_list)}(hhh](h list_item)}(hMMIO regions: noneh]jo)}(hj@h]hMMIO regions: none}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj>ubah}(h]h ]h"]h$]h&]uh1j<hj9hhhjMhNubj=)}(hIRQs: DPNI link changeh]jo)}(hjWh]hIRQs: DPNI link change}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjUubah}(h]h ]h"]h$]h&]uh1j<hj9hhhjMhNubj=)}(hNcommands: set link up/down, link config, get stats, IRQ config, enable, reset h]jo)}(hMcommands: set link up/down, link config, get stats, IRQ config, enable, reseth]hMcommands: set link up/down, link config, get stats, IRQ config, enable, reset}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjlubah}(h]h ]h"]h$]h&]uh1j<hj9hhhjMhNubeh}(h]h ]h"]h$]h&]bullet-uh1j7hjMhKhjhhubeh}(h]dpmac-datapath-ethernet-macah ]h"]dpmac (datapath ethernet mac)ah$]h&]uh1j8hjhhhjMhKubj9)}(hhh](j>)}(h!DPNI (Datapath Network Interface)h]h!DPNI (Datapath Network Interface)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(hContains TX/RX queues, network interface configuration, and RX buffer pool configuration mechanisms. The TX/RX queues are in memory and are identified by queue number.h]hContains TX/RX queues, network interface configuration, and RX buffer pool configuration mechanisms. The TX/RX queues are in memory and are identified by queue number.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubj8)}(hhh](j=)}(hMMIO regions: noneh]jo)}(hjh]hMMIO regions: none}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubj=)}(hIRQs: link stateh]jo)}(hjh]hIRQs: link state}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubj=)}(hfcommands: port config, offload config, queue config, parse/classify config, IRQ config, enable, reset h]jo)}(hecommands: port config, offload config, queue config, parse/classify config, IRQ config, enable, reseth]hecommands: port config, offload config, queue config, parse/classify config, IRQ config, enable, reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhKhjhhubeh}(h]dpni-datapath-network-interfaceah ]h"]!dpni (datapath network interface)ah$]h&]uh1j8hjhhhjMhKubj9)}(hhh](j>)}(hDPIO (Datapath I/O)h]hDPIO (Datapath I/O)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhKubjo)}(hXEProvides interfaces to enqueue and dequeue packets and do hardware buffer pool management operations. The DPAA2 architecture separates the mechanism to access queues (the DPIO object) from the queues themselves. The DPIO provides an MMIO interface to enqueue/dequeue packets. To enqueue something a descriptor is written to the DPIO MMIO region, which includes the target queue number. There will typically be one DPIO assigned to each CPU. This allows all CPUs to simultaneously perform enqueue/dequeued operations. DPIOs are expected to be shared by different DPAA2 drivers.h]hXEProvides interfaces to enqueue and dequeue packets and do hardware buffer pool management operations. The DPAA2 architecture separates the mechanism to access queues (the DPIO object) from the queues themselves. The DPIO provides an MMIO interface to enqueue/dequeue packets. To enqueue something a descriptor is written to the DPIO MMIO region, which includes the target queue number. There will typically be one DPIO assigned to each CPU. This allows all CPUs to simultaneously perform enqueue/dequeued operations. DPIOs are expected to be shared by different DPAA2 drivers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj hhubj8)}(hhh](j=)}(h1MMIO regions: queue operations, buffer managementh]jo)}(hj.h]h1MMIO regions: queue operations, buffer management}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj,ubah}(h]h ]h"]h$]h&]uh1j<hj)hhhjMhNubj=)}(hGIRQs: data availability, congestion notification, buffer pool depletionh]jo)}(hGIRQs: data availability, congestion notification, buffer pool depletionh]hGIRQs: data availability, congestion notification, buffer pool depletion}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjCubah}(h]h ]h"]h$]h&]uh1j<hj)hhhjMhNubj=)}(h$commands: IRQ config, enable, reset h]jo)}(h#commands: IRQ config, enable, reseth]h#commands: IRQ config, enable, reset}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj[ubah}(h]h ]h"]h$]h&]uh1j<hj)hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhKhj hhubeh}(h]dpio-datapath-i-oah ]h"]dpio (datapath i/o)ah$]h&]uh1j8hjhhhjMhKubj9)}(hhh](j>)}(hDPBP (Datapath Buffer Pool)h]hDPBP (Datapath Buffer Pool)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(h"Represents a hardware buffer pool.h]h"Represents a hardware buffer pool.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubj8)}(hhh](j=)}(hMMIO regions: noneh]jo)}(hjh]hMMIO regions: none}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubj=)}(h IRQs: noneh]jo)}(hjh]h IRQs: none}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubj=)}(hcommands: enable, reset h]jo)}(hcommands: enable, reseth]hcommands: enable, reset}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjubah}(h]h ]h"]h$]h&]uh1j<hjhhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhKhjhhubeh}(h]dpbp-datapath-buffer-poolah ]h"]dpbp (datapath buffer pool)ah$]h&]uh1j8hjhhhjMhKubj9)}(hhh](j>)}(hDPMCP (Datapath MC Portal)h]hDPMCP (Datapath MC Portal)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjhhhjMhKubjo)}(h\Provides an MC command portal. Used by drivers to send commands to the MC to manage objects.h]h\Provides an MC command portal. Used by drivers to send commands to the MC to manage objects.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjhhubj8)}(hhh](j=)}(hMMIO regions: MC command portalh]jo)}(hj h]hMMIO regions: MC command portal}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hIRQs: command completionh]jo)}(hj2 h]hIRQs: command completion}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj0 ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(h$commands: IRQ config, enable, reset h]jo)}(h#commands: IRQ config, enable, reseth]h#commands: IRQ config, enable, reset}(hjK hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhjG ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhKhjhhubeh}(h]dpmcp-datapath-mc-portalah ]h"]dpmcp (datapath mc portal)ah$]h&]uh1j8hjhhhjMhKubeh}(h]/dpaa2-objects-for-an-ethernet-network-interfaceah ]h"]/dpaa2 objects for an ethernet network interfaceah$]h&]uh1j8hj5hhhjMhKubeh}(h]overview-of-dpaa2-objectsah ]h"]overview of dpaa2 objectsah$]h&]uh1j8hj:hhhjMhKJubj9)}(hhh](j>)}(hObject Connectionsh]hObject Connections}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj} hhhjMhKubjo)}(hASome objects have explicit relationships that must be configured:h]hASome objects have explicit relationships that must be configured:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj} hhubj8)}(hhh](j=)}(hDPNI <--> DPMACh]jo)}(hj h]hDPNI <--> DPMAC}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hDPNI <--> DPNIh]jo)}(hj h]hDPNI <--> DPNI}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hDPNI <--> L2-switch-port A DPNI must be connected to something such as a DPMAC, another DPNI, or L2 switch port. The DPNI connection is made via a DPRC command. h](jo)}(hDPNI <--> L2-switch-porth]hDPNI <--> L2-switch-port}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubh block_quote)}(hA DPNI must be connected to something such as a DPMAC, another DPNI, or L2 switch port. The DPNI connection is made via a DPRC command. h]jo)}(hA DPNI must be connected to something such as a DPMAC, another DPNI, or L2 switch port. The DPNI connection is made via a DPRC command.h]hA DPNI must be connected to something such as a DPMAC, another DPNI, or L2 switch port. The DPNI connection is made via a DPRC command.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubah}(h]h ]h"]h$]h&]uh1j hjMhKhj ubeh}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhKhj} hhubj)}(h`+-------+ +-------+ | DPNI | | DPMAC | +---+---+ +---+---+ | | +==========+h]h`+-------+ +-------+ | DPNI | | DPMAC | +---+---+ +---+---+ | | +==========+}hj sbah}(h]h ]h"]h$]h&]hhuh1jhjMhKhj} hhubj8)}(hhh]j=)}(hXDPNI <--> DPBP A network interface requires a 'buffer pool' (DPBP object) which provides a list of pointers to memory where received Ethernet data is to be copied. The Ethernet driver configures the DPBPs associated with the network interface. h](jo)}(hDPNI <--> DPBPh]hDPNI <--> DPBP}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj ubj )}(hA network interface requires a 'buffer pool' (DPBP object) which provides a list of pointers to memory where received Ethernet data is to be copied. The Ethernet driver configures the DPBPs associated with the network interface. h]jo)}(hA network interface requires a 'buffer pool' (DPBP object) which provides a list of pointers to memory where received Ethernet data is to be copied. The Ethernet driver configures the DPBPs associated with the network interface.h]hA network interface requires a ‘buffer pool’ (DPBP object) which provides a list of pointers to memory where received Ethernet data is to be copied. The Ethernet driver configures the DPBPs associated with the network interface.}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhKhj( ubah}(h]h ]h"]h$]h&]uh1j hjMhKhj ubeh}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubah}(h]h ]h"]h$]h&]jjuh1j7hjMhKhj} hhubeh}(h]object-connectionsah ]h"]object connectionsah$]h&]uh1j8hj:hhhjMhKubj9)}(hhh](j>)}(h Interruptsh]h Interrupts}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hjT hhhjMhMubjo)}(hXAll interrupts generated by DPAA2 objects are message interrupts. At the hardware level message interrupts generated by devices will normally have 3 components-- 1) a non-spoofable 'device-id' expressed on the hardware bus, 2) an address, 3) a data value.h]hXAll interrupts generated by DPAA2 objects are message interrupts. At the hardware level message interrupts generated by devices will normally have 3 components-- 1) a non-spoofable ‘device-id’ expressed on the hardware bus, 2) an address, 3) a data value.}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhjT hhubjo)}(hIn the case of DPAA2 devices/objects, all objects in the same container/DPRC share the same 'device-id'. For ARM-based SoC this is the same as the stream ID.h]hIn the case of DPAA2 devices/objects, all objects in the same container/DPRC share the same ‘device-id’. For ARM-based SoC this is the same as the stream ID.}(hjs hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhM hjT hhubeh}(h] interruptsah ]h"] interruptsah$]h&]uh1j8hj:hhhjMhMubj9)}(hhh](j>)}(hDPAA2 Linux Drivers Overviewh]hDPAA2 Linux Drivers Overview}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhMubjo)}(hThis section provides an overview of the Linux kernel drivers for DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure" drivers and 2) functional object drivers (such as Ethernet).h]hThis section provides an overview of the Linux kernel drivers for DPAA2-- 1) the bus driver and associated “DPAA2 infrastructure” drivers and 2) functional object drivers (such as Ethernet).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhj hhubjo)}(hXAs described previously, a DPRC is a container that holds the other types of DPAA2 objects. It is functionally similar to a plug-and-play bus controller. Each object in the DPRC is a Linux "device" and is bound to a driver. The diagram below shows the Linux drivers involved in a networking scenario and the objects bound to each driver. A brief description of each driver follows.h]hXAs described previously, a DPRC is a container that holds the other types of DPAA2 objects. It is functionally similar to a plug-and-play bus controller. Each object in the DPRC is a Linux “device” and is bound to a driver. The diagram below shows the Linux drivers involved in a networking scenario and the objects bound to each driver. A brief description of each driver follows.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhj hhubj)}(hX +------------+ | OS Network | | Stack | +------------+ +------------+ | Allocator |. . . . . . . | Ethernet | |(DPMCP,DPBP)| | (DPNI) | +-.----------+ +---+---+----+ . . ^ | . . | | dequeue> +-------------+ . | | | DPRC driver | . +---+---V----+ +---------+ | (DPRC) | . . . . . .| DPIO driver| | MAC | +----------+--+ | (DPIO) | | (DPMAC) | | +------+-----+ +-----+---+ | | | | | | +--------+----------+ | +--+---+ | MC-bus driver | | | PHY | | | | |driver| | /bus/fsl-mc | | +--+---+ +-------------------+ | | | | ========================= HARDWARE =========|=================|====== DPIO | | | DPNI---DPBP | | | DPMAC | | | PHY ---------------+ ============================================|========================h]hX +------------+ | OS Network | | Stack | +------------+ +------------+ | Allocator |. . . . . . . | Ethernet | |(DPMCP,DPBP)| | (DPNI) | +-.----------+ +---+---+----+ . . ^ | . . | | dequeue> +-------------+ . | | | DPRC driver | . +---+---V----+ +---------+ | (DPRC) | . . . . . .| DPIO driver| | MAC | +----------+--+ | (DPIO) | | (DPMAC) | | +------+-----+ +-----+---+ | | | | | | +--------+----------+ | +--+---+ | MC-bus driver | | | PHY | | | | |driver| | /bus/fsl-mc | | +--+---+ +-------------------+ | | | | ========================= HARDWARE =========|=================|====== DPIO | | | DPNI---DPBP | | | DPMAC | | | PHY ---------------+ ============================================|========================}hj sbah}(h]h ]h"]h$]h&]hhuh1jhjMhM"hj hhubjo)}(h5A brief description of each driver is provided below.h]h5A brief description of each driver is provided below.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMChj hhubj9)}(hhh](j>)}(h MC-bus driverh]h MC-bus driver}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhMFubjo)}(hThe MC-bus driver is a platform driver and is probed from a node in the device tree (compatible "fsl,qoriq-mc") passed in by boot firmware. It is responsible for bootstrapping the DPAA2 kernel infrastructure. Key functions include:h]hThe MC-bus driver is a platform driver and is probed from a node in the device tree (compatible “fsl,qoriq-mc”) passed in by boot firmware. It is responsible for bootstrapping the DPAA2 kernel infrastructure. Key functions include:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMGhj hhubj8)}(hhh](j=)}(hyregistering a new bus type named "fsl-mc" with the kernel, and implementing bus call-backs (e.g. match/uevent/dev_groups)h]jo)}(hyregistering a new bus type named "fsl-mc" with the kernel, and implementing bus call-backs (e.g. match/uevent/dev_groups)h]h}registering a new bus type named “fsl-mc” with the kernel, and implementing bus call-backs (e.g. match/uevent/dev_groups)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMMhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hIimplementing APIs for DPAA2 driver registration and for device add/removeh]jo)}(hIimplementing APIs for DPAA2 driver registration and for device add/removeh]hIimplementing APIs for DPAA2 driver registration and for device add/remove}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMOhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hcreates an MSI IRQ domainh]jo)}(hj& h]hcreates an MSI IRQ domain}(hj( hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMQhj$ ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hndoing a 'device add' to expose the 'root' DPRC, in turn triggering a bind of the root DPRC to the DPRC driver h]jo)}(hmdoing a 'device add' to expose the 'root' DPRC, in turn triggering a bind of the root DPRC to the DPRC driverh]hudoing a ‘device add’ to expose the ‘root’ DPRC, in turn triggering a bind of the root DPRC to the DPRC driver}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMRhj; ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhMMhj hhubjo)}(hThe binding for the MC-bus device-tree node can be consulted at *Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml*. The sysfs bind/unbind interfaces for the MC-bus can be consulted at *Documentation/ABI/testing/sysfs-bus-fsl-mc*.h](h@The binding for the MC-bus device-tree node can be consulted at }(hjY hhhNhNubhemphasis)}(h:*Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml*h]h8Documentation/devicetree/bindings/misc/fsl,qoriq-mc.yaml}(hjc hhhNhNubah}(h]h ]h"]h$]h&]uh1ja hjY ubhF. The sysfs bind/unbind interfaces for the MC-bus can be consulted at }(hjY hhhNhNubjb )}(h,*Documentation/ABI/testing/sysfs-bus-fsl-mc*h]h*Documentation/ABI/testing/sysfs-bus-fsl-mc}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1ja hjY ubh.}(hjY hhhNhNubeh}(h]h ]h"]h$]h&]uh1jnhjMhMUhj hhubeh}(h] mc-bus-driverah ]h"] mc-bus driverah$]h&]uh1j8hj hhhjMhMFubj9)}(hhh](j>)}(h DPRC driverh]h DPRC driver}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhM[ubjo)}(hThe DPRC driver is bound to DPRC objects and does runtime management of a bus instance. It performs the initial bus scan of the DPRC and handles interrupts for container events such as hot plug by re-scanning the DPRC.h]hThe DPRC driver is bound to DPRC objects and does runtime management of a bus instance. It performs the initial bus scan of the DPRC and handles interrupts for container events such as hot plug by re-scanning the DPRC.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhM\hj hhubeh}(h] dprc-driverah ]h"] dprc driverah$]h&]uh1j8hj hhhjMhM[ubj9)}(hhh](j>)}(h Allocatorh]h Allocator}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhMbubjo)}(hCertain objects such as DPMCP and DPBP are generic and fungible, and are intended to be used by other drivers. For example, the DPAA2 Ethernet driver needs:h]hCertain objects such as DPMCP and DPBP are generic and fungible, and are intended to be used by other drivers. For example, the DPAA2 Ethernet driver needs:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMchj hhubj8)}(hhh](j=)}(h;DPMCPs to send MC commands, to configure network interfacesh]jo)}(hj h]h;DPMCPs to send MC commands, to configure network interfaces}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMghj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubj=)}(hDPBPs for network buffer pools h]jo)}(hDPBPs for network buffer poolsh]hDPBPs for network buffer pools}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhhj ubah}(h]h ]h"]h$]h&]uh1j<hj hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhMghj hhubjo)}(hThe allocator driver registers for these allocatable object types and those objects are bound to the allocator when the bus is probed. The allocator maintains a pool of objects that are available for allocation by other DPAA2 drivers.h]hThe allocator driver registers for these allocatable object types and those objects are bound to the allocator when the bus is probed. The allocator maintains a pool of objects that are available for allocation by other DPAA2 drivers.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMjhj hhubeh}(h] allocatorah ]h"] allocatorah$]h&]uh1j8hj hhhjMhMbubj9)}(hhh](j>)}(h DPIO driverh]h DPIO driver}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj) hhhjMhMpubjo)}(hThe DPIO driver is bound to DPIO objects and provides services that allow other drivers such as the Ethernet driver to enqueue and dequeue data for their respective objects. Key services include:h]hThe DPIO driver is bound to DPIO objects and provides services that allow other drivers such as the Ethernet driver to enqueue and dequeue data for their respective objects. Key services include:}(hj: hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMqhj) hhubj8)}(hhh](j=)}(hdata availability notificationsh]jo)}(hjM h]hdata availability notifications}(hjO hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMvhjK ubah}(h]h ]h"]h$]h&]uh1j<hjH hhhjMhNubj=)}(h9hardware queuing operations (enqueue and dequeue of data)h]jo)}(hjd h]h9hardware queuing operations (enqueue and dequeue of data)}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMwhjb ubah}(h]h ]h"]h$]h&]uh1j<hjH hhhjMhNubj=)}(h hardware buffer pool management h]jo)}(hhardware buffer pool managementh]hhardware buffer pool management}(hj} hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMxhjy ubah}(h]h ]h"]h$]h&]uh1j<hjH hhhjMhNubeh}(h]h ]h"]h$]h&]jjuh1j7hjMhMvhj) hhubjo)}(hXfTo transmit a packet the Ethernet driver puts data on a queue and invokes a DPIO API. For receive, the Ethernet driver registers a data availability notification callback. To dequeue a packet a DPIO API is used. There is typically one DPIO object per physical CPU for optimum performance, allowing different CPUs to simultaneously enqueue and dequeue data.h]hXfTo transmit a packet the Ethernet driver puts data on a queue and invokes a DPIO API. For receive, the Ethernet driver registers a data availability notification callback. To dequeue a packet a DPIO API is used. There is typically one DPIO object per physical CPU for optimum performance, allowing different CPUs to simultaneously enqueue and dequeue data.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMzhj) hhubjo)}(hsThe DPIO driver operates on behalf of all DPAA2 drivers active in the kernel-- Ethernet, crypto, compression, etc.h]hsThe DPIO driver operates on behalf of all DPAA2 drivers active in the kernel-- Ethernet, crypto, compression, etc.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhj) hhubeh}(h] dpio-driverah ]h"] dpio driverah$]h&]uh1j8hj hhhjMhMpubj9)}(hhh](j>)}(hEthernet driverh]hEthernet driver}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhMubjo)}(hThe Ethernet driver is bound to a DPNI and implements the kernel interfaces needed to connect the DPAA2 network interface to the network stack. Each DPNI corresponds to a Linux network interface.h]hThe Ethernet driver is bound to a DPNI and implements the kernel interfaces needed to connect the DPAA2 network interface to the network stack. Each DPNI corresponds to a Linux network interface.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhj hhubeh}(h]ethernet-driverah ]h"]ethernet driverah$]h&]uh1j8hj hhhjMhMubj9)}(hhh](j>)}(h MAC driverh]h MAC driver}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j=hj hhhjMhMubjo)}(hXAn Ethernet PHY is an off-chip, board specific component and is managed by the appropriate PHY driver via an mdio bus. The MAC driver plays a role of being a proxy between the PHY driver and the MC. It does this proxy via the MC commands to a DPMAC object. If the PHY driver signals a link change, the MAC driver notifies the MC via a DPMAC command. If a network interface is brought up or down, the MC notifies the DPMAC driver via an interrupt and the driver can take appropriate action.h]hXAn Ethernet PHY is an off-chip, board specific component and is managed by the appropriate PHY driver via an mdio bus. The MAC driver plays a role of being a proxy between the PHY driver and the MC. It does this proxy via the MC commands to a DPMAC object. If the PHY driver signals a link change, the MAC driver notifies the MC via a DPMAC command. If a network interface is brought up or down, the MC notifies the DPMAC driver via an interrupt and the driver can take appropriate action.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jnhjMhMhj hhubeh}(h] mac-driverah ]h"] mac driverah$]h&]uh1j8hj hhhjMhMubeh}(h]dpaa2-linux-drivers-overviewah ]h"]dpaa2 linux drivers overviewah$]h&]uh1j8hj:hhhjMhMubeh}(h]7dpaa2-data-path-acceleration-architecture-gen2-overviewah ]h"]9dpaa2 (data path acceleration architecture gen2) overviewah$]h&]uh1j8hhhhhjMhKubeh}(h]h ]h"]h$]h&]sourcejMuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(j=N generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj< error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcejM _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}(hhhhhhhhj jjjj*jj9j-jHj<jWjKjfjZjujijjxjjjjjjjjjjjjjjjjj jjjj)jj8j,jGj;jVjJjejYjtjhjjwjjjjjjjjjjjjjjjjj jjj j(jj7j+jFj:jUjIjdjXjsjgjjvjjjjjjjjjjjjjjjjj jjj j'jj6j*jEj9jTjHjcjWjrjfjjujjjjjjjjjjjjjjjjjjjj j&jj5j)usubstitution_names}(amphЌaposhߌasthbrvbarhbsolj centjcolonj*commaj9commatjHcopyjWcurrenjfdarrjudegjdividejdollarjequalsjexcljfrac12jfrac14jfrac18jfrac34jfrac38j frac58jfrac78j)gtj8halfjGhorbarjVhyphenjeiexcljtiquestjlaquojlarrjlcubjldquojlowbarjlparjlsqbjlsquojltj microjmiddotj(nbspj7notjFnumjUohmjdordfjsordmjparajpercntjperiodjplusjplusmnjpoundjquestjquotjraquoj rarrjrcubj'rdquoj6regjErparjTrsqbjcrsquojrsectjsemijshyjsoljsungjsup1jsup2jsup3jtimesjtradejuarrjverbarj&yenj5urefnames}refids}nameids}(j j j2j/jz jw jjjr jo jjjjj~j{jjjj jg jQ jN j j j j j j j j j& j# j j j j j j u nametypes}(j j2jz jjr jjj~jjj jQ j j j j j& j j j uh}(j j:j/jjw j5jjTjo jjjjjj{j jjjg jjN j} j jT j j j j j j j# j j j) j j j j u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log]MDocumentation/networking/device_drivers/ethernet/freescale/dpaa2/overview.rst(NNNNta decorationNhhub.