epoc32/include/usbman.rh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:
williamr@4
    15
* Resource header for usbman configuration.
williamr@4
    16
*
williamr@4
    17
*/
williamr@4
    18
williamr@4
    19
/**
williamr@4
    20
 @file
williamr@4
    21
 @publishedPartner
williamr@4
    22
 @released
williamr@4
    23
*/
williamr@4
    24
williamr@4
    25
STRUCT usb_configuration
williamr@4
    26
	{
williamr@4
    27
	/** 
williamr@4
    28
		vendorId is the 16-bit number that is assigned by USB-ORG.
williamr@4
    29
	 */
williamr@4
    30
	WORD	vendorId		= 0x0e22;
williamr@4
    31
williamr@4
    32
	/** 
williamr@4
    33
		productId is a 16-bit number that is assigned by the licensee to 
williamr@4
    34
		uniquely identify this particular type of device.
williamr@4
    35
	 */
williamr@4
    36
	WORD	productId		= 0x000b;
williamr@4
    37
williamr@4
    38
	/** 
williamr@4
    39
		bcdDevice may be optionally used during enumeration, this depends on 
williamr@4
    40
		the licensee's policy regarding device upgrades (new versions of a 
williamr@4
    41
		device may require to use new host driver files)
williamr@4
    42
	 */
williamr@4
    43
	WORD	bcdDevice		= 0x0000;
williamr@4
    44
williamr@4
    45
	/** 
williamr@4
    46
		manufacturerString is displayed on the Windows screen during first 
williamr@4
    47
		enumeration of the device, and should identify the same company that 
williamr@4
    48
		owns the USB vendorId given above
williamr@4
    49
	 */
williamr@4
    50
	LTEXT	manufacturer	= "Symbian Ltd.";
williamr@4
    51
williamr@4
    52
	/** 
williamr@4
    53
		productString is displayed on the Windows screen during first 
williamr@4
    54
		enumeration of the device, and should identify the same device that is 
williamr@4
    55
		implied by the productId given above
williamr@4
    56
	 */
williamr@4
    57
	LTEXT	product			= "Symbian OS";
williamr@4
    58
	}
williamr@4
    59
williamr@4
    60
STRUCT PERSONALITY
williamr@4
    61
	{
williamr@4
    62
	/** 	Class code (assigned by the USB-IF). If this field is set to zero, each interface within 
williamr@4
    63
		a configuration specifies its own class information and the various interfaces operate independently. 
williamr@4
    64
williamr@4
    65
		If this field is set to a value between 1 and FEH, the device supports different class
williamr@4
    66
		specifications on different interfaces and the interfaces may not operate independently.
williamr@4
    67
		This value identifies the class definition used for the aggregate interfaces.
williamr@4
    68
williamr@4
    69
		If this field is set to FFH, the device class is vendor-specific. */
williamr@4
    70
	BYTE	bDeviceClass;
williamr@4
    71
williamr@4
    72
	/** 	Subclass code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass field.
williamr@4
    73
		If the bDeviceClass field is set to zero, this field must also be set to zero.
williamr@4
    74
		If the bDeviceClass field is not set to FFH, all values are reserved for assignment by the USB-IF. */
williamr@4
    75
	BYTE	bDeviceSubClass;
williamr@4
    76
williamr@4
    77
	/**	Protocol code (assigned by the USB-IF). These codes are qualified by the value of the bDeviceClass and the
williamr@4
    78
		bDeviceSubClass fields. If a device supports class-specific protocols on a device basis as opposed to an 
williamr@4
    79
		interface basis, this code identifies the protocols that the device uses as defined by the specification of the device class.
williamr@4
    80
		If this field is set to zero, the device does not use class-specific protocols on a device basis. However, it may use 
williamr@4
    81
		classspecific protocols on an interface basis.
williamr@4
    82
		If this field is set to FFH, the device uses a vendor-specific protocol on a device basis. */
williamr@4
    83
	BYTE 	protocol;
williamr@4
    84
williamr@4
    85
	/**	Number of possible configurations */
williamr@4
    86
	BYTE	numConfigurations;
williamr@4
    87
williamr@4
    88
	/** vendorId is the 16-bit number that is assigned by USB-ORG. */
williamr@4
    89
	WORD 	vendorId;
williamr@4
    90
williamr@4
    91
	/** productId is a 16-bit number that is assigned by the licensee to 
williamr@4
    92
	uniquely identify this particular personality as type of device . */
williamr@4
    93
	WORD 	productId;
williamr@4
    94
williamr@4
    95
	/** 	bcdDevice may be optionally used during enumeration, this depends on 
williamr@4
    96
		the licensee's policy regarding device upgrades */
williamr@4
    97
	WORD 	bcdDevice;
williamr@4
    98
williamr@4
    99
	/** 	manufacturerString is displayed on the Windows screen during first 
williamr@4
   100
		enumeration of the device, and should identify the same company that 
williamr@4
   101
		owns the USB vendorId given above */
williamr@4
   102
	LTEXT 	manufacturer;
williamr@4
   103
	
williamr@4
   104
	/** 	productString is displayed on the Windows screen during first 
williamr@4
   105
		enumeration of the device, and should identify the same device that is 
williamr@4
   106
		implied by the productId given above */
williamr@4
   107
	LTEXT 	product;
williamr@4
   108
williamr@4
   109
	/**	personality id - UID which identified this personality */
williamr@4
   110
	WORD 	id;					 
williamr@4
   111
	
williamr@4
   112
	/**	list of Class Controllers UIDs associated with this personality.
williamr@4
   113
		UIDs shoud be provided as list of hexadecimal numbers separated by space or comma.
williamr@4
   114
		Note Do not provide leading 0x or any trailing characters!
williamr@4
   115
		Example "1Abc3422, 12345678  FE43bc33"
williamr@4
   116
		Incorrect example "1abc3422, 0x12345678," */
williamr@4
   117
	LTEXT	class_uids;			
williamr@4
   118
	
williamr@4
   119
	/** 	free text description of this personality. */
williamr@4
   120
	LTEXT 	description;
williamr@4
   121
williamr@4
   122
	/**     free text detailed description of this personality. */
williamr@4
   123
	LTEXT   detailedDescription;
williamr@4
   124
williamr@4
   125
	/**	personality property - the property of this personality */
williamr@4
   126
	LONG 	property;					 
williamr@4
   127
williamr@4
   128
	}
williamr@4
   129
	
williamr@4
   130
STRUCT PERSONALITY_ARRAY
williamr@4
   131
	{
williamr@4
   132
	STRUCT	personalities[];	// STRUCT PERSONALITY
williamr@4
   133
	}