1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 

    17 #ifndef COMMIPC_H

    18 #define COMMIPC_H

    19 

    20 /** 

    21 @file

    22  

    23 Defines the IPC numbers used for C32 Client/Server communications

    24 @internalAll

    25 */

    26 

    27 /**

    28 unique numbers used for message passing between

    29 client and C32 comms server.

    30 @internalAll

    31 */

    32 enum TCommMess

    33 {

    34 	ECommLoadCommModule,            //< 0 Load a CSY comms module

    35 	ECommCloseCommModule,           //< 1 Unload a CSY comms module

    36 	ECommPortInfo,

    37 	ECommPortInfoByName,            //< 3 Get information on serial ports by name

    38 	ECommPortInfoByNumber,          //< 4 Get information on serial ports by number

    39 	ECommNumPorts,                  //< 5 Get how many CSY's are loaded

    40 	ECommStartServerThread,         //< 6 Start another thread in the C32 process

    41 	ECommOpen,                      //< 7 Open a comm port

    42 	ECommRead,                      //< 8 Read from the comm port

    43 	ECommReadCancel,                //< 9 Cancel an outstanding read

    44 	ECommQueryReceiveBuffer,        //< 10 Get number of bytes in received buffer

    45 

    46 	ECommResetBuffers,              //< 11 Reset the serial port buffers

    47 	ECommWrite,                     //< 12 Write to the comm port

    48 	ECommWriteCancel,               //< 13 Cancel an outstanding write

    49 	ECommBreak,                     //< 14 Send a break

    50 	ECommBreakCancel,               //< 15 Cancel sending of break

    51 	ECommCancel,                    //< 16 Cancel any outstanding reads or writes

    52 	ECommConfig,                    //< 17 Get comm port configuration

    53 	ECommSetConfig,                 //< 18 Set comm port configuration

    54 	ECommCaps,                      //< 19 Get the capabilities of the comm port

    55 	ECommSetMode,                   //< 20 Set server buffering mode

    56 

    57 	ECommGetMode,                   //< 21 Get server buffering mode

    58 	ECommSignals,                   //< 22 Read serial port control lines

    59 	ECommSetSignalsToMark,          //< 23 Set control lines high (1)

    60 	ECommSetSignalsToSpace,         //< 24 Set control line low (0)

    61 	ECommReceiveBufferLength,       //< 25 Get the size of the receive buffer

    62 	ECommSetReceiveBufferLength,    //< 26 Set the size of the receive buffer

    63 	ECommClose,                     //< 27 Close the comm port

    64 	ECommDbgMarkHeap,               //< 28 Set a heap mark in the Comms server

    65 	ECommDbgCheckHeap,              //< 29 Check the heap mark in the Comms server

    66 	ECommDbgMarkEnd,                //< 30 Set the heap mark end in the Comms server

    67 

    68 	ECommDbgFailNext,               //< 31 Emulate fail next heap allocation in the comm server

    69 	ECommDbgSetDebugPrintMask,      //< 32 Set the debug print mask

    70 	ECommDbgDoDumpDebugInfo,        //< 33 Dump debug info

    71 

    72 	// Here starts version 02 extensions

    73 	ECommGetRole,                   //< 34 Get the current role

    74 	ECommNotifySignals,             //< 35 Notify when signals change

    75 	ECommNotifySignalsCancel,       //< 36 Cancel an outstanding signals notify

    76 	ECommNotifyFlowControl,         //< 37 Notify when flow control changes

    77 	ECommNotifyFlowControlCancel,   //< 38 Cancel an outstanding flow control notify

    78 	ECommGetFlowControl,            //< 39 Get the current status of flow control

    79 	ECommNotifyConfigChange,        //< 40 Notify when config change

    80 

    81 	ECommNotifyConfigChangeCancel,  //< 41 Cancel an outstanding config notify

    82 	ECommNotifyBreak,               //< 42 Send break

    83 	ECommNotifyBreakCancel,	        //< 43 Cancel an outstanding sending of break

    84 	ECommNotifyDataAvailable,       //< 44 Notify when data available in Rx buffer

    85 	ECommNotifyDataAvailableCancel, //< 45 Cancel an outstanding notify data available

    86 	ECommNotifyOutputEmpty,         //< 46 Notify when Tx buffer is empty

    87 	ECommNotifyOutputEmptyCancel,   //< 47 Cancel an outstanding output empty notify

    88 	// Here ends version 02 extensions

    89 

    90 	ECommSetAccess,                 //< 48 Set the access mode defined by TCommAccess

    91 	ECommDebugState,                //< 49 Get the debug state

    92 	ECommOpenWhenAvailable,         //< 50 Open port when it is available

    93 	ECommOpenWhenAvailableCancel    //< 51 Cancel open port when it is available

    94 	};

    95 

    96 #endif // COMMIPC_H