ccNOos  v0.0.0
Build Portable Microcontroller Applications!
Data Structures | Macros | Functions
execution_system.h File Reference

IMS: ccNOos, Declarations for straight C and C++ More...

#include "version_config.h"
Include dependency graph for execution_system.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  executionSystemStruct
 
struct  linkedIODeviceStruct
 
struct  linkedEntryPointStruct
 
struct  executionEntryStruct
 

Macros

#define TIME_us_PER_MIN   (60000000u)
 
#define TIME_uS_PER_HR   (3600000000u)
 
#define TIME_uS_PER_SEC   (1000000u)
 
#define TIME_SEC_PER_MIN   (60u)
 
#define TIME_MIN_PER_HR   (60u)
 
#define EXP_SETUP   (0u)
 
#define EXP_LOOP   (1u)
 
#define EXP_SYSTICK   (2u)
 
#define EXP_PLATFORM   (3u)
 
#define EXP_HANDLER   (4u)
 
#define _DeclareExeSys   struct executionSystemStruct exeSystem;
 
#define _ExeSys_   exeSystem.
 
#define __ExeSysAPIFuncsTemplate
 
#define ExeSysAPIFuncsTemplate   __ExeSysAPIFuncsTemplate
 

Functions

void platformSetup ()
 
void platformStart ()
 
void platformLoopDelay ()
 
struct executionSystemStruct CreateExecutionSystemStruct (UI_32 uSperTick)
 
UI_32 getuSecTicks ()
 
UI_32 getHourTicks ()
 
UI_32 getuSecPerSysTick ()
 
void ModuleExeArea (UI_32 ExcpIndex, struct linkedEntryPointStruct *exeListHeadIn)
 
void ModuleExceptionArea (struct linkedEntryPointStruct *exeListHeadIn)
 
int ExecuteMain (struct executionSystemStruct *exeStructIn, struct executionEntryStruct *exeEntryPtrsIn)
 
int ExecuteSetup (struct executionSystemStruct *exeStructIn, struct executionEntryStruct *exeEntryPtrsIn)
 
int ExecuteLoop (struct executionSystemStruct *exeStructIn, struct executionEntryStruct *exeEntryPtrsIn)
 
void ExecuteSysTick (struct executionSystemStruct *exeStructIn, struct executionEntryStruct *exeEntryPtrsIn)
 
void applicationConfig ()
 

Detailed Description

IMS: ccNOos, Declarations for straight C and C++

Copyright 2021 InMechaSol, Inc

