Skip to content

Commit 2ab24aa

Browse files
Bhawana SahuSiva Addepalli
Bhawana Sahu
authored and
Siva Addepalli
committed
updated for doxygen for drivers and lib
Signed-off-by: Bhawana Sahu <[email protected]>
1 parent c0aed2e commit 2ab24aa

File tree

2,312 files changed

+339122
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,312 files changed

+339122
-0
lines changed

‎lib/sw_services/xilasu/doc/html/api/HTML_custom.css‎

Lines changed: 1429 additions & 0 deletions
Large diffs are not rendered by default.

‎lib/sw_services/xilasu/doc/html/api/annotated.html‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.5"/>
7+
<title>xilasu: Data Structures</title>
8+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9+
<script type="text/javascript" src="jquery.js"></script>
10+
<script type="text/javascript" src="dynsections.js"></script>
11+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
12+
<script type="text/javascript" src="resize.js"></script>
13+
<script type="text/javascript" src="navtree.js"></script>
14+
<script type="text/javascript">
15+
$(document).ready(initResizable);
16+
$(window).load(resizeHeight);
17+
</script>
18+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
19+
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
28+
<td style="padding-left: 0.5em;">
29+
<div id="projectname">xilasu
30+
</div>
31+
<div id="projectbrief">Vitis Drivers API Documentation</div>
32+
</td>
33+
</tr>
34+
</tbody>
35+
</table>
36+
</div>
37+
<!-- end header part -->
38+
<!-- Generated by Doxygen 1.8.5 -->
39+
<div id="navrow1" class="tabs">
40+
<ul class="tablist">
41+
<li><a href="index.html"><span>Overview</span></a></li>
42+
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
43+
<li><a href="globals.html"><span>APIs</span></a></li>
44+
<li><a href="files.html"><span>File&#160;List</span></a></li>
45+
</ul>
46+
</div>
47+
<div id="navrow2" class="tabs2">
48+
<ul class="tablist">
49+
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
50+
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
51+
</ul>
52+
</div>
53+
</div><!-- top -->
54+
<div id="side-nav" class="ui-resizable side-nav-resizable">
55+
<div id="nav-tree">
56+
<div id="nav-tree-contents">
57+
<div id="nav-sync" class="sync"></div>
58+
</div>
59+
</div>
60+
<div id="splitbar" style="-moz-user-select:none;"
61+
class="ui-resizable-handle">
62+
</div>
63+
</div>
64+
<script type="text/javascript">
65+
$(document).ready(function(){initNavTree('annotated.html','');});
66+
</script>
67+
<div id="doc-content">
68+
<div class="header">
69+
<div class="headertitle">
70+
<div class="title">Data Structures</div> </div>
71+
</div><!--header-->
72+
<div class="contents">
73+
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
74+
<table class="directory">
75+
<tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_asu___aes_params.html" target="_self">Asu_AesParams</a></td><td class="desc">This structure is common for both client and handler, which contains AES input and output parameters information </td></tr>
76+
<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_ecdsa_crv_info.html" target="_self">EcdsaCrvInfo</a></td><td class="desc">&lt; The structure below matches the more private structures of binary_curve and prime_curve in the SDK </td></tr>
77+
<tr id="row_2_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___aes_key_object.html" target="_self">XAsu_AesKeyObject</a></td><td class="desc">This structure contains AES key object information </td></tr>
78+
<tr id="row_3_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___channel_memory.html" target="_self">XAsu_ChannelMemory</a></td><td class="desc">This struture is the channel's memory </td></tr>
79+
<tr id="row_4_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___channel_queue.html" target="_self">XAsu_ChannelQueue</a></td><td class="desc">This structure is the channel's queue which is of 8 buffers </td></tr>
80+
<tr id="row_5_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___channel_queue_buf.html" target="_self">XAsu_ChannelQueueBuf</a></td><td class="desc">This structure is the channel's queue buffer </td></tr>
81+
<tr id="row_6_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___client_params.html" target="_self">XAsu_ClientParams</a></td><td class="desc">This structure contains client parameters information </td></tr>
82+
<tr id="row_7_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___comm_channel.html" target="_self">XAsu_CommChannel</a></td><td class="desc">This structure contains information of each communication channel </td></tr>
83+
<tr id="row_8_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___comm_channel_info.html" target="_self">XAsu_CommChannelInfo</a></td><td class="desc">This structure contains information of all communication channels </td></tr>
84+
<tr id="row_9_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___ecc_key_params.html" target="_self">XAsu_EccKeyParams</a></td><td class="desc">This structure contains ECC params info for public key generation </td></tr>
85+
<tr id="row_10_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___ecc_params.html" target="_self">XAsu_EccParams</a></td><td class="desc">This structure contains ECC params info </td></tr>
86+
<tr id="row_11_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___ecies_params.html" target="_self">XAsu_EciesParams</a></td><td class="desc">This structure contains ECIES params info </td></tr>
87+
<tr id="row_12_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___hmac_params.html" target="_self">XAsu_HmacParams</a></td><td class="desc">This structure contains HMAC params info </td></tr>
88+
<tr id="row_13_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___kdf_params.html" target="_self">XAsu_KdfParams</a></td><td class="desc">This structure contains KDF params info </td></tr>
89+
<tr id="row_14_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___key_wrap_params.html" target="_self">XAsu_KeyWrapParams</a></td><td class="desc">This structure contains Key wrap unwrap params info </td></tr>
90+
<tr id="row_15_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___req_buf.html" target="_self">XAsu_ReqBuf</a></td><td class="desc">This structure is the request buffer </td></tr>
91+
<tr id="row_16_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___resp_buf.html" target="_self">XAsu_RespBuf</a></td><td class="desc">This structure is the response buffer </td></tr>
92+
<tr id="row_17_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_crt_key_comp.html" target="_self">XAsu_RsaCrtKeyComp</a></td><td class="desc">This structure contains RSA private key CRT parameters info </td></tr>
93+
<tr id="row_18_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_oaep_padding_params.html" target="_self">XAsu_RsaOaepPaddingParams</a></td><td class="desc">This structure contains RSA OAEP padding params info </td></tr>
94+
<tr id="row_19_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_padding_params.html" target="_self">XAsu_RsaPaddingParams</a></td><td class="desc">This structure contains RSA PSS padding params info </td></tr>
95+
<tr id="row_20_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_params.html" target="_self">XAsu_RsaParams</a></td><td class="desc">This structure contains RSA params info </td></tr>
96+
<tr id="row_21_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_pub_key_comp.html" target="_self">XAsu_RsaPubKeyComp</a></td><td class="desc">This structure contains RSA public key parameters info </td></tr>
97+
<tr id="row_22_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_pvt_key_comp.html" target="_self">XAsu_RsaPvtKeyComp</a></td><td class="desc">This structure contains RSA private key parameters info </td></tr>
98+
<tr id="row_23_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_r_mod_n.html" target="_self">XAsu_RsaRModN</a></td><td class="desc">This structure contains RSA exponent values (R mod N,R square mod N) </td></tr>
99+
<tr id="row_24_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___rsa_r_r_mod_n.html" target="_self">XAsu_RsaRRModN</a></td><td class="desc">This structure contains RSA exponent value (R square mod N) </td></tr>
100+
<tr id="row_25_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="struct_x_asu___sha_operation_cmd.html" target="_self">XAsu_ShaOperationCmd</a></td><td class="desc">This structure contains SHA params info </td></tr>
101+
</table>
102+
</div><!-- directory -->
103+
</div><!-- contents -->
104+
</div><!-- doc-content -->
105+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
106+
<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
107+
<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
108+
</div>
109+
</body>
110+
</html>

