smtc_hal_lp_timer.h

/*!
 * \file      smtc_hal_lp_timer.h
 *
 * \brief     Low Power Timer Hardware Abstraction Layer definition
 *
 * The Clear BSD License
 * Copyright Semtech Corporation 2021. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted (subject to the limitations in the disclaimer
 * below) 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 the Semtech corporation nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
 * THIS LICENSE. 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 SEMTECH CORPORATION 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 SMTC_HAL_LP_TIMER_H
#define SMTC_HAL_LP_TIMER_H

#ifdef __cplusplus
extern "C" {
#endif
/*
 * -----------------------------------------------------------------------------
 * --- DEPENDENCIES ------------------------------------------------------------
 */

#include <stdint.h>   // C99 types
#include <stdbool.h>  // bool type

/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC MACROS -----------------------------------------------------------
 */

/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC CONSTANTS --------------------------------------------------------
 */

/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC TYPES ------------------------------------------------------------
 */

/*!
 * \brief Low power timer ID
 */
typedef enum hal_lp_timer_id_e
{
    HAL_LP_TIMER_ID_1 = 0,
    HAL_LP_TIMER_ID_2 = 1,
} hal_lp_timer_id_t;

/*!
 * Timer IRQ handling data context
 */
typedef struct hal_lp_timer_irq_s
{
    void* context;
    void ( *callback )( void* context );
} hal_lp_timer_irq_t;

/*
 * -----------------------------------------------------------------------------
 * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
 */

/*!
 * \brief Initialize the MCU TMR peripheral
 *
 * \param [in] id Low power timer id
 */
void hal_lp_timer_init( hal_lp_timer_id_t id );

/*!
 * \brief Start the provided timer objet for the given time
 *
 * \param [in] id           Low power timer id
 * \param [in] milliseconds Number of milliseconds
 * \param [in] tmr_irq      Timer IRQ handling data ontext
 */
void hal_lp_timer_start( hal_lp_timer_id_t id, const uint32_t milliseconds, const hal_lp_timer_irq_t* tmr_irq );

/*!
 * \brief Start the provided timer objet for the given time
 *
 * \param [in] id Low power timer id
 */
void hal_lp_timer_stop( hal_lp_timer_id_t id );

/*!
 * \brief Enable timer interrupts (HW timer only)
 *
 * \param [in] id Low power timer id
 */
void hal_lp_timer_irq_enable( hal_lp_timer_id_t id );

/*!
 * \brief Disable timer interrupts (HW timer only)
 *
 * \param [in] id Low power timer id
 */
void hal_lp_timer_irq_disable( hal_lp_timer_id_t id );

#ifdef __cplusplus
}
#endif

#endif  // SMTC_HAL_LP_TIMER_H

/* --- EOF ------------------------------------------------------------------ */