From a2a45cf1dac85e8667eef4fcd1fb6842ddd31210 Mon Sep 17 00:00:00 2001 From: gilteixeira Date: Fri, 14 Apr 2023 20:19:44 +0100 Subject: [PATCH] proper documentation of the evm functions --- src/evm.h | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/src/evm.h b/src/evm.h index 3c43ac3..c58dac3 100644 --- a/src/evm.h +++ b/src/evm.h @@ -21,9 +21,15 @@ enum EVM_CHECK_R { /* * @brief Analyzes a received EVCSNM * - * @return A EVCSNM check code + * @return A EVM check code */ enum EVM_CHECK_R check_evcsnm(BTPPacketIndication_t *bpi, EvcsnPdu_t *evcsnm, uint8_t *ssp, uint32_t ssp_len); + +/* + * @brief Analyzes a received EVRSRM + * + * @return A EVM check code + */ enum EVM_CHECK_R check_evrsrm(BTPPacketIndication_t *bpi, EV_RSR_t *evrsrm, uint8_t *ssp, uint32_t ssp_len); /* @@ -44,7 +50,8 @@ int evrsrm_recv(EV_RSR_t *evrsr_request); /** * @brief Creates a pre reservation response. - * @param evrsr_request The reservation request + * @param evrsrm_oer The encoded pre reservation response + * @param evrsrm_len The length of the encoded pre reservation response * * @return The reservation response or NULL if the request isn't a Pre reservation request */ @@ -52,11 +59,17 @@ int evrsrm_recv(EV_RSR_t *evrsr_request); static int evrsrm_pre_reservation_response(uint8_t *evrsrm_oer, uint32_t *evrsrm_len); /** - * Analyses a evm - * @param evm The evm to be analyzed + * Analyses a evcsnm + * @param evcsnm The evcsnm to be analyzed * @return 0 on success, other value otherwise */ int evcsnm_check(EvcsnPdu_t* evcsnm); + +/** + * Analyses a evrsrm + * @param evrsrm The evrsrm to be analyzed + * @return 0 on success, other value otherwise + */ int evrsrm_check(EV_RSR_t *evrsrm); typedef struct evm_args {