Femto OS

0.88

Introduction

Below, find an overview of the configuration parametes you need to set. This list is only valid for version 0.88 of Femto OS. Please select the correct version first, for names, codes and descriptions made be significantly different between the versions.

Please have a look inside the file femtoos_config.h for a more elaborate discussion about the use. Note that there exists a template (at the bottom of femtoos_config.h) with predefined default values you can use in you own code, so you do not have to type all these parameters yourself.

System configuration
cfgSysOptimized	Switch between two sets of configuration parameters
cfgSysDebug	Used to debug on the Atmel Studio
cfgSysInline	Force inlining of some internal methods to reduce OS stack use.
cfgSysFramePointerCounterMeasures	To suppress the use of the frame pointer even further.
cfgSysReduceProEpilogue	Manage the code inside the pro- and epiloge.
cfgSysRegisterCheckByte	Specify the byte with which the registers are initially filled.
cfgSysStackGrowthUp	Specify the direction the stack grows.
cfgSysZeroPageStack	Reduce the stack pointer when all stacks fit on page zero
cfgSysClearUnusedR1	Makes sure r1 is always cleared after a context switch.
cfgSysSqueezeState	Squeeze all info needed by Femto OS in the Status Register.
cfgSysClockDivider	Specify the divider on the clock frequency used in the device.
cfgSysSubTicksPerFullTick	Subdivider for the tickcounter
cfgSysSubTickDivider	Setting of the hardware prescaler of the tick counter.
cfgSysGCCstartup	Switch to replace the startup code produced by gcc
cfgSysFsStorageSpace	Specify the total size of the storage in bytes

Interrupt handling
cfgIntGlobalOnly	To indicate that timer interrupts may be treated as global.
cfgIntUserDefined	To indicate you use interrupts of your own, possibly with an isr.
cfgIntSwitchUsesOSstack	Set this to let the isr run in OS space.
cfgIntOsProtected	Set this to protect the Femto OS from being interrupted.
cfgIntTickTrack	Activate to be able to block tick interrupts during part of a task.

Quality Assurance
cfgCheckReset	Give a signal through the error port that the system has reset.
cfgCheckTrace	Activate tracing, most OS activities are reported.
cfgCheckWatermarks	Keep watermarks of the stack and register use.
cfgCheckOsStack	Check if the OS stack keeps within the given limits.
cfgCheckTaskStack	Check if each task stack keeps with the given limits.
cfgCheckIsrStack	Check if the isr stack keeps with the given limits.
cfgCheckRegisters	Check if use is made of registers not saved on the context.
cfgCheckTiming	Check if the tick is long enough to let OS and tasks do their jobs.
cfgCheckQueuFilling	Check if the queu's are not overrun or underrun.
cfgCheckMethodUse	Checks if you make proper use of the API.
cfgCheckApplication	Activate checking of the user quality assurance.
cfgCheckAlwaysFatal	Decide if all reported errors should be treated as fatal.

System capabilities
cfgUseEquidistantTicks	Make sure every tick takes an equal amount of time.
cfgUseDelay	If you need delays or timeouts in your code, activate this.
cfgUseSynchronization	Activate if you make use of the synchronization primitives.
cfgUseNestedCriticals	If you need to nest critical blocks, activate this.
cfgUsePriorityLifting	If you need to make use of priority inheritance, activate this.
cfgUseTaskWatchdog	Activate this to protect a task against infinite loops and waits.
cfgUseCorrectWakeupTimes	Activate to keep track of the last task activation times.
cfgUseTimeout	Activate to enable timeout on all synchronizing methods.
cfgUseTasknames	Activate to reserve room in flash for dynamic task names.
cfgUseLowPowerSleep	Make the Femto OS aware of low power sleep modes.
cfgUseLowPowerOnDelay	Let the OS sleep as soon as all tasks are sufficiently delayed.
cfgUseLowPowerDelayRelease	Activate to correct delay times, if the device over slept.
cfgUseLoadMonitor	To keep track of the time spend in all tasks, os and isr.
cfgUseFileSystem	Activate the Femto File System on EEPROM
cfgUseFileSystemConcurrentRead	Separate read/write regions from read only regions.
cfgUseFileSystemEconomyMode	Option to save erase/write cycles on the file system / eeprom
cfgUseFileSystemMaintainFAT	Keep a table with the use of all files
cfgUseEvents	Lightweight messaging system between tasks and/or isr.
cfgUseEventsOnVariables	Activate if you need to use genFireEvent on variables.

System numerical parameters
cfgNumWatchdogDiv	Determines the frequency of watchdog checkups.
cfgNumMonitorDiv	Determines the copy frequency of the load monitor.
cfgNumSleepPeriod	Number of milliseconds the device may continuously sleep
cfgNumSleepThreshold	Minimum number of milliseconds the delay must be for sleeping.
cfgNumGlobWidth	Number of bits for counting the depth of global critical nesting.
cfgNumSwitchWidth	Number of bits for counting the depth of switch critical nesting.
cfgNumTickWidth	Number of bits for counting the depth of tick critical nesting.

External calls
callAppTick00	Activates the tick hook that fires every tick.
callAppTick08	Activates the tick hook that fires every 256 ticks
callAppTick16	Activates the tick hook that fires every 65536 ticks
callAppEnterIdle	Activates the idle hook that fires just before going idle.
callAppEnterSleep	Enable sleep hook that fires just before going to low power sleep.
callAppTickSleep	Enable sleep hook that fires at in-between wakeups.
callAppExitSleep	Enable sleep hook that fires just after going to low power sleep.
callAppBoot	Enable initialization hook called before any context construction.
callAppInit	Enable initialization hook called before context construction of each task.
callAppBark	Activates the watchdog hook called when the watchdog barks.

API inclusions
includeTaskYield	Manual context switch
includeTaskDelayFromNow	Delay your task for the given number of ticks, starting from now.
includeTaskDelayFromWake	Delay your task, starting at the last wake time.
includeGenSuspend	Suspend a task, but do not invoke a context switch.
includeTaskSuspendMe	Suspend this task and invoke a context switch.
includeGenResume	Resume the given task from suspension.
includeTaskSleep	Put this task to sleep and invoke a context switch.
includeTaskSleepAll	Put all tasks to sleep.
includeGenSetPriority	Set a new priority for the given task.
includeGenGetPriority	Return the current priority of a given task.
includeGenGetTickCount	Get the tick counter.
includeGenAddtoTickCount	Add the given number of ticks to the tick counter.
includeGenGetLastWakeTime	Return the time the task was last woken.
includeTaskFeedWatchdog	Feed the watchdog in order to prevent barking.
includeTaskKillWatchdog	Switch off the watchdog facility for this task.
includeGenGetTaskname	Get the address from a task name
includeTaskKillTask	Stop (in error mode) one particular task.
includeGenReboot	Reboot the system
includeTaskRestart	Restart a task
includeGenLogTask	Binary one liners about every task
includeGenLogOs	Binary one liner about the os
includeGenTrace	Send a byte or marker trough the trace.
includeGenPipeInt16	Auxiliary function to push a Tint16 on a pipe
includeGenPassFlashString	Auxiliary function to push a string on a pipe
includeTaskWaitForEvents	Lock this task until the required event is fired.
includeIsrFireEvent	Fire an event from the isr.
includeGenFireEvent	Fire an event from any location.
includeGenFireEventSet	Release all tasks waiting on events.
includeGenCountEventBlocks	Count number of blocks on a particular combination of events.
includeTaskWaitForTasks	Lock this task until other tasks pass on the same slot.
includeGenWaitRelease	Release all wait locks on this slot.
includeTaskMutex	Try to obtain or release a mutex on the given slot.
includeTaskQueu	Try to obtain or release a lock on a queu for n bytes.
includeGenQueuWrite	Write a byte on the queu.
includeGenQueuRead	Read a byte from the queu.
includeGenQueuClear	Clear the queu.
includeGenQueuPeek	Look ahead what the next byte to read would be.
includeGenQueuReadable	See how many bytes can be read from the queu.
includeGenQueuWriteable	See how many bytes can be written to the queu.
includeGenQueuFull	See if the queu is full.
includeGenQueuEmpty	See if the queu is empty.
includeTaskFileAccess	Open and close a file.
includeTaskFileFormat	Clear the whole file space (formats the FAT too).
includeTaskFileGetSize	Get the size of a file.
includeTaskFileSetSize	Set the size of a file.
includeTaskFileReadByte	Read a raw byte from a file
includeTaskFileWriteByte	Write a raw byte to a file
includeTaskFileAppendByte	Append a byte to a file
includeTaskFileReadPipe	Read bytes in a stream from a file
includeTaskFileWritePipe	Write bytes in a stream to a file
includeTaskFileReadBuffer	Read bytes from a file and put them in a buffer
includeTaskFileWriteBuffer	Write bytes from the buffer to a file
includeTaskProtectGlobalInterrupts	Enable/disable global interrupts.
includeTaskProtectSwitchTasks	Enable/disable task switching.
includeTaskProtectTickInterrupts	Enable/disable tick interrupts.
includeTaskProtectGlobalCritical	Disable/enable global interrupts, keep track of the level depth.
includeTaskProtectSwitchCritical	Disable/disable task switching, keep track of the level depth.
includeTaskProtectTickCritical	Disable/enable tick interrupts, keep track of the level depth.
includeIsrEnter	Start the isr by a context switch.
includeIsrExit	End the isr, switch to the OS.
includeIsrBegin	Start the isr, switch to the isr stack.
includeIsrEndReturn	Stop the isr, return to the place where the interrupt occurred.
includeIsrEndYield	Stop the isr, yield as quickly as possible.
includeIsrStartLoad	Start the stopwatch measuring time inside an unmanaged isr
includeIsrStopLoad	Stop the stopwatch measuring time inside an unmanaged isr
includeTaskStackCheck	Call to check how much free space is left on the task stack.
includeIsrStackCheck	Call to check how much free space is left on the isr stack.

General parametrization
CN_[xx]	Specify the names of the tasks.
TaskIncludeDefault	Specify which tasks must be included and how they are started.
TaskInclude_[taskname]	State which tasks are incorporated and how they are started.
CapabilitiesDefault	Specify the capabilities of each task.
Capabilities_[taskname]	State per task what its capabilities must be.
StackSizeDefault	Specify which stack sizes must be used for each task.
StackSize_[taskname]	Specify the stack of each task.
TimeSliceDefault	Specify which time slices must be used for each task.
TimeSlice_[taskname]	Specify how much run time each task gets per turn.
TaskName_[taskname]	Specify dynamic task names.
PriorityDefault	Specify which priority must be set when each task per default.
Priority_[taskname]	Specify the initial priority of each task.
RegisterUse_[taskname]	Specify which registers are used by each task.
RegisterUseDefault	Specify which registers are used by each task per default.
RegisterCheck_[taskname]	Specify which registers should be checked on each context switch.
RegisterCheckDefault	Specify which registers must be checked per default for each task.
InterruptStartDefault	Specify which interrupts must be activated per default.
InterruptStart_[taskname]	Specify which interrupts must be activated per task at startup.
EN_[xx]	Specify the names of the events.
FileSpaceDefault	Specify which file space must be reserved for each file per default.
FileSpace_[filename]	Specify the space (maximum size) of each file.
SN_[xx]	Specify the names of the slots.
SlotSizeDefault	Specify which slot sizes must be used for each task per default.
SlotSize_[taskname]	Specify the size of each slot stack per task.
SlotUseDefault	Specify the default use of each slot.
SlotUse_[slotname]	State how you will utilize each slot.
QueuSizeDefault	Specify the size of for each queue per default.
QueuSize_[slotname]	Specify the size of each queu.
FN_[xx]	Specify the file names.

Other configuration
StackSafety	Specify the free space required on the stack when checking.
StackSizeOS	Specify the stack of the OS.
StackSizeISR	Specify the stack of the isr.
TimeSliceIdleTime	Specify how much run time the idle time gets.
FileSpaceStandard	Specify the standard file size

Detailed descriptions

cfgSysOptimized: Switch between two sets of configuration parameters

#define cfgSysOptimized: (cfgTrue | cfgFalse)

Demo applications come in two flavors: 'optimized' and 'not optimized'. This is only about the configuration parameters, the code is identical. Since it is likely the optimization done for a particular version of the compiler and circumstances will lead to incorrect code for an other version, we distribute the examples with optimization switched off. You can simply test the optimized version for all examples by switching this to true.
However, it is better to do the optimization per application by hand (following the optimization instructions). Probably you will find slightly different values for the registers used and the stack sizes. This configuration parameter is, and should be, only used inside the config_application header code.
This option can be overridden from the command line by using defExtOptimized. If that is set to cfgTrue or cfgFalse its value overrides the value defined in your config file.

cfgSysDebug: Used to debug on the Atmel Studio

#define cfgSysDebug: (cfgTrue | cfgFalse)

