Contents

Index

• Getting Started

• Introduction to Real-Time Workshop Technology

• Developing Models for Code Generation

• Defining Data Representation and Storage for Code Generation

• Preparing Models for Code Generation

• Generating Code and Building Executables

• Converting MATLAB Code to C Code

• Integrating External Code With Generated C and C++ Code

• Setting Up Generated Code To Interface With Components in the Run-Time Environment

• Verifying Generated Code Applications

• Troubleshooting

• Target Language Compiler

• Introducing the Target Language Compiler

• Getting Started

Code Architecture

• Target Language Compiler Overview

The Target Language Compiler Process

Operating Sequence

• Inlining S-Functions

Inlining an S-function

Noninlined S-Function

Types of Inlining

Fully Inlined S-Function Example

Wrapper Inlined S-Function Example

• Target Language Compiler Tutorials

• Reading Record Files with TLC

Tutorial Overview

Learning About the Structure of Record Files

Interpreting Records

Learning About the Anatomy of a TLC Script

Modifying read-guide.tlc

Passing and Using a Parameter

• Inlining S-Functions with TLC

timesN Tutorial Overview

Learning About Noninlined Code Generation

Understand Why You Use TLC to Inline S-Functions

Creating an Inlined S-Function

• Exploring Variable Names and Loop Rolling

timesN Looping Tutorial Overview

Getting Started

Modifying the Model

Changing the Loop Rolling Threshold

Learning More About TLC Loop Rolling

• Debugging Your TLC Code

tlcdebug Tutorial Overview

Getting Started

Generating and Running Code from the Model

Start the Debugger and Use its Commands

Debugging timesN.tlc

Fixing the Bug and Verifying the Fix

• Using TLC Code Coverage to Aid Debugging

tlcdebug Execute Tutorial Overview

Getting Started

Opening the Model and Generating Code

• Wrapping User Code with TLC

wrapper Tutorial Overview

Understanding Why You Might Wrap

Getting Started

Generating Code Without a Wrapper

Generating Code Using a Wrapper

• Code Generation Architecture

• Understanding the model.rtw File

Introduction to the model.rtw File

Using Scopes in the model.rtw File

• Object Information in the model.rtw File

Object Overview

Object Records for Parameters

Object Records for Signals

Accessing Object Information via TLC

• Data References in the model.rtw File

Data Reference Overview

Controlling the Data Reference Threshold

Expanding Data References

Avoiding Data Reference Expansion

Restarting Code Generation

• Using Library Functions to Access model.rtw

Library Functions Overview

Caution Against Directly Accessing Record Fields

Exception to Using the Library Functions

• Directives and Built-In Functions

• Debugging TLC Files

• About the TLC Debugger

TLC Debugger Overview

Tips for Debugging TLC Code

• Using the TLC Debugger

Invoking the Debugger

TLC Debugger Command Summary

• TLC Coverage

Using the TLC Coverage Option

Example .log File

Analyzing the Results

• TLC Profiler

Using the Profiler

Analyzing the Report

Nonexecutable Directives

Improving Performance

• Inlining S-Functions

• Writing Block Target Files to Inline S-Functions

When to Inline S-Functions

Fully Inlined S-Functions

Function-Based or Wrapped Code Generation

• Inlining C MEX S-Functions

Inline S-Function Overview

S-Function Parameters

A Complete Example

Inlining M-File S-Functions

Inlining Fortran (F-MEX) S-Functions

• TLC Coding Conventions

Begin Identifiers with Uppercase Letters

Begin Global Variable Assignments with Uppercase Letters

Begin Local Variable Assignments with Lowercase Letters

Begin Functions Declared in block.tlc Files with Fcn

Do Not Hard-Code Variables Defined in commonsetup.tlc

Conditional Inclusion in Library Files

Code Defensively

• Block Target File Methods

Block Functions Overview

BlockInstanceSetup(block, system)

BlockTypeSetup(block, system)

Enable(block, system)

Disable(block, system)

Start(block, system)

InitializeConditions(block, system)

Outputs(block, system)

Update(block, system)

Derivatives(block, system)

Terminate(block, system)

Error Reporting

• TLC Function Library Reference

Obsolete Functions

• Target Language Compiler Function Conventions

Common Function Arguments

Overloading sigIdx

• Input Signal Functions

LibBlockInputPortIndexMode(block, pidx)

LibBlockInputSignal(portIdx, ucv, lcv, sigIdx)

