Quectel UC20 Installation and operating instructions

UC20 PPP
Application Note
UMTS/HSPA Module Series
Rev. UC20_PPP_Application_Note_V1.0
Date: 2014-05-15
www.quectel.com

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 1 / 29
Our aim is to provide customers with timely and comprehensive service. For any
assistance, please contact our company headquarters:
Quectel Wireless Solutions Co., Ltd.
Office 501, Building 13, No.99, Tianzhou Road, Shanghai, China, 200233
Tel: [phone]
Mail: [e-mail]
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 IS SUBJECT TO
CHANGE WITHOUT PRIOR NOTICE.
COPYRIGHT
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.
Copyright © Quectel Wireless Solutions Co., Ltd. 2014. All rights reserved.
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 2 / 29
About the Document
History
Revision
Date
Author
Description
1.0
2014-05-15
Gralik WANG
Initial
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 3 / 29
Contents
About the Document................................................................................................................................... 2
Contents....................................................................................................................................................... 3
Table Index................................................................................................................................................... 4
Figure Index ................................................................................................................................................. 5
1Introduction .......................................................................................................................................... 6
2Application Mode ................................................................................................................................. 7
3Procedure for PPP Setup .................................................................................................................... 8
3.1. General Procedure for PPP Setup.............................................................................................. 8
3.2. Recommended Procedure for PPP Setup.................................................................................. 9
4UART/USB for PPP Connection ....................................................................................................... 11
4.1. Data Mode and Command Mode.............................................................................................. 11
4.1.1. Switch from Data Mode to Command Mode.................................................................. 11
4.1.1.1. Use DTR Level Switch from Data Mode to Command Mode................................. 11
4.1.1.2. Use Sequence +++ to Switch from Data Mode to Command Mode...................... 11
4.1.2. Switch from Command Mode to Data Mode.................................................................. 12
4.1.2.1. Use ATO to Switch from Command Mode to Data Mode....................................... 12
4.2. Terminate the Connection ..................................................................................................... 12
4.3. Handle URC in Data Mode.................................................................................................... 13
4.4. Data Carrier Detect (DCD) Function Mode ........................................................................... 13
5PPP Dial-up in Windows.................................................................................................................... 14
5.1. Preparation ............................................................................................................................ 14
5.2. Modem Configuration ............................................................................................................ 14
5.2.1. Add a New Modem......................................................................................................... 14
5.2.2. Configure the Modem Driver.......................................................................................... 18
5.3. Dial-up Network Configuration .............................................................................................. 20
5.3.1. Create a New Connection.............................................................................................. 20
5.3.2. Configure the Connection .............................................................................................. 21
5.3.3. Configure the Dial-up Tool.............................................................................................. 22
5.3.4. Establish the Dial-up Connection................................................................................... 23
6PPP Dial-up in Linux.......................................................................................................................... 25
6.1. Prepare PPPD and CHAT ..................................................................................................... 25
6.2. Create Script Files................................................................................................................. 25
6.3. Set up PPP Connection by PPPD......................................................................................... 26
7Appendix A Reference....................................................................................................................... 28
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 4 / 29
Table Index
TABLE 1: RELATED DOCUMENTS .................................................................................................................. 28
TABLE 2: TERMS AND ABBREVIATIONS........................................................................................................ 28
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 5 / 29
Figure Index
FIGURE 1: PPP APPLICATION MODE............................................................................................................... 7
FIGURE 2: GENERAL PROCEDURE FOR PPP SETUP ................................................................................... 8
FIGURE 3: FLOWCHART FOR PPP SETUP ..................................................................................................... 9
FIGURE 4: PHONE AND MODEM OPTIONS................................................................................................... 15
FIGURE 5: ADD A NEW MODEM ..................................................................................................................... 16
FIGURE 6: SELECT MODEL OF THE MODEM ............................................................................................... 17
FIGURE 7: SELECT A PORT ............................................................................................................................ 17
FIGURE 8: INSTALLED SUCCESSFULLY ....................................................................................................... 18
FIGURE 9: CONFIGURE THE MODEM DRIVER............................................................................................. 19
FIGURE 10: CREATE A NEW CONNECTION .................................................................................................. 20
FIGURE 11: SET UP THE NEW CONNECTION .............................................................................................. 21
FIGURE 12: CONFIGURE THE SETTING........................................................................................................ 22
FIGURE 13: CONFIGURE THE DIAL-UP ......................................................................................................... 23
FIGURE 14: ESTABLISH THE DIAL-UP CONNECTION ................................................................................. 24
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 6 / 29
1Introduction
This document gives a brief introduction to PPP function of Quectel standard module, including
recommended procedures for PPP setup, the mode for PPP connection, and the example for PPP dial-up
in Windows.
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 7 / 29
2Application Mode
UART
USB
UART
USB
PPP
IP
Application
PPP
Radio Bearer
IP RELAY
Module
Application
TXD
RXD
CTS
RTS
DTR
DCD
RING
TXD
RXD
CTS
RTS
DTR
DCD
RING
USB_DM
USB_DP
USB_GN
USB_VBUS
USB_DM
USB_DP
USB_GND
USB_VBUS
Figure 1: PPP Application Mode
The usage of PPP (Point to Point Protocol) can be described as Figure 1. You can use either UART or
USB to realise PPP connection (please note only USB modem port could be used for PPP in the all USB
virtual ports). Module provides a PPP server to application, and application side provides PPP client to
module. Besides, application side also has to provide the following protocols: TCP/IP, HTTP, etc. When
PPP connection has been set up, the IP packet flow from application side will be transmitted to Internet by
module.
Most standard operating systems (e.g. Windows, Unix/Linux) include the PPP protocol stack. For other
operating systems which do not have existing application to set up PPP connection, it is very important to
develop an applicable application software to accomplish PPP connection first.
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 8 / 29
3Procedure for PPP Setup
This chapter gives the recommended procedure of PPP setup for Quectel standard module. If you want to
develop PPP application software, please read this chapter before programming.
3.1. General Procedure for PPP Setup
AT+CGREG?
+CGREG:0,1
AT+CGDCONT=1,"IP","CMNET"
OK
ATD*99#
CONNECT
7E FF 7D 23 C0 21 7D 21 7D „„
TE MT
Figure 2: General Procedure for PPP Setup
After module has registered to the GPRS network, you should set APN for PPP by AT+CGDCONT and
start PPP setup by command ATD*99#. When ATD*99# is executed, module enters into the procedure of
PPP packet interaction. The way of PPP packet interaction which Quectel module uses is on the basis of
standard Point to Point Protocol. Description about module’s packet interaction is included in Figure 3.
Please get more details about standard Point to Point Protocol from RFC 1661.
Quectel
Confidential

