URL
https://opencores.org/ocsvn/avs_aes/avs_aes/trunk
Subversion Repositories avs_aes
[/] [avs_aes/] [trunk/] [doc/] [sw/] [html/] [avs__aes_8h_source.html] - Rev 21
Compare with Previous | Blame | View Log
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>AES Avalon Slave (avs_aes): avs_aes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">AES Avalon Slave (avs_aes)
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('avs__aes_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">avs_aes.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="avs__aes_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * \file avs_aes.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * \brief header file for AES Avalon IP Core software driver</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * offers interfaces to convinient access to the core</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * This file is part of the project avs_aes</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * see: http://opencores.org/project,avs_aes</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * \section AUTHORS</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Thomas Ruschival -- ruschi@opencores.org (www.ruschival.de)</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * \section LICENSE</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * Copyright (c) 2009, Authors and opencores.org</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without modification,</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * are permitted provided that the following conditions are met:</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * * Redistributions of source code must retain the above copyright notice,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * * Redistributions in binary form must reproduce the above copyright notice,</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * this list of conditions and the following disclaimer in the documentation</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * * Neither the name of the organization nor the names of its contributors</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * may be used to endorse or promote products derived from this software without</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * specific prior written permission.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * THE POSSIBILITY OF SUCH DAMAGE</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#ifndef AVS_AES_H_</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="preprocessor">#define AVS_AES_H_</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * \section Configuration</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * Configuration items for the Avalon Slave component </span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * change them or define them elsewhere</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#ifndef KEYWORDS</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span><span class="comment">/** </span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * Keylength 256 Bit AES </span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="avs__aes_8h.html#a40ac9fbe108b0ea74f57215528f13196"> 52</a></span> <span class="preprocessor">#define KEYWORDS 8</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* KEYWORDS */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#ifndef AES_BASEADDR</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span><span class="comment">/**</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * base address of the Avalon Slave component in memory map </span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="avs__aes_8h.html#aa93e16f5419a2515d4ebbd5368e9a8c5"> 59</a></span> <span class="preprocessor">#define AES_BASEADDR 0x40000 </span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* AES_BASEADDR */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * \addtogroup control-register</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * Bits in Control Register </span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * \see{avs_aes_handle::control} </span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * \{</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"></span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/** Signal load of new key valid \see{avs_aes_handle::control} */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="group__control-register.html#gaf27449032ce353aa329edd80cd2759a5"> 70</a></span> <span class="preprocessor">#define KEY_VALID (1 << 7)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"></span><span class="comment">/** Enable interrupt bit \see{avs_aes_handle::control} */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="group__control-register.html#gab062bac21e942042e0e9a0b5c8bc6c04"> 72</a></span> <span class="preprocessor">#define IRQ_ENA (1 << 6)</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor"></span><span class="comment">/** Start decryption bit \see{avs_aes_handle::control} */</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="code" href="group__control-register.html#ga36fab47015485191712a579a059a7c20"> 74</a></span> <span class="preprocessor">#define DECRYPT (1 << 1)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span><span class="comment">/** start encryption bit \see{avs_aes_handle::control} */</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="group__control-register.html#ga1cb0c60ca582db30ae87362ca43e8c19"> 76</a></span> <span class="preprocessor">#define ENCRYPT (1 << 0)</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment">/** \} */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * \brief object storing addresses for this Avalon AES slave </span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * might be useful in case there are more attached, also for convinience</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="code" href="structavs__aes__handle.html"> 84</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{<span class="comment"></span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * \brief pointer to key field in memory mapping</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="structavs__aes__handle.html#acb9eb474c8310afe4b082b79914f274c"> 88</a></span>  <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* <a class="code" href="structavs__aes__handle.html#acb9eb474c8310afe4b082b79914f274c" title="pointer to key field in memory mapping ">key</a>;<span class="comment"></span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * \brief pointer to data field in memory mapping</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * used for both decryption and encryption</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="structavs__aes__handle.html#adae23dc33b7dec54b9da34f347256214"> 93</a></span>  <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* <a class="code" href="structavs__aes__handle.html#adae23dc33b7dec54b9da34f347256214" title="pointer to data field in memory mapping used for both decryption and encryption ">payload</a>;<span class="comment"></span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * \brief pointer to result field in memory mapping</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="structavs__aes__handle.html#ae0ad9e7bde68d07c018a299a0cda66af"> 97</a></span>  <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* <a class="code" href="structavs__aes__handle.html#ae0ad9e7bde68d07c018a299a0cda66af" title="pointer to result field in memory mapping ">result</a>;<span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> /**</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * \brief pointer to control word</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9"> 101</a></span>  <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* <a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word ">control</a>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> } <a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"></span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * \section functions </span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"></span></div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * \brief setup the context to be used later.</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * initializes the pointers to the correct memory locations</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * \param context : struct grouping address information </span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#a962dd946798faab0e83d401c7d43c33c" title="setup the context to be used later. ">avs_aes_init</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context);</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * \brief Set a new key</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * This call asserts the KEY_VALID flag and triggers the key-expansion in the core</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * \param key user key to load</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#af18edc2beecc3842a131423f55c7636a" title="Set a new key This call asserts the KEY_VALID flag and triggers the key-expansion in the core...">avs_aes_setKey</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* key);</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * \brief loads payload for processing to the core</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * basically memcopy...</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * \param payload user data to be processed</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#a22f9afae76f645e31b514b5aa4df2cc1" title="loads payload for processing to the core basically memcopy... ">avs_aes_setPayload</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* payload);</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"></span></div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * \brief set the KEY_VALID flag in the control word</span></div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * used to signal the completion of writing the key ( \ref avs_aes_setKey )</span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#a55f078baaf019797ab6de7ea1a02475f" title="set the KEY_VALID flag in the control word used to signal the completion of writing the key ( avs_aes...">avs_aes_setKeyvalid</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"></span></div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * \brief set the ENCRYPT flag in the control word</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * start encryption of (hopefully) previously loaded payload </span></div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#acea23b2ab998f18b9aca810765632cac" title="set the ENCRYPT flag in the control word start encryption of (hopefully) previously loaded payload ...">avs_aes_encrypt</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context);</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"></span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * \brief set the DECRYPT flag in the control word</span></div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * start encryption of (hopefully) previously loaded payload </span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#aef16b7ecbb1b091934a9c670ce3b2fcf" title="set the DECRYPT flag in the control word start encryption of (hopefully) previously loaded payload ...">avs_aes_decrypt</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context);</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"></span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/**</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * \brief checks the COMPLETED flag</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * can be used for ugly polling the slave if IRQs are not used</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * \param context struct grouping address information </span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * \return 1 if still computing 0 if done.</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="keywordtype">int</span> <a class="code" href="avs__aes_8c.html#a827a78f73dd8fef9d2c9e72ad9bb4ea9" title="checks the COMPLETED flag can be used for ugly polling the slave if IRQs are not used ...">avs_aes_isBusy</a>(<a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there are more attached...">avs_aes_handle</a>* context);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#endif </span><span class="comment">/*AVS_AES_H_*/</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="avs__aes_8h.html">avs_aes.h</a></li>
<li class="footer">Generated on Sat Apr 19 2014 17:55:55 for AES Avalon Slave (avs_aes) by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
</ul>
</div>
</body>
</html>