LibBlockInputSignalAddr(portIdx, ucv, lcv, sigIdx)

LibBlockInputSignalAliasedThruDataTypeName(portIdx, reim)

LibBlockInputSignalConnected(portIdx)

LibBlockInputSignalDataTypeId(portIdx)

LibBlockInputSignalDataTypeName(portIdx, reim)

LibBlockInputSignalDimensions(portIdx)

LibBlockInputSignalIsComplex(portIdx)

LibBlockInputSignalIsFrameData(portIdx)

LibBlockInputSignalLocalSampleTimeIndex(portIdx)

LibBlockInputSignalNumDimensions(portIdx)

LibBlockInputSignalOffsetTime(portIdx)

LibBlockInputSignalSampleTime(portIdx)

LibBlockInputSignalSampleTimeIndex(portIdx)

LibBlockInputSignalWidth(portIdx)

LibBlockNumInputPorts(block)

• Output Signal Functions

LibBlockNumOutputPorts(block)

LibBlockOutputPortIndexMode(block, pidx)

LibBlockOutputSignal(portIdx, ucv, lcv, sigIdx)

LibBlockOutputSignalAddr(portIdx, ucv, lcv, sigIdx)

LibBlockOutputSignalAliasedThruDataTypeName(portIdx, reim)

LibBlockOutputSignalBeingMerged(portIdx)

LibBlockOutputSignalConnected(portIdx)

LibBlockOutputSignalDataTypeId(portIdx)

LibBlockOutputSignalDataTypeName(portIdx, reim)

LibBlockOutputSignalDimensions(portIdx)

LibBlockOutputSignalIsComplex(portldx)

LibBlockOutputSignalIsFrameData(portIdx)

LibBlockOutputSignalLocalSampleTimeIndex(portIdx)

LibBlockOutputSignalNumDimensions(portIdx)

LibBlockOutputSignalOffsetTime(portIdx)

LibBlockOutputSignalSampleTime(portIdx)

LibBlockOutputSignalSampleTimeIndex(portIdx)

LibBlockOutputSignalWidth(portIdx)

• Parameter Functions

LibBlockMatrixParameter(param, rucv, rlcv, ridx, cucv, clcv, cidx)

LibBlockMatrixParameterAddr(param, rucv, rlcv, ridx, cucv, clcv, cidx)

LibBlockMatrixParameterBaseAddr(param)

LibBlockParamSetting(bType, psType)

LibBlockParameter(param, ucv, lcv, sigIdx)

LibBlockParameterAddr(param, ucv, lcv, idx)

LibBlockParameterBaseAddr(param)

LibBlockParameterDataTypeId(param)

LibBlockParameterDataTypeName(param, reim)

LibBlockParameterDimensions(param)

LibBlockParameterIsComplex(param)

LibBlockParameterSize(param)

LibBlockParameterString(param)

LibBlockParameterValue(param, elIdx)

LibBlockParameterWidth(param)

• Block State and Work Vector Functions

LibBlockContinuousState(ucv, lcv, idx)

LibBlockContinuousStateDerivative(ucv, lcv, idx)

LibBlockContStateDisabled(ucv, lcv, idx)

LibBlockDWork(dwork, ucv, lcv, idx)

LibBlockDWorkAddr(dwork, ucv, lcv, idx)

LibBlockDWorkDataTypeId(dwork)

LibBlockDWorkDataTypeName(dwork, reim)

LibBlockDWorkIsComplex(dwork)

LibBlockDWorkName(dwork)

LibBlockDWorkStorageClass(dwork)

LibBlockDWorkStorageTypeQualifier(dwork)

LibBlockDWorkUsedAsDiscreteState(dwork)

LibBlockDWorkWidth(dwork)

LibBlockDiscreteState(ucv, lcv, idx)

LibBlockIWork(definediwork, ucv, lcv, idx)

LibBlockMode(ucv, lcv, idx)

LibBlockNonSampledZC(ucv, lcv, NSZCIdx)

LibBlockPWork(definedpwork, ucv, lcv, idx)

LibBlockRWork(definedrwork, ucv, lcv, idx)

LibBlockZCSignalValue(ucv, lcv, zcsIdx, zcElIdx)

• Block Path and Error Reporting Functions

LibBlockReportError(block, errorstring)

LibBlockReportFatalError(block, errorstring)

LibBlockReportWarning(block, warnstring)

LibGetBlockName(block)

