Device Driver Interface of WiLink Solution

From OMAPpedia

(Difference between revisions)
Jump to: navigation, search
(On boot check)
m (Added the permissions required for BT/FM/GPS)
 
(33 intermediate revisions not shown)
Line 1: Line 1:
-
== Introduction ==
 
-
WL127x and WL128x are two generations of TI connectivity chips for the OMAP platforms. With any particular OMAP processor generation any particular generation of connectivity chip may be used (for a particular product). Generally used OMAP processor and connectivity chip combinations are:
 
-
:* OMAP3 and WL127x (as in Zoom2, Zoom3 devices) or
 
-
:* OMAP4 and WL128x (as in Blaze devices)
 
-
However, a few customers and internal development teams at TI use and need these (rare) combinations:
 
-
:* OMAP3 + WL128x and
 
-
:* OMAP4 + WL127x
 
-
 
-
The following hints are provided should you have an alternative combination of devices and have chosen not to use the devices ''on-board'' (for whatever reason):
 
-
 
-
Note that for ''on-board'' devices that come on a particular platform, i.e. Zoom2/3 (with WL127x), Blaze (with WL128x) and Panda (with WL127x), the relevant software releases for the platform (or board) should get WiFi, Bluetooth and FM work '''out of the box'''.
 
-
 
-
It should be clear by now that any OMAP platform can use any TI WiLink device. Below list provides a couple of ''rare/odd'' combinations along with a couple of regular:
 
-
 
-
:* OMAP3 + 1271 + 5500 (default for OMAP3)
 
-
:* OMAP3 + 1283
 
-
:* OMAP4 + 1283 (default for OMAP4)
 
-
:* OMAP4 + 1271
 
-
 
-
== Porting Shared Transport solution ==
 
-
A ''Shared Transport driver'' is a line discipline driver. It acts as a generic transport driver for Bluetooth, FM and GPS connectivity (for WL128x).
 
-
 
-
Each of those protocol drivers have a register and a unregister mechanisms with the shared transport driver. Upon registration the shared transport driver can do a concurrent write. The shared transport driver then would queue up the data and send it over the UART. When the shared transport driver receives any data it interprets the data and forwards it to the receiver protocol driver via callbacks.
 
-
 
-
Shared transport driver is a platform device driver. Hence, for any platform which has a WL127x/WL128x device and you want to make use of this device, and the accompanying driver, you may do so by including an entry in the architecture specific board file.
 
-
 
-
Illustration:
 
-
 
-
<pre>
 
-
/* wl128x BT, FM, GPS connectivity chip */
 
-
struct ti_st_plat_data wilink_pdata = {
 
-
        .nshutdown_gpio = 55,
 
-
        .dev_name = "/dev/ttyO1",
 
-
        .flow_cntrl = 1,
 
-
        .baud_rate = 3000000,
 
-
};
 
-
static struct platform_device wl128x_device = {
 
-
        .name          = "kim",
 
-
        .id            = -1,
 
-
        .dev.platform_data = &wilink_pdata,
 
-
};
 
-
</pre>
 
-
 
-
Also, in one of the architecture specific ''init functions'' add:
 
-
<pre>
 
-
platform_device_register(&wl128x_device);
 
-
</pre>
 
-
 
== Hardware Interface and MUX mode configuration ==
== Hardware Interface and MUX mode configuration ==
The WiLink connectivity chip's BT, FM and GPS IPs are interfaced with the application processor (OMAP) through UARTs. A GPIO line called ''nShutDown'' acts as the ''chip enable'' line for the connectivity chip.
The WiLink connectivity chip's BT, FM and GPS IPs are interfaced with the application processor (OMAP) through UARTs. A GPIO line called ''nShutDown'' acts as the ''chip enable'' line for the connectivity chip.
Line 87: Line 39:
'''Note: Since there lacks a standard way to configure the hardware interfaces, please look into relevant BSP or contact the email ID mentioned below.'''
'''Note: Since there lacks a standard way to configure the hardware interfaces, please look into relevant BSP or contact the email ID mentioned below.'''
 +
 +
 +