There is no standard way to debug the OS. The most usable form of debugging i found is making use of a simulator. Some of the example code contains values making is more easy to debug an application by reducing wait times. The AVR simulator from Atmel is not able to simulate the timers, so a trick is used. Note the code compiled with debug == cfgTrue cannot be run on real hardware.

cfgSysInline: Force inlining of some internal methods to reduce OS stack use.

#define cfgSysInline: (cfgTrue | cfgFalse)

Some methods use quite a bit of stack, i.e. they start by saving say 8 or more registers on the context. This implies not only 8 more bytes of ram use, but also 32 extra flash bytes just to store and retrieve the registers. This must be weighted against inlining those methods. Less stack, more flash, but maybe not that much more. It really depends which resource is limited. If you set inline to true you use less OS stack (Typically noticeable when using watchdog, restart of queu functionality) but more flash. Experiment to find the optimal setting. Note that changing this to false may require the need to increase OSstack. Test!

cfgSysFramePointerCounterMeasures: To suppress the use of the frame pointer even further.

#define cfgSysFramePointerCounterMeasures: (cfgTrue | cfgFalse)

Sometimes the GCC compiler uses a frame pointer although we explicitly asked not to do so by -fomit-frame-pointer. It may be unavoidable at times, but GCC is not perfect and sometimes misses he can use a free register instead of a frame pointer. Frame pointers cost a lot of space in terms of flash and ram. For small functions, the avr architecture should normally not need one. If it does so, you can activate the counter measures for the OS. This boils down to binding variables to registers. It is not always successful, for the compiler might ignore such requests.

cfgSysReduceProEpilogue: Manage the code inside the pro- and epiloge.

#define cfgSysReduceProEpilogue: (cfgNaked | cfgBikini | cfgComplete)

A lot of functions do not need to save any registers at entrance since they do not return but enter the OS system internal handling. That would be a waste of code. To make all these functions naked, you can the parameter cfgSysReduceProEpilogue to cfgNaked. This works wonderful as long as no frame pointers are used. Normally they are not needed, the functions are small and do not contain a lot of variables, there should be plenty of registers free on the avr. (Of course you compile with -fomit-frame-pointer)
However, GCC does sometimes still use a frame pointer, see the discussion on the cfgSysFramePointerCounterMeasures parameter. In that case you should not use naked functions, since naked functions do not contain frame pointer setup code. In that case you have two options if cfgSysFramePointerCounterMeasures do not eliminate the frame pointers. Set cfgSysReduceProEpilogue to cfgBikini or set it to cfgComplete. The latter is always save, but may increase your code dramatically for full pro- and epiloge code is used on all functions.
Since gcc 4.3.2 cfgBikini maps onto dressing of the methods with OS_task, which makes sure methods essentially naked, but still define a frame pointer when needed. If you have a fully patched kernel, which recognizes the attribute OS_task, you may safely put cfgBikini here.

cfgSysRegisterCheckByte: Specify the byte with which the registers are initially filled.

#define cfgSysRegisterCheckByte: (0x00 .. 0xFF)

If you make cfgCheckTaskStack == cfgTrue the registers are filled with the value giving at cfgSysRegisterCheckByte. Each time a context switch occurs, registers said not to be used in the RegisterUse by that task are compared with the byte. In theory it is possible that a register was used, but filled with the byte you selected. To be absolutely sure, run your code several times with different values of the cfgSysRegisterCheckByte.
     If you use tracing, it may be handy to use for this value 0xA5. This value is not defined for regular trace notifications. Thus if it appears in your tracing non the less, you know that a so called non used register leaked trough to the first parameter register, probably you missed some registers needed to be saved.
     If you want to measure which registers are used, (opposite to analyzing the assembly) you can set this value to the same value as the stack is initialized with (defStackInitByte, usually 0). Now, registers which are context saved but not used cannot be separated from the non-saved registers, so they do not appear it the watermark measurement (activate it). So it gives an indication which registers could be removed from context saving.
     This method has two drawbacks. (1) Still there may be registers which are changed, but do not have to be saved, since they are only saved in tick interrupt protected code. (2) Some registers may actually be in use, but contain zero for a longer period of time. This is can only be detected by changing defStackInitByte to some other value, but at the risk of contaminating r1.

cfgSysStackGrowthUp: Specify the direction the stack grows.

#define cfgSysStackGrowthUp: (cfgTrue | cfgFalse)

Depending on the hardware the stack may run upwards (for example AVR or ARM) or downwards. During the development of Femto OS i did not have hardware with the stack running upwards, so the setting cfgSysStackGrowthUp == cfgTrue does not work properly at this moment.

cfgSysZeroPageStack: Reduce the stack pointer when all stacks fit on page zero

#define cfgSysZeroPageStack: (cfgTrue | cfgFalse)

For very small devices the high byte stack pointer may not be needed. This is comparable to the option -tinystack. However, is not limited to the RAM being limited to 255 bytes. If all stacks present (that is OS stack, ISR stack and all task stacks) fit on the first page of the RAM (note that I/O is located at that place as well) AND the compiler is able to organize the stacks directly after the I/O space, the high byte stack pointer is safely ignored. Even if the actual ram is much larger. Now, the preprocessor can sort out all off the conditions above, with one exception, that is making sure the stacks are located directly after I/O. However, you can be sure the latter is the case if the data section is empty and if shared.o is linked first. Check the file main.map to be certain. In that case you may set cfgSysZeroPageStack to cfgTrue. Note: eclipse with generated makefiles will not put shared.o first, so do not set cfgSysZeroPageStack to true in that case. Instead use the external switch to control the setting of this option: -DdefExtZeroPageStack=cfgTrue To be on the save side: set this option to cfgFalse.

cfgSysClearUnusedR1: Makes sure r1 is always cleared after a context switch.

#define cfgSysClearUnusedR1: (cfgTrue | cfgFalse)

Gcc assumes r1 is cleared on AVR architecture at all times. It would be pretty wasteful to store 0 on the context however. Worse, we must not only store r1, but r0, r2 and r3 also. That means four bytes of ram wasted just to store 0. Thus, you may set this to cfgTrue, and the restore context makes sure r1 is cleared at the beginning, if you did not store it. If you do store it, it is not cleaned. This is because there may be instructions (like the multiply on the avr) which actually force you (the compiler) to make use of it.
The initial value of r1 equals zero, (because of defStackInitByte) and that should stay that way provided it is not changed by hand. On the other hand, if you use assembler, you may not want this at all. In general it is save to set this to cfgTrue, even if you store r1 on the context, it costs some extra bytes though. It is not save to leave it to cfgFalse when you do not store the registers r0-r3, in any of your tasks, since gcc still assumes r1 to be zero. This may lead to very funny results and bugs which are very hard to track down.

cfgSysSqueezeState: Squeeze all info needed by Femto OS in the Status Register.

#define cfgSysSqueezeState: (cfgTrue | cfgFalse)

Femto OS uses a trick that saves two bytes of stack space at a context switch. The price to be paid is that it must disable the global interrupts before the portSaveContext() is called. That information can be stored in an auxiliary register (the save way) or on the status register itself. An equivalent situation arises with the internal protection of methods from interrupts.
     Most devices have an general purpose register in the I/O region that can be used for this purpose. We only need one bit, the other bits are used as event flags. However, if such an register is not available the T and H flags (of the status register) are used to keep this information. This should be save. The T flag (transfer bit) is only used in special cases by gcc, and i verified that they do not collide with the way Femto OS uses the T bit. Upon context switch the T bit is conserved.
     Likewise, the H bit (half carry flag) may be destroyed on a context switch. As far as i know the backend of gcc does not procedure code that depends explicitly on the H flag. Also using the latter approach the code tends to be a little shorter, but it depends on which methods are used.
     To be absolutely save, or if you write assembler depending on the H flag, do not choose cfgTrue for this option.

cfgSysClockDivider: Specify the divider on the clock frequency used in the device.

#define cfgSysSqueezeState: (cfgTrue | cfgFalse)

The base frequency (devClockFrequency) is the frequency that is set by the crystal, the pll and other permanent settings such as fuses. That frequency cannot be changed by software so it is defined in the portfile xxx.asm in the devices directory. Some devices have the possibility to reduce the hardware clock by prescaling to a lower value, which is then used to drive the chip. That prescaling can be defined here.
Note that you cannot just change the value to your liking. The port file must support it, and it is likely it only supports a few predefined fixed values, such as 1,2,4,8,16,32,64,128,256 for the ATtiny861. See the port files for the allowed values. If there is no prescaler available (ATmega16) set this value to one.

cfgSysSubTicksPerFullTick: Subdivider for the tickcounter

#define cfgSysSubTicksPerFullTick: (1 .. 256)

The value of the subtick counter at which the tick counter is increased by one. We assume the tick counter is generated in the port by a hardware counter passing a certain value, thereby generating an interrupt. This hardware counter produces the subticks, and the number of Subticks per full tick must be given here. You give the value taking into account a couple of conditions.
First, make sure the value of cfgSysSubTicksPerFullTick give rise to the tick time of the desired length. This, by itself cannot be given as a parameter directly. Second, make sure that the hardware counter is able to count on some more before overflowing, depending on the variation you need for the time slices, so you don not want to make it to high. Third, the accuracy of the delay timers also depend on this number, this you don't want to make it to low either.
Rule of the thumb, make it 1/8 of the maximum of your hardware counter. (Thus, 8 bit counters take 32 and for 16 bit counters take 8192.) Then you can have tasks running approximately 7 ticks without being interrupted, and you have timer resolution of approx 3%. Never make it smaller as 8 in absolute sense.

cfgSysSubTickDivider: Setting of the hardware prescaler of the tick counter.

#define cfgSysSubTickDivider: (1,8,32,64,128,256,1024)

The divisor of the system clock to the subtick counter. This is highly system dependent, but for most architectures the timer clocks are derived form the system clock by some prescaler. You must choose a value here in such a way that the subtick counter gets 'the right speed'. This is your formula:
defTickFrequency = devClockFrequency / (cfgSysClockDivider * cfgSysSubTickDivider * cfgSysSubTicksPerFullTick)
Note that you cannot just change the value to your liking. The port file must support it, and it is likely it only supports a few predefined fixed values, such as 1,8,32,64,128,256,1024. See the port files for the allowed values.

cfgSysGCCstartup: Switch to replace the startup code produced by gcc

#define cfgSysGCCstartup: (cfgOverride | cfgReplace | cfgKeep)

Gcc produces startup code far from optimal for our (and most other) situation:

the stack is set, since we don't need it, it is a waste: 8 bytes down the drain
main is called rather than jumped to, a waste since returning makes no sense: 2 ram bytes gone
empty .data section is copied: 22 bytes gone
at least three unneeded jumps: 6 bytes
an interrupt vector table you might not need, 26 bytes

You can define your own startup code and activate it here. The little price you pay is that, at startup, all ram must be cleared, since we don't know exactly which part was used. (information only available at compile time). This is done with the option cfgOverride. You can also completely define your startup files, inclusive your own interrupt vector table. In that case specify cfgReplace. If you want gcc to decide everything set it to cfgKeep.
     It may not be possible to set this to cfgReplace for certain combination of other configuration settings. This will lead to a clear error.
     IMPORTANT: if you set this to cfgReplace add the option -nostartfiles to the linker. If you set it to cgfKeep or cfgOverride, DO NOT FORGET to remove that option, otherwise the code cannot be executed. This option can be overridden from the command line by using defExtGCCstartup. If that is set to cfgKeep, cfgOverride or cfgReplace its value overrides the value defined in your config file.
     Note: the functionality of this option maybe compiler version dependent. Since it is of use only for the smallest devices, i suggest you refrain from using this for devices above 16KB flash.
     Note: In the current implementation no provision has been made to copy data sections, i.e. if you have predefined data it is not copied from flash to ram unless you alter the implementation in the at***.asm files or use cfgKeep. Imo you should never need anything in the data section, but that is a matter of taste i suppose.

cfgSysFsStorageSpace: Specify the total size of the storage in bytes

#define cfgSysFsStorageSpace: (0 .. SIZE_OF_EEPROM)

The total amount of bytes used for the file system should be given here. Usually the file system is defined in onboard EEPROM, and you can use all of it. However, you can also decide to reserve half of it for other purposes for example. Per default the file system starts off at address 0x000.

cfgIntGlobalOnly: To indicate that timer interrupts may be treated as global.

#define cfgIntGlobalOnly: (cfgTrue | cfgFalse)

Normally blocking for timer interrupts and global interrupts are separate worlds. Most methods of the OS are blocked for timer interrupts but not for global interrupts (except when needed). If you however do not have any other interrupts present, you may decide not to make this distinction. All OS timer interrupt protection code is now replaced by global protection code. It can shorten the code, but, if you use interrupts for other purposes, it can make you application less responsive, since all functions now generally block all interrupts.

cfgIntUserDefined: To indicate you use interrupts of your own, possibly with an isr.

#define cfgIntUserDefined: (cfgTrue | cfgFalse)

If you make use of interrupt really executing some code (not counting timer interrupts or watchdog interrupts and so) set this to cfgTrue. It makes the use of the isrXXXX methods possible and makes sure the StackISR is included in the code if needed.

