Zebra PTC-2124 DOS Software Guide

Document Number: 30722-000-002

PTC-2124

DOS Software

Guide

Chapter 3 Configuring TN-3270/5250
PTC-2124 DOS Software Software Guide

Document Number: 30722-000-002

Chapter 3 Configuring TN-3270/5250
Symbol is a registered trademark of Symbol Technologies, In c. Windows 95 and Microsoft are r egistered trademarks
of the Microsoft Corporation. All other product or trade references appearing in this manual are registered
trademarks of their respective owners. The information in this manual is subjectto changewithout notice. Symbol Technologies shall not be liable for technical or editorial omissions or
mistakes in this manual. Nor shall it be liable for in cidental or consequential damages resulting from the use of the information contained in this manual.
This manual is copyrighted. No part of this manual may be photocopied or reproduced in any form without the prior written consent of Symbol.
Technical Writer: Norm Walters © Copyright 2000 Symbol Technologies, Inc. All rights reserved.

This Guide’s Purposeand Scope

Introduction

This Guide’s Purpose and Scope
This manual was written by the Symbol Technical Publications Group. This group is tasked with providing technical documentation for the Symbol PTC-2124 product line that uses the Microsoft® Windows CE® Operating System. Ev ery effort has been made to provide accurate and concise information to you, our customer.
The PTC-2124 DOS Software Guide pr ovides information that allows the use r to set up and use the PTC-2124. This manual is meant to provide information on the various components of this product, including
General regulations,
Overview of the PTC-2124,
Maintenance and trouble shooting,
Available accessories. This manual, h owever, does not provide instructions
on how to perform t he tasks specific to your job within your organization. For job-specific information, refer to the instructions provided b y your organization.
PTC-2124 DOS Software Guide i
Chapter 3 Configuring TN-3270/5250

Contacting Symbol’s Support Center

Symbol’s Support Center may be contacted to obtain help in resolving any PTC-21 24 system problem that you may experience.
If you have a problem running your unit or using your equipment, contact your facility’s technical or system support. If there is a problem with the equipment, the system s upport willcontact the Symbol Support Center at 1-800-653-5350.
For additional information on Sym bol’s products and services, please visit our website at
www.symbol.com.
ii PTC-2124 DOS Software Guide
Table of Contents
Introduction..................................................................................... i
This Manual’s Purpose and Scope.................................................. i
Contacting Symbol's Product Support Center............................... i
PTC-2124 O verview ........................................................................ 1
Functional Overview....................................................................... 2
BIOS ............................................................................................. 2
Operating System ........................................................................ 3
Application ................................................................................... 3
Other Software Components .......................................................... 4
SoftwareKernel ........................................................................... 4
PenRight! Operating Environment............................................. 4
Power Management..................................................................... 4
SoftwareDevelopment Kits......................................................... 5
PTC-2124 U nit Configurations ..................................................... 6
Radio Options.................................................................................. 7
Batch............................................................................................. 7
LAN Radio Ready......................................................................... 7
WAN Radio Factory Installed..................................................... 7
Memory............................................................................................ 8
RAM.............................................................................................. 8
ROM .............................................................................................. 8
Storage Options............................................................................... 8
ATA............................................................................................... 8
SRAM............................................................................................ 8
Compact Flash.............................................................................. 9
PCMCIA Slots.................................................................................. 9
External Slots............................................................................... 9
Display............................................................................................. 9
IrDA ................................................................................................. 10
Ethernet........................................................................................... 10
DCD Devices.................................................................................... 10
Scanners....................................................................................... 10
PTC-2124 DOS Software Guide iii
PTC-2124 A ssignments .................................................................. 11
Resource Map .................................................................................. 12
Memory Allocation Table ............................................................. 12
Hardware Interrupts....................................................................... 13
InterruptTable............................................................................. 13
COM Port Assignments .................................................................. 14
Boot Options..................................................................................... 15
POST................................................................................................ 16
What Happens During POST...................................................... 16
Changing BIO S S ettings ................................................................. 17
Boot Sources and Drive Letter Mapping........................................ 18
Normal Boot ................................................................................. 18
Booting from an ATA Card.......................................................... 19
Booting from an SRAM Card....................................................... 20
Reflashing the BIOS....................................................................... 23
TFLASH Utility ...................... ..................................................... 23
Automatic Genesis Flash............................................................. 25
Resetting/Rebooting the PTC-2124 ................................................ 26
Cold Reboot................................................................................... 26
Console Reboot............................................................................. 26
Power Management........................................................................ 28
APM ................................................................................................. 28
Monitoring....................................................................................... 29
APM Driver...................................................................................... 29
POWER.EXE................................................................................ 29
Command Line Parameters......................................................... 29
Power Management S tates............................................................. 31
Magic Packet Mode ...................................................................... 32
Features of Power Management in the Standby State.............. 33
Features of Power Management in the Suspend State.............. 34
SC 400 Power Control Flow............................................................ 35
iv PTC-2124 DOS Software Guide
Driver Su pport ................................................................................ 36
Cradle Information......................................................................... 37
Cradle O verview.............................................................................. 37
PTC-2124 Cradle Interactio n ......................................................... 38
Cradle Serial Interface ................................................................ 39
DTR and RTS Latching ............................................................... 41
Ring Indicator .............................................................................. 41
DB-9 Serial Connector Pinout..................................................... 41
Ethernet Port ............................................................................... 42
KeyboardPort .............................................................................. 43
Crad TSR Overview......................................................................... 44
Invoking CradTSR ....................................................................... 44
Specifying Interrupt Vector......................................................... 45
Binary Interface of CradTSR....................................................... 45
Command Line Arguments ......................................................... 46
SCRNBLNK....................................................................................... 48
Purpose............................................................................................ 48
User Interface Functions................................................................ 48
Reject Standby (/r option)............................................................ 48
Time-out (/t option) ...................................................................... 49
Unload (/u option) ........................................................................ 4 9
Vector (/v option).......................................................................... 49
TSR Internal Functions.................................................................. 50
Events........................................................................................... 50
INIT State .................................................................................... 50
SBL_ON State.............................................................................. 50
SBL_OFF State............................................................................ 50
INACTIVE State.......................................................................... 51
Standby/Suspend/Resume........................................................... 5 1
State Machine .............................................................................. 51
PTC-2124 DOS Software Guide v
Ethernet Power Management...................................................... 52
Cradle TSR Function ...................................................................... 52
Ethernet Drivers/Utilities................... .. .......................................... 53
Installing Ethernet Drivers......................................................... 53
ETHERCTL.EXE......................................................................... 53
TEP.COM ..................................................................................... 53
ETHERNET.BAT ......................................................................... 54
IrDA.................................................................................................... 55
IrDA Power Management............................................................... 55
JIRDAON.EXE............................................................................. 5 5
JIRDAOFF.EXE........................................................................... 55
LP20.EXE..................................................................................... 55
LitePlus 2.0 IrDA Print Driver ................................................... 55
LitePlus 2.0 IrDA DOS D river Architecture.............................. 56
IrDA Related Specification.......................................................... 56
IrDA Compatibility ...................................................................... 62
DOS BIOS INT17H Function Extension.................................... 62
DOS BIOS INT14H Function Extension.................................... 64
Miscellaneous............................................................................... 7 5
Discussions................................................................................... 79
NTMOUSE ......................................................................................... 80
What is NTMOUSE?.................................................................... 80
Pencal ........................................................................................... 81
Using NTM OUSE ........................................................................ 81
NTMOUSE Interaction with APM.............................................. 82
Special Notes for Programmers................................................... 83
2124POP ............................................................................................ 84
Command Line............................................................................. 84
Options.......................................................................................... 84
PENCAL ............................................................................................ 86
What is PENCAL?........................................................................... 86
Why Use PENCAL?......................................................................... 87
Using PENCAL ............................................................................... 88
PENCAL Usage Notes .................................................................... 90
vi PTC-2124 DOS Software Guide
PenRight!.......................................................................................... 91
PenRight! Overview ........................................................................ 9 1
Features........................................................................................... 91
MobileBuilder............................................................................... 93
System Requirements.................................................................. 94
Installation ...................................................................................... 9 4
PC Installation............................................................................. 94
RAM Disk Installation................................................................. 95
PCMCIA Card Installation.......................................................... 95
Command Line Parameters......................................................... 96
Radio Types and Functions.......................................................... 99
RadioID Overview........................................................................... 100
Radio Ty pe.................................................................................... 100
Utility Features............................................................................ 100
Usage............................................................................................ 101
Help Screen.................................................................................. 101
Silent Mode ................................................................................... 102
Verbose Mode ............................................................................... 102
Radio Ty pe Identifying Messages ............................................... 103
DPOWCTRL.EXE............................................................................ 104
Packet Drivers................................................................................. 105
Introductionto Packet Drivers....................................................... 105
Definition...................................................................................... 105
802.11-Compliant (DS and FH) Packet Driver Configuration...... 105
List of packet drivers................................................................... 105
Initialization file .......................................................................... 106
How to Load an 802.11-Compliant
(DS and FH) Packet Driver................................................................ 106
Packet driver requirements......................................................... 106
Classification of Devices.............................................................. 107
802.11-Compliant (DS and FH) Configuration Structure............. 108
Example ........................................................................................ 108
Packet Driver Loading Options...................................................... 110
Packet Driver Options List.......................................................... 110
PTC-2124 DOS Software Guide vii
Startup R eason Codes..................................................................... 112
Code List....................................................................................... 1 12
ARLAN Diagnostic Reason Codes.................................................. 114
List of Codes................................................................................. 114
WAND TSR Installation................................................................. 115
Bar-Code System............................................................................. 1 15
Bar Code....................................................................................... 115
Plessey (WNDCD01.EXE) ........................................................... 116
Universal Product Code (WNDCD02.EXE)................................ 116
Codabar (WNDCD 03. EXE).......................................................... 116
Code 39 (WNDCD04.EXE)........................................................... 117
Interleaved 2 of 5 (WNDCD05.EXE)........................................... 117
Code 128 (WNDCD07.EXE)......................................................... 118
Ames Code (WNDCD10.EXE) ..................................................... 118
Code 93 (WNDCD09.EXE)........................................................... 119
Code 16k (WNDCD12.EXE) ........................................................ 120
SuperCode (WNDCD13.EXE)...................................................... 120
WANDDRVR.EXE........................................................................... 122
Loading Wand Drivers ................................................................. 1 22
WANDT130.EXE............................................................................. 123
Command Line............................................................................. 123
Command Line Option:................................................................ 123
WNDCDxx.EXE............................................................................... 124
PCMCIA............................................................................................. 125
The PCMCIA Card.......................................................................... 125
Formatting an SRAM Card ............................................................ 127
Formatting an ATA Card................................................................ 127
Installing a PCMCIA Modem ......................................................... 127
PCMCIA Card System Software .................................................... 128
CNFIGNAM.EXE......................................................................... 129
PCFORMAT.EXE......................................................................... 129
HDFMT.EXE ................................................................................ 1 31
PCM.EXE ..................................................................................... 133
Editable Fields ............................................................................. 135
Advanced Information ................................................................. 1 37
Configure...................................................................................... 138
viii PTC-2124 DOS Software Guide
Edit Config Parameters............................................................... 141
Information................................................................................... 143
Card List....................................................................................... 143
Client Information ....................................................................... 1 45
Option........................................................................................... 146
PCMATA.SYS............................................................................... 1 47
PCMCS95.EXE............................................................................. 150
PCMSCD.EXE.............................................................................. 154
PCMSSIT.EXE............................................................................. 156
PCMAPM ...................................................................................... 157
DPMS.EXE................................................................................... 158
PCM.INI........................................................................................... 159
AUTOEXEC.BAT............................................................................ 161
CONFIG.SYS................................................................................... 161
Miscellaneous Utilities .................................................................. 162
GETID.COM.................................................................................... 163
ROWMGR.COM Version 1.0........................................................... 165
Rowmgr.com Overview ................................................................ 165
Command Line Syntax................................................................ 166
Installation................................................................................... 166
DOS INTERLNK.EXE.................................................................... 167
Overview....................................................................................... 167
Requirements............................................................................... 167
Configuring the Client................................................................. 1 68
Starting the Server ...................................................................... 169
Establishing a Connection Between Client and Server............. 1 70
Breaking the Connection Between Client and Server............... 170
TXRX.EXE....................................................................................... 171
TXRX File Transfer Utility Overview......................................... 171
Using TX RX.EXE......................................................................... 171
DOS Return Codes....................................................................... 173
Execution — Menu Driven .......................................................... 174
Execution — Us ing Configuration File ....................................... 176
Cable Requirements..................................................................... 177
PTC-2124 DOS Software Guide ix
WHICH.BAT.................................................................................... 1 78
USERAPP.BAT ............................................................................... 179
Accessories....................................................................................... 180
References ........................................................................................ 181
x PTC-2124 DOS Software Guide

