Документация

Панорама

Можно интегрировать существующий C (или C++) функции, такие как драйверы устройств, интерполяционные таблицы, и общие функции и интерфейсы, в модели Simulink^® при помощи Legacy Code Tool. Используя спецификации, которые вы предоставляете как код MATLAB^®, инструмент преобразовывает существующие функции в S-функции MEX C, которые можно включать в модели Simulink. Если вы используете Simulink Coder™, чтобы сгенерировать код, Legacy Code Tool может вставить соответствующий вызов вашей функции C в сгенерированный код. Для получения дополнительной информации смотрите Вызовы Импорта Внешнего Кода в Сгенерированный код с Legacy Code Tool (Simulink Coder).

По сравнению с использованием Разработчика S-функции или записью S-функции, Legacy Code Tool легче использовать и генерирует оптимизированный код (не генерирует код обертки), часто требуемый встраиваемыми системами. Однако рассмотрите альтернативные подходы для гибридной системы, такие как система, которая включает объект и контроллер или компонент системы, написанный в языке кроме C или C++. Альтернативные подходы более гибки в этом, они поддерживают больше функций и языков программирования.

Взаимодействовать с Legacy Code Tool, вами

Следующая схема иллюстрирует общую процедуру для использования Legacy Code Tool. Объединяйтесь Функции C в Модели Simulink с Legacy Code Tool обеспечивает пример, который использует Legacy Code Tool, чтобы преобразовать существующую функцию C в S-функцию MEX C.

Если у вас есть лицензия на продукты Simulink Coder, смотрите Вызовы Импорта Внешнего Кода в Сгенерированный код с Legacy Code Tool (Simulink Coder) для получения информации об использовании Legacy Code Tool для генерации кода.

Интегрируйте функции C в модели Simulink с Legacy Code Tool

Этот пример демонстрирует, как интегрировать существующую функцию C в модель Simulink с помощью Legacy Code Tool.

Предположим, что у вас есть функция C, которая выводит значение ее входа с плавающей точкой, умноженного на два. Функция задана в исходном файле под названием doubleIt.c, и его объявление существует в заголовочном файле под названием doubleIt.h.

Интегрируйте функцию C, аргументы которой являются указателями на структуры

В этом примере показано, как использовать Legacy Code Tool, чтобы объединяться, C функционируют, чьи аргументы являются указателями на структуры.

В Simulink® создайте Simulink.Bus объект представлять тип структуры. Используйте сигналы шины в модели, чтобы представлять структурированные сигналы и состояния. Создайте структуры MATLAB в рабочей области или в диалоговом окне параметров блоков, чтобы представлять структуры параметра.

Для основной информации о сигналах шины смотрите Виртуальную Шину. Для основной информации о структурах параметра смотрите, Организуют Связанные Определения Параметров блоков в Структурах. Чтобы создать объекты шины, смотрите, Создают и Задают Объекты Шины.

#include "ex_myTypes_LCT.h"

void myFcn(sigStructType *in, paramStructType *params, sigStructType *out)
{
    out->sig1 = in->sig1 * params->param1;
    out->sig2 = in->sig2 * params->param2 + params->param3;
}

#ifndef _MY_TYPES_H_
#define _MY_TYPES_H_

typedef struct {
  double sig1;
  double sig2;
} sigStructType;

typedef struct {
  double param1;
  double param2;
  double param3;
} paramStructType;

#endif

Simulink.importExternalCTypes('ex_myTypes_LCT.h');

def = legacy_code('initialize');

def.SFunctionName = 'sfun_ex_mySrc_LCT';

def.SourceFiles = {'ex_mySrc_LCT.c'};
def.HeaderFiles = {'ex_myTypes_LCT.h'};

def.OutputFcnSpec = ['void myFcn(sigStructType u1[1], ',...
    'paramStructType p1[1], sigStructType y1[1])'];

legacy_code('generate_for_sim',def);

### Start Compiling sfun_ex_mySrc_LCT
    mex('-I/tmp/BR2019bd_1170825_64229/publish_examples11/tpa15b7731/ex12763634', '-c', '-outdir', '/tmp/BR2019bd_1170825_64229/publish_examples11/tp9178e47e_327d_4942_bbbd_c8f0a29955a2', '/tmp/BR2019bd_1170825_64229/publish_examples11/tpa15b7731/ex12763634/ex_mySrc_LCT.c')
