MATLAB: How to know which source files, compiler options, and link options are needed to build the code generated from Real-Time Workshop on a PC that does not have MATLAB

Embedded Codersimulink coder

I have a Simulink model which I have exported to code using the Real-Time Workshop Embedded Coder. I need to be able to build this project on a PC that does not have MATLAB. I would like to know which source files, compiler options, and link options are needed. I would also like documented instructions on how to build this project outside of MATLAB.

Best Answer

The ability to generate a file that contains source files, compiler options, and link options is not available in Real-Time Workshop.

For releases prior to Real-Time Workshop v.v (R2007a), there are 2 methods to port generated code. Both require a lot of manual copying and extracting information from the makefile. Either the MATLAB file hierachy must be maintained and the generated makefile can be used with minor modifications, or the files must be copied, and some information form the makefile must be extracted. Both methods are summarized below.

%%%METHOD 1: Maintaining the MATLAB hierarchy

Note: "Host PC" refers to the PC running MATLAB, while "Target PC" refers to

the PC that the code will be compiled on (without MATLAB installed)

1) Generate code for the model on the Host PC

2) Copy the entire build dir (usually called model_ert_rtw) to the Target PC For example (rtwdemo_counter is the model):

Host PC: C:\myproject\rtwdemo_counter_ert_rtw

Target PC: C:\my_target_port\rtwdemo_counter_ert_rtw

3) Copy the entire slprj dir to the Target PC:

Host PC: C:\myproject\slprj\...

Target PC: C:\my_target_port\slprj\...

4) Open the generated makefile (the .mk file) and look for the definition of

MATLAB_INCLUDES. There will be several directories listed similar to these:

$(MATLAB_ROOT)\rtw\c\ert

$(MATLAB_ROOT)\extern\include

$(MATLAB_ROOT)\simulink\include

...

All of these directories must be copied from the Host PC to the Target PC, maintaining the relative path hierarchy. On the Target PC, a directory should be created for these directories. For example create this directory on the Target PC:

C:\my_target_port\MATLAB_files

assuming MATLAB is installed on the Host PC here:

C:\Program Files\MATLAB71

Then the directories listed in the makefile should be copied:

Host PC: C:\Program Files\MATLAB71\rtw\c\ert

Target PC: C:\my_target_port\MATLAB_files\rtw\c\ert

Host PC: C:\Program Files\MATLAB71\extern\include

Target PC: C:\my_target_port\MATLAB_files\extern\include

Host PC: C:\Program Files\MATLAB71\simulink\include

Target PC: C:\my_target_port\MATLAB_files\simulink\include

...

5) Step 4 must be repeated for build rules that contain $(MATLAB_ROOT) in them. For example, if this rule appears (this is from an MSVC build):

{$(MATLAB_ROOT)\rtw\c\ert}.c.obj

Then the source files in that directory should be copied

6) Copy vctools.mk from the Host PC to the Target PC:

Host PC: C:\Program Files\MATLAB71\rtw\c\tools\vctools.mk

Target PC: C:\my_target_port\MATLAB_files\rtw\c\tools\vctools.mk

7) In the makefile (.mk file) on the Target PC, change the definition of MATLAB_ROOT and ALT_MATLAB_ROOT MATLAB_BIN and ALT_MATLABBIN to the location on the Target PC:

Host PC:

MATLAB_ROOT = C:\Program Files\MATLAB71

ALT_MATLAB_ROOT = C:\PROGRA~1\MATLAB71

MATLAB_BIN = C:\Program Files\MATLAB71\bin\win32

ALT_MATLAB_BIN = C:\PROGRA~1\MATLAB71\bin\win32

Target PC:

MATLAB_ROOT = C:\my_target_port\MATLAB_files

ALT_MATLAB_ROOT = C:\my_target_port\MATLAB_files

MATLAB_BIN = C:\my_target_port\MATLAB_files\bin\win32

ALT_MATLAB_BIN = C:\my_target_port\MATLAB_files\bin\win32

8) In the additional includes area of the makefile, the start dir and build dir should be updated to the location on the Target PC (example with rtwdemo_counter model shown here):

Host PC:

MATLAB_INCLUDES = $(MATLAB_INCLUDES);c:\myproject

MATLAB_INCLUDES =

$(MATLAB_INCLUDES);c:\myproject\rtwdemo_counter_ert_rtw

Target PC:

MATLAB_INCLUDES = $(MATLAB_INCLUDES);c:\my_target_port\

MATLAB_INCLUDES =

$(MATLAB_INCLUDES);c:my_target_port\rtwdemo_counter_ert_rtw

9) On the Target PC the environment must be set up for MSVC. TMSVC ususally

installs a batch file called vcvars32.bat (or similar). run this on the Target PC.

10) In the generated BAT file(the model .bat file), copy the line that starts with

'nmake -f...' into a DOS cmd shell that is in the Target PC build directory

(c:\my_target_port).

%%%METHOD 2: Copying the sources to the Target PC

Note: in this method all files can be coipied to the same directory

1) Generate code for the model on the Host PC

2) Copy the entire build dir (usually called model_ert_rtw) to the Target PC For example (rtwdemo_counter is the model):

Host PC: C:\myproject\rtwdemo_counter_ert_rtw

Target PC: C:\my_target_port\

3) Copy the entire slprj dir to the Target PC:

Host PC: C:\myproject\slprj\...

Target PC: C:\my_target_port\

Steps 4 and 5 are the same as for Method 1, except all files can go into the