cfgIntSwitchUsesOSstack: Set this to let the isr run in OS space.

#define cfgIntSwitchUsesOSstack: (cfgTrue | cfgFalse)

There are two kinds of interrupt handling. One were the interrupt directly forces a context switch and one where the interrupt method itself is responsible for the saving of the registers used. For the former method, you may decide whether you want to make use of the OS stack or the ISR stack. If you use only context switching interrupts, you do not need a ISR stack at all, simple make use of the OS stack and set the parameter to cfgTrue. If you set it to false, the isr makes use of its own ISR stack, of which the size must me defined below. A separate ISR stack is required when the OS is interruptible. ISR's that start with isrBegin() always require an ISR Stack, independent of the setting of cfgIntSwitchUsesOSstack.

cfgIntOsProtected: Set this to protect the Femto OS from being interrupted.

#define cfgIntOsProtected: (cfgTrue | cfgFalse)

If your interrupts use ANY of the genXXXX functions, set this to cfgTrue. The internals of the OS and genXXXX functions are now protected. If your interrupts do not use such functions this may (but must not) be set to cfgFalse. Interrupts are now possible on any moment (except during context switch, since we may not have a valid stack there), so that its code is more responsive. You may use your own communication with the tasks (a shared boolean for instance)

cfgIntTickTrack: Activate to be able to block tick interrupts during part of a task.

#define cfgIntTickTrack: (cfgTrue | cfgFalse)

If you need protection from context switching during part of your task, you need to activate this option. Then you can switch off tick interrupts and still task switch to an other task manually. Activating this however blocks the use of other interrupts which start or end with a context switch since that would be a back door, possibly leading to the destruction of registers. Defining tasks as cooperative is also achieved by this activating option, and, for those tasks that are cooperative, set the start interrupts to cfgTickClear.
Note that it does not make sense to activate tick tracking when cfgIntGlobalOnly is cfgTrue. This is because all tick enabling / disabling has been mapped to enable / disable of the global interrupt, and the tick interrupt remains unaltered.

cfgCheckReset: Give a signal through the error port that the system has reset.

#define cfgCheckReset: (cfgTrue | cfgFalse)

If you activate this option Femto OS will call portShowReset at every reset. Normally this happens only when you, yes, reset the system or reboot it. However, if your code gets lost somewhere often this results in a system reset. It is very neat when you can spot this.

cfgCheckTrace: Activate tracing, most OS activities are reported.

#define cfgCheckTrace: (cfgTrue | cfgFalse)

With this option it is possible to trace what is happening in your system Most actions and api function calls will generate a trace event. Setting this to true may seriously slow down the system, depending on the trace handler implementation. Every task switch, api function call, error etc is reported.

cfgCheckWatermarks: Keep watermarks of the stack and register use.

#define cfgCheckWatermarks: (cfgTrue | cfgFalse)

Activate this to see which registers are used and what the highest use of the stack of all tasks may be. These are estimates, measured at certain moments. There is no way to be absolutely sure about the real heights of the stack or real register usage. Note that if you activate cfgCheckRegisters also, only those registers are collected in the watermark that are checked at, since otherwise this could lead to spurious errors. If cfgCheckRegisters is de-activated the use of all registers is monitored. Furthermore, activating cfgCheckWatermarks alone never leads to an error report, even if the stack overflows or unsaved registers are used. You must activate these options separately.

cfgCheckOsStack: Check if the OS stack keeps within the given limits.

#define cfgCheckOsStack: (cfgTrue | cfgFalse)

Set to cfgTrue to let the OS check its own use of the stack. The free space of the OS stack is measured in the deepest calls of the OS. The StackSafety parameter is NOT taken into account. The use of the OS stack is highly dependent of the capabilities and on the setting of of the cfgCheckTaskStack parameter, but not so much on the used methods of the system.
Therefore, it is best to first test with cfgCheckOsStack and cfgCheckTaskStack set to cfgTrue. Then, first switch of cfgCheckTaskStack and reduce the StackOS as much as possible. If the system runs error free, you may switch off cfgCheckOsStack too. Since the call to the method checking the OS is two bytes by itself, sometimes the OS Stack can be reduced two bytes more, but this is risky. Please note that running without errors and/or cfgCheckOsStack with set to cfgTrue is no absolute guaranty the stack will not overflow.

cfgCheckTaskStack: Check if each task stack keeps with the given limits.

#define cfgCheckTaskStack: (cfgTrue | cfgFalse)

This is your life saver. It checks unauthorized use of the stack on every context switch. Usually it reports an error and shuts the task down before the stack overflows. It requires quite some extra code and OS stack space though. This should not be a problem. When all the testing is done you can switch the option to cfgFalse and be reasonable certain, that no further stack overflow occurs.
If you have really deep functions where a context switch cannot occur use the option includeTaskStackCheck and implement its function. With this you can check how much space is really left.

cfgCheckIsrStack: Check if the isr stack keeps with the given limits.

#define cfgCheckIsrStack: (cfgTrue | cfgFalse)

In an isr no context switching occurs, so the only way to check this stack is the option includeIsrStackCheck. Switch this option on if you want to use the checking.

cfgCheckRegisters: Check if use is made of registers not saved on the context.

#define cfgCheckRegisters: (cfgTrue | cfgFalse)

This is a life saver too. It checks unauthorized use of registers on every context switch. It reports an error and shuts the task down before the task is restarted with erroneous registers. Checking on the registers is a little to strict, since registers only used with interrupt protected area's need not to be saved on the context. However, the system cannot make that distinction, so it reports on the save side. If you know exactly what you are doing, you may reduce the number of registers after you have switched off this option. The use of the Tbit is also checked with this option.

cfgCheckTiming: Check if the tick is long enough to let OS and tasks do their jobs.

#define cfgCheckTiming: (cfgTrue | cfgFalse)

Activate this option to check the issues having to do with timing. For example, check if there is enough time left for the tasks to run, or if the delays are calculated in an orderly manner.

cfgCheckQueuFilling: Check if the queu's are not overrun or underrun.

#define cfgCheckQueuFilling: (cfgTrue | cfgFalse)

Queus may be written to, even if there are full. This is important, since inside an isr you cannot block and wait until the queu is read. The same applies for reading, this may be done on an empty queu. However, you can not expect sensible results when doing so, the only guarantee you have is that the system does not deadlock.
Thus, it would be nice if you can see if such a situation occurs. By setting the option to cfgTrue, overrun and underrun of the queus become an error, but only when called from a task. When called from inside an isr environment, superfluous bytes are still silently ignored and zero bytes are provided when the the queus is empty. This is because we do not know how to act after an error in that case.

cfgCheckMethodUse: Checks if you make proper use of the API.

#define cfgCheckMethodUse: (cfgTrue | cfgFalse)

There are several rules about how to use the API of the Femto OS. It is your responsibility to honor them. For example, Slot 0 may not be used, priorities may not exceed 7 etc. The OS does not protect you from misuse, since in embedded systems there is usually no one who can click on the OK button when an error is reported. But during development you can check most of the rules on use by switching on this option.

cfgCheckApplication: Activate checking of the user quality assurance.

#define cfgCheckApplication: (cfgTrue | cfgFalse)

Use this switch for you own application, to switch on some leds or other means of quality assurance. This option is not used in Femto OS. It is reserved for user application purposes.

cfgCheckAlwaysFatal: Decide if all reported errors should be treated as fatal.

#define cfgCheckAlwaysFatal: (cfgTrue | cfgFalse)

Some error the system can report are fatal by nature, Femto OS cannot recover from them. Some errors however are no so severe, and the OS can, for example, simply terminate the offending task, and try to continue business as usual. Setting this option to cfgTrue makes the system treat all errors as fatal. In the early stage of development this is advised since otherwise you may miss an error.
Make sure you have enough OS stack if you set this option to false, since error handle may require a lot of stack on top of the regular stack handling. Os stack checking is not performed inside the error handling.

cfgUseEquidistantTicks: Make sure every tick takes an equal amount of time.

#define cfgUseEquidistantTicks: (cfgTrue | cfgFalse)

The femto OS uses a feature called Honest Time Slicing. This means that every task gets the full time slice when it starts. This is useful when you have several tasks running indefinitely, just to make sure they all get a fair part of the time.
There are reasons however to use the standard tick interrupt system, where all tick interrupts come a fixed times. If all you tasks are blocking, for example, or if you need to derive from that time base. In the latter case set this option to cfgTrue, it saves some code too.
Further, Honest Time Slicing introduces some extra rounding errors in the timing model which makes the tick counter less accurate as a system clock as the oscillator crystal would be. If you set this option to cfgTrue however, the tick counter is firmly coupled to the system clock, so that, if you want to use the tick counter as a time source, you only need to calibrate the system clock, i.e. the crystal. Some hardware may be driven by very accurate crystals, and then, with this option set to cfgTrue, you can make an accurate clock.

cfgUseDelay: If you need delays or timeouts in your code, activate this.

#define cfgUseDelay: (cfgTrue | cfgFalse)

If you want to delay some tasks, activate this option. In the system this enables keeping track of task waiting for some time and than being rescheduled. If you make use of timeouts on synchronization primitives, you must also enable this option.
Also, if you want to make use of cfgUseCorrectWakeupTimes you must enable it, since it makes use of delayed tasks. If you just use Femto OS as a simple scheduler without delays, you can set this to false. That saves some code and two bytes of ram per task.

cfgUseSynchronization: Activate if you make use of the synchronization primitives.

#define cfgUseSynchronization: (cfgSyncNon | cfgSyncSingleSlot | cfgSyncSingleBlock | cfgSyncDoubleBlock)

Specify here how you want the synchronization to be used. All synchronization Information is kept in a slotstack, one for each task. The size of that stack can be defined further below. The way this is stack is 'formatted', is chosen here. The more complex the formatting, the more possibilities and the more code generated by the preprocessor. You can choose from cfgSyncSingleSlot, cfgSyncSingleBlock, cfgSyncDoubleBlock and cfgSyncNon.
If you do not want to make any use of synchronization set this to cfgSyncNon. Please note that, although no code is included to handle slots, the slot stacks may still claim ram. Set them explicitly to zero if you do not need them. If you choose for cfgSyncSingleSlot, one slot may be occupied per task at every moment and no nesting is allowed. This takes one byte for every task using slots. It makes no sense to define the SlotSizes larger than one (and it is forbidden, to make sure we can optimize the code).
If you choose for cfgSyncSingleBlock, every task may hold one blocking slot at a time, and may use the rest of the bytes in the slot stack for other free locks or nesting. Every byte can hold two slots (one per nibble). If you choose for cfgSyncDoubleBlock, every task may hold two blocking slots, on which it blocks simultaneously. The other bytes in the slot stack are used for free locks.

cfgUseNestedCriticals: If you need to nest critical blocks, activate this.

#define cfgUseNestedCriticals: (cfgTrue | cfgFalse)

Critical sections can be made by disabling/enabling interrupts over the region you want to protect. However, this approach cannot be nested, since, when the deepest level is left, interrupts are enabled again. This nesting may occur over function calls and is therefore hard to monitor.
If you only have one level, there is no need for nesting, but otherwise, you have the option to switch cfgUseNestedCriticals to cfgTrue. Now the system keeps track of the nesting for you. The maximum number of levels depend on the use of the types of interrupts you need to protect. If is is one kind (e.g. either Global or Tick interrupts) you have 16 levels, if you use both, you have 4 levels per interrupt, which may be mixed.
If you switch this option to cfgFalse, all enter/exit critical calls are mapped to standard disable/enable calls by the preprocessor. Note, the nesting of mutexes/queu's is handled in a separate option. And second, note that, the OS itself does nest the switching of interrupts, but does not make use of this system, so in fact all levels are available for own use.

cfgUsePriorityLifting: If you need to make use of priority inheritance, activate this.

#define cfgUsePriorityLifting: (cfgTrue | cfgFalse)

A high priority task may block on a low priority task. If that low priority task never gets any processing time because, for example, there is a non blocking task at medium priority, the high priority task hangs too. In that case you may switch on cfgUsePriorityLifting. Blocking tasks sharing the same synchronization lock are lifted to the priority of that of the task with the highest priority. This, however is temporary. As soon as the lock is released, the priorities are restored to there initial value. Beware, the are not restored to there last value, but to the value it started with at the beginning, i.e. the priority of Priority_XXXX.

cfgUseTaskWatchdog: Activate this to protect a task against infinite loops and waits.

#define cfgUseTaskWatchdog: (cfgTrue | cfgFalse)

You can protect your tasks with a watchdog. If you set this option to cfgTrue, all tasks which contain a bark() method are called when the watchdog expires, if you activated the callAppBark. Shortly before the task is reinitialized (stack/variables cleaned) and afterwards restarted (loop called). Only the priority of the task is retained, the rest of the status info is renewed.
The init code of the task, if present, is not called. Redo any work in the bark section, or call init from bark. The watchdog must be activated per task separately, since it is likely you only want to protect only some tasks, bus drivers for example. After a restart the watchdog is deactivated, as it always is when a task starts. Please note that only (!) running tasks are watched. A blocking, delayed of sleeping task can never be barked at. Thus if two tasks are waiting on each other in a block, these tasks may still deadlock.

