mccibootloaderboard_catenaabz_vectors.c

Go to the documentation of this file.

/*
 
Module: mccibootloaderboard_catenaabz_vectors.c
 
Function:
        Vectors for bootloader for Catenas based on Murata type-ABZ module.
 
Copyright and License:
        This file copyright (C) 2021, 2026 by
 
                MCCI Corporation
                3520 Krums Corners Road
                Ithaca, NY  14850
 
        See accompanying LICENSE file for copyright and license information.
 
Author:
        Terry Moore, MCCI Corporation   March 2021
 
*/
 
#include "mcci_bootloader_cm0plus.h"
#include "mcci_bootloader.h"
#include "mcci_bootloader_board_catena_abz.h"
#include "mcci_bootloader_cm0plus_appimage.h"
␌
/****************************************************************************\
|
|       Manifest constants & typedefs.
|
\****************************************************************************/
 
static void McciBootloaderBoard_CatenaAbz_NotHandled(void);
 
static McciBootloaderPlatform_ARMv6M_SvcHandlerFn_t
McciBootloaderBoard_CatenaAbz_SvcHandler;
 
/****************************************************************************\
|
|       Read-only data.
|
\****************************************************************************/
 
const McciBootloader_CortexPageZero_t
gk_McciBootloader_CortexVectors =
        {
        .PageZero =
            {
            .CortexVectors.vectors =
                {
                [0] = /* stack pointer */       (uint32_t) &g_McciBootloader_StackTop[0],
                [1] = /* entry point */         (uint32_t) McciBootloader_main,
                [2] = /* NMI */                 (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [3] = /* HardFault */           (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [4] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [5] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [6] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [7] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [8] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [9] = /* reserved */            (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [10] = /* reserved */           (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [11] = /* SVCall */             (uint32_t) McciBootloaderBoard_CatenaAbz_SvcHandler,
                [12] = /* reserved */           (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [13] = /* reserved */           (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [14] = /* PendSV */             (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [15] = /* SysTick */            (uint32_t) McciBootloaderBoard_CatenaAbz_handleSysTick,
                [16] = /* ExtInt(0) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [17] = /* ExtInt(1) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [18] = /* ExtInt(2) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [19] = /* ExtInt(3) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [20] = /* ExtInt(4) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [21] = /* ExtInt(5) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [22] = /* ExtInt(6) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [23] = /* ExtInt(7) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [24] = /* ExtInt(8) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [25] = /* ExtInt(9) */          (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [26] = /* ExtInt(10) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [27] = /* ExtInt(11) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [28] = /* ExtInt(12) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [29] = /* ExtInt(13) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [30] = /* ExtInt(14) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [31] = /* ExtInt(15) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [32] = /* ExtInt(16) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [33] = /* ExtInt(17) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [34] = /* ExtInt(18) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [35] = /* ExtInt(19) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [36] = /* ExtInt(20) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [37] = /* ExtInt(21) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [38] = /* ExtInt(22) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [39] = /* ExtInt(23) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [40] = /* ExtInt(24) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [41] = /* ExtInt(25) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [42] = /* ExtInt(26) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [43] = /* ExtInt(27) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [44] = /* ExtInt(28) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [45] = /* ExtInt(29) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [46] = /* ExtInt(30) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                [47] = /* ExtInt(31) */         (uint32_t) McciBootloaderBoard_CatenaAbz_NotHandled,
                },
            .AppInfo =
                {
                .magic = MCCI_BOOTLOADER_APP_INFO_MAGIC,
                .size = sizeof(McciBootloader_AppInfo_t),
                .targetAddress = (uint32_t) &gk_McciBootloader_CortexVectors,
                .imagesize = (uint32_t) &gk_McciBootloader_ImageSize[0],
                .authsize = sizeof(McciBootloader_SignatureBlock_t),
                }
            }
        };
 
// instantiate the signature block.
const McciBootloader_SignatureBlock_t
gk_McciBootloader_SignatureBlock;
 
/****************************************************************************\
|
|       Variables.
|
\****************************************************************************/
 
 
/****************************************************************************\
|
|       Code
|
\****************************************************************************/
 
/// \brief interrupt not handled; loop.
static void
McciBootloaderBoard_CatenaAbz_NotHandled(void)
        {
        while (true)
                ;
        }
 
///
/// \brief SVC handler -- provides very limited facilities to the application
///     after boot.
///
/// \details
///     * McciBootloaderPlatform_ARMv6M_SvcRq_GetUpdatePointer: gets the address
///       used by this bootloader for the EEPROM update flag.
///
///     * McciBootloaderPlatform_ARMv6M_SvcRq_HashInit: initializes a hash calculation.
///       arg1 points to a 64 byte buffer that is filled with the initial
///       hash value.
///
///     * McciBootloaderPlatform_ARMv6M_SvcRq_HashBlocks: accumulates hash.
///       arg1 points to McciBootloaderPlatform_ARMv6M_SvcRq_HashBlocks_Arg_t
///       object.
///
///     * McciBootloaderPlatform_ARMv6M_SvcRq_HashFinish: finishes a hash calculation.
///       arg1 points to McciBootloaderPlatform_ARMv6M_SvcRq_HashFinish_Arg_t.
///
///     * McciBootloaderPlatform_ARMv6M_SvcRq_Verify64: does a time-invariant comparison
///       of two 64-byte buffers.
///
///     TODO(tmm@mcci.com): this should be refactored because it's essentially portable.
///     The board specific SVC handler should delegate to a portable common block of logic.
///
static void
McciBootloaderBoard_CatenaAbz_SvcHandler(
        McciBootloaderPlatform_ARMv6M_SvcRq_t svcRequest,
        McciBootloaderPlatform_ARMv6M_SvcError_t *pErrorCode,
        uint32_t arg1,
        uint32_t arg2
        )
        {
        McciBootloaderPlatform_ARMv6M_SvcError_t err;
 
        err = McciBootloaderPlatform_SvcError_OK;
 
        switch (svcRequest)
                {
        case McciBootloaderPlatform_ARMv6M_SvcRq_GetUpdatePointer:
                {
                uint32_t ** const pResult = (uint32_t **)arg1;
                McciBootloaderBoard_CatenaAbz_Eeprom_t * const pEeprom =
                        McciBootloaderBoard_CatenaAbz_getEepromPointer();
 
                /* return pointer to user */
                if (pResult != NULL)
                        *pResult = &pEeprom->fUpdateRequest;
                else
                        err = McciBootloaderPlatform_SvcError_InvalidParameter;
                }
                break;
 
        case McciBootloaderPlatform_ARMv6M_SvcRq_HashInit:
                {
                mcci_tweetnacl_sha512_t * const pHash = (void *)arg1;
 
                mcci_tweetnacl_hashblocks_sha512_init(pHash);
                }
                break;
 
        case McciBootloaderPlatform_ARMv6M_SvcRq_HashBlocks:
                {
                McciBootloaderPlatform_ARMv6M_SvcRq_HashBlocks_Arg_t * const
                        pArg = (void *)arg1;
 
                if (arg1 == 0 || (arg1 & 3) != 0)
                        err = McciBootloaderPlatform_SvcError_InvalidParameter;
                else
                        {
                        mcci_tweetnacl_sha512_t * const pHash = pArg->pHash;
                        pArg->nMessage = mcci_tweetnacl_hashblocks_sha512(
                                pHash,
                                pArg->pMessage,
                                pArg->nMessage
                                );
                        }
                }
                break;
 
        case McciBootloaderPlatform_ARMv6M_SvcRq_HashFinish:
                {
                McciBootloaderPlatform_ARMv6M_SvcRq_HashFinish_Arg_t * const
                        pArg = (void *)arg1;
 
                if (arg1 == 0 || (arg1 & 3) != 0)
                        err = McciBootloaderPlatform_SvcError_InvalidParameter;
                else
                        {
                        mcci_tweetnacl_sha512_t * const pHash = pArg->pHash;
                        mcci_tweetnacl_hashblocks_sha512_finish(
                                pHash,
                                pArg->pMessage,
                                pArg->nMessage,
                                pArg->nOverall
                                );
                        }
                }
                break;
 
        case McciBootloaderPlatform_ARMv6M_SvcRq_Verify64:
                {
                const mcci_tweetnacl_sha512_t * const
                        pArg1 = (void *)arg1;
                const mcci_tweetnacl_sha512_t * const
                        pArg2 = (void *)arg2;
 
                mcci_tweetnacl_result_t const r = mcci_tweetnacl_verify_64(pArg1->bytes, pArg2->bytes);
                err = mcci_tweetnacl_result_is_success(r)
                        ? McciBootloaderPlatform_SvcError_OK
                        : McciBootloaderPlatform_SvcError_VerifyFailure
                        ;
                }
                break;
 
        default:
                err = McciBootloaderPlatform_SvcError_Unclaimed;
                break;
                }
 
        // return result
        *pErrorCode = err;
        }
 
/**** end of mccibootloaderboard_catenaabz_vectors.c ****/