PTC-2124 Overview

The PTC-2124 is a rugged AMD™SC400 processor-powered, pen-based Portable Teletransaction Computer (PTC). It couples standard PC tec hnology with Symbol’s expertise in data collection and radio technology to provide a flexible, high-performance portable system.
This section of the manual provides a basic overview of the PTC-2124’s software environment, including brief discussions of
•thesystemBIOS,
the operating system and applications,
the software kernel,
the PenRight! operating environment,
power management, and
software development kits (SDKs).
PTC-2124 DOS Software Guide 1
Chapter 3 Configuring TN-3270/5250

Functional Overview

The PTC-2124 uses a PC-type software architecture consisting of three major software layers:
•BIOS(Basic Input/Output System)
•OperatingSystem
Application

BIOS

Application
Operating Syst em
BIOS
Hardware
The BIOS is the lowest software layer and typically exists i n ROM memory. It provides basic input/output services for the system and an insulating interface between the upper software layers and the hardware layer.
The PTC-2124 uses a customized version of the Phoenix™ BIOS to support PTC-2124 hardware features. To achieve this level of support while maintaining PC compatibility, a system extension called the Sym bol BIOS, or TBIOS, is used.
TBIOS is a method for expanding the BIOS functions without reserving a function number that could be used by another application. This is accomplished by forcing the TBIOS code to r eside with standard BIOS code, but by providing a differententry point t o the TBIOS. The entrypoint is defined by the contents of a static lo cation in the BIOS Compatibility Area (COMPAS).
2 PTC-2124 DOS Software Guide
Functional Overview

Operating System

The operating system provides additional h igher-level services to the Application Layer and uses the BIOS interface for performing hardware functions. By using standardized BIOS interfaces , the PC architecture supports standard operating systems. The PTC-2124 supports the MS-DOS 6.22 operating system.

Application

The application is the highest software layer and provides controlling sof tware programs for the unit.
PTC-2124 DOS Software Guide 3
Chapter 3 Configuring TN-3270/5250

Other Software Components

Software Kernel

The softwarekernel is a simple program loader that is used to reprogram the PTC-2124 Flash PROM memory areas.

PenRight! Operating Environment

PenRight! is a graphical application development tool used to create forms containing objects such as buttons, l ist boxes, and writing fields for pen-based computers. These objects are activated with a stylus pen, which may be used to select options, highlight items, enter strings of characters, or en ter a s ignature on a digitized screen.
PenRight! applications are DOS progra ms that are driven by events. Each depression or release of the stylus on the digitized screen triggers a particular type of programmed action.

Power Management

Power management is a necessity for ba ttery-operated devices such as the PTC-2124. The unit is designed to incorporate battery-saving p ower management functionsdirectlyintothe unit hardware and s oftware architecture. The platform hardware incorporates features t hat allow most internal elements to be slowed down or deactivated. Together, the hardware and software constantly monitor system activity and implementpower management activity states that are used for power management functions.
4 PTC-2124 DOS Software Guide
Other Software Components

Software Development Kits

Symbol provides application development tools in the form of Software Development Kits (SDKs) to help developers design application programs for the SC4 00 product family. The SDK is a collection of run-time libraries and TSRs that assist in the development of C application programs on PC-compatible computers. Once an application program is developed, it may be copied to a PCMCIA card and in serted into th e PTC-2124 to load or run the app lication.
Note: If converting applications from a PTC-1124,
any portion of the applicationsoftware that directly manipulates the SLC (PTC-1124) hardware will have to be rewritten before it will work on the PTC-2124. The internal architecture of the PTC-2124 is not compatible with SLC. Any software (BIOS, drivers, or applications) that manipulates hardwaremust be written specificallyforthe PTC-2124.
PTC-2124 DOS Software Guide 5
Chapter 3 Configuring TN-3270/5250
The PTC-2124 DOS unit is available in a wide variety of configurations.
This section will cover the configuration options for the following devices:
•Radio,
RAM,
•ROM,
•Storage,
PCMCIA Slots,
•Displays,
•IrDA,

PTC-2124 Unit Configurations

Ethernet, and
•DCDDevices.
6 PTC-2124 DOS Software Guide

Radio Options

Radio Options

Batch

A batch unit does not have an antenna c able integrated in the unit. It is still possible to install a radio in the unit by way of the user accessible PCMCIA slots. However, an antenna must be installed on the radio. Either of the PCMCIA slots may be used for a radio c ard.

LAN Radio Ready

The radio ready unit has an RSMA antenna cable integratedintotheunit.Theendofthecableroutes through the unit to the externally accessible PCMCIA slot do or . A radio may be installed into PCMCIA Slot 0 (closest to the display) or in PCMCIA Slot 1 (slot farthest from the unitsdisplay).

WAN Radio Factory Installed

When ordered with a WAN radio such as a DataTac or Mobitex network radio, the radio mo dule is installed internally in the unit. Because these radio types are not PCMCIA form factor, they require additional spacein the unit. The unit thereforehas a deeper backshell than non-WAN-radio-equipped units.
PTC-2124 DOS Software Guide 7
Chapter 3 Configuring TN-3270/5250

Memory

RAM
The PTC-2124 has RAM configurations of 4, 20, 36, or 64 MB on the CPU board. When the 16- and 32-MB memory modules are added, the 4 MB is included. The 64-MBconfigurationactually contains68 MB of RAM, but the SC400 is able to address only 64 MB and the 4 MB on the CPU board is disabled.
ROM
The PTC-2124 comes with 512 KB of ROM, which contains the BIOS for DOS.

Storage Options

ATA
The PTC -2124 supports ATA drives, both solid state and rotating. ATA Type II cards may be used in either of the user accessible PCMCIA slots. Symbol offers factory installed card options of 60, 110, and 175 MB.
The 520-MB rotating ATA disks (any Type III) are installed in PCMCIA Slot 0.

SRAM

The PTC-2124 also supports SRAM (static RAM) cards. Generally, these cards are used for special purposes like reloadin g the ROM images (Genesis procedure) or booting the unit, r ather t han data storage because the capacities are rather low 1, 2, and 4 MB. However, these cards may also be used by the application for data storage.
8 PTC-2124 DOS Software Guide

PCMCIA Slots

Compact Flash

The PTC-2124 has an internal Compact Flash ad ap ter which is a standard 50-pin port that supports a variety of Compact Flash module sizes.
PCMCIA Slots
The PTC-2124 has two PCMCIA slots that are user accessible. These external slots are controlled by an Intel PCMCIA controller.

External Slots

Slot 0
This is the card slot closest to the display.
Slot 1
This is the card slot farthest fro m the display.

Display

The PTC-2124 is designed with a 4.7(11.9 cm) diagonal ¼ VGA screen offering 12 lines x 40 characters of text in DOS mode. The standard monochrome transflective LCD display offers 320 x 240 pixel resolution, 64 levels of gray, and an EL backlight. A scratch- and impact-resistant touch digitizer protects the display.
The PTC-2124 includes a transparent, resistive-touch digitizer mounted above the LCD display. The digitizer is designed to support both stylus and finger activation and incorporates a minimal amount of palm rejec tionto helpminimize hand contact. It also uses transparent ma terial and will not interfere with the LCD display.
PTC-2124 DOS Software Guide 9
Chapter 3 Configuring TN-3270/5250

IrDA

The PTC-2124 supports an IrDA 1.0 port loc ated on the right side of the unit that pr ovides an optical serial communication interface. The IrDA communication port uses an infrared (IR) light beam to support a half-duplex, point-to-point communication link with a peripheral device.

Ethernet

The PTC-2124 supports Ethernet communications using a full 16-bit controller to provide a high-speed Ethernet interface via the cradle c ontacts for transmit and receive operation at 10 Mbps.

DCD Devices

Auto ID devices are attached to the 30-pin Scanner/Expansion moduleat the top of the unit.

Scanners

The PTC-2124 supports an optional laser scanner module. Using an attached laser scanner, the unit may be programmed to recognize, read, and discriminate automatically a mong six 1D barcode types. For instructions on using a laser scanner module, refer to the PTC-2124 User’s Guide.
10 PTC-2124 DOS Software Guide

PTC-2124 Assignments

This section provides information on the following PTC-2124 com p o ne nts:
Resource Map,
Hardware Interrupts, and
COM Port Assignments.
PTC-2124 DOS Software Guide 11
Chapter 3 Configuring TN-3270/5250

Resource Map

PTC-2124 c omponents are assignedvarious address ranges within s ystem memory.

Memory Allocation Table

PTC-2124 m emory is allocated as follows:
Address Size Resource Comments
000000-09FFFF 0A0000-0BFFFF 0C0000-0C7FFF 0C8000-0C9FFF 0CA000-0CBFFF 0CC000-0CCFFF
0CD000-0CDFFF
0CE000-0CEFFF
0CF000-0CFFFF
0D0000-0DFFFF 0E0000-0EFFFF
0F0000-0FFFFF 100000-xxxxxxxx
640 KB Base Base Memory
h
128 KB Video Video Display Frame Buffer
h
32 KB Video VGA BIOS ROM
h
8 KB ASIC SharedRAM area for ASIC
h
8KB -- Unused
h
8 KB PCMCIA/UMB PCMCIA Window or Upper
h
8 KB PCMCIA/UMB PCMCIA Window or Upper
h
8 KB PCMCIA/UMB PCMCIA Window or Upper
h
8 KB PCMCIA/UMB PCMCIA Window or Upper
h
64 KB UMB Upper Memor y Block
h
64 KB UMB Upper Memor y Block
h
64 KB BIOS System BIOS (shadowed)
h
>1 MB EMS Extended Memory
h
Memory Block
Memory Block
Memory Block
Memory Block
(reserved)
12 PTC-2124 DOS Software Guide

Hardware Interrupts

Hardware Interrupts
Knowledge of hardware inte rrupt ass ignments will be useful for making system configuration decisions.

Interrupt Table

PTC-2124 hardware is assigned to the following interrupts (IRQs):
H/W Interrupt PC/AT Usage PTC-2124 Usage Notes
IRQ 0 Timer 0 Timer 0 IRQ 1 Keyboard Keyboard IRQ 2 IRQ(15:9) Cascade IRQ(15:9) Cascade IRQ 3 COM 2 COM 2/4 COM 2 = User Port
COM 4 = WAN Radio
Serial Port IRQ 4 COM 1 COM 1 IrDA Port I/F IRQ 5 LPT 2 IRQ 6 Floppy Disk IRQ 7 LPT 1 LPT 1 IRQ 8 RTC RTC Alarm IRQ 9 PCMCIA Open for PCMCIA
IRQ 10 Ethernet IRQ 11 PCMCIA Open for PCMCIA
IRQ 12 Mouse Digitizer IRQ 13 Math Exception ASIC IRQ14 HardDisk IDEATASSHardDisk IRQ 15 PCMCIA Open for PCMCIA
PTC-2124 DOS Software Guide 13
devices
devices
devices
Chapter 3 Configuring TN-3270/5250

COM Port Assignments

ThefollowingarethedefaultCOMPortsettingsfor the PTC-2124:
COM1: IrDA,
COM2: 15 pin serial or cradle serial ports,
COM3:Scanner,and
COM4: WAN radio.
14 PTC-2124 DOS Software Guide

Boot Options

