////////////////////////////////////////////////////////////////////////////////
///
/// @file       ape.c
///
/// @project
///
/// @brief      APE Support Routines
///
////////////////////////////////////////////////////////////////////////////////
///
////////////////////////////////////////////////////////////////////////////////
///
/// @copyright Copyright (c) 2018, Evan Lojewski
/// @cond
///
/// All rights reserved.
///
/// Redistribution and use in source and binary forms, with or without
/// modification, are permitted provided that the following conditions are met:
/// 1. Redistributions of source code must retain the above copyright notice,
/// this list of conditions and the following disclaimer.
/// 2. 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.
/// 3. Neither the name of the copyright holder 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 HOLDER 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.
/// @endcond
////////////////////////////////////////////////////////////////////////////////
#include "bcm5719_APE_PERI.h"
#include "bcm5719_DEVICE.h"

void APE_aquireLock(void)
{
    RegAPE_PERIPerLockRequestPhy0_t lock_req;
    lock_req.r32 = 0;
#ifdef __arm__ /* APE */
    lock_req.bits.APE = 1;
#else
    lock_req.bits.Bootcode = 1;
#endif

    uint8_t function = DEVICE.Status.bits.FunctionNumber;
    switch (function)
    {
        default: /* fallthrough */
        case 0:
            APE_PERI.PerLockRequestPhy0.r32 = lock_req.r32;
            do
            {
                // spin
            } while (lock_req.r32 != APE_PERI.PerLockGrantPhy0.r32);
            return;

        case 1:
            APE_PERI.PerLockRequestPhy1.r32 = lock_req.r32;
            do
            {
                // spin
            } while (lock_req.r32 != APE_PERI.PerLockGrantPhy1.r32);
            return;

        case 2:
            APE_PERI.PerLockRequestPhy2.r32 = lock_req.r32;
            do
            {
                // spin
            } while (lock_req.r32 != APE_PERI.PerLockGrantPhy2.r32);
            return;

        case 3:
            APE_PERI.PerLockRequestPhy3.r32 = lock_req.r32;
            do
            {
                // spin
            } while (lock_req.r32 != APE_PERI.PerLockGrantPhy3.r32);
            return;
    }
}

void APE_releaseLock(void)
{
    RegAPE_PERIPerLockGrantPhy0_t lock_release;
    lock_release.r32 = 0;
#ifdef __arm__ /* APE */
    lock_release.bits.APE = 1;
#else
    lock_release.bits.Bootcode = 1;
#endif

    uint8_t function = DEVICE.Status.bits.FunctionNumber;
    switch (function)
    {
        default: /* fallthrough */
        case 0:
            APE_PERI.PerLockGrantPhy0.r32 = lock_release.r32;
            break;

        case 1:
            APE_PERI.PerLockGrantPhy1.r32 = lock_release.r32;
            break;

        case 2:
            APE_PERI.PerLockGrantPhy2.r32 = lock_release.r32;
            break;

        case 3:
            APE_PERI.PerLockGrantPhy3.r32 = lock_release.r32;
            break;
    }
}

void APE_releaseAllLocks(void)
{
    RegAPE_PERIPerLockGrantPhy0_t lock_release;
    lock_release.r32 = 0;
    lock_release.bits.Bootcode = 1;

    APE_PERI.PerLockGrantGrc.r32 = lock_release.r32;
    APE_PERI.PerLockGrantMem.r32 = lock_release.r32;
    APE_PERI.PerLockGrantPhy0.r32 = lock_release.r32;
    APE_PERI.PerLockGrantPhy1.r32 = lock_release.r32;
    APE_PERI.PerLockGrantPhy2.r32 = lock_release.r32;
    APE_PERI.PerLockGrantPhy3.r32 = lock_release.r32;
    APE_PERI.PerLockGrantGpio.r32 = lock_release.r32;
    APE_PERI.PerLockGrantPort6.r32 = lock_release.r32;
}