Licensed under the Apache License, Version 2.0(the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Notes: (.c includes .h) - for straight C or (.cpp includes .c which includes .h) - for C++ wrapped straight C Always compiled to a single compilation unit, either C or CPP, not both

Definition in file execution_system.h.

Macro Definition Documentation

◆ __ExeSysAPIFuncsTemplate

#define __ExeSysAPIFuncsTemplate
Value:
_DeclareExeSys \
UI_32 getuSecTicks()\
{\
return _ExeSys_ uSecTicks;\
}\
UI_32 getHourTicks()\
{\
return _ExeSys_ hourTicks;\
}\
UI_32 getuSecPerSysTick()\
{\
return _ExeSys_ uSecPerSysTick;\
}

Definition at line 83 of file execution_system.h.

◆ _DeclareExeSys

#define _DeclareExeSys   struct executionSystemStruct exeSystem;

Definition at line 79 of file execution_system.h.

◆ _ExeSys_

#define _ExeSys_   exeSystem.

Definition at line 80 of file execution_system.h.

◆ ExeSysAPIFuncsTemplate

#define ExeSysAPIFuncsTemplate   __ExeSysAPIFuncsTemplate

Definition at line 97 of file execution_system.h.

◆ EXP_HANDLER

#define EXP_HANDLER   (4u)

Definition at line 47 of file execution_system.h.

◆ EXP_LOOP

#define EXP_LOOP   (1u)

Definition at line 44 of file execution_system.h.

◆ EXP_PLATFORM

#define EXP_PLATFORM   (3u)

Definition at line 46 of file execution_system.h.

◆ EXP_SETUP

#define EXP_SETUP   (0u)

Definition at line 43 of file execution_system.h.

◆ EXP_SYSTICK

#define EXP_SYSTICK   (2u)

Definition at line 45 of file execution_system.h.

◆ TIME_MIN_PER_HR

#define TIME_MIN_PER_HR   (60u)

Definition at line 39 of file execution_system.h.

◆ TIME_SEC_PER_MIN

#define TIME_SEC_PER_MIN   (60u)

Definition at line 38 of file execution_system.h.

◆ TIME_uS_PER_HR

#define TIME_uS_PER_HR   (3600000000u)

Definition at line 35 of file execution_system.h.

◆ TIME_us_PER_MIN

#define TIME_us_PER_MIN   (60000000u)

Definition at line 34 of file execution_system.h.

◆ TIME_uS_PER_SEC

#define TIME_uS_PER_SEC   (1000000u)

Definition at line 36 of file execution_system.h.

Function Documentation

◆ applicationConfig()

void applicationConfig ( )

◆ CreateExecutionSystemStruct()

struct executionSystemStruct CreateExecutionSystemStruct ( UI_32  uSperTick)

Definition at line 1 of file execution_system.c.

34 {
35  struct executionSystemStruct outStruct;
36  outStruct.hourTicks = 0u;
37  outStruct.uSecTicks = 0u;
38  outStruct.uSecPerSysTick = uSperTick;
39  return outStruct;
40 }

◆ ExecuteLoop()

int ExecuteLoop ( struct executionSystemStruct *  exeStructIn,
struct executionEntryStruct *  exeEntryPtrsIn 
)

Definition at line 173 of file execution_system.c.

177 {
178  // module exception and loop execution areas
179  ModuleExceptionArea(
180  exeEntryPtrsIn->exceptionListHead
181  );
182 
183  ModuleExeArea(
184  EXP_LOOP,
185  exeEntryPtrsIn->loopListHead
186  );
187 
188  platformLoopDelay();
189 
190  return RETURN_SUCCESS;
191 }

◆ ExecuteMain()

int ExecuteMain ( struct executionSystemStruct *  exeStructIn,
struct executionEntryStruct *  exeEntryPtrsIn 
)

Definition at line 112 of file execution_system.c.

116 {
117  if(exeStructIn == nullptr || exeEntryPtrsIn == nullptr)
118  return RETURN_ERROR;
119 
120  // platform exe system setup
121  platformSetup();
122 
123  // module setup execution area
124  ModuleExeArea(
125  EXP_SETUP,
126  exeEntryPtrsIn->setupListHead
127  );
128 
129  // platform exe system start
130  platformStart();
131 
132  // module exception and loop execution areas
133  for(;;)
134  {
135  ModuleExceptionArea(
136  exeEntryPtrsIn->exceptionListHead
137  );
138 
139  ModuleExeArea(
140  EXP_LOOP,
141  exeEntryPtrsIn->loopListHead
142  );
143 
144  platformLoopDelay();
145  }
146 
147  return RETURN_SUCCESS;
148 }

◆ ExecuteSetup()

int ExecuteSetup ( struct executionSystemStruct *  exeStructIn,
struct executionEntryStruct *  exeEntryPtrsIn 
)

Definition at line 150 of file execution_system.c.

154 {
155  if(exeStructIn == nullptr || exeEntryPtrsIn == nullptr)
156  return RETURN_ERROR;
157 
158  // platform exe system setup
159  platformSetup();
160 
161  // module setup execution area
162  ModuleExeArea(
163  EXP_SETUP,
164  exeEntryPtrsIn->setupListHead
165  );
166 
167  // platform exe system start
168  platformStart();
169 
170  return RETURN_SUCCESS;
171 }

◆ ExecuteSysTick()

void ExecuteSysTick ( struct executionSystemStruct *  exeStructIn,
struct executionEntryStruct *  exeEntryPtrsIn 
)

Definition at line 193 of file execution_system.c.

197 {
198  exeStructIn->uSecTicks += exeStructIn->uSecPerSysTick;
199  if(exeStructIn->uSecTicks >= TIME_uS_PER_HR)
200  {
201  exeStructIn->uSecTicks = 0u;
202  exeStructIn->hourTicks++;
203  }
204 
205  // module systick execution area
206  ModuleExeArea(
207  EXP_SYSTICK,
208  exeEntryPtrsIn->sysTickListHead
209  );
210 
211 }

◆ getHourTicks()

UI_32 getHourTicks ( )

◆ getuSecPerSysTick()

UI_32 getuSecPerSysTick ( )

◆ getuSecTicks()

UI_32 getuSecTicks ( )

◆ ModuleExceptionArea()

void ModuleExceptionArea ( struct linkedEntryPointStruct *  exeListHeadIn)

Definition at line 80 of file execution_system.c.

83 {
84  struct linkedEntryPointStruct* currentExeNode = exeListHeadIn;
85  int retVal;
86  if(currentExeNode!=nullptr)
87  {
88  if(currentExeNode->entryPoint != nullptr)
89  {
90  do
91  {
92  if(currentExeNode->dataPtr->exceptionFlags!=0u)
93  retVal = currentExeNode->entryPoint(
94  currentExeNode->dataPtr
95  );
96  else
97  retVal = RETURN_SUCCESS;
98 
99  if(retVal != RETURN_SUCCESS)
100  currentExeNode->dataPtr->exceptionFlags |= (0x00000001 << EXP_HANDLER);
101 
102  if(currentExeNode->nextPtr != nullptr)
103  currentExeNode = currentExeNode->nextPtr;
104  else
105  break;
106 
107  }while(currentExeNode->entryPoint != nullptr);
108  }
109  }
110 }

◆ ModuleExeArea()

void ModuleExeArea ( UI_32  ExcpIndex,
struct linkedEntryPointStruct *  exeListHeadIn 
)

Definition at line 47 of file execution_system.c.

51 {
52  struct linkedEntryPointStruct* currentExeNode = exeListHeadIn;
53  int retVal;
54  if(currentExeNode!=nullptr)
55  {
56  if(currentExeNode->entryPoint != nullptr)
57  {
58  do
59  {
60  if(currentExeNode->dataPtr->exceptionFlags==0u)
61  retVal = currentExeNode->entryPoint(
62  currentExeNode->dataPtr
63  );
64  else
65  retVal = RETURN_SUCCESS;
66 
67  if(retVal != RETURN_SUCCESS)
68  currentExeNode->dataPtr->exceptionFlags |= (0x00000001 << ExcpIndex);
69 
70  if(currentExeNode->nextPtr != nullptr)
71  currentExeNode = currentExeNode->nextPtr;
72  else
73  break;
74 
75  }while(currentExeNode->entryPoint != nullptr);
76  }
77  }
78 }

◆ platformLoopDelay()

void platformLoopDelay ( )

Definition at line 128 of file Platform_Arduino.h.

129 {
130 
131  ReadSerialUARTS();
132 
133 
134  //<platformLoopDelay>
135  ;
136  //</platformLoopDelay>
137 }

◆ platformSetup()

void platformSetup ( )

Definition at line 66 of file Platform_Arduino.h.

67 {
68  //<platformSetup>
69 #ifdef __USINGCONSOLEMENU
70 #ifdef __USINGFLOATPRINTF
71  asm(".global _printf_float");
72 #endif
73 #endif
74  ConsoleMenuserialdev.devdata = createDeviceStruct();
75  ConsoleMenuserialdev.baudRate = 115200;
76  ConsoleMenuserialdev.dataBits = 8;
77  ConsoleMenuserialdev.stopBits = stop_one;
78  ConsoleMenuserialdev.parity = parity_none;
79  ConsoleMenuserialdev.handshake = handshake_none;
80 
81  LCDKeyPadserialdev.devdata = createDeviceStruct();
82  LCDKeyPadserialdev.baudRate = 9600;
83  LCDKeyPadserialdev.dataBits = 8;
84  LCDKeyPadserialdev.stopBits = stop_one;
85  LCDKeyPadserialdev.parity = parity_none;
86  LCDKeyPadserialdev.handshake = handshake_none;
87 
88  GPSserialdev.devdata = createDeviceStruct();
89  GPSserialdev.baudRate = 9600;
90  GPSserialdev.dataBits = 8;
91  GPSserialdev.stopBits = stop_one;
92  GPSserialdev.parity = parity_none;
93  GPSserialdev.handshake = handshake_none;
94 
95  eCompserialdev.devdata = createDeviceStruct();
96  eCompserialdev.baudRate = 19200;
97  eCompserialdev.dataBits = 8;
98  eCompserialdev.stopBits = stop_one;
99  eCompserialdev.parity = parity_none;
100  eCompserialdev.handshake = handshake_none;
101 
102  Serial.begin(115200);
103  Serial1.begin(GPSserialdev.baudRate);
104  Serial2.begin(eCompserialdev.baudRate);
105  Serial3.begin(LCDKeyPadserialdev.baudRate);
106  Wire.begin();
107 
108  while (!Serial) {
109  ; // wait for serial port to connect. Needed for native USB port only
110  }
111  //</platformSetup>
112 }

◆ platformStart()

void platformStart ( )

Definition at line 114 of file Platform_Arduino.h.

115 {
116  //<platformStart>
117  GPSserialdev.readIndex = 0;
118  eCompserialdev.readIndex = 0;
119  GPSserialdev.numBytes2Read = 1;
120  eCompserialdev.numBytes2Read = 1;
121  LCDKeyPadserialdev.readIndex = 0;
122  ConsoleMenuserialdev.readIndex = 0;
123  LCDKeyPadserialdev.numBytes2Read = 1;
124  ConsoleMenuserialdev.numBytes2Read = 1;
125  //</platformStart>
126 }
SerialDeviceStruct::baudRate
int baudRate
Definition: io_device.h:117
linkedEntryPointStruct::dataPtr
struct computeModuleStruct * dataPtr
Definition: execution_system.h:117
ReadSerialUARTS
void ReadSerialUARTS()
Definition: Platform_Arduino.h:57
EXP_SETUP
#define EXP_SETUP
Definition: execution_system.h:43
handshake_none
@ handshake_none
Definition: io_device.h:109
executionSystemStruct::uSecPerSysTick
UI_32 uSecPerSysTick
Definition: execution_system.h:60
LCDKeyPadserialdev
struct SerialDeviceStruct LCDKeyPadserialdev
Definition: Platform_Arduino.h:49
EXP_HANDLER
#define EXP_HANDLER
Definition: execution_system.h:47
executionEntryStruct::loopListHead
struct linkedEntryPointStruct * loopListHead
Definition: execution_system.h:126
SerialDeviceStruct::dataBits
int dataBits
Definition: io_device.h:118
_ExeSys_
#define _ExeSys_
Definition: execution_system.h:80
ModuleExeArea
void ModuleExeArea(UI_32 ExcpIndex, struct linkedEntryPointStruct *exeListHeadIn)
Definition: execution_system.c:47
linkedEntryPointStruct::nextPtr
struct linkedEntryPointStruct * nextPtr
Definition: execution_system.h:116
SerialDeviceStruct::parity
enum portParityEnum parity
Definition: io_device.h:120
executionSystemStruct
Definition: execution_system.h:57
GPSserialdev
struct SerialDeviceStruct GPSserialdev
Definition: Platform_Arduino.h:47
getHourTicks
UI_32 getHourTicks()
ConsoleMenuserialdev
struct SerialDeviceStruct ConsoleMenuserialdev
Definition: Platform_Arduino.h:50
executionEntryStruct::exceptionListHead
struct linkedEntryPointStruct * exceptionListHead
Definition: execution_system.h:128
SerialDeviceStruct::numBytes2Read
int numBytes2Read
Definition: io_device.h:123
platformStart
void platformStart()
Definition: Platform_Arduino.h:114
linkedEntryPointStruct::entryPoint
int(* entryPoint)(struct computeModuleStruct *dataPtrIn)
Definition: execution_system.h:118
getuSecTicks
UI_32 getuSecTicks()
eCompserialdev
struct SerialDeviceStruct eCompserialdev
Definition: Platform_Arduino.h:48
EXP_LOOP
#define EXP_LOOP
Definition: execution_system.h:44
SerialDeviceStruct::stopBits
enum portStopBitsEnum stopBits
Definition: io_device.h:119
platformSetup
void platformSetup()
Definition: Platform_Arduino.h:66
platformLoopDelay
void platformLoopDelay()
Definition: Platform_Arduino.h:128
EXP_SYSTICK
#define EXP_SYSTICK
Definition: execution_system.h:45
ModuleExceptionArea
void ModuleExceptionArea(struct linkedEntryPointStruct *exeListHeadIn)
Definition: execution_system.c:80
parity_none
@ parity_none
Definition: io_device.h:101
SerialDeviceStruct::handshake
enum portHandshakeEnum handshake
Definition: io_device.h:121
getuSecPerSysTick
UI_32 getuSecPerSysTick()
stop_one
@ stop_one
Definition: io_device.h:95
executionSystemStruct::hourTicks
UI_32 hourTicks
Definition: execution_system.h:59
executionEntryStruct::setupListHead
struct linkedEntryPointStruct * setupListHead
Definition: execution_system.h:125
computeModuleStruct::exceptionFlags
UI_32 exceptionFlags
Definition: compute_module.h:34
linkedEntryPointStruct
Definition: execution_system.h:115
TIME_uS_PER_HR
#define TIME_uS_PER_HR
Definition: execution_system.h:35
RETURN_SUCCESS
#define RETURN_SUCCESS
Function Return Value for Success.
Definition: version_config.h:87
RETURN_ERROR
#define RETURN_ERROR
Function Return Value for ERROR.
Definition: version_config.h:92
executionSystemStruct::uSecTicks
UI_32 uSecTicks
Definition: execution_system.h:58
createDeviceStruct
struct devicedatastruct createDeviceStruct()
Definition: io_device.c:31
executionEntryStruct::sysTickListHead
struct linkedEntryPointStruct * sysTickListHead
Definition: execution_system.h:127
SerialDeviceStruct::devdata
struct devicedatastruct devdata
Definition: io_device.h:122
SerialDeviceStruct::readIndex
int readIndex
Definition: io_device.h:124
Generated by doxygen 1.8.20