The PTC-2124 uses a customized version of the Phoenix BIO S (Basic Input/OutputSystem) that supports PTC-2124 features. Because the BIOS interfaces with the hardware, it must be aware of the physical devices present in the system. This section provides information on the following:
The behavior of the BIOS at boot-up,
Changing the BIOS settings,
Changing the boot source,
Drive letter mapping,
Reflashing the BIOS, and
Resetting/Re booting the PTC-2124.
PTC-2124 DOS Software Guide 15
Chapter 3 Configuring TN-3270/5250

POST

In PC-base d systems, afte r a boot, the BIOS is responsible for testing and initializing all hardware components and boot loading the operating system into memory. This process is known as the Power-On Self Test, or POST.

What Happens During POST

During the POST process, messages must be generated for the system. The POST, initializations, and messages are customized for the PTC-2124.
Once the POST operations are complete, the BIOS loads the operating system. Once a bootable disk is found, the boot loader is loaded into memory and executed. If no bootable disk i s found, the system displays the message: No Boot Device Available.
16 PTC-2124 DOS Software Guide

Changing BIOS Settings

Changing BIOS Settings
There are many settings in the BIOS of the PTC-2124 that you would expect to see in a desktop computer system. Once set, the BIOS settings generallydo not have to be returned to the previous settings.
To access the BIOS settings, attach a physical keyboard to the PTC-2124. During the memory test portion of the POST process, press F2.Upon completion of t he memory test, the system will grant access to the BIOS setup menu.
Listed below are several of the settings that can be accessed from the B IOS setup screen.
Power M ana gement
There are four operational states for the PTC-2124: Ship, Full Run, Standby, and Suspend. For more Power Management information, see “Power
Management St ateson page 31.
Boot Source
This determines which drive is used to boot the system.
CPU Speed
There are three possible settings: 33, 66, and 100 MHz. The default is 100 MHz.
Note: The systems contrast and brightness
controlsbecomedisabled when in the BIOS setup mode.
PTC-2124 DOS Software Guide 17
Chapter 3 Configuring TN-3270/5250

Boot Sources and Drive Letter Mapping

Normal Boot

Under normal conditions, t he u nit boots from the internal Compact Flash card and loads Card and Socket Services to support SRAM and ATA cards.
Drive Letter Assignments when Booting from a Compact Flash Card
Installation Slot Drive Letter
Compact Flash C
0D 1E
Note: If Card and Socket Services are not
loaded, the unit will not have access to SRAM or ATA cards.
18 PTC-2124 DOS Software Guide
Boot Sources and Drive Letter Mapping

Booting from an ATA Card

To prepare an ATA Card for booting the system, perform the following steps:
1. The ATA Card must be formatted first. The HDFMT utility located in the /DOS directory on the unit may be used for this. This command is identical to the MS-DOS FORMAT.COM utility. For more information, refer to the section titled
Formatting an ATA Cardon page 127.
2. Copy the MS-DOS operating system files onto the unit. This may be done by running the MS-DOS SYS.COM utility.
To boot from an ATA Card, perform the following steps:
1. Remove the Compact Flash card from the CF slot inside of the unit.
2. Install the ATA car d into PCMCIA Slot 0 (closest to display).
3. Restart the unit.
4. Press F2 during POST to enter CMOS Setup.
5. Arrow down to access the Embedded Fea tures screen.
6. Ensure that the PCMCIA ATA option is enabled.
7. Reboot the system.
Note: Do not attempt to load Card and
Socket Services when booting from an ATA card.
PTC-2124 DOS Software Guide 19
Chapter 3 Configuring TN-3270/5250
Drive Letter Assignments when Booting from an ATA Card
Installation Slot Drive Letter
Compact Flash
Not Installed
1
0C 1
1
CF Car d must be removed.
2
Card and Socket Services cannot be loaded. Doing so will cause the unit to lock up
Not Supported
2
.

Booting from an SRAM Card

The PTC-2124 may be configured to boot from an SRAM card instead of its internal Compact Flash Card. This is similar to booting a desktop PC from a floppy disk.
Note: When an SRAM Card is used as the
boot source, it must remain in the PCMCIA slot. Do not attempt to remove it.
For an SRAM Card to be recognized pr operly by the unit, it should be a 1-, 2-, or 4-MB SRAM Card with No-Attribute Memory. SRAM Cards with Attribute Memory ma y not be recognized properly by the unit at boot up.
Note: Do not attempt to load Card and
Socket Services when booting from an SRAM card.
20 PTC-2124 DOS Software Guide
Boot Sources and Drive Letter Mapping
To prepare an SRAM Card for booting purposes, perform the following steps:
1. The SRAM Card must first be formatted properly. To do this, the PCFORMAT utility in the PCM directory may be used. For more information on PCFORMAT, refer to the section titled “Format-
ting an SRAM Cardon p age 127.
2. Copy the MS-DOS operating system files onto the unit. This may be done by running the MS-DOS SYS.COM utility.
To boot from an SRAM Card, perform the following steps:
1. Insert the SRAM Card into Slot 0 (closest to the display).
2. Restart the unit.
3. Press F2 during POST to enter CMOS Setup.
4. Arrow down to access the Embedded Fea tures screen.
5. Ensure that the [ROM/RAM Disk 0] option is set to [PCMCIA].
6. Reboot the system.
PTC-2124 DOS Software Guide 21
Chapter 3 Configuring TN-3270/5250
Drive Letter Assignments when Booting from an SRAM Card
Installation Slot Drive Letter
Compact Flash C
0AorB 1
1
Card and Socket Services cannot be loaded. Doing so will cause the unit to lock up
Not Supported
1
.
Note: There is a possibility of a boot error if all video modes are not calibrated. As the PTC-2124 bo ots up, tapping on the screen as the config.sys, autoexec.bat, user_boot.bat, or application is loading may produce one of the following errors:
Run-time error R6002 integer divide by 0.
Divide overflow memory allocation error.
Divide overflow.
Should on e of these errors oc cur, it may be corrected by performing the following steps:
1. Delete TMOUSE.INI in the mouse directory.
2. Reboot the unit and allow it to go into the calibration mode.
3. Calibrate all video modes.
4. Save and Exit.
5. Reboot the unit.
22 PTC-2124 DOS Software Guide

Reflashing the BIOS

Reflashing the BIOS

TFLASH Utility

The TFlash utility is a DOS command line program that will reflash a system BIOS image into the unit. To use this program:
Step Action
Copy the binary ROM image of the BIOS to
1
be flashed to the directory in which the tflash.exe resides.
Boot the unit into D OS protected mode (perform a cleanboot with NO MEMORY MANAGER LOADED). This may be done
2
by using a keyboard and pressing F5 or by renamingthe config.sys and autoexec.bat files (i.e., config.old, autoexec.old,etc.).
Type TFlash <name>
3
(<name>=new BIOS ROM Image name)
4PressENTER.
When the flash process is complete, restart the unit. If the unit displays a blank screen without restarting, or if the restart message is not displayed, the unit should be reset by pressing the Reset but to n and then the Resume button. The unit is now operable with the new BIOS image.
Note: No crisis modeis associated
with this utility. If a failure occurs during the flash process, the process must be repeated in its entirety.
PTC-2124 DOS Software Guide 23
Chapter 3 Configuring TN-3270/5250
The TFLASH utility can also read the BIOS image from ROM and write it to disk. The command line option for this is:
Tflash romimage.bin –r8000
-r8000 is the memory location for the bios. The resulting file size should be 256 KB.
Complete usage for TFLASH is:
ex1:TFlash<Filename>[-o<offset>] ex2:TFlash<Filename>[-r<length>][-o<offset>] ex3: TFlash [-e<length>] [-o<offset>]
Where:
-o <offset>,default=0,frombaseofROM.
-r Reads<length>bytes, default=512k,fromROMinto afile.
-e Erases <length> bytes, default=512k, ROM area to all FFs.
24 PTC-2124 DOS Software Guide
Reflashing the BIOS

Automatic Genesis Flash

Perform the followingprocedure to re-flash the BIOS of a PTC-2124. Note that this procedure may also be used to force the PTC-2124 to boot from a bootable SRAM card in PC MCIA Slot 0.
To perform an Automatic Genesis Flash, follow these steps:
Step Action
1 Insert the Genesis formatted SRAM card
into Slot 0. 2 Turn on the PTC-2124. 3PressandholdtheBacklight button. 4PressandholdtheResume button. 5 Release the Backlight button. 6 Press and release the Backlight button. 7 Release the Resume button. 8 The Status light will start to flash and the
backlight will turn on. The unit will then
beep about 15 – 20 times to indicate that the
BIOS is being reloaded. 9 After the unit stops beeping, remove the
SRAM card from Slot 0.
10 Perform a Warm Boot on the unit.
PTC-2124 DOS Software Guide 25
Chapter 3 Configuring TN-3270/5250

Resetting/Rebooting the PTC-2124

There are several ways to reset the PTC-2124. It should be noted that removing the battery will not reset th e PTC-2124. The bridge battery maintains all pointers and memory such that when th e battery is reapplied to the unit, the unit will resu me ope rations at the point at which the po wer was removed.

Cold Reboot

Use the following procedure to perform a Cold Reboot. It powers off the PTC-2124 and puts it into ship mode. Turning on the unit at this point (pressing the Resume button) will reinitialize the PTC-2124.
Step Action
1 Remove the battery. 2 Locate the metallic Reset button located
underneath the batte ry.
3 Use a thin, insulated device (such as a plastic
coffee stirrer) to press the Reset button. 4 Replace the battery. 5PresstheResume button.

Console Reboot

The following Console Reboot procedure stops the PTC, resets it, then restarts (boots) it. This procedure erases all programs and data stored in RAM. When the PTC restarts, it returns to the operating system.
Step Action
1 Turn on the PTC-2124. 2PressandholdtheContrast button. 3PressandholdtheResume button.
26 PTC-2124 DOS Software Guide
Resetting/Rebooting the PTC-2124
Step Action
4 Release the Contrast button. 5 Press and release the Contrast button. 6 Release the Resume button.
PTC-2124 DOS Software Guide 27
Chapter 3 Configuring TN-3270/5250
APM
As b attery conservation measures are dependent upon user operations and preferences, the PTC-2124 al lows the user application program to direct and control Power Management operations via the industry standard Advanced Power Management (APM) software interface. This interface is defined by the APM Interface Specification which is currently at Revision Level 1.2. The platform software uses the APM functions and states to p lace the PTC-2124 into the appropriate platform Power Management Activity State.
To support the APM interface in the PTC-2124, Symbol enhanced the APM BIOS functions supported in the Phoenix BIOS from APM revision 1.0 to 1.2. The APM BIOS functions manage power in the background on the basis of device activity, and are specific to the PTC-2124 hardware platform. The APM BIOS is the software interface to the PTC -2124 platform and its power managed d evices and components. This interfaceallows software applications to take an active part in managing the power consumed b y the PTC-2124 unit.

Power Management

28 PTC-2124 DOS Software Guide

Monitoring

Monitoring
When full power management is enabled, system activity is monitored at two different levels. Th e APM Driver software monitors the frequency of certain interrupts, and the APM BIOS monitors the hardware activity directly. Both w ork together to inform APM-aware applications, Device Drivers, and TSRs about power management events and conditions. The PTC-2124 a llows all elements to work together to conserve power.

APM Driver

POWER.EXE

For MS-DOS environments, Symbol provides an APM Driver module, power.exe, which connects to the APM BIOS and controls power management policy via function calls to the APM software interface. This DOS drive r was modified by Symb ol to provide a specific inte rface to the PTC-2124 pen-based computer. Power.exe is a terminate and stay resident (TSR) driver that must be loaded into the config.sys file .

Command Line Parameters

