bthci/hci2implementations/hctls/usb_original/readme.txt
author jontanne
Thu, 14 Oct 2010 11:30:12 +0100
changeset 27 83036355c0f3
permissions -rw-r--r--
Add USB HCTL to bt package
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     1
This is an implementation of the Bluetooth USB HCTL for the Symbian
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     2
USB Host driver interface.
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     3
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     4
Note that this implementation is based on the classic "H2" 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     5
specification, as such it is not completely compatible with the 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     6
updated version published with the Bluetooth Core Specification 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     7
3.0+HS (and onwards).
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     8
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
     9
There are two distinct components:
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    10
	* The HCTL Plugin - this provides the Bluetooth transport 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    11
	  layer adaptation implementation through the USB driver 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    12
	  interface.
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    13
	* The FDC Plugin - this is receives the driver information 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    14
	  from the USB Function Driver Framework, it validates the 
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    15
	  device before supplying the notifications of device
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    16
	  attachment/detachment to the HCTL.
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    17
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    18
Both these components must be present for the system to be
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    19
functional, they can be included in a ROM image with the provided
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    20
iby file:
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    21
	hctl_usb_original.iby
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    22
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    23
If the reference CoreHCI is in use then a simple macro definition
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    24
is all that is required to include the iby file.  The macro to use
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    25
is HCI_USB; below is an example of its use:
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    26
	buildrom ... -DHCI_USB
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    27
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    28
To configure the Bluetooth stack to use this driver, the CoreHCI
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    29
implementation must be appropriately configured to use this
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    30
implementation.  Typically this is through an ini file in the
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    31
ESock data cage - in the Symbian file system this would be located:
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    32
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    33
	z:\private\101f7989\bluetooth\corehci_symbian.ini
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    34
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    35
In this file you should indicate the HCTL Plugin implementation
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    36
UID (0x200345E7):
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    37
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    38
	hctl_uid= 0x200345E7
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    39
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    40
An example configuration is provided in the Symbian reference
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    41
CoreHCI:
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    42
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    43
	corehci_symbian_usboriginal.ini
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    44
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    45
This should be all that is required to configure the use of the
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    46
driver.  The FDF should automatically load the FDC plugin when
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    47
a Bluetooth device is attached to the USB bus.  When no device is
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    48
attached then behaviour of the Bluetooth stack is the same as if
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    49
Bluetooth controllers power had been switched off (i.e. through the
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    50
power control API).
83036355c0f3 Add USB HCTL to bt package
jontanne
parents:
diff changeset
    51