femtoos_headers/femtoos_globals.h

Go to the documentation of this file.

/*
 * Femto OS v 0.91 - Copyright (C) 2008-2009 Ruud Vlaming
 *
 * This file is part of the Femto OS distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Please note that, due to the GPLv3 license, for application of this
 * work and/or combined work in embedded systems special obligations apply.
 * If these are not to you liking, please know the Femto OS is dual
 * licensed. A commercial license and support are available.
 * See http://www.femtoos.org/ for details.
 */

#ifndef FEMTOOS_GLOBALS_H
#define FEMTOOS_GLOBALS_H

/* DISCUSSION
 * Unfortunately we must include here some hardware dependent files. avr/io.h could
 * probably be moved to port.h, but this does not hold true for the avr/pgmspace.h.
 * Therefore we kept them together. The point is, storage in flash is not so hardware
 * independent as it may seem. Thus, if you want to port this OS, this is one point
 * to look at.
 */

#include  <avr/io.h>

/* These includes are not compatible with assembler language. But since we need the
 * globals in the startup code, we must explicitly exclude them here.
 */
#ifndef __ASSEMBLER__
  #include  <avr/pgmspace.h>
  #include  <string.h>
#endif

#define SystemID   "FemtoOS 0.91"

#define true       1
#define false      0


/* DISCUSSION
 * We don't use primitive data types in the code anywhere. All types are related
 * to the types below. We compile with the option -mint8, otherwise gcc promotes
 * a lot of 8 bit operations to 16 bit. Although this is standard behavior, and
 * can be suppressed with the right casts, to my opinion this has been the wrong
 * choice. C is a machine language and should respect the true lengths of the
 * defined variables. Note that it seems that GCC does not honor the bit lengths
 * defined; so why are the present anyway? With -mint8 int32_t becomes a 16 bit
 * integer. Why? This is totally confusing.
 */
#define Tchar      unsigned char
#define Tbool      Tuint08
#define Taddress   Tchar *
#define Tbyte      uint8_t
#define Tword      uint16_t
#define Tsint08    int8_t
#define Tuint08    uint8_t
#define Tsint16    int16_t
#define Tuint16    uint16_t
#define Tdouble    double
#define Tenum      uint8_t


#define defDelayTimeMax        0xFEFF

#define defDelayTimeZero       0x0000

#define defLockBlockInfinite   0x0000

#define defLockDoNotBlock      0x0001

#define defStackInitByte       0x00

#define defCurrentTaskNumber   0x80

#define defCurrentTaskName     defCurrentTaskName

#define defFromFileStart        0x00

#define defFromFileEnd          0xFF

#define defUntilFileEnd         0xFF

#define defReadOnly             0x01

#define defReadWrite            0x00

#define defAllEvents            0xFF

#define    defRestartSuspended  0x00

#define    defRestartSleeping   0x40

#define    defRestartDefault    0x80


#define    defRestartShared     0x80

#define    defRestartRunning    0xC0


#define    defSuspendNow        0x01

#define    defSuspendCheck      0x02

#define    defSuspendClear      0x04


#define  errUnused_0x00                   0x00

#define  errInsufficientCapabilities      0x01

#define  errUnused_0x02                   0x02

#define  errTaskStackWillOverflow         0x03

#define  errTaskIllegalRegisterUse        0x04

#define  errTaskTakesTooLong              0x05

#define  errTaskNestingOverflowed         0x06

#define  errTaskNestingUnderflowed        0x07

#define  errTaskNestingPresent            0x08

#define errUnused_0x09                    0x09

#define  errTaskHoldsNoSlots              0x0A

#define  errSlotDoubleUsed                0x0B

#define  errQueuOverrun                   0x0C

#define  errQueuUnderrun                  0x0D

#define  errTaskPriorityTooHigh            0x0E

#define  errTaskDelayTooLong              0x0F

#define  errTaskDelayTooShort             0x10

#define  errSlotZeroUsed                  0x11

#define  errSlotTypeMismatch              0x12

#define  errSlotTwins                     0x13

#define  errIllegalDominantState          0x14

#define  errQueuWriteLimit                0x15

#define  errQueuReadLimit                 0x16

#define  errSlotDecreaseFail              0x17

