Quectel UC20 User manual

UC20

Embedded Linux USB Driver

User Guide

UMTS/HSPA Module Series

Rev. UC20_Embedded_Linux_USB_Driver_User_Guide_V1.0

Date: 2013-06-04

www.quectel.com

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 1 / 18

Our aim is to provide customers with timely and comprehensive service. For any

assistance, please contact our company headquarter:

Quectel Wireless Solutions Co., Ltd.

Room 501, Building 13, No.99, Tianzhou Road, Shanghai, China, 200233

Tel: +86 21 5108 6236

Mail: info@quectel.com

Or our local office, for more information, please visit:

http://www.quectel.com/support/salesupport.aspx

For technical support, to report documentation errors, please visit:

http://www.quectel.com/support/techsupport.aspx

GENERAL NOTES

QUECTEL OFFERS THIS INFORMATION AS A SERVICE TO ITS CUSTOMERS. THE INFORMATION

PROVIDED IS BASED UPON CUSTOMERS’ REQUIREMENTS. QUECTEL MAKES EVERY EFFORT

TO ENSURE THE QUALITY OF THE INFORMATION IT MAKES AVAILABLE. QUECTEL DOES NOT

MAKE ANY WARRANTY AS TO THE INFORMATION CONTAINED HEREIN, AND DOES NOT ACCEPT

ANY LIABILITY FOR ANY INJURY, LOSS OR DAMAGE OF ANY KIND INCURRED BY USE OF OR

RELIANCE UPON THE INFORMATION. ALL INFORMATION SUPPLIED HEREIN ARE SUBJECT TO

CHANGE WITHOUT PRIOR NOTICE.

THIS INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF

QUECTEL CO., LTD. TRANSMITTABLE, REPRODUCTION, DISSEMINATION AND EDITING OF THIS

DOCUMENT AS WELL AS UTILIZATION OF THIS CONTENTS ARE FORBIDDEN WITHOUT

PERMISSION. OFFENDERS WILL BE HELD LIABLE FOR PAYMENT OF DAMAGES. ALL RIGHTS

ARE RESERVED IN THE EVENT OF A PATENT GRANT OR REGISTRATION OF A UTILITY MODEL

OR DESIGN.

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 2 / 18

About the document

History

Revision

Date

Author

Description

1.0

2012-05-31

Clare CHEN

Initial

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 3 / 18

Contents

About the document ................................................................................................................................... 2

Contents....................................................................................................................................................... 3

Table Index................................................................................................................................................... 4

Figure Index ................................................................................................................................................. 5

1Introduction .......................................................................................................................................... 6

2Product Overview ................................................................................................................................ 7

3System Setup ....................................................................................................................................... 8

3.1. Linux USB Drivers Structure...................................................................................................... 8

3.2. Building the driver...................................................................................................................... 9

3.2.1. Install cross compiler........................................................................................................ 9

3.2.2. Modify the source code file of Linux kernel...................................................................... 9

3.2.3. Modify kernel configuration ............................................................................................ 10

3.2.4. Compiling the kernel ...................................................................................................... 13

3.3. Loading the driver.................................................................................................................... 13

4Application of reference.................................................................................................................... 15

4.1. Modifying the rights of the devices port................................................................................... 15

4.2. Testing AT commands on the devices port.............................................................................. 15

4.3. Create a PPP connection ........................................................................................................ 15

5Appendix A Reference....................................................................................................................... 18

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 4 / 18

Table Index

TABLE 1: INTERFACE DESCRIPTION............................................................................................................... 7

TABLE 2: RELATIONSHIP BETWEEN INTERFACES AND DEVICES ............................................................ 14

TABLE 3: TERMS AND ABBREVIATIONS ........................................................................................................ 18

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 5 / 18

Figure Index

FIGURE 1:USB DRIVER STRUCTURE.............................................................................................................. 8

FIGURE 2: ADD UC20 SUPPORT .................................................................................................................... 10

FIGURE 3:KERNEL CONFIGURATION –SELECT DEVICE DRIVERS ...........................................................11

FIGURE 4:KERNEL CONFIGURATION –SELECT USB SUPPORT................................................................11

FIGURE 5:KERNEL CONFIGURATION –SELECT USB SERIAL CONVERTER SUPPORT ......................... 12

FIGURE 6:KERNEL CONFIGURATION –SELECT USB GENERIC SERIAL DRIVER ................................... 12

FIGURE 7:KERNEL CONFIGURATION –SELECT USB DRIVER FOR GSM AND CDMA MODEMS ........... 13

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 6 / 18

1Introduction

This document introduces how to generate the USB driver for UC20 module in Embedded Linux OS, and

how to use the module after the USB driver being loaded successfully.

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 7 / 18

2Product Overview

Quectel UC20 is a wireless WCDMA modem. You can use it to implement some functions such as VOICE

CALL and browsing internet and so on.

In general, the UC20 module will create five interfaces when you connect it with embedded equipments.

These five interfaces have different functionalities. The details are shown as below:

Table 1: Interface Description

DM interface

Diagnose port

NMEA interface

For GPS NMEA sentence output

AT interface

For AT commands

Modem interface

For PPP connections and AT commands

NDIS interface

Network driver interface

The NDIS interface is temporarily unavailable.

