TiagoRG
/
it2s-itss-facilities
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

proper documentation of the evm functions

This commit is contained in:
gilteixeira 2023-04-14 20:19:44 +01:00
parent f7c787ba1e
commit a2a45cf1da
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/evm.h
View File

@ -21,9 +21,15 @@ enum EVM_CHECK_R {
/* /*
* @brief Analyzes a received EVCSNM * @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); 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); 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. * @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 * @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); static int evrsrm_pre_reservation_response(uint8_t *evrsrm_oer, uint32_t *evrsrm_len);
/** /**
* Analyses a evm * Analyses a evcsnm
* @param evm The evm to be analyzed * @param evcsnm The evcsnm to be analyzed
* @return 0 on success, other value otherwise * @return 0 on success, other value otherwise
*/ */
int evcsnm_check(EvcsnPdu_t* evcsnm); 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); int evrsrm_check(EV_RSR_t *evrsrm);
typedef struct evm_args { typedef struct evm_args {