From 86c4f81408a516f65e2f4d672e023ed68a055ac4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Thu, 31 Oct 2019 13:02:03 +0100 Subject: [PATCH] Improve documentation of internal function --- tinycrypt/ecc.c | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tinycrypt/ecc.c b/tinycrypt/ecc.c index 45a01dc5e5..8eaa1e7498 100644 --- a/tinycrypt/ecc.c +++ b/tinycrypt/ecc.c @@ -253,7 +253,11 @@ static void uECC_vli_rshift1(uECC_word_t *vli, wordcount_t num_words) } } -/* Compute (r2, r1, r0) = a * b + (r1, r0): +/* Compute a * b + r, where r is a double-word with high-order word r1 and + * low-order word r0, and store the result in the same double-word (r1, r0), + * with the carry bit stored in r2. + * + * (r2, r1, r0) = a * b + (r1, r0): * [in] a, b: operands to be multiplied * [in] r0, r1: low and high-order words of operand to add * [out] r0, r1: low and high-order words of the result