/**
|
/**
|
* \file avs_aes.h
|
* \file avs_aes.h
|
* \brief header file for AES Avalon IP Core software driver
|
* \brief header file for AES Avalon IP Core software driver
|
* offers interfaces to convinient access to the core
|
* offers interfaces to convinient access to the core
|
*
|
*
|
* This file is part of the project avs_aes
|
* This file is part of the project avs_aes
|
* see: http://opencores.org/project,avs_aes
|
* see: http://opencores.org/project,avs_aes
|
*
|
*
|
*
|
*
|
* \section AUTHORS
|
* \section AUTHORS
|
* Thomas Ruschival -- ruschi@opencores.org (www.ruschival.de)
|
* Thomas Ruschival -- ruschi@opencores.org (www.ruschival.de)
|
*
|
*
|
* \section LICENSE
|
* \section LICENSE
|
* Copyright (c) 2009, Authors and opencores.org
|
* Copyright (c) 2009, Authors and opencores.org
|
* All rights reserved.
|
* All rights reserved.
|
*
|
*
|
* Redistribution and use in source and binary forms, with or without modification,
|
* Redistribution and use in source and binary forms, with or without modification,
|
* are permitted provided that the following conditions are met:
|
* are permitted provided that the following conditions are met:
|
* * Redistributions of source code must retain the above copyright notice,
|
* * Redistributions of source code must retain the above copyright notice,
|
* this list of conditions and the following disclaimer.
|
* this list of conditions and the following disclaimer.
|
* * Redistributions in binary form must reproduce the above copyright notice,
|
* * Redistributions in binary form must reproduce the above copyright notice,
|
* this list of conditions and the following disclaimer in the documentation
|
* this list of conditions and the following disclaimer in the documentation
|
* and/or other materials provided with the distribution.
|
* and/or other materials provided with the distribution.
|
* * Neither the name of the organization nor the names of its contributors
|
* * 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
|
* may be used to endorse or promote products derived from this software without
|
* specific prior written permission.
|
* specific prior written permission.
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
|
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
* THE POSSIBILITY OF SUCH DAMAGE
|
* THE POSSIBILITY OF SUCH DAMAGE
|
*/
|
*/
|
|
|
|
|
#ifndef AVS_AES_H_
|
#ifndef AVS_AES_H_
|
#define AVS_AES_H_
|
#define AVS_AES_H_
|
|
|
/**
|
/**
|
* \section Configuration
|
* \section Configuration
|
* Configuration items for the Avalon Slave component
|
* Configuration items for the Avalon Slave component
|
* change them or define them elsewhere
|
* change them or define them elsewhere
|
*/
|
*/
|
#ifndef KEYWORDS
|
#ifndef KEYWORDS
|
/**
|
/**
|
* Keylength 256 Bit AES
|
* Keylength 256 Bit AES
|
*/
|
*/
|
#define KEYWORDS 8
|
#define KEYWORDS 8
|
#endif /* KEYWORDS */
|
#endif /* KEYWORDS */
|
|
|
#ifndef AES_BASEADDR
|
#ifndef AES_BASEADDR
|
/**
|
/**
|
* base address of the Avalon Slave component in memory map
|
* base address of the Avalon Slave component in memory map
|
*/
|
*/
|
#define AES_BASEADDR 0x40000
|
#define AES_BASEADDR 0x40000
|
#endif /* AES_BASEADDR */
|
#endif /* AES_BASEADDR */
|
|
|
|
|
/**
|
/**
|
* \section Constants
|
* \addtogroup control-register
|
* Constants no need to change them!
|
* Bits in Control Register
|
*/
|
* \see{avs_aes_handle::control}
|
/** memory offset for key DON'T CHANGE! */
|
* \{
|
#define KEY_ADDR AES_BASEADDR+0x00
|
*/
|
/** memory offset of payload DON'T CHANGE!*/
|
|
#define DATA_ADDR AES_BASEADDR+0x08
|
/** Signal load of new key valid \see{avs_aes_handle::control} */
|
/** memory offset of result DON'T CHANGE! */
|
#define KEY_VALID (1 << 7)
|
#define RESULT_ADDR AES_BASEADDR+0x10
|
/** Enable interrupt bit \see{avs_aes_handle::control} */
|
/** memory offset for control word DON'T CHANGE! */
|
#define IRQ_ENA (1 << 6)
|
#define AESCTRLWD AES_BASEADDR+0x18
|
/** Start decryption bit \see{avs_aes_handle::control} */
|
|
#define DECRYPT (1 << 1)
|
|
/** start encryption bit \see{avs_aes_handle::control} */
|
|
#define ENCRYPT (1 << 0)
|
|
|
|
/** \} */
|
|
|
/**
|
/**
|
* \brief object storing addresses for this Avalon AES slave
|
* \brief object storing addresses for this Avalon AES slave
|
* might be useful in case there are more attached, also for convinience
|
* might be useful in case there are more attached, also for convinience
|
*/
|
*/
|
typedef struct{
|
typedef struct {
|
/**
|
/**
|
* \brief pointer "KEY" field in memory mapping
|
* \brief pointer to key field in memory mapping
|
*/
|
*/
|
volatile unsigned int* key;
|
volatile unsigned int* key;
|
/**
|
/**
|
* \brief pointer "data" field in memory mapping
|
* \brief pointer to data field in memory mapping
|
* used for both decryption and encryption
|
* used for both decryption and encryption
|
*/
|
*/
|
volatile unsigned int* payload;
|
volatile unsigned int* payload;
|
/**
|
/**
|
* \brief pointer "RESULT" field in memory mapping
|
* \brief pointer to result field in memory mapping
|
*/
|
*/
|
volatile unsigned int* result;
|
volatile unsigned int* result;
|
/**
|
/**
|
* \brief pointer to control word
|
* \brief pointer to control word
|
*/
|
*/
|
volatile unsigned int* control;
|
volatile unsigned int* control;
|
|
|
} avs_aes_handle;
|
} avs_aes_handle;
|
|
|
/**
|
/**
|
* \section functions
|
* \section functions
|
**/
|
**/
|
|
|
|
|
/**
|
/**
|
* \brief setup the context to be used later.
|
* \brief setup the context to be used later.
|
* initializes the pointers to the correct memory locations
|
* initializes the pointers to the correct memory locations
|
* \param context : struct grouping address information
|
* \param context : struct grouping address information
|
*/
|
*/
|
void avs_aes_init(avs_aes_handle* context);
|
void avs_aes_init(avs_aes_handle* context);
|
|
|
/**
|
/**
|
* \brief setup the context to be used later.
|
* \brief Set a new key
|
* initializes the pointers to the correct memory locations
|
* This call asserts the KEY_VALID flag and triggers the key-expansion in the core
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
* \param key user key to load
|
* \param key user key to load
|
*/
|
*/
|
void avs_aes_setKey(avs_aes_handle* context, unsigned int* key);
|
void avs_aes_setKey(avs_aes_handle* context, unsigned int* key);
|
|
|
/**
|
/**
|
* \brief loads payload for processing to the core
|
* \brief loads payload for processing to the core
|
* basically memcopy...
|
* basically memcopy...
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
* \param payload user data to be processed
|
* \param payload user data to be processed
|
*/
|
*/
|
void avs_aes_setPayload(avs_aes_handle* context, unsigned int* payload);
|
void avs_aes_setPayload(avs_aes_handle* context, unsigned int* payload);
|
|
|
/**
|
/**
|
* \brief set the KEY_VALID flag in the control word
|
* \brief set the KEY_VALID flag in the control word
|
* used to signal the completion of writing the key ( \ref avs_aes_setKey )
|
* used to signal the completion of writing the key ( \ref avs_aes_setKey )
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
*/
|
*/
|
void avs_aes_setKeyvalid(avs_aes_handle* context);
|
void avs_aes_setKeyvalid(avs_aes_handle* context);
|
|
|
/**
|
/**
|
* \brief set the ENCRYPT flag in the control word
|
* \brief set the ENCRYPT flag in the control word
|
* start encryption of (hopefully) previously loaded payload
|
* start encryption of (hopefully) previously loaded payload
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
*/
|
*/
|
void avs_aes_encrypt(avs_aes_handle* context);
|
void avs_aes_encrypt(avs_aes_handle* context);
|
|
|
/**
|
/**
|
* \brief set the DECRYPT flag in the control word
|
* \brief set the DECRYPT flag in the control word
|
* start encryption of (hopefully) previously loaded payload
|
* start encryption of (hopefully) previously loaded payload
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
*/
|
*/
|
void avs_aes_decrypt( avs_aes_handle* context);
|
void avs_aes_decrypt(avs_aes_handle* context);
|
|
|
/**
|
/**
|
* \brief checks the COMPLETED flag
|
* \brief checks the COMPLETED flag
|
* can be used for ugly polling the slave if IRQs are not used
|
* can be used for ugly polling the slave if IRQs are not used
|
* \param context struct grouping address information
|
* \param context struct grouping address information
|
* \return 1 if still computing 0 if done.
|
* \return 1 if still computing 0 if done.
|
*/
|
*/
|
int avs_aes_isBusy(avs_aes_handle* context);
|
int avs_aes_isBusy(avs_aes_handle* context);
|
|
|
|
|
#endif /*AVS_AES_H_*/
|
#endif /*AVS_AES_H_*/
|
|
|