== Shared Transport (ST) driver ==
 +
 +
TI_ST driver 'aka shared transport driver provides a line discipline driver, line discipline N_TI_WL value 22 to multiplex Bluetooth, FM, GPS and other short range wireless technologies interfaced over UART in WiLink connectivity chipsets.
 +
 +
The build for this driver is driven by the configuration option CONFIG_TI_ST and the driver sources are located at drivers/misc/ti-st/ directory.
 +
 +
To bind together line discipline and the protocol driver (Bluetooth, FM driver) data, TI_ST driver is probed as a platform device driver and require the platform device driver data to be initialized in the arch/XX/mach-XX.c board specific file.
 +
The platform device driver data can be populated according to latest information and documentation available at include/linux/ti_wilink_st.h for struct ti_st_plat_data{}.
 +
 +
<pre>
 +
struct ti_st_plat_data {
 +
        long nshutdown_gpio;
 +
        unsigned char dev_name[UART_DEV_NAME_LEN]; /* uart name */
 +
        unsigned char flow_cntrl; /* flow control flag */
 +
        unsigned long baud_rate;
 +
        < more members in actual structure .... >
 +
};
 +
</pre>
== BTWILINK driver ==
== BTWILINK driver ==
Line 92: Line 64:
BTWILINK driver (in drivers/bluetooth/btwilink.c) provides the bluetooth connectivity. The driver makes use of the shared transport driver; which talks to the bluetooth core on the WiLink chipsets.
BTWILINK driver (in drivers/bluetooth/btwilink.c) provides the bluetooth connectivity. The driver makes use of the shared transport driver; which talks to the bluetooth core on the WiLink chipsets.
-
Enable this driver either as a module or as a built-in component along with necessary bluetooth functionality in the kernel.
+
Build for this driver is driven by the configuration option CONFIG_BT_WILINK.
Similar to the TI ST driver, this is also a platform device driver. Hence, to be included it requires a relevant platform device registration, which can be achieved as follows:
Similar to the TI ST driver, this is also a platform device driver. Hence, to be included it requires a relevant platform device registration, which can be achieved as follows:
Line 115: Line 87:
You can obtain UIM from:
You can obtain UIM from:
-
:http://git.omapzoom.org/?p=platform/hardware/ti/wpan.git;a=summary .
+
:http://git.omapzoom.org/?p=platform/hardware/ti/wpan.git;a=summary
The latest can be found at the Gingerbread branch. It's named ''uim-sysfs''. Follow this link to get it:
The latest can be found at the Gingerbread branch. It's named ''uim-sysfs''. Follow this link to get it:
Line 125: Line 97:
To do so (run at boot time), have the UIM entry in one of your ''rc.S files''. Alternatively, you can specify a special ''udev rule'' based on the platform driver in addition to the device "kim" [Need Modification].
To do so (run at boot time), have the UIM entry in one of your ''rc.S files''. Alternatively, you can specify a special ''udev rule'' based on the platform driver in addition to the device "kim" [Need Modification].
-
For Android, the following entry in the ''init.rc'' should suffice:
+
Depending on hardware platform, permission for /dev/ttyxx interface to be mapped to bluetooth to be added in init.rc
 +
For Android, the following entry in the ''init.rc'' should suffice.
 +
 
 +
For OMAP4:
 +
<pre>
 +
# change permissions for Bluetooth/FM/GPS
 +
    chmod 0660 /sys/class/rfkill/rfkill0/state
 +
    chown bluetooth bluetooth /sys/class/rfkill/rfkill0/state
 +
    chmod 0660 /dev/ttyO4
 +
    chown bluetooth bluetooth /dev/ttyO1
 +
</pre>
 +
 
<pre>
<pre>
Line 133: Line 116:
     oneshot
     oneshot