The following is a description of the power.exe command line parameters. The curren t settings are always displayed when invok ing power.exe from the command line.
power [/option]
Options:
PTC-2124 DOS Software Guide 29
/SUSPEND XXXX
This parameter sets the amount of time that the unit will be in the Standby statebeforeentering Suspend. There are only 8 valid settings for this parameter. T hey are 0 (disable), 64, 128, 256, 512, 1024, 2048, and 4096 seconds. Any value of 1 – 4096 entered will be rounded off t o the nearest valid va lue. A paramete r value of 4097 or higher will cause an Invalid Parameter error.The default setting for this parameter i s 16 minutes.
Chapter 3 Configuring TN-3270/5250
/STANDBY XXXX
This parameter sets the amount of time during which the unit will be in the High Speed state before entering Standby. There are only 8 valid settings for this parameter. The y are 0 (disable), 8, 16, 32, 64, 256, 512, and 1024. Any value of 1 – 1024 will be roundedofftothenearestvalidvalue.Aparameter value of 1025 or higher will cause an Invalid
Parameter error. When Standby is disabled, the Suspend t imer never starts. Therefore, disabling Standby effectively disables Suspend. The default
setting for this parameter is 32 seconds.
/ADV:[MIN:MAX:REG]
This parameter means that power.exe has enabled and connected to the APM BIO S. It monitors hardware an d applications, then reduces power consumption where possible. The MIN, MAX, and REG parameters are optional. MIN conserves the least power, MAX conserves the most power, and REG gives averagepower conservation. The default setting for this parameter is REG.
/STD
This parameter means that power.exe will enab le the APM BIOS, but it will disconnect. Therefore , power.exe will not poll for APM ev ents.
/OFF
This parameter means that power.exe disables the APM power managem ent.
Note: A help message may be called by
entering POWER /?.
30 PTC-2124 DOS Software Guide

Power Management States

Power Management States
There are four operational states for the PTC-2124: Ship, Full Run, Standby,andSuspend.
State Description
The unit is completely powered off. The resume key must be pressed to power-up the unit.
Ship
Full Run
Standby
Pressing the metallic Reset Button located underneath the battery puts the unit into this mode.
The system CPU and devices are fully awake and functional also referred to as being fully operational.
A state generated by software-controlled timers and lack of activit y on monitored buses. While in the Standby state, the unitspowerusageis reduced by up to 50%, and the unit is able to process many functions at a reduced rate (8 MHz).
A state in which the system further reduces the power consumption from Standby mode. There are several suspend options that are controlled by the BIOS or device drivers. Most of the state
Suspend
PTC-2124 DOS Software Guide 31
changes that occur to get into Suspend are due to lack of activity of devices. While in the Suspend state, the unitspowerusageis reducedbyupto90%;however,theunitis functionally deactivated until it is reawakened.
The PTC-2124 allows the user to help conserve power directly via the Suspend/Resume feature. This feature allows the user to place the uni t into Suspend state by depressing the Resume switch on the unit's top cabinet. This deactivates the unit and most internal hardware elements. The user may reactivate the unit by pressing the Resume switch again.
Chapter 3 Configuring TN-3270/5250
Additionally, the PTC-2124 p rovides a Standby T imer, which specifies the inactive time before automatically entering the Standby state and deactivating most internal elements. The system default setting for this timer is approximately 32 seconds. During this period, the unit may be reactivated via the Digitizer or the Resume switch. Once the unit enters Suspend state, the Digitizer will no longer wake the unit.

Magic Packet Mode

Another feature of the PT C-2124s power management is the ability to enable the Magic Packet Wake-Upmode(MagicPacketisanE-Wakeutility developed by AMD) when the unit is docked in a cradle and in the Suspend state. Magic Packet mod e provides the ability to wake up the unit remotely by using the Ethernet connection established through thecradle.Thisallowstheunittobeaccessed remotely and managed even if the Suspend state has been entered. The Magic Packet feature does not require that a software network driver be loaded in the unit.
When the uni t is put manually into the Suspend state (while docked in a cradle), the Ethernet controller will automatically en able Magic Packet mode. While in the Magic Packet mode, the unit will monitor all incoming frames to determine whether any of them is a Magic Packet frame. A Magic Packet fram e is a unit of data that is sent by a network manager, via Ethernet connection, from a remote site with the intent to wake up the unit. When a Magic Packet frame is received and detected, the Ethernet controller will wake up the unit and disable the Magic Packet mode. The unit then returns to Full Run state, regaining full functionality, including network accessibility.
32 PTC-2124 DOS Software Guide
Power Management States

Features of Power Management in the Standby State

While in Standby, the PTC-2124 has the following features:
Power usage is reduced (up to 50% savings).
Processor speed drops to 8 M Hz.
Display is turned off and all other devices remain
on.
The following conditions will prevent the unit from entering the Standby mode:
IrDA drivers loaded.
Cradle Ethernet link with CradTSR loaded.
Scrnblnk utility loa ded.
The follo wing table illustrates wake sources used to bring the PTC-2124 out of Standby mode:
Wak e So ur ce Comment
Touch/Digitizer
RTC Alarm
Dock/Undock
Keyboard
Resume Button
PTC-2124 DOS Software Guide 33
Unit wakes when the digitizer registers a touch.
Unit wak e s when a Real Time Comparator Alarm is initiated.
Unit wakes when it is connected to or disconnected from a cradle.
Unit wakes with input from a keyboard tha t is attached to a cradle.
Unit wakes when the Resume Button is pressed.
Chapter 3 Configuring TN-3270/5250

Features of Power Management in the Suspend State

While in the Suspe nd mode, the PTC-2124 takes on the following conditions:
Power usage is reduced (up to 90% savings).
Processor speed drops to 8 M Hz.
All devices are turned off, except for non-
Ethernet is in Low Power.
The following conditions will prevent the unit from entering the Suspend mode:
IrDA drivers loaded.
LAN radio and drivers loaded.
Cradle Ethernet link with CradTSR loaded.
Scrnblnk utility loa ded.
The fo llowing table illustrates wake sources used
PCMCIA-based WAN r ad ios.
to bring the PTC-2124 out of the Suspend mode:
Wake S ou rc e Comment
User Serial Port
Cradle Serial Port
WAN Unit wakes i n response to a Ring Indicator. Ethernet Unitwakes in response to E-Wake. Dock/
Undock Resume
Button
34 PTC-2124 DOS Software Guide
Unit wakes in response to a Ring Indicator.
Unit wakes in response to a Ring Indicator.
Unit wakes when it is connected to or disconnected from a cradle.
Unit wakes when the Resume Button is pressed.

SC 400 Power Control Flow

Unit Is Running
SC 400 Power Control Flow
Yes
Yes
No
Any Activity Within
StandbyTime-out
Parameter?
No
Is
CradTSR Loaded and
Unit Docked/On An
Ethernet Link?
No
System Standby
Request Is Processed
Does Unit Go Into
Standby Mode?
Suspend Button Is
Suspend Request
No
Pressed
System/User Is Processed
UnitGoes Into
Suspend Mode
No
Is Wake
Source
Initiated?
Yes
Yes
PTC-2124 DOS Software Guide 35
WakeUpWithin
Suspend Time-out
Parameter?
Yes
Unit Resumes
Running
Chapter 3 Configuring TN-3270/5250
The PTC-2124 provides support for Symbol d rivers. Supported Symbol dr ivers a re described in the following sections.

Driver Support

36 PTC-2124 DOS Software Guide

Cradle Overview

Cradle Information

Cradle Overview
The Symbol PTC-1124 Desktop/Vehicle Cradle is a specialized docking station that is used for the PTC-2124. The cradle provides the following services:
External Serial Port Connection,
Battery Recharging Connection,
External Ethernet Connection, an d an
External Keyboard Connection.
The SC-1124 is designed for use on a flat horizontal surface, suc h as a t able or desk. The VC-1124 mounts securely inside a vehicles cab (using a vehicle mount).
Each cradle holds one PTC and o ne spare battery pack at a time and works with the PTC in two ways:
1. It acts as a communication link. Through the cradle, the PTC can send data to and receive data from a host computer or other serial devices.
2. The cradle provides power for rapidly recharging the PTCs lithium-ionbattery pack and a spare battery pack when the PTC and the spare pack are ins talled in the cradle .
The cradle may be connected via cable to a network throughits Ethernetport or to externalserial devices via its three 9-pin RS-232 serial ports. In addition, a keyboard can be connected to the cradle for use with the installed PTC.
PTC-2124 DOS Software Guide 37
Chapter 3 Configuring TN-3270/5250
Cradle COM1 Outlet COM2 Outlet

PTC-2124 Cradle Interaction

The PTC-2124 has only one COM port available for use by peripherals. Th e PTC-2124 uses an electrically controlled serial switch-box wit h a 9-wire interface to provide additional serial ports for this singleCOM port.
The PTC-2124 provides IrDA on COM1 and wired serial on COM2. An infrared sensor on the PTC-2124 provides the IrDA outlet. A ConnectorPod on the PTC-2124 pr ovides the serialoutlet.
The following table summarizes the possibilities for a PTC-2124. When out of the cradle, C OM1 is availabl e as IrDA and COM2 is available through an attached Connector P o d. When docke d, COM1 is available as IrDA and COM2 is rerouted to one of the three DB-9 serial connectors.
Undocked IrDA on PTC-2124 Connector Pod on PTC-2124
Docked IrDA on PTC-2124 DB-9 on cradle
PTC-2124 Plugged Into A Cradle
Power
Connector
1124 Cradle
RS232 DB-9
Transceivers
13-Pin
RS232
Transceivers
RS232
Transceivers
(Port 1)
DB-9
(Port 2)
DB-9
(Port 3)
PTC-2124
Conn Pod (COM2)
IrDA
(COM1)
38 PTC-2124 DOS Software Guide
PTC-2124 Cradle Interaction

Cradle Serial Interface

