Identive CLOUD 2700F Specification

CLOUD
eader
Identive Infrastructure
Reference Manual – version 1.03
Identive
Smart Card R
Reference manual
Identive CLOUD 2700 R Smart Card Reader
© Identive GmbH
Oskar-Messter-Strasse, 13
85737 Ismaning
Germany
Phone +49 89 9595 5000 • Fax +49 89 9595 5555
Date
Version
Description of change
08/08/2012
1.01
Initial Version
10/01/2013
1.02
Minor rework
22/02/2013
1.03
Minor corrections
Document history
Contact information
www.identive-group.com/en/products-and-solutions/identification-products/desktop-readers-
terminals/contact-desktop-readers
For sales information, please email sales@identive-infrastructure.com
Table of Contents
1. Legal information ................................................................................................................... 6
1.1. Disclaimers ..................................................................................................................... 6
1.2. Licenses ......................................................................................................................... 6
1.3. Trademarks .................................................................................................................... 6
2. Introduction to the manual ..................................................................................................... 7
2.1. Objective of the manual ................................................................................................. 7
2.2. Target audience ............................................................................................................. 7
2.3. Product version corresponding to the manual ............................................................... 7
2.4. Definition of various terms and acronyms ...................................................................... 8
2.5. References ..................................................................................................................... 9
2.6. Conventions ................................................................................................................. 10
3. General information about CLOUD 2700 R ........................................................................ 11
3.1. CLOUD 2700 R key benefits ........................................................................................ 11
3.2. CLOUD 2700 R key features ....................................................................................... 11
3.3. CLOUD 2700 R ordering information ........................................................................... 12
3.4. CLOUD 2700 R customization options ........................................................................ 12
Applications ............................................................................................................................. 13
3.4.1. General ................................................................................................................. 13
3.4.2. Applications provided by Identive ......................................................................... 13
4. CLOUD 2700 R characteristics ........................................................................................... 14
4.1. CLOUD 2700 R high level architecture ........................................................................ 14
4.1.1. Block diagram ....................................................................................................... 14
4.1.2. Software architecture ............................................................................................ 15
4.2. Quick reference data .................................................................................................... 16
4.2.1. CLOUD 2700 R dimensions .................................................................................. 16
4.2.2. LED behavior ........................................................................................................ 17
4.2.3. Other data ............................................................................................................. 17
4.2.3.1. General ...................................................................................................................... 17
4.2.3.2. USB ........................................................................................................................... 17
4.2.3.3. Card interface ........................................................................................................... 18
5. Software modules ................................................................................................................ 19
5.1. Installation .................................................................................................................... 19
5.2. Utilities .......................................................................................................................... 19
5.3. Driver ............................................................................................................................ 19
5.3.1. CLOUD 2700 R listing ........................................................................................... 19
5.3.2. Supported operating systems ............................................................................... 20
5.4. CT-API .......................................................................................................................... 20
5.5. MCard-API .................................................................................................................... 20
5.6. Firmware ...................................................................................................................... 21
5.6.1. CCID transport protocol ........................................................................................ 21
5.6.1.1. CCID class requests supported ................................................................................. 21
5.6.1.2. CCID messages supported ........................................................................................ 21
5.6.1.3. CCID Error Codes ...................................................................................................... 21
6. Commands description ........................................................................................................ 23
6.1. Escape commands for the CLOUD 2700 R ................................................................. 23
6.1.1. Sending Escape commands to CLOUD 2700 R ................................................... 23
6.1.2. Escape command codes ....................................................................................... 24
6.1.2.1. READER_SETMODE ................................................................................................ 25
6.1.2.2. READER_GETMODE ................................................................................................ 25
6.1.2.3. CONTACT_GET_SET_POWER_UP_SEQUENCE ................................................... 26
6.1.2.4. CONTACT_EMV_LOOPBACK .................................................................................. 27
6.1.2.5. CONTACT_EMV_SINGLEMODE .............................................................................. 28
6.1.2.6. CONTACT_APDU_TRANSFER ................................................................................ 28
6.1.2.7. CONTACT_CONTROL_PPS ..................................................................................... 29
6.1.2.8. CONTACT_EXCHANGE_RAW ................................................................................. 29
6.1.2.9. READER_GET_IFDTYPE ......................................................................................... 30
6.1.2.10. READER_LED_CONTROL........................................................................................ 30
6.1.2.11. READER_LED_CONTROL_BY_FW ......................................................................... 31
6.1.2.12. READER_GET_INFO_EXTENDED ........................................................................... 32
6.1.2.13. CONTACT_GET_SET_CLK_FREQUENCY .............................................................. 33
6.1.2.14. CONTACT_GET_SET_ETU ...................................................................................... 34
6.1.2.15. CONTACT_GET_SET_WAITTIME ............................................................................ 35
6.1.2.16. CONTACT_GET_SET_GUARDTIME ........................................................................ 36
6.1.2.17. CONTACT_GET_SET_MCARD_TIMEOUT .............................................................. 37
6.1.2.18. CONTACT_CONTROL_ATR_VALIDATION .............................................................. 38
7. Annexes ............................................................................................................................... 39
7.1. A – Status words table ................................................................................................. 39
7.2. Annex B – Sample code using Escape commands through Escape IOCTL ............... 40
7.3. Annex C – Mechanical drawings .................................................................................. 42
7.3.1. Top Casing ............................................................................................................ 42
7.3.2. Bottom Casing ...................................................................................................... 43
7.3.3. Stand plate ............................................................................................................ 44
7.3.4. Stand socket ......................................................................................................... 45
CLOUD 2700 R REFERENCE MANUAL 6
1. Legal information
1.1. Disclaimers
The content published in this document is believed to be accurate. Identive does not, however, provide any representation or warranty regarding the accuracy or completeness of its content and regarding the consequences of the use of information contained herein. If this document has the status “Draft”, its content is still under internal review and yet to be formally validated.
Identive reserves the right to change the content of this document without prior notice. The content of this document supersedes the content of previous versions of the same document. The document may contain application descriptions and/or source code examples, which are for illustrative purposes only. Identive gives no representation or warranty that such descriptions or examples are suitable for the application that the reader may want to use them for.
Should you notice problems with the provided documentation, please provide your feedback to
support@identive-group.com.
1.2. Licenses
If the document contains source code examples, they are provided for illustrative purposes only and subject to the following restrictions:
x You MAY at your own risk use or modify the source code provided in the document
in applications you may develop. You MAY distribute those applications ONLY in form of compiled applications.
x You MAY NOT copy or distribute parts of or the entire source code without prior
written consent from Identive.
x You MAY NOT combine or distribute the source code provided with Open Source
Software or with software developed using Open Source Software in a manner that subjects the source code or any portion thereof to any license obligations of such Open Source Software.
If the document contains technical drawings related to Identive products, they are provided for documentation purposes only. Identive does not grant you any license to its designs.
1.3. Trademarks
Windows is a trademark of Microsoft Corporation.
CLOUD 2700 R REFERENCE MANUAL 7
Item
Version
Hardware
0.3
Firmware
1.0
2. Introduction to the manual
2.1. Objective of the manual
This manual provides an overview of the hardware and software features of the CLOUD 2700 R smart card reader.
This manual describes in details interfaces and supported commands available for developers using CLOUD 2700 R in their applications.
2.2. Target audience
This document describes the technical implementation of CLOUD 2700 R.
The manual targets software developers. It assumes knowledge about ISO/IEC 7816 and commonly used engineering terms.
Should you have questions, you may send them to support@identive-group.com .
2.3. Product version corresponding to the manual
CLOUD 2700 R REFERENCE MANUAL 8
Term
Expansion
APDU
Application Protocol Data Unit
ATR
Answer to Reset, defined in ISO/IEC 7816
Byte
Group of 8 bits
CCID
Chip Card Interface Device
CID
Card Identifier
LED
Light emitting diode
NA
Not applicable
NAD
Node Address
Nibble
Group of 4 bits. 1 digit of the hexadecimal representation of a byte.
Example:
nibble is 0x3 or (0011)b and the most significant nibble is 0xA or (1010)b
PC/SC
Personal Computer/Smart Card: software interface to communicate between a PC and a smart card
PID
Product ID
RFU
Reserved for future use
USB
Universal Serial Bus
VID
Vendor ID
(xyz)b
Binary notation of a number x, y, z ^0,1`
0xYY
The byte value YY is represented in hexadecimal
2.4. Definition of various terms and acronyms
0xA3 is represented in binary as (10100011)b. The least significant
CLOUD 2700 R REFERENCE MANUAL 9
Doc ref in the manual
Description
Issuer
ISO/IEC 7816
Identification cards Integrated circuit cards Electrical interface and transmission protocols
ISO / IEC
ISO/IEC 7816
Identification cards - Integrated circuit(s) cards with contacts Part 4: Interindustry commands for interchange ISO/IEC 7816-4: 2005 (E)
ISO / IEC
PC/SC
Interoperability Specification for ICCs and Personal Computer Systems v2.01
PC/SC Workgroup
CCID
Specification for Integrated Circuit(s) Cards Interface Devices 1.1
USB-IF USB
Universal Serial Bus Specification 2.0
USB-IF
2.5. References
-3
-4
Part 3: Cards with contacts
CLOUD 2700 R REFERENCE MANUAL 10
2.6. Conventions
Bits are represented by lower case ‘b’ where followed by a numbering digit.
Bytes are represented by upper case ‘B’ where followed by a numbering digit.
Bit number 0Bit number 5
b7 b6 b5 b4 b3 b2 b1 b0
Least significant nibbleMost significant nibble
1 Byte = 8 bits = 2 nibbles
Byte number 11Byte number 2
B4 B5 B6 B7 B8 B9 B10 B11B0 B1 B2 B3
String of 12 bytes
Example:
163 decimal number is represented
x in hexadecimal as 0xA3
x in binary as (10100011)b
The least significant nibble of 0xA3 is
x 0x3 in hexadecimal
x (0011)b in binary
The most significant nibble of =xA3 is
x 0xA in hexadecimal
x (1010)b in binary
CLOUD 2700 R REFERENCE MANUAL 11
3. General information about CLOUD 2700 R
3.1. CLOUD 2700 R key benefits
With its combination of a modern slim design and its state of the art feature set, CLOUD 2700 R is the perfect desktop reader choice for environments where smart card support is required. Such environments may be corporates or authorities where use applications like network log-in, Windows authentication & Single Sign-On are implemented. As for all Identive products, CLOUD 2700 R is designed to offer best in class interoperability.
3.2. CLOUD 2700 R key features
x ISO/IEC 7816 compliant smart card reader
x PC/SC v2.0 compliant
x Unique serial number which enables that CLOUD 2700 R can be plugged into any
USB slot on a PC without having to re-install the driver.
CLOUD 2700 R REFERENCE MANUAL 12
Item
Part number
CLOUD
905369 Stand
905418
CLOUD 2700 R with pre standing base kit
905369
3.3. CLOUD 2700 R ordering information
2700 R
ing Base Kit
-assembled
-1912
3.4. CLOUD 2700 R customization options
Upon request and based on a minimum order quantity, Identive can customize:
x The color of the casing
x The logo
x The product label
x The USB strings
Terms and conditions apply, please contact your local Identive representative or send an email to sales@identive-infrastructure.com.
CLOUD 2700 R REFERENCE MANUAL 13
Applications
3.4.1. General
CLOUD 2700 R is a transparent reader designed to interface a personal computer host supporting PC/SC interface with smart cards according to ISO/IEC 7816 as well as synchronous memory cards like CAC and PKI cards, banking cards and health insurance cards.
USB link
PC/SC interface
Network
Smartcard contacts
ISO7816
`
2700 R
CLOUD
Host
Application logic
CLOUD 2700 R
Interface device
Application logic + User
personal data for given
CLOUD 2700 R itself handles the communication protocol but not the application related to the token. The application-specific logic has to be implemented by software developers on the host.
3.4.2. Applications provided by Identive
Identive provides a few applications for development and evaluation purposes that can function with CLOUD 2700 R. There are some tools provided; here is one of them:
Tokens
set of applications
x Smart card commander version 1.3 provides capabilities to identify most commonly
used cards in the field and display the content of them as well as scripting functionality which can be very useful for developers to develop and debug their applications.
Identive does not provide PKI or CAC applications.
CLOUD 2700 R REFERENCE MANUAL 14
4. CLOUD 2700 R characteristics
4.1. CLOUD 2700 R high level architecture
4.1.1. Block diagram
The link between CLOUD 2700 R and the host to which it is connected is the USB interface providing both the power and the communication channel.
ISO7816 contact
smart card interface
Device controller
To host
Mask ROM controller
LED
The CLOUD 2700 R device controller has several interfaces available. In the CLOUD 2700 R implementation 2 peripherals are connected to the device controller:
x LED for reader status indication
x A smart card interface
The μController contains the firmware developed by Identive to handle all the ISO/IEC 7816 contact protocol and the PC/SC communication protocol with the host.
CLOUD 2700 R REFERENCE MANUAL 15
4.1.2. Software architecture
Applications can interface with the driver directly through the PC/SC interface.
PC/SC Layer
Driver
- Contact Smart Card Reader
T=0/T=1
CLOUD 2700 R
Reader
ICC
FIRMWARE
LAYER
(CCID-API)
The CLOUD 2700 R leverages a PC/SC CCID driver that is freely available for all supported operating systems (Windows, MacOSX and Linux). With current Windows versions (starting with Windows Vista) and MacOSX, this driver is already included in the basic installation.
With the diverse Linux derivatives, there may be distribution specific drivers that should get installed using the install mechanism of the used distribution.
If there is none, the driver may always be downloaded from the webpage of the maintainer, Ludovic Rousseau, https://alioth.debian.org/frs/?group_id=30105.
CLOUD 2700 R REFERENCE MANUAL 16
Item
Characteristic
Value
CLOUD
Weight
66g 204g with Standing Base Kit
External dimensions
70x60x16 mm 70x63x62 mm with Standing Base Kit
Cable length
1.5 meter long with USB type A connector
Default color
white and cool grey
Default label
4.2. Quick reference data
4.2.1. CLOUD 2700 R dimensions
2700 R
Drawing with dimensions of the CLOUD 2700 R can be found in annex.
CLOUD 2700 R REFERENCE MANUAL 17
CLOUD 2700 R states
LED Indication
Reader powered, card out
OFF
Reader powered, card in but not powered
OFF
Card powered
ON
Card access
Blinking (500ms ON/500ms OFF)
error
Blinking (100ms ON/100ms OFF
Parameter
Value/Description
Clock of the device controller
48 API
PC/SC 2.0
Operating temperature range
0º to 50ºC
Operating humidity range
Up to 95%RH non condensing
Certifications
USB CE UL FCC VCCI WEEE RoHS REACH WHQL EMV Listed in GSA APL
Parameter
Value/Description
DC characteristics
Low bus powered (CLOUD 2700 R draws power from USB bus) Voltage: 5V Max. Current : Suspend current : 500uA
USB specification
USB 2.0 FS device
USB Speed
Full Speed Device (12Mbit/s)
Device Class
CCID
PID
0x5810
VID
0x04E6
4.2.2. LED behavior
CLOUD 2700 R is equipped with a green LED. Its behavior is described in the table below.
condition
4.2.3. Other data
4.2.3.1. General
MHz
2
-L1
4.2.3.2. USB
6mA + current consumed by an inserted card
CLOUD 2700 R REFERENCE MANUAL 18
Parameter
Value/Description
Smart card operating frequency
up to 16
Maximum supported card baud-rate
600Kbps
Cards supported
Class A, B and C asynchronous smart cards (T=0, T=1) Synchronous smart cards (2wire, 3wire, I²C)
ISO/IEC 7816 compliant
Yes EMV 4.2 compliant
Yes
CT-API compliant
Yes
Number of slots
Single smart card slot
Ejection mechanism
Manual
4.2.3.3. Card interface
MHz
CLOUD 2700 R REFERENCE MANUAL 19
Operating systems supported by the tools:
5. Software modules
5.1. Installation
On Operating Systems with a PC/SC CCID driver preinstalled, no installation is necessary.
Where there’s no PC/SC CCID driver preinstalled (Linux systems) the driver has to be installed using distribution specific measures or installed using the available source packages.
5.2. Utilities
The following utilities are available:
x A tool for testing the resource manager x A tool called PC/SC Diag capable of providing basic information about the reader
and a card through PC/SC stack
x Windows 2003 Server (32 & 64 bit)
x Windows XP (32 & 64 bit)
x Windows Vista (32 & 64 bit)
x Windows Server 2008 (32 & 64 bit)
x Windows 7
x MacOS X
x Linux
5.3. Driver
5.3.1. CLOUD 2700 R listing
CLOUD 2700 R is listed by PC/SC applications as
x Identive CLOUD 2700 R Smart Card Reader
CLOUD 2700 R uses the PC/SC CCID class driver readily available for all the supported operating systems.
On Windows XP systems, this driver is not preinstalled and has got to be loaded from Windows Update. The Hardware Wizard has got be allowed to load the driver from the internet for that purpose if it is not already present on the system (first time installation).
Starting with Windows Vista, the OS does have the driver preinstalled, so no additional driver installation is necessary.
MacOSX systems do have the PC/SC CCID driver preinstalled.
On Linux systems, the distribution specific installation mechanism should be used.
CLOUD 2700 R REFERENCE MANUAL 20
x Windows 2003 Server (32 & 64 bit)
5.3.2. Supported operating systems
x Windows XP (32 & 64 bit)
x Windows Vista (32 & 64 bit)
x Windows Server 2008 (32 & 64 bit)
x Windows 7
x Windows 8
x MacOS X
x Linux (32 & 64 bit)
5.4. CT-API
A CT-API interface that mostly is used in German banking applications and in conjunction with health insurance cards, is available for the reader.
5.5. MCard-API
With this proprietary Identive API, it is possible to access a vast majority of synchronous memory cards.
Cards supported are:
x SLE4404 x SLE4428 x SLE4432 x SLE4436 x SLE6636 x SLE4442 x SLE5532 x SLE5536 x SLE5542 x AT24C01ASC x AT24C02SC x AT24C04SC x AT24C08SC x AT24C16SC x AT24C32SC x AT24C64SC x AT24C128SC x AT24C256SC x AT24C512SC x AT88SC153 x AT88SC1608 x ST14C02
CLOUD 2700 R REFERENCE MANUAL 21
5.6. Firmware
5.6.1. CCID transport protocol
CLOUD 2700 R implements a transport protocol that is compliant with USB Device Class:
Smart Card CCID Specification for Integrated Circuit(s) Cards Interface Devices Revision 1.10.
This paragraph describes the CCID specification features that are implemented.
5.6.1.1. CCID class requests supported
Abort
x
5.6.1.2. CCID messages supported
The following CCID messages are supported for the contact interface when received through bulk-out endpoint.
x PC_to_RDR_IccPowerOn
x PC_to_RDR_IccPowerOff
x PC_to_RDR_GetSlotStatus
x PC_to_RDR_XfrBlock
x PC_to_RDR_GetParameters
x PC_to_RDR_SetParameters
x PC_to_RDR_Escape
x PC_to_RDR_Abort
x PC_to_RDR_NotifySlotChange
x PC_to_RDR_ResetParameters
x PC_to_RDR_T0APDU
x PC_to_RDR_SetDatarateAndClockFrequency
5.6.1.3. CCID Error Codes
Extensive error codes are reported on many conditions during all CCID responses. Most of the error messages are reported by the CCID appropriately. Some of the main error codes for the contact interface are:
x HW_ERROR
x XFR_PARITY_ERROR
x ICC_PROTOCOL_NOT_SUPPORTED
x BAD_ATR_TS
x BAD_ATR_TCK
x ICC_MUTE
x CMD_ABORTED
x Command not supported
CLOUD 2700 R REFERENCE MANUAL 22
The following sub-sections discuss when and why these error codes are returned:
5.6.1.3.1. HW_ERROR
This error code is returned when a hardware short circuit condition is detected, during application of power to the card or if any other internal hardware error is detected.
5.6.1.3.2. XFR_PARITY_ERROR
This error code is returned when a parity error condition is detected. This error will be reported in the response to a PC_to_RDR_XfrBlock message.
5.6.1.3.3. ICC_PROTOCOL_NOT_SUPPORTED
This error code is returned if the card is signaling to use a protocol other than T=0 or T=1 in its ATR.
5.6.1.3.4. BAD_ATR_TS
This error code is returned if the initial character of the ATR contains invalid data.
5.6.1.3.5. BAD_ATR_TCK
This error code is returned if the check character of the ATR contains is invalid.
5.6.1.3.6. ICC_MUTE
This error code is returned when the card does not respond until the reader time out occurs. This error will be reported in the response to PC_to_RDR_XfrBlock message and PC_to_RDR_IccPowerOn messages.
5.6.1.3.7. CMD_ABORTED
This error code is returned if the command issued has been aborted by the control pipe.
5.6.1.3.8. Command not supported
This error would be returned, if the command would not be supported by the reader.
CLOUD 2700 R REFERENCE MANUAL 23
6. Commands description
6.1. Escape commands for the CLOUD 2700 R
6.1.1. Sending Escape commands to CLOUD 2700 R
A developer can use the following method to send Escape commands to CLOUD 2700 R
x SCardControl method defined in PC/SC API
In Windows, in order to be able to send Escape commands to the CLOUD 2700 R, the feature
has got to be enabled by setting a REG_DWORD value named ‘EscapeCommandEnable’ in the registry to a value of ‘1’.
For Windows XP and Windows Vista, the key to hold the value would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_58 10\ Device-Instance-xxxx \Device Parameters
For Windows 7 and Windows 8, that would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_58 10\Device-Instance-xxxx \Device Parameters\WUDFUsbccidDriver
Device-Instance-xxxx has got to be equal to the serial number of the reader used, so this modification has got to be made for every physical reader intended to be used on the machine in question. The reader has got to be plugged in at least once for the mentioned key to exist and the driver has got to be restarted for this setting to take effect. (Unplug and re-plug the reader).
To be able to work with synchronous memory cards using our MCard API, the same setting will have to be established.
See appendix B for some sample code sending Escape commands to the reader.
CLOUD 2700 R REFERENCE MANUAL 24
Escape command
Code
READER_SETMODE
0x01
READER_GETMODE
0x02
CONTACT_GET_SET_POWERUPSEQUENCE
0x04
CONTACT_EMV_LOOPBACK
0x05
CONTACT_EMV_SINGLEMODE
0x06
CONTACT_APDU_TRANSFER
0x08
CONTACT_CONTROL_PPS
0x0F
CONTACT_EXCHANGE_RAW
0x10
READER_GETIFDTYPE
0x12
READER_LED_CONTROL
0x19
READER_LED_CONTROL_BY_FW
0xB2
READER_GETINFO_EXTENDED
0X1E
CONTACT_GET_SET_CLK_FREQUENCY
0x1F
CONTACT_GET_SET_ETU
0x80
CONTACT_GET_SET_WAITTIME
0x81
CONTACT_GET_SET_GUARDTIME
0x82
CONTACT_GET_SET_MCARD_TIMEOUT
0x85
CONTACT_CONTROL_ATR_VALIDATION
0x88
6.1.2. Escape command codes
Escape commands can be used by an application to configure CLOUD 2700 R to function in a mode that is not its default configured mode or to get specific information. To put the CLOUD 2700 R back into its default mode, it either has to be unplugged and plugged again or the application can send the same Escape command again.
The following Escape commands are supported by CLOUD 2700 R
CLOUD 2700 R REFERENCE MANUAL 25
Output buffer
NULL
Byte0
Byte1
Escape code (0x01)
Mode
Mode
Value
Remarks
ISO
0x00
ISO/IEC 7816 mode
EMV
0x01
EMV
Synchronous
0x02
memory card mode (Synchronous)
Byte0
Escape code(0x02)
6.1.2.1. READER_SETMODE
This Escape command sets the current mode of the reader. Applications may call this function, to set the desired mode. Typically, this call is used to switch between the ISO/IEC 7816, EMV and memory card operations. Upon power on, the reader will reset to the default ISO/IEC 7816 mode.
Input:
The first byte of the input buffer contains the Escape code value and the second one will contain the value for the desired mode of operation. The output buffer field will be NULL.
Following table gives the value of modes as interpreted by the firmware:
ISO mode uses APDU mode of data transfer and is used for normal operations. This is the default mode of the reader on power up.
EMV mode also uses APDU mode of data transfer and is used for EMV test purposes. This mode has more stringent checks for smart card detection and communication as per EMV4.2 spec.
Synchronous mode is used for communicating only with memory cards.
Any other value sent as mode is invalid.
The output buffer is
6.1.2.2. READER_GETMODE
This Escape command may be used to retrieve the current mode of the reader.
The input buffer is
Output:
Current active reader mode will be returned as a BYTE value.
CLOUD 2700 R REFERENCE MANUAL 26
Mode
Value
Remarks
ISO
0x00
ISO/IEC 7816 mode
EMV
0x01
EMV
Synchronous
0x02
memory card mode (synchronous)
Byte0 Byte1
Byte2 Value
Description
Escape code(0x04)
0x00
Starts with Class C voltage. (1.8V
-
0x01
Starts with Class A voltage. (5V
-
0x08
Time delay between resets
Delay value in milliseconds
0x09
Enable/Disable a Voltage Class
Bit Map of all Voltage Classes
[Bit0
Bit1
Bit2
Set bit to enable the Voltage class
Clear bit to disable the Voltage class
0xFE
Retrieves all the above values
-
0xFF
Retrieves the current Power up sequence
-
Following table gives the value of modes as interpreted by reader firmware
6.1.2.3. CONTACT_GET_SET_POWER_UP_SEQUENCE
This Escape command is used by the application/driver to get/set the following parameters:
x Smart card Power-on sequence x Delay between successive Activation retries x Enable/Disable any Voltage Class
As soon as card insertion is detected and power on message is received from the host, the firmware will start activation with the configured voltage sequence. If the activation fails, it will wait for the configured activation delay and then retry with the next enabled voltage class. If power up succeeds at an operating voltage, the firmware will continue card communication at that voltage. If power up fails in all the enabled operating voltages, then the firmware will report an error. The default power-up sequence would be A – B – C.
Input:
The first byte of the input buffer contains the Escape code. The next byte contains the function to be performed. Third byte contains the parameter for the function.
3V 5V order)
3V 1.8V order)
Class A;
Class B;
Class C]
CLOUD 2700 R REFERENCE MANUAL 27
Output buffer
NULL
Byte0
Byte 1
Byte2 Value
Description
0x00
Starts with Class C voltage. (1.8V
Time delay between resets
Bit Map of all Voltage Classes
[Bit0 – Class A; Bit1 – Class B; Bit2
Class C]
0x01
Starts with Class A voltage. (5V
Byte0
Value
Description
0x00
Starts with Class C voltage. (1.8V – 3V – 5V order)
0x01
Starts with Class A voltage. (5V – 3V – 1.8V order)
Byte0
Escape code(0x05)
Output:
For retrieving all settings (0xFE), the output will be the following:
3V 5V order)
3V 1.8V order)
For retrieving current power up sequence (0xFF), the output will be:
Example: retrieve all the current settings:
DataIn = 04 FE DataOut: 01 0A 07 (3 bytes)
00: Starting with Class A 0A: 10ms delay between resets 07: Class A, B, and C enabled
in milliseconds
6.1.2.4. CONTACT_EMV_LOOPBACK
This Escape command lets the host force the firmware to perform an EMV Loop-back application.
The input buffer is
The output buffer is
CLOUD 2700 R REFERENCE MANUAL 28
Output buffer
NULL
Output buffer
Response APDU
Byte0
Escape code(0x06)
Byte0
Byte1 onwards
Escape code(0x08)
Short APDU to be sent to card
6.1.2.5. CONTACT_EMV_SINGLEMODE
This Escape command lets the host perform a one-shot EMV Loop-back application as specified in the EMV Level 1 Testing Requirements document.
The input buffer is
The output buffer is
6.1.2.6. CONTACT_APDU_TRANSFER
This Escape command exchanges a short APDU with the smart card. The user has to ensure that a card is inserted and powered before issuing this Escape command. This Escape command mostly is used by the MCard API to access synchronous memory cards.
Input:
The input buffer contains the Escape code value followed by the short APDU to be sent to the card.
The output buffer contains the response APDU.
CLOUD 2700 R REFERENCE MANUAL 29
Output buffer
NULL
Output buffer
Response APDU
Byte0
Byte1
Escape code(0x0F)
PPS control byte (1-DISABLES PPS, 0-ENABLES PPS)
Byte0
Byte1
Byte2
Byte3
Byte4
Byte 5 onwards
Escape code(0x10)
LSB of send length
MSB of send length
LSB of expected length
MSB of expected length
Raw data to the card
6.1.2.7. CONTACT_CONTROL_PPS
This Escape command enables or disables the PPS done by the firmware/device for smart cards. This setting will take effect from the next card connect and remains effective till it is changed again or the next Reader power on. Default mode is PPS enabled.
Input:
The first byte of input buffer contains the Escape code and the following byte, if 1 disables the PPS and if 0 enables the PPS.
The output buffer is
6.1.2.8. CONTACT_EXCHANGE_RAW
This Escape command can be used to perform raw exchange of data with the card. The user must ensure that a card is inserted and powered on before issuing this Escape command. The Card is deactivated upon any reception error.
Input:
The input buffer for this command will contain the Escape code, low byte of the length of data to be sent, high byte of length of data to be sent, low byte of the length of expected data, high
byte of length of expected data and the command.
Output:
CLOUD 2700 R REFERENCE MANUAL 30
PID value
Description B0
B1
0x10
0x58
USB PID of Identive CLOUD 2700 R smart card Reader
Output buffer
NULL
Byte0
Escape code(0x12)
Byte0
Byte 1
Byte2
Escape code(0x19)
LED number (0 GREEN)
LED state (0-OFF, 1-ON)
6.1.2.9. READER_GET_IFDTYPE
This Escape command is used to get the current IFD type from the reader.
Input: The first byte of the input buffer contains the Escape code.
Output:
The reader returns the PID of the firmware which can be used to identify the reader.
6.1.2.10. READER_LED_CONTROL
This Escape command may be used to toggle the LED state. LED control by firmware should be disabled using the Escape command READER_LED_CONTROL_BY_FW to see proper LED change while using this IOCTL else the LED state will be overwritten by the FW LED behavior.
Input:
The first byte of the input buffer contains the Escape code, followed by LED number always set to 0 (just one LED) and then the desired LED state.
Output:
CLOUD 2700 R REFERENCE MANUAL 31
Output buffer
NULL
or current state
Byte0 Byte1
Value
Description
Escape code(0xB2)
0
Enable LED Control by firmware
1
Disable LED Control by firmware
Get State
FF
0 -- LED control by firmware enabled
1
6.1.2.11. READER_LED_CONTROL_BY_FW
This command is used to enable/disable LED control by firmware. Default setting is: LED is controlled by firmware.
Input:
The first byte of the input buffer contains the Escape code. The second byte specifies if LED control by the firmware should be disabled or enabled. The output buffer is NULL.
-- LED control by firmware disabled
Output:
No response is returned for set state. For Get State 1 byte response is received.
CLOUD 2700 R REFERENCE MANUAL 32
Field Size
Bytes
1
byMajorVersion
Major Version in BCD
Based on current firmware version 1
byMinorVersion
Minor Version in BCD
1 bySupportedModes
Total no of supported modes in the read
0x03 (ISO, EMV and MCard modes)
2 wSupportedProtocols
Protocols supported by the Reader
Bit 0
Bit 1
0x0300 (LSB first)
2 winputDevice
IO_DEV_NONE IO_DEV_KEYPAD IO_DEV_BIOMETRIC 0x02
0x0000(LSB first) 1
byPersonality
Reader Personality (Not Used )
0x00
1
byMaxSlots
Maximum number of slots
0x01 (Single slot device)
1
bySerialNoLength
Serial number length
0x1C
28
abySerialNumber [28]
Unicode serial number
Reader serial number(MSB first)
Byte0
Escape code(0x1E)
6.1.2.12. READER_GET_INFO_EXTENDED
This Escape command may be used to retrieve extended information about the reader and supported features.
Input: The first byte of the input buffer contains the Escape code.
Output:
The firmware returns data as per structure SCARD_READER_GETINFO_PARAMS_EX mentioned below. This Escape command is used to get the firmware version, reader capabilities, and Unicode serial number of the reader.
in
Field Name Field Description Default value
er
T0
T1
0x00
0x01
DataIn = 1E DataOut: 01 00 03 03 00 00 00 00 01 1C 35 00 33 00 36 00
39 00 31 00 33 00 30 00 31 00 32 00 30 00 30 00 30 00 36 00 32 00 (38 bytes)
CLOUD 2700 R REFERENCE MANUAL 33
Output buffer
NULL or
current divisor
DIVISOR VALUE
SCCLK Frequency
12
4 MHz
10
4.8 MHz
8
6 MHz
7
6.8 MHz
6
8 MHz
5
9.6 MHz
4
12 MHz
3
16 MHz
Byte0 Byte1
Value
Description
Escape code(
Clock divisor
The value to be Set in the smart card CLK divisor register
0xFF
Get current Clock divisor value
6.1.2.13. CONTACT_GET_SET_CLK_FREQUENCY
In case when an application wants to get or set the smart card clock frequency, this Escape command is used to instruct the reader to change the clock or to get the current Clock divisor used. Once set, the change in frequency will take effect immediately. Default divisor value is 10, that is 4.8MHz.
Input:
The first byte of the input buffer will contain the Escape code; the next byte will contain the
clock divisor value to set clock frequency or 0xFF to get clock frequency.
0x1F)
Output:
Set clock frequency: None
Get clock frequency: One byte value indicating the current Clock divisor.
Clock Divisor values:
DataIn = 1F FF DataOut: 0A (1 byte)
CLOUD 2700 R REFERENCE MANUAL 34
Byte0 Byte1
Byte2
Byte3
Byte4
Byte5
Value
Description
Wait time
Escape code(0x80)
0x01
SET ETU
BIT31 BIT24
BIT23 BIT16
BIT15 BIT8
BIT7 BIT0
0x00
GET ETU
- - -
-
Byte0
Byte1
Byte2
Byte3
ETU value
BIT31
BIT24
BIT23
BIT16
BIT15
BIT8
BIT7
BIT0
6.1.2.14. CONTACT_GET_SET_ETU
This Escape command is be used by the HOST to get/set the current ETU for smart cards. Once set, the new ETU value will take effect immediately.
Input:
The input buffer contains the Escape followed by an 8 bit GET/SET identifier. For SET ETU, a DWORD specifying the value to be set is following.
Output:
For both Set and Get ETU, the output will be the following.
-
DataIn = 80 00
DataOut: 00 00 01 40 (4 bytes)
-
-
-
-
-
-
-
CLOUD 2700 R REFERENCE MANUAL 35
Byte0 Byte1
Byte2
Byte3
Byte4
Byte5
Byte6
Value
Description
Value
Description
Wait time in ETU
Escape code(0x81)
0x01
SET Wait time
0x00
CWT
BIT31­BIT24
BIT23­BIT16
BIT15­BIT8
BIT7­BIT0
0x01
BWT
0x00
GET Wait time
0x00
CWT
- - -
-
0x01
BWT
Byte0
Byte1
Byte2
Byte3
Wait time in ETU
BIT31
BIT24
BIT23
BIT16
BIT15
BIT8
BIT7
BIT0
6.1.2.15. CONTACT_GET_SET_WAITTIME
This Escape command is used to get/set the Character/Block Waiting Time for smart cards. The wait time is specified in terms of ETU. Once set, the new Wait time will take effect from the next card communication.
Input:
The input buffer contains the Escape code followed by an 8 bit GET/SET identifier, an 8 bit Wait time identifier and a 32 bit Wait time value. BWT must be specified in units of 1.25ms and CWT in units of ETU.
Output:
For both Get/Set Wait time, the output will be the following.
-
DataIn = 81 00 01
DataOut: 00 00 03 5D (4 bytes)
-
-
-
CLOUD 2700 R REFERENCE MANUAL 36
Byte0 Byte1
Byte2
Byte3
Byte4
Byte5
Byte6
Value
Description
Value
Description
Guard time in ETU
Escape code(0x82)
0x01
SET Guard time
0x00
CGT
BIT31­BIT24
BIT23­BIT16
BIT15­BIT8
BIT7­BIT0
0x01
BGT
0x00
GET Guard time
0x00
CGT
- - -
-
0x01
BGT
Byte0
Byte1
Byte2
Byte3
Character Guard time in ETU
BIT31
BIT24
BIT23
BIT16
BIT15
BIT8
BIT7
BIT0
6.1.2.16. CONTACT_GET_SET_GUARDTIME
This Escape command is used to get/set the Character/Block Guard Time of the reader. The guard time is specified in terms of ETU. Once set, the new Guard time will take effect immediately.
Input:
The input buffer contains the Escape code followed by an 8 bit GET/SET identifier, an 8 bit guard time identifier and a 32 bit guard time value in ETU.
Output:
For Get/Set guard time, the output will be the Character/Block Guard Time value.
-
DataIn = 82 00 01 DataOut: 00 00 00 18 (4 bytes)
-
-
-
CLOUD 2700 R REFERENCE MANUAL 37
Byte0 Byte1
Value
Description
Escape code(0x85)
0x01
Delay in
Any value other than 1
Read
emory card
Write
Byte0
Delay in ms
6.1.2.17. CONTACT_GET_SET_MCARD_TIMEOUT
This Escape command is used to get or set the delay which is applied after a Write operation to memory cards. The delay is specified in milliseconds.
Input:
The first byte of the input buffer will contain the Escape code; the next byte will contain the
memory card write delay in seconds.
Output:
Write delay: No response byte
Read delay value: A byte value specifying the current delay applied during memory card Write in milliseconds
DataIn = 85 00 DataOut: 00 (1 byte)
milliseconds for memory card Write
the current applied delay for m
CLOUD 2700 R REFERENCE MANUAL 38
Output buffer
NULL
Byte0 Byte1
Value
Description
Escape code(0x88)
0x00
Enable ATR validation
0x01
Disable ATR validation
6.1.2.18. CONTACT_CONTROL_ATR_VALIDATION
This Escape command is used to enable or disable the ATR validation by the firmware in ISO/IEC 7816 mode.
In case the card would emit an ATR that is not ISO/IEC 7816 compliant, the card reader may fail to power up the card. In these cases, disabling ATR validation will let you work with the card regardless of ISO conformity of the ATR.
By default, ATR validation is enabled.
Input:
The first byte of the input buffer will contain the Escape code; the next byte will contain the
control byte.
Output:
CLOUD 2700 R REFERENCE MANUAL 39
SW1
SW2
Description
0x90
0x00
NO ERROR
0x67
0x00
LENGTH INCORRECT
0x6D
0x00
INVALID INSTRUCTION BYTE
0x6E
0x00
CLASS NOT SUPPORTED
0x6F
0x00
UNKNOWN COMMAND
0x63
0x00
NO INFORMATION GIVEN
0x65
0x81
MEMORY FAILURE
0x68
0x00
CLASS BYTE INCORRECT
0x6A
0x81
FUNCTION NOT SUPPORTED
0x6B
0x00
WRONG PARAMETER P1-P2
7. Annexes
7.1. A – Status words table
CLOUD 2700 R REFERENCE MANUAL 40
7.2. Annex B – Sample code using Escape commands through Escape IOCTL
File Name : CLOUD 2700 R Escape.h
#ifndef _CLOUD_2700 R_ESCAPE_H_ #define _CLOUD_2700 R_ESCAPE_H_
#ifdef __cplusplus extern "C" { #endif
# pragma pack (1) typedef struct { BYTE byMajorVersion; BYTE byMinorVersion; BYTE bySupportedModes; WORD wSupportedProtocols; WORD winputDevice; BYTE byPersonality; BYTE byMaxSlots; BYTE bySerialNoLength; BYTE abySerialNumber [28]; } ReaderInfoExtended; # pragma pack ()
#define IOCTL_CCID_ESCAPE SCARD_CTL_CODE (0xDAC)
#define READER_SET_MODE 0x01 #define READER_GET_MODE 0x02 #define CONTACT_GET_SET_POWERUPSEQUENCE 0x04 #define CONTACT_EMV_LOOPBACK 0x05 #define CONTACT_EMV_SINGLEMODE 0x06 #define CONTACT_APDU_TRANSFER 0x08 #define CONTACT_CONTROL_PPS 0x0F #define CONTACT_EXCHANGE_RAW 0x10 #define READER_GETIFDTYPE 0x12 #define READER_LED_CONTROL 0x19 #define READER_LED_CONTROL_BY_FW 0xB2 #define READER_GETINFO_EXTENDED 0x1E #define CONTACT_GET_SET_CLK_FREQUENCY 0x1F #define CONTACT_GET_SET_ETU 0x80 #define CONTACT_GET_SET_WAITTIME 0x81 #define CONTACT_GET_SET_GUARDTIME 0x82 #define CONTACT_GET_SET_MCARD_TIMEOUT 0x85 #define CONTACT_CONTROL_ATR_VALIDATION 0x88
#ifdef __cplusplus } #endif
#endif
File Name : CLOUD 2700 R Escape.c
#include <windows.h> #include <winbase.h> #include <stdio.h> #include <conio.h> #include "winscard.h" #include "winerror.h" #include "CLOUD 2700R Escape.h"
VOID main(VOID) {
SCARDCONTEXT ContextHandle; SCARDHANDLE CardHandle; ReaderInfoExtended strReaderInfo;
CLOUD 2700 R REFERENCE MANUAL 41
BYTE InByte, i; DWORD BytesRead, ActiveProtocol; ULONG ret; char *ReaderName[] = {"Identive CLOUD 2700 R Smart Card Reader 0", NULL};
/*************************************************************************************** *****************/
ContextHandle = -1;
ret = SCardEstablishContext(SCARD_SCOPE_USER, NULL, NULL, &ContextHandle);
if (ret == SCARD_S_SUCCESS) { ret = SCardConnect( ContextHandle, ReaderName[0], SCARD_SHARE_DIRECT, SCARD_PROTOCOL_UNDEFINED, &CardHandle, &ActiveProtocol);
if (ret == SCARD_S_SUCCESS) { InByte = 0x1E; ret = SCardControl( CardHandle, IOCTL_CCID_ESCAPE, &InByte, 1, &strReaderInfo, sizeof(strReaderInfo), &BytesRead); if (SCARD_S_SUCCESS == ret) { printf("major version:\t\t%d%d\n", (strReaderInfo.byMajorVersion & 0xF0)>> 4, (strReaderInfo.byMajorVersion & 0x0F)); printf("minor version:\t\t%d%d\n", (strReaderInfo.byMinorVersion & 0xF0)>> 4, (strReaderInfo.byMinorVersion & 0x0F)); printf("modes:\t\t\t%d\n", strReaderInfo.bySupportedModes); printf("protocols:\t\t%04x\n", strReaderInfo.wSupportedProtocols); printf("input device:\t\t%04x\n", strReaderInfo.winputDevice); printf("personality:\t\t%d\n", strReaderInfo.byPersonality); printf("max slots:\t\t%d\n", strReaderInfo.byMaxSlots); printf("serial no length:\t%d\n", strReaderInfo.bySerialNoLength); printf("serial no:\t\t"); for (i = 0; i < strReaderInfo.bySerialNoLength; i++) printf("%c", strReaderInfo.abySerialNumber[i]);
} else { printf("SCardControl failed: %08X\n", ret); } } else { printf("SCardConnect failed: %08X\n", ret); }
ret = SCardReleaseContext(ContextHandle); } else { printf("\n SCardEstablishContext failed with %.8lX",ret); }
printf("\npress any key to close the test tool\n"); getch(); }
CLOUD 2700 R REFERENCE MANUAL 42
7.3. Annex C – Mechanical drawings
7.3.1. Top Casing
CLOUD 2700 R REFERENCE MANUAL 43
7.3.2. Bottom Casing
CLOUD 2700 R REFERENCE MANUAL 44
7.3.3. Stand plate
CLOUD 2700 R REFERENCE MANUAL 45
7.3.4. Stand socket
Loading...