</pre>
</pre>
 +
 +
Note:
 +
 +
1. UIM needs access to the UART connected to BT/FM/GPS/NFC and therefore it has  to be the owner/group of the UART.
 +
 +
2. The permission for the rfkill entry created by bluetooth kernel sub-system has to be added, which is accessed by bluedroid which belongs to group bluetooth.
== Setting up the Firmware ==
== Setting up the Firmware ==
Line 143: Line 132:
Shared Transport driver uses the ''firmware class sub-system'' to download ''firmware files''. Hence the firmware ".bts" files should be placed in '''/system/etc/firmware/''' for Android and '''/lib/firmware/''' for Ubuntu.
Shared Transport driver uses the ''firmware class sub-system'' to download ''firmware files''. Hence the firmware ".bts" files should be placed in '''/system/etc/firmware/''' for Android and '''/lib/firmware/''' for Ubuntu.
 +
== On Boot Check ==
== On Boot Check ==
Line 150: Line 140:
<ul>
<ul>
 +
<li> Check up on the following default config options available in the ".config" of your kernel build directory, If any of the options among '''CONFIG_TI_ST''', '''CONFIG_BT_WILINK''', '''CONFIG_RADIO_WL128X''' is "=m" then it would mean the relevant driver would be built as a module.
 +
If the above mentioned options are configured to be "=y" then it would be built-in to the kernel and you would not need to perform the next 2 steps.
 +
<br>
<li> If you intended to build the following modules: TI ST driver, btwilink driver, FM and GPS, then make sure that the following kernel object files are present in the file-system (In the root "/" for Android.): '''st_drv.ko, btwilink.ko, fm_drv.ko and gps_drv.ko'''.
<li> If you intended to build the following modules: TI ST driver, btwilink driver, FM and GPS, then make sure that the following kernel object files are present in the file-system (In the root "/" for Android.): '''st_drv.ko, btwilink.ko, fm_drv.ko and gps_drv.ko'''.
-
 
+
<br>
<li> The above modules need to be inserted manually (with insmod) if the UIM does not do the job at boot. You can check that by doing a lising of the modules present. Use ''$lsmod'' to list the modules loaded.
<li> The above modules need to be inserted manually (with insmod) if the UIM does not do the job at boot. You can check that by doing a lising of the modules present. Use ''$lsmod'' to list the modules loaded.
-
 
+
<br>
<li> The directory ''sysfs'' should exist. The directory ''/sys/devices/platform/kim'' should also exist with the important entries like install, dev_name, baud_rate present. These entries should also represent at which UART the WiLink is connected for the platform.
<li> The directory ''sysfs'' should exist. The directory ''/sys/devices/platform/kim'' should also exist with the important entries like install, dev_name, baud_rate present. These entries should also represent at which UART the WiLink is connected for the platform.
-
 
+
<br>
<li> Similarily, the directory ''/sys/devices/platform/btwilink'' should exist. If this does then the hci0 interface can be checked using the command ''$hciconfig -a''.
<li> Similarily, the directory ''/sys/devices/platform/btwilink'' should exist. If this does then the hci0 interface can be checked using the command ''$hciconfig -a''.
 +
<br>
 +
<li> The process '''uim-sysfs''' should be running, this can be checked by peforming the '''$ps''' command. This would be started at system boot, because of the service entry uim.
 +
<br>
 +
<li> The ''FM driver'' initialization can be confirmed by checking the device node ('''''/dev/tifm''''' or '''''/dev/radio0''''' depending on the implementation).
 +
<br>
 +
<li> The ''GPS driver'' initialization can be confirmed by checking the device node '''''/dev/tigps'''''.
 +
</ul>
-
<li> The ''FM driver'' initialization can be confirmed by checking the device node '''''/dev/radio0'''''
+
== Enabling Profiles on Android ==
-
<li> The ''GPS driver'' initialization can be confirmed by checking the device node '''''/dev/tigps'''''
+
<ul>
-
</ul>
+
<li> GAP - Generic Access Profile:<br>
 +