Thecradleserialinterfaceisimplementedusinga communication chip and cradle electronics to create four multiplexed RS232 serial ports: one internal port and three external ports. Since the serial ports are multiplexed, only one port may be active at a time.
Serial Port 1 DB9 Connector (Male Pins). Serial Port 2 DB9 Connector (Male Pins). Serial Port 3 DB9 Connector (Male Pins). Control Port No Connector, Internal to unit. ThesameCOM2PortisusedforboththeVehicle/
Desktop-1124 Cradles Serial Connectors and the serial port in the PTC-2124 units Connector Pod. Therefore, only one COM interface may be used. When the PTC-2124 is placed in a cradle, the cradle’s serial ports can be used if the units application program uses the cradle serial routines from the PTC­2124 SDK (refer to the PTC-2124 SD K for software details).
Note: When the connector Pod is connected,
the Serial c onnection is a 4-wire implementationonly. When attached to a cradle, the active port is a full 9-wire serial port implementation.
PTC-2124 DOS Software Guide 39
Chapter 3 Configuring TN-3270/5250
The Optical Serial Signals use the cradle contacts on the PTC-2124 unit as shown below:
In the Optical Serial Interface, two lines are used to receive and tran smit data and two lines are used as status lines. The two status line s (OTXS#, ORXS#) provide communication status information via Time-Division-Multiplexing. In this technique, the status information is embedded in the status dat a of each line.
The Status Word, like a normal Data Word, begins with a Start Bit and ends with a Stop b it. H owever, the Status Word uses three Stop bits to provide an easy identification of the end of the word.
Pin Signals Description
1 OTXD Optical Transmit Data 2 ORXD Optical Rec e ive Data 3 OTXS# Optical Transmit Status 4 ORXS# Optical Rec eive S tatus
The Status Lines operate at a 38.4 KBP S data rate, where as the Data Lines operate at the rate programmed for the internal communication chip UART controllingthe Serial Port. The Serial communication chip UART can be programmed to support the following standard communications functions:
Data Rate 75 to 115.2 Kbps.
Parity Even, Odd, None.
DataWidth5,6,7,or8bits.
Stop Bits 1 or 2.
40 PTC-2124 DOS Software Guide
PTC-2124 Cradle Interaction

DTR and RTS Latching

The Vehicle/Desktop-1124 Cradle provides DTR an d RTS latching on Serial Port 3 to prevent the connected device from dropping the communication link with the PTC-2124. Prior to switching to another Serial Port, the cradle will latch the DTR and RTS lines at their cur rent levels. For example, if the signal is currently high, the line will be latched high, or if the signal is currently low, the line will be latched low. This feature is particularly useful when connecting to devices such as WAN radios.

Ring Indicator

To allow the Ring Indicator (R I) signal to reach the PTC-2124 unit fr om any serial port (active or not), the RI signals from all Serial Ports are logically Ored together. The RI signal can be used to wake the PTC­2124 unit from the Standby or Suspend modes.

DB-9 Serial Connector Pinout

The pinout of the RS232 port DB-9 (male pins) connectors are as shown in the tables below:
Pin Signal Pin Signal
1CD 6DSR 2RXD 7RTS 3TXD 8CTS 4DTR 9RI 5GND

Ethernet Port

PTC-2124 DOS Software Guide 41
Chapter 3 Configuring TN-3270/5250
The 10 Mbps Ethernet Port is available via an RJ-45 connector. The Ethernet Port is located on t he r ight side of the cradle and interfaces to the Cradle Contacts. Th e cradle RJ-45 port will be wired as DCE accepting a standard male LAN cable. The Ethernet RJ-45 connector pin out is as follows:
PIN SIGNAL PIN SIGNAL
1TXD+ 5 NC 2TXD- 6 RXD­3RXD+ 7 NC 4NC 8 NC
Note: The Ethernet Port is located on both the
Desktopand the Vehicle configurations; however, the port will typically be used only in a Desktop configuration.
42 PTC-2124 DOS Software Guide
PTC-2124 Cradle Interaction

Keyboard Port

The Vehicle/Desktop-1124 Cradle supports an external PS/2 K eyboard Port which is locatedon the right side of th e unit. The PS/2 Keyboard Port supports the following connector pinout:
Pin SIGNAL DESCRIPTION
1 KB_DATA Keyboar d Data 2 N/C Not Connected 3GND Ground 4 5VSW Keyboard Power (+5 VDC) 5 KB_CLOCK Keyboard Clock 6 N/C Not Connected
Note: Permanent Keyboard damage may
occurif the user connectsordisconnects the keyboard from the cradle's keyboard connector while the unit is docked, unless the unit is suspended first.
PTC-2124 DOS Software Guide 43
Chapter 3 Configuring TN-3270/5250

Crad TSR Overview

CradTSR is a Terminate and Stay Resident (TSR) program which controls how the PTC-2124 operates while in a cradle.
Specifically, CradTSR do es the following:
Interacts with the units on-board Ethernet
Rejects APM system Standby and Suspend
Reroutes COM2 from the DB-15 on the bottom of
Configures the baud rate, parity, and stop bits on
Provides cradle status information to user
controller to enable the controller when the unit is in the cradle and disables the controller when the unit is out of the cradle.
requests if Ethernet link activity is detected.
the unit to one of the two serial ports on the cradle.
the three serial ports on the cradle.
applications via API calls.
This section discusses in general what happens when CradTSR is invoked, both for the first time and at subsequent times.
For more information on Ethernet functions within CradTSR, see the section titled “Cradle TSR
Functionon page 52.

Invoking CradTSR

When CradTSR is invoked for the first time after a reboot, it queries the Symbol BIOS e x tensions to determinethe model of PTC on which it is running.If it finds any model other than the one it is designed for, it exits.
44 PTC-2124 DOS Software Guide
Crad TSR Overview

Specifying Interrupt Vector

There is no need to specify the software interrupt vector used for communicating with the TSR. CradTSR has been assigned vector 0 x 63 and uses that by default. Optionally, one can override this value using the /V option. Additionally, one can specify the /S option, which will cause CradTSR to automatically locate a free vector by scanning the IDT between 0 x 060 and 0 x 06F.

Binary Interface of CradTSR

When CradTSR has already been loaded and is resident and CradTSR is invoked again, the command line optionsmay be used as a binary interface to the TSR. Many of the CradTSR SDK functions are exposed via the binary interface, including options for ch anging COM2 configuration options, querying current status, etc.
When CradTSR is invoked for the N N 1, it sear ches the software interrupt vector range looking for a preloaded version of CradTSR.Whenit finds one, it uses the CradTSR SDK interface to query its major and minor version numbers an d reports them to the user.
The argum ents /C2P, /C2C1, etc. may be used to alter the cu rrent settings of COM1 or COM2. If specified when the PTC-2124 is outside of the cradle, the change takes place immediately. If the PTC-2124 is in the cradle, the COM1 parameters are not immediately altered.
Besides the Device parameters, the /M argument may be used to monitor the in-cradle state, and the /Q argument will dump all of the Device settings and other state variables.
PTC-2124 DOS Software Guide 45
th
time, where
Chapter 3 Configuring TN-3270/5250

Command Line Arguments

This section describes specific command-line arguments available when invoking CradTSR.
When the CradTSR is invoked, the syntax is
Cradtsr [ options ].
There are more options available for the N
th
invocation (N 1) than for the 1st. In the table on the next pag e, options available only for later invocations are marked with the phrase if preloaded(meaning valid only if CradTSR is a lready loaded).
In this table, BR stands for a decimal baud rate between 300 and 115200. D standsfor the numberof data bits (5 – 8), and S stands for the number of stop bits (1 or 2). P stands for a parity c ode: E (even), O (odd), and N (none) are supported.
The -uoption for /C2P, /C2C1, etc. tells CradTSRto stop altering the syste m state to support the given configuration.
46 PTC-2124 DOS Software Guide
The table below provides a description of each option and specifies when each option is available.
Option Available: Description
Crad TSR Overview
/V:hexVec If n ot l oaded
Load the TSR at hex vector hexVec if available.
/? Always Print summary of command-line options.
/C2C1:BR,D-P-S Always
/C2C2:BR,D-P-S Always
/C2C3:BR,D-P-S Always
/DB1 Always /DB2 Always /DB3 Always
1
1
1
Setup of COM2 o n Cradle DB1 (whenincradle).
Setup of COM2 o n Cradle DB2 (whenincradle).
Setup of COM2 o n Cradle DB3 (whenincradle).
RouteCOM2toDB1whenincradle. RouteCOM2toDB2whenincradle.
RouteCOM2toDB3whenincradle. /M If pre-loaded Monitor in-cradle status. /Q If pre-loaded Query current configuration. /U If pre-loaded Unload the TSR (if possible). /C2C1: -u If pre-loaded Disable COM2 on Cradle DB1. /C2C2: -u If pre-loaded Disable COM2 on Cradle DB2. /C2C3: -u If pre-loaded Disable COM2 on Cradle DB3. /C2C1: +u If pre-loaded Enable COM2 on Cradle DB1. /C2C2: +u If pre-loaded Enable COM2 on Cradle DB2. /C2C3: +u If pre-loaded Enable COM3 on Cradle DB3.
1
Cradle port must first be enabled with one of the
[/C2Cx: + u] enable options
PTC-2124 DOS Software Guide 47
.
Chapter 3 Configuring TN-3270/5250

Purpose

The purpose of the TSR is to promote longer device life by turning off the video driver and backlight after a determined period of idle time has elapsed. Idle time is based on monitore d events.
SCRNBLNK is useful in situations in which the unit isnotallowedtogointosystemStandby/Request states (such as when there is an active Ethernet link on the cradle, or when a radio is installed in the unit).
The goals of the TSR are as follows:
Prolong the useful battery time,
Automatically resume processing upon events,

SCRNBLNK

and
Allow the user to easily select the time-out period.

User Interface Functions

The user interface is a standard DOS command line with options to reject Standby messages, specify the time-out period in seconds, unload the TSR, and use a selected vector:
scrnblnk /r /t[seconds] /u /v[vector].

Reject Standby (/r option)

TheusermaychoosetorejectStandby messages. This will prevent the unit from moving to Suspend from a power t imer.
48 PTC-2124 DOS Software Guide
User InterfaceFunctions

Time-out (/t option)

The user may change the time-out period by reentering the command line with a different time. The time-out period may be set to a value within the range of 1 – 3600 (seconds).
The user may disable the TSR by entering /t0 seconds for a time-out period.

Unload (/u option)

The user may unload the TS R and recover the memory if no vectors have been changed since the TSR was installed.

Vector (/v option)

Theusermaychooseavectorintherange60 through 6fhfor the TSR to use. If the vector is already in use, an error message will be displayed.
The user may access a usage screen by entering the argument /?.
h
PTC-2124 DOS Software Guide 49
Chapter 3 Configuring TN-3270/5250

TSR Internal Functions

The TSR has the form of a Finite State Mac hine (FSM). The events and states relationships are described below.

Events

The events that the TSR sensesare
Keypad through INT 75
Mouse through INT 33
Timer through INT 1C
h
chain.
h
chain.
h
chain.

INIT State

When Enter is pressed to end the command entry, the TSR enters the INIT state.If the TSR is not in memory, i t is loaded, and the state is changed to SBL_ON. If it is already in memory, a new time-out value may be enter ed, and the resident state remains SBL_ON.

SBL_ON State

The TSR monitors the 55 mSec clock to calculate its elapsed t ime. When the time-out period has elapsed and no event has occurred, the current state of the backlight is saved; the backlight and video are turned off; and the state is changed to SBL_OFF.Ifanevent occurs, the timer is r eset to its initial value and the time-out countdown is restarted.

SBL_OFF State

The backlight cannot be turned on when the TSR is in the SBL_OFF state; the state must be changed to SBL_ON to turn on the backlight.
50 PTC-2124 DOS Software Guide
TSR Internal Functions
When either a mouse or a keypad event occurs, the backlight is restored to its saved state, and the video is turned on. The timer is then set to its initial value and the time-out countdown is restarted; and the stateis changedto SBL_ON.

INACTIVE State

When a delay of 0 seconds is entered, the TSR is effectively disabled but remains in memory, and t he state is changed to INACTIVE.When a non-0delay is entered, the timer is set to the new delay value and the state is changed to SBL_ON.

Standby/Suspend/Resume

The Standby/Suspend/Resume messages are a special set of circumstances. Their activity is sensed from a broadcast message through INT 2f
Standby messages may be rejected when the TSR state is either SBL_OFF or SBL_ON.
.
h
Resume messages are always recognized. The timer is set to its initial value. If a scrnblnk time-out occurs, the backlight is restored to its saved state, the vide o is turned on, and the TSR state is changed to SBL_ON.

State Machine

States Events
Initial
Command
Entry
INIT SBL_ON SBL_ON SBL_OFF INACTIVE SBL_OFF SBL_ON SBL_ON INACTIVE SBL_ON
PTC-2124 DOS Software Guide 51
Time-out Event
Suspendor
Resume
Enter Zero
Delay
Enter
Non-
Zero
Delay
Chapter 3 Configuring TN-3270/5250

Cradle TSR Function

If the cradle driver (CRADTSR) is loaded, the Ethernet driver (TEP) can optimize its power management significantly.
It does this in two ways:
1. When the unit is undocked, the Ethernet interface
2. When the unit is docked in a cradle with an

Ethernet Power Management

is put into a low-power mo de called hardware suspend mode. Th is mode extends the battery
lifetime by reducing power consumption.
attached Ethernet, it will not automatically go into Standby mode or Suspend mode.Thiskeepsthe unit from turning itself off while the user is downloading large files.
If CRADTSR is not l oaded, TEP will continue to function as a normal packet driver. However, this mode of operation is not recommended.
52 PTC-2124 DOS Software Guide

Ethernet Drivers/Utilities

Ethernet Drivers/Utilities

Installing Ethernet Drivers

To install Ethernet drivers, perform the following steps:
1. Edit the autoexec.bat file and u ncomment the lines that call ethernet.bat and cradle.bat.
2. If the FTP TCP/IP stack is to be loaded, copy th e necessary files to Ethernet/Pkt (theseare not included on the unit). Edit ethernet.bat and uncomment the two FTP lines at the bottom.
3. Uncomment the scrnblnk line if screen blanking is needed to conserve power.

ETHERCTL.EXE

Etherctl.exe is a power control utility that turns the power to the ethernet chip on and off.This utility is part of the eth ernet.bat file.
etherctl.exe [-f] {suspend | wake}
-f = ignore packet driver link status

TEP.COM

Tep.com istheethernetpacketdriverandisloaded when ethernet.bat is run.
tep [options] <packet_int_no> <io_ addr> <hardware_irq> <Ethernet
– i = Force driver t o report itself as IEEE 802.3
instead of Ethernet.
– d = Delayed initialization. Used for diskless
booting.
PTC-2124 DOS Software Guide 53
Chapter 3 Configuring TN-3270/5250

ETHERNET.BAT

Ethernet.bat is a batch fil e that turns on the power to the ethernet chip, loads the ethernet driver, and then loads the TCP stack.
– n = NetWare conversion; converts 802.3 packets
into 8137 packet. – w = Windows hack , obsoleted by winpkt. – p = Promiscuous mode disable. – u = Uninstall. –s=ScanI/Ospaceevenifaplugandplaycardis
found. – f = Fake hardware; used for debugging.
Note: The TCP/IP stack drivers are not
included on the base image and must be installed by the user. Once installed, ethernet.bat must be edited to load the stack.
54 PTC-2124 DOS Software Guide

IrDA Power Management

IrDA

IrDA Power Management
IrDA power is controlled by two simple utilities. Neither of these utilities requires parameters.

JIRDAON.EXE

Jirdaon.exe is the IR power on utility for the PTC-2124.

JIRDAOFF.EXE

Jirdaoff.exe is the IR power off utility for the PTC -
2124.

LP20.EXE

lp20.exe istheexecutablefilethatloadstheLitePlus drivers.

LitePlus 2.0 IrDA Print Driver

Even though the LitePlus 1.10 D OS driver provides the ability to print to IrDA compliant printers with APM support, it can send data only in one direction (to printers). I t is also not strictly IrDA-compliant in that it lacks the ability to act as a secondary station. The LitePlus 2.0 DOS driver is designed to provide bidirectional d ata transfer capability along with many other enhancements. These new features include a user-configurable buf fer size and the ability to enable/disable IrDA stack, change IrDA COM ports on-the-fly, supportthe applicationcallbackfunction, and provide a high-efficiency data exchange between the driver and the application.
PTC-2124 DOS Software Guide 55
Chapter 3 Configuring TN-3270/5250

LitePlus 2.0 IrDA DOS Driver Architecture

The LitePlus 2.0 IrDA DOS driver is based on a completely different architecture than that of LitePlus
1.10, even though its functions are natural extensions of that program.
LitePlus 2.0 still uses the format of the DOS TSR program and supports only single point-to-point data exchange. However, the IrDA state m achine will be driven by the timer interrupt ratherthan by the BIOS interrupts. The entire implementation will be purely interrupt driven. This will ensure that there is no waiting under most circumstances inside the IrDA driver, therefore providing maximum efficiency and consuming minimum system resources.
LitePlus 2.0 still controls INT 17H to support traditional DOS printing functions such as Ctrl-P, Print-Screen, and redi rection to an LPT driver.
LitePlus 2.0 also co ntrols INT 14H, adding new extension APIs to support two-way data transfer effectively. Direct redirection to COMx ports is no longer supported. The new APIs provide applications with direct access to IrDA stack information and allow high efficiency data exchange between the application and LitePlus 2.0.

IrDA Related Specification

LitePlus 2.0 is an IrDA primary station that can act as a secondary station. Whether it plays the primary or secondary role depends on which IrDA device initiates the connection procedure.
56 PTC-2124 DOS Software Guide
IrDA Power Management
Physical Layer
LitePlus 2.0 supports the standard IrDA SIR Physical Layer Specification 1.0 (except for 2400 bps-only devices). Implementing 2400 bps support increases the complexity and code size without benefit; all IrDA devices start with a 9600-bps discovery and a connection sequence. A 2400-bps-only station starts its discovery with the initial command frames beginning with a minimum of five SOP delimiters (0 x C0) at 2400 bp s. A station that supports 2400 bps hears the SOPs sent from the 2400 bps as a sequence of characters 0 x 77, 0 x 77, 0 x FF.Afterrecognizing this sign ature sequence, it shifts over to 240 0 bps and starts from there.
LitePlus 2.0 s upports two types of hardware IR implementations:
internal transceivers, and
external dongles.
Dongles may be attached to serial ports directly or indirectly(through a cradle). The internal transceiver design usually requires the IrDA infrared transceiver baud rate to b e controlled by the baud rate registers of the COM port it occupies. Internal implementations that require addit ional register control may be supported by treating them as external dongles. The only external dongle used currently supports SIR speeds of 9600, 19200, 57600, an d 115200 bps only.
To make an IrDA connection to an ex ternal dongle, follow these steps:
1. Install infrared drivers onto a Windows 95 PC.
Connect IrDA dongle to a free CO M Port.
2. Start hyperterminal, pointing the opening of the
port to the a ssigned IrDA COM Port (i.e., COM4).
3. From the PTC-2124 DOS, run
type config.sys >lpt1. The hyperterminal screen should d i splay the contents of config.sys.
PTC-2124 DOS Software Guide 57
Chapter 3 Configuring TN-3270/5250
Link Access Control Layer (IrLAP)
LitePlus 2.0 supports Link Access protocol IrDA specifications 1.0 and 1.1, with the followin g limitations:
Connectionless Data Services are not supported.
Sniff services are not supported. Since LitePlus
A window size of only one frame is supported. For
SinceLitePlus2.0residesinmainmemoryasa
Also, LitePlus 2 .0 does not expose such services to the application.
2.0 supports only single Service Access Points (SAP), such services are redundant and are not available to the applicatio n.
the single SAP TSR design, supporting window sizes of more than one significantly increases the amount of memory required for buffers and the complexity of state machine implementation.
TSR, a trade-off between communication efficiency and memory resources is required. Large buffers (more memory) means less overhead when transferring large amountsof data. However, it also means less memory is available to run applications. All IrLAP APIsare not directly available to applications.
58 PTC-2124 DOS Software Guide
IrDA Power Management
The IrLAP summary for LitePlus 2.0 parameter negotiation is provided in the following table:
Negotiation
Category
Baud rate
Maximum turn around time
Data size Up to 2048 bytes Any
Window size 1 frame window
Number of BOFs
Minimum turn­around time
Link disconnect
LitePlus XID
Response
9600, 19200, 38400, 57600, 115200
500 ms 500 ms
2 @ 115, 200 bps Any
10 ms Any
40, 30, 25, 20, 16, 12, 8,3 seconds
Preferred
Receipt Value
Anything but 2400, 38400
1frame window
Any
PTC-2124 DOS Software Guide 59
Chapter 3 Configuring TN-3270/5250
Link Management Layer (IrLMP)
LitePlus 2.0 supports IrLMP 1.0 and 1.1 with the following exceptions:
Only one Service Access Point is supported. With
LitePlus 2.0 does not include the architectural
Exclusive Mode is not supported.The
Connectio nless data are not supported.
Sniffing primitive is not supported. LitePlus
a single SAP, LitePlus 2.0 can support two-way data exchange.
component described in the Link Management Protocol Document section 2.2.3 Transport Protocol. LitePlus 2.0 does not support multiple IrLMP connections simultaneously.
Multiplexed mode supports only simultaneous connections of IAS (Information Access Service) and data transfer channel.
provides only n ormal discovery services.
The hint byte is set to 0 x 04, which identifies the IrDA driver as a Computer. The printer bit is not seteventhoughDOSprintingdatacanbe redirected to the driver. This byte may also be used by another computer to decide/display how the unit containing the IrDA driver is used.
Devicenicknamethe device nickn ame is exchanged during discovery sequence. LitePlus
2.0 allows the user to change nicknames through a command line option.
The DISCOVER and RESOLVE ADDRESS states described in section 3.5.2 and 3.5.2.3.1 of Link Management Protocol D ocument are n ot implemented internally in IrLMP b ut rather in the IrLAP layer.
Only the CONNECT, D ISCONNECTED and TRANSFER READY states are s upported in the diagram in section 6.3.1 of Link Management Protocol Document. Other states are not used by LitePlus 2.0.
60 PTC-2124 DOS Software Guide
IrDA Power Management
The only supported IAS primitive is
LM_GetValueByClass. Other primitives,including LM_GetinfoBaseDetails,LM_GetObjects, LM_GetValue, LM_GetObjectInfo, and LM_GetAttributeNames should not be used. The IrLMP API is not exposed to the application, and all IAS services are handled by L ite Plus automatica lly.
All IrLMP APIs, including those for IAS, are not directly available to applications. The applications will use extended INT14H functions to access the IrDA stack directly.
Classes and Attributes
LitePlus 2.0 will support the following three IAS classes and attributes:
Class Attribute Va l u e
{0,1,0,0,3,0,22,
Device Device Name
IrDADriverby ACTiSYS”}
IrLMPSupport
IrCOMM* Parameters
LSAPSel 0,1,0,1,1,0,0,0,2}
IrLPT** Parameters {0x81,0}
LSAPSel {0,1,0,4,1,0,0, 0, 2}
* Only a three-wire-raw portion is supported for
IrCOMM. Three-wire-raw is sufficient for LitePlus
2.0. More complicated protocols, s uch as nine-wire-cooked, target different usage models and require additional protocol support on top of IrLAP and IrLMP. TinyTP is such a protocol and is n ot a part of LitePlus 2 .0 design.
PTC-2124 DOS Software Guide 61
{0,1,0,0,2,0,3,1, 0,0}
{0,1,0,1,2,0,6,0, 1,1,1,1}
Chapter 3 Configuring TN-3270/5250
** Supported for backward c omp atibility. Even

