Начата работа с документацией

This commit is contained in:
2024-10-11 14:09:52 +03:00
parent ac187eb2d3
commit 6a08b0462d
759 changed files with 370188 additions and 223 deletions

View File

@@ -1,23 +1,27 @@
/**************************************************************************
Данный файл содержит функции для симуляции МК в Simulink (S-Function).
Данный файл содержит функции для симуляции МК в Simulink (S-Function).
**************************************************************************/
#include "mcu_wrapper_conf.h"
SIM__MCUHandleTypeDef hmcu; // для управления контекстом программы МК
SIM__MCUHandleTypeDef hmcu; // для управления контекстом программы МК
double SystemClockDouble = 0; // для симуляции системных тиков, прока просто по приколу
double SystemClock_step = 0; // для симуляции системных тиков, прока просто по приколу
uint64_t SystemClock; // для симуляции системных тиков, прока просто по приколу
double SystemClockDouble = 0; // для симуляции системных тиков, прока просто по приколу
double SystemClock_step = 0; // для симуляции системных тиков, прока просто по приколу
uint64_t SystemClock; // для симуляции системных тиков, прока просто по приколу
//-------------------------------------------------------------//
//-----------------CONTROLLER SIMULATE FUNCTIONS---------------//
/** THREAD FOR MCU APP */
/**
* @brief Thread that run MCU code.
* @note Поток, который запускает и выполняет код МК.
* @brief Main function of MCU app.
* @details Функция с которой начинается выполнение кода МК. Выход из данной функции происходит только в конце симуляции @ref mdlTerminate
*/
extern int main(void); // extern while from main.c
/** THREAD FOR MCU APP */
/**
* @brief Thread that run MCU code.
* @details Поток, который запускает и выполняет код МК (@ref main).
*/
unsigned __stdcall MCU_App_Thread(void) {
main(); // run MCU code
return 0; // end thread
@@ -25,15 +29,15 @@ unsigned __stdcall MCU_App_Thread(void) {
}
/** SIMULATE MCU FOR ONE SIMULATION STEP */
/**
* @brief Read from simulink S-Block Inputs and write to MCU I/O ports.
* @param time - current time of simulation (in second).
* @note Вызывает главную функцию main из пользовательского кода и управляет её ходом:
* Прерывает её, если она попала в бесконечный while, симулирует периферию
* и возвращает в точку остановки на следующем шаге.
* @brief Read from simulink S-Block Inputs and write to MCU I/O ports.
* @param time - current time of simulation (in second).
* @details Запускает поток, который выполняет код МК и управляет ходом потока:
* Если прошел таймаут, поток прерывается, симулируется периферия
* и на следующем шаге поток возобнавляется.
*/
void MCU_Step_Simulation(SimStruct* S, time_T time)
{
MCU_readInputs(S); // считывание портов
MCU_readInputs(S); // считывание портов
MCU_Periph_Simulation(); // simulate peripheral
@@ -43,13 +47,13 @@ void MCU_Step_Simulation(SimStruct* S, time_T time)
}
SuspendThread(hmcu.hMCUThread);
MCU_writeOutputs(S); // запись портов (по факту запись в буфер. запись в порты в mdlOutputs)
MCU_writeOutputs(S); // запись портов (по факту запись в буфер. запись в порты в mdlOutputs)
}
/** SIMULATE MCU PERIPHERAL */
/**
* @brief Simulate peripheral of MCU
* @note Пользовательский код, который симулирует работу периферии МК.
* @brief Simulate peripheral of MCU
* @details Пользовательский код, который симулирует работу периферии МК.
*/
void MCU_Periph_Simulation(void)
{
@@ -62,8 +66,9 @@ void MCU_Periph_Simulation(void)
/** READ INPUTS S-FUNCTION TO MCU REGS */
/**
* @brief Read from simulink S-Block Inputs and write to MCU I/O ports.
* @note Пользовательский код, который записывает в порты ввода-вывода из disc.
* @brief Read from simulink S-Block Inputs and write to MCU I/O ports.
* @param in - inputs of S-Function.
* @details Пользовательский код, который записывает в порты ввода-вывода из disc.
*/
void MCU_readInputs(SimStruct* S)
{
@@ -75,8 +80,9 @@ void MCU_readInputs(SimStruct* S)
/** WRITE OUTPUTS BUFFER S-FUNCTION FROM MCU REGS*/
/**
* @brief Read from MCU I/O ports and write to simulink S-Block Outputs Buffer.
* @note Пользовательский код, который записывает в disc порты ввода-вывода.
* @brief Read from MCU I/O ports and write to simulink S-Block Outputs.
* @param disc - discrete array of S-Function. Outputs would be written from disc.
* @details Пользовательский код, который записывает в disc порты ввода-вывода.
*/
void MCU_writeOutputs(SimStruct* S)
{
@@ -94,9 +100,9 @@ void MCU_writeOutputs(SimStruct* S)
//----------------------SIMULINK FUNCTIONS---------------------//
/** WRITE OUTPUTS OF S-BLOCK */
/**
* @brief Write S-Function Output ports to inputs.
* @param disc - discrete array of S-Function. Outputs would be written from disc.
* @note Пользовательский код, который записывает выходы S-Function.
* @brief Write S-Function Output ports to inputs.
* @param disc - discrete array of S-Function. Outputs would be written from disc.
* @details Пользовательский код, который записывает выходы S-Function.
*/
void SIM_writeOutputs(SimStruct* S)
{
@@ -117,8 +123,8 @@ void SIM_writeOutputs(SimStruct* S)
}
/** MCU WRAPPER DEINITIALIZATION */
/**
* @brief Initialize structures and variables for simulating MCU.
* @note Пользовательский код, который будет настраивать все структуры для симуляции.
* @brief Initialize structures and variables for simulating MCU.
* @details Пользовательский код, который будет настраивать все структуры для симуляции.
*/
void SIM_Initialize_Simulation(void)
{
@@ -126,14 +132,14 @@ void SIM_Initialize_Simulation(void)
Initialize_Periph_Sim();
/* wrapper initialization */
SystemClock_step = SystemCoreClock * SIM_Sample_Time; // set system clock step
// инициализация потока, который будет выполнять код МК
SystemClock_step = SystemCoreClock * hmcu.SIM_Sample_Time; // set system clock step
// инициализация потока, который будет выполнять код МК
hmcu.hMCUThread = (HANDLE)CreateThread(NULL, 0, MCU_App_Thread, 0, CREATE_SUSPENDED, &hmcu.idMCUThread);
}
/** MCU WRAPPER DEINITIALIZATION */
/**
* @brief Deinitialize structures and variables for simulating MCU.
* @note Пользовательский код, который будет очищать все структуры после окончания симуляции.
* @brief Deinitialize structures and variables for simulating MCU.
* @details Пользовательский код, который будет очищать все структуры после окончания симуляции.
*/
void SIM_deInitialize_Simulation(void)
{
@@ -145,10 +151,10 @@ void SIM_deInitialize_Simulation(void)
//-------------------------------------------------------------//
////-----------INIT WRAPPER-----------
//if (hmcu.MCU_Start) // если надо получть указатель на "начало" стека
//{ // сброс флаша, чтобы сюда больше не попадать
//if (hmcu.MCU_Start) // если надо получть указатель на "начало" стека
//{ // сброс флаша, чтобы сюда больше не попадать
// hmcu.MCU_Start = 0;
// // инициализация потока, который будет выполнять код МК
// // инициализация потока, который будет выполнять код МК
// hmcu.hMCUThread = (HANDLE)_beginthreadex(NULL, 0, MCU_App_Thread, 0, 0x00000004, &hmcu.idMCUThread); /* 0x00000004 - CREATE_SUSPENDED */
//}
////----------------------------------