/******************************************************************* Copyright © 1995 - 1998, 3Com Corporation or its subsidiaries ("3Com"). All rights reserved. This software may be copied and used solely for developing products for the Palm Computing platform and for archival and backup purposes. Except for the foregoing, no part of this software may be reproduced or transmitted in any form or by any means or used to make any derivative work (such as translation, transformation or adaptation) without express written consent from 3Com. 3Com reserves the right to revise this software and to make changes in content from time to time without obligation on the part of 3Com to provide notification of such revision or changes. 3COM MAKES NO REPRESENTATIONS OR WARRANTIES THAT THE SOFTWARE IS FREE OF ERRORS OR THAT THE SOFTWARE IS SUITABLE FOR YOUR USE. THE SOFTWARE IS PROVIDED ON AN "AS IS" BASIS. 3COM MAKES NO WARRANTIES, TERMS OR CONDITIONS, EXPRESS OR IMPLIED, EITHER IN FACT OR BY OPERATION OF LAW, STATUTORY OR OTHERWISE, INCLUDING WARRANTIES, TERMS, OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND SATISFACTORY QUALITY. TO THE FULL EXTENT ALLOWED BY LAW, 3COM ALSO EXCLUDES FOR ITSELF AND ITS SUPPLIERS ANY LIABILITY, WHETHER BASED IN CONTRACT OR TORT (INCLUDING NEGLIGENCE), FOR DIRECT, INCIDENTAL, CONSEQUENTIAL, INDIRECT, SPECIAL, OR PUNITIVE DAMAGES OF ANY KIND, OR FOR LOSS OF REVENUE OR PROFITS, LOSS OF BUSINESS, LOSS OF INFORMATION OR DATA, OR OTHER FINANCIAL LOSS ARISING OUT OF OR IN CONNECTION WITH THIS SOFTWARE, EVEN IF 3COM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 3Com, HotSync, Palm Computing, and Graffiti are registered trademarks, and Palm III and Palm OS are trademarks of 3Com Corporation or its subsidiaries. IF THIS SOFTWARE IS PROVIDED ON A COMPACT DISK, THE OTHER SOFTWARE AND DOCUMENTATION ON THE COMPACT DISK ARE SUBJECT TO THE LICENSE AGREEMENT ACCOMPANYING THE COMPACT DISK. *------------------------------------------------------------------- * FileName: * SystemMgr.h * * Description: * Pilot system equates * * History: * 10/27/94 RM - Created by Ron Marianetti * 10/ 7/96 SCL - Added sysAppLaunchFlagDataRelocated flag * 11/13/96 vmk - Added sysErrDelayWakened error code * *******************************************************************/ #ifndef __SYSTEMMGR_H__ #define __SYSTEMMGR_H__ // Include elementary types #include #include // Trap Numbers. // Other types #include // Resource definitions. // UI Headers #include #include #include #include #include #include #include #include // for DmOpenRef /************************************************************ * System Constants *************************************************************/ // Define the number of ticks/second #if EMULATION_LEVEL == EMULATION_MAC #define sysTicksPerSecond 60 // 60/sec on Macintosh #elif EMULATION_LEVEL == EMULATION_NONE #define sysTicksPerSecond 100 // 100/sec on Pilot #elif EMULATION_LEVEL == EMULATION_WINDOWS #define sysTicksPerSecond 1000 // 1000/sec on Windows PC #else #error #endif /************************************************************ * Rules for creating and using the Command Parameter Block * passed to SysUIAppSwitch *************************************************************/ // A parameter block containing application-specific information may be passed // to an application when launching it via SysUIAppSwitch. To create the // parameter block, you allocate a memory block using MemPtrNew and then you must // call MemPtrSetOwner to set the block's owner ID to 0. This assigns the block's // ownership to the system so that it will not be automatically freed by the system // when the calling app exits. The command block must be self contained. It must not // have pointers to anything on the stack or in memory blocks owned by an application. // The launching and launched applications do not need to worry about freeing the // command block since the system will do this after the launched application exits. // If no parameter block is being passed, this parameter must be NULL. /************************************************************ * Action Codes * * IMPORTANT ACTION CODE CONSIDERATIONS: * * Many action codes are "sent" to apps via a direct function call into the app's * PilotMain() function without launching the app. For these action codes, the * application's global and static variables are *not* available, unless the * application is already running. Some action codes are synchronized with the * currently running UI applcation via the event manager (alarm action codes, * for example), while others, such as HotSync action codes, are sent from a * background thread. To find out if your app is running (is the current UI * app) when an action code is received, test the sysAppLaunchFlagSubCall flag * (defined in SystemMgr.h) which is passed to your PilotMain in the * launchFlags parameter (the third PilotMain parameter). If it is non-zero, * you may assume that your app is currently running and the global variables * are accessible. This information is useful if your app maintains an open * data database (or another similar resource) when it is running. If the app * receives an action code and the sysAppLaunchFlagSubCall is set in * launchFlags, the handler may access global variables and use the open * database handle while handling the call. On the other hand, if the * sysAppLaunchFlagSubCall flag is not set (ie., zero), the handler will need * to open and close the database itself and is not allowed to access global * or static variables. * *************************************************************/ // NOTE: for defining custom action codes, see sysAppLaunchCmdCustomBase below. // System SysAppLaunch Commands #define sysAppLaunchCmdNormalLaunch 0 // Normal Launch #define sysAppLaunchCmdFind 1 // Find string #define sysAppLaunchCmdGoTo 2 // Launch and go to a particular record #define sysAppLaunchCmdSyncNotify 3 // Sent to apps whose databases changed during // HotSync after the sync has been completed, // including when the app itself has been installed // by HotSync. The data database(s) must have the // same creator ID as the application for this // mechanism to function correctly. This is a // good opportunity to update/initialize/validate // the app's data, such as resorting records, // setting alarms, etc. // // Parameter block: None. // Restrictions: No accessing of global or // static variables; no User Interface calls. // Notes: This action code is sent via a // direct function call into the app's // PilotMain function from the background // thread of the HotSync application. #define sysAppLaunchCmdTimeChange 4 // Sent to all applications and preference // panels when the system time is changed. // This notification is the right place to // update alarms and other time-related // activities and resources. // // Parameter block: None. // Restrictions: No accessing of global or // static variables; no User Interface calls. // Notes: This action code is sent via a direct // function call into the app's PilotMain // function without "launching" the app. #define sysAppLaunchCmdSystemReset 5 // Sent to all applications and preference // panels when the system is either soft-reset // or hard-reset. This notification is the // right place to initialize and/or validate // your application's preferences/features/ // database(s) as well as to update alarms and // other time-related activities and resources. // // Parameter block: SysAppLaunchCmdSystemResetType // Restrictions: No accessing of global or // static variables; no User Interface calls. // Notes: This action code is sent via a direct // function call into the app's PilotMain // function without "launching" the app. #define sysAppLaunchCmdAlarmTriggered 6 // Sent to an application at the time its // alarm time expires (even when another app // is already displaying its alarm dialog box). // This call is intended to allow the app to // perform some very quick activity, such as // scheduling the next alarm or performing a // quick maintenance task. The handler for // sysAppLaunchCmdAlarmTriggered must take as // little time as possible and is *not* allowed // to block (this would delay notification for // alarms set by other applications). // // Parameter block: SysAlarmTriggeredParamType // (defined in AlarmMgr.h) // Restrictions: No accessing of global or // static variables unless sysAppLaunchFlagSubCall // flag is set, as discussed above. // Notes: This action code is sent via a direct // function call into the app's PilotMain // function without "launching" the app. #define sysAppLaunchCmdDisplayAlarm 7 // Sent to an application when it is time // to display the alarm UI. The application // is responsible for making any alarm sounds // and for displaying the alarm UI. // sysAppLaunchCmdDisplayAlarm calls are ordered // chronoligically and are not overlapped. // This means that your app will receive // sysAppLaunchCmdDisplayAlarm only after // all earlier alarms have been displayed. // // Parameter block: SysDisplayAlarmParamType // (defined in AlarmMgr.h) // Restrictions: No accessing of global or // static variables unless sysAppLaunchFlagSubCall // flag is set, as discussed above. UI calls are // allowed to display the app's alarm dialog. // Notes: This action code is sent via a direct // function call into the app's PilotMain // function without "launching" the app. #define sysAppLaunchCmdCountryChange 8 // The country has changed #define sysAppLaunchCmdSyncRequestLocal 9 // Sent to the HotSync application to request a // local HotSync. ("HotSync" button was pressed.) #define sysAppLaunchCmdSyncRequest sysAppLaunchCmdSyncRequestLocal // for backward compatibility #define sysAppLaunchCmdSaveData 10 // Sent to running app before sysAppLaunchCmdFind // or other action codes that will cause data // searches or manipulation. #define sysAppLaunchCmdInitDatabase 11 // Sent to an application when a database with // a matching Creator ID is created during // HotSync (in response to a "create db" // request). This allows the application to // initialize a newly-created database during // HotSync. This might include creating some // default records, setting up the database's // application and sort info blocks, etc. // // Parameter block: SysAppLaunchCmdInitDatabaseType // Restrictions: No accessing of global or // static variables; no User Interface calls. // Notes: This action code is sent via a // direct function call into the app's // PilotMain function from the background // thread of the HotSync application. #define sysAppLaunchCmdSyncCallApplicationV10 12 // Used by DesktopLink Server command "call application"; // Pilot v1.0 only!!! //------------------------------------------------------------------------ // New launch codes defined for PalmOS 2.0 //------------------------------------------------------------------------ #define sysAppLaunchCmdPanelCalledFromApp 13 // The panel should display a done // button instead of the pick list. // The Done button will return the user // to the last app. #define sysAppLaunchCmdReturnFromPanel 14 // A panel returned to this app #define sysAppLaunchCmdLookup 15 // Lookup info managed by an app #define sysAppLaunchCmdSystemLock 16 // Lock the system until a password is entered. #define sysAppLaunchCmdSyncRequestRemote 17 // Sent to the HotSync application to request // a remote HotSync. ("Remote HotSync" button // was pressed.) #define sysAppLaunchCmdHandleSyncCallApp 18 // Pilot v2.0 and greater. Sent by DesktopLink Server to an application to handle // the "call application" command; use DlkControl with // control code dlkCtlSendCallAppReply to send the reply(see DLServer.h). // This action code replaces the v1.0 code sysAppLaunchCmdSyncCallApplication. // vmk 11/26/96 #define sysAppLaunchCmdAddRecord 19 // Add a record to an applications's database. //------------------------------------------------------------------------ // Standard Service Panel launch codes (used by network panel, dialer panel, etc.) // (DOLATER... document parameter block structures) //------------------------------------------------------------------------ #define sysSvcLaunchCmdSetServiceID 20 #define sysSvcLaunchCmdGetServiceID 21 #define sysSvcLaunchCmdGetServiceList 22 #define sysSvcLaunchCmdGetServiceInfo 23 #define sysAppLaunchCmdFailedAppNotify 24 // An app just switched to failed. #define sysAppLaunchCmdEventHook 25 // Application event hook callback #define sysAppLaunchCmdExgReceiveData 26 // Exg command for app to receive data. #define sysAppLaunchCmdExgAskUser 27 // Exg command sent before asking user. //------------------------------------------------------------------------ // Standard Dialer Service launch codes (30 - 39 reserved) // (DOLATER... document parameter block structures) //------------------------------------------------------------------------ // sysDialLaunchCmdDial: dials the modem(optionally displays dial progress UI), given service id // and serial library reference number #define sysDialLaunchCmdDial 30 // sysDialLaunchCmdHangUp: hangs up the modem(optionally displays disconnect progress UI), given service id // and serial library reference number #define sysDialLaunchCmdHangUp 31 #define sysDialLaunchCmdLast 39 //------------------------------------------------------------------------ // Additional standard Service Panel launch codes (used by network panel, dialer panel, etc) // (40-49 reserved) //------------------------------------------------------------------------ #define sysSvcLaunchCmdGetQuickEditLabel 40 // SvcQuickEditLabelInfoType #define sysSvcLaunchCmdLast 49 // ***ADD NEW SYSTEM ACTION CODES BEFORE THIS COMMENT*** //------------------------------------------------------------------------ // Custom action code base (custom action codes begin at this value) //------------------------------------------------------------------------ #define sysAppLaunchCmdCustomBase 0x8000 // Your custom launch codes can be defined like this: // // typedef enum { // myAppCmdDoSomething = sysAppLaunchCmdCustomBase, // myAppCmdDoSomethingElse, // myAppCmdEtcetera // // } MyAppCustomActionCodes; //------------------------------------------------------------------------ // SysAppLaunch flags (passed to PilotMain) //------------------------------------------------------------------------ #define sysAppLaunchFlagNewThread 0x01 // create a new thread for application // - implies sysAppLaunchFlagNewStack #define sysAppLaunchFlagNewStack 0x02 // create separate stack for application #define sysAppLaunchFlagNewGlobals 0x04 // create new globals world for application // - implies new owner ID for Memory chunks #define sysAppLaunchFlagUIApp 0x08 // notifies launch routine that this is a UI app being // launched. #define sysAppLaunchFlagSubCall 0x10 // notifies launch routine that the app is calling it's // entry point as a subroutine call. This tells the launch // code that it's OK to keep the A5 (globals) pointer valid // through the call. // IMPORTANT: This flag is for internal use by // SysAppLaunch only!!! It should NEVER be set // by the caller. #define sysAppLaunchFlagDataRelocated 0x80 // global data (static ptrs) have been "relocated" // by either SysAppStartup or StartupCode.c // IMPORTANT: This flag is for internal use by // SysAppLaunch only!!! It should NEVER be set // by the caller. // The set of private, internal flags that should never be set by the caller #define sysAppLaunchFlagPrivateSet (sysAppLaunchFlagSubCall | sysAppLaunchFlagDataRelocated) //------------------------------------------------------------------- // Parameter blocks for action codes // NOTE: The parameter block for the sysAppLaunchCmdFind and sysAppLaunchCmdGoTo // action codes are defined in "Find.h"; //--------------------------------------------------------------------------- // For sysAppLaunchCmdSaveData typedef struct { Boolean uiComing; // true if system dialog will be put up // before coming action code arrives. } SysAppLaunchCmdSaveDataType; // For sysAppLaunchCmdSystemReset typedef struct { Boolean hardReset; // true if system was hardReset, false if soft-reset. Boolean createDefaultDB; // true if app should create default database. } SysAppLaunchCmdSystemResetType; // For sysAppLaunchCmdInitDatabase typedef struct SysAppLaunchCmdInitDatabaseType { DmOpenRef dbP; // Handle of the newly-created database, // already open for read/write access. // IMPORTANT: The handler *MUST* leave // this database handle open on return. ULong creator; // Creator ID of the newly-created database ULong type; // Type ID of the newly-created database UInt version; // Version number of the newly-created database } SysAppLaunchCmdInitDatabaseType; // For sysAppLaunchCmdSyncCallApplicationV10 // This structure used on Pilot v1.0 only. See sysAppLaunchCmdHandleSyncCallApp // for later platforms. typedef struct SysAppLaunchCmdSyncCallApplicationTypeV10 { Word action; // call action id (app-specific) Word paramSize; // parameter size VoidPtr paramP; // ptr to parameter Byte remoteSocket; // remote socket id Byte tid; // command transaction id Boolean handled; // if handled, MUST be set true by the app } SysAppLaunchCmdSyncCallApplicationTypeV10; // For sysAppLaunchCmdHandleSyncCallApp (Pilot v2.0 and greater). // This structure replaces SysAppLaunchCmdSyncCallApplicationType // which was used in Pilot v1.0 typedef struct SysAppLaunchCmdHandleSyncCallAppType { Word pbSize; // this parameter block size (set to sizeof SysAppLaunchCmdHandleSyncCallAppType) Word action; // call action id (app-specific) VoidPtr paramP; // ptr to parameter DWord dwParamSize; // parameter size VoidPtr dlRefP; // DesktopLink reference pointer for passing // to DlkControl()'s dlkCtlSendCallAppReply code Boolean handled; // initialized to FALSE by DLServer; if // handled, MUST be set TRUE by the app(the // handler MUST call DlkControl with // control code dlkCtlSendCallAppReply); // if the handler is not going to send a reply, // it should leave this field set to FALSE, in which // case DesktopLink Server will send the default // "unknown request" reply. Err replyErr; // error from dlkCtlSendCallAppReply // RESERVED FOR FUTURE EXTENSIONS DWord dwReserved1; // RESERVED -- set to null!!! DWord dwReserved2; // RESERVED -- set to null!!! // Target executable creator and type for testing the mechanism // in EMULATION MODE ONLY!!! #if EMULATION_LEVEL != EMULATION_NONE DWord creator; DWord type; #endif } SysAppLaunchCmdHandleSyncCallAppType; // For sysAppLaunchCmdFailedAppNotify typedef struct { DWord creator; DWord type; Err result; } SysAppLaunchCmdFailedAppNotifyType; /************************************************************ * Function prototype for libraries *************************************************************/ // ***IMPORTANT*** // ***IMPORTANT*** // ***IMPORTANT*** // // The assembly level TrapDispatcher() function uses a hard-coded value for // the size of the structure SysLibTblEntryType to obtain a pointer to a // library entry in the library table. Therefore, any changes to this structure, // require corresponding changes in TrapDispatcher() in ROMBoot.c. Furthermore, // it is advantageous to keep the size of the structure a power of 2 as this // improves performance by allowing the entry offset to be calculated by shifting // left instead of using the multiply instruction. vmk 8/27/96 (yes, I fell into // this trap myself) typedef struct SysLibTblEntryType { Ptr* dispatchTblP; // pointer to library dispatch table void* globalsP; // Library globals // New INTERNAL fields for v2.0 (vmk 8/27/96): LocalID dbID; // database id of the library VoidPtr codeRscH; // library code resource handle for RAM-based libraries } SysLibTblEntryType; typedef SysLibTblEntryType* SysLibTblEntryPtr; // Library entry point procedure typedef Err (*SysLibEntryProcPtr)(UInt refNum, SysLibTblEntryPtr entryP); // This library refNum is reserved for the Debugger comm library #define sysDbgCommLibraryRefNum 0 // This refNum signals an invalid refNum #define sysInvalidRefNum 0xFFFF /************************************************************ * Function prototype for Kernel *************************************************************/ // Task termination procedure prototype for use with SysTaskSetTermProc typedef void (*SysTermProcPtr)(ULong taskID, Long reason); // Timer procedure for use with SysTimerCreate typedef void (*SysTimerProcPtr)(Long timerID, Long param); /************************************************************ * Error Classes for each manager *************************************************************/ #define memErrorClass 0x0100 // Memory Manager #define dmErrorClass 0x0200 // Data Manager #define serErrorClass 0x0300 // Serial Manager #define slkErrorClass 0x0400 // Serial Link Manager #define sysErrorClass 0x0500 // System Manager #define fplErrorClass 0x0600 // Floating Point Library #define flpErrorClass 0x0680 // New Floating Point Library #define evtErrorClass 0x0700 // System Event Manager #define sndErrorClass 0x0800 // Sound Manager #define almErrorClass 0x0900 // Alarm Manager #define timErrorClass 0x0A00 // Time Manager #define penErrorClass 0x0B00 // Pen Manager #define ftrErrorClass 0x0C00 // Feature Manager #define cmpErrorClass 0x0D00 // Connection Manager #define dlkErrorClass 0x0E00 // Desktop Link Manager #define padErrorClass 0x0F00 // PAD Manager #define grfErrorClass 0x1000 // Graffiti Manager #define mdmErrorClass 0x1100 // Modem Manager #define netErrorClass 0x1200 // Net Library #define htalErrorClass 0x1300 // HTAL Library #define inetErrorClass 0x1400 // INet Library #define exgErrorClass 0x1500 // Exg Manager #define fileErrorClass 0x1600 // File Stream Manager #define rfutErrorClass 0x1700 // RFUT Library #define appErrorClass 0x8000 // Application-defined errors /************************************************************ * System Errors *************************************************************/ #define sysErrTimeout (sysErrorClass | 1) #define sysErrParamErr (sysErrorClass | 2) #define sysErrNoFreeResource (sysErrorClass | 3) #define sysErrNoFreeRAM (sysErrorClass | 4) #define sysErrNotAllowed (sysErrorClass | 5) #define sysErrSemInUse (sysErrorClass | 6) #define sysErrInvalidID (sysErrorClass | 7) #define sysErrOutOfOwnerIDs (sysErrorClass | 8) #define sysErrNoFreeLibSlots (sysErrorClass | 9) #define sysErrLibNotFound (sysErrorClass | 10) #define sysErrDelayWakened (sysErrorClass | 11) // SysTaskDelay wakened by SysTaskWake before delay completed. #define sysErrRomIncompatible (sysErrorClass | 12) /************************************************************ * System Features *************************************************************/ #define sysFtrCreator sysFileCSystem // Feature Creator #define sysFtrNumROMVersion 1 // ROM Version // 0xMMmfsbbb, where MM is major version, m is minor version // f is bug fix, s is stage: 3-release,2-beta,1-alpha,0-development, // bbb is build number for non-releases // V1.12b3 would be: 0x01122003 // V2.00a2 would be: 0x02001002 // V1.01 would be: 0x01013000 #define sysFtrNumProductID 2 // Product id // 0xMMMMRRRR, where MMMM is the model and RRRR // is the revision. #define sysFtrNumBacklight 3 // Backlight // bit 0: 1 if present. 0 if Feature does not exist or backlight is not present #define sysFtrNumEncryption 4 // Which encryption schemes are present #define sysFtrNumEncryptionMaskDES 0x00000001 // bit 0: 1 if DES is present #define sysFtrNumCountry 5 // International ROM identifier // Result is of type CountryType as defined in Preferences.h. // Result is essentially the "default" country for this ROM. // Assume cUnitedStates if sysFtrNumROMVersion >= 02000000 // and feature does not exist. #define sysFtrNumLanguage 6 // Language identifier // Result is of untyped; values are defined in Incs:BuildRules.h // Result is essentially the "default" language for this ROM. // This is new for the WorkPad (v2.0.2) and did NOT exist for any of the // following: GermanPersonal, GermanPro, FrenchPersonal, FrenchPro // Thus we can't really assume anything if the feature doesn't exist, // though the actual language MAY be determined from sysFtrNumCountry, above. #define sysFtrNumDisplayDepth 7 // Display depth // Result is the "default" display depth for the screen. // This value is used by ScrDisplayMode when setting the default display depth. /************************************************************ * ROM token information (for SysGetROMToken, below) *************************************************************/ // Additional tokens and token information is located in #define sysROMTokenSnum 'snum' // Memory Card Flash ID (serial number) /************************************************************ * Macros for extracting and combining ROM/OS version components *************************************************************/ // ROM/OS stage numbers #define sysROMStageDevelopment (0) #define sysROMStageAlpha (1) #define sysROMStageBeta (2) #define sysROMStageRelease (3) // MACRO: sysMakeROMVersion // // Builds a ROM version value from the major, minor, fix, stage, and build numbers // #define sysMakeROMVersion(major, minor, fix, stage, buildNum) \ ( \ (((DWord)((Byte)(major) & 0x0FF)) << 24) | \ (((DWord)((Byte)(minor) & 0x00F)) << 20) | \ (((DWord)((Byte)(fix) & 0x00F)) << 16) | \ (((DWord)((Byte)(stage) & 0x00F)) << 12) | \ (((DWord)((Word)(buildNum) & 0x0FFF))) \ ) // Macros for parsing the ROM version number // (the system OS version is obtained by calling // FtrGet(sysFtrCreator, sysFtrNumROMVersion, dwOSVerP), where dwOSVerP is // a pointer to to a DWord variable that is to receive the OS version number) #define sysGetROMVerMajor(dwROMVer) (((Word)((dwROMVer) >> 24)) & 0x00FF) #define sysGetROMVerMinor(dwROMVer) (((Word)((dwROMVer) >> 20)) & 0x000F) #define sysGetROMVerFix(dwROMVer) (((Word)((dwROMVer) >> 16)) & 0x000F) #define sysGetROMVerStage(dwROMVer) (((Word)((dwROMVer) >> 12)) & 0x000F) #define sysGetROMVerBuild(dwROMVer) (((Word)(dwROMVer)) & 0x0FFF) /************************************************************ * System Types *************************************************************/ // Types of batteries installed. typedef enum { sysBatteryKindAlkaline=0, sysBatteryKindNiCad, sysBatteryKindLithium } SysBatteryKind; // SysCreateDataBaseList can generate a list of database. typedef struct { Char name[dmDBNameLength]; ULong creator; ULong type; UInt version; LocalID dbID; UInt cardNo; BitmapPtr iconP; } SysDBListItemType; // Structure of a generic message that can be send to a mailbox // through the SysMailboxSend call. Note, this structure MUST // be CJ_MAXMSZ bytes large, where CJ_MAXMSZ is defined in // the AMX includes. typedef struct { DWord data[3]; } SysMailboxMsgType; // Constants used by the SysEvGroupSignal call #define sysEvGroupSignalConstant 0 #define sysEvGroupSignalPulse 1 // Constants used by the SysEvGroupWait call #define sysEvGroupWaitOR 0 #define sysEvGroupWaitAND 1 /************************************************************ * System Pre-defined "file descriptors" * These are used by applications that use the Net Library's * NetLibSelect() call *************************************************************/ #define sysFileDescStdIn 0 /************************************************************ * Function Prototypes *************************************************************/ #ifdef __cplusplus extern "C" { #endif // Prototype for Pilot applications entry point DWord PilotMain(Word cmd, Ptr cmdPBP, Word launchFlags); // SystemMgr routines void SysUnimplemented(void) SYS_TRAP(sysTrapSysUnimplemented); void SysColdBoot(Ptr card0P, ULong card0Size, Ptr card1P, ULong card1Size, DWord sysCardHeaderOffset) SYS_TRAP(sysTrapSysColdBoot); void SysInit(void) SYS_TRAP(sysTrapSysInit); void SysReset(void) SYS_TRAP(sysTrapSysReset); void SysPowerOn(Ptr card0P, ULong card0Size, Ptr card1P, ULong card1Size, DWord sysCardHeaderOffset, Boolean reFormat); void SysDoze(Boolean onlyNMI) SYS_TRAP(sysTrapSysDoze); Err SysSetPerformance(ULongPtr sysClockP, UIntPtr cpuDutyP) SYS_TRAP(sysTrapSysSetPerformance); void SysSleep(Boolean untilReset, Boolean emergency) SYS_TRAP(sysTrapSysSleep); UInt SysSetAutoOffTime(UInt seconds) SYS_TRAP(sysTrapSysSetAutoOffTime); Word SysTicksPerSecond(void) SYS_TRAP(sysTrapSysTicksPerSecond); Err SysLaunchConsole(void) SYS_TRAP(sysTrapSysLaunchConsole); Boolean SysHandleEvent(EventPtr eventP) SYS_TRAP(sysTrapSysHandleEvent); void SysUILaunch(void) SYS_TRAP(sysTrapSysUILaunch); Err SysUIAppSwitch(UInt cardNo, LocalID dbID, Word cmd, Ptr cmdPBP) SYS_TRAP(sysTrapSysUIAppSwitch); Err SysCurAppDatabase(UIntPtr cardNoP, LocalID* dbIDP) SYS_TRAP(sysTrapSysCurAppDatabase); Err SysBroadcastActionCode(Word cmd, Ptr cmdPBP) SYS_TRAP(sysTrapSysBroadcastActionCode); Err SysAppLaunch(UInt cardNo, LocalID dbID, UInt launchFlags, Word cmd, Ptr cmdPBP, DWord* resultP) SYS_TRAP(sysTrapSysAppLaunch); UInt SysNewOwnerID(void) SYS_TRAP(sysTrapSysNewOwnerID); DWord SysSetA5(DWord newValue) SYS_TRAP(sysTrapSysSetA5); Ptr SysCardImageInfo(UInt cardNo, ULongPtr sizeP); void SysCardImageDeleted(UInt cardNo); Word SysUIBusy(Boolean set, Boolean value) SYS_TRAP(sysTrapSysUIBusy); // System Dialogs void SysBatteryDialog(void) SYS_TRAP(sysTrapSysBatteryDialog); // Utilities Err SysSetTrapAddress(UInt trapNum, VoidPtr procP) SYS_TRAP(sysTrapSysSetTrapAddress); VoidPtr SysGetTrapAddress(UInt trapNum) SYS_TRAP(sysTrapSysGetTrapAddress); Word SysDisableInts(void) SYS_TRAP(sysTrapSysDisableInts); void SysRestoreStatus(Word status) SYS_TRAP(sysTrapSysRestoreStatus); extern CharPtr SysGetOSVersionString() SYS_TRAP(sysTrapSysGetOSVersionString); // The following trap is a public definition of HwrGetROMToken from // See token definitions (like sysROMTokenSerial) above... Err SysGetROMToken(Word cardNo, DWord token, BytePtr *dataP, WordPtr sizeP ) SYS_TRAP(sysTrapHwrGetROMToken); // Library Management Err SysLibInstall(SysLibEntryProcPtr libraryP, UIntPtr refNumP) SYS_TRAP(sysTrapSysLibInstall); Err SysLibLoad(DWord libType, DWord libCreator, UIntPtr refNumP) SYS_TRAP(sysTrapSysLibLoad); Err SysLibRemove(UInt refNum) SYS_TRAP(sysTrapSysLibRemove); Err SysLibFind(CharPtr nameP, UIntPtr refNumP) SYS_TRAP(sysTrapSysLibFind); SysLibTblEntryPtr SysLibTblEntry(UInt refNum) SYS_TRAP(sysTrapSysLibTblEntry); // Generic Library calls Err SysLibOpen(UInt refNum) SYS_TRAP(sysLibTrapOpen); Err SysLibClose(UInt refNum) SYS_TRAP(sysLibTrapClose); Err SysLibSleep(UInt refNum) SYS_TRAP(sysLibTrapSleep); Err SysLibWake(UInt refNum) SYS_TRAP(sysLibTrapWake); //----------------------------------------------------- // Kernel Prototypes //----------------------------------------------------- // Task Creation and deleation Err SysTranslateKernelErr(Err err) SYS_TRAP(sysTrapSysTranslateKernelErr); Err SysTaskCreate(DWordPtr taskIDP, DWordPtr creator, ProcPtr codeP, Ptr stackP, DWord stackSize, DWord attr, DWord priority, DWord tSlice) SYS_TRAP(sysTrapSysTaskCreate); Err SysTaskDelete(DWord taskID, DWord priority) SYS_TRAP(sysTrapSysTaskDelete); Err SysTaskTrigger(DWord taskID) SYS_TRAP(sysTrapSysTaskTrigger); ULong SysTaskID() SYS_TRAP(sysTrapSysTaskID); Err SysTaskDelay(SDWord delay) SYS_TRAP(sysTrapSysTaskDelay); Err SysTaskSetTermProc(DWord taskID, SysTermProcPtr termProcP) SYS_TRAP(sysTrapSysTaskSetTermProc); Err SysTaskSwitching(Boolean enable) SYS_TRAP(sysTrapSysTaskSwitching); Err SysTaskWait(SDWord timeout) SYS_TRAP(sysTrapSysTaskWait); Err SysTaskWake(DWord taskID) SYS_TRAP(sysTrapSysTaskWake); Err SysTaskWaitClr(void) SYS_TRAP(sysTrapSysTaskWaitClr); Err SysTaskSuspend(DWord taskID) SYS_TRAP(sysTrapSysTaskSuspend); Err SysTaskResume(DWord taskID) SYS_TRAP(sysTrapSysTaskResume); // Counting Semaphores Err SysSemaphoreCreate(DWordPtr smIDP, DWordPtr tagP, SDWord initValue) SYS_TRAP(sysTrapSysSemaphoreCreate); Err SysSemaphoreDelete(DWord smID) SYS_TRAP(sysTrapSysSemaphoreDelete); Err SysSemaphoreWait(DWord smID, DWord priority, SDWord timeout) SYS_TRAP(sysTrapSysSemaphoreWait); Err SysSemaphoreSignal(DWord smID) SYS_TRAP(sysTrapSysSemaphoreSignal); Err SysSemaphoreSet(DWord smID) SYS_TRAP(sysTrapSysSemaphoreSet); // Resource Semaphores Err SysResSemaphoreCreate(DWordPtr smIDP, DWordPtr tagP) SYS_TRAP(sysTrapSysResSemaphoreCreate); Err SysResSemaphoreDelete(DWord smID) SYS_TRAP(sysTrapSysResSemaphoreDelete); Err SysResSemaphoreReserve(DWord smID, DWord priority, SDWord timeout) SYS_TRAP(sysTrapSysResSemaphoreReserve); Err SysResSemaphoreRelease(DWord smID) SYS_TRAP(sysTrapSysResSemaphoreRelease); // Timers Err SysTimerCreate(DWordPtr timerIDP, DWordPtr tagP, SysTimerProcPtr timerProc, DWord periodicDelay, DWord param) SYS_TRAP(sysTrapSysTimerCreate); Err SysTimerDelete(DWord timerID) SYS_TRAP(sysTrapSysTimerDelete); Err SysTimerWrite(DWord timerID, DWord value) SYS_TRAP(sysTrapSysTimerWrite); Err SysTimerRead(DWord timerID, DWordPtr valueP) SYS_TRAP(sysTrapSysTimerRead); // Information Err SysKernelInfo(VoidPtr paramP) SYS_TRAP(sysTrapSysKernelInfo); Boolean SysCreateDataBaseList(ULong type, ULong creator, WordPtr dbCount, Handle *dbIDs, Boolean lookupName) SYS_TRAP(sysTrapSysCreateDataBaseList); Boolean SysCreatePanelList(WordPtr panelCount, Handle *panelIDs) SYS_TRAP(sysTrapSysCreatePanelList); UInt SysBatteryInfo(Boolean set, UIntPtr warnThresholdP, UIntPtr criticalThresholdP, UIntPtr maxTicksP, SysBatteryKind* kindP, Boolean* pluggedIn, BytePtr percentP) SYS_TRAP(sysTrapSysBatteryInfo); UInt SysBatteryInfoV20(Boolean set, UIntPtr warnThresholdP, UIntPtr criticalThresholdP, UIntPtr maxTicksP, SysBatteryKind* kindP, Boolean* pluggedIn) SYS_TRAP(sysTrapSysBatteryInfoV20); Boolean SysGetStackInfo(Ptr *startPP, Ptr *endPP) SYS_TRAP(sysTrapSysGetStackInfo); // Mailboxes Err SysMailboxCreate(DWordPtr mbIDP, DWordPtr tagP, DWord depth) SYS_TRAP(sysTrapSysMailboxCreate); Err SysMailboxDelete(DWord mbID) SYS_TRAP(sysTrapSysMailboxDelete); Err SysMailboxFlush(DWord mbID) SYS_TRAP(sysTrapSysMailboxFlush); Err SysMailboxSend(DWord mbID, VoidPtr msgP, DWord wAck) SYS_TRAP(sysTrapSysMailboxSend); Err SysMailboxWait(DWord mbID, VoidPtr msgP, DWord priority, SDWord timeout) SYS_TRAP(sysTrapSysMailboxWait); // Event Groups Err SysEvGroupCreate(DWordPtr evIDP, DWordPtr tagP, DWord init) SYS_TRAP(sysTrapSysEvGroupCreate); //Err SysEvGroupDelete(DWord evID) // save trap table space - don't need //SYS_TRAP(sysTrapSysEvGroupDelete); Err SysEvGroupSignal(DWord evID, DWord mask, DWord value, SDWord type) SYS_TRAP(sysTrapSysEvGroupSignal); Err SysEvGroupRead(DWord evID, DWordPtr valueP) SYS_TRAP(sysTrapSysEvGroupRead); Err SysEvGroupWait(DWord evID, DWord mask, DWord value, SDWord matchType, SDWord timeout) SYS_TRAP(sysTrapSysEvGroupWait); #ifdef __cplusplus } #endif /************************************************************ * Assembly Function Prototypes *************************************************************/ #define _SysSemaphoreSignal \ ASM_SYS_TRAP(sysTrapSysSemaphoreSignal) #define _SysSemaphoreSet \ ASM_SYS_TRAP(sysTrapSysSemaphoreSet) #define _SysDoze \ ASM_SYS_TRAP(sysTrapSysDoze) #endif //__SYSTEMMGR_H__