epoc32/include/usbman.rh
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/usbman.rh	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,133 @@
     1.4 +/*
     1.5 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Resource header for usbman configuration.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +/**
    1.23 + @file
    1.24 + @publishedPartner
    1.25 + @released
    1.26 +*/
    1.27 +
    1.28 +STRUCT usb_configuration
    1.29 +	{
    1.30 +	/** 
    1.31 +		vendorId is the 16-bit number that is assigned by USB-ORG.
    1.32 +	 */
    1.33 +	WORD	vendorId		= 0x0e22;
    1.34 +
    1.35 +	/** 
    1.36 +		productId is a 16-bit number that is assigned by the licensee to 
    1.37 +		uniquely identify this particular type of device.
    1.38 +	 */
    1.39 +	WORD	productId		= 0x000b;
    1.40 +
    1.41 +	/** 
    1.42 +		bcdDevice may be optionally used during enumeration, this depends on 
    1.43 +		the licensee's policy regarding device upgrades (new versions of a 
    1.44 +		device may require to use new host driver files)
    1.45 +	 */
    1.46 +	WORD	bcdDevice		= 0x0000;
    1.47 +
    1.48 +	/** 
    1.49 +		manufacturerString is displayed on the Windows screen during first 
    1.50 +		enumeration of the device, and should identify the same company that 
    1.51 +		owns the USB vendorId given above
    1.52 +	 */
    1.53 +	LTEXT	manufacturer	= "Symbian Ltd.";
    1.54 +
    1.55 +	/** 
    1.56 +		productString is displayed on the Windows screen during first 
    1.57 +		enumeration of the device, and should identify the same device that is 
    1.58 +		implied by the productId given above
    1.59 +	 */
    1.60 +	LTEXT	product			= "Symbian OS";
    1.61 +	}
    1.62 +
    1.63 +STRUCT PERSONALITY
    1.64 +	{
    1.65 +	/** 	Class code (assigned by the USB-IF). If this field is set to zero, each interface within 
    1.66 +		a configuration specifies its own class information and the various interfaces operate independently. 
    1.67 +
    1.68 +		If this field is set to a value between 1 and FEH, the device supports different class
    1.69 +		specifications on different interfaces and the interfaces may not operate independently.
    1.70 +		This value identifies the class definition used for the aggregate interfaces.
    1.71 +
    1.72 +		If this field is set to FFH, the device class is vendor-specific. */
    1.73 +	BYTE	bDeviceClass;
    1.74 +
    1.75 +	/** 	Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field.
    1.76 +		If the bDeviceClass field is set to zero, this field must also be set to zero.
    1.77 +		If the bDeviceClass field is not set to FFH, all values are reserved for assignment by the USB-IF. */
    1.78 +	BYTE	bDeviceSubClass;
    1.79 +
    1.80 +	/**	Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the
    1.81 +		bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an 
    1.82 +		interface basis, this code identifies the protocols that the device uses as defined by the specification of the device class.
    1.83 +		If this field is set to zero, the device does not use class-specific protocols on a device basis. However, it may use 
    1.84 +		classspecific protocols on an interface basis.
    1.85 +		If this field is set to FFH, the device uses a vendor-specific protocol on a device basis. */
    1.86 +	BYTE 	protocol;
    1.87 +
    1.88 +	/**	Number of possible configurations */
    1.89 +	BYTE	numConfigurations;
    1.90 +
    1.91 +	/** vendorId is the 16-bit number that is assigned by USB-ORG. */
    1.92 +	WORD 	vendorId;
    1.93 +
    1.94 +	/** productId is a 16-bit number that is assigned by the licensee to 
    1.95 +	uniquely identify this particular personality as type of device . */
    1.96 +	WORD 	productId;
    1.97 +
    1.98 +	/** 	bcdDevice may be optionally used during enumeration, this depends on 
    1.99 +		the licensee's policy regarding device upgrades */
   1.100 +	WORD 	bcdDevice;
   1.101 +
   1.102 +	/** 	manufacturerString is displayed on the Windows screen during first 
   1.103 +		enumeration of the device, and should identify the same company that 
   1.104 +		owns the USB vendorId given above */
   1.105 +	LTEXT 	manufacturer;
   1.106 +	
   1.107 +	/** 	productString is displayed on the Windows screen during first 
   1.108 +		enumeration of the device, and should identify the same device that is 
   1.109 +		implied by the productId given above */
   1.110 +	LTEXT 	product;
   1.111 +
   1.112 +	/**	personality id - UID which identified this personality */
   1.113 +	WORD 	id;					 
   1.114 +	
   1.115 +	/**	list of Class Controllers UIDs associated with this personality.
   1.116 +		UIDs shoud be provided as list of hexadecimal numbers separated by space or comma.
   1.117 +		Note Do not provide leading 0x or any trailing characters!
   1.118 +		Example "1Abc3422, 12345678  FE43bc33"
   1.119 +		Incorrect example "1abc3422, 0x12345678," */
   1.120 +	LTEXT	class_uids;			
   1.121 +	
   1.122 +	/** 	free text description of this personality. */
   1.123 +	LTEXT 	description;
   1.124 +
   1.125 +	/**     free text detailed description of this personality. */
   1.126 +	LTEXT   detailedDescription;
   1.127 +
   1.128 +	/**	personality property - the property of this personality */
   1.129 +	LONG 	property;					 
   1.130 +
   1.131 +	}
   1.132 +	
   1.133 +STRUCT PERSONALITY_ARRAY
   1.134 +	{
   1.135 +	STRUCT	personalities[];	// STRUCT PERSONALITY
   1.136 +	}