ECDSACC26X2.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 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.
 */
#ifndef ti_drivers_ecdsa_ECDSACC26X2__include
#define ti_drivers_ecdsa_ECDSACC26X2__include

#ifdef __cplusplus
extern "C" {
#endif

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

#include <ti/drivers/Power.h>
#include <ti/drivers/ECDSA.h>
#include <ti/drivers/cryptoutils/ecc/ECCParams.h>
#include <ti/drivers/cryptoutils/cryptokey/CryptoKey.h>

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

/* Exit the SWI and wait until an HWI call posts the SWI again */
#define ECDSACC26X2_STATUS_FSM_RUN_PKA_OP       ECDSA_STATUS_RESERVED - 0
/* Execute the next FSM state immediately without waiting for the next HWI */
#define ECDSACC26X2_STATUS_FSM_RUN_FSM          ECDSA_STATUS_RESERVED - 1
/* Restart the FSM and begin executing from the initial state */
#define ECDSACC26X2_STATUS_FSM_RESTART_FSM      ECDSA_STATUS_RESERVED - 2

typedef enum ECDSACC26X2_FsmState_ {
    ECDSACC26X2_FSM_ERROR = 0,

    ECDSACC26X2_FSM_SIGN_GENERATE_PMSN,
    ECDSACC26X2_FSM_SIGN_PMSN_MOD_N,
    ECDSACC26X2_FSM_SIGN_PMSN_MOD_N_RESULT,
    ECDSACC26X2_FSM_SIGN_COMPUTE_R,
    ECDSACC26X2_FSM_SIGN_COMPUTE_R_RESULT,
    ECDSACC26X2_FSM_SIGN_R_MOD_N,
    ECDSACC26X2_FSM_SIGN_R_MOD_N_RESULT,
    ECDSACC26X2_FSM_SIGN_COMPUTE_PMSN_INVERSE,
    ECDSACC26X2_FSM_SIGN_COMPUTE_PMSN_INVERSE_RESULT,
    ECDSACC26X2_FSM_SIGN_COMPUTE_PRIVATE_KEY_X_R,
    ECDSACC26X2_FSM_SIGN_COMPUTE_PRIVATE_KEY_X_R_RESULT,
    ECDSACC26X2_FSM_SIGN_ADD_HASH,
    ECDSACC26X2_FSM_SIGN_ADD_HASH_RESULT,
    ECDSACC26X2_FSM_SIGN_MULT_BY_PMSN_INVERSE,
    ECDSACC26X2_FSM_SIGN_MULT_BY_PMSN_INVERSE_RESULT,
    ECDSACC26X2_FSM_SIGN_MOD_N,
    ECDSACC26X2_FSM_SIGN_MOD_N_RESULT,

    ECDSACC26X2_FSM_VERIFY_R_S_IN_RANGE,
    ECDSACC26X2_FSM_VERIFY_COMPUTE_S_INV,
    ECDSACC26X2_FSM_VERIFY_COMPUTE_S_INV_RESULT,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_HASH,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_HASH_RESULT,
    ECDSACC26X2_FSM_VERIFY_S_INV_MULT_HASH_MOD_N,
    ECDSACC26X2_FSM_VERIFY_S_INV_MULT_HASH_MOD_N_RESULT,
    ECDSACC26X2_FSM_VERIFY_MULT_G,
    ECDSACC26X2_FSM_VERIFY_MULT_G_RESULT,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_R,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_R_RESULT,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_R_MOD_N,
    ECDSACC26X2_FSM_VERIFY_MULT_S_INV_R_MOD_N_RESULT,
    ECDSACC26X2_FSM_VERIFY_MULT_PUB_KEY,
    ECDSACC26X2_FSM_VERIFY_MULT_PUB_KEY_RESULT,
    ECDSACC26X2_FSM_VERIFY_ADD_MULT_RESULTS,
    ECDSACC26X2_FSM_VERIFY_ADD_MULT_RESULTS_RESULT,
    ECDSACC26X2_FSM_VERIFY_POINTX_MOD_N,
    ECDSACC26X2_FSM_VERIFY_POINTX_MOD_N_RESULT,
    ECDSACC26X2_FSM_VERIFY_COMPARE_RESULT_R,

} ECDSACC26X2_FsmState;

typedef int_fast16_t (*ECDSACC26X2_stateMachineFxn) (ECDSA_Handle handle);

typedef struct ECDSACC26X2_HWAttrs_ {
    uint8_t    intPriority;
    uint32_t   swiPriority;
} ECDSACC26X2_HWAttrs;

typedef struct ECDSACC26X2_Object_ {
    bool                            isOpen;
    int_fast16_t                    returnValue;
    ECDSA_Operation                 operation;
    ECDSA_OperationType             operationType;
    ECDSA_CallbackFxn               callbackFxn;
    ECDSACC26X2_stateMachineFxn     fsmFxn;
    ECDSA_ReturnBehavior            returnBehavior;
    ECDSACC26X2_FsmState            fsmState;
    ECDSACC26X2_FsmState            fsmStateInitial;
    uint32_t                        semaphoreTimeout;
    uint32_t                        resultAddress;
    uint32_t                       *scratchNumber1;
    uint32_t                       *scratchNumber2;
    SwiP_Struct                     callbackSwi;
} ECDSACC26X2_Object;

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_ecdsa_ECDSACC26X2__include */