#define  errSlotIncreaseFail              0x18

#define  errFileOpenMode                  0x19

#define  errFileInvalidFileNumber         0x1A

#define  errFileOutOfRange                0x1B

#define  errFileClosedMode                0x1C

#define  errFileWrongMode                 0x1D

#define  errInvalidRestartMode            0x1E

#define  errInvalidSuspendMode            0x1F


#define  fatInternalError                 0x20

#define  fatOsStackUnderMinimum           0x21

#define  fatOsStackOverflowed             0x22

#define  fatIllegalEvent                  0x23

#define  fatTaskStackOverflowed           0x24

#define  fatIsrStackOverflowed            0x25

#define  fatOsTickRateTooHigh             0x26

#define  fatTaskSubtickOverflow           0x27

#define  fatTaskIllegalTaskNumber         0x28

#define  fatUnused_0x29                   0x29

#define  fatIllegalCallfromISR            0x2A

#define  fatUnused_0x2B                   0x2B

#define  fatUnused_0x2C                   0x2C

#define  fatUnused_0x2D                   0x2D

#define  fatUnused_0x2E                   0x2E

#define  fatUnused_0x2F                   0x2F


#define  traceNull                                    0x00  /* Nullbyte is not used, and may used as separation byte.           */
#define  traceMarker                                  0x01  /* Mark a special point in the tracing.                             */
#define  traceUserByteMessage                         0x02  /* Used to pass a payload information byte                          */
#define  traceUserWordMessage                         0x03  /* Used to pass a payload information word                          */
#define  traceTaskStart                               0x10  /* switched to the task number 0x00 - 0x0F by 0x10 - 0x1F           */
#define  traceOsStart                                 0x20  /* switched to the OS                                               */
#define  traceIdleStart                               0x21  /* switched to the idle task                                        */
#define  traceSleepStart                              0x22  /* switched to low power sleep                                      */
#define  traceTickInterrupt                           0x23  /* a tick interrupt has occurred                                    */
#define  traceWatchdog                                0x24  /* the watchdog barked, see following TaskInit for number           */
#define  traceLockAcquire                             0x25  /* the slot is free and the task may continue                       */
#define  traceLockReject                              0x26  /* the slot has been taken and the task will be blocked             */
#define  traceReset                                   0x27  /* a reset occurred                                                 */
#define  traceISR                                     0x28  /* switched to one of 8 interrupts 0x28 -- 0x2F, define yourself.   */
#define  traceSlotLock                                0x30  /* lock a slot, 2 bytes:   (0x30 | tasknumber), (slot1<<4 | slot2)  */
#define  traceSlotUnlock                              0x40  /* unlock a slot, 2 bytes: (0x40 | tasknumber), (slot1<<4 | slot2)  */
#define  traceFireEvent                               0x50  /* Fire of event number 0..7 given by 0x50 ... 0.57                 */
#define  traceWatermarks                              0x58  /* Watermarks of stacks of OS, ISR and tasks                        */
#define  traceUnused                                  0x59  /* Unused                                                           */
#define  traceREGISTERLEAK_5A                         0x5A  /* If this event occurs, you probably have a register leak          */
#define  traceBurnLock                                0x5B  /* File system not ready for burning                                */
#define  traceBurnFree                                0x5C  /* File system ready for burning                                    */
#define  traceCreateContext                           0x5D  /* construction of a context                                        */
#define  traceLoadInfo                                0x5E  /* Load info on Os, Idle, ISR + tasks, multibyte message            */
#define  traceOsTime                                  0x5F  /* Continuous average load of the Os, 3 byte message                */
#define  traceTaskInit                                0x60  /* Initialized task number 0x00 - 0x0F by 0x60 - 0x6F               */
#define  traceTaskRelease                             0x70  /* A blocked (Sync,File,Event) task may continue 0x70..0x7F         */
#define  traceAPIcallBase                             0x80  /* 0x80 -- 0xCF api called (max 80 functions's)                     */
#define  traceAPIcall1                                0x90  /* See below for definitions                                        */
#define  traceAPIcall2                                0xA0  /*                                                                  */
#define  traceAPIcall3                                0xB0  /*                                                                  */
#define  traceAPIcall4                                0xC0  /*                                                                  */
#define  traceErrorBase                               0xD0  /* 0xD0 -- 0xFF error situation (max 48 error's)                    */
#define  traceError1                                  0xE0  /* See above for definitions                                        */
#define  traceError2                                  0xF0  /*                                                                  */

