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

class/freemaster_class.h@17:b2a783a8691f, 2014-09-10 (annotated)

Committer:
JardaPajskr
Date:
Wed Sep 10 16:04:07 2014 +0000
Revision:
17:b2a783a8691f
Parent:
16:be9b137b888c
Child:
20:355a9738a180
Updated documentation for the FreeMASTER lib class

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JardaPajskr 0:fb135bf60f82 1 #ifndef MBED_FREEMASTER_H
JardaPajskr 0:fb135bf60f82 2 #define MBED_FREEMASTER_H
JardaPajskr 0:fb135bf60f82 3
JardaPajskr 0:fb135bf60f82 4 #include "platform.h"
JardaPajskr 0:fb135bf60f82 5
JardaPajskr 0:fb135bf60f82 6 #if DEVICE_SERIAL
JardaPajskr 0:fb135bf60f82 7
JardaPajskr 0:fb135bf60f82 8 #include "serial_api.h"
JardaPajskr 11:d1de61dc3766 9 #include "freemaster_cfg.h"
JardaPajskr 0:fb135bf60f82 10 #include "freemaster.h"
JardaPajskr 13:62ef0bfeb036 11 #include "freemaster_tsa.h"
JardaPajskr 0:fb135bf60f82 12
JardaPajskr 0:fb135bf60f82 13 namespace mbed {
JardaPajskr 0:fb135bf60f82 14
JardaPajskr 0:fb135bf60f82 15 /** A FreeMASTER serial driver
JardaPajskr 0:fb135bf60f82 16 *
JardaPajskr 0:fb135bf60f82 17 * Can be used for debugging code over the serial line
JardaPajskr 0:fb135bf60f82 18 *
JardaPajskr 0:fb135bf60f82 19 * Example:
JardaPajskr 0:fb135bf60f82 20 * @code
JardaPajskr 0:fb135bf60f82 21 * // Set up the FreeMASTER serial driver
JardaPajskr 0:fb135bf60f82 22 *
JardaPajskr 0:fb135bf60f82 23 * #include "mbed.h"
JardaPajskr 0:fb135bf60f82 24 * #include "freemaster_class.h"
JardaPajskr 0:fb135bf60f82 25 *
JardaPajskr 0:fb135bf60f82 26 * Freemaster fm(USBTX, USBRX);
JardaPajskr 0:fb135bf60f82 27 *
JardaPajskr 0:fb135bf60f82 28 * FMSTR_TSA_TABLE_LIST_BEGIN()
JardaPajskr 0:fb135bf60f82 29 * FMSTR_TSA_TABLE_LIST_END()
JardaPajskr 0:fb135bf60f82 30 *
JardaPajskr 0:fb135bf60f82 31 * //define global variables
JardaPajskr 17:b2a783a8691f 32 * volatile unsigned char var8;
JardaPajskr 17:b2a783a8691f 33 * volatile unsigned short var16;
JardaPajskr 0:fb135bf60f82 34 *
JardaPajskr 0:fb135bf60f82 35 * int main() {
JardaPajskr 0:fb135bf60f82 36 * //register global or static variables
JardaPajskr 17:b2a783a8691f 37 * fm.TsaAddVar(FMSTR_TSA_RW_VAR_CFG(var8,FMSTR_TSA_UINT8));
JardaPajskr 0:fb135bf60f82 38 * //register read only variable
JardaPajskr 17:b2a783a8691f 39 * fm.TsaAddVar(FMSTR_TSA_RO_VAR_CFG(var16,FMSTR_TSA_UINT16));
JardaPajskr 0:fb135bf60f82 40 * while(1)
JardaPajskr 0:fb135bf60f82 41 * {
JardaPajskr 17:b2a783a8691f 42 * //your application
JardaPajskr 17:b2a783a8691f 43 * var16+=var8;
JardaPajskr 0:fb135bf60f82 44 * }
JardaPajskr 0:fb135bf60f82 45 * }
JardaPajskr 0:fb135bf60f82 46 * @endcode
JardaPajskr 0:fb135bf60f82 47 */
JardaPajskr 15:24a63ac82fc3 48
JardaPajskr 0:fb135bf60f82 49 class Freemaster {
JardaPajskr 0:fb135bf60f82 50
JardaPajskr 0:fb135bf60f82 51 public:
JardaPajskr 1:5033fe82d4c2 52 /** Create FreeMASTER interface
JardaPajskr 1:5033fe82d4c2 53 *
JardaPajskr 1:5033fe82d4c2 54 * @param tx Transmit pin
JardaPajskr 1:5033fe82d4c2 55 * @param rx Receive pin
JardaPajskr 1:5033fe82d4c2 56 * @param tsaMembers Maximum of variables to register dynamically. (optional)
JardaPajskr 1:5033fe82d4c2 57 * @param recBufferSize Buffer size for recorder feature. (optional)
JardaPajskr 1:5033fe82d4c2 58 * @param flags Advanced configuration. (optional)
JardaPajskr 1:5033fe82d4c2 59 *
JardaPajskr 1:5033fe82d4c2 60 */
JardaPajskr 0:fb135bf60f82 61 Freemaster(PinName tx, PinName rx, uint32_t tsaMembers = 20, uint32_t recBufferSize = 1024, uint32_t flags = 0);
JardaPajskr 1:5033fe82d4c2 62
JardaPajskr 1:5033fe82d4c2 63 /** Set the baud rate of the serial port
JardaPajskr 1:5033fe82d4c2 64 *
JardaPajskr 1:5033fe82d4c2 65 * @param baudrate The baudrate of the serial port (default = 9600).
JardaPajskr 1:5033fe82d4c2 66 */
JardaPajskr 0:fb135bf60f82 67 void baud(int baudrate);
JardaPajskr 1:5033fe82d4c2 68
JardaPajskr 1:5033fe82d4c2 69 /** Catch initialized variables into recorder buffer.
JardaPajskr 1:5033fe82d4c2 70 */
JardaPajskr 0:fb135bf60f82 71 void Recorder(void);
JardaPajskr 8:17470feaa6be 72
JardaPajskr 17:b2a783a8691f 73 /** Trigger sampling of the recorder by SW.
JardaPajskr 8:17470feaa6be 74 */
JardaPajskr 8:17470feaa6be 75 void TriggerRec(void);
JardaPajskr 8:17470feaa6be 76
JardaPajskr 8:17470feaa6be 77 /** This function can be used to detect if any Application Command is waiting to be processed by the application.
JardaPajskr 17:b2a783a8691f 78 *
JardaPajskr 17:b2a783a8691f 79 * @returns
JardaPajskr 17:b2a783a8691f 80 * 1-247 - command needs to be processed by application\n
JardaPajskr 17:b2a783a8691f 81 * FMSTR_APPCMDRESULT_NOCMD - no command is pending
JardaPajskr 8:17470feaa6be 82 */
JardaPajskr 17:b2a783a8691f 83 FMSTR_APPCMD_CODE GetAppCmd(void);
JardaPajskr 8:17470feaa6be 84
JardaPajskr 8:17470feaa6be 85 /** This function can be used to retrieve the Application Command data.
JardaPajskr 17:b2a783a8691f 86 *
JardaPajskr 17:b2a783a8691f 87 * @param pDataLen Pointer to variable, which receives length of the data available in buffer.
JardaPajskr 17:b2a783a8691f 88 *
JardaPajskr 17:b2a783a8691f 89 * @returns Pointer to buffer, which holds received data. The data needs to be handled before FMSTR_AppCmdAck() call.
JardaPajskr 8:17470feaa6be 90 */
JardaPajskr 8:17470feaa6be 91 FMSTR_APPCMD_PDATA GetAppCmdData(FMSTR_SIZE* pDataLen);
JardaPajskr 8:17470feaa6be 92
JardaPajskr 8:17470feaa6be 93 /** This function can be used to register a given function as a callback handler for an Application Command.
JardaPajskr 17:b2a783a8691f 94 *
JardaPajskr 17:b2a783a8691f 95 * @param nAppCmdCode An Application Command code for which the callback is to be registered.
JardaPajskr 17:b2a783a8691f 96 * @param pCallbackFunc A pointer to a callback function which is to be registered. Use NULL to un-register a callback
JardaPajskr 17:b2a783a8691f 97 * registered previously with this Application Command.
JardaPajskr 17:b2a783a8691f 98 *
JardaPajskr 17:b2a783a8691f 99 * @returns
JardaPajskr 17:b2a783a8691f 100 * 1 if there is space to register a variable /n
JardaPajskr 17:b2a783a8691f 101 * 0 otherwise
JardaPajskr 8:17470feaa6be 102 */
JardaPajskr 8:17470feaa6be 103 FMSTR_BOOL RegisterAppCmdCall(FMSTR_APPCMD_CODE nAppCmdCode, FMSTR_PAPPCMDFUNC pCallbackFunc);
JardaPajskr 8:17470feaa6be 104
JardaPajskr 8:17470feaa6be 105 /** This function is used when Application Command processing is finished in the application.
JardaPajskr 17:b2a783a8691f 106 *
JardaPajskr 17:b2a783a8691f 107 * @param nResultCode The result code, which is to be returned to the FreeMASTER tool.
JardaPajskr 8:17470feaa6be 108 */
JardaPajskr 8:17470feaa6be 109 void AppCmdAck(FMSTR_APPCMD_RESULT nResultCode);
JardaPajskr 8:17470feaa6be 110
JardaPajskr 8:17470feaa6be 111 /** This function can be used before the Application Command processing is finished.
JardaPajskr 17:b2a783a8691f 112 *
JardaPajskr 17:b2a783a8691f 113 * @param nResultDataAddr A pointer to data buffer which is to be copied to the Application Command data buffer.
JardaPajskr 17:b2a783a8691f 114 * @param nResultDataLen The length of a data to be copied. It must not exceed the FMSTR_APPCMD_BUFF_SIZE value.
JardaPajskr 8:17470feaa6be 115 */
JardaPajskr 8:17470feaa6be 116 void AppCmdSetResponseData(FMSTR_ADDR nResultDataAddr, FMSTR_SIZE nResultDataLen);
JardaPajskr 8:17470feaa6be 117
JardaPajskr 0:fb135bf60f82 118 void Poll(void);
JardaPajskr 0:fb135bf60f82 119
JardaPajskr 17:b2a783a8691f 120 /** Register variables to dynamic TSA table
JardaPajskr 4:256c3ffc6f40 121 *
JardaPajskr 17:b2a783a8691f 122 * @param (name, type, addr, info) use following macros to register variable\n
JardaPajskr 17:b2a783a8691f 123 * FMSTR_TSA_STRUCT_CFG(name) - register structure(name)\n
JardaPajskr 17:b2a783a8691f 124 * FMSTR_TSA_MEMBER_CFG(parenttype,name,type) - register member(name) of (type) in structure(parenttype), \n
JardaPajskr 17:b2a783a8691f 125 * FMSTR_TSA_RO_VAR_CFG(name,type) - register Read Only variable(name) of (type)\n
JardaPajskr 17:b2a783a8691f 126 * FMSTR_TSA_RW_VAR_CFG(name,type) - register variable(name) of (type)\n
JardaPajskr 17:b2a783a8691f 127 * FMSTR_TSA_RO_MEM_CFG(name,type,addr,size) - register Read Only memory block(name) of (type)\n
JardaPajskr 17:b2a783a8691f 128 * FMSTR_TSA_RW_MEM_CFG(name,type,addr,size) - register memory block(name) of (type)\n
JardaPajskr 4:256c3ffc6f40 129 *
JardaPajskr 4:256c3ffc6f40 130 * @returns
JardaPajskr 17:b2a783a8691f 131 * 1 if there is space to register a variable \n
JardaPajskr 4:256c3ffc6f40 132 * 0 otherwise
JardaPajskr 17:b2a783a8691f 133 * @note use following macros to define type of variable:\n
JardaPajskr 17:b2a783a8691f 134 * FMSTR_TSA_UINT8, FMSTR_TSA_UINT16, FMSTR_TSA_UINT32, FMSTR_TSA_UINT64, \n
JardaPajskr 17:b2a783a8691f 135 * FMSTR_TSA_SINT8, FMSTR_TSA_SINT16, FMSTR_TSA_SINT32, FMSTR_TSA_SINT64, \n
JardaPajskr 17:b2a783a8691f 136 * FMSTR_TSA_UFRAC16, FMSTR_TSA_UFRAC32, FMSTR_TSA_FRAC16, FMSTR_TSA_FRAC32,\n
JardaPajskr 17:b2a783a8691f 137 * FMSTR_TSA_FLOAT, FMSTR_TSA_DOUBLE
JardaPajskr 17:b2a783a8691f 138 * @note Default configuration can register up to 20 variables
JardaPajskr 4:256c3ffc6f40 139 */
JardaPajskr 0:fb135bf60f82 140 FMSTR_BOOL TsaAddVar(FMSTR_TSATBL_STRPTR name, FMSTR_TSATBL_STRPTR type, FMSTR_TSATBL_VOIDPTR addr, FMSTR_TSATBL_VOIDPTR info);
JardaPajskr 0:fb135bf60f82 141
JardaPajskr 0:fb135bf60f82 142 static void _irq_handler(uint32_t id, SerialIrq irq_type);
JardaPajskr 0:fb135bf60f82 143 protected:
JardaPajskr 0:fb135bf60f82 144 serial_t _serial;
JardaPajskr 0:fb135bf60f82 145 int _baud;
JardaPajskr 0:fb135bf60f82 146 void* tsaTable;
JardaPajskr 0:fb135bf60f82 147 void* recBuf;
JardaPajskr 0:fb135bf60f82 148
JardaPajskr 0:fb135bf60f82 149 };
JardaPajskr 0:fb135bf60f82 150
JardaPajskr 0:fb135bf60f82 151 } // namespace mbed
JardaPajskr 0:fb135bf60f82 152 #endif
JardaPajskr 0:fb135bf60f82 153
JardaPajskr 0:fb135bf60f82 154 #endif