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 15
Go to most recent revision | 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"/>
<title>AES Avalon Slave (avs_aes): avs_aes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>avs_aes.h</h1><a href="avs__aes_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span>
<a name="l00002"></a>00002 <span class="comment">* \file avs_aes.h</span>
<a name="l00003"></a>00003 <span class="comment">* \brief header file for AES Avalon IP Core software driver </span>
<a name="l00004"></a>00004 <span class="comment">* offers interfaces to convinient access to the core</span>
<a name="l00005"></a>00005 <span class="comment">*</span>
<a name="l00006"></a>00006 <span class="comment">* This file is part of the project avs_aes</span>
<a name="l00007"></a>00007 <span class="comment">* see: http://opencores.org/project,avs_aes</span>
<a name="l00008"></a>00008 <span class="comment">* </span>
<a name="l00009"></a>00009 <span class="comment">* </span>
<a name="l00010"></a>00010 <span class="comment">* \section AUTHORS</span>
<a name="l00011"></a>00011 <span class="comment">* Thomas Ruschival -- ruschi@opencores.org (www.ruschival.de)</span>
<a name="l00012"></a>00012 <span class="comment">* </span>
<a name="l00013"></a>00013 <span class="comment">* \section LICENSE</span>
<a name="l00014"></a>00014 <span class="comment">* Copyright (c) 2009, Authors and opencores.org</span>
<a name="l00015"></a>00015 <span class="comment">* All rights reserved.</span>
<a name="l00016"></a>00016 <span class="comment">* </span>
<a name="l00017"></a>00017 <span class="comment">* Redistribution and use in source and binary forms, with or without modification,</span>
<a name="l00018"></a>00018 <span class="comment">* are permitted provided that the following conditions are met:</span>
<a name="l00019"></a>00019 <span class="comment">* * Redistributions of source code must retain the above copyright notice,</span>
<a name="l00020"></a>00020 <span class="comment">* this list of conditions and the following disclaimer.</span>
<a name="l00021"></a>00021 <span class="comment">* * Redistributions in binary form must reproduce the above copyright notice,</span>
<a name="l00022"></a>00022 <span class="comment">* this list of conditions and the following disclaimer in the documentation</span>
<a name="l00023"></a>00023 <span class="comment">* and/or other materials provided with the distribution.</span>
<a name="l00024"></a>00024 <span class="comment">* * Neither the name of the organization nor the names of its contributors</span>
<a name="l00025"></a>00025 <span class="comment">* may be used to endorse or promote products derived from this software without</span>
<a name="l00026"></a>00026 <span class="comment">* specific prior written permission.</span>
<a name="l00027"></a>00027 <span class="comment">* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span>
<a name="l00028"></a>00028 <span class="comment">* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span>
<a name="l00029"></a>00029 <span class="comment">* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span>
<a name="l00030"></a>00030 <span class="comment">* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE</span>
<a name="l00031"></a>00031 <span class="comment">* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,</span>
<a name="l00032"></a>00032 <span class="comment">* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</span>
<a name="l00033"></a>00033 <span class="comment">* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span>
<a name="l00034"></a>00034 <span class="comment">* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</span>
<a name="l00035"></a>00035 <span class="comment">* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</span>
<a name="l00036"></a>00036 <span class="comment">* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF</span>
<a name="l00037"></a>00037 <span class="comment">* THE POSSIBILITY OF SUCH DAMAGE</span>
<a name="l00038"></a>00038 <span class="comment">*/</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#ifndef AVS_AES_H_</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define AVS_AES_H_</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">/**</span>
<a name="l00045"></a>00045 <span class="comment"> * \section Configuration</span>
<a name="l00046"></a>00046 <span class="comment"> * Configuration items for the Avalon Slave component </span>
<a name="l00047"></a>00047 <span class="comment"> * change them or define them elsewhere</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a>00049 <span class="preprocessor">#ifndef KEYWORDS</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="comment">/** </span>
<a name="l00051"></a>00051 <span class="comment"> * Keylength 256 Bit AES </span>
<a name="l00052"></a>00052 <span class="comment">*/</span>
<a name="l00053"></a><a class="code" href="avs__aes_8h.html#a40ac9fbe108b0ea74f57215528f13196">00053</a> <span class="preprocessor">#define KEYWORDS 8</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* KEYWORDS */</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="preprocessor">#ifndef AES_BASEADDR</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span><span class="comment">/** </span>
<a name="l00058"></a>00058 <span class="comment"> * base address of the Avalon Slave component in memory map </span>
<a name="l00059"></a>00059 <span class="comment">*/</span>
<a name="l00060"></a><a class="code" href="avs__aes_8h.html#aa93e16f5419a2515d4ebbd5368e9a8c5">00060</a> <span class="preprocessor">#define AES_BASEADDR 0x40000 </span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* AES_BASEADDR */</span>
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment"></span>
<a name="l00064"></a>00064 <span class="comment">/**</span>
<a name="l00065"></a>00065 <span class="comment"> * \section Constants</span>
<a name="l00066"></a>00066 <span class="comment"> * Constants no need to change them!</span>
<a name="l00067"></a>00067 <span class="comment"> */</span><span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">/** memory offset for key DON'T CHANGE! */</span>
<a name="l00069"></a><a class="code" href="avs__aes_8h.html#ac237029d30090de9c406fd8cf6f9df37">00069</a> <span class="preprocessor">#define KEY_ADDR AES_BASEADDR+0x00</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="comment">/** memory offset of payload DON'T CHANGE!*/</span>
<a name="l00071"></a><a class="code" href="avs__aes_8h.html#a622ef33a8b85e8a7558ce42e9fc73870">00071</a> <span class="preprocessor">#define DATA_ADDR AES_BASEADDR+0x08</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="comment">/** memory offset of result DON'T CHANGE! */</span>
<a name="l00073"></a><a class="code" href="avs__aes_8h.html#add31e6954a8ef1d40c63409f686135b9">00073</a> <span class="preprocessor">#define RESULT_ADDR AES_BASEADDR+0x10</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment">/** memory offset for control word DON'T CHANGE! */</span>
<a name="l00075"></a><a class="code" href="avs__aes_8h.html#a939a4e25c6ce6c1224b8d923038f6639">00075</a> <span class="preprocessor">#define AESCTRLWD AES_BASEADDR+0x18 </span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment">/**</span>
<a name="l00078"></a>00078 <span class="comment"> * \brief object storing addresses for this Avalon AES slave </span>
<a name="l00079"></a>00079 <span class="comment"> * might be useful in case there are more attached, also for convinience</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a><a class="code" href="structavs__aes__handle.html">00081</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>{<span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** </span>
<a name="l00083"></a>00083 <span class="comment"> * \brief pointer "KEY" field in memory mapping </span>
<a name="l00084"></a>00084 <span class="comment"> */</span>
<a name="l00085"></a><a class="code" href="structavs__aes__handle.html#acb9eb474c8310afe4b082b79914f274c">00085</a> <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* key;<span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** </span>
<a name="l00087"></a>00087 <span class="comment"> * \brief pointer "data" field in memory mapping</span>
<a name="l00088"></a>00088 <span class="comment"> * used for both decryption and encryption </span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a><a class="code" href="structavs__aes__handle.html#adae23dc33b7dec54b9da34f347256214">00090</a> <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* payload;<span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment"> /** </span>
<a name="l00092"></a>00092 <span class="comment"> * \brief pointer "RESULT" field in memory mapping </span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a><a class="code" href="structavs__aes__handle.html#ae0ad9e7bde68d07c018a299a0cda66af">00094</a> <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* result;<span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment"> /** </span>
<a name="l00096"></a>00096 <span class="comment"> * \brief pointer to control word </span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9">00098</a> <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* control;
<a name="l00099"></a>00099 } <a class="code" href="structavs__aes__handle.html" title="object storing addresses for this Avalon AES slave might be useful in case there...">avs_aes_handle</a>;
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment">/**</span>
<a name="l00102"></a>00102 <span class="comment"> * \section functions </span>
<a name="l00103"></a>00103 <span class="comment"> **/</span>
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment">/**</span>
<a name="l00107"></a>00107 <span class="comment"> * \brief setup the context to be used later.</span>
<a name="l00108"></a>00108 <span class="comment"> * initializes the pointers to the correct memory locations</span>
<a name="l00109"></a>00109 <span class="comment"> * \param context : struct grouping address information </span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 <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...">avs_aes_handle</a>* context);
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">/**</span>
<a name="l00114"></a>00114 <span class="comment"> * \brief setup the context to be used later.</span>
<a name="l00115"></a>00115 <span class="comment"> * initializes the pointers to the correct memory locations</span>
<a name="l00116"></a>00116 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00117"></a>00117 <span class="comment"> * \param key user key to load</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 <span class="keywordtype">void</span> <a class="code" href="avs__aes_8c.html#af18edc2beecc3842a131423f55c7636a" title="setup the context to be used later.">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...">avs_aes_handle</a>* context, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* key);
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">/**</span>
<a name="l00122"></a>00122 <span class="comment"> * \brief loads payload for processing to the core</span>
<a name="l00123"></a>00123 <span class="comment"> * basically memcopy...</span>
<a name="l00124"></a>00124 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00125"></a>00125 <span class="comment"> * \param payload user data to be processed</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 <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...">avs_aes_handle</a>* context, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* payload);
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/**</span>
<a name="l00130"></a>00130 <span class="comment"> * \brief set the KEY_VALID flag in the control word</span>
<a name="l00131"></a>00131 <span class="comment"> * used to signal the completion of writing the key ( \ref avs_aes_setKey )</span>
<a name="l00132"></a>00132 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 <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...">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...">avs_aes_handle</a>* context);
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment">/**</span>
<a name="l00137"></a>00137 <span class="comment"> * \brief set the ENCRYPT flag in the control word</span>
<a name="l00138"></a>00138 <span class="comment"> * start encryption of (hopefully) previously loaded payload </span>
<a name="l00139"></a>00139 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 <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...">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...">avs_aes_handle</a>* context);
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">/**</span>
<a name="l00144"></a>00144 <span class="comment"> * \brief set the DECRYPT flag in the control word</span>
<a name="l00145"></a>00145 <span class="comment"> * start encryption of (hopefully) previously loaded payload </span>
<a name="l00146"></a>00146 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <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...">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...">avs_aes_handle</a>* context);
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">/**</span>
<a name="l00151"></a>00151 <span class="comment"> * \brief checks the COMPLETED flag</span>
<a name="l00152"></a>00152 <span class="comment"> * can be used for ugly polling the slave if IRQs are not used</span>
<a name="l00153"></a>00153 <span class="comment"> * \param context struct grouping address information </span>
<a name="l00154"></a>00154 <span class="comment"> * \return 1 if still computing 0 if done.</span>
<a name="l00155"></a>00155 <span class="comment"> */</span>
<a name="l00156"></a>00156 <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...">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...">avs_aes_handle</a>* context);
<a name="l00157"></a>00157
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="preprocessor">#endif </span><span class="comment">/*AVS_AES_H_*/</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Apr 2 23:22:36 2010 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.6.1 </small></address>
</body>
</html>
Go to most recent revision | Compare with Previous | Blame | View Log