| 1 |
11 |
ruschi |
<!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 |
|
|
<title>AES Avalon Slave (avs_aes): avs_aes.h File Reference</title>
|
| 6 |
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
| 7 |
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
| 8 |
|
|
</head>
|
| 9 |
|
|
<body>
|
| 10 |
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
| 11 |
|
|
<script type="text/javascript">
|
| 12 |
|
|
<!--
|
| 13 |
|
|
function changeDisplayState (e){
|
| 14 |
|
|
var num=this.id.replace(/[^[0-9]/g,'');
|
| 15 |
|
|
var button=this.firstChild;
|
| 16 |
|
|
var sectionDiv=document.getElementById('dynsection'+num);
|
| 17 |
|
|
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
|
| 18 |
|
|
sectionDiv.style.display='block';
|
| 19 |
|
|
button.src='open.gif';
|
| 20 |
|
|
}else{
|
| 21 |
|
|
sectionDiv.style.display='none';
|
| 22 |
|
|
button.src='closed.gif';
|
| 23 |
|
|
}
|
| 24 |
|
|
}
|
| 25 |
|
|
function initDynSections(){
|
| 26 |
|
|
var divs=document.getElementsByTagName('div');
|
| 27 |
|
|
var sectionCounter=1;
|
| 28 |
|
|
for(var i=0;i<divs.length-1;i++){
|
| 29 |
|
|
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
|
| 30 |
|
|
var header=divs[i];
|
| 31 |
|
|
var section=divs[i+1];
|
| 32 |
|
|
var button=header.firstChild;
|
| 33 |
|
|
if (button!='IMG'){
|
| 34 |
|
|
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
|
| 35 |
|
|
button=document.createElement('img');
|
| 36 |
|
|
divs[i].insertBefore(button,divs[i].firstChild);
|
| 37 |
|
|
}
|
| 38 |
|
|
header.style.cursor='pointer';
|
| 39 |
|
|
header.onclick=changeDisplayState;
|
| 40 |
|
|
header.id='dynheader'+sectionCounter;
|
| 41 |
|
|
button.src='closed.gif';
|
| 42 |
|
|
section.id='dynsection'+sectionCounter;
|
| 43 |
|
|
section.style.display='none';
|
| 44 |
|
|
section.style.marginLeft='14px';
|
| 45 |
|
|
sectionCounter++;
|
| 46 |
|
|
}
|
| 47 |
|
|
}
|
| 48 |
|
|
}
|
| 49 |
|
|
window.onload = initDynSections;
|
| 50 |
|
|
-->
|
| 51 |
|
|
</script>
|
| 52 |
|
|
<div class="navigation" id="top">
|
| 53 |
|
|
<div class="tabs">
|
| 54 |
|
|
<ul>
|
| 55 |
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
| 56 |
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
| 57 |
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
| 58 |
|
|
</ul>
|
| 59 |
|
|
</div>
|
| 60 |
|
|
<div class="tabs">
|
| 61 |
|
|
<ul>
|
| 62 |
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
| 63 |
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
| 64 |
|
|
</ul>
|
| 65 |
|
|
</div>
|
| 66 |
|
|
</div>
|
| 67 |
|
|
<div class="contents">
|
| 68 |
|
|
<h1>avs_aes.h File Reference</h1>
|
| 69 |
|
|
<p>header file for AES Avalon IP Core software driver offers interfaces to convinient access to the core
|
| 70 |
|
|
<a href="#_details">More...</a></p>
|
| 71 |
|
|
<div class="dynheader">
|
| 72 |
|
|
This graph shows which files directly or indirectly include this file:</div>
|
| 73 |
|
|
<div class="dynsection">
|
| 74 |
|
|
<div class="center"><img src="avs__aes_8h__dep__incl.png" border="0" usemap="#avs__aes_8hdep_map" alt=""/></div>
|
| 75 |
|
|
<map name="avs__aes_8hdep_map" id="avs__aes_8hdep">
|
| 76 |
|
|
<area shape="rect" href="AEStester_8c.html" title="test program and example of how to use the software" alt="" coords="5,83,96,112"/><area shape="rect" href="avs__aes_8c.html" title="AES Avalon IP Core software driver." alt="" coords="120,83,200,112"/></map>
|
| 77 |
|
|
</div>
|
| 78 |
|
|
|
| 79 |
|
|
<p><a href="avs__aes_8h_source.html">Go to the source code of this file.</a></p>
|
| 80 |
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
| 81 |
|
|
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
|
| 82 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a></td></tr>
|
| 83 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">object storing addresses for this Avalon AES slave might be useful in case there are more attached, also for convinience <a href="structavs__aes__handle.html#_details">More...</a><br/></td></tr>
|
| 84 |
|
|
<tr><td colspan="2"><h2>Defines</h2></td></tr>
|
| 85 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a40ac9fbe108b0ea74f57215528f13196">KEYWORDS</a> 8</td></tr>
|
| 86 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keylength 256 Bit AES. <a href="#a40ac9fbe108b0ea74f57215528f13196"></a><br/></td></tr>
|
| 87 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#aa93e16f5419a2515d4ebbd5368e9a8c5">AES_BASEADDR</a> 0x40000</td></tr>
|
| 88 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">base address of the Avalon Slave component in memory map <a href="#aa93e16f5419a2515d4ebbd5368e9a8c5"></a><br/></td></tr>
|
| 89 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#ac237029d30090de9c406fd8cf6f9df37">KEY_ADDR</a> AES_BASEADDR+0x00</td></tr>
|
| 90 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">memory offset for key DON'T CHANGE! <a href="#ac237029d30090de9c406fd8cf6f9df37"></a><br/></td></tr>
|
| 91 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a622ef33a8b85e8a7558ce42e9fc73870">DATA_ADDR</a> AES_BASEADDR+0x08</td></tr>
|
| 92 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">memory offset of payload DON'T CHANGE! <a href="#a622ef33a8b85e8a7558ce42e9fc73870"></a><br/></td></tr>
|
| 93 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#add31e6954a8ef1d40c63409f686135b9">RESULT_ADDR</a> AES_BASEADDR+0x10</td></tr>
|
| 94 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">memory offset of result DON'T CHANGE! <a href="#add31e6954a8ef1d40c63409f686135b9"></a><br/></td></tr>
|
| 95 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a939a4e25c6ce6c1224b8d923038f6639">AESCTRLWD</a> AES_BASEADDR+0x18</td></tr>
|
| 96 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">memory offset for control word DON'T CHANGE! <a href="#a939a4e25c6ce6c1224b8d923038f6639"></a><br/></td></tr>
|
| 97 |
|
|
<tr><td colspan="2"><h2>Functions</h2></td></tr>
|
| 98 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a962dd946798faab0e83d401c7d43c33c">avs_aes_init</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context)</td></tr>
|
| 99 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">setup the context to be used later. <a href="#a962dd946798faab0e83d401c7d43c33c"></a><br/></td></tr>
|
| 100 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#af18edc2beecc3842a131423f55c7636a">avs_aes_setKey</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context, unsigned int *key)</td></tr>
|
| 101 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">setup the context to be used later. <a href="#af18edc2beecc3842a131423f55c7636a"></a><br/></td></tr>
|
| 102 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a22f9afae76f645e31b514b5aa4df2cc1">avs_aes_setPayload</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context, unsigned int *payload)</td></tr>
|
| 103 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">loads payload for processing to the core basically memcopy. <a href="#a22f9afae76f645e31b514b5aa4df2cc1"></a><br/></td></tr>
|
| 104 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a55f078baaf019797ab6de7ea1a02475f">avs_aes_setKeyvalid</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context)</td></tr>
|
| 105 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the KEY_VALID flag in the control word used to signal the completion of writing the key ( <a class="el" href="avs__aes_8h.html#af18edc2beecc3842a131423f55c7636a">avs_aes_setKey</a> ) <a href="#a55f078baaf019797ab6de7ea1a02475f"></a><br/></td></tr>
|
| 106 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#acea23b2ab998f18b9aca810765632cac">avs_aes_encrypt</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context)</td></tr>
|
| 107 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the ENCRYPT flag in the control word start encryption of (hopefully) previously loaded payload <a href="#acea23b2ab998f18b9aca810765632cac"></a><br/></td></tr>
|
| 108 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#aef16b7ecbb1b091934a9c670ce3b2fcf">avs_aes_decrypt</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context)</td></tr>
|
| 109 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the DECRYPT flag in the control word start encryption of (hopefully) previously loaded payload <a href="#aef16b7ecbb1b091934a9c670ce3b2fcf"></a><br/></td></tr>
|
| 110 |
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="avs__aes_8h.html#a827a78f73dd8fef9d2c9e72ad9bb4ea9">avs_aes_isBusy</a> (<a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> *context)</td></tr>
|
| 111 |
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">checks the COMPLETED flag can be used for ugly polling the slave if IRQs are not used <a href="#a827a78f73dd8fef9d2c9e72ad9bb4ea9"></a><br/></td></tr>
|
| 112 |
|
|
</table>
|
| 113 |
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
| 114 |
|
|
<p>header file for AES Avalon IP Core software driver offers interfaces to convinient access to the core </p>
|
| 115 |
|
|
<p>This file is part of the project avs_aes see: <a href="http://opencores.org/project,avs_aes">http://opencores.org/project,avs_aes</a></p>
|
| 116 |
|
|
<h2><a class="anchor" id="AUTHORS">
|
| 117 |
|
|
AUTHORS</a></h2>
|
| 118 |
|
|
<p>Thomas Ruschival -- <a href="mailto:ruschi@opencores.org">ruschi@opencores.org</a> (www.ruschival.de)</p>
|
| 119 |
|
|
<h2><a class="anchor" id="LICENSE">
|
| 120 |
|
|
LICENSE</a></h2>
|
| 121 |
|
|
<p>Copyright (c) 2009, Authors and opencores.org All rights reserved.</p>
|
| 122 |
|
|
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE </p>
|
| 123 |
|
|
|
| 124 |
|
|
<p>Definition in file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 125 |
|
|
<hr/><h2>Define Documentation</h2>
|
| 126 |
|
|
<a class="anchor" id="aa93e16f5419a2515d4ebbd5368e9a8c5"></a><!-- doxytag: member="avs_aes.h::AES_BASEADDR" ref="aa93e16f5419a2515d4ebbd5368e9a8c5" args="" -->
|
| 127 |
|
|
<div class="memitem">
|
| 128 |
|
|
<div class="memproto">
|
| 129 |
|
|
<table class="memname">
|
| 130 |
|
|
<tr>
|
| 131 |
|
|
<td class="memname">#define AES_BASEADDR 0x40000</td>
|
| 132 |
|
|
</tr>
|
| 133 |
|
|
</table>
|
| 134 |
|
|
</div>
|
| 135 |
|
|
<div class="memdoc">
|
| 136 |
|
|
|
| 137 |
|
|
<p>base address of the Avalon Slave component in memory map </p>
|
| 138 |
|
|
|
| 139 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00060">60</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 140 |
|
|
|
| 141 |
|
|
</div>
|
| 142 |
|
|
</div>
|
| 143 |
|
|
<a class="anchor" id="a939a4e25c6ce6c1224b8d923038f6639"></a><!-- doxytag: member="avs_aes.h::AESCTRLWD" ref="a939a4e25c6ce6c1224b8d923038f6639" args="" -->
|
| 144 |
|
|
<div class="memitem">
|
| 145 |
|
|
<div class="memproto">
|
| 146 |
|
|
<table class="memname">
|
| 147 |
|
|
<tr>
|
| 148 |
|
|
<td class="memname">#define AESCTRLWD AES_BASEADDR+0x18</td>
|
| 149 |
|
|
</tr>
|
| 150 |
|
|
</table>
|
| 151 |
|
|
</div>
|
| 152 |
|
|
<div class="memdoc">
|
| 153 |
|
|
|
| 154 |
|
|
<p>memory offset for control word DON'T CHANGE! </p>
|
| 155 |
|
|
|
| 156 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00075">75</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 157 |
|
|
|
| 158 |
|
|
</div>
|
| 159 |
|
|
</div>
|
| 160 |
|
|
<a class="anchor" id="a622ef33a8b85e8a7558ce42e9fc73870"></a><!-- doxytag: member="avs_aes.h::DATA_ADDR" ref="a622ef33a8b85e8a7558ce42e9fc73870" args="" -->
|
| 161 |
|
|
<div class="memitem">
|
| 162 |
|
|
<div class="memproto">
|
| 163 |
|
|
<table class="memname">
|
| 164 |
|
|
<tr>
|
| 165 |
|
|
<td class="memname">#define DATA_ADDR AES_BASEADDR+0x08</td>
|
| 166 |
|
|
</tr>
|
| 167 |
|
|
</table>
|
| 168 |
|
|
</div>
|
| 169 |
|
|
<div class="memdoc">
|
| 170 |
|
|
|
| 171 |
|
|
<p>memory offset of payload DON'T CHANGE! </p>
|
| 172 |
|
|
|
| 173 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00071">71</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 174 |
|
|
|
| 175 |
|
|
</div>
|
| 176 |
|
|
</div>
|
| 177 |
|
|
<a class="anchor" id="ac237029d30090de9c406fd8cf6f9df37"></a><!-- doxytag: member="avs_aes.h::KEY_ADDR" ref="ac237029d30090de9c406fd8cf6f9df37" args="" -->
|
| 178 |
|
|
<div class="memitem">
|
| 179 |
|
|
<div class="memproto">
|
| 180 |
|
|
<table class="memname">
|
| 181 |
|
|
<tr>
|
| 182 |
|
|
<td class="memname">#define KEY_ADDR AES_BASEADDR+0x00</td>
|
| 183 |
|
|
</tr>
|
| 184 |
|
|
</table>
|
| 185 |
|
|
</div>
|
| 186 |
|
|
<div class="memdoc">
|
| 187 |
|
|
|
| 188 |
|
|
<p>memory offset for key DON'T CHANGE! </p>
|
| 189 |
|
|
<h2><a class="anchor" id="Constants">
|
| 190 |
|
|
Constants</a></h2>
|
| 191 |
|
|
<p>Constants no need to change them! </p>
|
| 192 |
|
|
|
| 193 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00069">69</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 194 |
|
|
|
| 195 |
|
|
</div>
|
| 196 |
|
|
</div>
|
| 197 |
|
|
<a class="anchor" id="a40ac9fbe108b0ea74f57215528f13196"></a><!-- doxytag: member="avs_aes.h::KEYWORDS" ref="a40ac9fbe108b0ea74f57215528f13196" args="" -->
|
| 198 |
|
|
<div class="memitem">
|
| 199 |
|
|
<div class="memproto">
|
| 200 |
|
|
<table class="memname">
|
| 201 |
|
|
<tr>
|
| 202 |
|
|
<td class="memname">#define KEYWORDS 8</td>
|
| 203 |
|
|
</tr>
|
| 204 |
|
|
</table>
|
| 205 |
|
|
</div>
|
| 206 |
|
|
<div class="memdoc">
|
| 207 |
|
|
|
| 208 |
|
|
<p>Keylength 256 Bit AES. </p>
|
| 209 |
|
|
<h2><a class="anchor" id="Configuration">
|
| 210 |
|
|
Configuration</a></h2>
|
| 211 |
|
|
<p>Configuration items for the Avalon Slave component change them or define them elsewhere </p>
|
| 212 |
|
|
|
| 213 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00053">53</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 214 |
|
|
|
| 215 |
|
|
</div>
|
| 216 |
|
|
</div>
|
| 217 |
|
|
<a class="anchor" id="add31e6954a8ef1d40c63409f686135b9"></a><!-- doxytag: member="avs_aes.h::RESULT_ADDR" ref="add31e6954a8ef1d40c63409f686135b9" args="" -->
|
| 218 |
|
|
<div class="memitem">
|
| 219 |
|
|
<div class="memproto">
|
| 220 |
|
|
<table class="memname">
|
| 221 |
|
|
<tr>
|
| 222 |
|
|
<td class="memname">#define RESULT_ADDR AES_BASEADDR+0x10</td>
|
| 223 |
|
|
</tr>
|
| 224 |
|
|
</table>
|
| 225 |
|
|
</div>
|
| 226 |
|
|
<div class="memdoc">
|
| 227 |
|
|
|
| 228 |
|
|
<p>memory offset of result DON'T CHANGE! </p>
|
| 229 |
|
|
|
| 230 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8h_source.html#l00073">73</a> of file <a class="el" href="avs__aes_8h_source.html">avs_aes.h</a>.</p>
|
| 231 |
|
|
|
| 232 |
|
|
</div>
|
| 233 |
|
|
</div>
|
| 234 |
|
|
<hr/><h2>Function Documentation</h2>
|
| 235 |
|
|
<a class="anchor" id="aef16b7ecbb1b091934a9c670ce3b2fcf"></a><!-- doxytag: member="avs_aes.h::avs_aes_decrypt" ref="aef16b7ecbb1b091934a9c670ce3b2fcf" args="(avs_aes_handle *context)" -->
|
| 236 |
|
|
<div class="memitem">
|
| 237 |
|
|
<div class="memproto">
|
| 238 |
|
|
<table class="memname">
|
| 239 |
|
|
<tr>
|
| 240 |
|
|
<td class="memname">void avs_aes_decrypt </td>
|
| 241 |
|
|
<td>(</td>
|
| 242 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 243 |
|
|
<td class="paramname"> <em>context</em></td>
|
| 244 |
|
|
<td> ) </td>
|
| 245 |
|
|
<td></td>
|
| 246 |
|
|
</tr>
|
| 247 |
|
|
</table>
|
| 248 |
|
|
</div>
|
| 249 |
|
|
<div class="memdoc">
|
| 250 |
|
|
|
| 251 |
|
|
<p>set the DECRYPT flag in the control word start encryption of (hopefully) previously loaded payload </p>
|
| 252 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 253 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 254 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 255 |
|
|
</table>
|
| 256 |
|
|
</dd>
|
| 257 |
|
|
</dl>
|
| 258 |
|
|
|
| 259 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00115">115</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 260 |
|
|
|
| 261 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00115"></a>00115 {
|
| 262 |
|
|
<a name="l00116"></a>00116 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) |= 0x00000002;
|
| 263 |
|
|
<a name="l00117"></a>00117 }
|
| 264 |
|
|
</pre></div></p>
|
| 265 |
|
|
|
| 266 |
|
|
</div>
|
| 267 |
|
|
</div>
|
| 268 |
|
|
<a class="anchor" id="acea23b2ab998f18b9aca810765632cac"></a><!-- doxytag: member="avs_aes.h::avs_aes_encrypt" ref="acea23b2ab998f18b9aca810765632cac" args="(avs_aes_handle *context)" -->
|
| 269 |
|
|
<div class="memitem">
|
| 270 |
|
|
<div class="memproto">
|
| 271 |
|
|
<table class="memname">
|
| 272 |
|
|
<tr>
|
| 273 |
|
|
<td class="memname">void avs_aes_encrypt </td>
|
| 274 |
|
|
<td>(</td>
|
| 275 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 276 |
|
|
<td class="paramname"> <em>context</em></td>
|
| 277 |
|
|
<td> ) </td>
|
| 278 |
|
|
<td></td>
|
| 279 |
|
|
</tr>
|
| 280 |
|
|
</table>
|
| 281 |
|
|
</div>
|
| 282 |
|
|
<div class="memdoc">
|
| 283 |
|
|
|
| 284 |
|
|
<p>set the ENCRYPT flag in the control word start encryption of (hopefully) previously loaded payload </p>
|
| 285 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 286 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 287 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 288 |
|
|
</table>
|
| 289 |
|
|
</dd>
|
| 290 |
|
|
</dl>
|
| 291 |
|
|
|
| 292 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00106">106</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 293 |
|
|
|
| 294 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00106"></a>00106 {
|
| 295 |
|
|
<a name="l00107"></a>00107 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) |= 0x00000001;
|
| 296 |
|
|
<a name="l00108"></a>00108 }
|
| 297 |
|
|
</pre></div></p>
|
| 298 |
|
|
|
| 299 |
|
|
</div>
|
| 300 |
|
|
</div>
|
| 301 |
|
|
<a class="anchor" id="a962dd946798faab0e83d401c7d43c33c"></a><!-- doxytag: member="avs_aes.h::avs_aes_init" ref="a962dd946798faab0e83d401c7d43c33c" args="(avs_aes_handle *context)" -->
|
| 302 |
|
|
<div class="memitem">
|
| 303 |
|
|
<div class="memproto">
|
| 304 |
|
|
<table class="memname">
|
| 305 |
|
|
<tr>
|
| 306 |
|
|
<td class="memname">void avs_aes_init </td>
|
| 307 |
|
|
<td>(</td>
|
| 308 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 309 |
|
|
<td class="paramname"> <em>context</em></td>
|
| 310 |
|
|
<td> ) </td>
|
| 311 |
|
|
<td></td>
|
| 312 |
|
|
</tr>
|
| 313 |
|
|
</table>
|
| 314 |
|
|
</div>
|
| 315 |
|
|
<div class="memdoc">
|
| 316 |
|
|
|
| 317 |
|
|
<p>setup the context to be used later. </p>
|
| 318 |
|
|
<h2><a class="anchor" id="functions">
|
| 319 |
|
|
functions</a></h2>
|
| 320 |
|
|
<p>initializes the pointers to the correct memory locations </p>
|
| 321 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 322 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 323 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>: struct grouping address information</td></tr>
|
| 324 |
|
|
</table>
|
| 325 |
|
|
</dd>
|
| 326 |
|
|
</dl>
|
| 327 |
|
|
<p>initializes the pointers to the correct memory locations </p>
|
| 328 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 329 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 330 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>: struct grouping address information </td></tr>
|
| 331 |
|
|
</table>
|
| 332 |
|
|
</dd>
|
| 333 |
|
|
</dl>
|
| 334 |
|
|
|
| 335 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00047">47</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 336 |
|
|
|
| 337 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00047"></a>00047 {
|
| 338 |
|
|
<a name="l00048"></a>00048 context-><a class="code" href="structavs__aes__handle.html#acb9eb474c8310afe4b082b79914f274c" title="pointer &quot;KEY&quot; field in memory mapping">key</a> = (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>*) <a class="code" href="avs__aes_8h.html#ac237029d30090de9c406fd8cf6f9df37" title="memory offset for key DON&#39;T CHANGE!">KEY_ADDR</a>;
|
| 339 |
|
|
<a name="l00049"></a>00049 context-><a class="code" href="structavs__aes__handle.html#adae23dc33b7dec54b9da34f347256214" title="pointer &quot;data&quot; field in memory mapping used for both decryption and encryption...">payload</a>= (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>*) <a class="code" href="avs__aes_8h.html#a622ef33a8b85e8a7558ce42e9fc73870" title="memory offset of payload DON&#39;T CHANGE!">DATA_ADDR</a>;
|
| 340 |
|
|
<a name="l00050"></a>00050 context-><a class="code" href="structavs__aes__handle.html#ae0ad9e7bde68d07c018a299a0cda66af" title="pointer &quot;RESULT&quot; field in memory mapping">result</a> = (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>*) <a class="code" href="avs__aes_8h.html#add31e6954a8ef1d40c63409f686135b9" title="memory offset of result DON&#39;T CHANGE!">RESULT_ADDR</a>;
|
| 341 |
|
|
<a name="l00051"></a>00051 context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a> = (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>*) <a class="code" href="avs__aes_8h.html#a939a4e25c6ce6c1224b8d923038f6639" title="memory offset for control word DON&#39;T CHANGE!">AESCTRLWD</a>;
|
| 342 |
|
|
<a name="l00052"></a>00052 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) = 0x00000000;
|
| 343 |
|
|
<a name="l00053"></a>00053 }
|
| 344 |
|
|
</pre></div></p>
|
| 345 |
|
|
|
| 346 |
|
|
</div>
|
| 347 |
|
|
</div>
|
| 348 |
|
|
<a class="anchor" id="a827a78f73dd8fef9d2c9e72ad9bb4ea9"></a><!-- doxytag: member="avs_aes.h::avs_aes_isBusy" ref="a827a78f73dd8fef9d2c9e72ad9bb4ea9" args="(avs_aes_handle *context)" -->
|
| 349 |
|
|
<div class="memitem">
|
| 350 |
|
|
<div class="memproto">
|
| 351 |
|
|
<table class="memname">
|
| 352 |
|
|
<tr>
|
| 353 |
|
|
<td class="memname">int avs_aes_isBusy </td>
|
| 354 |
|
|
<td>(</td>
|
| 355 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 356 |
|
|
<td class="paramname"> <em>context</em></td>
|
| 357 |
|
|
<td> ) </td>
|
| 358 |
|
|
<td></td>
|
| 359 |
|
|
</tr>
|
| 360 |
|
|
</table>
|
| 361 |
|
|
</div>
|
| 362 |
|
|
<div class="memdoc">
|
| 363 |
|
|
|
| 364 |
|
|
<p>checks the COMPLETED flag can be used for ugly polling the slave if IRQs are not used </p>
|
| 365 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 366 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 367 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 368 |
|
|
</table>
|
| 369 |
|
|
</dd>
|
| 370 |
|
|
</dl>
|
| 371 |
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if still computing 0 if done. </dd></dl>
|
| 372 |
|
|
|
| 373 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00125">125</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 374 |
|
|
|
| 375 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00125"></a>00125 {
|
| 376 |
|
|
<a name="l00126"></a>00126 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> mycontrol = *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>);
|
| 377 |
|
|
<a name="l00127"></a>00127 <span class="keywordflow">return</span> mycontrol & 0x03;
|
| 378 |
|
|
<a name="l00128"></a>00128 }
|
| 379 |
|
|
</pre></div></p>
|
| 380 |
|
|
|
| 381 |
|
|
</div>
|
| 382 |
|
|
</div>
|
| 383 |
|
|
<a class="anchor" id="af18edc2beecc3842a131423f55c7636a"></a><!-- doxytag: member="avs_aes.h::avs_aes_setKey" ref="af18edc2beecc3842a131423f55c7636a" args="(avs_aes_handle *context, unsigned int *key)" -->
|
| 384 |
|
|
<div class="memitem">
|
| 385 |
|
|
<div class="memproto">
|
| 386 |
|
|
<table class="memname">
|
| 387 |
|
|
<tr>
|
| 388 |
|
|
<td class="memname">void avs_aes_setKey </td>
|
| 389 |
|
|
<td>(</td>
|
| 390 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 391 |
|
|
<td class="paramname"> <em>context</em>, </td>
|
| 392 |
|
|
</tr>
|
| 393 |
|
|
<tr>
|
| 394 |
|
|
<td class="paramkey"></td>
|
| 395 |
|
|
<td></td>
|
| 396 |
|
|
<td class="paramtype">unsigned int * </td>
|
| 397 |
|
|
<td class="paramname"> <em>key</em></td><td> </td>
|
| 398 |
|
|
</tr>
|
| 399 |
|
|
<tr>
|
| 400 |
|
|
<td></td>
|
| 401 |
|
|
<td>)</td>
|
| 402 |
|
|
<td></td><td></td><td></td>
|
| 403 |
|
|
</tr>
|
| 404 |
|
|
</table>
|
| 405 |
|
|
</div>
|
| 406 |
|
|
<div class="memdoc">
|
| 407 |
|
|
|
| 408 |
|
|
<p>setup the context to be used later. </p>
|
| 409 |
|
|
<p>initializes the pointers to the correct memory locations </p>
|
| 410 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 411 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 412 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 413 |
|
|
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>user key to load </td></tr>
|
| 414 |
|
|
</table>
|
| 415 |
|
|
</dd>
|
| 416 |
|
|
</dl>
|
| 417 |
|
|
|
| 418 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00062">62</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 419 |
|
|
|
| 420 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00062"></a>00062 {
|
| 421 |
|
|
<a name="l00063"></a>00063 <span class="keywordtype">int</span> i=0;
|
| 422 |
|
|
<a name="l00064"></a>00064 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* target_ptr = (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* )context-><a class="code" href="structavs__aes__handle.html#acb9eb474c8310afe4b082b79914f274c" title="pointer &quot;KEY&quot; field in memory mapping">key</a>;
|
| 423 |
|
|
<a name="l00065"></a>00065 <span class="comment">// Invalidate old key;</span>
|
| 424 |
|
|
<a name="l00066"></a>00066 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) &= (~0x00000080);
|
| 425 |
|
|
<a name="l00067"></a>00067 <span class="keywordflow">for</span>(i=0; i<<a class="code" href="avs__aes_8h.html#a40ac9fbe108b0ea74f57215528f13196" title="Keylength 256 Bit AES.">KEYWORDS</a>; i++){
|
| 426 |
|
|
<a name="l00068"></a>00068 *(target_ptr++) = *(key++);
|
| 427 |
|
|
<a name="l00069"></a>00069 }
|
| 428 |
|
|
<a name="l00070"></a>00070 <span class="comment">// validate key;</span>
|
| 429 |
|
|
<a name="l00071"></a>00071 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) |= 0x00000080;
|
| 430 |
|
|
<a name="l00072"></a>00072 }
|
| 431 |
|
|
</pre></div></p>
|
| 432 |
|
|
|
| 433 |
|
|
</div>
|
| 434 |
|
|
</div>
|
| 435 |
|
|
<a class="anchor" id="a55f078baaf019797ab6de7ea1a02475f"></a><!-- doxytag: member="avs_aes.h::avs_aes_setKeyvalid" ref="a55f078baaf019797ab6de7ea1a02475f" args="(avs_aes_handle *context)" -->
|
| 436 |
|
|
<div class="memitem">
|
| 437 |
|
|
<div class="memproto">
|
| 438 |
|
|
<table class="memname">
|
| 439 |
|
|
<tr>
|
| 440 |
|
|
<td class="memname">void avs_aes_setKeyvalid </td>
|
| 441 |
|
|
<td>(</td>
|
| 442 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 443 |
|
|
<td class="paramname"> <em>context</em></td>
|
| 444 |
|
|
<td> ) </td>
|
| 445 |
|
|
<td></td>
|
| 446 |
|
|
</tr>
|
| 447 |
|
|
</table>
|
| 448 |
|
|
</div>
|
| 449 |
|
|
<div class="memdoc">
|
| 450 |
|
|
|
| 451 |
|
|
<p>set the KEY_VALID flag in the control word used to signal the completion of writing the key ( <a class="el" href="avs__aes_8h.html#af18edc2beecc3842a131423f55c7636a">avs_aes_setKey</a> ) </p>
|
| 452 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 453 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 454 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 455 |
|
|
</table>
|
| 456 |
|
|
</dd>
|
| 457 |
|
|
</dl>
|
| 458 |
|
|
|
| 459 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00096">96</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 460 |
|
|
|
| 461 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00096"></a>00096 {
|
| 462 |
|
|
<a name="l00097"></a>00097 *(context-><a class="code" href="structavs__aes__handle.html#a15143869a0c8bfcacc8e1839e4e789c9" title="pointer to control word">control</a>) |= 0x00000080;
|
| 463 |
|
|
<a name="l00098"></a>00098 }
|
| 464 |
|
|
</pre></div></p>
|
| 465 |
|
|
|
| 466 |
|
|
</div>
|
| 467 |
|
|
</div>
|
| 468 |
|
|
<a class="anchor" id="a22f9afae76f645e31b514b5aa4df2cc1"></a><!-- doxytag: member="avs_aes.h::avs_aes_setPayload" ref="a22f9afae76f645e31b514b5aa4df2cc1" args="(avs_aes_handle *context, unsigned int *payload)" -->
|
| 469 |
|
|
<div class="memitem">
|
| 470 |
|
|
<div class="memproto">
|
| 471 |
|
|
<table class="memname">
|
| 472 |
|
|
<tr>
|
| 473 |
|
|
<td class="memname">void avs_aes_setPayload </td>
|
| 474 |
|
|
<td>(</td>
|
| 475 |
|
|
<td class="paramtype"><a class="el" href="structavs__aes__handle.html">avs_aes_handle</a> * </td>
|
| 476 |
|
|
<td class="paramname"> <em>context</em>, </td>
|
| 477 |
|
|
</tr>
|
| 478 |
|
|
<tr>
|
| 479 |
|
|
<td class="paramkey"></td>
|
| 480 |
|
|
<td></td>
|
| 481 |
|
|
<td class="paramtype">unsigned int * </td>
|
| 482 |
|
|
<td class="paramname"> <em>payload</em></td><td> </td>
|
| 483 |
|
|
</tr>
|
| 484 |
|
|
<tr>
|
| 485 |
|
|
<td></td>
|
| 486 |
|
|
<td>)</td>
|
| 487 |
|
|
<td></td><td></td><td></td>
|
| 488 |
|
|
</tr>
|
| 489 |
|
|
</table>
|
| 490 |
|
|
</div>
|
| 491 |
|
|
<div class="memdoc">
|
| 492 |
|
|
|
| 493 |
|
|
<p>loads payload for processing to the core basically memcopy. </p>
|
| 494 |
|
|
<p>.. </p>
|
| 495 |
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
| 496 |
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
| 497 |
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </td><td>struct grouping address information </td></tr>
|
| 498 |
|
|
<tr><td valign="top"></td><td valign="top"><em>payload</em> </td><td>user data to be processed </td></tr>
|
| 499 |
|
|
</table>
|
| 500 |
|
|
</dd>
|
| 501 |
|
|
</dl>
|
| 502 |
|
|
|
| 503 |
|
|
<p>Definition at line <a class="el" href="avs__aes_8c_source.html#l00081">81</a> of file <a class="el" href="avs__aes_8c_source.html">avs_aes.c</a>.</p>
|
| 504 |
|
|
|
| 505 |
|
|
<p><div class="fragment"><pre class="fragment"><a name="l00081"></a>00081 {
|
| 506 |
|
|
<a name="l00082"></a>00082 <span class="keywordtype">int</span> i=0;
|
| 507 |
|
|
<a name="l00083"></a>00083 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* target_ptr = (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>* )context-><a class="code" href="structavs__aes__handle.html#adae23dc33b7dec54b9da34f347256214" title="pointer &quot;data&quot; field in memory mapping used for both decryption and encryption...">payload</a>;
|
| 508 |
|
|
<a name="l00084"></a>00084 <span class="keywordflow">for</span>(i=0; i<4; i++){
|
| 509 |
|
|
<a name="l00085"></a>00085 *(target_ptr++) = *(payload++);
|
| 510 |
|
|
<a name="l00086"></a>00086 }
|
| 511 |
|
|
<a name="l00087"></a>00087 }
|
| 512 |
|
|
</pre></div></p>
|
| 513 |
|
|
|
| 514 |
|
|
</div>
|
| 515 |
|
|
</div>
|
| 516 |
|
|
</div>
|
| 517 |
|
|
<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
|
| 518 |
|
|
<a href="http://www.doxygen.org/index.html">
|
| 519 |
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
| 520 |
|
|
</body>
|
| 521 |
|
|
</html>
|
