mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-10-30 20:51:41 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			72 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			72 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD
 | |
|  *
 | |
|  * SPDX-License-Identifier: Apache-2.0
 | |
|  */
 | |
| 
 | |
| #pragma once
 | |
| 
 | |
| #include "esp_crypto_dma.h"
 | |
| #include "esp_private/gdma.h"
 | |
| #include "esp_err.h"
 | |
| #include "soc/lldesc.h"
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| extern "C" {
 | |
| #endif
 | |
| 
 | |
| /**
 | |
|  * @brief Start a GDMA transfer on the shared crypto DMA channel
 | |
|  *        Only supports AHB-DMA.
 | |
|  *
 | |
|  * @note Will allocate a GDMA channel for AES & SHA if no such channel is already allocated
 | |
|  *
 | |
|  * @param input Input linked list descriptor (lldesc_t *)
 | |
|  * @param output Output linked list descriptor (lldesc_t *)
 | |
|  * @param peripheral Crypto peripheral to connect the DMA to, either GDMA_TRIG_PERIPH_AES or
 | |
|  *                   GDMA_TRIG_PERIPH_SHA
 | |
|  * @return esp_err_t ESP_FAIL if no GDMA channel available
 | |
|  */
 | |
| esp_err_t esp_crypto_shared_gdma_start(const lldesc_t *input, const lldesc_t *output, gdma_trigger_peripheral_t peripheral) __attribute__((deprecated("use esp_crypto_shared_gdma_start_axi_ahb instead")));
 | |
| 
 | |
| /**
 | |
|  * @brief Start a GDMA transfer on the shared crypto DMA channel
 | |
|  *        Supports AXI-DMA and AHB-DMA.
 | |
|  *
 | |
|  * @note Will allocate a GDMA channel for AES & SHA if no such channel is already allocated
 | |
|  *
 | |
|  * @param input Input linked list descriptor (crypto_dma_desc_t *)
 | |
|  * @param output Output linked list descriptor (crypto_dma_desc_t *)
 | |
|  * @param peripheral Crypto peripheral to connect the DMA to, either GDMA_TRIG_PERIPH_AES or
 | |
|  *                   GDMA_TRIG_PERIPH_SHA
 | |
|  * @return esp_err_t ESP_FAIL if no GDMA channel available
 | |
|  */
 | |
| esp_err_t esp_crypto_shared_gdma_start_axi_ahb(const crypto_dma_desc_t *input, const crypto_dma_desc_t *output, gdma_trigger_peripheral_t peripheral);
 | |
| 
 | |
| #if SOC_AXI_GDMA_SUPPORTED
 | |
| /**
 | |
|  * @brief Busy wait until GDMA RX data transfer is complete
 | |
|  *
 | |
|  * @return true, when GDMA RX data transfer is complete
 | |
|  */
 | |
| bool esp_crypto_shared_gdma_done(void);
 | |
| #endif /* SOC_AXI_GDMA_SUPPORTED */
 | |
| 
 | |
| /**
 | |
|  * @brief Frees any shared crypto DMA channel, if esp_crypto_shared_gdma_start is called after
 | |
|  *        this, new GDMA channels will be allocated.
 | |
|  *
 | |
|  * @note Function is meant to be called from user code, and thus takes AES/SHA lock.
 | |
|  *       This means this function should not be called from code which already takes these locks,
 | |
|  *       i.e. inside our AES/SHA code.
 | |
|  *
 | |
|  *       If you are continously using AES/SHA (e.g. because of a wifi connection) then it's not recommended
 | |
|  *       to use this API. Freeing the channel is mainly for use cases where you are finished with the crypto peripherals
 | |
|  *       and need the DMA channel for other peripherals. An example would be doing some processing after disconnecting WiFi
 | |
|  */
 | |
| void esp_crypto_shared_gdma_free(void);
 | |
| 
 | |
| #ifdef __cplusplus
 | |
| }
 | |
| #endif
 | 