IrDA Compatibility

LitePlus 2.0 is based on the ACT1 IrDA stack, which has passed Ir D A compatibility tests conducted by ACTiSYS. Those tests include both test suites from Genoa for IrDA compatibility and interoperability tests, including many third-party implementations.

DOS BIOS INT17H Function Extension

OneofthekeyfeaturesofLitePlus1.10issupportfor data printing through the IrDA driver under a DOS prompt. Th is feature is achieved by replacing the INT17H interrupt routine.
When L ite Plus is enabled, all calls to INT17H are redirected to the IrDA stack only when DX is zero. This implies that LitePlus 2.0 distinguishes between different LPTx ports, and only LPT1 i s ma pped to the IrDA port. The reason LPT1 is always used is because all DOS printing functions, such as PRINT SCREEN, are always redirected to LPT1. When LitePlus is disabled or DX is not zero, all calls are direc ted to the original INT17H routine. Following are the details for the new INT 17H.
printing will use three-wire-raw in the Ir COMM object in stead of the IrLPT object.
62 PTC-2124 DOS Software Guide
IrDA Power Management
Print Character
The print character function sends the byte in AL to LitePlus 2.0s internal bufferif a connection has already been configured.If a connectionhas not b een established,LitePlus 2.0 waits for a full discovery cycle before it returns.
Called with
AH = 0 AL = character to print DX = 0 Only LPT1 is mapped to IrDA port.
Returns
AH = 0x9 0 If successful.
0x31 If failed.
Initialize Printer
This function initializes the IrDA driver by initializing discovery/connection.
Called with
AH = 1 DX = 0 Only LPT1 is mapped to IrDA port.
Returns
AH = 0 x 90 If successful.
0xA8If failed.
Get Printer Status
This function always returns successfully. Called with
AH = 2 DX = 0 Only LPT1 is mapped to IrDA port.
PTC-2124 DOS Software Guide 63
Chapter 3 Configuring TN-3270/5250
Returns
Tests to support the following DOS printing functions will be conducted and demonstrated before release:
Redirection of TYPE, DIR or COPY command.
Print screen Sys Rq.
Ctrl-P.

DOS BIOS INT14H Function Extension