Building with 'gcc'.
MEX completed successfully.
    mex('sfun_ex_mySrc_LCT.c', '-I/tmp/BR2019bd_1170825_64229/publish_examples11/tpa15b7731/ex12763634', '/tmp/BR2019bd_1170825_64229/publish_examples11/tp9178e47e_327d_4942_bbbd_c8f0a29955a2/ex_mySrc_LCT.o')
Building with 'gcc'.
/tmp/BR2019bd_1170825_64229/publish_examples11/tpa15b7731/ex12763634/sfun_ex_mySrc_LCT.c: In function ‘mdlOutputs’:
/tmp/BR2019bd_1170825_64229/publish_examples11/tpa15b7731/ex12763634/sfun_ex_mySrc_LCT.c:417:9: warning: implicit declaration of function ‘myFcn’ [-Wimplicit-function-declaration]
         myFcn(__u1BUS, __p1BUS, __y1BUS);
         ^~~~~

MEX completed successfully.
### Finish Compiling sfun_ex_mySrc_LCT
### Exit

legacy_code('slblock_generate', def);

open_system('ex_lct_struct')

structParam = struct;
structParam.param1 = 15;
structParam.param2 = 20;
structParam.param3 = 5;

structParam = Simulink.Parameter(structParam);
structParam.DataType = 'Bus: paramStructType';

set_param('ex_lct_struct/sfun_ex_mySrc_LCT','SParameter1','structParam')

open_system('ex_lct_struct/Scope')
open_system('ex_lct_struct/Scope1')
sim('ex_lct_struct')

ans = 

  Simulink.SimulationOutput:
                   tout: [51x1 double] 

     SimulationMetadata: [1x1 Simulink.SimulationMetadata] 
           ErrorMessage: [0x0 char] 

Регистрация структур данных Legacy Code Tool

Первый шаг к использованию Legacy Code Tool должен указать одну или несколько структур MATLAB с полями, которые представляют свойства существующего кода С и сгенерированной S-функции. Процесс регистрации гибок. Можно принять решение настроить ресурсы и инициировать регистрацию во множестве путей, включая

Указывать структуру данных Legacy Code Tool:

Если вы задаете поля, которые задают ресурсы компиляции, и вы задаете относительные пути, Legacy Code Tool ищет ресурсы относительно следующих директорий в следующем порядке:

Объявление спецификаций функции Legacy Code Tool

InitializeConditionsFcnSpec, OutputFcnSpec, StartFcnSpec, и TerminateFcnSpec поля задали в структуре данных Legacy Code Tool (см. описание legacy_code функция), требуют значений вектора символов, которые придерживаются определенного формата синтаксиса. Необходимый формат синтаксиса позволяет Legacy Code Tool сопоставить возвращаемое значение и аргументы существующей функции C к возвращаемому значению, входным параметрам, выходным параметрам, параметрам, и работать векторы S-функции, которую генерирует инструмент.

Общий синтаксис

return-spec = function-name(argument-spec)

Например, следующий вектор символов задает функцию с именем doubleIt со спецификацией возврата double y1 и спецификация входного параметра double u1.

def.OutputFcnSpec = 'double y1 = doubleIt(double u1)';

Для большего количества детали об объявлении функциональных спецификаций смотрите

• Возвратите спецификацию

• FunctionName

• Спецификация аргумента

• Поддерживаемые типы данных

• Правила спецификации функции Legacy Code Tool

• Наследие C функциональные правила

return-type return-variable

float doubleIt(float inVal);

argument-type argument-token

float powerIt(float inVal, int exponent);

'single y1 = powerIt(single u1, int16 p1)'

void myfunc(double *y2, double u2, double u3, double u1, double *y1);

'void myfunc(double y2[1], double u2, double u3, double u1, double y1[1])'

Генерация и компиляция S-функций

После того, как вы укажете структуру данных Legacy Code Tool для существующей функции C, используйте legacy_code функционируйте, как объяснено ниже, чтобы сгенерировать, скомпилировать и соединить S-функцию.

Как удобство, можно сгенерировать, скомпилировать и соединить S-функцию на одном шаге путем вызова legacy_code с вектором символов 'generate_for_sim'. Функция также генерирует файл TLC для ускоренных симуляций, если Options.useTlcWithAccel поле структуры данных Legacy Code Tool установлено в 1.

