dl_factoryregion.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_factoryregion.h
 *  @brief      Factory Region Driver Library
 *  @defgroup   FACTORYREGION Factory Region (FACTORYREGION)
 *
 *  @anchor ti_dl_dl_factoryregion_Overview
 *  # Overview
 *
 *  <hr>
 ******************************************************************************
 */
#ifndef ti_dl_dl_factoryregion__include
#define ti_dl_dl_factoryregion__include

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

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

#ifdef __cplusplus
extern "C" {
#endif

/* clang-format off */

/* clang-format on */

__STATIC_INLINE uint16_t DL_FactoryRegion_getMAINFlashSize(void)
{
    return (
        FACTORYREGION->SRAMFLASH & FACTORYREGION_SRAMFLASH_MAINFLASH_SZ_MASK);
}

__STATIC_INLINE uint16_t DL_FactoryRegion_getSRAMFlashSize(void)
{
    return (
        (FACTORYREGION->SRAMFLASH & FACTORYREGION_SRAMFLASH_SRAM_SZ_MASK) >>
        FACTORYREGION_SRAMFLASH_SRAM_SZ_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getDATAFlashSize(void)
{
    return ((FACTORYREGION->SRAMFLASH &
                FACTORYREGION_SRAMFLASH_DATAFLASH_SZ_MASK) >>
            FACTORYREGION_SRAMFLASH_DATAFLASH_SZ_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getNumBanks(void)
{
    return (((FACTORYREGION->SRAMFLASH &
                 FACTORYREGION_SRAMFLASH_MAINNUMBANKS_MASK) >>
                FACTORYREGION_SRAMFLASH_MAINNUMBANKS_OFS) +
            (uint8_t) 1);
}

__STATIC_INLINE uint32_t DL_FactoryRegion_getTraceID(void)
{
    return (FACTORYREGION->TRACEID & FACTORYREGION_TRACEID_DATA_MASK);
}

__STATIC_INLINE uint16_t DL_FactoryRegion_getManufacturerCode(void)
{
    return (
        (FACTORYREGION->DEVICEID & FACTORYREGION_DEVICEID_MANUFACTURER_MASK) >>
        FACTORYREGION_DEVICEID_MANUFACTURER_OFS);
}

__STATIC_INLINE uint16_t DL_FactoryRegion_getPartNumber(void)
{
    return ((FACTORYREGION->DEVICEID & FACTORYREGION_DEVICEID_PARTNUM_MASK) >>
            FACTORYREGION_DEVICEID_PARTNUM_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getVersion(void)
{
    return ((FACTORYREGION->DEVICEID & FACTORYREGION_DEVICEID_VERSION_MASK) >>
            FACTORYREGION_DEVICEID_VERSION_OFS);
}

__STATIC_INLINE uint16_t DL_FactoryRegion_getUserIDPart(void)
{
    return ((FACTORYREGION->USERID & FACTORYREGION_USERID_PART_MASK) >>
            FACTORYREGION_USERID_PART_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getUserIDVariant(void)
{
    return ((FACTORYREGION->USERID & FACTORYREGION_USERID_VARIANT_MASK) >>
            FACTORYREGION_USERID_VARIANT_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getUserIDMinorRev(void)
{
    return ((FACTORYREGION->USERID & FACTORYREGION_USERID_MINORREV_MASK) >>
            FACTORYREGION_USERID_MINORREV_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getUserIDMajorRev(void)
{
    return ((FACTORYREGION->USERID & FACTORYREGION_USERID_MAJORREV_MASK) >>
            FACTORYREGION_USERID_MAJORREV_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinUARTRXDPad(void)
{
    return ((FACTORYREGION->BSLPIN_UART &
                FACTORYREGION_BSLPIN_UART_UART_RXD_PAD_MASK) >>
            FACTORYREGION_BSLPIN_UART_UART_RXD_PAD_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinUARTRXDFunction(void)
{
    return ((FACTORYREGION->BSLPIN_UART &
                FACTORYREGION_BSLPIN_UART_UART_RXD_PF_MASK) >>
            FACTORYREGION_BSLPIN_UART_UART_RXD_PF_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinUARTTXDPad(void)
{
    return ((FACTORYREGION->BSLPIN_UART &
                FACTORYREGION_BSLPIN_UART_UART_TXD_PAD_MASK) >>
            FACTORYREGION_BSLPIN_UART_UART_TXD_PAD_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinUARTTXDFunction(void)
{
    return ((FACTORYREGION->BSLPIN_UART &
                FACTORYREGION_BSLPIN_UART_UART_TXD_PF_MASK) >>
            FACTORYREGION_BSLPIN_UART_UART_TXD_PF_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinI2CSDAPad(void)
{
    return ((FACTORYREGION->BSLPIN_I2C &
                FACTORYREGION_BSLPIN_I2C_I2C_SDA_PAD_MASK) >>
            FACTORYREGION_BSLPIN_I2C_I2C_SDA_PAD_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinI2CSDAFunction(void)
{
    return ((FACTORYREGION->BSLPIN_I2C &
                FACTORYREGION_BSLPIN_I2C_I2C_SDA_PF_MASK) >>
            FACTORYREGION_BSLPIN_I2C_I2C_SDA_PF_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinI2CSCLPad(void)
{
    return ((FACTORYREGION->BSLPIN_I2C &
                FACTORYREGION_BSLPIN_I2C_I2C_SCL_PAD_MASK) >>
            FACTORYREGION_BSLPIN_I2C_I2C_SCL_PAD_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinI2CSCLFunction(void)
{
    return ((FACTORYREGION->BSLPIN_I2C &
                FACTORYREGION_BSLPIN_I2C_I2C_SCL_PF_MASK) >>
            FACTORYREGION_BSLPIN_I2C_I2C_SCL_PF_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinInvokeGPIOLevel(void)
{
    return ((FACTORYREGION->BSLPIN_INVOKE &
                FACTORYREGION_BSLPIN_INVOKE_GPIO_LEVEL_MASK) >>
            FACTORYREGION_BSLPIN_INVOKE_GPIO_LEVEL_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinInvokeGPIOPin(void)
{
    return ((FACTORYREGION->BSLPIN_INVOKE &
                FACTORYREGION_BSLPIN_INVOKE_GPIO_PIN_SEL_MASK) >>
            FACTORYREGION_BSLPIN_INVOKE_GPIO_PIN_SEL_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinInvokeGPIOPModule(void)
{
    return ((FACTORYREGION->BSLPIN_INVOKE &
                FACTORYREGION_BSLPIN_INVOKE_GPIO_REG_SEL_MASK) >>
            FACTORYREGION_BSLPIN_INVOKE_GPIO_REG_SEL_OFS);
}

__STATIC_INLINE uint8_t DL_FactoryRegion_getBSLPinInvokeGPIOPModulePad(void)
{
    return ((FACTORYREGION->BSLPIN_INVOKE &
                FACTORYREGION_BSLPIN_INVOKE_BSL_PAD_MASK) >>
            FACTORYREGION_BSLPIN_INVOKE_BSL_PAD_OFS);
}

__STATIC_INLINE uint32_t DL_FactoryRegion_getTemperatureVoltage(void)
{
    return (
        (FACTORYREGION->TEMP_SENSE0 & FACTORYREGION_TEMP_SENSE0_DATA_MASK) >>
        FACTORYREGION_TEMP_SENSE0_DATA_OFS);
}

__STATIC_INLINE uint32_t DL_FactoryRegion_getBOOTCRCData(void)
{
    return ((FACTORYREGION->BOOTCRC & FACTORYREGION_BOOTCRC_DATA_MASK) >>
            FACTORYREGION_BOOTCRC_DATA_OFS);
}

#ifdef __cplusplus
}
#endif

#endif /* ti_dl_dl_factoryregion__include */