ext/hal/nordic/drivers/nrf_radio_802154/nrf_802154_critical_section.h

/* Copyright (c) 2017 - 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 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.
 *
 * 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.
 *
 */

#ifndef NRF_802154_CRITICAL_SECTION_H__
#define NRF_802154_CRITICAL_SECTION_H__

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

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup nrf_802154_critical_section 802.15.4 driver critical section
 * @{
 * @ingroup nrf_802154
 * @brief Critical section used with requests to the 802.15.4 driver.
 */

/**
 * @brief Initialize critical section module.
 */
void nrf_802154_critical_section_init(void);

/**
 * @brief Enter critical section in the 802.15.4 driver.
 *
 * @note Entering critical section may be prohibited at given time. If critical section is not
 *       entered, request should not be proceeded.
 *
 * @retval true   Entered critical section.
 * @retval false  Could not enter critical section.
 */
bool nrf_802154_critical_section_enter(void);

/**
 * @brief Exit critical section in the 802.15.4 driver.
 */
void nrf_802154_critical_section_exit(void);

/**
 * @brief Forcefully enter critical section in the 802.15.4 driver.
 *
 * This function enters critical section regardless critical sections is already entered.
 *
 * This function is intended to be used by RADIO IRQ handler and RAAL notifications handlers to
 * prevent interrupting of these procedures by FSM requests from higher priority IRQ handlers.
 */
void nrf_802154_critical_section_forcefully_enter(void);

/**
 * @brief Allow entering nested critical section.
 *
 * This function is intended to be used with notification module in order to allow processing
 * requests called from notification context.
 */
void nrf_802154_critical_section_nesting_allow(void);

/**
 * @brief Disallow entering nested critical section.
 */
void nrf_802154_critical_section_nesting_deny(void);

/**
 * @brief Check if critical section is nested.
 *
 * @retval true   Critical section is nested.
 * @retval false  Critical section is not nested.
 */
bool nrf_802154_critical_section_is_nested(void);

/**
 * @brief Get current IRQ priority.
 *
 * @return IRQ priority
 */
uint32_t nrf_802154_critical_section_active_vector_priority_get(void);

/**
 * @brief Function called to enter critical section in the RSCH module.
 */
extern void nrf_802154_critical_section_rsch_enter(void);

/**
 * @brief Function called to exit critical section in the RSCH module.
 */
extern void nrf_802154_critical_section_rsch_exit(void);

/**
 * @brief Check if there is pending event in the RSCH critical section.
 */
extern bool nrf_802154_critical_section_rsch_event_is_pending(void);

/**
 *@}
 **/

#ifdef __cplusplus
}
#endif

#endif // NRF_802154_CRITICAL_SECTION_H__