NOTES

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 8 / 18

3System Setup

Linux OS includes a generic USB to serial driver for modem. You can make the UC20 module available in

the Embedded Linux OS by adding some kernel configuration items and adding the information (VID/PID)

in Linux kernel.

The first part of this chapter is to describe the structure of Linux USB Driver and the rest is to explain how

to build the USB driver for UC20 module.

3.1. Linux USB Driver Structure

USB is a kind of hierarchical bus structure. The data transmission between USB devices and Host is

achieved by USB Controller. The following picture illustrates the architecture of USB Driver. Linux USB

Host driver includes three parts: USB Host Controller driver, USB core and USB device drivers.

USB Device Drivers

USB Host Controller Driver

( OHCI/EHCI/UHCI )

USB Controllers ( OHCI/EHCI/UHCI )

USB Core

Applicantions

URB

USBD

Interface

HCD

Interface

UC20 Module

Software

UC20 Module

Linux Host

Figure 1: USB Driver Structure

Quectel

Confidential

UMTS/HSPA Module

UC20 Embedded Linux USB Driver User Guide

UC20_Embedded_Linux_USB_Driver_User_Guide Confidential / Released 9 / 18

The USB Host Controller driver, the bottom of the hierarchical structure, is a software module which

interacts directly with hardware.

USB core, the core of the whole USB host driver, is responsible for the management of USB bus, USB

bus devices, and USB bus bandwidth, providing the interfaces for USB device driver, through which the

applications can access the USB system files.

USB device drivers interact with the applications, and mainly provide the interfaces for accessing the

specific USB devices.

3.2. Building the Driver

During the development based on embedded Linux OS, you must retrieve the Linux kernel source code

files and install an appropriate cross compiler first, then modify the kernel configuration and

corresponding source code files, and compile the kernel to generate image file, then burn the file into the

target machine (The OS of the target machine is Android 4.0.3, and the corresponding Linux kernel

version is 3.0.8).The detailed steps are shown as below:

3.2.1. Install Cross Compiler

Cross-compilation is an important technology for embedded development. Its feature is that the source

code files are not compiled in native machine but the other one. In general we call the former target

machine and the latter host machine.

The reason of adopting cross-compilation is that most embedded target system cannot provide enough

resources for compiling source code files, so we have to do that in a high-performance host machine in

which we will create an environment of cross-compilation for the target machine.

In general, the vendor of the embedded machine would provide the cross compiler and the installment

method about it. Here, we use the cross compiler "arm-linux-gcc-4.5.1", install it and add the compiler’s

path in the system environment variables, then re-logout system, then you can use the cross compiler to

compile the source code files.

3.2.2. Modify the Source Code File of Linux Kernel

Modify the source code file "option.c" in Linux kernel by adding VID and PID of UC20, so that the OS can

recognize it.

Quectel

Confidential

Other manuals for UC20

Table of contents

Other Quectel Control Unit manuals

Quectel

Quectel FC80A User manual

Quectel

Quectel M66 Supplement

Quectel

Quectel FGM842D Supplement

Quectel

Quectel UC15 Supplement

Quectel

Quectel UC200T-GL Supplement

Quectel

Quectel LCC Series User manual

Quectel

Quectel SC200L-EM Supplement

Quectel

Quectel WCDMA UG FILE Series Installation manual

Quectel

Quectel GNSS Module Series User manual

Quectel

Quectel SG368Z Series Supplement

Quectel

Quectel MC60 Supplement

Quectel

Quectel RM502Q-GL Supplement

Quectel

Quectel FCM561D-P Supplement

Quectel

Quectel RMU500-EK User manual

Quectel

Quectel EC200U Series Installation and operating instructions

Quectel

Quectel BG96 User manual

Quectel

Quectel SC600Y-EM Series Supplement

Quectel

Quectel EM05 Supplement

Quectel

Quectel RG500L EVB User manual

Quectel

Quectel GSM UART Port Installation and operating instructions

Quectel

Quectel UG Series Installation instructions

Quectel

Quectel EC200T Series Supplement

Quectel

Quectel SC20-EL User manual

Quectel

Quectel L70 Installation instructions

Popular Control Unit manuals by other brands

Festo

Festo Compact Performance CP-FB6-E Brief description

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Quick installation guide

JS Automation

JS Automation MPC3034A user manual

JAUDT

JAUDT SW GII 6406 Series Translation of the original operating instructions

Spektrum

Spektrum Air Module System manual

BOC Edwards

BOC Edwards Q Series instruction manual

KHADAS

KHADAS BT Magic quick start

Etherma

Etherma eNEXHO-IL Assembly and operating instructions

PMFoundations

PMFoundations Attenuverter Assembly guide

GEA

GEA VARIVENT Operating instruction

Walther Systemtechnik

Walther Systemtechnik VMS-05 Assembly instructions

Altronix

Altronix LINQ8PD Installation and programming manual

Eaton

Eaton Powerware Series user guide

WAGO

WAGO 750-407/040-000 manual

Sony

Sony CCU-590 Operation manual

Graco

Graco 25D614 instructions

Task Force Tips

Task Force Tips YE-RF-900 Instructions for installation, safe operation and maintenance

Shini

Shini SPV-U Series manual