5620 SAM 9500 MPTGS Driver Version 1.3.0

1. What is the 5620 SAM 9500 MPTGS Driver?

The 5620 SAM 9500 (Secure Access Module) is a hardware security token used in Nokia (formerly Alcatel) 5620 Service Aware Manager (SAM) installations. The MPTGS (MultiProtocol Terminal Gateway Service) driver acts as the communication bridge between the SAM hardware and the management software, translating the proprietary SAM protocol into standard API calls used by the 5620 Service Aware Manager.

Version 1.3.0 is the latest stable release (as of this writing) and includes:

• Support for the 9500B and 9500C hardware revisions.
• Improved error handling for intermittent USB link failures.
• Enhanced cryptographic module loading to comply with FIPS1402.
• Compatibility with 5620 SAM 12.4R3 and later.

2. Architecture Overview

The driver consists of three logical layers:

1. Hardware Abstraction Layer (HAL) Directly accesses the USB controller, performs endpoint configuration and manages powerstate transitions.
2. Protocol Engine Implements the MPTGS bytestream protocol, packet framing, sequence numbering and CRC validation.
3. Service Interface Exposes a set of Windows Service calls (and, starting with v1.3.0, a limited Linuxcompatible API) that the 5620 SAM application consumes.

Each layer is built as a separate dynamiclink library (DLL) to simplify future updates. The primary DLL is MPTGSDriver.dll, which loads MPTGSHAL.dll and MPTGSProto.dll at runtime.

3. Key Features in Version 1.3.0

• AutoRecovery Mechanism Detects a lost USB link, attempts three reconnection cycles, and logs the event to the Windows Event Log (Source: MPTGSDriver).
• FIPS1402 Cryptographic Provider All symmetric keys are now generated via the Microsoft CNG provider with FIPS validation enabled.
• Extended Device Discovery The driver now enumerates both standard and dualmode SAM modules, exposing them under separate device IDs (e.g., USB\VID_0A5C&PID_9500 and USB\VID_0A5C&PID_9500D).
• CrossPlatform Wrapper A thin compatibility layer (shared object libmptgs.so) allows the driver to be utilized on RedHat Enterprise Linux 8 via the wine translation layer for hybrid deployments.
• Diagnostic CLI New commandline utility mptgsdiag.exe provides realtime status, firmware version, and a selftest routine.

4. Installation Instructions

4.1 Prerequisites

• Windows Server 2016/2019 (64bit) or Windows 10/11 (Professional). For Linux, RedHat8 with wine6.0.
• Administrator rights on the target machine.
• USB 2.0 or higher port with driver signing enforcement disabled (if using testsigned builds).
• Existing 5620 SAM 12.4R3 installation (or later).

4.2 StepbyStep Procedure (Windows)

1. Download MPTGS_Driver_1.3.0.zip from the Nokia support portal.
2. Extract the archive to C:\Program Files\MPTGS.
3. Open an elevated PowerShell window and run:

   cd "C:\Program Files\MPTGS"                .\installdriver.ps1

4. The script registers the driver, creates the service MPTGSService, and starts it automatically.
5. Connect the 5620 SAM 9500 token. Wait for Windows to display MPTGS Device Ready.
6. Open mptgsdiag.exe status to verify successful communication.

4.3 Linux Installation (Optional)

1. Install wine and winetricks vcrun2015.
2. Copy the Windows driver files to /opt/mptgs.
3. Run the wrapper script:

   cd /opt/mptgs                sudo ./installlinuxwrapper.sh

4. Confirm the service is active with systemctl status mptgs.service.

5. Configuration Options

All configurable parameters are stored in C:\ProgramData\MPTGS\mptgs.ini (Windows) or /etc/mptgs/mptgs.conf (Linux). The most important entries are:

[General]LogLevel=InfoAutoRecover=TrueMaxReconnectAttempts=3[Security]FIPSMode=EnabledCryptoProvider=CNG[Device]PreferredId=USB\VID_0A5C&PID_9500TimeoutMs=2000        

After editing the file, restart the service:

net stop MPTGSServicenet start MPTGSService

6. Known Issues & Workarounds (v1.3.0)

• Issue: On some USB 3.0 hubs the driver reports Device not ready.
  Workaround: Connect the SAM token directly to a USB 2.0 port or disable USB selective suspend.
• Issue: Linux wrapper fails under wine 8.0.
  Workaround: Use wine 6.07.0 or apply the provided patch winemptgspatch.diff.
• Issue: Event Log entries flood with Checksum error under heavy traffic.
  Workaround: Increase TimeoutMs to 3000ms and enable LogLevel=Warning.

7. Best Practices for Production Deployments

1. Dedicated USB controller Assign a separate USB host controller to the SAM token to avoid bandwidth contention.
2. Periodic selftest Schedule mptgsdiag.exe selftest via Windows Task Scheduler (daily) and alert on nonzero return codes.
3. Secure logging Forward driver logs to a centralized SIEM using Windows Event Forwarding; disable local log file storage if compliance requires.
4. Firmware alignment Verify that the SAM firmware version matches the drivers supported matrix (see the release notes PDF).
5. Backup configuration Keep a copy of mptgs.ini in version control; restore automatically after OS patches.

8. Additional Resources

• Official 5620 SAM Documentation
• Driver Release Notes (PDF)
• Nokia Community 5620 SAM Forum
• GitHub Repository (source for Linux wrapper)