为模型入口函数配置生成的 C 函数接口
什么是入口函数?
入口是代码中发生程序控制权(执行)转移的位置。主函数 (main()
) 是进入 C/C++ 程序的入口,在应用程序开始执行时调用。对其他函数的调用(例如从 main
函数调用)是进入函数代码的入口。程序控制权会转移到被调函数。函数代码随后执行,在完成后将控制权交还给 main
或其他主调函数。
为模型生成代码时,代码生成器会定义一组入口函数,您可以调用这些函数来执行生成的代码。您可以从外部代码或生成的主函数的修改版调用生成的函数。
代码生成报告的“代码接口报告”部分会列出代码生成器为模型生成的入口函数。有关详细信息,请参阅 Analyze Generated Data Code Interface (Embedded Coder)。
生成的入口函数的类型
代码生成器为下列类型的模型函数生成入口函数。
模型函数的类型 | 模型源函数名称 | 默认的生成函数名称 | 描述 |
---|---|---|---|
导出函数(需要 Embedded Coder®) | ExportedFunction: ,其中 是模型中函数调用 Inport 模块的名称 | 或 (如果指定) | 对于导出函数模型,即为子系统的导出函数。 |
初始化函数 | Initialize |
| 模型的初始化代码。在应用程序代码的开始,调用函数一次。请不要使用此函数重置实时模型数据结构体 ( |
分区函数 | Partition: ,其中 是从模型中的模块显式创建的一个分区并显示在 Simulink® 调度编辑器中(例如 P1),或是“并行执行”对话框中的一个任务名称 | ,其中 基于模型采样周期唯一标识生成的函数 | 对于模型分区,输出并更新代码。模型配置参数单一输出/更新函数处于选中状态(默认值)。 |
分区更新函数 | PartitionUpdate: ,其中 是从模型中的模块显式创建的一个分区并显示在 Simulink® 调度编辑器中(例如 P1),或是“并行执行”对话框中的一个任务名称 | 和 ,其中 基于模型采样周期唯一标识生成的函数 | 对于模型分区,使用分别的函数输出和更新代码。模型配置参数单一输出/更新函数处于未选中状态。 |
周期性多任务函数 | Periodic: ,其中 是一个注释,对应于多任务模型的一个周期性或连续速率的采样时间周期(例如,D1) | ,其中 基于模型采样周期唯一标识生成的函数 | 对于为多任务配置的一个基于速率的模型中的模块,输出和更新代码。代码生成器为每个采样周期生成一个函数。模型配置参数单一输出/更新函数处于选中状态(默认值)。 |
周期性多任务更新函数 | PeriodicUpdate: ,其中 是一个注释,对应于多任务模型的一个周期性或连续速率的采样时间周期(例如,D1) | 和 ,其中 基于模型采样周期唯一标识生成的函数 | 对于为多任务配置的一个基于速率的模型中的模块,分别在单独的函数中输出和更新代码。代码生成器为每个采样周期生成输出和更新函数。模型配置参数单一输出/更新函数处于未选中状态。 |
周期性单任务函数 | Periodic |
| 对于为单任务配置的基于速率的模型中的模块,输出和更新代码。模型配置参数单一输出/更新函数处于选中状态(默认值)。 |
周期性单任务更新函数 | PeriodicUpdate | 和
| 对于为单任务配置的基于速率的模型中的模块,分别在单独的函数中输出和更新代码。模型配置参数单一输出/更新函数处于未选中状态。 |
重置函数 | Reset: ,其中 是模型中重置函数的名称 |
| 如果模型包含 Reset Function 模块,则重置生成的代码。要重置条件或状态,请从应用程序代码中调用函数。 |
Simulink 函数 | Simulink Function: ,其中 是模型中 Simulink Function 模块的名称 | 对于全局 Simulink Function 模块,为 ;对于限定作用域的 Simulink Function 模块,为
| 对于导出函数模型,是 Simulink Function 模块的导出函数。 |
终止函数 | Terminate |
| 用于关闭系统的代码。对于基于 ERT 的模型,您可以通过清除模型配置参数需要终止函数 (Embedded Coder)(默认设置)来隐藏此函数的生成。 |
如果您有 Embedded Coder 软件,为了便于集成外部代码和生成的代码并符合代码标准和规范,您可以配置代码生成器如何从模型或子系统生成函数接口。
配置入口函数是否可重用
默认情况下,对于顶层模型,代码生成器生成不可重用或不可重入的代码。入口函数有一个 void-void
接口。代码通过直接访问驻留在共享内存中的全局数据结构体来与其他代码通信。
如果您的应用程序需要可重用的多实例入口函数代码,您可以配置代码生成器使用唯一数据来调用每个函数(实例)。在这种情况下,代码是可重入的。
您可以使用模型配置参数代码接口打包和相关参数来配置入口函数是否可重用。您选择的参数设置取决于系统目标文件的配置选择、编程语言和参数接口等因素。
单实例 C 入口函数的默认配置
默认情况下,对于基于 GRT 和基于 ERT 的系统目标文件,代码生成器生成单实例 C 入口函数。生成的代码:
创建不带参数的执行函数 (
void-void
)。为模型数据结构体静态分配内存(在编译时)。
配置单实例入口函数代码的默认模型配置参数设置为:
生成可重用的多实例 C 入口函数
您可以配置代码生成器,为基于 GRT 或基于 ERT 的系统目标文件生成可重用的 C 入口函数。但是,代码生成器默认生成的各函数接口有所不同。假设模型配置参数语言设置为 “C
” 且代码接口打包设置为“可重用函数
”,代码生成器为每个系统目标文件场景生成以下入口函数代码。
系统目标文件 | 接口 |
---|---|
基于 GRT |
|
基于 ERT |
|
如果您使用的是基于 ERT 的系统目标文件,并希望生成可重用、可重入的多实例 C 入口函数,请考虑:
使用动态内存分配来初始化模型数据结构体。选择使用动态内存分配进行模型初始化 (Embedded Coder)。
将模型根级 Inport 模块的值打包到一个结构体中,将根级 Outport 模块的值打包到另一个结构体中,并按引用将这些结构体作为参数传递给执行函数。将根级 I/O 传递方式 (Embedded Coder)设置为“
结构体引用
”。将模型根级 Inport 模块和 Outport 模块的值打包到实时模型数据结构体中,并按引用将该结构体作为参数传递给执行函数。将根级 I/O 传递方式 (Embedded Coder)设置为“
模型数据结构体的一部分
”。
如何与生成的入口函数对接
为模型生成代码后,使用代码视图查看生成的入口函数,以及表示外部输入和输出端口的变量(如果适用)。
将
#include
语句添加到外部代码中,这些语句包括声明模型入口函数的生成的头文件。添加一条
#include
语句以包含生成的文件rtwtypes.h
。此文件提供类型定义、#define
语句和枚举。初始化目标特定的数据结构体和硬件,如 ADC 或 DAC。
如果适用,为可重用模型的每个实例初始化数据。
如果适用,将输入数据写入表示模型 Inport 模块的生成变量。
调用生成的入口函数或设置
rt_OneStep
函数的使用。如果适用,从表示模型 Outport 模块的生成变量中读取数据。
有关详细信息,请参阅Deploy Applications to Target Hardware (Embedded Coder)。
C 函数接口自定义限制
生成的 C 函数接口的自定义有以下限制:
您必须选择模型配置参数单一输出/更新函数。
支持多速率模型,但您必须为单任务配置模型。
您必须配置根级输入端口和输出端口以使用
Default
存储类。如果您选择自定义函数接口,您必须提供自己的自定义
main
程序。您无法使用 MathWorks® 提供的静态rt_main.c
来配置函数接口。指定非默认的函数接口配置会导致生成的代码与默认静态rt_main.c
不匹配。代码生成器会删除模型根输入端口的数据结构体,除非由不可重用函数实现的子系统使用一个或更多个输入端口的值。
代码生成器会删除模型的根输出端口的数据结构体,除非您启用 MAT 文件记录或者一个或更多个输出端口的采样时间不是基本速率(包括恒定速率)。
如果您复制子系统模块以在新模型或同一模型中创建模块,则原始子系统模块的函数接口信息不会复制到新子系统模块中。
如果您有 Stateflow®,则对于使用模型根输入端口值或调用使用模型根输入端口值的子系统的 Stateflow 图,请执行以下操作之一来生成代码:
在 Stateflow 图中,清除初始化时执行(进入)图复选框。
将 Stateflow 函数设置为不可重用的函数。
在根输入端口后立即插入 Simulink® Signal Conversion 模块。在 Signal Conversion 模块参数对话框中,选择从 ''模块简化'' 优化中排除此模块。
如果模型根输入端口值连接到 Simscape™ 转换模块,请在根输入端口和 Simscape 转换模块之间插入 Simulink Signal Conversion 模块。在 Signal Conversion 模块参数对话框中,选择从 ''模块简化'' 优化中排除此模块。
当编译配置有函数接口的引用模型时,不要使用虚拟总线作为引用模型的输入或输出。请改用非虚拟总线。
如果 C 函数接口不是默认值,则忽略模型配置参数为代码生成按值传递固定大小的标量根输入的值。有关详细信息,请参阅Pass fixed-size scalar root inputs by value for code generation。
另请参阅
Simulink Function | Function Caller