From 43eabeeeaa993b6628e0490fbf6b78f24cee4788 Mon Sep 17 00:00:00 2001 From: Kevin Redon Date: Sun, 16 Sep 2012 18:40:02 +0200 Subject: sim: replaced function/structure comments with doxygen comments affected files: sim.h, sim/core.c affected funtions/strucutres: osim_new_apdumsg, osim_apdu_case,osim_apdu_cmd_hdr, osim_msgb_cb --- src/sim/core.c | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) (limited to 'src') diff --git a/src/sim/core.c b/src/sim/core.c index 9c1c9ae2..cbbb9f81 100644 --- a/src/sim/core.c +++ b/src/sim/core.c @@ -174,14 +174,18 @@ osim_file_find_name(struct osim_file_desc *parent, const char *name) return NULL; } -/* create an APDU header - * APDU format as defined in ISO/IEC 7816-4:2005(E) §5.1 - * - cla: CLASS byte - * - ins: INSTRUCTION byte - * - p1: Parameter 1 byte - * - p2: Parameter 2 byte - * - lc: number of bytes in the command data field Nc, which will encoded in 0, 1 or 3 bytes into Lc - * - le: maximum number of bytes expected in the response data field, which will encoded in 0, 1, 2 or 3 bytes into Le +/*! \brief Generate an APDU message and initialize APDU command header + * \param[in] cla CLASS byte + * \param[in] ins INSTRUCTION byte + * \param[in] p1 Parameter 1 byte + * \param[in] p2 Parameter 2 byte + * \param[in] lc number of bytes in the command data field Nc, which will encoded in 0, 1 or 3 bytes into Lc + * \param[in] le maximum number of bytes expected in the response data field, which will encoded in 0, 1, 2 or 3 bytes into Le + * \returns an APDU message generated using provided APDU parameters + * + * This function generates an APDU message, as defined in ISO/IEC 7816-4:2005(E) §5.1. + * The APDU command header, command and response fields lengths are initialized using the parameters. + * The APDU case is determined by the command and response fields lengths. */ struct msgb *osim_new_apdumsg(uint8_t cla, uint8_t ins, uint8_t p1, uint8_t p2, uint16_t lc, uint16_t le) -- cgit v1.2.3