UMTS/HSPA Module Series
UC20 PPP Application Note
UC20_PPP_Application_Note Confidential / Released 9 / 29
3.2. Recommended Procedure for PPP Setup
Connect_Count
<5
Power On the
Module
AT+CPIN？
Query SIM Card
Status
AT+CGREG?
Query PS
network
1. Set APN by AT+CGDCONT
2. Start PPP Dialing by ATD*99#
Return CONNECT
MCU got IP and
DNS
Data
Transmission
MCU sends
PPP
Terminate-
Request
packet
Connect_Count++
Recommended Power ON/OFF:
1. Power OFF: Pull Power Key from
high to low, then cut off power after
12s.
2. Power ON: Pull Power Key to low
in 1s.
3. Pull Power Key back to high
when finishing Power OFF or
Power ON.
Exit from the PPP dialing if
SIM Card is not ready in 10s
SIM card is ready
Query SIM Card Status:
AT+CPIN/AT+QINISTAT. Reboot
module if module failed to detect
SIM card in 10s with AT+CPIN?.
PS Network：
1. It indicates that module has
registered to PS when
AT+CGREG? returns 1 or 5.
2. It is able to go to next step
without registering to PS in 60s.
APN Configuration：
1. APN must be set by
AT+CGDCONT
2. Use AT+CGACT? to check
whether current context has been
activated when AT+CGDCONT
returns error.
Y
Y
N
Packet Interaction
1. Exit from the procedure of Packet
Interaction by “+++”.
2. Module will report NO CARRIER
when PPP connection is
terminated.
LCP Negotiation
1. If UART is used, ensure the
baudrate between MCU and
module is the same.
AUTH Negotiation
1. Ensure the type of AUTH is one
of PAP(0xc023) and
CHAP(0xc223).
IPCP Negotiation
1. Check if MCU gets legal IP and
DNS address.
2. Check whether the amount of
DNS MCU is equal to the amount
requested by MCU.
3. Terminate PPP connection if
IPCP negotiation between TA and
TE is not completed in 90s, and
then retry PPP setup.
Exception Handling
1. Check whether the PPP
Terminate-Request packet is right.
2. Reboot module if the steps above
do not work.
Start timer when
IPCP negotiation
begins
Succeed to
negotiate IPCP
in 90s
Y
NMCU receives
PPP Terminate-
Ack packet in 3s
Send Count<5
Exception Handling
Send Count++
LCP Negotiation
AUTH Negotiation
IPCP Negotiation
Packet Interaction
OK
OK
OK
N
Y
Y
N
N
1.Synchronization between TE and TA
2. Fix and save baudrate by AT+IPR=xxx&W, if
USB modem port is used, this coud be ignored
Network：
1. It indicates that module has
registered to network when
AT+CREG? returns 1 or 5.
2. Reboot the module if it failed to
register to network in 60s.
Exit from the PPP dialing
if module failed to register
to network in 60s AT+CREG？
Query network
Register to network in 60s
Figure 3: Flowchart for PPP Setup
Quectel
Confidential