mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
84 lines
2.1 KiB
C
84 lines
2.1 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "esp_err.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief This function initializes the OpenThread API lock.
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NO_MEM if allocation has failed
|
|
* - ESP_ERR_INVALID_STATE if already initialized
|
|
*
|
|
*/
|
|
esp_err_t esp_openthread_lock_init(void);
|
|
|
|
/**
|
|
* This function deinitializes the OpenThread API lock.
|
|
*
|
|
*/
|
|
void esp_openthread_lock_deinit(void);
|
|
|
|
/**
|
|
* @brief This function acquires the OpenThread API lock.
|
|
*
|
|
* @note Every OT APIs that takes an otInstance argument MUST be protected with this API lock
|
|
* except that the call site is in OT callbacks.
|
|
*
|
|
* @param[in] block_ticks The maxinum number of RTOS ticks to wait for the lock.
|
|
*
|
|
* @return
|
|
* - True on lock acquired
|
|
* - False on failing to acquire the lock with the timeout.
|
|
*
|
|
*/
|
|
bool esp_openthread_lock_acquire(TickType_t block_ticks);
|
|
|
|
/**
|
|
* @brief This function releases the OpenThread API lock.
|
|
*
|
|
*/
|
|
void esp_openthread_lock_release(void);
|
|
|
|
/**
|
|
* @brief This function acquires the OpenThread API task switching lock.
|
|
*
|
|
* @note In OpenThread API context, it waits for some actions to be done in other tasks (like lwip),
|
|
* after task switching, it needs to call OpenThread API again. Normally it's not allowed,
|
|
* since the previous OpenThread API lock is not released yet. This task_switching lock allows
|
|
* the OpenThread API can be called in this case.
|
|
*
|
|
* @note Please use esp_openthread_lock_acquire() for normal cases.
|
|
*
|
|
* @param[in] block_ticks The maxinum number of RTOS ticks to wait for the lock.
|
|
*
|
|
* @return
|
|
* - True on lock acquired
|
|
* - False on failing to acquire the lock with the timeout.
|
|
*
|
|
*/
|
|
bool esp_openthread_task_switching_lock_acquire(TickType_t block_ticks);
|
|
|
|
/**
|
|
* @brief This function releases the OpenThread API task switching lock.
|
|
*
|
|
*/
|
|
void esp_openthread_task_switching_lock_release(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|