‎lib/sw_services/xilasu/doc/html/api/annotated.js‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
var annotated =
2+
[
3+
[ "Asu_AesParams", "struct_asu___aes_params.html", "struct_asu___aes_params" ],
4+
[ "EcdsaCrvInfo", "struct_ecdsa_crv_info.html", "struct_ecdsa_crv_info" ],
5+
[ "XAsu_AesKeyObject", "struct_x_asu___aes_key_object.html", "struct_x_asu___aes_key_object" ],
6+
[ "XAsu_ChannelMemory", "struct_x_asu___channel_memory.html", "struct_x_asu___channel_memory" ],
7+
[ "XAsu_ChannelQueue", "struct_x_asu___channel_queue.html", "struct_x_asu___channel_queue" ],
8+
[ "XAsu_ChannelQueueBuf", "struct_x_asu___channel_queue_buf.html", "struct_x_asu___channel_queue_buf" ],
9+
[ "XAsu_ClientParams", "struct_x_asu___client_params.html", "struct_x_asu___client_params" ],
10+
[ "XAsu_CommChannel", "struct_x_asu___comm_channel.html", "struct_x_asu___comm_channel" ],
11+
[ "XAsu_CommChannelInfo", "struct_x_asu___comm_channel_info.html", "struct_x_asu___comm_channel_info" ],
12+
[ "XAsu_EccKeyParams", "struct_x_asu___ecc_key_params.html", "struct_x_asu___ecc_key_params" ],
13+
[ "XAsu_EccParams", "struct_x_asu___ecc_params.html", "struct_x_asu___ecc_params" ],
14+
[ "XAsu_EciesParams", "struct_x_asu___ecies_params.html", "struct_x_asu___ecies_params" ],
15+
[ "XAsu_HmacParams", "struct_x_asu___hmac_params.html", "struct_x_asu___hmac_params" ],
16+
[ "XAsu_KdfParams", "struct_x_asu___kdf_params.html", "struct_x_asu___kdf_params" ],
17+
[ "XAsu_KeyWrapParams", "struct_x_asu___key_wrap_params.html", "struct_x_asu___key_wrap_params" ],
18+
[ "XAsu_ReqBuf", "struct_x_asu___req_buf.html", "struct_x_asu___req_buf" ],
19+
[ "XAsu_RespBuf", "struct_x_asu___resp_buf.html", "struct_x_asu___resp_buf" ],
20+
[ "XAsu_RsaCrtKeyComp", "struct_x_asu___rsa_crt_key_comp.html", "struct_x_asu___rsa_crt_key_comp" ],
21+
[ "XAsu_RsaOaepPaddingParams", "struct_x_asu___rsa_oaep_padding_params.html", "struct_x_asu___rsa_oaep_padding_params" ],
22+
[ "XAsu_RsaPaddingParams", "struct_x_asu___rsa_padding_params.html", "struct_x_asu___rsa_padding_params" ],
23+
[ "XAsu_RsaParams", "struct_x_asu___rsa_params.html", "struct_x_asu___rsa_params" ],
24+
[ "XAsu_RsaPubKeyComp", "struct_x_asu___rsa_pub_key_comp.html", "struct_x_asu___rsa_pub_key_comp" ],
25+
[ "XAsu_RsaPvtKeyComp", "struct_x_asu___rsa_pvt_key_comp.html", "struct_x_asu___rsa_pvt_key_comp" ],
26+
[ "XAsu_RsaRModN", "struct_x_asu___rsa_r_mod_n.html", "struct_x_asu___rsa_r_mod_n" ],
27+
[ "XAsu_RsaRRModN", "struct_x_asu___rsa_r_r_mod_n.html", "struct_x_asu___rsa_r_r_mod_n" ],
28+
[ "XAsu_ShaOperationCmd", "struct_x_asu___sha_operation_cmd.html", "struct_x_asu___sha_operation_cmd" ]
29+
];

‎lib/sw_services/xilasu/doc/html/api/arrowdown.png‎

246 Bytes
Loading

‎lib/sw_services/xilasu/doc/html/api/bc_s.png‎

676 Bytes
Loading

‎lib/sw_services/xilasu/doc/html/api/bdwn.png‎

147 Bytes
Loading

0 commit comments

Comments
 (0)