dl_mathacl.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, 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       dl_mathacl.h
 *  @brief      Math Accelerator Driver Library
 *  @defgroup   MATHACL Math Accelerator (MATHACL)
 *
 *  @anchor ti_dl_dl_m0p_mathacl_Overview
 *  # Overview
 *
 *  The Math Accelerator Driver Library provides software to control the
 *  onboard Math Accelerator hardware.
 *
 ******************************************************************************
 */
#ifndef ti_dl_dl_mathacl__include
#define ti_dl_dl_mathacl__include

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

#include <ti/devices/msp/msp.h>
#include <ti/driverlib/dl_common.h>

#ifdef __MSPM0_HAS_MATHACL__

#ifdef __cplusplus
extern "C" {
#endif

/* clang-format off */

#define DL_MATHACL_STATUS_UNDERFLOW               (MATHACL_STATUS_UF_UNDERFLOW)

#define DL_MATHACL_STATUS_UF_MASK                      (MATHACL_STATUS_UF_MASK)

#define DL_MATHACL_STATUS_OVERFLOW                (MATHACL_STATUS_OVF_OVERFLOW)

#define DL_MATHACL_STATUS_OVF_MASK                    (MATHACL_STATUS_OVF_MASK)

#define DL_MATHACL_STATUS_ERR_DIVBY0                (MATHACL_STATUS_ERR_DIVBY0)

#define DL_MATHACL_STATUS_ERR_MASK                    (MATHACL_STATUS_ERR_MASK)

#define DL_MathACL_startSinCosOperation(MATHACL, config, op)    DL_MathACL_configOperation(MATHACL, config, op, 0)

#define DL_MathACL_startArcTan2Operation(MATHACL, config, x, y)    DL_MathACL_configOperation(MATHACL, config, x, y)

#define DL_MathACL_startArcTanOperation(MATHACL, config, x)    DL_MathACL_configOperation(MATHACL, config, x, 0)

#define DL_MathACL_startDivOperation(MATHACL, config, num, den)    DL_MathACL_configOperation(MATHACL, config, num, den)

#define DL_MathACL_startSqrtOperation(MATHACL, config, sqrt)    DL_MathACL_configOperation(MATHACL, config, sqrt, 0)

#define DL_MathACL_startMpyOperation(MATHACL, config, multicand, multiplier)    DL_MathACL_configOperation(MATHACL, config, multicand, multiplier)

/* clang-format on */

typedef enum {
    DL_MATHACL_OP_TYPE_SINCOS = MATHACL_CTL_FUNC_SINCOS,
    DL_MATHACL_OP_TYPE_ARCTAN2 = MATHACL_CTL_FUNC_ATAN2,
    DL_MATHACL_OP_TYPE_DIV = MATHACL_CTL_FUNC_DIV,
    DL_MATHACL_OP_TYPE_SQRT = MATHACL_CTL_FUNC_SQRT,
    DL_MATHACL_OP_TYPE_MPY_32 = MATHACL_CTL_FUNC_MPY32,
    DL_MATHACL_OP_TYPE_SQUARE_32 = MATHACL_CTL_FUNC_SQUARE32,
    DL_MATHACL_OP_TYPE_MPY_64 = MATHACL_CTL_FUNC_MPY64,
    DL_MATHACL_OP_TYPE_SQUARE_64 = MATHACL_CTL_FUNC_SQUARE64,
    DL_MATHACL_OP_TYPE_MAC = MATHACL_CTL_FUNC_MAC,
    DL_MATHACL_OP_TYPE_SAC = MATHACL_CTL_FUNC_SAC,
} DL_MATHACL_OP_TYPE;

typedef enum {
    DL_MATHACL_Q_TYPE_Q0 = MATHACL_CTL_QVAL_Q0,
    DL_MATHACL_Q_TYPE_Q1 = MATHACL_CTL_QVAL_Q1,
    DL_MATHACL_Q_TYPE_Q2 = MATHACL_CTL_QVAL_Q2,
    DL_MATHACL_Q_TYPE_Q3 = MATHACL_CTL_QVAL_Q3,
    DL_MATHACL_Q_TYPE_Q4 = MATHACL_CTL_QVAL_Q4,
    DL_MATHACL_Q_TYPE_Q5 = MATHACL_CTL_QVAL_Q5,
    DL_MATHACL_Q_TYPE_Q6 = MATHACL_CTL_QVAL_Q6,
    DL_MATHACL_Q_TYPE_Q7 = MATHACL_CTL_QVAL_Q7,
    DL_MATHACL_Q_TYPE_Q8 = MATHACL_CTL_QVAL_Q8,
    DL_MATHACL_Q_TYPE_Q9 = MATHACL_CTL_QVAL_Q9,
    DL_MATHACL_Q_TYPE_Q10 = MATHACL_CTL_QVAL_Q10,
    DL_MATHACL_Q_TYPE_Q11 = MATHACL_CTL_QVAL_Q11,
    DL_MATHACL_Q_TYPE_Q12 = MATHACL_CTL_QVAL_Q12,
    DL_MATHACL_Q_TYPE_Q13 = MATHACL_CTL_QVAL_Q13,
    DL_MATHACL_Q_TYPE_Q14 = MATHACL_CTL_QVAL_Q14,
    DL_MATHACL_Q_TYPE_Q15 = MATHACL_CTL_QVAL_Q15,
    DL_MATHACL_Q_TYPE_Q16 = MATHACL_CTL_QVAL_Q16,
    DL_MATHACL_Q_TYPE_Q17 = MATHACL_CTL_QVAL_Q17,
    DL_MATHACL_Q_TYPE_Q18 = MATHACL_CTL_QVAL_Q18,
    DL_MATHACL_Q_TYPE_Q19 = MATHACL_CTL_QVAL_Q19,
    DL_MATHACL_Q_TYPE_Q20 = MATHACL_CTL_QVAL_Q20,
    DL_MATHACL_Q_TYPE_Q21 = MATHACL_CTL_QVAL_Q21,
    DL_MATHACL_Q_TYPE_Q22 = MATHACL_CTL_QVAL_Q22,
    DL_MATHACL_Q_TYPE_Q23 = MATHACL_CTL_QVAL_Q23,
    DL_MATHACL_Q_TYPE_Q24 = MATHACL_CTL_QVAL_Q24,
    DL_MATHACL_Q_TYPE_Q25 = MATHACL_CTL_QVAL_Q25,
    DL_MATHACL_Q_TYPE_Q26 = MATHACL_CTL_QVAL_Q26,
    DL_MATHACL_Q_TYPE_Q27 = MATHACL_CTL_QVAL_Q27,
    DL_MATHACL_Q_TYPE_Q28 = MATHACL_CTL_QVAL_Q28,
    DL_MATHACL_Q_TYPE_Q29 = MATHACL_CTL_QVAL_Q29,
    DL_MATHACL_Q_TYPE_Q30 = MATHACL_CTL_QVAL_Q30,
    DL_MATHACL_Q_TYPE_Q31 = MATHACL_CTL_QVAL_Q31,
} DL_MATHACL_Q_TYPE;

typedef enum {
    DL_MATHACL_OPSIGN_UNSIGNED = MATHACL_CTL_OPTYPE_UNSIGNED,
    DL_MATHACL_OPSIGN_SIGNED = MATHACL_CTL_OPTYPE_SIGNED,
} DL_MATHACL_OPSIGN;

typedef struct {
    DL_MATHACL_OP_TYPE opType;
    DL_MATHACL_OPSIGN opSign;
    uint32_t iterations;
    uint32_t scaleFactor;
    DL_MATHACL_Q_TYPE qType;
} DL_MathACL_operationConfig;

__STATIC_INLINE void DL_MathACL_enablePower(MATHACL_Regs *mathacl)
{
    mathacl->GPRCM.PWREN =
        MATHACL_PWREN_KEY_UNLOCK_W | MATHACL_PWREN_ENABLE_ENABLE;
}

__STATIC_INLINE void DL_MathACL_disablePower(MATHACL_Regs *mathacl)
{
    mathacl->GPRCM.PWREN =
        MATHACL_PWREN_KEY_UNLOCK_W | MATHACL_PWREN_ENABLE_DISABLE;
}

__STATIC_INLINE bool DL_MathACL_isPowerEnabled(MATHACL_Regs *mathacl)
{
    return ((mathacl->GPRCM.PWREN & MATHACL_PWREN_ENABLE_MASK) ==
            MATHACL_PWREN_ENABLE_ENABLE);
}

__STATIC_INLINE void DL_MathACL_reset(MATHACL_Regs *mathacl)
{
    mathacl->GPRCM.RSTCTL =
        MATHACL_RSTCTL_RESETASSERT_ASSERT | MATHACL_RSTCTL_KEY_UNLOCK_W;
}

__STATIC_INLINE bool DL_MathACL_isReset(const MATHACL_Regs *mathacl)
{
    return (mathacl->GPRCM.STAT & MATHACL_STAT_RESETSTKY_MASK) ==
           MATHACL_STAT_RESETSTKY_RESET;
}

__STATIC_INLINE void DL_MathACL_enableSaturation(MATHACL_Regs *mathacl)
{
    mathacl->CTL |= MATHACL_CTL_SATEN_ENABLE;
}

__STATIC_INLINE void DL_MathACL_disableSaturation(MATHACL_Regs *mathacl)
{
    mathacl->CTL &= ~(MATHACL_CTL_SATEN_MASK);
}

__STATIC_INLINE bool DL_MathACL_isSaturationEnabled(
    const MATHACL_Regs *mathacl)
{
    return (
        (mathacl->CTL & MATHACL_CTL_SATEN_MASK) == MATHACL_CTL_SATEN_ENABLE);
}

__STATIC_INLINE void DL_MathACL_setOperandOne(
    MATHACL_Regs *mathacl, uint32_t op)
{
    mathacl->OP1 = op;
}

__STATIC_INLINE void DL_MathACL_setOperandTwo(
    MATHACL_Regs *mathacl, uint32_t op)
{
    mathacl->OP2 = op;
}

__STATIC_INLINE uint32_t DL_MathACL_getResultOne(const MATHACL_Regs *mathacl)
{
    return mathacl->RES1;
}

__STATIC_INLINE uint32_t DL_MathACL_getResultTwo(const MATHACL_Regs *mathacl)
{
    return mathacl->RES2;
}

__STATIC_INLINE uint32_t DL_MathACL_getStatus(const MATHACL_Regs *mathacl)
{
    return mathacl->STATUS;
}

__STATIC_INLINE void DL_MathACL_clearOverflowStatus(MATHACL_Regs *mathacl)
{
    mathacl->STATUSCLR |= MATHACL_STATUSCLR_CLR_OVF_CLR;
}

__STATIC_INLINE void DL_MathACL_clearUnderflowStatus(MATHACL_Regs *mathacl)
{
    mathacl->STATUSCLR |= MATHACL_STATUSCLR_CLR_UF_CLR;
}

__STATIC_INLINE void DL_MathACL_clearErrorStatus(MATHACL_Regs *mathacl)
{
    mathacl->STATUSCLR |= MATHACL_STATUSCLR_CLR_ERR_CLR;
}

__STATIC_INLINE void DL_MathACL_waitForOperation(const MATHACL_Regs *mathacl)
{
    while ((mathacl->STATUS & MATHACL_STATUS_BUSY_MASK) ==
           MATHACL_STATUS_BUSY_NOTDONE) {
        ;
    }
}

void DL_MathACL_configOperation(MATHACL_Regs *mathacl,
    const DL_MathACL_operationConfig *opConfig, uint32_t op1, uint32_t op2);

__STATIC_INLINE void DL_MathACL_clearResultOne(MATHACL_Regs *mathacl)
{
    mathacl->RES1 = 0;
}

__STATIC_INLINE void DL_MathACL_clearResultTwo(MATHACL_Regs *mathacl)
{
    mathacl->RES2 = 0;
}

__STATIC_INLINE void DL_MathACL_clearResults(MATHACL_Regs *mathacl)
{
    mathacl->RES1 = 0;
    mathacl->RES2 = 0;
}

#ifdef __cplusplus
}
#endif

#endif /* __MSPM0_HAS_MATHACL__ */

#endif /* ti_dl_mathacl__include */