#define  callIdSystem                                 0x00  
#define  callIdTaskYield                              0x01  
#define  callIdTaskWaitForEvent                       0x02  
#define  callIdTaskDelayFromNow                       0x03  
#define  callIdTaskDelayFromWake                      0x04  
#define  callIdTaskSuspend                            0x05  
#define  callIdTaskSleep                              0x06  
#define  callIdTaskSleepAll                           0x07  
#define  callIdTaskRecreate                           0x08  
#define  callIdTaskFeedWatchdog                       0x09  
#define  callIdTaskKillWatchdog                       0x0A  
#define  callIdTaskRestart                            0x0B  
#define  callIdTaskTerminate                          0x0C  
#define  callIdTaskEnableGlobalInterrupts             0x0D  
#define  callIdTaskDisableGlobalInterrupts            0x0E  
#define  callIdTaskEnableTickInterrupts               0x0F  
#define  callIdTaskDisableTickInterrupts              0x10  
#define  callIdTaskEnableSwitchTask                   0x11  
#define  callIdTaskDisableSwitchTask                  0x12  
#define  callIdTaskEnterGlobalCritical                0x13  
#define  callIdTaskExitGlobalCritical                 0x14  
#define  callIdTaskEnterTickCritical                  0x15  
#define  callIdTaskExitTickCritical                   0x16  
#define  callIdTaskEnterSwitchCritical                0x17  
#define  callIdTaskExitSwitchCritical                 0x18  
#define  callIdTaskFileOpen                           0x19  
#define  callIdTaskFileClose                          0x1A  
#define  callIdTaskFileFormat                         0x1B  
#define  callIdTaskFileGetSize                        0x1C  
#define  callIdTaskFileSetSize                        0x1D  
#define  callIdTaskFileReadByte                       0x1E  
#define  callIdTaskFileWriteByte                      0x1F  
#define  callIdTaskFileAppendByte                     0x20  
#define  callIdTaskFileReadPipe                       0x21  
#define  callIdTaskFileWritePipe                      0x22  
#define  callIdTaskFileReadBuffer                     0x23  
#define  callIdTaskFileWriteBuffer                    0x24  
#define  callIdREGISTERLEAK_A5                        0x25  
#define  callIdTaskWaitForTasks                       0x26  
#define  callIdTaskSyncRequest                        0x27  
#define  callIdTaskSyncRelease                        0x28  
#define  callIdTaskMemMalloc                          0x29  
#define  callIdTaskMemFree                            0x2A  
#define  callIdTaskMemDefrag                          0x2B  
#define  callIdTaskMemPointer                         0x2C  
#define  callIdTaskReserved1                          0x2D  
#define  callIdTaskReserved2                          0x2E  
#define  callIdTaskReserved3                          0x2F  
#define  callIdTaskReserved4                          0x30  
#define  callIdTaskReserved5                          0x31  
#define  callIdTaskReserved6                          0x32  
#define  callIdGenSuspend                             0x33  
#define  callIdGenResume                              0x34  
#define  callIdGenSetPriority                         0x35  
#define  callIdGenGetPriority                         0x36  
#define  callIdGenGetTickCount                        0x37  
#define  callIdGenGetLastWakeTime                     0x38  
#define  callIdGenGetTaskname                         0x39  
#define  callIdGenFireEventSet                        0x3A  
#define  callIdGenReboot                              0x3B  
#define  callIdGenLogTask                             0x3C  
#define  callIdGenLogOs                               0x3D  
#define  callIdGenWaitRelease                         0x3E  
#define  callIdGenQueuWrite                           0x3F  
#define  callIdGenQueuRead                            0x40  
#define  callIdGenQueuPeek                            0x41  
#define  callIdGenQueuReadable                        0x42  
#define  callIdGenQueuWriteable                       0x43  
#define  callIdGenQueuFull                            0x44  
#define  callIdGenQueuEmpty                           0x45  
#define  callIdGenQueuClear                           0x46  
#define  callIdGenAddtoTickCount                      0x47  
#define  callIdGenPassFlashString                     0x48  
#define  callIdGenCountEventBlocks                    0x49  
#define  callIdGenReserved1                           0x4A  
#define  callIdGenReserved2                           0x4B  
#define  callIdGenReserved3                           0x4C  
#define  callIdGenReserved4                           0x4D  
#define  callIdGenReserved5                           0x4E  
#define  callIdGenReserved6                           0x4F  
#define  callIdTaskStackCheck                         ----  
#define  callIdGenPipeInt16                           ----  
#define  callIdGenTraceByteInfo                       ----  
#define  callIdGenTraceWordInfo                       ----  
#define  callIdGenTraceMarker                         ----  
#define  callIdTaskMutexRequestOnName                 0x27  
#define  callIdTaskMutexReleaseOnName                 0x27  
#define  callIdTaskQueuWriteRequestOnName             0x27  
#define  callIdTaskQueuReadRequestOnName              0x27  
#define  callIdTaskQueuReleaseOnName                  0x28  
#define  callIdTaskSyncReleaseOnName                  0x28  
#define  callIdTaskSyncWriteWriteRequestOnName        0x27  
#define  callIdTaskSyncWriteReadRequestOnName         0x27  
#define  callIdTaskSyncReadWriteRequestOnName         0x27  
#define  callIdTaskSyncReadReadRequestOnName          0x27  
#define  callIdTaskWaitForOtherTask                   0x26  
#define  callIdIsrBegin                               ----  
#define  callIdIsrEndReturn                           ----  
#define  callIdIsrEndYield                            ----  
#define  callIdIsrEnter                               ----  
#define  callIdIsrExit                                ----  
#define  callIdIsrStackCheck                          ----  
#define  callIdIsrStartLoad                           ----  
#define  callIdIsrStopLoad                            ----  
#define  callIdIsrFireEvent                           ----  
#define  callIdGenFireEvent                           ----  
#define  callIdTaskFileClear                          0x1D  
#define  callIdTaskFileDirectRead                     ----  
#define  callIdTaskFileDirectWrite                    ----  
#define  defResponseOK                                0x01  /* datalength: 0   */
#define  defResponseUnknownCommand                    0x02  /* datalength: 0   */
#define  defResponseError                             0x03  /* datalength: 0   */
#define  defResponseInvalidTask                       0x04  /* datalength: 0   */
#define  defResponseInvalidPriority                   0x05  /* datalength: 0   */
#define  defResponseFemtoOs                           0x10  /* datalength: 12  */
#define  defResponseLogTask                           0x11  /* datalength: 16  */
#define  defResponseLogOs                             0x12  /* datalength: 10  */
#define  defResponseTickCount                         0x13  /* datalength: 2   */
#define  defResponseDump                              0x14  /* datalength: 2   */
#define  defResponseUptime                            0x15  /* datalength: 5   */
#define  defResponseFile                              0x16  /* datalength: x   */
#define  defResponseInvalidFileNumber                 0x17  /* datalength: x   */

#define  defRequestFemtoOs                            0x90  /* datalength: 0   */
#define  defRequestProcessList                        0x91  /* datalength: 0   */
#define  defRequestTickCount                          0x93  /* datalength: 0   */
#define  defRequestReboot                             0x94  /* datalength: 0   */
#define  defRequestSuspend                            0x95  /* datalength: 1   */
#define  defRequestResume                             0x96  /* datalength: 1   */
#define  defRequestTerminate                          0x97  /* datalength: 1   */
#define  defRequestPriority                           0x98  /* datalength: 2   */
#define  defRequestRecreate                           0x99  /* datalength: 2   */
#define  defRequestDump                               0x9A  /* datalength: 2   */
#define  defRequestStore                              0x9B  /* datalength: x   */
#define  defRequestRecall                             0x9C  /* datalength: x   */
#define  defRequestUptime                             0x9D  /* datalength: 0   */
#define  defRequestTest                               0x9E  /* datalength: 1  */

#define defDumpRAM                                    0x01
#define defDumpEEPROM                                 0x02
#define defDumpFLASH                                  0x03

#endif /* FEMTOOS_GLOBALS_H */

---