owner-nrf52sdk/nRF5_SDK_15.3.0/modules/nrfx/hal/nrf_temp.h

/**
 * Copyright (c) 2012 - 2018, Nordic Semiconductor ASA
 *
 * 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, except as embedded into a Nordic
 *    Semiconductor ASA integrated circuit in a product or a software update for
 *    such product, 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 Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 *    engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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 NRF_TEMP_H__
#define NRF_TEMP_H__

#include <nrfx.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
* @defgroup nrf_temp_hal TEMP HAL
* @{
* @ingroup nrf_temp temperature_example
* @brief   Temperature module init and read functions.
*/

#define MASK_SIGN           (0x00000200UL)
#define MASK_SIGN_EXTENSION (0xFFFFFC00UL)

	/**
 * @brief temperature measurement converter tasks.
 */
typedef enum /*lint -save -e30 -esym(628,__INTADDR__) */
{
	NRF_TEMP_TASK_START           = offsetof(NRF_TEMP_Type, TASKS_START),           ///< Start the TEMP and prepare the result buffer in RAM.
	NRF_TEMP_TASK_STOP            = offsetof(NRF_TEMP_Type, TASKS_STOP),            ///< Stop the TEMP and terminate any on-going conversion.
} nrf_temp_task_t;


/**
 * @brief temperature measurement converter events.
 */
typedef enum /*lint -save -e30 -esym(628,__INTADDR__) */
{
	NRF_TEMP_EVENT_DATARDY       = offsetof(NRF_TEMP_Type, EVENTS_DATARDY),       ///< Temperature measurement complete, data ready.
} nrf_temp_event_t;

/**
 * @brief temperature measurement converter interrupt masks.
 */
typedef enum
{
    NRF_TEMP_INT_DATARDY       = TEMP_INTENSET_DATARDY_Msk,       ///< Interrupt on EVENTS_STARTED event.
} nrf_temp_int_mask_t;

/**
 * @brief Function for preparing the temp module for temperature measurement.
 *
 * This function initializes the TEMP module and writes to the hidden configuration register.
 */
static __INLINE void nrf_temp_init(void)
{
    /**@note Workaround for PAN_028 rev2.0A anomaly 31 - TEMP: Temperature offset value has to be manually loaded to the TEMP module */
    *(uint32_t *) 0x4000C504 = 0;
}

/**
 * @brief Function for triggering a specific TEMP task.
 *
 * @param[in] temp_task TEMP task.
 */
__STATIC_INLINE void nrf_temp_task_trigger(nrf_temp_task_t temp_task)
{
    *((volatile uint32_t *)((uint8_t *)NRF_TEMP + (uint32_t)temp_task)) = 0x1UL;
}

/**
 * @brief Function for getting the address of a specific TEMP task register.
 *
 * @param[in] temp_task TEMP task.
 *
 * @return Address of the specified TEMP task.
 */
__STATIC_INLINE uint32_t nrf_temp_task_address_get(nrf_temp_task_t temp_task)
{
    return (uint32_t)((uint8_t *)NRF_TEMP + (uint32_t)temp_task);
}

/**
 * @brief Function for getting the state of a specific TEMP event.
 *
 * @param[in] temp_event TEMP event.
 *
 * @return State of the specified TEMP event.
 */
__STATIC_INLINE bool nrf_temp_event_check(nrf_temp_event_t temp_event)
{
    return (bool)*(volatile uint32_t *)((uint8_t *)NRF_TEMP + (uint32_t)temp_event);
}


/**
 * @brief Function for clearing the specific TEMP event.
 *
 * @param[in] temp_event TEMP event.
 */
__STATIC_INLINE void nrf_temp_event_clear(nrf_temp_event_t temp_event)
{
    *((volatile uint32_t *)((uint8_t *)NRF_TEMP + (uint32_t)temp_event)) = 0x0UL;
#if __CORTEX_M == 0x04
    volatile uint32_t dummy = *((volatile uint32_t *)((uint8_t *)NRF_TEMP + (uint32_t)temp_event));
    (void)dummy;
#endif
}

/**
 * @brief Function for getting the address of a specific TEMP event register.
 *
 * @param[in] temp_event TEMP event.
 *
 * @return Address of the specified TEMP event.
 */
__STATIC_INLINE uint32_t  nrf_temp_event_address_get(nrf_temp_event_t temp_event)
{
    return (uint32_t )((uint8_t *)NRF_TEMP + (uint32_t)temp_event);
}

/**
 * @brief Function for enabling specified TEMP interrupts.
 *
 * @param[in] temp_int_mask Interrupt(s) to enable.
 */
__STATIC_INLINE void nrf_temp_int_enable(uint32_t temp_int_mask)
{
    NRF_TEMP->INTENSET = temp_int_mask;
}


/**
 * @brief Function for retrieving the state of specified TEMP interrupts.
 *
 * @param[in] temp_int_mask Interrupt(s) to check.
 *
 * @retval true  If all specified interrupts are enabled.
 * @retval false If at least one of the given interrupts is not enabled.
 */
__STATIC_INLINE bool nrf_temp_int_enable_check(uint32_t temp_int_mask)
{
    return (bool)(NRF_TEMP->INTENSET & temp_int_mask);
}


/**
 * @brief Function for disabling specified interrupts.
 *
 * @param temp_int_mask Interrupt(s) to disable.
 */
__STATIC_INLINE void nrf_temp_int_disable(uint32_t temp_int_mask)
{
    NRF_TEMP->INTENCLR = temp_int_mask;
}

/** @} */

#ifdef __cplusplus
}
#endif

#endif