1 /*---------------------------------------------------------------------------* 2 Project: OS Message API 3 File: OSMessage.h 4 5 Copyright 1998-2011 Nintendo. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 *---------------------------------------------------------------------------*/ 14 15 #ifndef __OSMESSAGE_H__ 16 #define __OSMESSAGE_H__ 17 18 #define OSMESSAGEQ_TXT_TAG 0x6D536751 19 20 #ifdef __cplusplus 21 extern "C" { 22 #endif 23 24 #include <cafe/os/OSThread.h> 25 26 typedef struct OSMessageQueue OSMessageQueue; 27 28 typedef struct OSMessage OSMessage; 29 struct OSMessage 30 { 31 void* message; 32 u32 data0; 33 u32 data1; 34 u32 data2; 35 }; 36 37 struct OSMessageQueue 38 { 39 u32 txtTag; // 'mSgQ' 0x6D536751 40 char * name; // debug name or NULL 41 u32 os_reserved1; 42 43 OSThreadQueue queueSend; 44 OSThreadQueue queueReceive; 45 OSMessage* msgArray; 46 s32 msgCount; 47 s32 firstIndex; 48 s32 usedCount; 49 }; 50 51 // Flags to turn blocking on/off when sending/receiving message 52 #define OS_MESSAGE_NOBLOCK (0) 53 #define OS_MESSAGE_BLOCK (0x00000001) 54 #define OS_MESSAGE_HIGH_PRIORITY (0x00000002) 55 56 void OSInitMessageQueue( OSMessageQueue* mq, OSMessage* msgArray, s32 msgCount ); 57 void OSInitMessageQueueEx( OSMessageQueue* mq, OSMessage* msgArray, s32 msgCount, char * name ); 58 59 BOOL OSSendMessage( OSMessageQueue* mq, OSMessage* msg, s32 flags ); 60 BOOL OSReceiveMessage( OSMessageQueue* mq, OSMessage* msg, s32 flags ); 61 BOOL OSPeekMessage( OSMessageQueue* mq, OSMessage* msg); 62 63 #define OSJamMessage(__os_message_queue, __os_message, __os_message_flags) \ 64 OSSendMessage((__os_message_queue), \ 65 (__os_message), \ 66 (__os_message_flags) | OS_MESSAGE_HIGH_PRIORITY) 67 68 OSMessageQueue * OSGetSystemMessageQueue(void); 69 70 #define OS_SYSTEM_MESSAGE_DATA0_RELEASE_FOREGROUND 0xFACEBACC 71 #define OS_SYSTEM_MESSAGE_DATA0_ACQUIRED_FOREGROUND 0xFACEF000 72 #define OS_SYSTEM_MESSAGE_DATA0_EXIT 0xD1E0D1E0 73 #define OS_SYSTEM_MESSAGE_DATA0_NETIO_CHANGE 0xAAC0FFEE 74 #define OS_SYSTEM_MESSAGE_DATA0_HOMEBUTTON_DENIED 0xCCC0FFEE 75 #define OS_SYSTEM_MESSAGE_DATA0_ROOT_RECYCLE 0xAAFECAAA 76 77 #define OS_SYSTEM_MESSAGE_DATA1_RELEASE_FOREGROUND_SHUTDOWN_FLAG 1 78 79 #ifdef __cplusplus 80 } 81 #endif 82 83 #endif // __OSMESSAGE_H__ 84 85