Jarda Pajskr / freemaster_lib

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   FreeMASTER_HelloWorld FreeMASTER_HelloWorld2 FreeMASTER_HelloWorld3

Fork of freemaster_lib by Jarda Pajskr

Diff: class/freemaster_class.h

Revision:
4:256c3ffc6f40
Parent:
2:1895e8ed1c25
Child:
8:17470feaa6be
--- a/class/freemaster_class.h	Wed May 14 13:43:35 2014 +0000
+++ b/class/freemaster_class.h	Wed May 14 13:47:39 2014 +0000
@@ -67,7 +67,20 @@
     void Recorder(void);
     void Poll(void);
 
-
+    /** Register variables to TSA table
+     *
+     *  @param name, type, addr, info, use following macros to register variable
+     *               FMSTR_TSA_STRUCT_CFG(name) - register structure
+     *               FMSTR_TSA_MEMBER_CFG(parenttype,name,type) - register member of structure
+     *               FMSTR_TSA_RO_VAR_CFG(name,type) - register Read Only variable
+     *               FMSTR_TSA_RW_VAR_CFG(name,type) - register variable
+     *               FMSTR_TSA_RO_MEM_CFG(name,type,addr,size) - register read only of memory block
+     *               FMSTR_TSA_RW_MEM_CFG(name,type,addr,size) - register memory block
+     *
+     *  @returns
+     *    1 if there is space to register a variable,
+     *    0 otherwise
+     */
     FMSTR_BOOL TsaAddVar(FMSTR_TSATBL_STRPTR name, FMSTR_TSATBL_STRPTR type, FMSTR_TSATBL_VOIDPTR addr, FMSTR_TSATBL_VOIDPTR info);
 
     static void _irq_handler(uint32_t id, SerialIrq irq_type);