Added the start documentation (for me haha) and updated the .gitignore

Author: drowsymike

.gitignore

@@ -1,3 +1,6 @@
 *.hex
 *.bin
-*.elf
+*.elf
+examples/stm32f4x/compile_commands.json
+.cache
+compile_commands.json

.vscode/c_cpp_properties.json

@@ -0,0 +1,40 @@
+# Structure of source files
+
+`inc/sch.h` - main the list of contents (system's headers)
+`inc/sch_common.h` - a header what inites the keywords within the system. Some technical things
+`inc/sch_config.h` - the config what'll configure the system. Defines the quantity of tasks and the mode of arbitration
+`inc/sch_context_change.h` - the header what creates the header of functions what will be implemented by the Assenbly or C code within the `port/`-files. These functions intended to switch the context
+`inc/sch_event_management.h` - the basic functional for event-driven interaction - the ability to transmit the data between the tasks
+`inc/sch_task_management.h` - the header what creates the header of functions what will be implemented by the Assenbly or C code within the `port/`-files. These functions intended to help to do the task management
+
+`port/{platform}/sch_assertion.c` - implements the functions from the `sch_common.h`-file
+`port/{platform}/sch_context_change.c` - implements the functions from the `sch_context_change.h`-file
+`port/{platform}/sch_context_change.s` - implements the functions from the `sch_context_change.h`-file in Assembly
+`port/{platform}/sch_event_management.c` - implements the functions from the `sch_event_management.h`-file in Assembly
+`port/{platform}/sch_find_most_significant_task.s` - inplements the function of finding the most significant task by Assembly
+
+# Simple example of creating the task:
+```
+
+void sch_task_dispatch(sch_task_t* task);
+void sch_task_init(sch_task_t* task);
+
+void main() {
+  sch_task_t first_task;
+  sch_task_create(&first_task, -3, 0, sch_task_dispatch, sch_task_init);
+  sch_task_activate(&first_task);
+
+}
+
+void sch_task_dispatch(sch_task_t* task) {
+  //something to do
+}
+
+void sch_task_init(sch_task_t* task) {
+  //something to do
+}
+
+```
+
+The `sch_task_create` attaches the task's parts to the main object to make it easy to call. For example, the typical dispatch function: `sch_task_dispatch` as the main task's function - that func describes what task will actually do. You can see the arguments of the function in the `sch/src/sch.c` file.
+Also the `sch_task_init` function will use by the user as the start of the task. But keep in mind that the init function will call at the moment of creating the task itself.

.vscode/settings.json

@@ -21,6 +21,7 @@ CFLAGS += -Iplatform/cmsis/CMSIS/Include
 CFLAGS += -Iplatform/cmsis/CMSIS/Device/ST/STM32F4xx/Include
 CFLAGS += -I../../sch/inc
 CFLAGS += -I../../sch/src
+CFLAGS += -I../../sch/port/stm32f4xx
 CFLAGS += $(DEFS)
 
 ASFLAGS = $(MCU) $(OPT)
@@ -50,6 +51,7 @@ app/src/sysmem.c \
 ../../sch/src/sch.c \
 ../../sch/port/stm32f4xx/sch_find_most_significant_task.s \
 ../../sch/port/stm32f4xx/sch_context_change.s \
+../../sch/port/stm32f4xx/sch_event_management.c \
 
 all: $(TARGET).elf
 

doc/glossary.md

@@ -18,7 +18,6 @@ extern "C" {
 #include <stdint.h>
 
 #include "sch_config.h"
-#include "sch_assertion.h"
 #include "sch_context_change.h"
 #include "sch_common.h"
 #include "sch_task_management.h"

doc/sch.md

@@ -9,14 +9,16 @@
 #ifndef SCH_COMMON_H
 #define SCH_COMMON_H
 
+#include <cstdint>
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /*--Weak macro definition----------------------------------------------------*/
 
 /**
- * @brief 
+ * @brief The definition of portable 
+ * common __WEAK construction 
  * 
  */
 #if defined(__GNUC__)
@@ -29,8 +31,60 @@ extern "C" {
   #define __WEAK
 #endif
 
+/*--Checking compilation conditions------------------------------------------*/
+
+/**
+ * @brief Check macro definitions
+ * 
+ * @details Checking the definition of a macro, 
+ * with the value of which the functions of the 
+ * "function module" sch_assertion will later 
+ * be called
+ * 
+ */
+#ifdef SCH_ASSERTION_NORETURN
+    #define SCH_NORETURN_FUNC_ATTRIBUTE __attribute__((noreturn))
+#else
+    #define SCH_NORETURN_FUNC_ATTRIBUTE
+#endif
+
+/**
+ * @brief Check macro definitions
+ * 
+ * @details Checking the definition of the macro 
+ * responsible for calling the sch_fault_handler 
+ * error handler
+ * 
+ * @note The configuration of the sch_fault_handler 
+ * function is determined, among other things, by 
+ * the SCH_ASSERTION_NORETURN macro
+ * 
+ */
+#ifdef SCH_ASSERTION
+    #define SCH_ASSERT(expr) ((expr) ? ((void)0) : sch_fault_handler())
+#else
+    #define SCH_ASSERT(expr) ((expr) ? ((void)0) : sch_fault_handler())
+#endif
+
+/*--Definition of functions--------------------------------------------------*/
+
+/**
+ * @brief Error handling function
+ * 
+ * @note The function has an additional attribute 
+ * for returning to the context from which the 
+ * function was called. The value of this attribute 
+ * depends on the definition (or non-definition) of 
+ * the SCH_ASSERTION_NORETURN macro
+ * 
+ * @return void 
+ */
+__WEAK SCH_NORETURN_FUNC_ATTRIBUTE void sch_fault_handler(void);
+
+/*---------------------------------------------------------------------------*/
+
 #ifdef __cplusplus
 }
 #endif
 
-#endif
+#endif