knx/source/ti/drivers/aesctr/AESCTRCC26XX.c

/*
 * Copyright (c) 2018-2019, 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.
 */

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

#include <ti/drivers/dpl/DebugP.h>
#include <ti/drivers/dpl/HwiP.h>
#include <ti/drivers/dpl/SemaphoreP.h>

#include <ti/drivers/Power.h>
#include <ti/drivers/power/PowerCC26XX.h>
#include <ti/drivers/AESCTR.h>
#include <ti/drivers/aesctr/AESCTRCC26XX.h>
#include <ti/drivers/cryptoutils/sharedresources/CryptoResourceCC26XX.h>
#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>

#include <ti/devices/DeviceFamily.h>
#include DeviceFamily_constructPath(inc/hw_ints.h)
#include DeviceFamily_constructPath(inc/hw_types.h)
#include DeviceFamily_constructPath(inc/hw_crypto.h)
#include DeviceFamily_constructPath(driverlib/aes.h)
#include DeviceFamily_constructPath(driverlib/interrupt.h)

/* Forward declarations */
static void AESCTR_hwiFxn (uintptr_t arg0);
static int_fast16_t AESCTR_startOperation(AESCTR_Handle handle,
                                          AESCTR_Operation *operation,
                                          AESCTR_OperationType operationType);
static int_fast16_t AESCTR_waitForResult(AESCTR_Handle handle);
static void AESCTR_cleanup(AESCTR_Handle handle);

/* Non-public functions required by other drivers */
bool AESCTR_acquireLock(AESCTR_Handle handle);
void AESCTR_releaseLock(AESCTR_Handle handle);
void AESCTR_enableThreadSafety(AESCTR_Handle handle);
void AESCTR_disableThreadSafety(AESCTR_Handle handle);

/* Extern globals */
extern const AESCTR_Config AESCTR_config[];
extern const uint_least8_t AESCTR_count;

/* Static globals */
static bool isInitialized = false;

/*
 *  ======== AESCTR_hwiFxn ========
 */
static void AESCTR_hwiFxn (uintptr_t arg0) {
    AESCTRCC26XX_Object *object = ((AESCTR_Handle)arg0)->object;
    uint32_t key;

    key = HwiP_disable();
    if (!object->operationCanceled) {

        /* Mark that we are done with the operation so that AESCTR_cancelOperation
         * knows not to try canceling.
         */
        object->operationInProgress = false;

        HwiP_restore(key);
    }
    else {
        HwiP_restore(key);
        return;
    }

    /* Propagate the DMA error from driverlib to the application */
    if (AESIntStatusRaw() & AES_DMA_BUS_ERR) {
        object->returnStatus = AESCTR_STATUS_ERROR;
    }

    AESIntClear(AES_RESULT_RDY | AES_DMA_IN_DONE | AES_DMA_BUS_ERR);

    /* Handle cleaning up of the operation. Invalidate the key,
     * release the Power constraints, and post the access semaphore.
     */
    AESCTR_cleanup((AESCTR_Handle)arg0);

    if (object->returnBehavior == AESCTR_RETURN_BEHAVIOR_BLOCKING) {
        /* Unblock the pending task to signal that the operation is complete. */
        SemaphoreP_post(&CryptoResourceCC26XX_operationSemaphore);
    }
    else {
        /* Call the callback function provided by the application.
         */
        object->callbackFxn((AESCTR_Handle)arg0,
                            object->returnStatus,
                            object->operation,
                            object->operationType);
    }

}

/*
 *  ======== AESCTR_cleanup ========
 */
static void AESCTR_cleanup(AESCTR_Handle handle) {
    AESCTRCC26XX_Object *object = handle->object;

    /* Since plaintext keys use two reserved (by convention) slots in the keystore,
     * the slots must be invalidated to prevent its re-use without reloading
     * the key material again.
     */
    AESInvalidateKey(AES_KEY_AREA_6);
    AESInvalidateKey(AES_KEY_AREA_7);

    /*  This powers down all sub-modules of the crypto module until needed.
     *  It does not power down the crypto module at PRCM level and provides small
     *  power savings.
     */
    AESSelectAlgorithm(0x00);

    Power_releaseConstraint(PowerCC26XX_DISALLOW_STANDBY);

    /*  Grant access for other threads to use the crypto module.
     *  The semaphore must be posted before the callbackFxn to allow the chaining
     *  of operations.
     */
    if (object->threadSafe) {
        CryptoResourceCC26XX_releaseLock();
    }
}

/*
 *  ======== AESCTR_init ========
 */
void AESCTR_init(void) {
    CryptoResourceCC26XX_constructRTOSObjects();

    isInitialized = true;
}

/*
 *  ======== AESCTR_open ========
 */
