feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'bugfix/esp_srp_doc' into 'master'

Browse Source 
fix(esp_srp): Use `@file` for file documentation and resolved few doc build warnings

Closes IDF-8737

See merge request espressif/esp-idf!27411
This commit is contained in:
Aditya Patwardhan
2023-12-18 19:31:05 +08:00
parent 0e759c6deb 40adf0bfcd
commit 21e1a48a62
5 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
components/esp_common/include/esp_err.h
View File

@@ -79,7 +79,6 @@ const char *esp_err_to_name_r(esp_err_t code, char *buf, size_t buflen);
/** @cond */ /** @cond */
void _esp_error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression) __attribute__((__noreturn__)); void _esp_error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression) __attribute__((__noreturn__));
/** @cond */
void _esp_error_check_failed_without_abort(esp_err_t rc, const char *file, int line, const char *function, const char *expression); void _esp_error_check_failed_without_abort(esp_err_t rc, const char *file, int line, const char *function, const char *expression);
#ifndef __ASSERT_FUNC #ifndef __ASSERT_FUNC

2
components/esp_driver_i2c/include/driver/i2c_types.h
View File

@@ -85,7 +85,7 @@ typedef struct {
* *
* @param[in] i2c_slave Handle for I2C slave. * @param[in] i2c_slave Handle for I2C slave.
* @param[out] evt_data I2C capture event data, fed by driver * @param[out] evt_data I2C capture event data, fed by driver
* @param[in] user_ctx User data, set in `i2c_slave_register_event_callbacks()` * @param[in] arg User data, set in `i2c_slave_register_event_callbacks()`
* *
* @return Whether a high priority task has been waken up by this function * @return Whether a high priority task has been waken up by this function
*/ */

6
components/esp_wifi/include/esp_wifi_crypto_types.h
View File

@@ -134,7 +134,7 @@ typedef int (*esp_sha256_prf_t)(const unsigned char *key, int key_len, const cha
* *
* @param key Key for HMAC operations * @param key Key for HMAC operations
* @param key_len Length of the key in bytes * @param key_len Length of the key in bytes
* @param dataPointers to the data area * @param data Pointers to the data area
* @param data_len Length of the data area * @param data_len Length of the data area
* @param mac Buffer for the hash (16 bytes) * @param mac Buffer for the hash (16 bytes)
* Returns: 0 on success, -1 on failure * Returns: 0 on success, -1 on failure
@@ -327,7 +327,7 @@ typedef int (*esp_omac1_aes_128_t)(const uint8_t *key, const uint8_t *data, size
* Counter Mode Cipher Block Chaining Message Authentication * Counter Mode Cipher Block Chaining Message Authentication
* Code Protocol) which is used in IEEE 802.11i RSN standard. * Code Protocol) which is used in IEEE 802.11i RSN standard.
* @param tk 128-bit Temporal Key for obtained during 4-way handshake * @param tk 128-bit Temporal Key for obtained during 4-way handshake
* @param hdr Pointer to IEEE802.11 frame headeri needed for AAD * @param ieee80211_hdr Pointer to IEEE802.11 frame headeri needed for AAD
* @param data Pointer to encrypted data buffer * @param data Pointer to encrypted data buffer
* @param data_len Encrypted data length in bytes * @param data_len Encrypted data length in bytes
* @param decrypted_len Length of decrypted data * @param decrypted_len Length of decrypted data
@@ -373,7 +373,7 @@ typedef int (*esp_aes_gmac_t)(const uint8_t *key, size_t keylen, const uint8_t *
* @param num_elem Number of elements in the data vector * @param num_elem Number of elements in the data vector
* @param addr Pointers to the data areas * @param addr Pointers to the data areas
* @param len Lengths of the data blocks * @param len Lengths of the data blocks
* @param mac Buffer for the hash * @param buf Buffer for the hash
* Returns: 0 on success, -1 on failure * Returns: 0 on success, -1 on failure
*/ */
typedef int (*esp_sha256_vector_t)(size_t num_elem, const uint8_t *addr[], const size_t *len, uint8_t *buf); typedef int (*esp_sha256_vector_t)(size_t num_elem, const uint8_t *addr[], const size_t *len, uint8_t *buf);

2
components/esp_wifi/lib

Submodule components/esp_wifi/lib updated: eb14a403c8...0105d2a2df

8
components/protocomm/include/crypto/srp6a/esp_srp.h
View File

@@ -13,6 +13,7 @@ extern "C" {
#endif #endif
/** /**
* @file esp_srp.h
* @brief SRP-6a protocol implementation * @brief SRP-6a protocol implementation
* *
* More information on protocol can be found: https://datatracker.ietf.org/doc/html/rfc5054 * More information on protocol can be found: https://datatracker.ietf.org/doc/html/rfc5054
@@ -98,6 +99,13 @@ typedef enum {
ESP_NG_3072 = 0, ESP_NG_3072 = 0,
} esp_ng_type_t; } esp_ng_type_t;
/**
* @brief esp_srp handle as the result of `esp_srp_init`
*
* The handle is returned by `esp_srp_init` on successful init. It is then
* passed for subsequent API calls as an argument. `esp_srp_free` can be used to
* clean up the handle. After `esp_srp_free` the handle becomes invalid.
*/
typedef struct esp_srp_handle esp_srp_handle_t; typedef struct esp_srp_handle esp_srp_handle_t;
/** /**