Redpine Signals RS9113 User manual

Redpine Signals, Inc. Proprietary and Confidential
RS9113-n-Link-Module-Driver-
Installation-Guide
V
Ve er rs si io on n 3 3. .0 0
October 014
Redpine Signals, Inc
.
2107 N. First Street, #6 0
San Jose, CA 95131.
Tel: (40 ) 74 -33 5
Fax: (40 ) 705-2019
Email: [e-mail]
Website: www.redpinesignals.com

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 2
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
Disclaimer:
The information in this document pertains to information related to Redpine Signals,
Inc. products. This information is provided as a service to our customers, and may
be used for information purposes only.
Redpine assumes no liabilities or responsibilities for errors or omissions in this
document. This document may be changed at any time at Redpine’s sole discretion
without any prior notice to anyone. Redpine is not committed to updating this
document in the future.
Copyright © 2009 Redpine Signals, Inc. All rights reserved.

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 3
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
Table Of Contents
1 Introduction ........................................................................ 5
1.1 Definitions, Acronyms and Abbreviations ............................. 5
Onebox Driver – Setup Requirements .................................. 6
.1 Hardware Requirements ....................................................... 6
. Software Requirements ........................................................ 6
.3 Extraction of the driver package ........................................... 6
3 Compilation Procedure on various platforms ....................... 8
4 Software Boot loader Flashing ........................................... 11
5 Software Boot Loader Upgradation .................................... 13
6 OneBox-Mobile™ in WiFi only mode ................................... 14
6.1 Loading SDIO stack modules (applicable only if SDIO
interface is selected by user) ........................................................ 14
6. Installation procedure in Client mode ................................. 14
6.3 Printing supplicant scan results .......................................... 17
6.4 Deep sleep: ......................................................................... 17
6.5 Connecting to Hidden AP .................................................... 17
6.6 Installation procedure in AccessPoint mode ....................... 18
6.7 Installation procedure in WiFi-Direct mode ........................ 0
6.7.1 Autonomous GO mode: ..................................................... 1
7 OneBox-Mobile™ Coexistence Driver in WiFi + BT Classic
mode ......................................................................................
7.1 Note: The initialization procedure mentioned below will be
applicable to both USB and SDIO interfaces.Loading SDIO stack
modules (applicable only if SDIO interface is selected by user) ....
7. Installation procedure ........................................................
8 Installation and usage of Bluetooth manager .................... 4
9 OneBox-Mobile™ Coexistence Driver in WiFi +BLE mode ... 7
9.1 Note: The initialization procedure mentioned below will be
applicable to both USB and SDIO interfaces.Loading SDIO stack
modules (applicable only if SDIO interface is selected by user) .... 7
9. Installation procedure ........................................................ 7
9.3 Advertise Mode: .................................................................. 8
9.4 Scanning Mode: .................................................................. 8
9.5 Master Mode Connected State: ............................................ 8
9.6 Slave Mode Connected State: .............................................. 8
10 OneBox-Mobile™ Coexistence Driver in WiFi+Zigbee Mode
30
10.1 Driver Installation Procedure.............................................. 30
10. Building and running the sample HA switch application ...... 30
1. About sample application .................................................................. 30
2. Host API folder structure ................................................................... 30
3. Application state machine .................................................................. 31
4. Stack callbacks ................................................................................ 31

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 4
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
5. Building and running the HA sample switch application ......................... 32
11 Driver Un-installation Procedure ..................................... 33
1 Driver Information .......................................................... 34
1 .1 Driver statistics: ................................................................. 34
1 . Disabling prints in the driver .............................................. 34
13 Starting DHCP Server/Client ........................................... 35
14 Appendix: ........................................................................ 36
14.1 Iperf cross compilation: ...................................................... 36
14. Configuration of kernels from 3.13 to 3.16 to support the
Driver ………………………………………………………………………………….37
15 BT Porting for Android:.................................................... 39

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 5
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
1 Introduction
This document describes how to bring up the Redpine’s OneBox-Mobile
Coexistence software based on RS9113 chipset on x 6 or any embedded
platform. OneBox-Mobile Coexistence software currently supports WiFi
mode which has Access Point, Client and WiFi-Direct (P2P) modes and
Bluetooth Classic, Bluetooth Low Energy and Zigbee modes. OneBox-
Mobile Coexistence software supports the following combinations.
1) WiFi only mode
2) WiFi + Bluetooth Classic mode
3) WiFi + Bluetooth Low Energy mode
4) WiFi + Zigbee mode
Coexistence mode can be used with WiFi operating in Client mode only.
1.1 Definitions, Acronyms and Abbreviations
The following terms and definitions are used in the document.
a) WiFi Mode: WiFi mode refers to the WLAN Protocol based on
IEEE 02.11 standard. Whenever driver runs in WiFi Mode, it
supports one of the Access Point, Client and WiFi-Direct modes.
b) BT Classic Mode: BT Classic mode refers to the Core Bluetooth
BR/EDR Protocol defined by the trade organization Bluetooth SIG.
c) BLE Mode: BLE mode refers to the Core Bluetooth Low Energy
Protocol defined by the trade organization Bluetooth SIG.
d) Zigbee Mode: Zigbee mode refers to the ZigBee Protocol based
on the IEEE 02.15 standard.
e) Coexistence(Coex) Mode: Coexistence mode refers to the
simultaneous functioning of driver in both WiFi Client mode and
Zigbee mode (or) WiFi client mode and BT (Classic or LE modes).
Driver enters into Coexistence mode whenever both protocol
modules are inserted.
f) End-to-End Mode: End-to-End mode refers to the default driver
mode where Driver operates in WiFi or Zigbee or Coex mode.

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 6
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
Onebox Driver – Setup Requirements
This section describes the hardware and software environment for the installation
and operation of the Redpine’s Onebox-Mobile Driver.
The following configuration is required to install and use the Onebox-Mobile
device on Linux platform.
.1 Hardware Requirements
•RS9113 SDIO/USB module
•Laptop/PC with SDIO interface, usb support
•Note : In case if the Laptop doesn’t have a built in MMC /SDIO interface
we can use a Ricoh card for accessing the SDHC/SD/MMC via PCI card-
bus interface. Refer to the following link below for more information on
the Ricoh cards. http://www.hwtools.net/cardreader/SDCBA_C01.html
. Software Requirements
•Linux 2.6.35 and above kernel version with open source SDIO stack patch
applied.
•DHCP server
•Iperf
•Bluetooth Manager Application
•Compatible Bluetooth Host stack(Bluez stack)
•
For higher kernel versions, i.e 3.13 and above , refer to the section Configuration
of kernels from 3.13 to 3.16 to support the Driver in the Appendix to ensure
correct kernel configuration.
.3 Extraction of the driver package
The driver tarball is copied into a new folder and untar it using the following
commands
#mkdir redpine
# cp <package_name.tgz> redpine/
Note: The example showed here is a generic release package for Linux
OS. The package name may get changed accordingly based on the
customer releases.
For eg:
cp RS9113.NXX.NL.GEN.LNX.x.x.x.tgz redpine/
Contents of the release package are
1) Readme
2) Release Notes
3) Documents
Note

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 7
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
4) Source (Optional)
5) Binary_files(Optional)
# cd redpine
# tar xzvf package name.tgz
If Driver binaries are provided then follow the below procedure.
# mkdir –p /home/rsi
# cp Binary_files/release.tgz /home/rsi
# cd /home/rsi
# tar xzvf release.tgz
Final driver binaries (*.ko) can be found in the /home/rsi/release.
If source is provided then follow the below procedure:
# cd Source
Untar the driver source using the following command
# tar xzvf host.tgz
#cd host
Follow the compilation procedure mentioned in Compilation
Procedure on various platforms. Note that the compiled binaries
will be finally copied in to the “/home/rsi/release” directory