same target dir.

4) In the generated makefile (the model .mak file) the defines must be extracted:

First look for the definition of CPP_REQ_DEFINEs. It should look similar to this:

CPP_REQ_DEFINES = -DMODEL=$(MODEL) -DNUMST=$(NUMST) -DNCSTATES=$(NCSTATES) \

-DMAT_FILE=$(MAT_FILE) -DINTEGER_CODE=$(INTEGER_CODE) \

-DONESTEPFCN=$(ONESTEPFCN) -DTERMFCN=$(TERMFCN) \

-DHAVESTDIO -DMULTI_INSTANCE_CODE=$(MULTI_INSTANCE_CODE) \

-DADD_MDL_NAME_TO_GLOBALS=$(ADD_MDL_NAME_TO_GLOBALS)

For each make var that looks similar to "$(...)" the value most be searched for in the makefile. Most, if not all of them will be near the beginning of the makefile and look similar to this:

...

NUMST = 1

NCSTATES = 0

BUILDARGS = GENERATE_REPORT=1

MULTITASKING = 0

INTEGER_CODE = 1

MAT_FILE = 0

ONESTEPFCN = 1

TERMFCN = 0

...

These must be expanded and put into a temporary text buffer. So the final defines will look similar to this:

/DMODEL=rtwdemo_counter /DNUMST=1 /DNCSTATES=0 /DMAT_FILE=0 /DINTEGER_CODE=1

/DONESTEPFCN=1 /DTERMFCN=0 /DHAVESTDIO /DMULTI_INSTANCE_CODE=0

/DADD_MDL_NAME_TO_GLOBALS=0

Additionally, if External mode is used, then the "-D" definitions in the

external mode section of the makefile must be copied as well.

5) The defines obtained in step 4 must either be put on the compile line (if a custom makefile is being created), or they must be imported into the IDE.

Related Solutions

MATLAB: How to define separate includes for legacy and non-legacy code when generating code

The best approach to this workflow is to create a custom target file which includes a set of rtwoptions allowing the separate specification of standard includes and legacy code includes. This can then be linked to a custom TMF variable which can be used appropriately in the code. You can find a general summary of this workflow in our documentation using the link below:

http://www.mathworks.com/help/releases/R2015b/rtw/ug/customizing-system-target-files.html#f6351

A summary of the steps which need to be taken are shown below:

1) Define an element in the 'rtwoptions' file to capture the location of the directory

rtwoptions(2).prompt         = 'Custom Legacy Code Directory';
rtwoptions(2).type           = 'Edit';
rtwoptions(2).enable         = 'on';  
rtwoptions(2).default        =  'C:\LegacyCodeInc';   
rtwoptions(2).popupstrings  = '';
rtwoptions(2).tlcvariable   = 'CustomLegacyCodeDir';
rtwoptions(2).tooltip       = '';
rtwoptions(2).callback      = '';
rtwoptions(2).opencallback  = '';
rtwoptions(2).closecallback = '';
rtwoptions(2).makevariable  = 'CUSTOM_LEGACY_CODE_DIR';

2) Modify your TMF in order to expand the CUSTOM_LEGACY_CODE_DIR makevariable

# Additional file include paths
|>START_EXPAND_INCLUDES<|
MATLAB_INCLUDES = $(MATLAB_INCLUDES);|>EXPAND_DIR_NAME<||>END_EXPAND_INCLUDES<|
ADD_LEGACY_INCLUDES = |>CUSTOM_LEGACY_CODE_DIR<|;
INCLUDE = .;$(RELATIVE_PATH_TO_ANCHOR);$(MATLAB_INCLUDES); $(ADD_LEGACY_INCLUDES); $(INCLUDE)
!if "$(SHARED_SRC_DIR)" != ""
INCLUDE = $(INCLUDE);$(SHARED_SRC_DIR)
!endif

After expansion, the code above will appear as the following

# Additional file include paths
MATLAB_INCLUDES = $(MATLAB_INCLUDES);$(START_DIR)\bouncing_ball02302873_legacy_include_rtw
MATLAB_INCLUDES = $(MATLAB_INCLUDES);$(START_DIR)
MATLAB_INCLUDES = $(MATLAB_INCLUDES);$(MATLAB_ROOT)\toolbox\physmod\mech\c
MATLAB_INCLUDES = $(MATLAB_INCLUDES);$(MATLAB_ROOT)\toolbox\physmod\common\foundation\core\c
ADD_LEGACY_INCLUDES = C:\LegacyCodeInc;
INCLUDE = .;$(RELATIVE_PATH_TO_ANCHOR);$(MATLAB_INCLUDES); $(ADD_LEGACY_INCLUDES); $(INCLUDE)
!if "$(SHARED_SRC_DIR)" != ""
INCLUDE = $(INCLUDE);$(SHARED_SRC_DIR)
!endif

MATLAB: How to make a system able to find a file under the MATLAB root directory

Folders under matlabroot are by default "frozen", meaning that any changes to these folders on the path will not be picked up by MATLAB automatically.

If this file has to be placed under matlabroot, you can try

>> rehash toolboxcache

>> fschange "foldername"; rehash;

after placing the file into a folder that is under matlabroot (and also on path).

Then, the "which" command should be able to find the file.

Best Answer

Related Solutions

MATLAB: How to define separate includes for legacy and non-legacy code when generating code

MATLAB: How to make a system able to find a file under the MATLAB root directory

Related Question