ISSDK  1.8
IoT Sensing Software Development Kit
Macros
freemaster_cfg.h File Reference

Go to the source code of this file.

Macros

#define FMSTR_PLATFORM_CORTEX_M   1 /* Cortex-M platform (see freemaster.h for list of all supported platforms) */
 
#define FMSTR_DEMO_ENOUGH_ROM   1 /* Platform has enough ROM to show most of the FreeMASTER features */
 Set the demo configuration. More...
 
#define FMSTR_DEMO_LARGE_ROM   1 /* Platform has large ROM enough to store the extended data structures used in FreeMASTER demo */
 
#define FMSTR_DEMO_SUPPORT_I64   1 /* support for long long type */
 
#define FMSTR_DEMO_SUPPORT_FLT   1 /* support for float type */
 
#define FMSTR_DEMO_SUPPORT_DBL   1 /* support for double type */
 
#define FMSTR_DISABLE   0
 Enable/Disable FreeMASTER functionalities. More...
 
#define FMSTR_LONG_INTR   0
 Select interrupt or poll-driven serial communication. More...
 
#define FMSTR_SHORT_INTR   1
 Queuing done in interrupt. More...
 
#define FMSTR_POLL_DRIVEN   0
 No interrupt needed, polling only. More...
 
#define FMSTR_TRANSPORT   FMSTR_SERIAL
 Select communication interface. More...
 
#define FMSTR_SERIAL_DRV   FMSTR_SERIAL_MCUX_UART
 Use serial driver for UART */. More...
 
#define FMSTR_FLEXCAN_TXMB   0
 Define communication interface base address or leave undefined for runtime setting. More...
 
#define FMSTR_FLEXCAN_RXMB   1
 
#define FMSTR_COMM_BUFFER_SIZE   0
 Input/output communication buffer size. More...
 
#define FMSTR_COMM_RQUEUE_SIZE   32
 Receive FIFO queue size (use with FMSTR_SHORT_INTR only) More...
 
#define FMSTR_USE_APPCMD   1
 Support for Application Commands. More...
 
#define FMSTR_APPCMD_BUFF_SIZE   32
 App.Command data buffer size. More...
 
#define FMSTR_MAX_APPCMD_CALLS   4
 How many app.cmd callbacks? (0=disable) More...
 
#define FMSTR_USE_SCOPE   2
 Oscilloscope support. More...
 
#define FMSTR_MAX_SCOPE_VARS   8
 Specify maximum number of scope variables per one oscilloscope. More...
 
#define FMSTR_USE_RECORDER   2
 Recorder support. More...
 
#define FMSTR_REC_BUFF_SIZE   1024
 Built-in recorder buffer. More...
 
#define FMSTR_REC_TIMEBASE   FMSTR_REC_BASE_MILLISEC(0)
 Recorder time base, specifies how often the recorder is called in the user app. More...
 
#define FMSTR_REC_FLOAT_TRIG   1
 Enable/disable floating point triggering. More...
 
#define FMSTR_USE_TSA   1
 Enable TSA functionality. More...
 
#define FMSTR_USE_TSA_INROM   1
 TSA tables declared as const (put to ROM) More...
 
#define FMSTR_USE_TSA_SAFETY   1
 Enable/Disable TSA memory protection. More...
 
#define FMSTR_USE_TSA_DYNAMIC   1
 Enable/Disable TSA entries to be added also in runtime. More...
 
#define FMSTR_USE_PIPES   3
 Specify number of supported pipe objects. More...
 
#define FMSTR_USE_READMEM   1
 Enable read memory commands. More...
 
#define FMSTR_USE_WRITEMEM   1
 Enable write memory commands. More...
 
#define FMSTR_USE_WRITEMEMMASK   1
 Enable write memory bits commands. More...
 
#define FMSTR_USE_HASHED_PASSWORDS   0
 When non-zero, the passwords above are specified as a pointer to 20-byte SHA1 hash of password text. More...
 

Macro Definition Documentation

◆ FMSTR_APPCMD_BUFF_SIZE

#define FMSTR_APPCMD_BUFF_SIZE   32

App.Command data buffer size.

Definition at line 69 of file freemaster_cfg.h.

◆ FMSTR_COMM_BUFFER_SIZE

