usbmgmt/usbmgr/device/classdrivers/acm/classimplementation/ecacm/public/AcmInterface.h
changeset 0 c9bc50fca66e
equal deleted inserted replaced
-1:000000000000 0:c9bc50fca66e
       
     1 /*
       
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __ACMINTERFACE_H__
       
    19 #define __ACMINTERFACE_H__
       
    20 
       
    21 /** @file
       
    22 Public interface to ECACM CSY.
       
    23 @publishedPartner
       
    24 @released
       
    25 */
       
    26 
       
    27 #include <e32std.h>
       
    28 
       
    29 /**
       
    30 The root of the CSY filename. Use this in LoadCommModule.
       
    31 */
       
    32 _LIT(KAcmCsyName, "ECACM"); 
       
    33 
       
    34 /**
       
    35 The name of the CSerial, and consequently the root of the ACM port name 
       
    36 ACM::0. Use this in Open (and UnloadCommModule, if you're not closing your 
       
    37 session anyway).
       
    38 */
       
    39 _LIT(KAcmSerialName, "ACM"); 
       
    40 
       
    41 /**
       
    42 Lowest valid value of %d in calls to Open(_L("ACM::%d")).
       
    43 For the highest valid value of %d in calls to Open(_L("ACM::%d")), use RCommServ::GetPortInfo.
       
    44 Note that if USB services are stopped/idle (see RUsb::GetServiceState) the high unit value will 
       
    45 be incorrect. Under these circumstances, no ACM ports are may be opened, but TSerialInfo cannot
       
    46 express this.
       
    47 When USB services are starting/started/stopping, the given high unit will accurately reflect 
       
    48 the highest available port number. Note that this numerical value will depend on the current 
       
    49 USB personality (see RUsb) and also potentially whether USB is fully started or in a transitional
       
    50 state (starting or stopping).
       
    51 */
       
    52 const TUint KAcmLowUnit = 0;
       
    53 
       
    54 /**
       
    55 @deprecated RCommServ::GetPortInfo is the preferred method for determining the number of available ports.
       
    56 @see RCommServ::GetPortInfo
       
    57 */	
       
    58 const TUint KAcmHighUnit = 0; 
       
    59 
       
    60 #endif // __ACMINTERFACE_H__