commsfwtools/commstools/utracedecoder/data/nodemessages.definition.txt
changeset 0 dfb7c4ff071f
child 18 9644881fedd0
equal deleted inserted replaced
-1:000000000000 0:dfb7c4ff071f
       
     1 //
       
     2 // Node Messages basic message and message signature definitions
       
     3 //
       
     4 
       
     5 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       
     6 // Define ENUM TStateChangeStage before including this file
       
     7 // Define ENUM ActivityId before including this file
       
     8 // !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
       
     9 
       
    10 ENUM DECIMAL TErrorCode : INT32
       
    11     KErrNone = 0
       
    12     KErrNotFound = -1
       
    13     KErrGeneral = -2
       
    14     KErrCancel = -3
       
    15     KErrNoMemory = -4
       
    16     KErrNotSupported = -5
       
    17     KErrArgument = -6
       
    18     KErrTotalLossOfPrecision = -7
       
    19     KErrBadHandle = -8
       
    20     KErrOverflow = -9
       
    21     KErrUnderflow = -10
       
    22     KErrAlreadyExists = -11
       
    23     KErrPathNotFound = -12
       
    24     KErrDied = -13
       
    25     KErrInUse = -14
       
    26     KErrServerTerminated = -15
       
    27     KErrServerBusy = -16
       
    28     KErrCompletion = -17
       
    29     KErrNotReady = -18
       
    30     KErrUnknown = -19
       
    31     KErrCorrupt = -20
       
    32     KErrAccessDenied = -21
       
    33     KErrLocked = -22
       
    34     KErrWrite = -23
       
    35     KErrDisMounted = -24
       
    36     KErrEof = -25
       
    37     KErrDiskFull = -26
       
    38     KErrBadDriver = -27
       
    39     KErrBadName = -28
       
    40     KErrCommsLineFail = -29
       
    41     KErrCommsFrame = -30
       
    42     KErrCommsOverrun = -31
       
    43     KErrCommsParity = -32
       
    44     KErrTimedOut = -33
       
    45     KErrCouldNotConnect = -34
       
    46     KErrCouldNotDisconnect = -35
       
    47     KErrDisconnected = -36
       
    48     KErrBadLibraryEntryPoint = -37
       
    49     KErrBadDescriptor = -38
       
    50     KErrAbort = -39
       
    51     KErrTooBig = -40
       
    52     KErrDivideByZero = -41
       
    53     KErrBadPower = -42
       
    54     KErrDirFull = -43
       
    55     KErrHardwareNotAvailable = -44
       
    56     KErrSessionClosed = -45
       
    57     KErrPermissionDenied = -46
       
    58     KErrExtensionNotSupported = -47
       
    59     KErrCommsBreak = -48
       
    60     KErrNoSecureTime = -49
       
    61 END ENUM
       
    62 
       
    63 CONST KNodeMessagesImplementationUid = 0x10285F38
       
    64 
       
    65 ENUM NM_SignatureId : UINT32
       
    66     ESignalBase                          =0
       
    67     ENodeSignal                          =1
       
    68     ESignatureBase                       =2
       
    69     ESignatureNumber                     =3
       
    70     ESignatureUid                        =4
       
    71     ESignatureErrContext                 =5
       
    72     ESignatureErrResponse                =6
       
    73 	
       
    74     ESignatureNodeId                     =8
       
    75     ESignatureNodeIdNumber               =9
       
    76     ESignatureNodeIdNumberNumber         =10
       
    77     ESignatureMessageIdNumber            =11
       
    78     ESignatureAnyNumber                  =12
       
    79     ESignatureMetaDataPtr                =13
       
    80     ESignatureNumberNumberNumber         =14
       
    81     ESignatureRMessage2                  =15
       
    82     ESignatureNumberRMessage2            =16
       
    83     ESignatureAny                        =17
       
    84     ESignatureNumberNumber               =18
       
    85     ESignatureNodeIdAny                  =19
       
    86     ESignatureNodeIdNodeId               =20
       
    87     ESignatureNodeIdNodeIdNumber         =21
       
    88     ESignatureNumberNumberNumberNumber   =22
       
    89     ESignatureUidNumber                  =23
       
    90     ESignatureNumberUidNumber            =24
       
    91     ESignatureNodeIdClientType           =25
       
    92     ESignatureClientTypeUidClientType    =26
       
    93     ESignatureClientType                 =27
       
    94     ESignatureClientTypeUid              =28
       
    95     ESignatureMessageId                  =29
       
    96     ESignatureNodeIdNumberNumberNumber   =30
       
    97     ESignatureTypeId                     =31
       
    98 END ENUM
       
    99 	
       
   100 ENUM TRespAction : UINT32
       
   101     EIgnore = 0
       
   102     EPropagate = 1
       
   103     ERetry = 2
       
   104 END ENUM
       
   105 
       
   106 
       
   107 CONTEXT Context_RuntimeCtxId
       
   108 //    UINT8 iSize
       
   109 //    UINT8 iSalt
       
   110 //    UINT16 iThread
       
   111 //    UINT32 iScope
       
   112       PAD 8
       
   113 END CONTEXT
       
   114 
       
   115 
       
   116 CONTEXT Context_NodeId : Context_RuntimeCtxId 
       
   117     UINT32 iPtr
       
   118 END CONTEXT
       
   119 
       
   120 
       
   121 CONTEXT Context_NodeCtxId : Context_NodeId 
       
   122     ActivityId iNodeCtx		// low byte of activity id
       
   123     PAD 1			// high byte of activity id
       
   124     PAD 2 // 2-byte padding
       
   125 END CONTEXT
       
   126 
       
   127 ALIAS CONTEXT TCommsId = Context_NodeId
       
   128 
       
   129 STRUCT STypeId
       
   130     UINT32 iUid
       
   131     UINT32 iTypeId
       
   132 END STRUCT
       
   133 
       
   134 // h_structures.h
       
   135 STRUCT TStateChange
       
   136     TStateChangeStage iStage
       
   137     TErrorCode iError    
       
   138 END STRUCT
       
   139 
       
   140 // nm_errorrecovery.h
       
   141 STRUCT TErrContext
       
   142     TCommsId iOriginator
       
   143     UINT32 iActivitySigId
       
   144     TMessageId iMessageId
       
   145     TStateChange iStateChange
       
   146     PAD 4 // UINT32 iInfo
       
   147 END STRUCT
       
   148 
       
   149 // nm_errorrecovery.h
       
   150 STRUCT TErrResponse
       
   151     TRespAction iAction
       
   152     TErrorCode iError    
       
   153     TMessageId iMessageId  
       
   154 END STRUCT
       
   155 
       
   156 // e32cmn.h
       
   157 STRUCT RMessage2
       
   158     UINT32 iHandle // From RMessagePtr2
       
   159     INT32 iFunction
       
   160     INT32 iArgs1
       
   161     INT32 iArgs2
       
   162     INT32 iArgs3
       
   163     INT32 iArgs4
       
   164     INT32 iSpare
       
   165     UINT32 iSessionPtr
       
   166     INT32 iFlags
       
   167     INT32 iSpare3
       
   168 END STRUCT
       
   169 
       
   170 // nm_interfaces.h
       
   171 STRUCT TClientType
       
   172     UINT32 iClientType
       
   173     UINT32 iClientFlags
       
   174 END STRUCT
       
   175 
       
   176 // nm_interfaces.h
       
   177 STRUCT RClientInterface
       
   178     UINT32 iSender
       
   179     PAD 20
       
   180 END STRUCT
       
   181 
       
   182 // nm_interfaces.h
       
   183 STRUCT RNodeInterface
       
   184     RClientInterface iBase
       
   185     TClientType iClientType
       
   186 END STRUCT
       
   187 
       
   188 
       
   189 SIGNATURE TSignalBase
       
   190     TYPEID = KNodeMessagesImplementationUid:ESignalBase
       
   191 END SIGNATURE
       
   192 
       
   193 SIGNATURE TNodeSignal : TSignalBase
       
   194     TYPEID = KNodeMessagesImplementationUid:ENodeSignal
       
   195     TMessageId iMessageId
       
   196 END SIGNATURE
       
   197 
       
   198 // Synonymous with TSigVoid
       
   199 SIGNATURE TSignatureBase : TNodeSignal
       
   200     TYPEID = KNodeMessagesImplementationUid:ESignatureBase
       
   201 END SIGNATURE
       
   202 
       
   203 SIGNATURE TSigErrContext : TSignatureBase
       
   204     TYPEID = KNodeMessagesImplementationUid:ESignatureErrContext
       
   205     TErrContext iErrContext
       
   206 END SIGNATURE 
       
   207 
       
   208 SIGNATURE TSigErrResponse : TSignatureBase
       
   209     TYPEID = KNodeMessagesImplementationUid:ESignatureErrResponse
       
   210     TErrResponse iErrResponse
       
   211 END SIGNATURE 
       
   212 
       
   213 SIGNATURE TSigNumber : TSignatureBase
       
   214     TYPEID = KNodeMessagesImplementationUid:ESignatureNumber
       
   215     UINT32 iValue
       
   216 END SIGNATURE 
       
   217 
       
   218 SIGNATURE TSigUid : TSignatureBase
       
   219     TYPEID = KNodeMessagesImplementationUid:ESignatureUid
       
   220     UINT32 iUid
       
   221 END SIGNATURE 
       
   222 
       
   223 SIGNATURE TSigNodeId : TSignatureBase
       
   224     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeId
       
   225     TCommsId iNodeId
       
   226 END SIGNATURE 
       
   227 
       
   228 SIGNATURE TSigNodeIdNumber : TSignatureBase
       
   229     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdNumber
       
   230     TCommsId iNodeId
       
   231     UINT32 iValue
       
   232 END SIGNATURE 
       
   233 
       
   234 SIGNATURE TSigNodeIdNumberNumber : TSignatureBase
       
   235     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdNumberNumber
       
   236     TCommsId iNodeId
       
   237     UINT32 iValue1
       
   238     UINT32 iValue2
       
   239 END SIGNATURE 
       
   240 
       
   241 SIGNATURE TSigNodeIdNumberNumberNumber : TSignatureBase
       
   242     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdNumberNumberNumber
       
   243     TCommsId iNodeId
       
   244     UINT32 iValue1
       
   245     UINT32 iValue2
       
   246     UINT32 iValue3
       
   247 END SIGNATURE 
       
   248 
       
   249 SIGNATURE TSigTypeId : TSignatureBase
       
   250     TYPEID = KNodeMessagesImplementationUid:ESignatureTypeId
       
   251     STypeId iTypeId
       
   252 END SIGNATURE
       
   253 
       
   254 SIGNATURE TSigMessageIdNumber : TSignatureBase
       
   255     TYPEID = KNodeMessagesImplementationUid:ESignatureMessageIdNumber
       
   256     TMessageId iMsgId
       
   257     UINT32 iValue
       
   258 END SIGNATURE 
       
   259 
       
   260 SIGNATURE TSigNumberNumber : TSignatureBase
       
   261     TYPEID = KNodeMessagesImplementationUid:ESignatureNumberNumber
       
   262     UINT32 iValue1
       
   263     UINT32 iValue2
       
   264 END SIGNATURE 
       
   265 
       
   266 SIGNATURE TSigNumberNumberNumber : TSignatureBase
       
   267     TYPEID = KNodeMessagesImplementationUid:ESignatureNumberNumberNumber
       
   268     UINT32 iValue1
       
   269     UINT32 iValue2
       
   270     UINT32 iValue3
       
   271 END SIGNATURE 
       
   272 
       
   273 SIGNATURE TSigNumberNumberNumberNumber : TSignatureBase
       
   274     TYPEID = KNodeMessagesImplementationUid:ESignatureNumberNumberNumberNumber
       
   275     UINT32 iValue1
       
   276     UINT32 iValue2
       
   277     UINT32 iValue3
       
   278     UINT32 iValue4
       
   279 END SIGNATURE 
       
   280 
       
   281 SIGNATURE TSigNodeIdNodeIdNumber : TSignatureBase
       
   282     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdNodeIdNumber
       
   283     TCommsId iNodeId1
       
   284     TCommsId iNodeId2
       
   285     UINT32 iValue
       
   286 END SIGNATURE 
       
   287 
       
   288 SIGNATURE TSigMetaDataPtr : TSignatureBase
       
   289     TYPEID = KNodeMessagesImplementationUid:ESignatureMetaDataPtr
       
   290     UINT32 iPtr
       
   291 END SIGNATURE 
       
   292 
       
   293 SIGNATURE TSigRMessage2 : TSignatureBase
       
   294     TYPEID = KNodeMessagesImplementationUid:ESignatureMetaDataPtr
       
   295     RMessage2 iMessage
       
   296 END SIGNATURE 
       
   297 
       
   298 SIGNATURE TSigNumberRMessage2 : TSignatureBase
       
   299     TYPEID = KNodeMessagesImplementationUid:ESignatureNumberRMessage2
       
   300     UINT32 iValue
       
   301     RMessage2 iMessage
       
   302 END SIGNATURE 
       
   303 
       
   304 SIGNATURE TSigAny : TSignatureBase
       
   305     TYPEID = KNodeMessagesImplementationUid:ESignatureAny
       
   306     UINT32 iPtr
       
   307 END SIGNATURE 
       
   308 
       
   309 SIGNATURE TSigAnyNumber : TSignatureBase
       
   310     TYPEID = KNodeMessagesImplementationUid:ESignatureAnyNumber
       
   311     UINT32 iPtr
       
   312     UINT32 iValue
       
   313 END SIGNATURE
       
   314 
       
   315 SIGNATURE TSigNodeIdAny : TSignatureBase
       
   316     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdAny
       
   317     TCommsId iNodeId
       
   318     UINT32 iPtr
       
   319 END SIGNATURE
       
   320 
       
   321 SIGNATURE TSigNodeIdNodeId : TSignatureBase
       
   322     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdNodeId
       
   323     TCommsId iNodeId1
       
   324     TCommsId iNodeId2
       
   325 END SIGNATURE
       
   326 
       
   327 SIGNATURE TSigNodeIdClientType : TSignatureBase
       
   328     TYPEID = KNodeMessagesImplementationUid:ESignatureNodeIdClientType
       
   329     TCommsId iNodeId
       
   330     TClientType iClientType
       
   331 END SIGNATURE
       
   332 
       
   333 SIGNATURE TSigClientType : TSignatureBase
       
   334     TYPEID = KNodeMessagesImplementationUid:ESignatureClientType
       
   335     TClientType iClientType
       
   336 END SIGNATURE 
       
   337 
       
   338 
       
   339 ALIAS SIGNATURE TSigVoid = TSignatureBase
       
   340 ALIAS SIGNATURE TSigNumberDefaultNumberDefault = TSigNumberNumber
       
   341 ALIAS SIGNATURE TSigNodeIdNumberDefault = TSigNodeIdNumber
       
   342 ALIAS SIGNATURE TSigNumberDefault = TSigNumber
       
   343 ALIAS SIGNATURE TMessageExtensionRMessage2 = TSigNumberRMessage2
       
   344 ALIAS SIGNATURE TSigAnyNumberDefault = TSigAnyNumber
       
   345 
       
   346 
       
   347 // nm_messages_base.h
       
   348 CONST KBaseRealmId = 0x10285F38
       
   349 
       
   350 ENUM Base_MessageId : UINT16
       
   351     ENull                         = 1
       
   352     ECancel                       = 2
       
   353     EError                        = 3
       
   354 END ENUM
       
   355 
       
   356 MESSAGE Null
       
   357     SIGNATURE = TSignatureBase
       
   358     MESSAGEID = KBaseRealmId:ENull
       
   359 END MESSAGE
       
   360 
       
   361 MESSAGE Cancel
       
   362     SIGNATURE = TSignatureBase
       
   363     MESSAGEID = KBaseRealmId:ECancel
       
   364 END MESSAGE
       
   365 
       
   366 MESSAGE Error
       
   367     SIGNATURE = TSigMessageIdNumber
       
   368     MESSAGEID = KBaseRealmId:EError
       
   369 END MESSAGE
       
   370 
       
   371 // nm_messages_error_recovery.h
       
   372 CONST KErrRecRealmId = 0x10285F3A
       
   373 ENUM ErrRec_MessageId : UINT16
       
   374      EErrorRecoveryRequest         = 1
       
   375      EErrorRecoveryResponse        = 2
       
   376 END ENUM
       
   377 
       
   378 MESSAGE ErrorRecoveryRequest
       
   379     SIGNATURE = TSigErrContext
       
   380     MESSAGEID = KErrRecRealmId:EErrorRecoveryRequest
       
   381 END MESSAGE
       
   382 
       
   383 MESSAGE ErrorRecoveryResponse
       
   384     SIGNATURE = TSigErrResponse
       
   385     MESSAGEID = KErrRecRealmId:EErrorRecoveryResponse
       
   386 END MESSAGE
       
   387 
       
   388 // nm_messages_child.h
       
   389 CONST KChildRealmId = 0x10285F39
       
   390 
       
   391 ENUM Child_MessageId : UINT16
       
   392 	EDestroy		= 1
       
   393 	ELeft			= 2
       
   394 END ENUM
       
   395 
       
   396 MESSAGE Destroy
       
   397     SIGNATURE = TSignatureBase
       
   398     MESSAGEID = KChildRealmId:EDestroy
       
   399 END MESSAGE
       
   400 
       
   401 MESSAGE Left
       
   402     SIGNATURE = TSignatureBase
       
   403     MESSAGEID = KChildRealmId:ELeft
       
   404 END MESSAGE
       
   405 
       
   406 
       
   407 
       
   408 // nm_messages_parent.h
       
   409 CONST KParentRealmId = 0x10285F3B
       
   410 ENUM Parent_MessageId : UINT16
       
   411      	EDataClientIdle               = 1
       
   412 	EDataClientActive             = 2
       
   413 END ENUM
       
   414 
       
   415 MESSAGE DataClientIdle
       
   416     SIGNATURE = TSignatureBase
       
   417     MESSAGEID = KParentRealmId:EDataClientIdle
       
   418 END MESSAGE
       
   419 
       
   420 MESSAGE DataClientActive
       
   421     SIGNATURE = TSignatureBase
       
   422     MESSAGEID = KParentRealmId:EDataClientActive
       
   423 END MESSAGE
       
   424 
       
   425 //MESSAGE Joined
       
   426 //    SIGNATURE = TSigNodeIdNumber
       
   427 //    MESSAGEID = KParentRealmId:EJoined
       
   428 //END MESSAGE
       
   429 
       
   430 // nm_messages_peer.h
       
   431 CONST KPeerRealmId = 0x10285F3C
       
   432 
       
   433 ENUM Peer_MessageId : UINT16 
       
   434 	ELeaveRequest			= 1
       
   435 	ELeaveComplete			= 2
       
   436 //	EJoinRequest			= 3
       
   437 //	EJoinComplete			= 4
       
   438 END ENUM
       
   439 
       
   440 MESSAGE LeaveRequest
       
   441     SIGNATURE = TSignatureBase
       
   442     MESSAGEID = KPeerRealmId:ELeaveRequest
       
   443 END MESSAGE
       
   444 
       
   445 MESSAGE LeaveComplete
       
   446     SIGNATURE = TSignatureBase
       
   447     MESSAGEID = KPeerRealmId:ELeaveComplete
       
   448 END MESSAGE
       
   449 
       
   450 //MESSAGE JoinRequest
       
   451 //    SIGNATURE = TSigNodeIdClientType
       
   452 //    MESSAGEID = KPeerRealmId:EJoinRequest
       
   453 //END MESSAGE
       
   454 
       
   455 
       
   456