#define FMSTR_COMM_BUFFER_SIZE   0

Input/output communication buffer size.

Set to 0 for "automatic"

Definition at line 62 of file freemaster_cfg.h.

◆ FMSTR_COMM_RQUEUE_SIZE

#define FMSTR_COMM_RQUEUE_SIZE   32

Receive FIFO queue size (use with FMSTR_SHORT_INTR only)

Set to 0 for "default"

Definition at line 65 of file freemaster_cfg.h.

◆ FMSTR_DEMO_ENOUGH_ROM

#define FMSTR_DEMO_ENOUGH_ROM   1 /* Platform has enough ROM to show most of the FreeMASTER features */

Set the demo configuration.

Definition at line 20 of file freemaster_cfg.h.

◆ FMSTR_DEMO_LARGE_ROM

#define FMSTR_DEMO_LARGE_ROM   1 /* Platform has large ROM enough to store the extended data structures used in FreeMASTER demo */

Definition at line 21 of file freemaster_cfg.h.

◆ FMSTR_DEMO_SUPPORT_DBL

#define FMSTR_DEMO_SUPPORT_DBL   1 /* support for double type */

Definition at line 24 of file freemaster_cfg.h.

◆ FMSTR_DEMO_SUPPORT_FLT

#define FMSTR_DEMO_SUPPORT_FLT   1 /* support for float type */

Definition at line 23 of file freemaster_cfg.h.

◆ FMSTR_DEMO_SUPPORT_I64

#define FMSTR_DEMO_SUPPORT_I64   1 /* support for long long type */

Definition at line 22 of file freemaster_cfg.h.

◆ FMSTR_DISABLE

#define FMSTR_DISABLE   0

Enable/Disable FreeMASTER functionalities.

To disable all FreeMASTER functionalities

Definition at line 28 of file freemaster_cfg.h.

◆ FMSTR_FLEXCAN_RXMB

#define FMSTR_FLEXCAN_RXMB   1

Definition at line 59 of file freemaster_cfg.h.

◆ FMSTR_FLEXCAN_TXMB

#define FMSTR_FLEXCAN_TXMB   0

Define communication interface base address or leave undefined for runtime setting.

FlexCAN-specific, communication message buffers

Definition at line 58 of file freemaster_cfg.h.

◆ FMSTR_LONG_INTR

#define FMSTR_LONG_INTR   0

Select interrupt or poll-driven serial communication.

Complete message processing in interrupt

Definition at line 31 of file freemaster_cfg.h.

◆ FMSTR_MAX_APPCMD_CALLS

#define FMSTR_MAX_APPCMD_CALLS   4

How many app.cmd callbacks? (0=disable)

Definition at line 70 of file freemaster_cfg.h.

◆ FMSTR_MAX_SCOPE_VARS

#define FMSTR_MAX_SCOPE_VARS   8

Specify maximum number of scope variables per one oscilloscope.

Definition at line 74 of file freemaster_cfg.h.

◆ FMSTR_PLATFORM_CORTEX_M

#define FMSTR_PLATFORM_CORTEX_M   1 /* Cortex-M platform (see freemaster.h for list of all supported platforms) */

Definition at line 17 of file freemaster_cfg.h.

◆ FMSTR_POLL_DRIVEN

#define FMSTR_POLL_DRIVEN   0

No interrupt needed, polling only.

Definition at line 33 of file freemaster_cfg.h.

◆ FMSTR_REC_BUFF_SIZE

#define FMSTR_REC_BUFF_SIZE   1024

Built-in recorder buffer.

Built-in buffer size. Set to zero to disable using embedded buffer for recorder 0.

Definition at line 80 of file freemaster_cfg.h.

◆ FMSTR_REC_FLOAT_TRIG

#define FMSTR_REC_FLOAT_TRIG   1

Enable/disable floating point triggering.

Target-side address translation (TSA)

Definition at line 84 of file freemaster_cfg.h.

◆ FMSTR_REC_TIMEBASE

#define FMSTR_REC_TIMEBASE   FMSTR_REC_BASE_MILLISEC(0)

Recorder time base, specifies how often the recorder is called in the user app.

0 = "unknown"

Definition at line 83 of file freemaster_cfg.h.

◆ FMSTR_SERIAL_DRV