:Bluetooth-Settings under Wireless Setting menu of the Setting Application in Android allows you to Scan, Pair and Connect to the devices. Upon scanning, the type of device is detected by Android and the connection is established upon the user's request.
 +
 
 +
<li> A2DP - Audio Streaming via Bluetooth:<br>
 +
:Android supports this profile. As soon as you have Bluetooth working, this is expected to work ''out of the box''. On Android, apart from the baud-rate on UART no other factor should generally cause the A2DP profile to break.
 +
 
 +
<li> AVRCP - Audio Video Remote Control Profile:<br>
 +
:This requires the ''uInput'' to be enabled in the kernel; Issue ''make menuconfig'' for more details.
 +
 
 +
<li> HFP/HSP - Head Set and Hands Free (In-Call operation):<br>
 +
:While all other kind of Bluetooth data goes over UART, this one goes through the OMAP to the BT via the McBSP. Different platforms have different configurations for the McBSP that has been interfaced with BT-PCM lines. Even without the Modem, the BT-PCM lines are verified by streaming music and record voice from the BT-headset.
 +
 
 +
<li>HID:<br>
 +
:On connection to a Bluetooth Keyboard or Mouse, the HID functionality should work ''out of the box''.
 +
 
 +
<li>PBAP/OPP:<br>
 +
:Since Android provides them, ''object push'' and ''Vcard listing'' should also work ''out of box''.
 +
 
 +
<li>FTP:<br>
 +
:There are 3rd party applications, called ''BlueFTP'', that are available from ''Android App Market'' that should work without any modifications upon installation.
 +
 
 +
<li>SPP:<br>
 +
:There are 3rd party applications, like ''BlueTerm'', that are available from ''Android App Market'' that should work without any modifications upon installation.
-
== Enabling profiles on Android ==
 
-
<ul>
 
-
<li> GAP - Generic Access Profile<br>
 
-
Bluetooth-Settings under Wireless Setting menu of the Setting Application in Android, allows you to Scan, Pair and Connect to
 
-
devices, upon Scanning, the type of device is detected by Android and connection is made upon user's request.
 
-
<li> A2DP - Audio Streaming via Bluetooth<br>
 
-
This is one of those profiles, which has android has support for in its profile and is expected to work out of the box as
 
-
soon as you have Bluetooth working. Apart from the baud-rate on UART no other factor should generally cause the A2DP
 
-
profile to break on android.
 
-
<li> AVRCP - Audio Video Remote Control Profile<br>
 
-
This requires the uInput to be enabled in the kernel  - make menuconfig for more details.
 
-
<li> HFP/HSP - Head Set and Hands Free (In-Call operation)<br>
 
-
While all other kind of bluetooth data goes over UART, this one goes over from the OMAP, to the BT via the McBSP.
 
-
Different platforms have different configurations for the McBSP that has been interfaced with BT-PCM lines.
 
-
Even without the Modem, the BT-PCM lines are verified by streaming music and record voice from the BT-headset.
 
-
<li> HID <br>
 
-
On connection to a Bluetooth Keyboard or Mouse, the HID functionality should work out of the box.
 
-
<li> PBAP/OPP <br>
 
-
Object push, Vcard listing should also work out of box, since Android provides them
 
-
<li> FTP <br>
 
-
3rd party applications like BlueFTP are available from Android App Market which should work without modifications upon installation.
 
</ul>
</ul>
 +
== Important Notes ==
== Important Notes ==
-
The platform data and its structure tend to keep changing, and hence before adding the platform device, please make sure
+
 
-
the platform data matches in type and structure of the platform data defined in include/linux/ti_wilink_st.h
+
The platform data and its structure constantly, inevitably change. Hence, before adding the platform device, make sure
 +