cfgUseCorrectWakeupTimes: Activate to keep track of the last task activation times.

#define cfgUseCorrectWakeupTimes: (cfgTrue | cfgFalse)

Setting this to cfgTrue makes sure that for every take the last wakeup time is recorded correctly. It is recorded correctly always when only delays are used to block a task. However, if tasks are also woke from suspension or sleep, or are deblocked by releasing semafores, these times are not automatically correct. You may need correct times when you use includeTaskDelayFromWake for example. If you activate this option correct wake uptime are kept internally. cfgUseDelay must be activated, for this option to make sense.

cfgUseTimeout: Activate to enable timeout on all synchronizing methods.

#define cfgUseTimeout: (cfgTrue | cfgFalse)

Blocking calls on synchronizing methods may be given a timeout parameter. For this to be effective though, i.e. in order to make sure the code is present for releasing the task on a timeout, this option must be set to cfgTrue. Otherwise the timeout parameter is ignored, and the call or returns with the lock obtained or never returns. The return value itself is undefined, and may even be false, in that case. Activating this implies activation of cfgUseDelay (if cfgUseSynchronization is not equal to cfgSyncNon), even if cfgUseDelay is set to false, internally, but you must still activate cfgUseDelay if you want to make explicit use of delays.
TODO: Change the name in cfgUseTimeout

cfgUseTasknames: Activate to reserve room in flash for dynamic task names.

#define cfgUseTasknames: (cfgTrue | cfgFalse)

All tasks have compile time (literal) tasks names. This makes handling more easy. Usually the presence of dynamic task names is a waste of space, since nobody is watching the embedded system. Besides, tasks cannot be dynamically loaded or unloaded, so it is know on any time which tasks are running ;-) However there may be reasons where dynamic task names may be handy, and this is the option you need to set to cfgTrue in order to make use of them. If it is set to cfgFalse, the names are not compiled in, regardless if they are specified below.

cfgUseLowPowerSleep: Make the Femto OS aware of low power sleep modes.

#define cfgUseLowPowerSleep: (cfgTrue | cfgFalse)

As soon as all tasks are put to sleep or have stopped for an other reason (stopped due to an fatal error, suspended or locked by a semaphore) and thus the only tasks left is the idle task, the system can go to a low power mode instead of the idle task, if this option is set to cfgTrue. Timer interrupts are stopped. Note that, if only this option is set to cfgTrue, the system will not go to sleep if there are still delayed tasks left.)
One further point of attention is that interrupts are used to wake up the device from low power sleep. This may be the (internal) watchdog but could as well be some other interrupt you are currently using. Since the Femto OS is in OS mode while sleeping, it is not possible to use the switching interrupts isrEnter() and isrExit(). Interrupt routines have to start with isrBegin() and have to end with isrEndReturn(), and must have their own ISR stack. As an alternative, you can make use of the event system which does not even require isrBegin()/isrEnd(). No stack and registers are used in this case.
For the avr, code in the port.c file makes sure the system wakes up again, and correct the tick counter is restored. Please note that passed tick hooks are not catched up, except the appTick16(). Upon wake all sleeping tasks are woken per default. For indefinite sleeps the tick counter cannot be restored.

cfgUseLowPowerOnDelay: Let the OS sleep as soon as all tasks are sufficiently delayed.

#define cfgUseLowPowerOnDelay: (cfgTrue | cfgFalse)

If the tasks that are not put to sleep are delayed long enough, it may be sensible to put the system in low power too. The minimal delay time for this to happen is set in the parameter cfgNumSleepThreshold. Thus if the system enters idle with all tasks either stopped for any reason or delayed long enough the system will to to sleep if this option is set. Requires the activation of cfgUseDelay.
     This option may not be activated on devices that do not have a watchdog interrupt. For example the ATmega16 can only reset on watchdog, so the watchdog, used internally to limit the sleeptime cannot be used. Unfortunately there is no other mechanism which can take over this role.
     The use of the watchdog as time source has one other consequence. The watchdog has its own clock, which is set in milliseconds. So you can set cfgNumSleepPeriod to any value you like, only these device predefined values will be used. The tick clock must be corrected using this values, making it dependent on the real clock frequency. You will obtain shortest code and most accurate results when the real time spend for 256 ticks is a divisor of the used predefined value of the watchdog timer.
     Last thing you must know that it is your responsibility to correct the tick counter when cfgUseLowPowerOnDelay is activated, otherwise the system wakes up, but the clock is like unaltered, and the delayed task stayed delayed. This could be intentional, but not likely. So better activate includeGenAddtoTickCount. The OS then takes care of adjusting the tick counter.

cfgUseLowPowerDelayRelease: Activate to correct delay times, if the device over slept.

#define cfgUseLowPowerDelayRelease: (cfgTrue | cfgFalse)

The function call for LowPowerSleep contains a parameter which indicates the maximal sleep time. If the low power sleep takes no longer as this parameter indicates, it is guaranteed that no timer delay tasks have been expired during the sleep so no waking up is necessary. If it is however not certain that the sleep time was equal or shorter as the max sleep time, it may be needed to wake up some delayed tasks (standard sleeping tasks are woken anyhow). Then set this option to cfgTrue. Note, that it is still your responsibility to adjust the tick counter. If you forget, it will be to the system as if no time has passed at all. Requires the activation of cfgUseDelay.

cfgUseLoadMonitor: To keep track of the time spend in all tasks, os and isr.

#define cfgUseLoadMonitor: (cfgTrue | cfgFalse)

With this option it is possible to monitor how much time is spend in each of the tasks. Compare it to the traditional task manager. You must read the accumulated values at hand. The values are measured in subticks. Activating this option increases the ram use a lot. The OS has to keep track of the Time spend in the OS itself (4 bytes) and the idle time (4 bytes) and possible the ISR (5 bytes) and per task spend time must be collected and stored (4 bytes per task). So if you have four tasks or so with an interrupt this facility costs 29 bytes of ram extra!

cfgUseFileSystem: Activate the Femto File System on EEPROM

#define cfgUseFileSystem: (cfgTrue | cfgFalse)

With this option you can indicate that you want to make use of the Femto File System that is defined as FS on the EEPROM. Synchronized access (single write, multiple read) to the EEPROM is organized by the FFS and there is no need to use slots. Also, the system blocks the writing task until the burnlock on the eeprom has been released.

cfgUseFileSystemConcurrentRead: Separate read/write regions from read only regions.

#define cfgUseFileSystemConcurrentRead: (cfgTrue | cfgFalse)

This option enables you to choose to open a file in read/write mode or in read mode only. The advantage of the latter is that more tasks can simultaneously read from the file system. If an other task wants to write, no new reader tasks are allowed any more until all readers are finished. Then (one) writing task is allowed. This is also known are a singlewritermultiplereader synchronizer. But even if you have one task active at most on the file system it can be handy, since tasks that are only reading on the file system may be put to sleep, whereas writing tasks are never.

cfgUseFileSystemEconomyMode: Option to save erase/write cycles on the file system / eeprom

#define cfgUseFileSystemEconomyMode: (cfgTrue | cfgFalse)

Normally writing a bytes triggers an erase before the write. However, depending on the content of the byte written, this may not be necessary. If you activate the economy mode, every byte is read prior to being written and on the basis of the content it is decided if an erase, a write or both are needed. Of course, this increases the code somewhat and introduces some more overhead. On the other side, you the eeprom will last longer (less erases) and the writing time will be shorter on average. This option is only available on devices that support split byte programming, and should be set to cfgFalse in such a feature is not present.

cfgUseFileSystemMaintainFAT: Keep a table with the use of all files

#define cfgUseFileSystemMaintainFAT: (cfgTrue | cfgFalse)

If you activate this option, Femto OS will maintain a 'FAT' table at the start of the file space. Every entry of the table contains the length of corresponding files. After a file system format these are all zero. Since files are on fixed locations and their maximum length cannot change, there is no need to keep more information. If you want to append bytes to a file, or want to set the size explicitly, for example, you need this feature.

cfgUseEvents: Lightweight messaging system between tasks and/or isr.

#define cfgUseEvents: (cfgTrue | cfgFalse)

There are eight events which can be given a name. A task may send and event or may block waiting on one or more events to take place. An event may be fired from an isr, even if the OS is made interruptible. The event itself is not stored. As it takes place, all tasks blocking on that particular event are released. If a task blocks after an event has taken place, it has to wait for a new event. Tasks that block on more than one event are released when all events have taken place at least once.

cfgUseEventsOnVariables: Activate if you need to use genFireEvent on variables.

#define cfgUseEventsOnVariables: (cfgTrue | cfgFalse)

In normal circumstances it is most efficient to call genFireEvent on a compile time constant only. Depending on the location of the event register (and other configuration parameters) this may compile to a single (atomic) instruction. The isrFireEvent() method may only be called upon compile time constants! Sometimes however is may be needed to have some variable (e.g. a counter) which determines which event to fire. In that case you need to activate the parameter cfgUseEventsOnVariables. This makes sure the method genFireEvent() is used instead of its macro. It generates a lot of code however. Setting this parameter makes only sense in combination with cfgUseEvents set to cfgTrue.

cfgNumWatchdogDiv: Determines the frequency of watchdog checkups.

#define cfgNumWatchdogDiv: (0 .. 7)

This is the divisor of the watchdog down counter. In other words, the watchdog counter, which starts at (an internal value of) 3 is decremented by one every (2^n) * 256 ticks. The (2^n)*256 tick boundary is used to determine that moment. Depending on when the watchdog is started, the first decrement may directly be after the first reset of the watchdog, or a full period of (2^n) * 256 - 1 ticks later. If the watchdog counter itself reaches 1 it starts barking. Thus, this mechanism only guarantees a minimum sleep time of the watchdog, namely (2^n)*256 ticks. n is in the interval : 0<=n<=8. Thus, for a given n the minimum watchdog time equals (2^n)*256 ticks, the maximum watchdog time 2*(2^n)*256 -1.

cfgNumMonitorDiv: Determines the copy frequency of the load monitor.

#define cfgNumMonitorDiv: (0 .. 7)

Specify the divisor if the load entry timer. The mechanism is the same as for the watchdog down counter. Since the load logging is a periodic activity it is not really important when the log event occurs. It can thus occur every 256, 512, 1204 etc ticks. Please note that, if you choose your value to high some load counters may overflow. The maximum number of ticks that can be monitored is 65536 / cfgSysSubTicksPerFullTick. For cfgSysSubTicksPerFullTick = 32, this is 2048, leading to a divisor of 3.

cfgNumSleepPeriod: Number of milliseconds the device may continuously sleep

#define cfgNumSleepPeriod: (250 .. 8000)

When the device is sleeping (and there is a watchdog present in the device) it wakes up at fixed intervals to see it the total sleeping period is already over. If not, a new period of sleep starts. Of course, this repeated wakening only takes place when there is some delay timer which may expire. So both cfgUseLowPowerSleep and cfgUseLowPowerOnDelay must be set to cfgTrue.
With this parameter you can set the sleep period in milliseconds. Every wakening costs energy so you don't want to set it to low. However, if you set it to large, the period may exceed the remaining sleep time to quickly, and if that happens, the device stays awake without a real need. The minimum time is 250ms, the maximum time is device dependent, 2 or 8 seconds. In any case, the value you give will be rounded and maximized, so it makes no sense to specify it up to the millisecond.
Furthermore, depending on the tick time different values of the cfgNumSleepPeriod imply different calculation methods, which, in turn may have a dramatic impact on the code size. So, experiment with different values.

cfgNumSleepThreshold: Minimum number of milliseconds the delay must be for sleeping.

#define cfgNumSleepThreshold: (250 .. ~4000)

Set the minimum number of milliseconds the shortest delay must have in order to go to low power sleep. the minimum is about 250 ms, Note that the option cfgUseLowPowerSleep and cfgUseLowPowerOnDelay must be set to cfgTrue. It makes no sense to set it to a lower as the value of cfgNumSleepPeriod although it does not harm either. Set it high enough to make sleep worthwhile but not to high since otherwise sleep will never occur.

cfgNumGlobWidth: Number of bits for counting the depth of global critical nesting.

#define cfgNumGlobWidth: (0 .. 8)

Specify how many bits must be reserver to keep track of the depth of critical nesting. For example, if you specify 3 bits, 8 levels can be used. The number of bits of cfgNumGlobWidth, cfgNumSwitchWidth and cfgNumTickWidth may not exceed 8 bits, for they are stored in one byte. Specify 0 if you do not use this type of critical nesting.

cfgNumSwitchWidth: Number of bits for counting the depth of switch critical nesting.

#define cfgNumSwitchWidth: (0 .. 8)

cfgNumTickWidth: Number of bits for counting the depth of tick critical nesting.

#define cfgNumTickWidth: (0 .. 8)