AESCTR_Handle AESCTR_open(uint_least8_t index, const AESCTR_Params *params) {
    AESCTR_Handle               handle;
    AESCTRCC26XX_Object        *object;
    uint_fast8_t                key;

    handle = (AESCTR_Config*)&AESCTR_config[index];
    object = handle->object;

    DebugP_assert(index < AESCTR_count);

    key = HwiP_disable();

    if (!isInitialized || object->isOpen) {
        HwiP_restore(key);
        return NULL;
    }

    object->isOpen = true;

    HwiP_restore(key);

    /* If params are NULL, use defaults */
    if (params == NULL) {
        params = &AESCTR_defaultParams;
    }

    DebugP_assert(params->returnBehavior == AESCTR_RETURN_BEHAVIOR_CALLBACK ? params->callbackFxn : true);

    object->returnBehavior = params->returnBehavior;
    object->callbackFxn = params->callbackFxn;
    object->semaphoreTimeout = params->returnBehavior == AESCTR_RETURN_BEHAVIOR_BLOCKING ? params->timeout : SemaphoreP_NO_WAIT;
    object->threadSafe = true;

    /* Set power dependency - i.e. power up and enable clock for Crypto (CryptoResourceCC26XX) module. */
    Power_setDependency(PowerCC26XX_PERIPH_CRYPTO);

    return handle;
}

/*
 *  ======== AESCTR_close ========
 */
void AESCTR_close(AESCTR_Handle handle) {
    AESCTRCC26XX_Object         *object;

    DebugP_assert(handle);

    /* Get the pointer to the object and hwAttrs */
    object = handle->object;

    /* Mark the module as available */
    object->isOpen = false;

    /* Release power dependency on Crypto Module. */
    Power_releaseDependency(PowerCC26XX_PERIPH_CRYPTO);
}

/*
 *  ======== AESCTR_startOperation ========
 */
static int_fast16_t AESCTR_startOperation(AESCTR_Handle handle,
                                          AESCTR_Operation *operation,
                                          AESCTR_OperationType operationType) {
    AESCTRCC26XX_Object *object = handle->object;
    AESCTRCC26XX_HWAttrs const *hwAttrs = handle->hwAttrs;
    bool resourceAcquired;

    /* Only plaintext CryptoKeys are supported for now */
    uint16_t keyLength = operation->key->u.plaintext.keyLength;
    uint8_t *keyingMaterial = operation->key->u.plaintext.keyMaterial;

    DebugP_assert(handle);

    if (object->threadSafe) {
        /* Try and obtain access to the crypto module */
        resourceAcquired = CryptoResourceCC26XX_acquireLock(object->semaphoreTimeout);

        if (!resourceAcquired) {
            return AESCTR_STATUS_RESOURCE_UNAVAILABLE;
        }
    }

    object->operationType = operationType;
    object->operation = operation;
    /* We will only change the returnStatus if there is an error */
    object->returnStatus = AESCTR_STATUS_SUCCESS;
    object->operationCanceled = false;


    /* We need to set the HWI function and priority since the same physical interrupt is shared by multiple
     * drivers and they all need to coexist. Whenever a driver starts an operation, it
     * registers its HWI callback with the OS.
     */
    HwiP_setFunc(&CryptoResourceCC26XX_hwi, AESCTR_hwiFxn, (uintptr_t)handle);
    HwiP_setPriority(INT_CRYPTO_RESULT_AVAIL_IRQ, hwAttrs->intPriority);

    /* Disallow standby. We are about to configure and start the accelerator.
     * Setting the constraint should happen after all opportunities to fail out of the
     * function. This way, we do not need to undo it each time we exit with a failure.
     */
    Power_setConstraint(PowerCC26XX_DISALLOW_STANDBY);

    /* Load the key from RAM or flash into the key store at a hardcoded and reserved location */
    if (AESWriteToKeyStore(keyingMaterial, keyLength, AES_KEY_AREA_6) != AES_SUCCESS) {
        /* Wipe keys, release STANDBY constraint, power off AES sub-module,
         * and release acclerator lock
         */
        AESCTR_cleanup(handle);

        return AESCTR_STATUS_ERROR;
    }

    /* If we are in AESCTR_RETURN_BEHAVIOR_POLLING, we do not want an interrupt to trigger.
     * AESWriteToKeyStore() disables and then re-enables the CRYPTO IRQ in the NVIC so we
     * need to disable it before kicking off the operation.
     */
    if (object->returnBehavior == AESCTR_RETURN_BEHAVIOR_POLLING)  {
        IntDisable(INT_CRYPTO_RESULT_AVAIL_IRQ);
    }

    /* Power the AES sub-module of the crypto module */
    AESSelectAlgorithm(AES_ALGSEL_AES);

    /* Load the key from the key store into the internal register banks of the AES sub-module */
    if (AESReadFromKeyStore(AES_KEY_AREA_6) != AES_SUCCESS) {
        /* Wipe keys, release STANDBY constraint, power off AES sub-module,
         * and release acclerator lock
         */
        AESCTR_cleanup(handle);

        return AESCTR_STATUS_ERROR;
    }

    if (operation->initialCounter) {
        /* If an initial counter is provided, load it. */
        AESSetInitializationVector((uint32_t *)operation->initialCounter);
    }
    else {
        /* Otherwise, use an initial counter of 0 */
        HWREG(CRYPTO_BASE + CRYPTO_O_AESIV0) = 0x00000000;
        HWREG(CRYPTO_BASE + CRYPTO_O_AESIV1) = 0x00000000;
        HWREG(CRYPTO_BASE + CRYPTO_O_AESIV2) = 0x00000000;
        HWREG(CRYPTO_BASE + CRYPTO_O_AESIV3) = 0x00000000;
    }

    AESSetCtrl(CRYPTO_AESCTL_CTR |
               CRYPTO_AESCTL_CTR_WIDTH_128_BIT |
               (operationType == AESCTR_OPERATION_TYPE_ENCRYPT ? CRYPTO_AESCTL_DIR : 0));

    AESSetDataLength(operation->inputLength);
    AESSetAuthLength(0);

    AESStartDMAOperation(operation->input, operation->inputLength, operation->output, operation->inputLength);

    return AESCTR_waitForResult(handle);
}

