Outline ![]()
Files ![]()
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/esp_hw_support/include/esp_private/esp_gpio_reserve.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/*
* SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Background:
*
* - On some **modules**, specific GPIOs are connected to the PSRAM or Flash, and they shouldn't be used as general purpose IOs in the user's projects.
* - Some GPIO may be not fan-out in the SiP variant.
* - GPIO A is driven by peripheral M, we don't want peripheral N to use the same GPIO.
* - User may deliver a board where a GPIO is used for a special purpose or even not fan-out on the PCB, they want to reserve it in the BSP package.
* ...
*/
/**
* Usage Attention:
*
* - If a GPIO is used by IO MUX, no matter it's used as Input or Output, we should reserve it, because IO MUX's different "FUNC" has its dedicated peripheral.
* - If a GPIO is used by Matrix, and only use its output path, we should reserve it, because we can't bind multiple peripheral output signals to the same GPIO.
* - When doing GPIO reserve, we must check its return value, to ensure the same GPIO is not reserved already.
*/
#pragma once
#include "esp_types.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Reserve the given GPIOs by mask, so they can't be used by others
*
* @param gpio_mask Mask of the GPIOs to be reserved
* @return The mask of the GPIOs that were already reserved before this call
*/
uint64_t esp_gpio_reserve(uint64_t gpio_mask);
/**
* @brief Revoke the given GPIOs by mask, so they can be reused again by others
*
* @param gpio_mask Mask of the GPIOs to be revoked
* @return The mask of the GPIOs that were already reserved before this call
*/
uint64_t esp_gpio_revoke(uint64_t gpio_mask);
/**
* @brief Check whether the given GPIOs are reserved
*
* @param gpio_mask Mask of the GPIOs to be checked
* @return
* - true Any of the given GPIO(s) is reserved
* - false Any of the given GPIO(s) is not reserved
*/
bool esp_gpio_is_reserved(uint64_t gpio_mask);
#ifdef __cplusplus
}
#endif
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.