that the ''platform data'' matches in ''type and structure'' to the ''platform data'' defined in the file: include/linux/ti_wilink_st.h.
 +
 
== Support Contacts ==
== Support Contacts ==
-
Write your queries to [mailto:wcg-leads@list.ti.com WCG Leads]
 
 +
If you have any questions, doubts or suggestions please send them to: [mailto:wcg-leads@list.ti.com WCG Leads].
 +
 +
[http://www.omappedia.org/wiki/OMAP_WiLink_Connectivity_Home Back to Connectivity Home Page]
-
[[Category:Porting]]
+
[[Category:Wilink]]

Latest revision as of 20:24, 20 February 2012

Contents

[edit] Hardware Interface and MUX mode configuration

The WiLink connectivity chip's BT, FM and GPS IPs are interfaced with the application processor (OMAP) through UARTs. A GPIO line called nShutDown acts as the chip enable line for the connectivity chip.

Also, the connectivity chip is interfaced to BT core via PCM lines (mcbsp if OMAP) and to the FM core via i2S (or PCM). The BT-PCM lines carry the voice data during a call scenario. The FM i2S lines can be used for FM Rx audio (digital) or FM Tx audio.

The mux-mode configurations of these hardware interfaces can be configured via the OMAP MUX framework supported by the BSP as follows:


Example 1: On Zoom3 the N-Shut-Down line is connected to GPIO 109.

In file arch/arm/mach-omap2/board-zoom3.c you would find the following entry:
        omap_mux_init_gpio(109, OMAP_PIN_OUTPUT);

The configuration can be done in x-loader or u-boot. Note that the configuration may not take place in u-boot if it is already being done in x-loader.


Example 2: On OMAP3SDP/Blaze's x-loader, the McBSP1 is connected to the BT-PCM lines.

In file board/omap4430sdp/omap4430sdp.c of the ''u-boot'' source code, you will find entries which look like:

        MV(CP(ABE_MCBSP1_DX),   (OFF_EN | OFF_OUT_PTD | M0)) /* abe_mcbsp1_dx */ \
        MV(CP(ABE_MCBSP1_FSX),  (IEN | OFF_EN | OFF_PD | OFF_IN | M0)) /* abe_mcbsp1_fsx */ \
and
        MV(CP(ABE_MCBSP1_DX),   (OFF_EN | OFF_OUT_PTD | M0)) /* abe_mcbsp1_dx */ \
        MV(CP(ABE_MCBSP1_FSX),  (IEN | OFF_EN | OFF_PD | OFF_IN | M0)) /* abe_mcbsp1_fsx */ \

Example 3: On OMAP4SDP/Blaze, the OMAP UART2 is connected to the BT-HCI-UART.

        MV(CP(UART2_CTS),       (PTU | IEN | M0)) /* uart2_cts */ \
        MV(CP(UART2_RTS),       (M0)) /* uart2_rts */ \
        MV(CP(UART2_RX),        (IEN | M0)) /* uart2_rx */ \
        MV(CP(UART2_TX),        (M0)) /* uart2_tx */ \

Note: Since there lacks a standard way to configure the hardware interfaces, please look into relevant BSP or contact the email ID mentioned below.


[edit] Shared Transport (ST) driver

TI_ST driver 'aka shared transport driver provides a line discipline driver, line discipline N_TI_WL value 22 to multiplex Bluetooth, FM, GPS and other short range wireless technologies interfaced over UART in WiLink connectivity chipsets.

The build for this driver is driven by the configuration option CONFIG_TI_ST and the driver sources are located at drivers/misc/ti-st/ directory.

To bind together line discipline and the protocol driver (Bluetooth, FM driver) data, TI_ST driver is probed as a platform device driver and require the platform device driver data to be initialized in the arch/XX/mach-XX.c board specific file. The platform device driver data can be populated according to latest information and documentation available at include/linux/ti_wilink_st.h for struct ti_st_plat_data{}.

struct ti_st_plat_data {
        long nshutdown_gpio;
        unsigned char dev_name[UART_DEV_NAME_LEN]; /* uart name */
        unsigned char flow_cntrl; /* flow control flag */
        unsigned long baud_rate;
        < more members in actual structure .... >
};

[edit] BTWILINK driver

BTWILINK driver (in drivers/bluetooth/btwilink.c) provides the bluetooth connectivity. The driver makes use of the shared transport driver; which talks to the bluetooth core on the WiLink chipsets.

Build for this driver is driven by the configuration option CONFIG_BT_WILINK.

Similar to the TI ST driver, this is also a platform device driver. Hence, to be included it requires a relevant platform device registration, which can be achieved as follows:

static struct platform_device btwilink_device = {
       .name = "btwilink",
       .id = -1,
};

The inclusion of btwilink_device in one of the architecture specific init functions would enable the Bluetooth driver for WiLink chipsets. Include the following line in one of the architecture/platform specific init functions:

platform_device_register(&btwilink_device);

[edit] User Space components

An utility known as UIM is critical for the shared transport (TI_ST) driver to work. (Meaning, without UIM, TI_ST will not work.) Most line disciplines, if not all, require a user-space daemon to open the UART. Installing the line discipline thereby gives control to the line discipline driver.

You can obtain UIM from:

http://git.omapzoom.org/?p=platform/hardware/ti/wpan.git;a=summary

The latest can be found at the Gingerbread branch. It's named uim-sysfs. Follow this link to get it:

http://git.omapzoom.org/?p=platform/hardware/ti/wpan.git;a=tree;f=ti_st/uim-sysfs;h=12ce6bafd461474ad90d41a0b9523a94534e4c0a;hb=refs/heads/gingerbread

UIM needs to be run at boot since some Linux flavors may require Bluetooth or GPS to be turned on at boot.

To do so (run at boot time), have the UIM entry in one of your rc.S files. Alternatively, you can specify a special udev rule based on the platform driver in addition to the device "kim" [Need Modification].

Depending on hardware platform, permission for /dev/ttyxx interface to be mapped to bluetooth to be added in init.rc For Android, the following entry in the init.rc should suffice.

For OMAP4:

# change permissions for Bluetooth/FM/GPS
    chmod 0660 /sys/class/rfkill/rfkill0/state
    chown bluetooth bluetooth /sys/class/rfkill/rfkill0/state
    chmod 0660 /dev/ttyO4
    chown bluetooth bluetooth /dev/ttyO1


service uim /system/bin/uim-sysfs
    user root
    group media bluetooth
    oneshot

Note:

1. UIM needs access to the UART connected to BT/FM/GPS/NFC and therefore it has to be the owner/group of the UART.

2. The permission for the rfkill entry created by bluetooth kernel sub-system has to be added, which is accessed by bluedroid which belongs to group bluetooth.

[edit] Setting up the Firmware

All three connectivities -- Bluetooth, FM and GPS -- require their own firmware files. The Bluetooth firmware core file is used earlier (first) than the other cores in WiLink.

The latest firmware files are available on this site:

https://gforge.ti.com/gf/project/wilink_drivers/

Shared Transport driver uses the firmware class sub-system to download firmware files. Hence the firmware ".bts" files should be placed in /system/etc/firmware/ for Android and /lib/firmware/ for Ubuntu.


[edit] On Boot Check

Since there are many versions of the drivers floating around and a lot needs to be done to get them all working fine, checking a few things as mentioned below will ensure that the porting effort went well :

[edit] Enabling Profiles on Android


[edit] Important Notes

The platform data and its structure constantly, inevitably change. Hence, before adding the platform device, make sure that the platform data matches in type and structure to the platform data defined in the file: include/linux/ti_wilink_st.h.


[edit] Support Contacts

If you have any questions, doubts or suggestions please send them to: WCG Leads.

Back to Connectivity Home Page

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox