AESCommon.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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 Texas Instruments Incorporated 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 OWNER 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.
 */

/*!***************************************************************************
 *  @file       AESCommon.h
 *
 *  @brief      AES common module header for all devices
 *****************************************************************************/

#ifndef ti_drivers_AESCommon_include
#define ti_drivers_AESCommon_include

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#define AES_STATUS_SUCCESS ((int_fast16_t)0)

#define AES_STATUS_ERROR ((int_fast16_t)-1)

#define AES_STATUS_RESOURCE_UNAVAILABLE ((int_fast16_t)-2)

#define AES_STATUS_CANCELED ((int_fast16_t)-3)

#define AES_STATUS_MAC_INVALID ((int_fast16_t)-4)

#define AES_STATUS_KEYSTORE_INVALID_ID ((int_fast16_t)-5)

#define AES_STATUS_KEYSTORE_GENERIC_ERROR ((int_fast16_t)-6)

#define AES_STATUS_FEATURE_NOT_SUPPORTED ((int_fast16_t)-7)

#define AES_STATUS_UNALIGNED_IO_NOT_SUPPORTED ((int_fast16_t)-8)

#define AES_STATUS_DRIVER_SPECIFIC_ERROR ((int_fast16_t)-16)

#define AES_STATUS_RESERVED ((int_fast16_t)-32)

typedef struct
{
    void *object;

    void const *hwAttrs;
} AESCommon_Config;

typedef enum
{
    AES_RETURN_BEHAVIOR_CALLBACK = 1, 
    AES_RETURN_BEHAVIOR_BLOCKING = 2, 
    AES_RETURN_BEHAVIOR_POLLING  = 4, 
} AES_ReturnBehavior;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_AESCommon__include */