LibGetBlockPath(block)

LibGetFormattedBlockPath(block)

• Code Configuration Functions

LibAddSourceFileCustomSection(file, builtInSection, newSection)

LibAddToCommonIncludes(incFileName)

LibAddToModelSources(newFile)

LibCacheDefine(buffer)

LibCacheExtern(buffer)

LibCacheFunctionPrototype(buffer)

LibCacheTypedefs(buffer)

LibCallModelInitialize()

LibCallModelStep(tid)

LibCallModelTerminate()

LibCallSetEventForThisBaseStep(buffername)

LibCreateSourceFile(type, creator, name)

LibGetMdlPrvHdrBaseName()

LibGetMdlPubHdrBaseName()

LibGetMdlSrcBaseName()

LibGetModelDotCFile()

LibGetModelDotHFile()

LibGetModelName()

LibGetNumSourceFiles()

LibGetRTModelErrorStatus()

LibGetSourceFileCustomSection(file, attrib)

LibGetSourceFileFromIdx(fileIdx)

LibGetSourceFileTag(fileIdx)

LibMdlRegCustomCode(buffer, location)

LibMdlStartCustomCode(buffer, location)

LibMdlTerminateCustomCode(buffer, location)

LibSetRTModelErrorStatus(str)

LibSetSourceFileCodeTemplate(opFile, name)

LibSetSourceFileCustomSection(file, attrib, value)

LibSetSourceFileOutputDirectory(opFile, name)

LibSetSourceFileSection(fileH, section, value)

LibSystemDerivativeCustomCode(system, buffer, location)

LibSystemDisableCustomCode(system, buffer, location)

LibSystemEnableCustomCode(system, buffer, location)

LibSystemInitializeCustomCode(system, buffer, location)

LibSystemOutputCustomCode(system, buffer, location)

LibSystemUpdateCustomCode(system, buffer, location)

LibWriteModelData()

LibWriteModelInput(tid, rollThreshold)

LibWriteModelInputs()

LibWriteModelOutput(tid, rollThreshold)

LibWriteModelOutputs()

• Sample Time Functions

LibAsynchronousTriggeredTID(tid)

LibAsyncTaskAccessTimeInFcn(tid, fcnType)

LibBlockSampleTime(block)

LibGetClockTick(tid)

LibGetClockTickDataTypeId(tid)

LibGetClockTickHigh(tid)

LibGetClockTickStepSize(tid)

LibGetElapseTime(system)

LibGetElapseTimeCounter(system)

LibGetElapseTimeCounterDTypeId(system)

LibGetElapseTimeResolution(system)

LibGetGlobalTIDFromLocalSFcnTID(sfcnTID)

LibGetNumAsyncTasks()

LibGetNumSFcnSampleTimes(block)

LibGetNumSyncPeriodicTasks()

LibGetNumTasks()

LibGetSampleTimePeriodAndOffset(tid, idx)

LibGetSFcnTIDType(sfcnTID)

LibGetTaskTime(tid)

LibGetTaskTimeFromTID(block)

LibGetTID01EQ()

LibIsContinuous(TID)

LibIsDiscrete(TID)

LibIsSFcnSampleHit(sfcnTID)

LibIsSFcnSingleRate(block)

LibIsSFcnSpecialSampleHit(sfcnSTI, sfcnTID)

LibIsSingleRateModel()

LibIsSingleTasking()

LibIsZOHContinuous(TID)

LibNumAsynchronousSampleTimes()

LibNumDiscreteSampleTimes()

LibNumSynchronousSampleTimes()

LibPortBasedSampleTimeBlockIsTriggered(block)

LibSetVarNextHitTime(block, tNext)

LibTriggeredTID(tid)

• Other Useful Functions

LibBlockExecuteFcnCall(sfcnBlock, callIdx)

LibBlockInputSignalAliasedThruDataTypeId(idx)

LibBlockOutputSignalAliasedThruDataTypeId(idx)

LibCallFCSS(system, simObject, portEl, tidVal)

LibDisableFCSS(system, simObject, portEl, tidVal)

LibEnableFCSS(system, simObject, portEl, tidVal)

LibExecuteFcnCall(ssBlock, portEl, tidVal)

LibExecuteFcnDisable(ssBlock, portEl, tidVal)

LibExecuteFcnEnable(ssBlock, portEl, tidVal)

LibGenConstVectWithInit(data, typeId, varId)