Although LitePlus 1.10 supports printing through redirectiontoCOMx(wherexisthenumberofIrDA COM ports), LitePlus 2.0 no longer supports such usage. All printing data should be redirected to the LPT port instead. One of the major features of LitePlus 2.0 is support for two-way, h igh-efficiency data transfers.
AH = 0 x 90
Becauseof the well-knownlatency of DOS serialBIOS calls, most DOS programmers bypass the BIOS call and access the registers directly. Un fortunately, DOS does n ot have the capability to catch direct access to registers and make legacy programs work transparently. To use the new IrDA capability, use the extended APIs that LitePlus supports.
Instead of supporting DOS redirection to COMx similar to LPT1 ports, LitePlus 2.0 actually ex tends INT14H to support two-way, high-efficiency data transfer. Applications can directly access IrDA stack buffers and status through these extensions. This method also provides application software a way to disable/enable the entire IrDA stack.
Upon installation, LitePlus 2.0 installs its own INT14H routine. All calls without the correct COMx port specified, or with a function number small er than 0 x 80, are passed over to the old INT14H. The following are details of the new INT14H functions.
64 PTC-2124 DOS Software Guide
IrDA Power Management
Buffer Control Block (BCB)
To increase the efficiency of da ta transfer, structures called Buffer Control Blocks (BCBs) are exchanged between IrDA stacks and application software. Th e definition of a BCB is as follows:
typedef struct BufferControlBlock {
int Status; /* Internal buffer usage indicator */ struct BufCntlBlck* pNext;/*Pointerto next BCB structure*/ unsignedint BufferSize;/* Size of the buffer pointed by
pPacket */ unsigned int DataLength;/* Length of total frame data */ unsigned int DataOffset;/* Offset to the star t of useful
data */ unsigned char pPacket;/* Pointer to the start of the
buffer */ } BCB;
Two BCB queues are maintained independent ly by the LitePlus 2.0 driver: the send queue and the receive queue. For receiving data, the application can either poll the LitePlus 2.0 driver to get a BCB that LitePlus 2.0 r eceived successfully or directly use t he pointer returned by the callback function.
After the data in the BCB is consumed, the application returns the BCB to LitePlus 2.0s receive queue. For sending data, t he application first requests a free BCB from LitePlus 2.0. If succ essful, it fills up the BCB and passes it back to LitePlus via an INT14H call.
Status
This field i s u sed internally by LitePlus 2.0 for buffer management. The application software sets it to zero before returning it to the IrDA driver to send.
PTC-2124 DOS Software Guide 65
Chapter 3 Configuring TN-3270/5250
pNext
This fie ld is also used internally by LitePlus 2.0 for buffer manage ment. The application software should ensure not to change this field for both incoming and outgoing buffers.
BufferSize
This number is the size of the buffer po inted by pPacket and is the maximumnumberof bytes of data that t his BCB can carry. The application should always check this field to e nsure that it does not write too much data into a BCB. For future consideration, applications should assume th at all BCBs could have different BufferSize values. For L itePlus 2.0, this value is set for all BCBs during the driver load.
DataLength
For incoming buffers, this field indicates the len gth of the data bytes in the IrDA I frame received. The number of realdata bytesis this number minusfour.
For outgoing buffers, this field indicates how many bytes are to be sent and should be set correctly by the application. The numbe r of realdata bytes is this number plus four.
DataOffset
This field indicates the starting index of real data in the Data array pointed by pPacket. For all BCBs , this field is four and has been included for future compatibility with more complicated protocols such as TinyTP.
For outgoing BCBs, th is field has no effect.
66 PTC-2124 DOS Software Guide
IrDA Power Management
pPacket
This is the pointer to where real data is stored. For incoming BCBs, the effective data starts with pPacket[DataOffset] with length of DataLength.
Initialize IrDA Stack
Called with
AH = 0 x 80 AL = 0 Disable IrDA stack. Discards all data
buffers that have not yet been sent. All data buffers received but not yet consumed will also be lost. This is necessary to maintain the integrity of buffer, as there could be a buffer occupied by printing data from INT17H. Once disabled, the only way to enable the stack again is to call INT 14H with AH = 0 x 80 and A L = 1.
=1Enable IrDA stack with callback
function. Discards all data buffers that have not yet been sent. All data buffers received but not consumed will be lost.
EX:BX Address of a callback function. (AL = 1) The callback function contains the void
CallBack (char far * fpData, int iDataLength) prototype. If EX:BX w as setto0:0,nocallbackoccurs.The received data buffer is available through other calls.
CX = 0 Internal transceiver used on the COM
port.
=1ACT220L dongle is used.
0 x FFFF Default don gle. This is either the
default transceiver (internal) or the one specified on the command line.
PTC-2124 DOS Software Guide 67
Chapter 3 Configuring TN-3270/5250
DX = Serial port 0 to 3. This parameter
Returns AH = 0 x 90 Successful. This value is always
ES:BX Pointer to a data structure that
allows users to changethe IrDA serial port on the fly.Avalueof FFFF
indicates that the default
h
port (or the one specified on the command line) should be used.
returned.
contains all the IrDA-re lated information. The definition of the data structure is listed below. After the first initialization call, the app lication so ftware should be able to get most of the useful information directly from this structure.
typedef struct IRDA_INFO {
unsignedint BaudRate; unsigned int LAP_Status; unsignedint EngineType; unsigned int IAS_Selection; unsignedlongs DeviceAddress; unsignedlong dDeviceAddress; unsigned char LocalDiscoveryInfo[32]; unsignedchar RemoteDiscoveryInfo[32]; unsignedlong ReceivedPackets; unsignedlong ReceivedBytes; unsigned long SentPackets; unsigned long SentBytes; unsigned long DataInSendQueue; unsigned long DataInReceiveQueue; unsigned long BadPackets; unsignedlong TotalReSend;} IrDA_info;
Although the main purpose o f this call is to disable/ enable the LitePlus 2.0 driver, the returned pointer points to a data structure that allows the application to retrieve many of the counters and statistics of the underlying LitePlus 2.0 driver while the IrDA connection is active.
The LitePlus 2.0 driver is enabled by default after installation.
68 PTC-2124 DOS Software Guide
IrDA Power Management
BaudRate
The current Baud rate used by the IrDA transceiver. Thefollowingarethepossiblevaluesforthisfield:
1 115.2K bps 2 57.6K bps 3 38.4K bps 6 19.2K bps 12 9.6K bps
LAP_Status
This field indicates the current status of the LitePlus
2.0 driver. The f ollowing are the possible value s for this field:
0 Disconnected. The driver has not yet
set up a connection with a nother IrDA device. L itePlus 2.0 may either be idle or in the middle of a discovery/ connection procedure.
1 Connected. The driver is al ready
connected with another IrDA device. Data transfer occurs only when LitePlus 2.0 is in this state.
2 Disabled. The driver will reject any
data transfer request. This implies that if a BCB is requested, a NULL pointer will be returned.
EngineType
This field indicates what role the LitePlus 2.0 driver is currently playing. Following are the possible values:
0 Secondary station role. In this role,
LitePlus 2.0 responds passively.
1 Primary station role . In this role,
LitePlus 2.0 actively attempts to connect wi th another device.
PTC-2124 DOS Software Guide 69
Chapter 3 Configuring TN-3270/5250
IAS_Selection
This field indicates how IAS responds to inquiries. Therearetwopossiblevalues:
DeviceAddress
This long word is the MAC address used by the IrDA LAP of LitePlus 2.0 (source address).
dDeviceAddress
2 Undecided. The LitePlus 2.0 is idle in
disconnected mode. Which role it will play depends on whether another IrDAdevicetriestoinitiatea connection first.
0 LitePlus2.0supportsIrLPTonly
(usedonlybyLitePlus1.x).
1 IrCOMM, three-wire-raw (used by
LitePlus 2. 0).
This long word is the MAC address used by the IrDA LAP of the IrDA device that communicates with LitePlus 2.0 (destination address).
LocalDiscoveryInfo
This string contains the nickname of the local station/IrDA stack. LitePlus 2.0 always sets it to LitePlus.
RemoteDiscoveryInfo
This string contains the nickname of the remote station/IrDA stack.
70 PTC-2124 DOS Software Guide
IrDA Power Management
ReceivedPackets
This long word counter contains the total packets receivedby LitePlus 2.0. This counter is reset each time the stack makes a transition from the connected to the disconnected mode.
ReceivedBytes
This long word counter contains the total bytes received by LitePlus 2.0. Please note that this coun ter is NOT the total number of bytes of effective data carried over the infrared link. It includes all the bytes in all packets and is a good indication of infrared channel quality.
SendPackets
This long word counter contains the total packets sent by LitePlus 2.0. This counter is reset each time the stack makes a transition from connected to disconnected mode.
SentBytes
This long word counter contains the total bytes sent by LitePlus 2.0. Please note that this counter is the NOT the total number of bytes of effective data carried over the infrared link. It includes all the bytes in all packets.
DataInSendQueue
This long word counter contains the total number of bytes already in the L itePlus 2.0 send data queue but not sent over the infrared link. Packets that h ave already b een sent but not yet acknowledged are also included.
PTC-2124 DOS Software Guide 71
Chapter 3 Configuring TN-3270/5250
DataInReceiveQueue
This long word counter contains the total number of bytes already received by LitePlus 2.0 but not yet consumed by the application.
BadPackets
This long word counter contains the total bad packets received by LitePlus 2.0. Bad packets are those complete packets with bad CRC or partial packets. This counter will be reset each time the stack makes a transition from c onnected t o disconnected mode.
To ta lR e se nd
This long word counter contains the total number of times a packet has been resent. A resent condition could occur for several reasons: (1) The other station does n ot receive the packet; (2) The other station received the packet but the received packet does not have a valid CRC; (3) The response from the other station is not received by this statio n; (4) The response is not valid. This counter is reset each time the LitePlus 2.0 makes a transition from connected to disconnected mode.
Send/Return BCB
Called with
AH = 0 x 81 AL = 0 The BCB has valid data and is
to be sent.
=1The data in this BCB has been
consumed. The application is returning the BCB to LitePlus
2.0.
72 PTC-2124 DOS Software Guide
IrDA Power Management
Returns
AH = 0 x 90 Success. This value is
returned so long as LitePlus
2.0 is enabled.
=0xA0Fail. LitePlus 2.0 is
currently in a disabled mode.
This function has two uses: (1) the application may use this function to requestLitePlus 2.0 to send a BCB that has been filled with data or (2) it may return a BCB with received data already used by the application.
Receive/Get free BCB
Called with AH = 0 x 82
AL = 0 Ask LitePlus 2.0 for possible incoming
BCB.
=1Ask LitePlus 2.0 for possible free BCB.
Returns AH = 0 x 90 Success. This value is returned as
long a s LitePlus 2.0 is enabled.
=0xA0Fail. LitePlus 2.0 is now in
disabled mode.
EX:BX Pointer to the BCB. It could be a BCB
that contains the data LitePlus 2.0 successfully received over the infrared link or a fr ee BCB for application to place send data. A NULL po inter may be returned in both cases. A NULL pointer means no dat a has been received if the application is asking for incoming BCB. It also mean s no free BCB is available if the application is requesting free BCB.
PTC-2124 DOS Software Guide 73
Chapter 3 Configuring TN-3270/5250
Get Status
Called with
Returns
If the application asks for discovery status, the possible return values are as follows:
AH = 0 x 83 AL = 0 Discovery status.
=1Connection status.
AX = Corresponding status.
0 Never discovered. 1 Already discovered, but LitePlus 2.0 is
idle. 2 In the middle of a discovery procedure. 4 Already discovered, probably
connected.
If the application requests connection status, the possible return values are as follows:
0 Disconnected. LitePlus 2.0 is in NDM
state. 1 Connecting. LitePlus 2.0 is in the
middleof a connection procedure. 2 Connected. LitePlus 2.0 is already
connected with another station. 4 Disabled.
Please note that this status information is used by the application to display the status of the underlying LitePlus 2.0 driver.
74 PTC-2124 DOS Software Guide
IrDA Power Management
Unload LitePlus driver
Called with
AH = 0 x 84
Returns
BX = 0 Unable to unload the LitePlus driver.
Before unloading the LitePlus driver, it checks to ensure that APM interrupt support is installed. If yes, it verifies that the current interrupt vector is the same as in the LitePlus d river. If not, it means another routine replaced the APM driver after LitePlus was loaded. It is not possible to unload the driver.
BX = otherwise LitePlus has recovered all the
interrupt vectors. BX now contains the _psp variable of the LitePlus driver. The caller canthenusethisvariableto unload the driver.

Miscellaneous