/*
 *  ======== AESCTR_waitForResult ========
 */
static int_fast16_t AESCTR_waitForResult(AESCTR_Handle handle){
    AESCTRCC26XX_Object *object = handle->object;

    object->operationInProgress = true;

    if (object->returnBehavior == AESCTR_RETURN_BEHAVIOR_POLLING) {
        /* Wait until the operation is complete and check for DMA errors. */
        if(AESWaitForIRQFlags(AES_RESULT_RDY | AES_DMA_BUS_ERR) & AES_DMA_BUS_ERR){
            object->returnStatus = AESCTR_STATUS_ERROR;
        }

        /* Mark that we are done with the operation */
        object->operationInProgress = false;

        /* Make sure to also clear DMA_IN_DONE as it is not cleared above
         * but will be set none-the-less.
         */
        AESIntClear(AES_RESULT_RDY | AES_DMA_IN_DONE | AES_DMA_BUS_ERR);

        /* Instead of handling cleanup in the hwi, we will execute
         * the core of the function here
         */
        AESCTR_cleanup(handle);

        return object->returnStatus;
    }
    else if (object->returnBehavior == AESCTR_RETURN_BEHAVIOR_BLOCKING) {
        SemaphoreP_pend(&CryptoResourceCC26XX_operationSemaphore, SemaphoreP_WAIT_FOREVER);

        return object->returnStatus;
    }
    else {
        return AESCTR_STATUS_SUCCESS;
    }
}

/*
 *  ======== AESCTR_oneStepEncrypt ========
 */
int_fast16_t AESCTR_oneStepEncrypt(AESCTR_Handle handle, AESCTR_Operation *operationStruct) {

    return AESCTR_startOperation(handle, operationStruct, AESCTR_OPERATION_TYPE_ENCRYPT);
}

/*
 *  ======== AESCTR_oneStepDecrypt ========
 */
int_fast16_t AESCTR_oneStepDecrypt(AESCTR_Handle handle, AESCTR_Operation *operationStruct) {

    return AESCTR_startOperation(handle, operationStruct, AESCTR_OPERATION_TYPE_DECRYPT);
}

/*
 *  ======== AESCTR_cancelOperation ========
 */
int_fast16_t AESCTR_cancelOperation(AESCTR_Handle handle) {
    AESCTRCC26XX_Object *object         = handle->object;
    uint32_t key;

    key = HwiP_disable();

    if (!object->operationInProgress) {
        HwiP_restore(key);
        return AESCTR_STATUS_ERROR;
    }

    /* Reset the accelerator. Immediately stops ongoing operations. */
    AESReset();

    /* Consume any outstanding interrupts we may have accrued
     * since disabling interrupts.
     */
    IntPendClear(INT_CRYPTO_RESULT_AVAIL_IRQ);

    object->operationCanceled = true;
    object->returnStatus = AESCTR_STATUS_CANCELED;

    HwiP_restore(key);

    /* Wipe keys, release STANDBY constraint, power off AES sub-module,
     * and release acclerator lock
     */
    AESCTR_cleanup(handle);

    if (object->returnBehavior == AESCTR_RETURN_BEHAVIOR_BLOCKING) {
        /* Unblock the pending task to signal that the operation is complete. */
        SemaphoreP_post(&CryptoResourceCC26XX_operationSemaphore);
    }
    else {
        /* Call the callback function provided by the application. */
        object->callbackFxn(handle,
                            AESCTR_STATUS_CANCELED,
                            object->operation,
                            object->operationType);
    }

    return AESCTR_STATUS_SUCCESS;
}

bool AESCTR_acquireLock(AESCTR_Handle handle) {
    AESCTRCC26XX_Object *object = handle->object;

    return CryptoResourceCC26XX_acquireLock(object->semaphoreTimeout);
}

void AESCTR_releaseLock(AESCTR_Handle handle) {
    CryptoResourceCC26XX_releaseLock();
}

void AESCTR_enableThreadSafety(AESCTR_Handle handle) {
    AESCTRCC26XX_Object *object = handle->object;

    object->threadSafe = true;
}
void AESCTR_disableThreadSafety(AESCTR_Handle handle) {
    AESCTRCC26XX_Object *object = handle->object;

    object->threadSafe = false;
}