#define FMSTR_SERIAL_DRV   FMSTR_SERIAL_MCUX_UART

Use serial driver for UART */.

Definition at line 51 of file freemaster_cfg.h.

◆ FMSTR_SHORT_INTR

#define FMSTR_SHORT_INTR   1

Queuing done in interrupt.

Definition at line 32 of file freemaster_cfg.h.

◆ FMSTR_TRANSPORT

#define FMSTR_TRANSPORT   FMSTR_SERIAL

Select communication interface.

List of implemented standard FreeMASTER transports and its drivers FMSTR_SERIAL - Standard serial transport protocol (Used by various types of UART peripherals as USB CDC implementation) FMSTR_SERIAL_MCUX_UART - MCUXSDK driver for UART peripheral FMSTR_SERIAL_MCUX_LPUART - MCUXSDK driver for LPUART peripheral FMSTR_SERIAL_MCUX_USART - MCUXSDK driver for USART peripheral FMSTR_SERIAL_MCUX_MINIUSART -MCUXSDK driver for MINIUSART peripheral FMSTR_SERIAL_MCUX_USB - MCUXSDK driver for USB peripheral with CDC class FMSTR_CAN - Standard CAN transport protocol (Used by various types of CAN peripherals) FMSTR_CAN_MCUX_FLEXCAN - MCUXSDK driver for FlexCAN peripheral FMSTR_CAN_MCUX_MCAN - MCUXSDK driver for MCAN peripheral FMSTR_CAN_MCUX_MSCAN - MCUXSDK driver for msCAN peripheral FMSTR_PDBDM - Packet Driven BDM (Background debug memory access using JTAG, SWD or BDM debug probes). This transport does not use low-level driver. Use serial transport layer */

Definition at line 50 of file freemaster_cfg.h.

◆ FMSTR_USE_APPCMD

#define FMSTR_USE_APPCMD   1

Support for Application Commands.

Enable/disable App.Commands support

Definition at line 68 of file freemaster_cfg.h.

◆ FMSTR_USE_HASHED_PASSWORDS

#define FMSTR_USE_HASHED_PASSWORDS   0

When non-zero, the passwords above are specified as a pointer to 20-byte SHA1 hash of password text.

Definition at line 108 of file freemaster_cfg.h.

◆ FMSTR_USE_PIPES

#define FMSTR_USE_PIPES   3

Specify number of supported pipe objects.

Enable/Disable read/write memory commands

Definition at line 93 of file freemaster_cfg.h.

◆ FMSTR_USE_READMEM

#define FMSTR_USE_READMEM   1

Enable read memory commands.

Definition at line 96 of file freemaster_cfg.h.

◆ FMSTR_USE_RECORDER

#define FMSTR_USE_RECORDER   2

Recorder support.

Specify number of supported recorders

Definition at line 77 of file freemaster_cfg.h.

◆ FMSTR_USE_SCOPE

#define FMSTR_USE_SCOPE   2

Oscilloscope support.

Specify number of supported oscilloscopes

Definition at line 73 of file freemaster_cfg.h.

◆ FMSTR_USE_TSA

#define FMSTR_USE_TSA   1

Enable TSA functionality.

Definition at line 87 of file freemaster_cfg.h.

◆ FMSTR_USE_TSA_DYNAMIC

#define FMSTR_USE_TSA_DYNAMIC   1

Enable/Disable TSA entries to be added also in runtime.

Pipes as data streaming over FreeMASTER protocol

Definition at line 90 of file freemaster_cfg.h.

◆ FMSTR_USE_TSA_INROM

#define FMSTR_USE_TSA_INROM   1

TSA tables declared as const (put to ROM)

Definition at line 88 of file freemaster_cfg.h.

◆ FMSTR_USE_TSA_SAFETY

#define FMSTR_USE_TSA_SAFETY   1

Enable/Disable TSA memory protection.

Definition at line 89 of file freemaster_cfg.h.

◆ FMSTR_USE_WRITEMEM

#define FMSTR_USE_WRITEMEM   1

Enable write memory commands.

Definition at line 97 of file freemaster_cfg.h.

◆ FMSTR_USE_WRITEMEMMASK

#define FMSTR_USE_WRITEMEMMASK   1

Enable write memory bits commands.

Definition at line 98 of file freemaster_cfg.h.