Если вы сгенерировали динамически загружаемый исполняемый файл, вы или другие можете использовать его в модели путем добавления Блока s-function, который задает скомпилированную S-функцию.

Генерация блока s-function маскированного для вызова сгенерированной S-функции

У вас есть опция использования Legacy Code Tool, чтобы сгенерировать Блок s-function маскированный (графическое представление), которое сконфигурировано, чтобы вызвать сгенерированную S-функцию MEX C. Чтобы сгенерировать такой блок, вызовите legacy_code с 'slblock_generate' в качестве первого аргумента и имени структуры данных Legacy Code Tool в качестве второго аргумента.

legacy_code('slblock_generate', lct_spec);

Инструмент маскирует блок, таким образом, что это отображает значение OutputFcnSpec поле . Можно затем добавить блок в модель вручную.

Если вы предпочитаете, чтобы Legacy Code Tool добавил блок в модель автоматически, задал имя модели в качестве третьего аргумента. Например:

legacy_code('slblock_generate', lct_spec, 'myModel');

Если заданная модель (например, myModel) существует, legacy_code открывает модель и добавляет Блок s-function маскированный, описанный структурой данных Legacy Code Tool. Если модель не существует, функция создает новую модель с указанным именем и добавляет Блок s-function маскированный.

Принуждение режима Accelerator Simulink, чтобы использовать S-функцию TLC, встраивающую код

Если вы используете режим Simulink Accelerator™, можно сгенерировать и обеспечить использование TLC встраивание кода для S-функции, сгенерированной Legacy Code Tool. Для этого:

Вызывание наследия функции C++

Чтобы вызвать устаревшую функцию C++ после инициализации структуры данных Legacy Code Tool, присвойте значение 'C++' Options.language поле . Например,

def = legacy_code('initialize');
def.Options.language = 'C++';

Чтобы проверить новую установку, войти

def.Options.language

Обработка нескольких регистрационных файлов

Вы можете иметь несколько регистрационных файлов в той же папке и сгенерировать S-функцию для каждого файла с одним вызовом legacy_code. Аналогично, можно использовать один вызов legacy_code для того, чтобы скомпилировать и соединить S-функции и другого, чтобы сгенерировать соответствующие файлы блока TLC, в подходящих случаях.

Рассмотрите следующий пример, где lct_register_1, lct_register_2, и lct_register_3 каждый создает и инициализирует поля структуры Legacy Code Tool.

defs1 = lct_register_1;
defs2 = lct_register_2;
defs3 = lct_register_3;
defs = [defs1(:);defs2(:);defs3(:)];

Можно затем использовать следующую последовательность вызовов legacy_code для того, чтобы сгенерировать файлы на основе трех регистрационных файлов:

legacy_code('sfcn_cmex_generate', defs);
legacy_code('compile', defs);
legacy_code('sfcn_tlc_generate', defs);

В качестве альтернативы можно обработать каждый регистрационный файл отдельно. Например:

defs1 = lct_register1;
legacy_code('sfcn_cmex_generate', defs1);
legacy_code('compile', defs1);
legacy_code('sfcn_tlc_generate', defs1);
.
.
.
defs2 = lct_register2;
legacy_code('sfcn_cmex_generate', defs2);
legacy_code('compile', defs2);
legacy_code('sfcn_tlc_generate', defs2);
.
.
.
defs3 = lct_register3;
legacy_code('sfcn_cmex_generate', defs3);
legacy_code('compile', defs3);
legacy_code('sfcn_tlc_generate', defs3);

Развертывание сгенерированных S-функций

Можно развернуть S-функции, которые вы генерируете с Legacy Code Tool для использования другими. Чтобы развернуть S-функцию для симуляции используют только, необходимо совместно использовать только скомпилированный динамически загружаемый исполняемый файл.

Примеры Legacy Code Tool

Чтобы видеть примеры Legacy Code Tool, в окне команды MATLAB, введите:

demo simulink

Примеры Legacy Code Tool перечислены в Моделировании Функций> Пользовательские блоки с S-функциями, Системными объектами и Legacy Code Tool.

Ограничения Legacy Code Tool

Legacy Code Tool