X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fnet%2Fkeytag.c;h=32473ceb733fd047614a8558616ad6eab82a3a7c;hb=35be7aa348f671b0ed50ee43d903444edc4892af;hp=2376305a07424ebfb4cf2c733f2a9d18ad57b924;hpb=33a94063da7261ecced063b6e8a80c2c77567cd3;p=bertos.git diff --git a/bertos/net/keytag.c b/bertos/net/keytag.c index 2376305a..32473ceb 100644 --- a/bertos/net/keytag.c +++ b/bertos/net/keytag.c @@ -31,8 +31,12 @@ * --> * * \author Andrea Grandi + * \author Daniele Basile * - * \brief Tag protocol (protocol). + * \brief KeyTAG parser. + * + * This module parse TAG message that come from comunication channel, + * and convert the tag value into string. * * TAG protocol is decribed in this way: *
@@ -85,6 +89,11 @@ void keytag_poll(struct TagPacket *pkt)
 		kfile_write(pkt->host, buf, len);
 }
 
+/**
+ * Receive the tag message from channel, and if
+ * the tag is good put the converted string into given buffer.
+ * The fuction return the len of found tag string, otherwise EOF.
+ */
 int keytag_recv(struct TagPacket *pkt, uint8_t *tag, size_t len)
 {
 	int c;