LibGetBlockAttribute(block, attr)

LibGetCallerClockTickCounter(sfcnBlock)

LibGetCallerClockTickCounterHigh(sfcnBlock)

LibGetDataTypeComplexNameFromId(id)

LibGetDataTypeEnumFromId(id)

LibGetDataTypeIdAliasedThruToFromId(id)

LibGetDataTypeIdAliasedToFromId(id)

LibGetDataTypeIdResolvesToFromId(id)

LibGetDataTypeNameFromId(id)

LibGetDataTypeSLSizeFromId(id)

LibGetDataTypeStorageIdFromId(id)

LibGetFcnCallBlock(sfcnblock,callIdx)

LibGetRecordDataTypeId(rec)

LibGetRecordDimensions(rec)

LibGetRecordIsComplex(rec)

LibGetRecordWidth(rec)

LibIsComplex(arg)

LibIsFirstInitCond()

LibIsMajorTimeStep()

LibIsMinorTimeStep()

LibManageAsyncCounter(sfcnBlock, callIdx)

LibMaxIntValue(dtype)

LibMinIntValue(dtype)

LibNeedAsyncCounter(sfcnBlock, callIdx)

LibSetAsyncClockTicks(sfcnBlock, callIdx, buf1, buf2)

LibSetAsyncCounter(sfcnBlock, callIdx, buf)

LibSetAsyncCounterHigh(sfcnBlock, callIdx, buf)

LibTIDInSystem(system, fcnType)

• Advanced Functions

LibAppendToModelReferenceUserData(data)

LibBlockInputSignalBufferDstPort(portIdx)

LibBlockInputSignalStorageClass(portIdx, sigIdx)

LibBlockInputSignalStorageTypeQualifier(portIdx, sigIdx)

LibBlockOutputSignalIsGlobal(portIdx)

LibBlockOutputSignalIsInBlockIO(portIdx)

LibBlockOutputSignalIsValidLValue(portIdx)

LibBlockOutputSignalStorageClass(portIdx)

LibBlockOutputSignalStorageTypeQualifier(portIdx)

LibBlockSrcSignalBlock(portIdx, sigIdx)

LibBlockSrcSignalIsDiscrete(portIdx, sigIdx)

LibBlockSrcSignalIsGlobalAndModifiable(portIdx, sigIdx)

LibBlockSrcSignalIsInvariant(portIdx, sigIdx)

LibGetModelReferenceUserData(modelName)

LibGetReferencedModelNames()

LibIsModelReferenceRTWTarget()

LibIsModelReferenceSimTarget()

LibIsModelReferenceTarget()

• TLC Error Handling

• Generating Errors from TLC Files

How to Generate Usage Errors

Fatal (Internal) TLC Coding Errors

Formatting Error Messages

• TLC Error Messages

Using TLC Error Messages to Troubleshoot

Alphabetical List of Error Messages

TLC Function Library Error Messages

Product Limitations Summary

• Configuration Parameters for Simulink Models

• Configuration Parameters for Embedded MATLAB Coder

• Model Advisor Checks

• Release Notes

Learn more about Real-Time Workshop

Target Language Compiler

Introducing the Target Language Compiler	Provides an overview of the Target Language Compiler and the code generation process, and the advantages of inlining S-functions.
Getting Started	Describes the process that the Target Language Compiler uses to generate code, and general inlining S-function concepts.
Target Language Compiler Tutorials	Provides a series of Target Language Compiler tutorials
Code Generation Architecture	Describes the TLC files and the build process. It also provides a tutorial on how to write target language files.
Understanding the model.rtw File	Describes the `model.rtw` file.
Directives and Built-In Functions	Contains the language syntax for the Target Language Compiler.
Debugging TLC Files	Explains how to use the TLC debugger.
Inlining S-Functions	Describes how to use the Target Language Compiler and how to inline S-functions.
TLC Function Library Reference	Contains abstracts for the Target Language Compiler functions.
TLC Error Handling	Lists the error messages that the Target Language Compiler can generate, as well as how to best use the errors.

Introducing the Target Language Compiler

Introducing the Target Language Compiler

Related Products & Applications

Get Simulink trial software

Learn more about Simulink through this collection of videos, articles, technical literature and the Getting Started with Simulink Guide.

Get this Simulink Kit

© 1984-2009- The MathWorks, Inc. - Site Help - Patents - Trademarks - Privacy Policy - Preventing Piracy - RSS