-
-
Redpine Signals, Inc. Proprietary and Confidential Page
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
3Compilation Procedure on various platforms
Using menuconfig utility we can select or deselect features while
compiling the driver. The following are the menuconfig options:
•Interface on which the driver has to run, For eg : SDIO or USB.
•Regulatory Domain (US, Europe, Japan and rest of the world)
•Encap in FW
•Decap in FW
•Loading instructions from TA, disable it from host
•Programming BBP values from TA
•Programming SCAN values from TA
•Enable/Disable Aggregation Support
•Enable/Disable Debugging Support
•Enable/Disable Chip Enabled
•Enable/Disable AutoRate Support
•Enable/Disable EEPROM Read
•Enable/Disable RSI_SDIO MultiBlock Support
•Enable/Disable Security Support
•Enable/Disable Peer to Peer Support
•Enable/Disable AMPDU Age
The Menuconfig utility will start automatically when user
issues a “make” command in the driver source.
Note: User has to select the Interface to support (SDIO/
USB)in the menuconfig file.
In case of embedded platform the following changes are to
be made in the Makefile.
# cd host
# vim Makefile
EDIT the DEF_KERNEL_DIR path in the Makefile as shown below.
# DEF_KERNEL_DIR := (Platform Compiled Kernel path)
For example: If the kernel build path is in /work/redpine folder, then the
DEF_KERNEL_DIR should be modified as
# DEF_KERNEL_DIR:= /work/redpine/linux-x.x.x.

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 9
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
After editing the above changes issue make command followed by
the cross compilation options and the target platform on which the
binaries has to be built.
For example , if the target platform is ARM and tool chain path is
“/opt/freescale/usr/local/gcc-4.4.4-glibc-2.11.1-multilib-1.0/arm-fsl-
linux-gnueabi/bin/arm-none-linux-gnueabi-“ then the command is
issued as
# make ARCH=arm CROSS_COMPILE =
/opt/freescale/usr/local/gcc-4.4.4-glibc-2.11.1-multilib-1.0/arm-fsl-
linux-gnueabi/bin/arm-none-linux-gnueabi-
Please check the below snapshots for reference.
Figure 1: Menuconfig Utility Main page

-
-
Redpine Signals, Inc. Proprietary and Confidential Page 10
R
RS S9 91 11 13 3- -n n- -L Li in nk k- -M Mo od du ul le e- -D Dr ri iv ve er r- -I In ns st ta al ll la at ti io on n- -G Gu ui id de e
V
V
e
e
r
r
s
s
i
i
o
o
n
n
3
3
.
.
0
0
Figure 2: Selecting the interface type to test the driver
Figure 3: Save the changes before exiting