callAppTick00: Activates the tick hook that fires every tick.

#define callAppTick00: (cfgTrue | cfgFalse)

If there is some work that must be done every tick define your own tick00() method and set this option to cfgTrue. Now is is called every tick. Needles to say you must keep the work short. The code runs in OS stack space, and the system cannot check if the OS stack overflows inside your code, so be careful, and check you assembler how much stack is used in the code. Although called every tick, the calls may not be equidistant in time. This heavily depends on the way you set up the time slice parameters.
If use is made of cfgUseEquidistantTicks == cfgTrue the calls should be fairly constant over time (aside from interrupts), and if you use variable time slicing, it may get silent for longer timers, up to several times the tick time, and than these are caught up afterwards. Note that you can be sure that on every call the tick counter itself only is incremented by one since the last call. (Not that you can do much with the tick counter, you cannot get it's value form inside the tick hook) The only exception being when the system is in low power sleep. The missed calls due to a low power sleep are not caught up.

callAppTick08: Activates the tick hook that fires every 256 ticks

#define callAppTick08: (cfgTrue | cfgFalse)

This method is called every 256 ticks, and always after the tick00 has been called. Further the same conditions apply.

callAppTick16: Activates the tick hook that fires every 65536 ticks

#define callAppTick16: (cfgTrue | cfgFalse)

This method is called every 65536 ticks, so when the tick counter overflows. It may be used to extend the tick counter to 32 bits, if needed. Note that, due to the rounding errors in the timer model, it is not particularly well suited to make an accurate clock, only perhaps when cfgUseEquidistantTicks is set to cfgTrue. You still have the drift of the driving crystal though.
When in low power sleep, this call is of course skipped. If however, you manually correct the tick counter after sleep, and the sleep time was less than one full round (<65536 ticks) than the appTick16() call is made anyway so that for instance, your 32 tick counter remains accurate.

callAppEnterIdle: Activates the idle hook that fires just before going idle.

#define callAppEnterIdle: (cfgTrue | cfgFalse)

Just before the system goes idle you can perform some tasks when installing the hook appEnterIdle(). If you do so, activate it here by setting this option to cfgTrue. You code is run with tick interrupts disabled, so be very brief. Depending on the setting of the interrupt options other interrupts may occur. Of course the call runs in OS space.

callAppEnterSleep: Enable sleep hook that fires just before going to low power sleep.

#define callAppEnterSleep: (cfgTrue | cfgFalse)

Just before the system goes to sleep appEnterSleep() is called. You can perform last tasks before the low power mode is activated. The time spend in your routine is not counted for, so be very brief. The call runs in OS space, and global interrupts are disabled. If you arrive here, you can be certain the device will not be interrupted before it goes to sleep. The sleep itself however may be short or even absent (if you chose the cfgNumSleepThreshold lower as cfgNumSleepPeriod).

callAppTickSleep: Enable sleep hook that fires at in-between wakeups.

#define callAppTickSleep: (cfgTrue | cfgFalse)

When cfgUseLowPowerOnDelay is activated the device wakes up periodically (with intervals set by cfgNumSleepPeriod) to see if the sleep time is over. You can define a hook on these wake ups to do some bookkeeping. This call takes place in OS space, and the device may go to sleep again afterwards, if the sleeping time was not over yet. Use this for example to keep an external clock in sync, or to flash a heart beat led.

callAppExitSleep: Enable sleep hook that fires just after going to low power sleep.

#define callAppExitSleep: (cfgTrue | cfgFalse)

Just after the sleep period is over appExitSleep() is called. You can perform some tasks before the system is restarted. Time spend in your routine is not counted for, so be very brief. The call runs in OS space, and global interrupts are disabled again, and you can be sure that if you arrive here, no other tasks where started since the wake up. Other interrupts may have occurred and run however.

callAppBoot: Enable initialization hook called before any context construction.

#define callAppBoot: (cfgTrue | cfgFalse)

There may be some initialization code that is shared for all tasks. This can be put inside the the function appBoot(). This is called inside OS space, and none of the tasks are already set up at that moment. It is usually a lot more effective to collect the initialization code of the tasks that to give all tasks its own initialization code. Only put code here that only needs to be done at the very start. It is not called again if a particular task is restarted after a watchdog bark for instance.

callAppInit: Enable initialization hook called before context construction of each task.

#define callAppInit: (cfgTrue | cfgFalse)

It may be necessary however to individually give every task its own startup code. If so, set this parameter to cfgTrue. Note that this implies that every task must have an init method, although it may be empty. Note that it is possible to set both callMainInit and callAppInit to cfgTrue. The appBoot() is called first, followed by init methods of the tasks. In appInit code is placed that must be called before the task may start. If a task is restarted manually this is re-executed.

callAppBark: Activates the watchdog hook called when the watchdog barks.

#define callAppBark: (cfgTrue | cfgFalse)

When using the watchdog facility a task that gets stuck is reset. Usually there is some cleaning up to do before the loop is called again. (The init of the task is not called again!) This is done inside appBark(). The task is first re-intialized (cleanup stack and variables) and afterwards restarted (call loop). The bark section is optional however. Decide here if you want such a section. Activate cfgUseTaskWatchdog to make use of the watchdog facility.

includeTaskYield: Manual context switch

#define includeTaskYield: (cfgTrue | cfgFalse)

includes: void taskYield(void)

includeTaskDelayFromNow: Delay your task for the given number of ticks, starting from now.

#define includeTaskDelayFromNow: (cfgTrue | cfgFalse)

includes: void taskDelayFromNow(void)

Activate cfgUseDelay to make use of the this facility

includeTaskDelayFromWake: Delay your task, starting at the last wake time.

#define includeTaskDelayFromWake: (cfgTrue | cfgFalse)

includes: void taskDelayFromWake(Tuint16 uiTicksToWait)

Activate cfgUseDelay to make use of the this facility

includeGenSuspend: Suspend a task, but do not invoke a context switch.

#define includeGenSuspend: (cfgTrue | cfgFalse)

includes: void genSuspend(Tuint08 uiTaskNumber)

includes: void genSuspendOnName(Tlit TaskName)

includeTaskSuspendMe: Suspend this task and invoke a context switch.

#define includeTaskSuspendMe: (cfgTrue | cfgFalse)

includes: void taskSuspendMe(void)

includeGenResume: Resume the given task from suspension.

#define includeGenResume: (cfgTrue | cfgFalse)

includes: void genResume(Tuint08 uiTaskNumber)

includes: void genResumeOnName(Tlit TaskName)

includeTaskSleep: Put this task to sleep and invoke a context switch.

#define includeTaskSleep: (cfgTrue | cfgFalse)

includes: void taskSleep(void)

Activate cfgUseLowPowerSleep to make use of the this facility

includeTaskSleepAll: Put all tasks to sleep.

#define includeTaskSleepAll: (cfgTrue | cfgFalse)

includes: void taskSleepAll(void)

Activate cfgUseLowPowerSleep to make use of the this facility

includeGenSetPriority: Set a new priority for the given task.

#define includeGenSetPriority: (cfgTrue | cfgFalse)

includes: void genSetPriority(Tuint08 uiTaskNumber, Tuint08 uiNewPriority)

includes: void genSetPriorityOnName(Tlit TaskName,Tuint08 NewPriority)

includeGenGetPriority: Return the current priority of a given task.

#define includeGenGetPriority: (cfgTrue | cfgFalse)

includes: Tuint08 genGetPriority(Tuint08 uiTaskNumber)

includes: Tuint08 genGetPriorityOnName(Tlit TaskName)

includeGenGetTickCount: Get the tick counter.

#define includeGenGetTickCount: (cfgTrue | cfgFalse)

includes: Tuint16 genGetTickCount(void)

includeGenAddtoTickCount: Add the given number of ticks to the tick counter.

#define includeGenAddtoTickCount: (cfgTrue | cfgFalse)

includes: void genAddtoTickCount(Tuint16 uiSleepTime)

includeGenGetLastWakeTime: Return the time the task was last woken.

#define includeGenGetLastWakeTime: (cfgTrue | cfgFalse)

includes: Tuint16 genGetLastWakeTime(Tuint08 uiTaskNumber)

includes: Tuint16 genGetLastWakeTimeOnName(Tlit TaskName))

Activate cfgUseDelay to make use of the this facility

includeTaskFeedWatchdog: Feed the watchdog in order to prevent barking.

#define includeTaskFeedWatchdog: (cfgTrue | cfgFalse)

includes: void taskFeedWatchdog(void)

Activate cfgUseTaskWatchdog to make use of the this facility

includeTaskKillWatchdog: Switch off the watchdog facility for this task.

#define includeTaskKillWatchdog: (cfgTrue | cfgFalse)

includes: void taskKillWatchdog(void)

Activate cfgUseTaskWatchdog to make use of the this facility

includeGenGetTaskname: Get the address from a task name

#define includeGenGetTaskname: (cfgTrue | cfgFalse)

includes: Taddress genGetTaskname(Tuint08 uiTaskNumber)

includes: Taddress genGetTasknameOnName(Tlit TaskName)

Activate cfgUseTasknames to make use of the this facility

includeTaskKillTask: Stop (in error mode) one particular task.

#define includeGenKill: (cfgTrue | cfgFalse)

includes: void taskKillTask(Tuint08 uiTaskNumber)

includes: void taskKillTaskOnName(Tlit TaskName)

includeGenReboot: Reboot the system

#define includeGenReboot: (cfgTrue | cfgFalse)

includes: void genReboot(void)

includeTaskRestart: Restart a task

#define includeTaskRestart: (cfgTrue | cfgFalse)

includes: void taskRestart(Tuint08 uiTaskNumber)

includes: void taskRestartOnName(Tlit TaskName)

includeGenLogTask: Binary one liners about every task

#define includeGenLogTask: (cfgTrue | cfgFalse)

includes: void genLogTask(Tuint08 uiTaskNumber, void (*pipe)(Tchar))

includeGenLogOs: Binary one liner about the os

#define includeGenLogOs: (cfgTrue | cfgFalse)

includes: void genLogOs(void (*pipe)(Tchar))

includeGenTrace: Send a byte or marker trough the trace.

#define includeGenTrace: (cfgTrue | cfgFalse)

includes: void genTrace(Tbyte bUser)

Activate cfgCheckTarce to make use of the this facility. includes genTraceInfo() and genTraceMarker().

includeGenPipeInt16: Auxiliary function to push a Tint16 on a pipe

#define includeGenPipeInt16: (cfgTrue | cfgFalse)

includes: void genPipeInt16(Tuint16 uiValue, void (*pipe)(Tchar))

includeGenPassFlashString: Auxiliary function to push a string on a pipe

#define includeGenPassFlashString: (cfgTrue | cfgFalse)

includes: void genPassFlashString(Taddress pString, Tuint08 uiLength, Tchar cFilling, void (*pipe)(Tchar))

includeTaskWaitForTasks: Lock this task until other tasks pass on the same slot.

#define includeTaskWaitForTasks: (cfgTrue | cfgFalse)

includes: Tbool taskWaitForTasks(Tuint08 uiSlot, Tuint08 uiNumberOfTasks, Tuint16 uiTicksToWait)

includes: Tbool taskWaitForTasks(Tuint08 uiSlot, Tuint08 uiNumberOfTasks)

includes: Tbool taskWaitForTasksOnName(Tlit SlotName, Tuint08 uiNumberOfTasks, Tuint16 uiTicksToWait)

includes: Tbool taskWaitForTasksOnName(Tlit SlotName, Tuint08 uiNumberOfTasks)

includes: Tbool taskWaitForOtherTask(Tuint08 uiSlot, Tuint16 uiTicksToWait)

includes: Tbool taskWaitForOtherTask(Tuint08 uiSlot)

includes: Tbool taskWaitForOtherTaskOnName(Tlit SlotName, Tuint16 uiTicksToWait)

includes: Tbool taskWaitForOtherTasknName(Tlit SlotName)

Activate cfgUseSynchronization to make use of the this facility

includeGenWaitRelease: Release all wait locks on this slot.

#define includeGenWaitRelease: (cfgTrue | cfgFalse)

includes: void genWaitRelease(Tuint08 uiSlot)

includes: void genWaitReleaseOnName(Tlit SlotName)

Activate cfgUseSynchronization to make use of the this facility

includeTaskMutex: Try to obtain or release a mutex on the given slot.

#define includeTaskMutex: (cfgTrue | cfgFalse)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeRightFilling)

includes: void taskSyncRelease(Tuint08 uiSlotSlot)

includes:

Tbool taskSyncWriteWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncWriteWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncWriteReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncWriteReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncReadWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncReadWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncReadReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncReadReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes: Tbool taskMutexRequestOnName(Tlit SlotName, Tuint16 uiTicksToWait)

includes: Tbool taskMutexRequestOnName(Tlit SlotName)

includes: void taskSyncReleaseOnName(Tlit SlotLeftName, Tlit SlotRightName)

includes: void taskMutexReleaseOnName(Tlit SlotName)

Call taskMutexRequest() and taskMutexRelease() Activate cfgUseSynchronization to make use of the this facility

includeTaskQueu: Try to obtain or release a lock on a queu for n bytes.

#define includeTaskQueu: (cfgTrue | cfgFalse)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes: Tbool taskSyncRequest(Tuint08 uiSlotSlot, Tsint08 siFreeRightFilling)

includes: void taskSyncRelease(Tuint08 uiSlotSlot)

includes:

Tbool taskSyncWriteWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncWriteWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncWriteReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncWriteReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncReadWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncReadWriteRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes:

Tbool taskSyncReadReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling, Tuint16 uiTicksToWait)

includes:

Tbool taskSyncReadReadRequestOnName(Tlit SlotLeftName, Tlit SlotRightName, Tsint08 siFreeLeftFilling, Tsint08 siFreeRightFilling)

includes: Tbool taskQueuWriteRequestOnName(Tlit SlotName, Tsint08 siFreeFilling, Tuint16 uiTicksToWait)

includes: Tbool taskQueuWriteRequestOnName(Tlit SlotName, Tsint08 siFreeFilling)

includes: Tbool taskQueuReadRequestOnName(Tlit SlotName, Tsint08 siFreeFilling, Tuint16 uiTicksToWait)

includes: Tbool taskQueuReadRequestOnName(Tlit SlotName, Tsint08 siFreeFilling)

includes: void taskSyncReleaseOnName(Tlit SlotLeftName, Tlit SlotRightName)

includes: void taskQueuReleaseOnName(Tlit SlotName)

Call taskQueuRequest() and taskQueuRelease() Activate cfgUseSynchronization to make use of the this facility

includeGenQueuWrite: Write a byte on the queu.

#define includeGenQueuWrite: (cfgTrue | cfgFalse)

includes: void genQueuWrite(Tuint08 uiSlot, Tbyte bItem)

includes: void genQueuWriteOnName(Tlit SlotName, Tbyte bItem)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuRead: Read a byte from the queu.

#define includeGenQueuRead: (cfgTrue | cfgFalse)

includes: Tbyte genQueuRead(Tuint08 uiSlot)

includes: Tbyte genQueuReadOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuClear: Clear the queu.

#define includeGenQueuClear: (cfgTrue | cfgFalse)

includes: void genQueuClear(Tuint08 uiSlot)

includes: void genQueuClearOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuPeek: Look ahead what the next byte to read would be.

#define includeGenQueuPeek: (cfgTrue | cfgFalse)

includes: Tbyte genQueuPeek(Tuint08 uiSlot)

includes: Tbyte genQueuPeekOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuReadable: See how many bytes can be read from the queu.

#define includeGenQueuReadable: (cfgTrue | cfgFalse)

includes: Tuint08 genQueuReadable(Tuint08 uiSlot)

includes: Tuint08 genQueuReadableOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuWriteable: See how many bytes can be written to the queu.

#define includeGenQueuWriteable: (cfgTrue | cfgFalse)

includes: Tuint08 genQueuWriteable(Tuint08 uiSlot)

includes: Tuint08 genQueuWriteableOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuFull: See if the queu is full.

#define includeGenQueuFull: (cfgTrue | cfgFalse)

includes: Tbool genQueuFull(Tuint08 uiSlot)

includes: Tbool genQueuFullOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeGenQueuEmpty: See if the queu is empty.

#define includeGenQueuEmpty: (cfgTrue | cfgFalse)

includes: Tbool genQueuEmpty(Tuint08 uiSlot)

includes: Tbool genQueuEmptyOnName(Tlit SlotName)

Activate cfgUseSynchronization, and have cfgUseAsQueu defined on at least one task to make use of the this facility.

includeTaskProtectGlobalInterrupts: Enable/disable global interrupts.

#define includeTaskProtectGlobalInterrupts: (cfgTrue | cfgFalse)

includes: taskEnableGlobalInterrupts()

includes: taskDisableGlobalInterrupts()

Enable (with taskEnableGlobalInterrupts()) or disable (with taskDisableGlobalInterrupts()) global interrupts, and keep track of the interrupt state over a context switch.

includeTaskProtectSwitchTasks: Enable/disable task switching.

#define includeTaskProtectSwitchTasks: (cfgTrue | cfgFalse)

includes: taskEnableSwitchTask()

includes: taskDisableSwitchTask()

Enable (with taskEnableSwitchTask()) or disable (with taskDisableSwitchTask()) switching of tasks, and keep track of the interrupt state over a context switch.

includeTaskProtectTickInterrupts: Enable/disable tick interrupts.

#define includeTaskProtectTickInterrupts: (cfgTrue | cfgFalse)

includes: taskEnableTickInterrupts()

includes: taskDisableTickInterrupts()

Enable (with taskEnableTickInterrupts()) or disable (with taskDisableTickInterrupts()) tick interrupts, and keep track of the interrupt state over a context switch.

includeTaskProtectGlobalCritical: Disable/enable global interrupts, keep track of the level depth.

#define includeTaskProtectGlobalCritical: (cfgTrue | cfgFalse)

includes: void taskEnterGlobalCritical(void)

includes: void taskExitGlobalCritical(void)

Call taskEnterGlobalCritical() and taskExitGlobalCritical() Activate cfgUseNestedCriticals to make use of the this facility.

includeTaskProtectSwitchCritical: Disable/disable task switching, keep track of the level depth.

#define includeTaskProtectSwitchCritical: (cfgTrue | cfgFalse)

includes: void taskEnterSwitchCritical(void)

includes: void taskExitSwitchCritical(void)

Call taskEnterTickCritical() and taskExitTickCritical() Activate cfgUseNestedCriticals to make use of the this facility.

includeTaskProtectTickCritical: Disable/enable tick interrupts, keep track of the level depth.

#define includeTaskProtectTickCritical: (cfgTrue | cfgFalse)

includes: void taskEnterTickCritical(void)

includes: void taskExitTickCritical(void)

Call taskEnterTickCritical() and taskExitTickCritical() Activate cfgUseNestedCriticals to make use of the this facility.

includeIsrEnter: Start the isr by a context switch.

#define includeIsrEnter: (cfgTrue | cfgFalse)

includes: isrEnter()

includes: INCLUDES

Activate cfgIntUserDefined to make use of the this facility.

includeIsrExit: End the isr, switch to the OS.

#define includeIsrExit: (cfgTrue | cfgFalse)

includes: isrExit()

Activate cfgIntUserDefined to make use of the this facility.

includeIsrBegin: Start the isr, switch to the isr stack.

#define includeIsrBegin: (cfgTrue | cfgFalse)

includes: isrBegin()

Activate cfgIntUserDefined to make use of the this facility.

includeIsrEndReturn: Stop the isr, return to the place where the interrupt occurred.

#define includeIsrEndReturn: (cfgTrue | cfgFalse)

includes: isrEndReturn()

Activate cfgIntUserDefined to make use of the this facility.

includeIsrEndYield: Stop the isr, yield as quickly as possible.

#define includeIsrEndYield: (cfgTrue | cfgFalse)

includes: isrEndYield()

Activate cfgIntUserDefined to make use of the this facility.

includeIsrStartLoad: Start the stopwatch measuring time inside an unmanaged isr

#define includeIsrStartLoad: (cfgTrue | cfgFalse)

includes: void isrStartLoad(void)

Activate cfgIntUserDefined, cfgIntOsProtected and includeTaskYield to make use of the this facility. If you do not activate cfgUseLoadMonitor the method is replaced by an empty call.

includeIsrStopLoad: Stop the stopwatch measuring time inside an unmanaged isr

#define includeIsrStopLoad: (cfgTrue | cfgFalse)

includes: void isrStopLoad(void)

Activate cfgIntUserDefined to make use of the this facility. If you do not activate cfgUseLoadMonitor the method is replaced by an empty call.

includeTaskStackCheck: Call to check how much free space is left on the task stack.

#define includeTaskStackCheck: (cfgTrue | cfgFalse)

includes: Tuint08 isrStackCheck(Tuint08 uiExtraStackSafety)

includeIsrStackCheck: Call to check how much free space is left on the isr stack.

#define includeIsrStackCheck: (cfgTrue | cfgFalse)

includes: Tuint08 taskStackCheck(Tuint08 uiExtraStackSafety)

Depending on the settings of cfgCheckIsrStack, cfgCheckWatermarks and cfgIntSwitchUsesOSstack the call be be replaced by an empty call.

includeTaskWaitForEvents: Lock this task until the required event is fired.

#define includeTaskWaitForEvents: (cfgTrue | cfgFalse)

includes: Tbool taskWaitForEvent(Tuint08 uiEvent, Tuint16 uiTicksToWait)

includes: Tbool taskWaitForEvent(Tuint08 uiEvent)

includes: Tbool taskWaitForEventOnName(Tlit EventName,TicksToWait)

includes: Tbool taskWaitForEventOnName(Tlit EventName)

Activate cfgUseEvents to make use of the this facility

includeIsrFireEvent: Fire an event from the isr.

#define includeIsrFireEvent: (cfgTrue | cfgFalse)

includes: void isrFireEvent(Tuint08 uiEvent)

Activate cfgUseEvents to make use of the this facility.

includeGenFireEvent: Fire an event from any location.

#define includeGenFireEvent: (cfgTrue | cfgFalse)

includes: void genFireEvent(Tuint08 uiEvent)

Activate cfgUseEvents to make use of the this facility.

includeGenFireEventSet: Release all tasks waiting on events.

#define includeGenFireEventSet: (cfgTrue | cfgFalse)

includes: void genFireEventSet(Tuint08 uiEventSet)

Activate cfgUseEvents to make use of the this facility

includeGenCountEventBlocks: Count number of blocks on a particular combination of events.

#define includeGenCountEventBlocks: (cfgTrue | cfgFalse)

includes: Tuint08 genEventCountBlocks(Tuint08 uiEventSet)

Activate cfgUseEvents to make use of the this facility

includeTaskFileAccess: Open and close a file.

#define includeTaskFileAccess: (cfgTrue | cfgFalse)

includes: Tbool taskFileOpen(Tbool bReadOnly, Tuint16 uiTicksToWait)

includes: Tbool taskFileOpen(Tuint16 uiTicksToWait)

includes: Tbool taskFileOpen(Tbool bReadOnly)

includes: Tbool taskFileOpen(void)

includes: void taskFileClose(void)

includes: Tbyte taskFileDirectRead(Taddress pAddress)

includes: void taskFileDirectWrite(Taddress pAddress, Tbyte bValue)

Call taskFileOpen() and taskFileClsoe(), and taskFileDirectRead() and taskFileDirectWrite() for unmanaged raw access to the file system. Activate cfgUseFileSystem to make use of the this facility

includeTaskFileFormat: Clear the whole file space (formats the FAT too).

#define includeTaskFileFormat: (cfgTrue | cfgFalse)

includes: void taskFileFormat(void)

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileGetSize: Get the size of a file.

#define includeTaskFileGetSize: (cfgTrue | cfgFalse)

includes: Tuint08 taskFileGetSize(Tuint08 uiFileNumber)

includes: Tuint08 taskFileGetSizeOnName(Tlit FileName)

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileSetSize: Set the size of a file.

#define includeTaskFileSetSize: (cfgTrue | cfgFalse)

includes: void taskFileSetSize(Tuint08 uiFileNumber, Tuint08 uiSize)

includes: void taskFileSetSizeOnName(Tlit FileName, Tuint08 uiSize)

includes: void taskFileClear(Tuint08 uiFileNumber)

includes: void taskFileClearOnName(Tlit FileName)

Activate cfgUseFileSystem to make use of the this facility Activate cfgUseFileSystemMaintainFAT to make use of the this facility

includeTaskFileReadByte: Read a raw byte from a file

#define includeTaskFileReadByte: (cfgTrue | cfgFalse)

includes: Tbyte taskFileReadByte(Tuint08 uiFileNumber, Tuint08 uiOffset)

includes: Tbyte taskFileReadByteOnName(Tlit FileName, Tuint08 uiOffset)

Activate cfgUseFileSystem to make use of the this facility Activate cfgUseFileSystemMaintainFAT to make use of the this facility

includeTaskFileWriteByte: Write a raw byte to a file

#define includeTaskFileWriteByte: (cfgTrue | cfgFalse)

includes: void taskFileWriteByte(Tuint08 uiFileNumber, Tuint08 uiOffset, Tbyte bItem)

includes: void taskFileWriteByteOnName(Tlit FileName, Tuint08 uiOffset, Tbyte bItem)

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileAppendByte: Append a byte to a file

#define includeTaskFileAppendByte: (cfgTrue | cfgFalse)

includes: void taskFileAppendByte(Tuint08 uiFileNumber, Tbyte bItem)

includes: void taskFileAppendByteOnName(Tlit FileName, Tbyte bItem)

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileReadPipe: Read bytes in a stream from a file

#define includeTaskFileReadPipe: (cfgTrue | cfgFalse)

includes: void taskFileReadPipe(Tuint08 uiFileNumber, Tuint08 uiOffset, Tuint08 uiSize, void (*pipe)(Tchar))

includes: void taskFileReadPipeOnName(Tlit FileName, Tuint08 uiOffset, Tuint08 uiSize, void (*pipe)(Tchar))

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileWritePipe: Write bytes in a stream to a file

#define includeTaskFileWritePipe: (cfgTrue | cfgFalse)

includes: void taskFileWritePipe(Tuint08 uiFileNumber, Tuint08 uiOffset, Tuint08 uiSize, Tchar (*pipe)(void))

includes: void taskFileWritePipeOnName(Tlit FileName, Tuint08 uiOffset, Tuint08 uiSize, Tchar (*pipe)(void))

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileReadBuffer: Read bytes from a file and put them in a buffer

#define includeTaskFileReadBuffer: (cfgTrue | cfgFalse)

includes: void taskFileReadBuffer(Tuint08 uiFileNumber, Tuint08 uiOffset, Tuint08 uiSize, Taddress pBuffer)

includes: void taskFileReadBufferOnName(Tlit FileName, Tuint08 uiOffset, Tuint08 uiSize, Taddress pBuffer)

Activate cfgUseFileSystem to make use of the this facility

includeTaskFileWriteBuffer: Write bytes from the buffer to a file

#define includeTaskFileWriteBuffer: (cfgTrue | cfgFalse)

includes: void taskFileWriteBuffer(Tuint08 uiFileNumber, Tuint08 uiOffset, Tuint08 uiSize, Taddress pBuffer)

includes: void taskFileWriteBufferOnName(Tlit FileName, Tuint08 uiOffset, Tuint08 uiSize, Taddress pBuffer)

Activate cfgUseFileSystem to make use of the this facility

CN_[xx]: Specify the names of the tasks.

#define CN_[xx]: (literal) [xx = 00 .. 15]

Internally the Femto OS work with task numbers. These run from 0 to defNumberOfTasks-1. The defNumberOfTasks parameter is defined internally, in this list you define which names you will be using. Furthermore, the task number given to a particular task is done in the order defined below, that is, starting with CN_00 CN_01 etc, if they are to be included in the system (see include tasks).
The maximum number of tasks is 16. The task names you define here are used below, all handled by the preprocessor, so theses static names do not cost any ram, and need not to be short. There is no need to remove unused parameters.

TaskIncludeDefault: Specify which tasks must be included and how they are started.

#define TaskIncludeDefault: (cfgDefaultNon | cfgExclude | cfgStartTerminated | cfgStartSleeping | cfgStartSuspended | cfgStartRunning)

You can specify one default TaskInclude value for all tasks by using TaskIncludeDefault. If you want to specify the TaskInclude setting per task, set TaskIncludeDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the TaskIncludeDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See TaskInclude_[taskname] for explanation.

TaskInclude_[taskname]: State which tasks are incorporated and how they are started.

#define TaskInclude_[taskname]: (cfgExclude | cfgStartTerminated | cfgStartSleeping | cfgStartSuspended | cfgStartRunning)

Here define which tasks will be actually compiled into your system. The task is excluded by Femto OS if you set the parameter to cfgExclude. The other possibilities are #define cfgStartTerminated, cfgStartSleeping, cfgStartSuspended and cfgStartRunning which behave as can be expected by there definition. Thus, normally you would use which implies the task is started directly at startup.
Using the function preTaskDefined([TaskName]) you can conditionally include your c code as well. If you need to specify a task number to some method don't you numbers directly, since they may differ according to changed in this list, but use the (preprocessor) function preTaskNumberOf([TaskName]) instead, so you keep all calls number independent.
Note: The preprocessor cannot check if you define includes here for tasks that have not been previously declared with a task name. Usually this is harmless, but the preTaskDefined() may produce false results in this case.

StackSizeDefault: Specify which stack sizes must be used for each task.

#define StackSizeDefault: (cfgDefaultNon | 0 .. 65535 )

You can specify one default StackSize value for all tasks by using StackSizeDefault. If you want to specify the StackSize setting per task, set StackSizeDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the StackSizeDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
This default is not used to define StackSizeISR or StackSizeOS. See StackSize_[taskname] for explanation.

StackSize_[taskname]: Specify the stack of each task.

#define StackSize_[taskname]: (0 .. 65535)

This is the most important place. Here you decide between life an death. How much stack should u give a particular task? First, make sure that, whatever you do, run protected first. Really! Now, these are point to take into consideration.

Two nested calls are necessary to reach the saveContext, thus the minimum value is 4 bytes, or whatever that takes on you architecture, even if you save nothing on the stack. Two af these bytes are removed again, the other contain the return address and are left in place.
Interrupts are disabled after the first call, so if you yield manually there is a slim (but non zero chance) the timer interrupt comes just after the call, and from that point on, 4 bytes are the minimum again, so with manual yielding, blocking delaying etc, add two bytes to your calculation. This risk is absent when the task run's 'forever', and is only switched at a timer interrupt.
You need one byte for the status register.
You need 4 bytes per group of 4 registers saved on the context
If you use any calls to the OS, they usually disable interrupts after the (nested) call. If the function takes parameters, they are usually pushed on the stack in between. Count one byte per parameter.
Count your own nested calls!
Note that the testing the Femto OS performs for you only takes account of the regular depth encountered. However, in real life eventually all instructions will be subject to an interrupt / context switch sometime. Also those you did not encountered on you lab table. Thus, the weird behavior may start weeks after you installed everything. Beware!
Have a look at the assembler code! Even if you don't really understand what is happening inside, calculating the stack depth is relatively easy. Certainly you know the depth a some locations.

There is no need to remove unused parameters, if you deactivate the task, the stack is automatically excluded.
If all StackSize values are below 256, i.e. fit in one byte, only one byte is used per task to store the stack level at context switch. Stacks may be larger as 255 bytes however. In that case two bytes are needed per task to store the information.

TimeSliceDefault: Specify which time slices must be used for each task.

#define TimeSliceDefault: (cfgDefaultNon | cfgSysSubTicksPerFullTick | defMinTimeSlice .. 0xFF - cfgSysSubTicksPerFullTick )

You can specify one default TimeSlice value for all tasks by using TimeSliceDefault. If you want to specify the TimeSlice setting per task, set TimeSliceDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the TimeSliceDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
This default is not used to define TimeSliceIdleTime. In that case the value specified here is ignored. See TimeSlice_[taskname] for explanation.

TimeSlice_[taskname]: Specify how much run time each task gets per turn.

#define TimeSlice_[taskname]: (cfgSysSubTicksPerFullTick | defMinTimeSlice .. 0xFF - cfgSysSubTicksPerFullTick)

Here you determine how many subticks every task may run before the tick interrupt comes. If you choose for cfgSysSubTicksPerFullTick, the task get one full tick at most. If you choose a higher number it may run for more that one tick. The tick counter gets back (lag) but after the task is interrupted this is corrected. Note that the minimum value is defMinTimeSlice and the maximum is approx 0xFF - cfgSysSubTicksPerFullTick since the subtick counter should not overflow, in that case a many ticks are missed. This safety margin is for interrupts and other extra's (some OS operations etc). Many timers cannot handle 0 and it makes not much sense too.
These variable time slices only work when, cfgUseEquidistantTicks == cfgFalse except for the TimeSliceIdleTime, which must be set independently. Since you can put the system in some power save mode during idle time too (make sure timer interrupts work) it may make sense to put a longer period there. This mechanism is for busses for example which require and undisturbed time to run.
In case of cfgUseEquidistantTicks == cfgTrue you need not specify anything since every tick is equal and the tick may be shared among several tasks. In that case the values specified here are ignored.

TaskName_[taskname]: Specify dynamic task names.

#define TaskName_[taskname]: (literal)

For some applications it may be handy to have task names. Femto OS does not use them internally, and of course these names consume resources. Set cfgUseTasknames == cfgTrue to include the names in flash. The names are unrelated to the static names.
There is no possibility to define a default task name.

PriorityDefault: Specify which priority must be set when each task per default.

#define PriorityDefault: (cfgDefaultNon | 0 .. 7 )

You can specify one default priority value for all tasks by using PriorityDefault. If you want to specify the priority setting per task, set PriorityDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the PriorityDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See Priority_[taskname] for further explanation.

Priority_[taskname]: Specify the initial priority of each task.

#define Priority_[taskname]: (0 .. 7)

Each task starts in a predefined priority 0..7. zero being the lowest priority. All tasks in one priority run round robin, the lowest task number runs first. If in one priority there is one (or more) non blocking task(s), this tasks starves all tasks in lower priorities. This is not a problem from the systems point of view. The idle task runs in a (virtual) priority -1 which cannot be shared with any other task. Which and how many tasks run in a priority does not influence the use of resources. Priorities can be changed at runtime.

RegisterUseDefault: Specify which registers are used by each task per default.

#define RegisterUseDefault: (cfgDefaultNon | r00r01r02r03 | r04r05r06r07 | r08r09r10r11 | r12r13r14r15 | r16r17r18r19 | r16r17r18r19 | r20r21r22r23 | r24r25r26r27 | r28r29r30r31 | r00_upto_r07 | r08_upto_r15 | r16_upto_r23 | r24_upto_r31 | r00_upto_r15 | r16_upto_r31 | registersAll)

You can specify one default RegisterUse value for all tasks by using RegisterUseDefault. If you want to specify the RegisterUse setting per task, set RegisterUseDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the RegisterUseDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See RegisterUse_[taskname] for further explanation.

RegisterUse_[taskname]: Specify which registers are used by each task.

#define RegisterUse_[taskname]: ( registersNon | r00r01r02r03 | r04r05r06r07 | r08r09r10r11 | r12r13r14r15 | r16r17r18r19 | r16r17r18r19 | r20r21r22r23 | r24r25r26r27 | r28r29r30r31 | r00_upto_r07 | r08_upto_r15 | r16_upto_r23 | r24_upto_r31 | r00_upto_r15 | r16_upto_r31 | registersAll )

The AVR is one example of hardware which contains many registers, most of which you probably don't use. So why save them on the context then? It takes a lot of ram and time too, so we save only those needed. This is called RegisterCompression and works per default.
Specify which registers are used in the tasks. These are defined in blocks of four registers. If no use of a register is made, it need not to be saved on the context. If a particular task uses no registers at all, use registersNon, is all registers are used use registersAll.
If you have the space it may be wise to develop with all registers saved. Registers only used inside critical sections (and this includes most functions of the Femto OS api) formally need not to be saved. However, this cannot be checked, thus it may be hard to determine if you save enough registers.

RegisterCheckDefault: Specify which registers must be checked per default for each task.

#define RegisterCheckDefault: (cfgDefaultNon | registersNon | r00r01r02r03 | r04r05r06r07 | r08r09r10r11 | r12r13r14r15 | r16r17r18r19 | r16r17r18r19 | r20r21r22r23 | r24r25r26r27 | r28r29r30r31 | r00_upto_r07 | r08_upto_r15 | r16_upto_r23 | r24_upto_r31 | r00_upto_r15 | r16_upto_r31 | registersAll )

You can specify one default RegisterCheck value for all tasks by using RegisterCheckDefault. If you want to specify the RegisterCheck setting per task, set RegisterCheckDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the RegisterCheckDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See RegisterCheck_[taskname] for further explanation.

RegisterCheck_[taskname]: Specify which registers should be checked on each context switch.

#define RegisterCheck_[taskname]: ( registersNon | r00r01r02r03 | r04r05r06r07 | r08r09r10r11 | r12r13r14r15 | r16r17r18r19 | r16r17r18r19 | r20r21r22r23 | r24r25r26r27 | r28r29r30r31 | r00_upto_r07 | r08_upto_r15 | r16_upto_r23 | r24_upto_r31 | r00_upto_r15 | r16_upto_r31 | registersAll )

Specify which registers you want to have checked. Registers that are defined as 'used' above are never checked, so you do not need to exclude them. Thus normally, you would set this to registersAll. However, it may be the case that you know some registers are changed in places where a tick interrupt cannot take place. Such a registers need not to be saved on the context, but may still changed, and thus trigger an error when cfgCheckRegisters is set to cgfTrue. In that case you may exclude such registers here. Even if they are changed, it will not trigger an error. Of course, at your own responsibility. If the register may turn out to be important after all, the system may crash.
These values must be provided if you use cfgCheckRegisters, per default choose for registersAll.

InterruptStartDefault: Specify wich interrupts must be activated when each task is started.

#define InterruptStartDefault: (cfgDefaultNon | ((cfgGlobClear | cfgGlobSet) & (cfgTickSet | cfgTickClear)) )

You can specify one default InterruptStart value for all tasks by using InterruptStartDefault. If you want to specify the InterruptStart setting per task, set InterruptStartDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the InterruptStartDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See InterruptStart_[taskname] for further explanation.

InterruptStart_[taskname]: Specify which interrupts must be activated per task at startup.

#define InterruptStart_[taskname]: (cfgGlobClear | cfgGlobSet) & (cfgTickSet | cfgTickClear)

Specify the interrupt startup value per task. These values are used only when InterruptStartDefault is set to cfgDefaultNon, any other value takes precedence over the definitions per task.
Defining the tick interrupts is only useful when cfgIntTickTrack is set to cfgTrue, otherwise tick interrupts are always switched on per default. If cfgIntGlobalOnly is defined to cfgTrue, it makes no sense to set cfgIntTickTrack to cfgTrue since all tick interrupt changing operation are mapped to the global interrupt. If you however still decide to do so make sure you activate tick interrupts per task, since there is no possibility to do so via the OS in a later stage any more.
If cfgIntTickTrack is cfgFalse the setting of cfgTickSet / cfgTickClear is irrelevant, since timer interrupts are always activated at the start of a task, or after a context switch. However, since these settings are also relevant to choose between cooperative and preemptive tasks, the setting if cfgTick is mapped to cfgGlob when cfgIntGlobalOnly is defined to cfgTrue, making them of importance after all.

CapabilitiesDefault: Specify the capabilities of each task.

#define CapabilitiesDefault: (cfgDefaultNon | cfgCapNon | cfgCapWatchdog | cfgCapEvent | cfgCapCritical | cfgCapSynchronization | cfgCapFileSystem | cfgCapDelay | cfgCapTimeout | cfgCapAll)

You can specify one default Capabilities value for all tasks by using CapabilitiesDefault. If you want to specify the Capabilities setting per task, set CapabilitiesDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the CapabilitiesDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See Capabilities_[taskname] for explanation.

Capabilities_[taskname]: State per task what its capabilities must be.

#define Capabilities_[taskname]: (cfgCapNon | cfgCapWatchdog | cfgCapEvent | cfgCapCritical | cfgCapSynchronization | cfgCapFileSystem | cfgCapDelay | cfgCapTimeout | cfgCapAll)

You can choose to specify per task what the capabilities should be. Some of the capabilities (which must be activated above) can be activated on a task by task basis. The preprocessor can generate more optimal code in some cases. Also, you usually use less ram that way. Also some runtime optimization takes place.
     You can choose from the following capabilities: cfgCapWatchdog, cfgCapEvent, cfgCapCritical, cfgCapSynchronization, cfgCapFileSystem, cfgCapTimeout, cfgCapDelay, cfgCapAll, cfgCapNon. (cfgCapCritical is only needed for nested critical sections)
     It is always safe (and usually more convenient while developing) to set all Capabilities to cfgCapAll. Omitting to specify a capability which is used in a particular task may result bugs that are very hard to find, since some ram locations will be used for multiple purposes in that case. Specifying values here other than cfgCapAll for all tasks is on of the last optimizations you should perform. When checkMethodUse is activated Femto OS checks if you specified the correct capabilities on every API call when applicable.
     Only firing an event from a task does not require the task to have event capabilities, but waiting for an event does.

EN_[xx]: Specify the names of the events.

#define EN_[xx]: (literal) [xx = 00 .. 15]

Femto OS has 8 events for free use, when cfgUseEvents is activated. Here they can be given (compile time) names. You would normally use events only through the genFireEventOnName() function. This is because on the avr, only the firing of single constant events generate an atomic instruction. Therefore such a call does not need to be interrupt protected.

FileSpaceDefault: Specify the space default filesize

#define FileSpaceDefault: (0 .. cfgSysFsStorageSpace)

You can specify one default FileSpace value for all tasks by using FileSpaceDefault. If you want to specify the FileSpace setting per task, set FileSpaceDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the FileSpaceDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
This default is not used to define FileSpaceStandard. See FileSpace_[filename] for explanation.

FileSpace_[filename]: Specify the space (maximum size) of each file.

#define FileSpace_[filename]: (0 .. cfgSysFsStorageSpace)

Here you can define the maximal length of each file. Files may not exceed the given length, and are protected at writing. You can skip a file by setting its space to zero. You need not use all space.
The FAT specifies for each file how much bytes are written. Note: The preprocessor cannot check if you define spaces here for files that have not been previously declared with a file name. Usually this is harmless, but the preFileDefined() may produce false results in this case.

SN_[xx]: Specify the names of the slots.

#define SN_[xx]: (literal) [xx = 01 .. 15]

Femto OS has 15 slots for free use, when cfgUseSynchronization is activated they do not use ram by themselves. The slots are numbered 1..15 internally, number 0 is reserved to indicate a particular lock is free. Below you can specify names for each slot. You need not to specify all. The function preSlotNumberOf([SlotName]) provides you with the possibility to find the number to a slot, needed in the Femto OS API.,

SlotSizeDefault: Specify which slot sizes must be used for each task per default.

#define SlotSizeDefault: (cfgDefaultNon | 0 .. 14 )

You can specify one default SlotSize value for all tasks by using SlotSizeDefault. If you want to specify the SlotSize setting per task, set SlotSizeDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the SlotSizeDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See SlotSize_[taskname] for explanation.

SlotSize_[taskname]: Specify the size of each slot stack per task.

#define SlotSize_[taskname]: (0 .. 14)

You can specify per task how many simultaneous slots you need to use. To determine how many slots you need, and how much space this will take, you must realize the following:

A slot can be locked or blocked by a task, or both. Every time a task locks a slot 4 bits are needed to store the slo tvalue. Two locks occupy one byte. Nesting of a synchronization primitive is realized by locking the same slot multiple times.
Locks are internally stored in the so called slot stack. The slot stack may contain free locks (i.e. not blocked) only or may hold blocking slots. A task can block on two slots at most, which are always stored at the bottom of the stack.
The mode in which the synchronization is placed determines how the slot stack is understood. The possible modes are: cfgSyncNon, cfgSyncSingleSlot, cfgSyncSingleBlock and cfgSyncDoubleBlock.

See also the explanation at cfgUseSynchronization.

cfgSyncNon: No slots can be used, it makes no sense to define space for them. Set all values below to 0.
cfgSyncSingleSlot: Only one slot per task is utilized. Values below can be 0 or 1. One byte is occupied for every task that makes use of a slot.
cfgSyncSingleBlock: Every task may only block on one slot, but may hold one or more non blocking slots. Specify as many slots as you need. The number of free slots the total number, or the total minus one if a block is used. The minimum number of slots in this case is 2, (requires 1 byte)
cfgSyncDoubleBlock: Every task may block on one or two slots, and may hold one or more non blocking slots. Specify as many slots as you need. The number of free slots the total number, or the total minus two if blocks are used. Since in this situation, even in case a single block is used, two slot places are reserved, no free locks are possible any more. Thus the minimum for this option is 4 slots (requiring 2 bytes)

There does not exist a memory difference between 3 and 4 slots, or 5 and 6 slots. So you made round up to the next even number (except in case of one slot) Tasks that do not need slots get a 0. Note the every nesting for the same slot counts as one, so if you use a lock and reenter it in the same task, that task needs two slots. Please note that any task that makes use of the file system need at least one. At the moment the size maximum is 14 (allowing for 14 simultaneous slots.
Important: The preprocessor can generate much shorter code when all tasks that use slots have the same size. So, besides 0 use one other size if possible. Of course, you must weight that against the use of ram.

SlotUseDefault: Specify the default use of each slot.

#define SlotUseDefault: (cfgDefaultNon | cfgUseAsNon | cfgUseAsWait | cfgUseAsMutex | cfgUseAsQueu )

You can specify one default SlotUse value for all tasks by using SlotUseDefault. If you want to specify the SlotUse setting per task, set SlotUseDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the SlotUseDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See SlotUse_[slotname] for explanation.

SlotUse_[slotname]: State how you will utilize each slot.

#define SlotUse_[slotname]: (cfgUseAsNon | cfgUseAsWait | cfgUseAsMutex | cfgUseAsQueu)

Specify how you want to utilize your slots. You can choose from cfgUseAsWait, cfgUseAsMutex, cfgUseAsQueu, cfgUseAsNon. Apart from the queus, slots do not take space by themselves, and the difference between Wait (a rendezvous) Mutex and Non is only in the way the use is checked. In your code you can test the use of a slot using the functions preWaitDefined([SlotName]), preMutexDefined([SlotName]) or preQueuDefined([SlotName]) to see if the particular slot was defined in that type.
The slots the queus take are always the ones numbered * 1 .. defNumberOfQueus (internally). This does not bother you much, but must be kept in mind is you want to address the queus numerically for a reason. Do not mix the use of slots.
Note: The preprocessor cannot check if you define uses here for slots that have not been previously declared with a slot name. Usually this is harmless, but the preQueuDefined(), preMutexDefined() and preWaitDefined() may produce false results in this case.

QueuSizeDefault: Specify the size of for each queue per default.

#define QueuSizeDefault: (cfgDefaultNon | 1 .. 127 )

You can specify one default QueuSize value for all tasks by using QueuSizeDefault. If you want to specify the QueuSize setting per task, set QueuSizeDefault to cfgDefaultNon, and define the value for each task separately. If you define each task as well as the QueuSizeDefault the latter takes precedence, so the default value overrides values specified per task (if unequal to cfgDefaultNon). Defining this value is not required.
See QueuSize_[slotname] for explanation.

QueuSize_[slotname]: Specify the size of each queu.

#define QueuSize_[slotname]: (1 .. 127)

Define the sizes of the queus you want to use. Each Queu occupies a slot. The queus of course use resources, for each queue the number of bytes you define (size) plus three extra, which hold the information about locking reading and writing pointers. The maximum size per queue is 127 bytes.

FN_[xx]: Specify the file names.

#define FN_[xx]: (literal) [xx = 00 .. 15]

Files are numbered internally, but can be given names, just like the tasks. Only the first 16 files can have such a names. The rest of the file space is divided into anonymous files of default length. Handle the files using their names in the OnName methods. If the number of a particular named file is needed use preFileNumberOf([FileName]) instead of directly specifying the number, which may be due to change.

StackSafety: Specify the free space required on the stack when checking.

#define StackSafety: (0 .. 255)

This parameter defines the 'danger zone' on the task stacks when checking. Thus, if your task should not require no more as 14 bytes, but you fear it may go as far as 18, define your task stack to be 18 bytes and set StackSafety to 4, it will report an error as soon as it detects values are pushed onto the stack beyond 14 bytes. The task will then be stopped. However, if the surplus stayed with the 18 byte limit, other tasks are not effected. StackSafety may be set to zero, but if you set it to some (small) positive value, this increases the chance the check method catches an error before some the buggy behavior.
When your code is finished, and runs bug free for some time, then set StackSafety to zero and reduce all task sizes by the same amount. If then still no errors are reported, you may switch of the cfgCheckTaskStack and start working on the size of the OS stack.
This value is not added when checking the OS or ISR stack. Please note that the StackSafety parameter only has effect on the checking itself, it does not create any extra stack or use any ram. The value is limited to the value that, increased with the highest stack size, does not exceed the 255 or 65535 limit (one or two byte arithmetic). This limit is determined by the largest stack used.

StackSizeOS: Specify the stack of the OS.

#define StackSizeOS: (0 .. 255)

The Femto OS is not really stack hungry and the stack is also used to hold a number of background variables when the tasks are running. The code for these background variables never uses more than 8 bytes with all protection switched off, and 16 bytes with protection switched on. However, please experiment with the different values and have cfgCheckOsStack == cfgTrue while testing. This is because the stack itself may need to be larger. The StackSizeOS may not be larger then 255.

StackSizeISR: Specify the stack of the isr.

#define StackSizeISR: (0 .. 65535)

Specify the stack size of the interrupt service routine. Such a stack is not always needed, even when using interrupts. Basically you only need it if you want to allow interrupts while in OS space. If you don't, thus have cfgIntOsProtected == cfgTrue, and use isrBegin - isrEnd constructions you also need a separate stack. If you only use isrEnter - isrExit constructions, i.e. entering the isr with context switching, you have the choice, see the option cfgIntSwitchUsesOSstack.
Check your stack manually with includeIsrStackCheck. Note that the non-switching isr's can be quite stack hungry, since it must push all registers is uses, plus some more. Value must be between 0 and 65536 and is in fact limited by the amount or ram the device has.

TimeSliceIdleTime: Specify how much run time the idle time gets.

#define TimeSliceIdleTime: (cfgSysSubTicksPerFullTick | defMinTimeSlice .. 0xFF - cfgSysSubTicksPerFullTick )

The TimeSliceIdleTime must be specified and and may differ from the time other tasks get. For a detailed explanation how this works see TimeSlice_[taskname].
In case of cfgUseEquidistantTicks == cfgTrue you need not specify anything since every tick is equal and the tick may be shared among several tasks. In that case the value specified here is ignored.

FileSpaceStandard: Specify the standard file size

#define FileSpaceStandard: (0 .. cfgSysFsStorageSpace)

Space not used for regular predefined files is filled up with files of standard size. These files cannot be reached with a compile time name, only under file number.
The FAT specifies for each file how much bytes are written.

Contact: info@femtoos.org