9a24a3184e
This patch updates the doxygen for the drivers spi,spips,srio,sysmon,tmrctr to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
2721 lines
160 KiB
HTML
Executable file
2721 lines
160 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
Xilinx Driver srio v1_0: xsrio.h File Reference
|
|
</title>
|
|
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
|
|
<hl>Software Drivers</hl>
|
|
<hr class="whs1">
|
|
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>File Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>xsrio.h File Reference</h1><code>#include <string.h></code><br/>
|
|
<code>#include "xstatus.h"</code><br/>
|
|
<code>#include "xil_assert.h"</code><br/>
|
|
<code>#include "<a class="el" href="xsrio__hw_8h.html">xsrio_hw.h</a>"</code><br/>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Classes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_srio___config.html">XSrio_Config</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_srio.html">XSrio</a></td></tr>
|
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a28f04469ea0d63a8b787989f94d6f8d5">XSRIO_H</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#abea6ccdc70412fa41b6d45785ff2d287">XSRIO_IS_MEMORY</a> 1</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ada8228136dc485b32c5a1e8ea9f0c1ee">XSRIO_IS_PROCESSOR</a> 2</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5c084f9424ee6edbc6c9c94db2dac6f8">XSRIO_IS_BRIDGE</a> 3</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#afadc09b23898c51bba7c5167f439000d">XSRIO_OP_MODE_NREAD</a> 0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5bcffc7047fbbb505c256fa15062ec9e">XSRIO_OP_MODE_NWRITE</a> 1</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a17ddc9d36a51e2a63e6b7e8b1d6ca204">XSRIO_OP_MODE_SWRITE</a> 2</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab4e13bb3d8eeb614bdc2f655cbc4ba16">XSRIO_OP_MODE_NWRITE_R</a> 3</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a01882d64861c721fafb08cc63dc7e589">XSRIO_OP_MODE_DATA_MESSAGE</a> 4</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a246f138414b507e094ebbfb196350805">XSRIO_OP_MODE_DOORBELL</a> 5</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ac0c9b8d9ebb9191a8314f93225bd59a8">XSRIO_OP_MODE_ATOMIC</a> 6</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#abc16a98ad67644dbb4dc653fafe590bb">XSRIO_PORT_OK</a> 0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#af20e9fbfb23bbe3e1c9c201609a93352">XSRIO_PORT_UNINITIALIZED</a> 1</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a86e8b638b0295f135b4dfea25bcefce4">XSRIO_PORT_HAS_ERRORS</a> 2</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a30c7873d0765851288036067362c5b7e">XSRIO_DIR_TX</a> 1</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#abc2766876577ad322e774bd96906f178">XSRIO_DIR_RX</a> 2</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8a7ebb9dba61f05473de5c3e80f6037a">XSrio_ReadDeviceVendorID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5de6f1044b7f754c6ae9cdbe703f8ee6">XSrio_ReadDeviceID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a2b99a417e8924310fc14618c629a8f50">XSrio_ReadAsmVendorID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a327539a3b73d7658270fc3a2e268153d">XSrio_ReadAsmID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a3ae00f693b20af370a16c288ad85e3a8">XSrio_GetExFeaturesPointer</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#afc9e89d83a445e74b1c96d9c05f7e7b6">XSrio_ReadAsmRevision</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a9aee3caa383586a448d912957518246c">XSrio_IsLargeSystem</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a307ef4f230012aa16316913933832c82">XSrio_IsCRFSupported</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ada1a2bfecf3f5afca7be3d94df46290a">XSrio_ReadSrcOps</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ae7326b439df172403f28fcc0fa38e992">XSrio_ReadDstOps</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aff3d43b0d620e05058151226ec142f8a">XSrio_GetLCSBA</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aceba101926e9798fa350e1d5676fd43a">XSrio_SetLCSBA</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ae1b3ddcbd05c2fb66429ba118e11632b">XSrio_GetLargeBaseDeviceID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab4bcd463737ea357837d33a6dc5d624d">XSrio_SetLargeBaseDeviceID</a>(InstancePtr, DeviceId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#acfde7cdfa931c5719879f7cb5b4d25cf">XSrio_GetBaseDeviceID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a07769a73bad559c94a8df465fa696d41">XSrio_SetBaseDeviceID</a>(InstancePtr, DeviceId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a3a0629b01afa0520405529334e758849">XSrio_GetHostBaseDevID_LockCSR</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#afdfe7ecbbc797795197a01c43d757bde">XSrio_SetHostBaseDevID_LockCSR</a>(InstancePtr, DeviceId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#add5d85392da1dc1f58b65c23510edd95">XSrio_GetComponentTagCSR</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aefe9cfb3e23651f6e0ba04cebf2ea468">XSrio_SetComponentTagCSR</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab5e62651fb6880055528649c423f5a99">XSrio_GetExtFeaturesID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8deeb1034839d63ea19adcafcfbb3f10">XSrio_GetSerialExtFeaturesPointer</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a81b9edd3c92a0e2a71bdc6e8204ad87a">XSrio_GetPortLinkTimeOutValue</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ae07e03313283e68a326337c7b7719e8a">XSrio_SetPortLinkTimeOutValue</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a9963021f71bdeca584ebfb9d3e57a1e4">XSrio_GetPortRespTimeOutValue</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a3c92d05848b754806d55eaf92d37e57e">XSrio_SetPortRespTimeOutValue</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#abb901983e661260f87855035e838a5b1">XSrio_IsPEDiscovered</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a6fe0e368f18de444791fabf766909ce5">XSrio_SetDiscovered</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a3dce12def9f522691b91a352b4f8f718">XSrio_IsMasterEnabled</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aac00f96b3a6ce690351f244ab67ca136">XSrio_SetMasterEnabled</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a06ac428cbafbe85e5513f696a65c5fef">XSrio_IsHost</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ae335b6bbb82ca4ac987b936bc83017d2">XSrio_SetHostEnabled</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab389a5b20baa6ce1d517b831ecf4c091">XSrio_GetCommand</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a42eecc100ed216b9cdda8612284a0a61">XSrio_SendCommand</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8e6d99b38fe43a4eeab492ba4b98f0d7">XSrio_IsResponseValid</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a20713788620dca8ec06667899ad09086">XSrio_GetOutboundAckID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a49bc09c674f99b8edb4c050c68394794">XSrio_SetOutboundAckID</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a05f6e0fd9a933c44f621c096bffdf0ff">XSrio_GetInboundAckID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ad2c03c531f3f4f6f6755abbf659de414">XSrio_SetInboundAckID</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a164706fd7f0d869858f84027bb3f5607">XSrio_ClrOutStandingAckIDs</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab4861fc531773228164b79f8759f0f2b">XSrio_IsEnumerationBoundary</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8c151ef9804e5dcdcbc8e8dd1f477025">XSrio_ClrEnumerationBoundary</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a66ab356e1da20d8530a3028634091321">XSrio_GetPortwidthOverride</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a9695e204da2d3f1de942cdd68074d170">XSrio_SetPortwidthOverride</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5416a4413a7fba4cde587a089f1ef1ab">XSrio_GetSerialLaneExtFeaturesPointer</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a39928235ee8e95d1e21f0e5c378ec942">XSrio_ClrDecodingErrors</a>(InstancePtr, Lanenum)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aae5bc91f206477d2b670df74960c9f21">XSrio_GetRxSize</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a4ce9d661242960c57815217d016c5ab0">XSrio_ForceRxFlowControl</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a65108021ee8bdfcc49caf050106a015c">XSrio_GetTxSize</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5f1d616c02c11b4883bace20cc17d5ae">XSrio_CheckforTxReqreorder</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#af495f0414308d1f913450d94149ffa45">XSrio_IsTxFlowControl</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a3c60f6d350aea0945644251ce9aa38a9">XSrio_GetDestinationID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#afe400870d468d8dcf400b78fa64c812e">XSrio_SetDestinationID</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a76698c33cdf6c12d510c1e93209f366d">XSrio_GetCRF</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8c73d55426fe8cebbecb990d6b3d2157">XSrio_SetCRF</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aa67bb8a01c79079bed244bed3d8b2288">XSrio_GetPriority</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a96b78184a872c8eb94ece898fb80baef">XSrio_SetPriority</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a8f99aebc6c8ef91fffe3512e76cb199f">XSrio_RequestTID</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#aa0b06583959e2e4a720790dad9af0e39">XSrio_SetTID</a>(InstancePtr, Value)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#acab486169451593319feea69b08e4cac">XSrio_ClrPortError</a>(InstancePtr, Mask)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ab855a80c812d251ab338c74fd004ab10">XSrio_GetPortErrorStatus</a>(InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a1a877c69f015fcb1069b874f8008a8f5">XSrio_SetPortControlStatus</a>(InstancePtr, Mask)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a5378e52f9e70d3b7bcdadd01a764d4a6">XSrio_GetPortControlStatus</a>(InstancePtr)</td></tr>
|
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#ac5162a4f64b1b7d32456015e6c6b0243">XSrio_CfgInitialize</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, <a class="el" href="struct_x_srio___config.html">XSrio_Config</a> *Config, u32 EffectiveAddress)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_srio___config.html">XSrio_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a42b26033e0da4cb550f5b62477a6387c">XSrio_LookupConfig</a> (u32 DeviceId)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#acbd49fb630e7f2d7c8533d12607ef105">XSrio_GetPortStatus</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a753aded6db30e1c042e7c7ee43b2a483">XSrio_GetPEType</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#afce174875d087f4b3cc4713a1df5446d">XSrio_IsOperationSupported</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u8 Operation, u8 Direction)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a9cb7fbc368f16113382c2a9b4556b601">XSrio_SetWaterMark</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u8 WaterMark0, u8 WaterMark1, u8 WaterMark2)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="xsrio_8h.html#a9eb82f808fa01a1679ed60a026a2a2c7">XSrio_GetWaterMark</a> (<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u8 *WaterMark0, u8 *WaterMark1, u8 *WaterMark2)</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<hr/><h2>Define Documentation</h2>
|
|
<a class="anchor" id="a5f1d616c02c11b4883bace20cc17d5ae"></a><!-- doxytag: member="xsrio.h::XSrio_CheckforTxReqreorder" ref="a5f1d616c02c11b4883bace20cc17d5ae" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_CheckforTxReqreorder</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ad8f753d02157a46e2feb752325fa8fa9">XSRIO_IMP_BCSR_TXREQ_REORDER_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_CheckforTxReqreorder checks whether the transmit buffer has been configured to allow reordering of requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the Tx Request reorder is enabled in the core.</li>
|
|
<li>FALSE If the Tx Request reorder is not enabled in the core.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a5f1d616c02c11b4883bace20cc17d5ae">XSrio_CheckforTxReqreorder(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a39928235ee8e95d1e21f0e5c378ec942"></a><!-- doxytag: member="xsrio.h::XSrio_ClrDecodingErrors" ref="a39928235ee8e95d1e21f0e5c378ec942" args="(InstancePtr, Lanenum)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ClrDecodingErrors</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Lanenum </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a72659b475911b0612f6bd8704ab1fe56">XSRIO_EFB_LPSL_OFFSET</a> + <a class="code" href="xsrio__hw_8h.html#ac1727fbcfcc856554646e9a8c037242b">XSRIO_SLS0_CSR_OFFSET</a>(Lanenum)) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a735fded4f8506dc560fcce58190e8792">XSRIO_SLS0_CSR_DECODING_ERRORS_MASK</a>) \
|
|
>> <a class="code" href="xsrio__hw_8h.html#aab5ffaf0b2b1dafd570be459fded1e60">XSRIO_SLS0_CSR_DECODING_ERRORS_SHIFT</a>)
|
|
</pre></div><p>XSrio_ClrDecodingErrors clears the 8B/10B decoding errors and return Result.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Lanenum</em> </td><td>is the Serial Lane-number(0,1,2,3).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: int <a class="el" href="xsrio_8h.html#a39928235ee8e95d1e21f0e5c378ec942">XSrio_ClrDecodingErrors(XSrio *InstancePtr, u8 Lanenum)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c151ef9804e5dcdcbc8e8dd1f477025"></a><!-- doxytag: member="xsrio.h::XSrio_ClrEnumerationBoundary" ref="a8c151ef9804e5dcdcbc8e8dd1f477025" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ClrEnumerationBoundary</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) \
|
|
| <a class="code" href="xsrio__hw_8h.html#ab5e4697d8469fa671713a7d0f948410e">XSRIO_PORT_N_CTL_CSR_ENUMB_MASK</a>)))
|
|
</pre></div><p>XSrio_ClrEnumerationBoundary clears the enumeration boundary of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a8c151ef9804e5dcdcbc8e8dd1f477025">XSrio_ClrEnumerationBoundary(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a164706fd7f0d869858f84027bb3f5607"></a><!-- doxytag: member="xsrio.h::XSrio_ClrOutStandingAckIDs" ref="a164706fd7f0d869858f84027bb3f5607" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ClrOutStandingAckIDs</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>) \
|
|
| <a class="code" href="xsrio__hw_8h.html#ab22ac5185816e99ebaf0d6ebca184633">XSRIO_PORT_N_ACKID_CSR_CLSACKID_MASK</a>)))
|
|
</pre></div><p>XSrio_ClrOutStandingAckIDs clears all outstanding unacknowledged received packets of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a164706fd7f0d869858f84027bb3f5607">XSrio_ClrOutStandingAckIDs(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acab486169451593319feea69b08e4cac"></a><!-- doxytag: member="xsrio.h::XSrio_ClrPortError" ref="acab486169451593319feea69b08e4cac" args="(InstancePtr, Mask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ClrPortError</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Mask </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa9bc2b856e9b7dcb4cd5781ec1df9681">XSRIO_PORT_N_ERR_STS_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa9bc2b856e9b7dcb4cd5781ec1df9681">XSRIO_PORT_N_ERR_STS_CSR_OFFSET</a>) | \
|
|
(Mask & <a class="code" href="xsrio__hw_8h.html#a72cb3e32c415ed1ad9bf901ed4738c3b">XSRIO_PORT_N_ERR_STS_CSR_ERR_ALL_MASK</a>))))
|
|
</pre></div><p>XSrio_ClrPortError clears the Port Error specified by the Mask.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Mask</em> </td><td>is the mask for the Port Error to be cleared.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#acab486169451593319feea69b08e4cac">XSrio_ClrPortError(XSrio *InstancePtrm, u32 Mask)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc2766876577ad322e774bd96906f178"></a><!-- doxytag: member="xsrio.h::XSRIO_DIR_RX" ref="abc2766876577ad322e774bd96906f178" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_DIR_RX 2</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Receive Direction Flag </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30c7873d0765851288036067362c5b7e"></a><!-- doxytag: member="xsrio.h::XSRIO_DIR_TX" ref="a30c7873d0765851288036067362c5b7e" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_DIR_TX 1</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Transmit Direction Flag </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4ce9d661242960c57815217d016c5ab0"></a><!-- doxytag: member="xsrio.h::XSrio_ForceRxFlowControl" ref="a4ce9d661242960c57815217d016c5ab0" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ForceRxFlowControl</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a>) | \
|
|
<a class="code" href="xsrio__hw_8h.html#a1c3f8e97192bb4fa1ef6de5698663d63">XSRIO_IMP_BCSR_FRX_FLOW_CNTL_MASK</a>)))
|
|
</pre></div><p>XSrio_ForceRxFlowControl forces the Tx flow control enabled core to use Rx flow control.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a4ce9d661242960c57815217d016c5ab0">XSrio_ForceRxFlowControl(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acfde7cdfa931c5719879f7cb5b4d25cf"></a><!-- doxytag: member="xsrio.h::XSrio_GetBaseDeviceID" ref="acfde7cdfa931c5719879f7cb5b4d25cf" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetBaseDeviceID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#aa398a9d87c352370ad8368def9aec0df">XSRIO_BASE_DID_CSR_BDID_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#add5f5e46e978b7addcd450362a3e4f6b">XSRIO_BASE_DID_CSR_BDID_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetBaseDeviceID returns the 8-bit Device Id for an endpoint in a small Transport system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>8-bit Device Id.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#acfde7cdfa931c5719879f7cb5b4d25cf">XSrio_GetBaseDeviceID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab389a5b20baa6ce1d517b831ecf4c091"></a><!-- doxytag: member="xsrio.h::XSrio_GetCommand" ref="ab389a5b20baa6ce1d517b831ecf4c091" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetCommand</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a98dd1aa546c28e3ad2e5dfa370795346">XSRIO_PORT_N_MNT_REQ_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a90f9f21f13d053d8d92578cdddfe8027">XSRIO_PORT_N_MNT_REQ_CSR_CMD_MASK</a>)
|
|
</pre></div><p>XSrio_GetCommand returns the command value that is sent on the Link-request Control symbol of the SRIO Gen2 core. This api is available only if the software assisted error recovery option is enabled in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Command information of the link-request control symbol.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#ab389a5b20baa6ce1d517b831ecf4c091">XSrio_GetCommand(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="add5d85392da1dc1f58b65c23510edd95"></a><!-- doxytag: member="xsrio.h::XSrio_GetComponentTagCSR" ref="add5d85392da1dc1f58b65c23510edd95" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetComponentTagCSR</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#abf538c58029dbfecbc051a594c5b6ab8">XSRIO_COMPONENT_TAG_CSR_OFFSET</a>))
|
|
</pre></div><p>XSrio_GetComponentTagCSR returns the Component Tag Value set by the software during initialization.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Component Tag Value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#add5d85392da1dc1f58b65c23510edd95">XSrio_GetComponentTagCSR(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a76698c33cdf6c12d510c1e93209f366d"></a><!-- doxytag: member="xsrio.h::XSrio_GetCRF" ref="a76698c33cdf6c12d510c1e93209f366d" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetCRF</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a114b6719c2e1043ef79c009fead1b28d">XSRIO_IMP_MRIR_REQ_CRF_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#a73a0d5b6fa6ad54db9f7251a78b0888c">XSRIO_IMP_MRIR_REQ_CRF_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetCRF checks whether the CRF is enabled in the core or not which will be used for outgoing maintenance requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>CRF Value used for outgoing maintenance requests.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a76698c33cdf6c12d510c1e93209f366d">XSrio_GetCRF(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3c60f6d350aea0945644251ce9aa38a9"></a><!-- doxytag: member="xsrio.h::XSrio_GetDestinationID" ref="a3c60f6d350aea0945644251ce9aa38a9" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetDestinationID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a4b251ca3e20b50fad896a7b93eadd002">XSRIO_IMP_MRIR_REQ_DESTID_MASK</a>)
|
|
</pre></div><p>XSrio_GetDestinationID gets the destination id value which will be used for outgoing maintenance requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Destination ID value of the outgoing maintenance request.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a3c60f6d350aea0945644251ce9aa38a9">XSrio_GetDestinationID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3ae00f693b20af370a16c288ad85e3a8"></a><!-- doxytag: member="xsrio.h::XSrio_GetExFeaturesPointer" ref="a3ae00f693b20af370a16c288ad85e3a8" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetExFeaturesPointer</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a0a923d474a8eeac67f54d6259da07dc4">XSRIO_ASM_INFO_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a7548def33dd41ea582a382c7ffbe2c58">XSRIO_ASM_INFO_CAR_EFP_MASK</a>)
|
|
</pre></div><p>XSrio_GetExFeaturesPointer gives the pointer to the Phy Register space of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the Phy Register space of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a3ae00f693b20af370a16c288ad85e3a8">XSrio_GetExFeaturesPointer(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab5e62651fb6880055528649c423f5a99"></a><!-- doxytag: member="xsrio.h::XSrio_GetExtFeaturesID" ref="ab5e62651fb6880055528649c423f5a99" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetExtFeaturesID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a2e147a812705dfde71c8b3b5ea85b7e0">XSRIO_EFB_HEADER_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a6cdfee54edff28e0f650ca0e6be5f69f">XSRIO_EFB_HEADER_EFID_MASK</a>)
|
|
</pre></div><p>XSrio_GetExtFeaturesID returns the Extended Features Id value.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Extended Features ID Value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#ab5e62651fb6880055528649c423f5a99">XSrio_GetExtFeaturesID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3a0629b01afa0520405529334e758849"></a><!-- doxytag: member="xsrio.h::XSrio_GetHostBaseDevID_LockCSR" ref="a3a0629b01afa0520405529334e758849" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetHostBaseDevID_LockCSR</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa385c427eb29650bb31acbaf4a3e320c">XSRIO_HOST_DID_LOCK_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a65ffdf1055349f408681a28e4804ad0a">XSRIO_HOST_DID_LOCK_CSR_HBDID_MASK</a>)
|
|
</pre></div><p>XSrio_GetHostBaseDevID_LockCSR returns the Device Id of the system host.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Device Id of the system host.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a3a0629b01afa0520405529334e758849">XSrio_GetHostBaseDevID_LockCSR(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a05f6e0fd9a933c44f621c096bffdf0ff"></a><!-- doxytag: member="xsrio.h::XSrio_GetInboundAckID" ref="a05f6e0fd9a933c44f621c096bffdf0ff" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetInboundAckID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a8acb5233083f47870eddd512acf461cd">XSRIO_PORT_N_ACKID_CSR_IBACKID_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#a8b3e4ea25cec8c9876433d60720c2b9b">XSRIO_PORT_N_ACKID_CSR_IBACKID_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetInboundAckID returns the expected Ackid of the next received packet of the SRIO Gen2 core. This api is available only if the software assisted error recovery option is selected in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Inbound Ack ID value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#a05f6e0fd9a933c44f621c096bffdf0ff">XSrio_GetInboundAckID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae1b3ddcbd05c2fb66429ba118e11632b"></a><!-- doxytag: member="xsrio.h::XSrio_GetLargeBaseDeviceID" ref="ae1b3ddcbd05c2fb66429ba118e11632b" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetLargeBaseDeviceID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a593eed7b4e0cf5c113668ec501709392">XSRIO_BASE_DID_CSR_LBDID_MASK</a>)
|
|
</pre></div><p>XSrio_GetLargeBaseDeviceID returns the 16-bit Device Id for an endpoint in a Large transport system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>16-bit Device Id.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#ae1b3ddcbd05c2fb66429ba118e11632b">XSrio_GetLargeBaseDeviceID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aff3d43b0d620e05058151226ec142f8a"></a><!-- doxytag: member="xsrio.h::XSrio_GetLCSBA" ref="aff3d43b0d620e05058151226ec142f8a" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetLCSBA</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afffc5b4df1dd5366ef4074e68f7b958a">XSRIO_LCS1_BASEADDR_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a7c4c40c3d4edc4ca1bc643c95fe18cf2">XSRIO_LCS1_BASEADDR_LCSBA_CSR_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#acffff28710d77ac7a123f78728eb4712">XSRIO_LCS1_BASEADDR_LCSBA_CSR_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetLCSBA returns the Local Configuration Space Base Address(LCSBA) of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Contents of Local Configuration Space Base Address Register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#aff3d43b0d620e05058151226ec142f8a">XSrio_GetLCSBA(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20713788620dca8ec06667899ad09086"></a><!-- doxytag: member="xsrio.h::XSrio_GetOutboundAckID" ref="a20713788620dca8ec06667899ad09086" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetOutboundAckID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a6541e592e664f2549721d2073626dc91">XSRIO_PORT_N_ACKID_CSR_OBACKID_MASK</a>)
|
|
</pre></div><p>XSrio_GetOutboundAckID returns the value of the next transmitted Ackid of the SRIO Gen2 Core. This api is available only if the software assisted error recovery option is selected core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Outbound Ack ID value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#a20713788620dca8ec06667899ad09086">XSrio_GetOutboundAckID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5378e52f9e70d3b7bcdadd01a764d4a6"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortControlStatus" ref="a5378e52f9e70d3b7bcdadd01a764d4a6" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPortControlStatus</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a364330b68240054841422bcc2144ad56">XSRIO_PORT_N_CTL_CSR_STATUS_ALL_MASK</a>)
|
|
</pre></div><p>XSrio_GetPortControlStatus returns the status of the port that is currently enabled in the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The bit mask for the ports that are currently enabled.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#a5378e52f9e70d3b7bcdadd01a764d4a6">XSrio_GetPortControlStatus(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab855a80c812d251ab338c74fd004ab10"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortErrorStatus" ref="ab855a80c812d251ab338c74fd004ab10" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPortErrorStatus</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa9bc2b856e9b7dcb4cd5781ec1df9681">XSRIO_PORT_N_ERR_STS_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a72cb3e32c415ed1ad9bf901ed4738c3b">XSRIO_PORT_N_ERR_STS_CSR_ERR_ALL_MASK</a>)
|
|
</pre></div><p>XSrio_GetPortErrorStatus returns the mask for the port errors currently enabled in the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The bit mask for the port errors that are currently enabled.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#ab855a80c812d251ab338c74fd004ab10">XSrio_GetPortErrorStatus(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a81b9edd3c92a0e2a71bdc6e8204ad87a"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortLinkTimeOutValue" ref="a81b9edd3c92a0e2a71bdc6e8204ad87a" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPortLinkTimeOutValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a1e79cd1c619b83e98fd3890a7e481afb">XSRIO_PORT_LINK_TOUT_CSR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a4879c96774b975189fcbf586e57a06ba">XSRIO_PORT_LINK_TOUT_CSR_TOUTVAL_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#a1393da4ef49e86fc2372cc7da2c7f1f2">XSRIO_PORT_LINK_TOUT_CSR_TOUTVAL_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetPortLinkTimeOutValue returns the Port Link Timeout value for the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Port link Timeout Value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#a81b9edd3c92a0e2a71bdc6e8204ad87a">XSrio_GetPortLinkTimeOutValue(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9963021f71bdeca584ebfb9d3e57a1e4"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortRespTimeOutValue" ref="a9963021f71bdeca584ebfb9d3e57a1e4" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPortRespTimeOutValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa2f205d7f2f3063e39ce45e6e2712bd8">XSRIO_PORT_RESP_TOUT_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a14f32634f2bedb6a547b75714ab1300a">XSRIO_PORT_RESP_TOUT_CSR_TOUTVAL_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#acc4dcceafc76cc3725fdcee33bda63e8">XSRIO_PORT_RESP_TOUT_CSR_TOUTVAL_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetPortRespTimeOutValue returns the Port Response Timeout value for the the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Port Response Timeout value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#a9963021f71bdeca584ebfb9d3e57a1e4">XSrio_GetPortRespTimeOutValue(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a66ab356e1da20d8530a3028634091321"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortwidthOverride" ref="a66ab356e1da20d8530a3028634091321" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPortwidthOverride</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ada34aa1e1fa5c40f1fa47aadce896ca6">XSRIO_PORT_N_CTL_CSR_PWO_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#a55777eb3881e2b939ba8de77a16c62d6">XSRIO_PORT_N_CTL_CSR_PWO_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetPortwidthOverride returns the port width override value of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Port Width Override Value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a66ab356e1da20d8530a3028634091321">XSrio_GetPortwidthOverride(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa67bb8a01c79079bed244bed3d8b2288"></a><!-- doxytag: member="xsrio.h::XSrio_GetPriority" ref="aa67bb8a01c79079bed244bed3d8b2288" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetPriority</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a4a5e50909869ab789a272b6e1b93a2be">XSRIO_IMP_MRIR_REQ_PRIO_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#aae865ad4db5328c09c32b1f4105f5276">XSRIO_IMP_MRIR_REQ_PRIO_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetPriority priority used for outgoing maintenance requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Priority value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#aa67bb8a01c79079bed244bed3d8b2288">XSrio_GetPriority(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aae5bc91f206477d2b670df74960c9f21"></a><!-- doxytag: member="xsrio.h::XSrio_GetRxSize" ref="aae5bc91f206477d2b670df74960c9f21" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetRxSize</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a335241657626eab68188c0d505572c35">XSRIO_IMP_BCSR_RXSIZE_MASK</a>)
|
|
</pre></div><p>XSrio_GetRxSize returns the number of maximum-size packets the rx buffer holded.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Rx buffer size.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#aae5bc91f206477d2b670df74960c9f21">XSrio_GetRxSize(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8deeb1034839d63ea19adcafcfbb3f10"></a><!-- doxytag: member="xsrio.h::XSrio_GetSerialExtFeaturesPointer" ref="a8deeb1034839d63ea19adcafcfbb3f10" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetSerialExtFeaturesPointer</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a2e147a812705dfde71c8b3b5ea85b7e0">XSRIO_EFB_HEADER_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ab268d0f09ad1647741b2db233c436cfa">XSRIO_EFB_HEADER_EFP_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#aa8021afc163a4658898e6f036b7f50ca">XSRIO_EFB_HEADER_EFP_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetSerialExtFeaturesPointer returns the Extended Features Pointer which will point to the next extended features block if one exists.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Extended Features Pointer Address.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a8deeb1034839d63ea19adcafcfbb3f10">XSrio_GetSerialExtFeaturesPointer(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5416a4413a7fba4cde587a089f1ef1ab"></a><!-- doxytag: member="xsrio.h::XSrio_GetSerialLaneExtFeaturesPointer" ref="a5416a4413a7fba4cde587a089f1ef1ab" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetSerialLaneExtFeaturesPointer</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a72659b475911b0612f6bd8704ab1fe56">XSRIO_EFB_LPSL_OFFSET</a> + <a class="code" href="xsrio__hw_8h.html#a4499d2f039a465f34e8f80995c11b144">XSRIO_SL_HEADER_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ad8ff82d1b0be608c51ff0429e823f7a1">XSRIO_SL_HEADER_EFP_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#a78b48c1d1df27c224b1c46435a55ba6f">XSRIO_SL_HEADER_EFP_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetSerialLaneExtFeaturesPointer returns the extended features pointer For the serial lane which will point to the next extended features block If one exists.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Extended Features Pointer Address.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a5416a4413a7fba4cde587a089f1ef1ab">XSrio_GetSerialLaneExtFeaturesPointer(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a65108021ee8bdfcc49caf050106a015c"></a><!-- doxytag: member="xsrio.h::XSrio_GetTxSize" ref="a65108021ee8bdfcc49caf050106a015c" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_GetTxSize</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a8c58f4eff4ec070291fc83b76351a73c">XSRIO_IMP_BCSR_TXSIZE_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#a04e3e69ddd5ca32d49b7177773cd4740">XSRIO_IMP_BCSR_TXSIZE_SHIFT</a>)
|
|
</pre></div><p>XSrio_GetTxSize returns the number of maximum-size packets the tx buffer holds.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Tx buffer size.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a65108021ee8bdfcc49caf050106a015c">XSrio_GetTxSize(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28f04469ea0d63a8b787989f94d6f8d5"></a><!-- doxytag: member="xsrio.h::XSRIO_H" ref="a28f04469ea0d63a8b787989f94d6f8d5" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_H</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5c084f9424ee6edbc6c9c94db2dac6f8"></a><!-- doxytag: member="xsrio.h::XSRIO_IS_BRIDGE" ref="a5c084f9424ee6edbc6c9c94db2dac6f8" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_IS_BRIDGE 3</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core can be used as a bridge to another interface </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abea6ccdc70412fa41b6d45785ff2d287"></a><!-- doxytag: member="xsrio.h::XSRIO_IS_MEMORY" ref="abea6ccdc70412fa41b6d45785ff2d287" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_IS_MEMORY 1</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core has physically addressable storage space </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada8228136dc485b32c5a1e8ea9f0c1ee"></a><!-- doxytag: member="xsrio.h::XSRIO_IS_PROCESSOR" ref="ada8228136dc485b32c5a1e8ea9f0c1ee" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_IS_PROCESSOR 2</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core has a local processor that runs code </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a307ef4f230012aa16316913933832c82"></a><!-- doxytag: member="xsrio.h::XSrio_IsCRFSupported" ref="a307ef4f230012aa16316913933832c82" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsCRFSupported</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a1570a90db90ab3215174f7e6c40afebe">XSRIO_PEF_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#aae8b2866d05745c18564ad1ac6f9fefb">XSRIO_PEF_CAR_CRF_MASK</a>) ? \
|
|
TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsCRFSupported checks whether the PE(Processing Element) supports CRF(Critical Request Flow indicator).</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the System Supports CRF.</li>
|
|
<li>FALSE If the System Wont Support CRF.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a307ef4f230012aa16316913933832c82">XSrio_IsCRFSupported(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab4861fc531773228164b79f8759f0f2b"></a><!-- doxytag: member="xsrio.h::XSrio_IsEnumerationBoundary" ref="ab4861fc531773228164b79f8759f0f2b" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsEnumerationBoundary</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ab5e4697d8469fa671713a7d0f948410e">XSRIO_PORT_N_CTL_CSR_ENUMB_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsEnumerationBoundary checks whether the enumeration boundary is available or not for the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE if the EnumerationBoundary Enabled.</li>
|
|
<li>FALSE if the EnumerationBoundary is not Enabled.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#ab4861fc531773228164b79f8759f0f2b">XSrio_IsEnumerationBoundary(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a06ac428cbafbe85e5513f696a65c5fef"></a><!-- doxytag: member="xsrio.h::XSrio_IsHost" ref="a06ac428cbafbe85e5513f696a65c5fef" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsHost</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) \
|
|
& <a class="code" href="xsrio__hw_8h.html#a77b8c4f3f9031effb14a67997d224677">XSRIO_PORT_GEN_CTL_CSR_HOST_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsHost checks whether PE(Processing Element) is responsible for system exploration.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the Host bit is set.</li>
|
|
<li>FALSE If the Host bit is not set.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a06ac428cbafbe85e5513f696a65c5fef">XSrio_IsHost(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9aee3caa383586a448d912957518246c"></a><!-- doxytag: member="xsrio.h::XSrio_IsLargeSystem" ref="a9aee3caa383586a448d912957518246c" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsLargeSystem</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a1570a90db90ab3215174f7e6c40afebe">XSRIO_PEF_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a6d0954eda8d0276d5555eee23fa85d6c">XSRIO_PEF_CAR_CTS_MASK</a>) ? \
|
|
TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsLargeSystem checks whether PE(Processing Element) supports a large system (16-bit Device ids)</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the System Supports 16-bit Devices.</li>
|
|
<li>FALSE If the System Supports 8-bit Devices.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a9aee3caa383586a448d912957518246c">XSrio_IsLargeSystem(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3dce12def9f522691b91a352b4f8f718"></a><!-- doxytag: member="xsrio.h::XSrio_IsMasterEnabled" ref="a3dce12def9f522691b91a352b4f8f718" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsMasterEnabled</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) \
|
|
& <a class="code" href="xsrio__hw_8h.html#a008f961f9e1d2c969c8cf9a4b886e3d6">XSRIO_PORT_GEN_CTL_CSR_MENABLE_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsMasterEnabled checks whether PE(Processing Element) is allowed to issue request into the system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the Master Enable bit is set.</li>
|
|
<li>FALSE If the Master Enable bit is not set.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a3dce12def9f522691b91a352b4f8f718">XSrio_IsMasterEnabled(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abb901983e661260f87855035e838a5b1"></a><!-- doxytag: member="xsrio.h::XSrio_IsPEDiscovered" ref="abb901983e661260f87855035e838a5b1" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsPEDiscovered</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a39dba66c3b45c23056552d38459a5426">XSRIO_PORT_GEN_CTL_CSR_DISCOVERED_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsPEDiscovered checks whether the PE(Processing Element) is discovered or not.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the PE is Discovered.</li>
|
|
<li>FALSE If the PE is not Discovered.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#abb901983e661260f87855035e838a5b1">XSrio_IsPEDiscovered(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8e6d99b38fe43a4eeab492ba4b98f0d7"></a><!-- doxytag: member="xsrio.h::XSrio_IsResponseValid" ref="a8e6d99b38fe43a4eeab492ba4b98f0d7" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsResponseValid</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a8e71a8e128b15c1b237942a5485c1123">XSRIO_PORT_N_MNT_RES_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a823f5fff998236f34c384e1a6e3450d8">XSRIO_PORT_N_MNT_RES_CSR_RVALID_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsResponseValid checks whether the link response is valid or not in the SRIO Gen2 Core. This api is available only if the software assisted error recovery option is enabled in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE if the corresponding link request causes a link response.</li>
|
|
<li>FALSE if the corresponding link request not causes a link response.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a8e6d99b38fe43a4eeab492ba4b98f0d7">XSrio_IsResponseValid(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af495f0414308d1f913450d94149ffa45"></a><!-- doxytag: member="xsrio.h::XSrio_IsTxFlowControl" ref="af495f0414308d1f913450d94149ffa45" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_IsTxFlowControl</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad651fab42acba780368b1dbe153c1e4d">XSRIO_IMP_BCSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a2fee7f23801a2e0b8ce142335a401717">XSRIO_IMP_BCSR_TX_FLOW_CNTL_MASK</a>) ? TRUE : FALSE)
|
|
</pre></div><p>XSrio_IsTxFlowControl checks whether the BUF is currently operating in Tx flow control mode or not.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>TRUE If the Tx Flow Control is enabled in the core.</li>
|
|
<li>FALSE If the Tx Flow Control is not enabled in the core.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#af495f0414308d1f913450d94149ffa45">XSrio_IsTxFlowControl(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac0c9b8d9ebb9191a8314f93225bd59a8"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_ATOMIC" ref="ac0c9b8d9ebb9191a8314f93225bd59a8" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_ATOMIC 6</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports atomic Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a01882d64861c721fafb08cc63dc7e589"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_DATA_MESSAGE" ref="a01882d64861c721fafb08cc63dc7e589" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_DATA_MESSAGE 4</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports data message Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a246f138414b507e094ebbfb196350805"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_DOORBELL" ref="a246f138414b507e094ebbfb196350805" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_DOORBELL 5</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports doorbell Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afadc09b23898c51bba7c5167f439000d"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_NREAD" ref="afadc09b23898c51bba7c5167f439000d" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_NREAD 0</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports read Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5bcffc7047fbbb505c256fa15062ec9e"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_NWRITE" ref="a5bcffc7047fbbb505c256fa15062ec9e" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_NWRITE 1</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports write Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab4e13bb3d8eeb614bdc2f655cbc4ba16"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_NWRITE_R" ref="ab4e13bb3d8eeb614bdc2f655cbc4ba16" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_NWRITE_R 3</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports write with Response operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a17ddc9d36a51e2a63e6b7e8b1d6ca204"></a><!-- doxytag: member="xsrio.h::XSRIO_OP_MODE_SWRITE" ref="a17ddc9d36a51e2a63e6b7e8b1d6ca204" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_OP_MODE_SWRITE 2</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Core supports streaming-write Operation </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a86e8b638b0295f135b4dfea25bcefce4"></a><!-- doxytag: member="xsrio.h::XSRIO_PORT_HAS_ERRORS" ref="a86e8b638b0295f135b4dfea25bcefce4" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_PORT_HAS_ERRORS 2</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Port has errors </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abc16a98ad67644dbb4dc653fafe590bb"></a><!-- doxytag: member="xsrio.h::XSRIO_PORT_OK" ref="abc16a98ad67644dbb4dc653fafe590bb" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_PORT_OK 0</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Port is initialized </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af20e9fbfb23bbe3e1c9c201609a93352"></a><!-- doxytag: member="xsrio.h::XSRIO_PORT_UNINITIALIZED" ref="af20e9fbfb23bbe3e1c9c201609a93352" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSRIO_PORT_UNINITIALIZED 1</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Port is uninitialized </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a327539a3b73d7658270fc3a2e268153d"></a><!-- doxytag: member="xsrio.h::XSrio_ReadAsmID" ref="a327539a3b73d7658270fc3a2e268153d" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadAsmID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad1d21e2f268e2846ebe39b28a264f913">XSRIO_ASM_ID_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a89b8ef844db7e44d64e664cd6db8be32">XSRIO_ASM_ID_CAR_ASMID_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#a1cd5b1b731cd9b62308620bfb57e3fb3">XSRIO_ASM_ID_CAR_ASMID_SHIFT</a>)
|
|
</pre></div><p>XSrio_ReadAsmID returns the Assembly Id of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Assembly ID of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a327539a3b73d7658270fc3a2e268153d">XSrio_ReadAsmID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afc9e89d83a445e74b1c96d9c05f7e7b6"></a><!-- doxytag: member="xsrio.h::XSrio_ReadAsmRevision" ref="afc9e89d83a445e74b1c96d9c05f7e7b6" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadAsmRevision</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a0a923d474a8eeac67f54d6259da07dc4">XSRIO_ASM_INFO_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a227ff52b5cef4a3e6580d8f4f9eb804b">XSRIO_ASM_INFO_CAR_ASMREV_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#a7253ac10f0978d022f8a89ff6c11763b">XSRIO_ASM_INFO_CAR_ASMREV_SHIFT</a>)
|
|
</pre></div><p>XSrio_ReadAsmRevision returns the Assembly Revision value of the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Assembly revision of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#afc9e89d83a445e74b1c96d9c05f7e7b6">XSrio_ReadAsmRevision(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2b99a417e8924310fc14618c629a8f50"></a><!-- doxytag: member="xsrio.h::XSrio_ReadAsmVendorID" ref="a2b99a417e8924310fc14618c629a8f50" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadAsmVendorID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#ad1d21e2f268e2846ebe39b28a264f913">XSRIO_ASM_ID_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#add35ed24ff26b397f6c1631c92782f3b">XSRIO_ASM_ID_CAR_ASMVID_MASK</a>)
|
|
</pre></div><p>XSrio_ReadAsmVendorID returns the Assembly Vendor Id of the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Assembly Vendor ID of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a2b99a417e8924310fc14618c629a8f50">XSrio_ReadAsmVendorID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5de6f1044b7f754c6ae9cdbe703f8ee6"></a><!-- doxytag: member="xsrio.h::XSrio_ReadDeviceID" ref="a5de6f1044b7f754c6ae9cdbe703f8ee6" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadDeviceID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#abab5f1195566978a3b8d7547b6c4e0a3">XSRIO_DEV_ID_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a5090e315c08229f3f0dd2f6da8a11d7b">XSRIO_DEV_ID_DEVID_CAR_MASK</a>) >> \
|
|
<a class="code" href="xsrio__hw_8h.html#a820df48ad6186de84f3140bf90383c10">XSRIO_DEV_ID_DEVID_CAR_SHIFT</a>)
|
|
</pre></div><p>XSrio_ReadDeviceID returns the Device Id of the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Device ID of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a5de6f1044b7f754c6ae9cdbe703f8ee6">XSrio_ReadDeviceID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8a7ebb9dba61f05473de5c3e80f6037a"></a><!-- doxytag: member="xsrio.h::XSrio_ReadDeviceVendorID" ref="a8a7ebb9dba61f05473de5c3e80f6037a" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadDeviceVendorID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#abab5f1195566978a3b8d7547b6c4e0a3">XSRIO_DEV_ID_CAR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a39ae0182ccd2af230e7c1b9a308f8fdd">XSRIO_DEV_ID_VDRID_CAR_MASK</a>)
|
|
</pre></div><p>XSrio_ReadDeviceVendorID returns the Device Vendor Id of the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Device Vendor ID of the core.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u16 <a class="el" href="xsrio_8h.html#a8a7ebb9dba61f05473de5c3e80f6037a">XSrio_ReadDeviceVendorID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae7326b439df172403f28fcc0fa38e992"></a><!-- doxytag: member="xsrio.h::XSrio_ReadDstOps" ref="ae7326b439df172403f28fcc0fa38e992" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadDstOps</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a6d60eb0dc6cb85145be43d77bf14bae1">XSRIO_DST_OPS_CAR_OFFSET</a>)
|
|
</pre></div><p>XSrio_ReadDstOps returns the Destination Operations CAR Register contents.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Contents of the Destination Operations CAR Register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#ae7326b439df172403f28fcc0fa38e992">XSrio_ReadDstOps(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ada1a2bfecf3f5afca7be3d94df46290a"></a><!-- doxytag: member="xsrio.h::XSrio_ReadSrcOps" ref="ada1a2bfecf3f5afca7be3d94df46290a" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_ReadSrcOps</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a1ab414d1303bbb5d65e4a22a7361ea55">XSRIO_SRC_OPS_CAR_OFFSET</a>)
|
|
</pre></div><p>XSrio_ReadSrcOps returns the Source Operations CAR Register contents.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Contents of the Source Operations CAR Register.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u32 <a class="el" href="xsrio_8h.html#ada1a2bfecf3f5afca7be3d94df46290a">XSrio_ReadSrcOps(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8f99aebc6c8ef91fffe3512e76cb199f"></a><!-- doxytag: member="xsrio.h::XSrio_RequestTID" ref="a8f99aebc6c8ef91fffe3512e76cb199f" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_RequestTID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a> ) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a6fd471211a93073029bfcdcd7de4ddef">XSRIO_IMP_MRIR_REQ_TID_MASK</a>) >> <a class="code" href="xsrio__hw_8h.html#a55186561b6e59efbe64182bab5ade583">XSRIO_IMP_MRIR_REQ_TID_SHIFT</a>)
|
|
</pre></div><p>XSrio_RequestTID gives the transfer id value which will be used for the next outgoing maintenance request. This value will increment after each request is sent.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>Transfer ID value.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: u8 <a class="el" href="xsrio_8h.html#a8f99aebc6c8ef91fffe3512e76cb199f">XSrio_RequestTID(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a42eecc100ed216b9cdda8612284a0a61"></a><!-- doxytag: member="xsrio.h::XSrio_SendCommand" ref="a42eecc100ed216b9cdda8612284a0a61" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SendCommand</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a98dd1aa546c28e3ad2e5dfa370795346">XSRIO_PORT_N_MNT_REQ_CSR_OFFSET</a>, \
|
|
Value & <a class="code" href="xsrio__hw_8h.html#a90f9f21f13d053d8d92578cdddfe8027">XSRIO_PORT_N_MNT_REQ_CSR_CMD_MASK</a>))
|
|
</pre></div><p>XSrio_SendCommand sends the given command in the link-request control symbol of the SRIO Gen2 core. This api is available only if the software assisted error recovery option is selected in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Command to be send.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a42eecc100ed216b9cdda8612284a0a61">XSrio_SendCommand(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a07769a73bad559c94a8df465fa696d41"></a><!-- doxytag: member="xsrio.h::XSrio_SetBaseDeviceID" ref="a07769a73bad559c94a8df465fa696d41" args="(InstancePtr, DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetBaseDeviceID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DeviceId </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#a593eed7b4e0cf5c113668ec501709392">XSRIO_BASE_DID_CSR_LBDID_MASK</a>) \
|
|
|((DeviceId << <a class="code" href="xsrio__hw_8h.html#add5f5e46e978b7addcd450362a3e4f6b">XSRIO_BASE_DID_CSR_BDID_SHIFT</a>) \
|
|
& <a class="code" href="xsrio__hw_8h.html#aa398a9d87c352370ad8368def9aec0df">XSRIO_BASE_DID_CSR_BDID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetBaseDeviceID configures the 8-bit Device Id for an endpoint in a small transport system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em> </td><td>is the Device ID that needs to be configured.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a07769a73bad559c94a8df465fa696d41">XSrio_SetBaseDeviceID(XSrio *InstancePtr, u8 DeviceId)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aefe9cfb3e23651f6e0ba04cebf2ea468"></a><!-- doxytag: member="xsrio.h::XSrio_SetComponentTagCSR" ref="aefe9cfb3e23651f6e0ba04cebf2ea468" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetComponentTagCSR</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#abf538c58029dbfecbc051a594c5b6ab8">XSRIO_COMPONENT_TAG_CSR_OFFSET</a>, \
|
|
Value))
|
|
</pre></div><p>XSrio_SetComponentTagCSR sets the Component Tag Value for SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Component Tag Value to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#aefe9cfb3e23651f6e0ba04cebf2ea468">XSrio_SetComponentTagCSR(XSrio *InstancePtr, u32 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8c73d55426fe8cebbecb990d6b3d2157"></a><!-- doxytag: member="xsrio.h::XSrio_SetCRF" ref="a8c73d55426fe8cebbecb990d6b3d2157" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetCRF</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>) | \
|
|
<a class="code" href="xsrio__hw_8h.html#a114b6719c2e1043ef79c009fead1b28d">XSRIO_IMP_MRIR_REQ_CRF_MASK</a>)))
|
|
</pre></div><p>XSrio_SetCRF sets CRF value that is used for outgoing maintenance requests. This api will work only when the CRF support is enabled in the core</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a8c73d55426fe8cebbecb990d6b3d2157">XSrio_SetCRF(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afe400870d468d8dcf400b78fa64c812e"></a><!-- doxytag: member="xsrio.h::XSrio_SetDestinationID" ref="afe400870d468d8dcf400b78fa64c812e" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetDestinationID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>) & ~<a class="code" href="xsrio__hw_8h.html#a4b251ca3e20b50fad896a7b93eadd002">XSRIO_IMP_MRIR_REQ_DESTID_MASK</a>) | \
|
|
(Value & <a class="code" href="xsrio__hw_8h.html#a4b251ca3e20b50fad896a7b93eadd002">XSRIO_IMP_MRIR_REQ_DESTID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetDestinationID sets Device Id which will be used for Outgoing maintenance requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Device Id value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#afe400870d468d8dcf400b78fa64c812e">XSrio_SetDestinationID(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6fe0e368f18de444791fabf766909ce5"></a><!-- doxytag: member="xsrio.h::XSrio_SetDiscovered" ref="a6fe0e368f18de444791fabf766909ce5" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetDiscovered</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) \
|
|
| <a class="code" href="xsrio__hw_8h.html#a39dba66c3b45c23056552d38459a5426">XSRIO_PORT_GEN_CTL_CSR_DISCOVERED_MASK</a>)))
|
|
</pre></div><p>XSrio_SetDiscovered configures the device as Discovered so that it is responsible for system exploration.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a6fe0e368f18de444791fabf766909ce5">XSrio_SetDiscovered(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afdfe7ecbbc797795197a01c43d757bde"></a><!-- doxytag: member="xsrio.h::XSrio_SetHostBaseDevID_LockCSR" ref="afdfe7ecbbc797795197a01c43d757bde" args="(InstancePtr, DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetHostBaseDevID_LockCSR</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DeviceId </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa385c427eb29650bb31acbaf4a3e320c">XSRIO_HOST_DID_LOCK_CSR_OFFSET</a>, \
|
|
(DeviceId & <a class="code" href="xsrio__hw_8h.html#a65ffdf1055349f408681a28e4804ad0a">XSRIO_HOST_DID_LOCK_CSR_HBDID_MASK</a>)))
|
|
</pre></div><p>XSrio_SetHostBaseDevID_LockCSR configures the Host Base Device Id of the SRIO gen2 Core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em> </td><td>is the Device ID that needs to be configured.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void XSrio_SetHostBaseDevID_LockCSR(<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u16 DeviceId) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae335b6bbb82ca4ac987b936bc83017d2"></a><!-- doxytag: member="xsrio.h::XSrio_SetHostEnabled" ref="ae335b6bbb82ca4ac987b936bc83017d2" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetHostEnabled</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) \
|
|
| <a class="code" href="xsrio__hw_8h.html#a77b8c4f3f9031effb14a67997d224677">XSRIO_PORT_GEN_CTL_CSR_HOST_MASK</a>)))
|
|
</pre></div><p>XSrio_SetHostEnabled configures the device to be responsible for system exploration.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#ae335b6bbb82ca4ac987b936bc83017d2">XSrio_SetHostEnabled(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad2c03c531f3f4f6f6755abbf659de414"></a><!-- doxytag: member="xsrio.h::XSrio_SetInboundAckID" ref="ad2c03c531f3f4f6f6755abbf659de414" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetInboundAckID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#ab8e80519afd40400fcc74f268a7a2e7a">XSRIO_PORT_N_ACKID_CSR_RESET_IBACKID_MASK</a>) \
|
|
| ((Value << <a class="code" href="xsrio__hw_8h.html#a8b3e4ea25cec8c9876433d60720c2b9b">XSRIO_PORT_N_ACKID_CSR_IBACKID_SHIFT</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a8acb5233083f47870eddd512acf461cd">XSRIO_PORT_N_ACKID_CSR_IBACKID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetInboundAckID sets the value of the next transmitted Ackid of the SRIO Gen2 core. This api is available only if the software assisted error recovery option is selected in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the InBound Ack Id to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void XSrio_SetInboundAckID(<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u8 Value) This api won't work if you call the XSrio_ClrOutStandingAckIDs before calling this api. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab4bcd463737ea357837d33a6dc5d624d"></a><!-- doxytag: member="xsrio.h::XSrio_SetLargeBaseDeviceID" ref="ab4bcd463737ea357837d33a6dc5d624d" args="(InstancePtr, DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetLargeBaseDeviceID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DeviceId </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a9b3abe05cc0b757413751f3c493023cd">XSRIO_BASE_DID_CSR_OFFSET</a>) & <a class="code" href="xsrio__hw_8h.html#aa398a9d87c352370ad8368def9aec0df">XSRIO_BASE_DID_CSR_BDID_MASK</a>) | \
|
|
(DeviceId & <a class="code" href="xsrio__hw_8h.html#a593eed7b4e0cf5c113668ec501709392">XSRIO_BASE_DID_CSR_LBDID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetLargeBaseDeviceID configures the 16-bit Device Id for an endpoint in a Large transport system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em> </td><td>is the Device ID that needs to be configured.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#ab4bcd463737ea357837d33a6dc5d624d">XSrio_SetLargeBaseDeviceID(XSrio *InstancePtr, u16 DeviceId)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aceba101926e9798fa350e1d5676fd43a"></a><!-- doxytag: member="xsrio.h::XSrio_SetLCSBA" ref="aceba101926e9798fa350e1d5676fd43a" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetLCSBA</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afffc5b4df1dd5366ef4074e68f7b958a">XSRIO_LCS1_BASEADDR_CSR_OFFSET</a>, \
|
|
((Value << <a class="code" href="xsrio__hw_8h.html#acffff28710d77ac7a123f78728eb4712">XSRIO_LCS1_BASEADDR_LCSBA_CSR_SHIFT</a>) \
|
|
& <a class="code" href="xsrio__hw_8h.html#a7c4c40c3d4edc4ca1bc643c95fe18cf2">XSRIO_LCS1_BASEADDR_LCSBA_CSR_MASK</a>)))
|
|
</pre></div><p>XSrio_SetLCSBA Configures the Local Configuration Space Base Address of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Local Configuration Space Base Address that needs to be configured.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#aceba101926e9798fa350e1d5676fd43a">XSrio_SetLCSBA(XSrio *InstancePtr, u32 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aac00f96b3a6ce690351f244ab67ca136"></a><!-- doxytag: member="xsrio.h::XSrio_SetMasterEnabled" ref="aac00f96b3a6ce690351f244ab67ca136" args="(InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetMasterEnabled</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a4561044e5d4900706f43c752b43ff51a">XSRIO_PORT_GEN_CTL_CSR_OFFSET</a>) \
|
|
| <a class="code" href="xsrio__hw_8h.html#a008f961f9e1d2c969c8cf9a4b886e3d6">XSRIO_PORT_GEN_CTL_CSR_MENABLE_MASK</a>)))
|
|
</pre></div><p>XSrio_SetMasterEnabled configures the device so that it is allowed to issue requests into the system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#aac00f96b3a6ce690351f244ab67ca136">XSrio_SetMasterEnabled(XSrio *InstancePtr)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49bc09c674f99b8edb4c050c68394794"></a><!-- doxytag: member="xsrio.h::XSrio_SetOutboundAckID" ref="a49bc09c674f99b8edb4c050c68394794" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetOutboundAckID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#af43554809e5c07fffb0e53045b09c01c">XSRIO_PORT_N_ACKID_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#abadb3622d68d65a1ff9d08a7bd754620">XSRIO_PORT_N_ACKID_CSR_RESET_OBACKID_MASK</a>) \
|
|
| (Value & <a class="code" href="xsrio__hw_8h.html#a6541e592e664f2549721d2073626dc91">XSRIO_PORT_N_ACKID_CSR_OBACKID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetOutboundAckID sets value of the next transmitted Ackid of the SRIO Gen2 Core. This api is available only if the software assisted error Recovery option is selected in the core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Outbound Ack Id to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a49bc09c674f99b8edb4c050c68394794">XSrio_SetOutboundAckID(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1a877c69f015fcb1069b874f8008a8f5"></a><!-- doxytag: member="xsrio.h::XSrio_SetPortControlStatus" ref="a1a877c69f015fcb1069b874f8008a8f5" args="(InstancePtr, Mask)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetPortControlStatus</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Mask </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>, \
|
|
(<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) \
|
|
| (Mask & <a class="code" href="xsrio__hw_8h.html#a364330b68240054841422bcc2144ad56">XSRIO_PORT_N_CTL_CSR_STATUS_ALL_MASK</a>))))
|
|
</pre></div><p>XSrio_SetPortControlStatus Configures specific port specified by the Mask.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Mask</em> </td><td>is the mask for the port that needs to be enabled.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a1a877c69f015fcb1069b874f8008a8f5">XSrio_SetPortControlStatus(XSrio *InstancePtrm, u32 Mask)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae07e03313283e68a326337c7b7719e8a"></a><!-- doxytag: member="xsrio.h::XSrio_SetPortLinkTimeOutValue" ref="ae07e03313283e68a326337c7b7719e8a" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetPortLinkTimeOutValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#a1e79cd1c619b83e98fd3890a7e481afb">XSRIO_PORT_LINK_TOUT_CSR_OFFSET</a> , \
|
|
(Value << <a class="code" href="xsrio__hw_8h.html#a1393da4ef49e86fc2372cc7da2c7f1f2">XSRIO_PORT_LINK_TOUT_CSR_TOUTVAL_SHIFT</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a4879c96774b975189fcbf586e57a06ba">XSRIO_PORT_LINK_TOUT_CSR_TOUTVAL_MASK</a>))
|
|
</pre></div><p>XSrio_SetPortLinkTimeOutValue sets the Port Link Timeout value for the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Port Link Timeout value to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void XSrio_SetPortLinkTimeOutValue(<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u16 Value) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a3c92d05848b754806d55eaf92d37e57e"></a><!-- doxytag: member="xsrio.h::XSrio_SetPortRespTimeOutValue" ref="a3c92d05848b754806d55eaf92d37e57e" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetPortRespTimeOutValue</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#aa2f205d7f2f3063e39ce45e6e2712bd8">XSRIO_PORT_RESP_TOUT_CSR_OFFSET</a>, \
|
|
(Value << <a class="code" href="xsrio__hw_8h.html#acc4dcceafc76cc3725fdcee33bda63e8">XSRIO_PORT_RESP_TOUT_CSR_TOUTVAL_SHIFT</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a14f32634f2bedb6a547b75714ab1300a">XSRIO_PORT_RESP_TOUT_CSR_TOUTVAL_MASK</a>))
|
|
</pre></div><p>XSrio_SetPortRespTimeOutValue sets the Port Response Timeout value for the The SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Port Response Timeout to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void XSrio_SetPortRespTimeOutValue(<a class="el" href="struct_x_srio.html">XSrio</a> *InstancePtr, u16 Value) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9695e204da2d3f1de942cdd68074d170"></a><!-- doxytag: member="xsrio.h::XSrio_SetPortwidthOverride" ref="a9695e204da2d3f1de942cdd68074d170" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetPortwidthOverride</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe2d28961f5aa630a30dc2916262d02b">XSRIO_PORT_N_CTL_CSR_OFFSET</a>) & \
|
|
<a class="code" href="xsrio__hw_8h.html#a1e7acaa5c3c152ded875097ff2fdb658">XSRIO_PORT_N_CTL_CSR_RESET_PWO_MASK</a>) | \
|
|
((Value << <a class="code" href="xsrio__hw_8h.html#a55777eb3881e2b939ba8de77a16c62d6">XSRIO_PORT_N_CTL_CSR_PWO_SHIFT</a>) \
|
|
& <a class="code" href="xsrio__hw_8h.html#ada34aa1e1fa5c40f1fa47aadce896ca6">XSRIO_PORT_N_CTL_CSR_PWO_MASK</a>))))
|
|
</pre></div><p>XSrio_SetPortwidthOverride configures the port width override value of the SRIO Gen2 core.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the port width override value needs to be set.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a9695e204da2d3f1de942cdd68074d170">XSrio_SetPortwidthOverride(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a96b78184a872c8eb94ece898fb80baef"></a><!-- doxytag: member="xsrio.h::XSrio_SetPriority" ref="a96b78184a872c8eb94ece898fb80baef" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetPriority</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>) & ~<a class="code" href="xsrio__hw_8h.html#a4a5e50909869ab789a272b6e1b93a2be">XSRIO_IMP_MRIR_REQ_PRIO_MASK</a>) | \
|
|
((Value << <a class="code" href="xsrio__hw_8h.html#aae865ad4db5328c09c32b1f4105f5276">XSRIO_IMP_MRIR_REQ_PRIO_SHIFT</a>)& \
|
|
<a class="code" href="xsrio__hw_8h.html#a4a5e50909869ab789a272b6e1b93a2be">XSRIO_IMP_MRIR_REQ_PRIO_MASK</a>))))
|
|
</pre></div><p>XSrio_SetPriority sets the Priority which will be used for outgoing maintenance requests.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the Priority value which will used for outgoing maintenance requests.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#a96b78184a872c8eb94ece898fb80baef">XSrio_SetPriority(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa0b06583959e2e4a720790dad9af0e39"></a><!-- doxytag: member="xsrio.h::XSrio_SetTID" ref="aa0b06583959e2e4a720790dad9af0e39" args="(InstancePtr, Value)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define XSrio_SetTID</td>
|
|
<td>(</td>
|
|
<td class="paramtype">InstancePtr, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">Value </td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="xsrio__hw_8h.html#a7f54b6fbef6410f2c375bde9e7bf09bd">XSrio_WriteReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>, \
|
|
((<a class="code" href="xsrio__hw_8h.html#a88e5d3fa1470e0fef0ae45c4956f1fa3">XSrio_ReadReg</a>((InstancePtr)->Config.BaseAddress, \
|
|
<a class="code" href="xsrio__hw_8h.html#afe4d77bd8382322b677d9765101c7b6d">XSRIO_IMP_MRIR_OFFSET</a>) & ~<a class="code" href="xsrio__hw_8h.html#a6fd471211a93073029bfcdcd7de4ddef">XSRIO_IMP_MRIR_REQ_TID_MASK</a>) | \
|
|
((Value << <a class="code" href="xsrio__hw_8h.html#a55186561b6e59efbe64182bab5ade583">XSRIO_IMP_MRIR_REQ_TID_SHIFT</a>)& \
|
|
<a class="code" href="xsrio__hw_8h.html#a6fd471211a93073029bfcdcd7de4ddef">XSRIO_IMP_MRIR_REQ_TID_MASK</a>))))
|
|
</pre></div><p>XSrio_SetTID sets the transfer id which will be used for the next outgoing maintenance request.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Value</em> </td><td>is the transfer id value which of the next outgoing maintenance request.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>C-style signature: void <a class="el" href="xsrio_8h.html#aa0b06583959e2e4a720790dad9af0e39">XSrio_SetTID(XSrio *InstancePtr, u8 Value)</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="ac5162a4f64b1b7d32456015e6c6b0243"></a><!-- doxytag: member="xsrio.h::XSrio_CfgInitialize" ref="ac5162a4f64b1b7d32456015e6c6b0243" args="(XSrio *InstancePtr, XSrio_Config *Config, u32 EffectiveAddress)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XSrio_CfgInitialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio___config.html">XSrio_Config</a> * </td>
|
|
<td class="paramname"> <em>Config</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>EffectiveAddress</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Initialization and Control functions in <a class="el" href="xsrio_8c.html">xsrio.c</a></p>
|
|
<p>Initialize the <a class="el" href="struct_x_srio.html">XSrio</a> instance provided by the caller based on the given Config structure.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is the <a class="el" href="struct_x_srio.html">XSrio</a> instance to operate on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Config</em> </td><td>is the device configuration structure containing information about a specific SRIO Device. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>EffectiveAddress</em> </td><td>is the Physical address of the hardware in a Virtual Memory operating system environment.It is the Base Address in a stand alone environment.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS Initialization was successful.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a753aded6db30e1c042e7c7ee43b2a483"></a><!-- doxytag: member="xsrio.h::XSrio_GetPEType" ref="a753aded6db30e1c042e7c7ee43b2a483" args="(XSrio *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XSrio_GetPEType </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>XSrio_GetPEType API will check for the Processing Element type and return the type of type of Processing Element</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is the <a class="el" href="struct_x_srio.html">XSrio</a> instance to operate on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XSRIO_IS_MEMORY if the core is configured as a memory</li>
|
|
<li>XSRIO_IS_PROCESSOR if the core is configured as a processor</li>
|
|
<li>XSRIO_IS_BRIDGE if the core is configured as a bridge.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>: None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acbd49fb630e7f2d7c8533d12607ef105"></a><!-- doxytag: member="xsrio.h::XSrio_GetPortStatus" ref="acbd49fb630e7f2d7c8533d12607ef105" args="(XSrio *InstancePtr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XSrio_GetPortStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>XSrio_GetPortStatus will check the status of the port and returns the status of the port to the user</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is the <a class="el" href="struct_x_srio.html">XSrio</a> instance to operate on.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XSRIO_PORT_OK Port is initialized with no errors.</li>
|
|
<li>XSRIO_PORT_UNINITIALIZED Port is not initialized. No Serial Rapidio link is present.</li>
|
|
<li>XSRIO_PORT_HAS_ERRORS Port is initialized but has errors.</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>: None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9eb82f808fa01a1679ed60a026a2a2c7"></a><!-- doxytag: member="xsrio.h::XSrio_GetWaterMark" ref="a9eb82f808fa01a1679ed60a026a2a2c7" args="(XSrio *InstancePtr, u8 *WaterMark0, u8 *WaterMark1, u8 *WaterMark2)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XSrio_GetWaterMark </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 * </td>
|
|
<td class="paramname"> <em>WaterMark0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 * </td>
|
|
<td class="paramname"> <em>WaterMark1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 * </td>
|
|
<td class="paramname"> <em>WaterMark2</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>XSrio_GetWaterMark API reads the water mark values.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is the <a class="el" href="struct_x_srio.html">XSrio</a> instance to operate on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark0</em> </td><td>is a pointer to a variable where the driver will pass back the water mark 0 value. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark1</em> </td><td>is a pointer to a variable where the driver will pass back the water mark 1 value. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark2</em> </td><td>is a pointer to a variable where the driver will pass back the water mark 2 value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>: None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afce174875d087f4b3cc4713a1df5446d"></a><!-- doxytag: member="xsrio.h::XSrio_IsOperationSupported" ref="afce174875d087f4b3cc4713a1df5446d" args="(XSrio *InstancePtr, u8 Operation, u8 Direction)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int XSrio_IsOperationSupported </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Operation</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>Direction</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>XSrio_IsOperationSupported tells whether the operation is supported by the SRIO Gen2 core or not.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Operation</em> </td><td>type is the operation type of the SRIO Packet </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>Direction</em> </td><td>type</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
|
|
<li>XST_SUCCESS if the operation is supported by the core.<ul>
|
|
<li>XST_FAILURE if the operation is not supported by the core.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a42b26033e0da4cb550f5b62477a6387c"></a><!-- doxytag: member="xsrio.h::XSrio_LookupConfig" ref="a42b26033e0da4cb550f5b62477a6387c" args="(u32 DeviceId)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="struct_x_srio___config.html">XSrio_Config</a>* XSrio_LookupConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype">u32 </td>
|
|
<td class="paramname"> <em>DeviceId</em></td>
|
|
<td> ) </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Looks up the device configuration based on the unique device ID. The table XSrio_ConfigTable contains the configuration info for each device in the system.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>DeviceId</em> </td><td>is the unique device ID of the device to lookup for</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>The configuration structure for the device. If the device ID is not found,a NULL pointer is returned.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9cb7fbc368f16113382c2a9b4556b601"></a><!-- doxytag: member="xsrio.h::XSrio_SetWaterMark" ref="a9cb7fbc368f16113382c2a9b4556b601" args="(XSrio *InstancePtr, u8 WaterMark0, u8 WaterMark1, u8 WaterMark2)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void XSrio_SetWaterMark </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_x_srio.html">XSrio</a> * </td>
|
|
<td class="paramname"> <em>InstancePtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>WaterMark0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>WaterMark1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">u8 </td>
|
|
<td class="paramname"> <em>WaterMark2</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>XSrio_SetWaterMark Configures the watermark to transfer a priority packet.</p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em> </td><td>is a pointer to the SRIO Gen2 instance to be worked on. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark0</em> </td><td>is the water mark value to transfer a priority 0 packet. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark1</em> </td><td>is the water mark value to transfer a priority 1 packet. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>WaterMark2</em> </td><td>is the water mark value to transfer a priority 2 packet.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>None.</dd></dl>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd>None. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p class="Copyright">
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
|
</p>
|
|
</body>
|
|
</html>
|