Command Line Options
All command line options start with /.Thefollowing command line options are availa ble for LitePlus 2.0. The synopsis for LitePlus 2.0 is as follows:
LitePlus [/COM:x] [/BAUD:xxx] [/EXT:xx] [/BUFFER:x] [/NOAPM]
[/SUSPENDOK] [/NAME:ssss] [/HELP] [/U NLOAD]
Note: Options are not case sensitive.
PTC-2124 DOS Software Guide 75
Chapter 3 Configuring TN-3270/5250
/COM:x This option allows the user to choose
/BAUD:xxx This option allows the user to choose
the UART port to wh ich the IrDA
hardware is connected.The “x” may be
any value between 1 and 4. LitePlus
2.0 uses DOS def ault register
addresses, and the default COM port
is COM3. LitePlus 2.0 also assigns an
IRQ number accordingly. The default
values for DOS are as follows:
COM port Base Register Address IRQ
COM1 0x3F8 IRQ4 COM2 0x2F8 IRQ3 COM3 0x3E8 IRQ4 COM4 0x2E8 IRQ3
the highest baud rate LitePlus 2.0
supports during IrDA connections.
LitePlus 2.0 itself can support up to
115.2 Kbps. Unless there is a specific
reason for a lower baud rate (strong
interference, background lighting), it
is normally unnecessary to limit the
highest speed. The default highest
speed is 115.2 K.
The valid values for xxx are as follows:
96 9600 bps 192 19200 bps 384 38400 bps 576 57600 bps 1152 115.2 Kbps
Note that 38400 bps is listed here, even though ACT IR220L does not support 38400 bps. The 38400 bps is listed because the default dongle is assumed to be an internal dongle.
76 PTC-2124 DOS Software Guide
IrDA Power Management
/EXT:x This option tells LitePlus 2.0 what
external dongle is attached to the serial port. Following values are currently supported.
0 Noexternaldongle(Default) 1 ACT IR220L
/BUFFER:x This option tells LitePlus 2.0 the
maximum size for a single buffer. Following values are supported:
0 64 bytes (default) 1 128 bytes 2 256 bytes 3 512 bytes 4 1024 bytes 5 2048 bytes
This is the only control over memory a llocation for buffers. Send queue and receive queue, each contain two BCBs. Ea ch BCB contains a data buffer of the size d efined here.
/NOAPM LitePlus 2.0 supportsthe Symbol APM
(Advanced P ower Management) driver. B y default, LitePlus 2.0 attempts to detect APM driver and install APM supp ort accordingly. However, if the APM driver is not detected or the user chooses to in stall with the /NOAPM option, LitePlus 2.0 will not install APM support. By supporting APM, LitePlus 2.0 is able to recover from a suspend/resume cycle.
/SUSPENDOK By default, LitePlus 2.0 rejects a
request to suspend if it is in the middle of a communication section. However, if the driver is installed with this option, LitePlus 2.0 always honors the request.
PTC-2124 DOS Software Guide 77
Chapter 3 Configuring TN-3270/5250
/NAME:ssss This option allows the name of the
/HELP If this option is used, LitePlus will
Usage
IrDAstack to be changed. This name
is displayed when the device is
discoveredby Windows 95. The default
value is PTC-2124.Pleasenotethat
Windows95displaysonlythefirst18
characters of the string whe n
disconnected and can display at least
28 characters when con nected. The
longest name that LitePlus 2.0 can
handle is 28 characters. LitePlus 2.0
truncates the string if it is longer than
28.
simply display the following message
and quit without further action.
LitePlus [/COM:port][/BAUD:baud-rate][/EXT:dongle] [/BUFFER:size][/NOAPM] [/SUSPENDOK] [/NAME:nick­name][/HELP][/UNLOAD].
Port
1=COM1,2=COM2,3*=COM3and4=COM4.
Baud-Rate
Only 96, 192, 384, 576, and 1152* are valid.
Dongle
0* = internal, 1 = ACT220L.
Size
0* = 64, 1 = 128, 2 = 256, 3 = 512, 4 = 1024 and 5 = 2048.
Name
Any strin g. Only the first 28 characters are used. Default is PTC-2124.
78 PTC-2124 DOS Software Guide
IrDA Power Management
Note
In the preceding parameters, “*” indicates a default setting value.
/UNLOAD LitePlus attempts to recover all the
interrupt vectors it changed and unloads itself. If successful, the message LitePlus uninstalled is displayed. If unsuccessful, the message APM interrupt prevent unloading LitePlusisdisplayed, and the driver stays unchanged. Notice that when the /UNLOAD option is used, all other options are ignored.
Initial Detection
Before installing the LitePlus 2.0 TSR driver , the software per forms the following detections:
Whether the required COM port has been detected by DOS. This is achieved by checking the BIOS data area at 0 x 40:0. The associated error message is Serial port not found. Driver not installed.
Whether the LitePlus 2.0 TSR has already been installed. This is ac hieved by checking the LitePlus identification string. The associated error message is Driver already loaded.
If either of the detections fail, LitePlus 2.0 aborts the installation procedure with an appropriate error message.

Discussions

Callback functions can easily disrupt or disable the system if the application terminates without first disabling the IrDA driver.
Since callback functions are actually called from inside the interrupt routine, the application should return as soon as possible. Long delays in the callback routine could cause the behavior of the driver to be unpredictable.
PTC-2124 DOS Software Guide 79
Chapter 3 Configuring TN-3270/5250
This section describes NTMOUSE, Symbols digitizer driver for the Nissha touchscreen controller.

What is NTMOUSE?

NTMOUSE is the Symbol digitizer driver for the Nisshatouchscreen controller. This section describes the relationship among digitizers, the NTMOUSE digitizer driver, and the PENCAL pen calibration utility.
The Nissha digitizer (or touchscreen controller) generates interrupts when the screen is touched with astylus.Thedataprovidedbythedigitizerareina very raw format, consisting of X and Y coordinates in digitizer units.These digitizer units do not correspond to pixels; the digitizer simply c onverts analog X and Y voltages from the touchscreen into a digital v alue and generates an interrupt to the digitizer driver.

NTMOUSE

The NTMO USE digitizer driver (sometimes called the pen driver or mouse driver) reads the stylus po sition in digitizer units and makes it available to applications as mouseinput. The ma in roles of NTMOUSE are to (a) emulate the DOS interrupt 33h mouse programming interface, and (b) convert digitizer unit coordinates to mouse coordinates.
The conversion from digitizer units to mouse units is simple once NTMOUSE is calibratedproperly. NTMOUSE monitors the current video mode of the PTC, giving it the range of valid X and Y coordinates in mouse units. For example, Video Mode 18 is 640 x 480 pixels in X and Y dimensions and ha s 16 colors. The dig itizer simply has to convert digitizer units into a 640 x 480 range for each digitizer interrupt.
80 PTC-2124 DOS Software Guide

Pencal

PENCAL is the tool that configures NTMOUSE with the minimum and maximum X and Y digitizer unit coordinates for each video mode.It does this by displaying a configuration screen with four c rosshairs and asking the user to tap each one in sequence.
For each pen tap, PENCAL obtains the digitizer coordinates of the crosshair.Because it knows the pixel coordinates of the crosshair, PENCAL can calculate the for mula needed to convert between the two. It saves this information in a configuration file (generally tmouse.ini)thatisreadbyNTMOUSE when it loads.

Using NTMOUSE

To run NTMOUSE, invoke it at the DOS command prompt using command-line arguments appropriate to the PTC display type. NTMOUSE contains the following command-line:
ntmouse [/Q] [/B] [/?]
These arguments are optional:
/Q indicates the display is a 320 x 240 quarter-VGA.
/B disables the beep on APM resume (available in version 3.02.02 and later).
/? displays the usage line.
By default, NTMOUSE assumes a 64 0 x 480 full VGA display and ex pects to read calibration information from tmouse.ini.
PTC-2124 DOS Software Guide 81
Chapter 3 Configuring TN-3270/5250
ThepathtoNTMOUSE’s calibration file may be configuredusing environment variables. When it loads, the file looks for an environment variable named TMOUSE. This variable should contain a pointer to the configuration file (for example, TMOUSE = c:\mouse\tmouse.ini). If this variable does not exist, NTMOUSE reads its program segment prefix to determine its installation directory. It then tries to open tmo use.ini in its installation directory. If this fails, NTMOUSE will still l oad but will use default calibration values that may be incorrect.
The Symbol PTC-2124 has a ¼ VGA display which shows a sliceof the full VGA display. Applications runningonsuchsystemsmustensurethattheydo not draw outside the visible part of the display. NTMOUSEs commandline arguments control how the digitizer driver must scale the digitizer units. This ensures that the units appear to be mouse events on the visibleportion of the full VGA display.

NTMOUSE Interaction with APM

The NTMOUSE driver is APM aware. This means that it gets a notification when the PTC on which it is running is suspended or resumed. During Resume, NTMOUSE reinitializesthe touchscreen hardware and generates a beep. The beep is NTMOUSEssignal to the user that the touchscreen is active again and is ready for input.
Units with the mouse, Ethernet, and cradle driver loaded that are left in a cradle with an active Ethernet link will emit a beep at regular intervals, whenever the unit attempts to go into APM s tandby mode and the Ethernet driver rejects the attempt. The reason for this is that a rejectedAPM standbyrequest results in an APM resume notification to a ll drivers, and this causes NTMOUSE to generate a beep. Th is may be disabled with the /B command mentioned in the Using NTMOUSEsection.
82 PTC-2124 DOS Software Guide

Special Notes for Programmers

NTMOUSE does not support INT 33h functions 7 and 8 (Set Horizontal Limits f or Pointer and Set Vertical Limits for Pointer,respectively).
Some applications (such as the PenRight! runtime) routinely use these calls to set the horizontal limits to 0 through 640 and the vertical limits to 0 through
480. Intern ally, NTMOUSE uses the pointer limits to
scale dig itizer coordinates to mouse coordinates, so these calls interfere with its ability to provide accurate information to applications. NTMOUSE will silently ignore attempts to se t the pointer limits using these two functions.
PTC-2124 DOS Software Guide 83
Chapter 3 Configuring TN-3270/5250
2124POP is a pop-up keyboard utility that allows users to use the pen-based screen to touch the keys in the pop-up keyboard with a stylus to key in text on the comm a nd line or in other applications. 2124POP also has a gas gaugefunction to show battery life. This function will display a meter that displays the amount of life remainin g in the battery as a percentage of the originallife.

Command Line

The command string for the 2124POP is as follows:

Options

2124POP

2124pop [/option]
Individual parameters within the string influence different features or operations as follows:
/D enables the Direct Video I/O Mode. /N disables the Drag feature. /B enables the budget Keyboard operation. /E enables the Keyboard when pop-up is invoked. /X:n sets the number of video columns. /Y:n sets the number of video rows. /K:n n=0– 9999, sets the standard keyboard delay
(default = 25).
/S:n n=0– 9999, sets the secondary keyboard
delay for action keys.
84 PTC-2124 DOS Software Guide
/T:n n=1– 5, sets the triple-tap a ctivation time
threshold (default = 2).
/R:n n= 0 – 60, sets the time-out value for the
Resume Time-out macro.
/A:n n=1– 5, sets triple-tap activation area
threshold (default = 2).
/G[:n] enables Bat tery Ga s Gauge. n = 0 – 8default
= 2, sets the gas gauge alarm level (optional).
/M:path specifies a Macro Definition File. /F:path specifies a file containing actionkey
definitions.
PTC-2124 DOS Software Guide 85
Chapter 3 Configuring TN-3270/5250
This section describes PENCAL, Symbolspen calibration utility. PENCAL is used in conjunction with Symbols DOS-based digitizer drivers, such as NTMOUSE.

What is PENCAL?

To understand PENCAL, it is necessary to understand Symbols digitizer drivers. This section gives a brief overview of how the digitizer, the digitizer driver, and PENCAL work together.
The digitizer (or touchscreen) generates interrupts when the screen is touched using a stylus. The data provided by the digitizer is in a very raw format, consisting of X and Y coordinates in digitizer units. These digitizer units do not correspond to pixels in anyway;thedigitizersimplyconvertsanalogXandY voltages f rom the touchscreen into a digital value and generates an interrupt to the digitizer driver.

PENCAL

The digitizer driver reads the stylus position in digitizer units and makes it available to applications as mouseinput and is som etimes called the pen driver or mouse driver.
The main roles of the digitizer driver are to
emulate the DOS interrupt 33h mouse programming interface, and
convert digitizer unit coordinates to mouse coordinates.
86 PTC-2124 DOS Software Guide
Loading...