LTE&5G Linux USB
Driver User Guide
LTE/5G Module Series
Rev. LTE&5G_Linux_USB_Driver_User_Guide_V2.0
Date: 2019-12-11
Status: Released
www.quectel.com
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
Our aim is to provide customers with timely and comprehensive service. For any
assistance, please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
Building 5, Shanghai Business Park Phase III (Area B), No.1016 Tianlin Road, Minhang District,
Shanghai, China 200233
Tel: +86 21 5108 6236
Email: info@quectel.com
Or our local office. For more information, please visit:
http://www.quectel.com/support/sales.htm
For technical support, or to report documentation errors, please visit:
http://www.quectel.com/support/technical.htm
Or email to: support@quectel.com
GENERAL NOTES
QUECTEL OFFERS THE 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 IS SUBJECT TO
CHANGE WITHOUT PRIOR NOTICE.
COPYRIGHT
THE INFORMATION CONTAINED HERE IS PROPRIETARY TECHNICAL INFORMATION OF
QUECTEL WIRELESS SOLUTIONS CO., LTD. TRANSMITTING, REPRODUCTION, DISSEMINATION
AND EDITING OF THIS DOCUMENT AS WELL AS UTILIZATION OF THE CONTENT 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.
Copyright © Quectel Wireless Solutions Co., Ltd. 2019. All rights reserved.
LTE&5G_Linux_USB_Driver_User_Guide 1 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
About the Document
History
Revision Date
Author
Description
1.0
1.1
1.2
2015-02-27
Joe WANG
Initial
2015-3-25
Carl YIN
Updated supported products
2015-3-30
Kent XU
Added Zero Packet feature in Section 3.2.2 and 3.3.2
1.3
2015-06-24
Carl YIN
1.4
2015-12-16
1. Added GobiNet and QMI WWAN description in
Section 3.4 and 3.5
2. Added building drivers as a kernel module in Section
3.2.4/3.3.4/3.4.3/3.5.4
3. Added power management in Chapter 4
4. Added FAQ and kernel log in Chapter 6
1. Deleted Auto-Connect of GobiNet and QMI WWAN
2. Updated the usage of quectel-CM
2016-05-13
Carl YIN/
Neo HOU
Updated supported modules
2016-08-23
Kent XU
Added EC20 R2.0 in supported modules
Added EG91/EG95/EG06/EP06/EM06/BG96 in supported
modules
Updated description of supported modules and added
AG35 in supported modules.
1. Added applicable modules, which can be referred in
Table 1.
2. Updated USB driver interface description in Table 2.
3. Updated description of USB serial option, GobiNet
and QMI_WWAN drivers in Chapter 3.2, 3.3 and 3.4.
4. Added
related
content of
testing
command
“AT$QCRMCALL” and protocol QMAP on GobiNet or
QMI_WWAN driver in Chapter 5.4 and 5.6 as well as
1.5
1.6
1.7
2017-05-24
Kent XU
1.8
2017-09-01
Kent XU
2.0
2019-12-11
Carl YIN
LTE&5G_Linux_USB_Driver_User_Guide 2 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
testing MBIM driver in Chapter 5.5.
5. Added FAQs in Chapter 6.
LTE&5G_Linux_USB_Driver_User_Guide 3 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
Contents
About the Document ................................................................................................................................... 2
Contents ....................................................................................................................................................... 4
Table Index ................................................................................................................................................... 6
Figure Index ................................................................................................................................................. 7
1
Introduction .......................................................................................................................................... 8
1.1.
Applicable Modules ................................................................................................................... 8
2 Overview of Linux USB Driver ............................................................................................................ 9
3 System Setup ..................................................................................................................................... 11
3.1.
Linux USB Driver Structure ..................................................................................................... 11
3.2. USB Serial Option Driver ......................................................................................................... 12
3.2.1. Add VID and PID ............................................................................................................ 12
3.2.2. Add the Zero Packet Mechanism ................................................................................... 13
3.2.3. Add Reset-resume Mechanism ...................................................................................... 14
3.2.4.
Increase the Quantity and Capacity of the Bulk Out URBs ........................................... 15
3.2.5. Use MBIM, GobiNet or QMI_WWAN Driver .................................................................. 15
3.2.6. Modify Kernel Configuration ........................................................................................... 16
3.3. GobiNet Driver ......................................................................................................................... 17
3.3.1. Modify Source Codes of the Driver ................................................................................ 17
3.3.2. Modify Kernel Configuration ........................................................................................... 17
3.4. QMI_WWAN Driver .................................................................................................................. 18
3.4.1. Modify Source Codes of the Driver ................................................................................ 18
3.4.2. Modify Kernel Configuration ........................................................................................... 19
3.5. Configure Kernel to Support PPP ............................................................................................ 20
3.6.
Install and Load Driver as a Kernel Module for PC in Linux ................................................... 21
4 Test the Module .................................................................................................................................. 23
4.1.
4.2.
4.3.
4.4.
4.5.
4.6.
Test AT Function ...................................................................................................................... 23
Test PPP Function ................................................................................................................... 23
Test GobiNet/QMI_WWAN Driver ............................................................................................ 26
Test "AT$QCRMCALL" on GobiNet/QMI_WWAN Driver ........................................................ 29
Test MBIM Driver ..................................................................................................................... 30
Test QMAP on GobiNet/QMI_WWAN Driver ........................................................................... 32
5 Power Management ........................................................................................................................... 33
5.1.
5.2.
Enable USB Auto Suspend...................................................................................................... 33
Enable USB Remote Wakeup ................................................................................................. 34
6 FAQs and Kernel Log ........................................................................................................................ 35
6.1. How to Check Whether USB Driver Exists in the Module ....................................................... 35
6.2. How to Check Whether the Module Works Well with the Corresponding USB Driver............ 35
6.3. How to Check Which USB Driver Has Been Installed ............................................................ 36
LTE&5G_Linux_USB_Driver_User_Guide 4 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
7 Appendix A References ..................................................................................................................... 38
LTE&5G_Linux_USB_Driver_User_Guide 5 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
Table Index
TABLE 1: APPLICABLE MODULES .................................................................................................................... 8
TABLE 2: DESCRIPTION OF USB DRIVER INTERFACE IN LINUX OPERATING SYSTEM ........................... 9
TABLE 3: DESCRIPTION OF QUECTEL-CM ARGUMENTS ........................................................................... 27
TABLE 4: USB NETWORK TYPE ..................................................................................................................... 31
TABLE 5: TERMS AND ABBREVIATIONS ........................................................................................................ 38
LTE&5G_Linux_USB_Driver_User_Guide 6 / 38
LTE/5G Module Series
LTE&5G Linux USB Driver User Guide
Figure Index
FIGURE 1: LINUX USB DRIVER STRUCTURE ................................................................................................ 11
FIGURE 2: CONFIGURE USB SERIAL IN KERNEL ........................................................................................ 17
FIGURE 3: CONFIGURE QMI_WWAN DRIVER IN KERNEL .......................................................................... 20
FIGURE 4: CONFIGURE PPP IN KERNEL ...................................................................................................... 21
FIGURE 5: AT COMMAND TEST RESULT ....................................................................................................... 23
FIGURE 6: USB SERIAL OPTION AND GOBINET FOR RG500Q .................................................................. 36
FIGURE 7: USB SERIAL OPTION AND QMI_WWAN FOR RG500Q .............................................................. 36
FIGURE 8: USB INTERFACE AND DRIVER FOR RG500Q ............................................................................ 37
LTE&5G_Linux_USB_Driver_User_Guide 7 / 38