Identive CLOUD 45x0 F, CLOUD 4500 F, CLOUD 4510 F Dual Interface Smartcard Reader Reference Manual
Below you will find brief information for Dual Interface Smartcard Reader CLOUD 4500 F, Dual Interface Smartcard Reader CLOUD 4510 F. The CLOUD 45x0 F series are dual interface smart card reader modules designed to make it easy to read both contact smart cards and contactless user tokens. The CLOUD 4500 F is ideal for environments where both contact and contactless smart card support is required, while the CLOUD 4510 F is suited for environments where access to contactless cards with simultaneous access to a contact SAM card is required. These readers are PC/SC v2.0 compliant and offer full CCID for both the contact and contactless interfaces, supporting a variety of card technologies, including ISO 7816 compliant cards, MIFARE series, FeliCa, and NFC forum tags. The CLOUD 45x0 F series also features secure in-field SmartOSTM firmware upgrade capabilities and a unique reader serial number for easy plug-and-play functionality. The CLOUD 45x0 F series can be used in a variety of applications, such as access control, identity management, and payment systems.
Advertisement
Advertisement
Identive Infrastructure
Reference Manual
– version 1.0
CLOUD 45x0 F
Dual Interface Smartcard Reader Modules
Reference manual
CLOUD 45x0 F Dual Interface Smartcard Reader
Modules
© Identive GmbH
Oskar-Messter-Straße, 13
85737 Ismaning
Germany
Phone +49 89 9595 5000 • Fax +49 89 9595 5555
Document history
Date
03/01/2013
Version Description of change
1.0 Initial Version
Contact information
CLOUD 4500 F
CLOUD 4510 F
For sales information, please email [email protected]
Table of Contents
Contactless communication principles and CLOUD 45x0 F usage recommendations 15
PC/SC 2.0 compliant ATR for contactless interface ............................................. 24
PAPDU_MIFARE_READ_BINARY ...................................................................... 30
PAPDU_MIFARE_UPDATE_BINARY .................................................................. 31
PAPDU_MIFARE_LOAD_KEYS .......................................................................... 32
PAPDU_MIFARE_AUTHENTICATE .................................................................... 34
PAPDU_MIFARE_READ_SECTOR ..................................................................... 35
PAPDU_MIFARE_READ_SECTOR_EX .............................................................. 36
PAPDU_MIFARE_WRITE_SECTOR ................................................................... 37
PAPDU_MIFARE_VALUE_BLK_OLD .................................................................. 37
PAPDU_MIFARE_VALUE_BLK_NEW ................................................................. 39
PAPDU_TCL_PASS_THRU (T=CL Pass Thru) ................................................... 40
PAPDU_ISO14443_PART3_PASS_THRU (Mifare Pass Thru) ........................... 41
PAPDU_ISO14443_PART4_PART3_SWITCH (TCL
– Mifare Switch) ................ 41
PAPDU_FELICA_REQ_SERVICE ....................................................................... 42
PAPDU_FELICA_REQ_RESPONSE ................................................................... 43
PAPDU_NFC_TYPE1_TAG_RID ......................................................................... 45
PAPDU_NFC_TYPE1_TAG_RALL ...................................................................... 45
PAPDU_NFC_TYPE1_TAG_READ ..................................................................... 46
PAPDU_NFC_TYPE1_TAG_WRITE_E ............................................................... 46
PAPDU_NFC_TYPE1_TAG_WRITE_NE ............................................................. 47
PAPDU_NFC_TYPE1_TAG_RSEG ..................................................................... 48
PAPDU_NFC_TYPE1_TAG_READ8 ................................................................... 48
PAPDU_NFC_TYPE1_TAG_WRITE_E8 ............................................................. 49
PAPDU_NFC_TYPE1_TAG_WRITE_NE8 ........................................................... 49
Sending Escape commands to CLOUD 45x0 F ................................................... 50
Common for Contact and Contactless Interfaces ................................................. 51
READER _CONTROL_CONTACT_SLOT ................................................................. 57
CNTLESS_IS_COLLISION_DETECTED ................................................................... 67
CNTLESS_P2P_INITIATOR_DESELECT ................................................................. 72
CNTLESS_P2P_INITIATOR_TRANCEIVE ............................................................... 73
CNTLESS_GET_SET_NFC_PARAMS ...................................................................... 75
CNTLESS_GET_P2P_EXTERNAL_RF_STATE ....................................................... 76
CONTACT_GET_SET_PWR_UP_SEQUENCE ........................................................ 78
CONTACT_GET_SET_CLK_FREQUENCY .............................................................. 83
CONTACT_CONTROL_ATR_VALIDATION .............................................................. 84
CONTACT_GET_SET_MCARD_TIMEOUT .............................................................. 85
CONTACT_READ_INSERTION_COUNTER ............................................................. 89
Module Mounting Holes, HF Antenna and LED Details ............................................... 90
CLOUD 4500F USB Interface and Smart Card Connector Details .............................. 91
CLOUD 4510F USB Interface and SAM Card Connector Details ............................... 93
– Sample code using escape commands ...................................................... 98
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
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 [email protected]
.
1.2. Licenses
If the document contains source code examples, they are provided for illustrative purposes only and subject to the following restrictions:
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.
You MAY NOT copy or distribute parts of or the entire source code without prior written consent from Identive.
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
MIFARE
TM
is a registered trademark of NXP Semiconductors BV.
Windows is a trademark of Microsoft Corporation.
8
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
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 45x0 F dual interface smart card reader modules (CLOUD 4500 F and CLOUD 4510 F).
This manual describes in detail interfaces and supported commands available for developers using CLOUD45x0 F in their applications.
The reader will additionally find in this document important component location to help with the design of custom external housing.
2.2. Target audience
This document describes the technical implementation of CLOUD 45x0 F.
The manual targets software developers. It assumes knowledge about ISO 7816, 13.56 MHz contactless technologies like ISO/IEC 14443 and commonly used engineering terms.
Should you have questions, you may send them to [email protected]
.
2.3. Product version corresponding to the manual
Item Version
Hardware 0.3
Firmware 1.00
9
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
2.4. Definition of various terms and acronyms
Term Expansion
APDU
ATR
ATS
Byte
CCID
CID
DFU
DR
DS
LED
MIFARE
NA
NAD
Nibble
PCD
PC/SC
PICC
PID
Proximity
PUPI
RF
RFU
USB
VID
(xyz)b
0xYY
Application Protocol Data Unit
Answer to Reset, defined in ISO7816
Answer to select, defined in ISO/IEC 14443
Group of 8 bits
Chip Card Interface Device
Card Identifier
Device Firmware Upgrade
Divider receive: used to determine the baud rate between the reader to the card
Divider send: used to determine the baud rate between the card to the reader
Light emitting diode
The ISO14443 Type A with extensions for security (NXP)
Not applicable
Node Address
Group of 4 bits. 1 digit of the hexadecimal representation of a byte.
Example: 0xA3 is represented in binary as (10100011)b. The least significant nibble is
0x3 or (0011)b and the most significant nibble is 0xA or (1010)b
Proximity Coupling Device
Personal Computer/Smart Card: software interface to communicate between a PC and a smart card
Proximity Integrated Chip Card
Product ID
Distance coverage till ~10 cm.
Pseudo unique PICC identifier
Radio Frequency
Reserved for future use
Universal Serial Bus
Vendor ID
Binary notation of a number x, y, z
0,1
The byte value YY is represented in hexadecimal
10
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
2.5. References
Doc ref in the manual
Description
ISO/IEC 7816-3
ISO/IEC 7816-4
Identification cards
— Integrated circuit cards
—Part 3:Cards with contacts — Electrical interface and transmission protocols
Identification cards - Integrated circuit(s) cards with contacts
Part 4: Interindustry commands for interchange
ISO/IEC 14443-3
ISO/IEC 7816-4: 1995 (E)
Identification cards
— Contactless integrated circuit(s) cards
— Proximity cards
—Part 3:Initialization and anticollision
ISO/IEC 14443-4 Identification cards
— Contactless integrated circuit(s) cards
— Proximity cards
Part 4: Transmission protocol ISO/IEC 14443-
4:2001(E)
PC/SC
PCSC3
PCSC3-AMD1
PCSC3-SUP
PCSC3-SUP2
CCID
USB
AN337
AN338
Interoperability Specification for ICCs and Personal
Computer Systems v2.01
Interoperability Specification for ICCs and Personal
Computer Systems
Part 3. Requirements for PC-Connected Interface
Devices
Interoperability Specification for ICCs and Personal
Computer Systems
Part 3. Requirements for PC-Connected Interface
Devices
– Amendment 1
Interoperability Specification for ICCs and Personal
Computer Systems
Part 3. Supplemental Document
Interoperability Specification for ICCs and Personal
Computer Systems
Part 3. Supplemental Document for Contactless
ICCs
Specification for Integrated Circuit(s) Cards
Interface Devices 1.1
Universal Serial Bus Specification 2.0
Application Note describing handling of DESFire
EV1 cards
Application Note describing handling of MIFARE
Plus cards
Issuer
ISO / IEC
ISO / IEC
ISO / IEC
ISO / IEC
PC/SC Workgroup
PC/SC Workgroup
PC/SC Workgroup
PC/SC Workgroup
PC/SC Workgroup
USB-IF
USB-IF
Identive
Identive
11
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
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 5 Bit number 0 b7 b6 b5 b4 b3 b2 b1
Most significant nibble Least significant nibble
1 Byte = 8 bits = 2 nibbles
Byte number 2 b0
B0 B1 B2 B3 B4 B5 B6 B7
Byte number 11
B8 B9 B10 B11
String of 12 bytes
Example:
163 decimal number is represented
in hexadecimal as 0xA3
in binary as (10100011)b
The least significant nibble of 0xA3 is
0x3 in hexadecimal
(0011)b in binary
The most significant nibble of =xA3 is
0xA in hexadecimal
(1010)b in binary
12
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
3. General information about CLOUD 45x0 F
3.1. CLOUD 45x0 F key benefits
With its state of the art feature set, CLOUD 4500 F is the perfect reader choice for environments where both contact and contactless smart card support is required while CLOUD
4510 F perfectly fits environments where access to contactless cards with simultaneous access to a contact SAM card is required.
As for all Identive products, CLOUD 45x0 F is designed to offer best in class interoperability.
3.2. CLOUD 45x0 F key features
13.56MHz contactless reader: o ISO14443 type A & B, o MIFARE
TM
ISO7816 compliant contact smart card reader for ID-1 cards (CLOUD 4500 F)
ISO7816 compliant contact smart card reader for ID-000 cards (CLOUD 4510 F)
PC/SC v2.0 compliant
Full CCID for both the contact and the contactless interfaces
Secure in-field SmartOS
TM firmware upgrade
Unique reader serial number which enables that CLOUD 45x0 F can be plugged into any USB slot on a PC without having to re-install the driver. Additionally, the application S/W running on the host can check for exact readers
249 bytes of non-volatile user memory
NFC P2P (passive mode) capable
Secure key loading support for MIFARE Classic cards
Communication speed up to 848Kbps
13
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
3.3. CLOUD 45x0 F ordering information
Item Part number
CLOUD 4500 F 905322
CLOUD 4510 F 905323
3.4. CLOUD 45x0 F customization options
Upon request and based on a minimum order quantity, Identive can consider customizing:
The product label
The USB strings
Terms and conditions apply, please contact your local Identive representative or send an email to [email protected]
.
14
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
3.5. Contactless communication principles and CLOUD
45x0 F usage recommendations
CLOUD 45x0 F is a dual interface reader module capable of reading both contact smart cards and contactless user tokens. The following paragraph focuses on a few specifics of contactless communication to outline usage recommendations in order to ensure best user experience.
CLOUD 45x0 F is a contactless reader
1
designed to communicate with user credentials.
User credentials
2
are made of a contactless integrated circuit chip connected to an antenna
User credentials can take several form factors:
Credit card sized smart card
Key fob
USB token
NFC mobile phone etc…
Communication between CLOUD 45x0 F and user credentials uses magnetic field inductive coupling.
The magnetic field generated by CLOUD 45x0 F has a carrier frequency of 13.56MHz.
C
L
O
U
D
4
5 x0
F
CLOUD 45x0 F
User tokens
3.5.1. Power supply
When the user credential is put in the magnetic field of the reader, its antenna couples with the reader and an induction current appears in the antenna thus providing power to the integrated circuit. The generated current is proportional to the magnetic flux going through the antenna of the user credential.
3.5.2. Data exchange
The carrier frequency of the magnetic field is used as a fundamental clock signal for the communication between the reader and the credential. It is also used as a fundamental clock input for the integrated circuit microprocessor to function.
To send data to the user credential the reader modulates the amplitude of the field. There are several amplitude modulation and data encoding rules defined in ISO/IEC 14443. The reader should refer to the standard for further details.
To answer the reader, the integrated circuit card of the user credential modulates its way of loading (impedance) the field generated by the reader. Here also further details can be found in
ISO/IEC 14443.
15
1
In the ISO/IEC 14443 standard, the reader is called the proximity coupling device (PCD)
2
In the ISO/IEC 14443 standard, the user credential is called proximity integrated chip card (PICC)
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
3.5.3. Recommendations
The communication between the reader and the user credential is sensitive to the presence of material or objects interfering with the magnetic field generated by the reader.
The presence of conductive materials like metal in the vicinity of the reader and the user credential can significantly degrade the communication and even make it impossible. The magnetic field of the reader generates Eddy or Foucault’s currents in the conductive materials; the field is literally absorbed by that kind of material.
It is recommended for proper communication to avoid putting CLOUD 45x0 F in close proximity of conductive materials.
A minimum distance of 2.5cm (1”) should be kept.
To prevent the fields of adjacent readers to interfere with each other, a minimum distance between readers of 2.5cm (1”) should be kept.
The presence of multiple user credentials in the field also interferes with the communication.
When several user credentials are in the field of the reader, load of the field increases which implies that less energy is available for each of them and that the system is detuned. For this reason, Identive has implemented in its driver only one slot.
It is recommended to present only one user credential at a time in front of
CLOUD 45x0 F.
The communication between the reader and the credential is sensitive to the geometry of the system {reader, credential}. Parameters like the geometry and especially the relative size of the reader’s and credential’s antennas directly influence the inductive coupling and therefore the communication.
CLOUD 45x0 F was designed and optimized to function with user credentials of various technologies and sizes.
It may happen, that CLOUD 45x0 F is not capable of communicating with extremely large or extremely small credentials.
In order to optimize the coupling between the reader and the credential, it is recommended to put both antennas as parallel as possible to each other
In order to optimize transaction speed between the reader and the card it is recommended to place the credential as close as possible to the reader. This will increase the amount of energy supplied to the user credential which will then be able to use its microprocessor at higher speeds
3.6. Applications
3.7.1. General
CLOUD 4500 F is a transparent reader module designed to interface a personal computer host supporting PC/SC interface with 13.56MHz user tokens like public transport cards, contactless banking cards, electronic identification documents
– e.g. e-passports, e-ID cards, driving licenses etc. and smartcards according to ISO7816 as well as synchronous memory cards like
CAC and PKI cards and health insurance cards.
User credentials can have several form factors like credit cards, key fobs, NFC mobile phones or USB dongles like our SCTxxxx or @MAXX products.
16
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
17
CLOUD 4510 F incorporates a SAM slot for SIM-sized cards instead of the standard card slot for ID-1 sized cards of the CLOUD 4500 F.
RF link (13.56MHz)
ISO14443 interface
Smartcard contacts
ISO7816
Network
USB link
PC/SC interface
`
C
L
O
U
D
4
5 x0
F
CLOUD 4500
CLOUD 4510
Host CLOUD 45x0 F
Interface device
Credentials/SAM
Application logic
Application logic + User personal data for given set of applications
CLOUD 45x0 F itself handles the communication protocol but not the application related to the credential or card. The application-specific logic has to be implemented by software developers on the host.
3.7.2. Applications provided by Identive
Identive does not provide payment or transport applications or PKI or CAC applications.
Identive provides a few applications for development and evaluation purposes that can function with CLOUD 45x0 F. There are many tools provided; here are two of them:
The Simple NFC Tag Editor is part of our NFC-NDEF Editor Kit that enables the user to read and write NFC forum compliant records from/to NFC forum compatible tags.
It is an easy to use tool to configure NFC forum tag demonstrations rapidly, available in our web shop .
Smart card commander version 1.3 provides capabilities to identify most common 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.
This tool is as well part of all our SDKs and available as a stand-alone product .
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
4. CLOUD 45x0 F characteristics
4.1. CLOUD 45x0 F high level architecture
4.1.1. Block diagram
The link between CLOUD 45x0 F 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
To host
Device controller RF front-end
EMC filter +
Matching circuitry text text text
LED
The device controller has several interfaces available. In the CLOUD 45x0 F implementation three peripherals are connected to the device controller:
LED for reader status indication
A contact smart card interface
An RF front-end that handles the RF communication
The controller contains the firmware developed by Identive to handle all the ISO7816 contact protocol, the RF communication protocols and the PC/SC communication protocol with the host. The flash can be upgraded once the device is deployed in the field, hence enabling firmware upgrades to add and potentially patch features.
The RF front-end ensures the coding/decoding/framing modulation/demodulation required for the RF communication. It is controlled by the device controller through registers.
The matching circuitry provides the transmission and receiver paths adaptation for the antenna to function properly.
18
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
4.1.2. Software architecture
Applications can interface with the driver directly through the PC/SC interface.
Contact Reader
Contactless
Reader
PC/SC Layer
Driver
- Contact Smart Card
Reader
Driver
- Contactless Card
Reader
19
T= 0 / T= 1
SLOT 0
T = CL
SLOT 1
FIRMWARE
LAYER
CLOUD 45x0 F
Reader
ICC
PICC
The CLOUD 45x0 F 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 .
Additionally, Identive provides a proprietary driver for all the supported OSs.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
4.2. Quick reference data
Item
4.2.1. CLOUD 45x0 F dimensions
Characteristic Value
Weight
External dimensions
37g
100 mm X 70 mm X 11 mm
CLOUD
4500 F
Default label
Weight
External dimensions
CLOUD
4510 F
Default label
27g
100 mm X 70 mm X 10 mm
Drawing with dimensions of the CLOUD 45x0 F can be found in annex.
20
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
4.2.2. LED behavior
CLOUD 45x0 F is equipped with one bicolor LED. Its behavior is described in the table below.
GREEN RED Reader states
Just after plug-in (with drivers already installed)
ON OFF
Just after DFU operation
Suspend / standby
ON
OFF
OFF
OFF
Reader powered, Contact card
IN, but not powered
Reader powered, Contactless card IN, but not powered
ON
ON
OFF
ON
Contact card powered / communication
Contactless card powered / communication
Reader / card errors
500ms ON
500ms OFF
500ms ON
500ms OFF
OFF
OFF
500ms ON
500ms OFF
100ms ON
100ms OFF
Dual interface card powered in contact Slot
Dual interface card powered using RF field
500ms ON
500ms OFF
500ms ON
500ms OFF
OFF
500ms ON
500ms OFF
4.2.3. Other data
Parameter
4.2.3.1. General
Value/Description
Clock of the device controller
API
Operating temperature range
Operating humidity range
Certifications
8MHz
PC/SC 2.0
0º to 50ºC
Up to 95%RH non condensing
USB
CE
FCC
WEEE
RoHS2
REACH
WHQL
21
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Parameter
4.2.3.2. USB
Value/Description
DC characteristics
USB specification
USB Speed
Device Class
PID
VID
High bus powered (CLOUD 45x0 F draws power from USB bus)
Voltage: 5V
Avg. Current : 110mA (RF on, no cards present)
Suspend Current: 400µA
USB 2.0 FS Device
Full Speed Device (12Mbit/s)
CCID
0x5720 for CLOUD 4500 F; 0x5721 for CLOUD 4510 F
0x04E6
Parameter
4.2.3.3. Contact card interface
Value/Description
Smart card operating frequency
Maximum supported card baud-rate
Cards supported
ISO-7816 compliant
CT-API compliant
Number of slots
Ejection mechanism up to 12MHz
600Kbps
ISO/IEC 7816 smart cards - Class A, B and C
Synchronous smart cards
Yes
Yes
Single smart card slot
Manual
Parameter
4.2.3.4. Contactless interface
Value/Description
RF carrier frequency 13.56MHz +/-50ppm
Maximum supported card baud-rate
848Kbps
Cards supported
MIFARE: Classic 1K and 4K, DESFire, DESFire EV1, Ultralight,
Ultralight C, MIFARE mini and MIFARE Plus
FeliCa™ 212 and 424 Kbps support: FeliCa Standard/Lite
NFC forum tag type 1, 2, 3, 4
iCLASS UID support
my-d move
– SLE 66RxxP, my-d move NFC – SLE 66RxxPN,
SLE 66RxxS, SLE 55RxxE
NFC enabled Smart Phones and Tablets
3
ISO-14443A and B compliant
Number of slots
Ejection mechanism
Yes
1
Manual
22
3
tested with available device during development & qualification phase
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
5. Software modules
5.1. Installation
On Operating Systems with a CCID driver pre-installed, no installation is necessary.
Where there’s no CCID driver pre-installed – e.g. Linux systems or old Windows systems – the driver has to be installed using distribution-specific measures or using the available source packages.
Due to some limitations of the available CCID drivers under some circumstances, Identive does provide a dedicated driver for this reader, as well, which is available through Windows Update or on the Identive support pages .
5.2. Utilities
The following utilities are available:
A tool for testing the resource manager
A tool called PCSCDiag capable of providing basic information about the reader and a card through PC/SC stack
5.3. Driver
5.3.1. CLOUD 45x0 F listing
CLOUD 45x0 F is listed by PC/SC applications as
Identive CLOUD 47x0 F Contact Reader
Identive CLOUD 47x0 F Contactless Reader
5.3.2. Supported operating systems
Windows XP (32 & 64 bit)
Windows 2003 Server (32 & 64 bit)
Windows Vista (32 & 64 bit)
Windows Server 2008 (32 & 64 bit)
Windows 7 (32 & 64 bit)
Windows 8 (32 & 64 bit)
MacOS X
Linux
23
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
5.3.3. PC/SC 2.0 compliant ATR for contactless interface
When a user credential is placed on the reader, initialization, anti-collision is done. The user credential is automatically activated and an ATR is built as defined in the PC/SC specification.
For further information, please refer to section 3.1.3.2.3 of [PCSC3] and to [PCSC3-SUP]
5.3.3.1. ATR for contactless storage user tokens
The ATR of the credential is composed as described in the table below. In order to allow the application to identify the storage card properly, it’s Standard and Card name describing bytes must be interpreted according to the Part 3 Supplemental Document, maintained by PC/SC.
Credentials using technology like MIFARE are examples of this:
Byte# Value Designation Description
0
1
2
3
4...3+n
4+n
0x3B
0x8n
0x80
0x01
0x80
0x4F
Length
RID
PIX
0x00 0x000x000x00
Initial header
T0 n indicates the number of historical bytes in following ATR
TD1 upper nibble 8 indicates no TA2, TB2, TC2 lower nibble 0 means T=0
TD2 upper nibble 0 indicates no TA3, TB3, TC3 lower nibble 1 means T=1
A status indicator may be present in an optional TLV data object
Optional TLV data object
TCK
Tag: Application identifier
1 byte
Registered identifier on 5 bytes
Proprietary identifier extension on 3 bytes
4 RFU bytes
XOR of all previous bytes
Example of the ATR built for contactless storage tokens:
MIFARE Classic 4K MIFARE Ultralight
24
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
5.3.3.2. ATR for ISO/IEC 14443-4 user tokens
The credential exposes its ATS or application information which is mapped to an ATR. The table describes how this mapping is done.
Byte# Value Designation Description
0
1
2
3
4...3+n
0x3B Initial header
0x8n T0 n indicates the number of historical bytes in following ATR
0x80 TD1 upper nibble 8 indicates no TA2, TB2, TC2 lower nibble 0 means T=0
0x01 TD2 upper nibble 0 indicates no TA3, TB3, TC3 lower nibble 1 means T=1
4+n
Historical bytes application information or
TCK
Type A: the historical bytes from the ATS (up to 15 bytes)
Type B (8 bytes):
Byte 0 through 3: application data from ATQB,
Byte 4 through 6: protocol info byte from ATQB,
Byte 7: highest nibble is the MBLI (maximum buffer length index) from ATTRIB, lowest nibble is 0x0
XOR of all previous bytes
Example of the ATR built for an ISO14443-4 credential:
Type A Type B
25
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
5.4. Firmware
5.4.1. CCID transport protocol
CLOUD 45x0 F 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.4.1.1. CCID class requests supported
Abort
5.4.1.2. CCID messages supported
The following CCID messages are supported for the contact interface when received through bulk-out endpoint.
PC_to_RDR_IccPowerOn
PC_to_RDR_IccPowerOff
PC_to_RDR_GetSlotStatus
PC_to_RDR_XfrBlock
PC_to_RDR_GetParameters
PC_to_RDR_ResetParameters
PC_to_RDR_SetParameters
PC_to_RDR_Escape
PC_to_RDR_ICCClock
PC_to_RDR_T0APDU
PC_to_RDR_Abort
PC_to_RDR_SetDataRateAndClockFrequency
5.4.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:
HW_ERROR
XFR_PARITY_ERROR
ICC_PROTOCOL_NOT_SUPPORTED
BAD_ATR_TS
BAD_ATR_TCK
ICC_MUTE
CMD_ABORTED
Command not supported
The following sub-sections discuss when and why these error codes are returned:
26
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
27
5.4.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.4.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.4.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.4.1.3.4. BAD_ATR_TS
This error code is returned if the initial character of the ATR contains invalid data.
5.4.1.3.5. BAD_ATR_TCK
This error code is returned if the check character of the ATR contains is invalid.
5.4.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.4.1.3.7. CMD_ABORTED
This error code is returned if the command issued has been aborted by the control pipe.
5.4.1.3.8. Command not supported
This error would be returned, if the command would not be supported by the reader.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6. Commands description
6.1. Generic APDU
6.1.1. Working with DESFire and MIFARE Plus tokens
To work with DESFire EV1 and MIFARE Plus tokens, please refer to the according application notes [AN337] and [AN338], respectively.
Please note that, since these application notes contain information available only under NDA with NXP, you’d need to sign an NDA with NXP to be allowed to receive them.
6.1.2. PAPDU_GET_UID
GET UID will retrieve the UID or SNR or PUPI of the user token. This command can be used for all supported technologies.
Command APDU
:
CLA
0xFF
INS
0xCA
P1
0x00
P2
0x00
Lc
-
Data in
-
Le
XX
Setting Le = 0x00 can be used to request the full UID or PUPI. (e.g. for ISO14443A single 4 bytes, double 7 bytes, triple 10 bytes, for ISO14443B 4 bytes PUPI).
Response APDU:
Data
Requested bytes of UID
Status Word
SW1, SW2
6.1.3. PAPDU_ESCAPE_CMD
Usually escape commands are transmitted through SCardControl as defined in PCSC API using IOCTL_CCID_ESCAPE. But on some environments, the driver will block this IOCTL unless the registry has been edited to allow it. Hence this vendor specific APDU was defined to transmit Escape commands to the reader as below
Command APDU
:
CLA
0xFF
INS
0xCC
P1
0x00
P2
0x00
Lc
Length of data
Data in
Escape
Command
Buffer
Le
XX
Response APDU:
Data
Reader Response
Status Word
SW1, SW2
28
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
29
Example:
1)
To issue the “READER_GETIFDTYPE (0x12)” escape command , this pseudo APDU would be used:
Command APDU : FF CC 00 00 01 12
Response : 20 57 90 00
2)
To issue the “READER_SETMODE (0X01)” escape command, this pseudo APDU would be used:
Command APDU : FF CC 00 00 02 01 01 (to set to EMV mode)
Response APDU : 90 00
Note:
1) To send Escape commands using this method, the reader should be connected in shared mode using T0 or T1 protocol. Only then would the resource manager allow
SCardTransmit.
2)
As the escape commands defined using “
7816 APDU format, they can be sent using SCardTransmit without having any need to prepend “FF CC 00 00 P3”.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2. Supported Pseudo APDU (Contactless Interface)
All Pseudo APDUs specific to Contactless Interface supported in the reader are explained in this section
6.2.1. PAPDU_MIFARE_READ_BINARY
This command is used to read data from a Mifare card. Refer to section 3.2.2.1.8 of [PCSC3] for details.
Command APDU
:
Command
Read Binary
CLA
0xFF
INS P1 P2
0xB0 Addr MSB Addr LSB
Lc
-
Data
-
Le
xx
P1 and P2 represent the block number of the block to be read, starting with 0 for sector 0, block
0, continuing with 4 for sector 1, block 0 (sector no. x 4 + block no.)
Regardless of the value given in Le, this command will always return the entire block content:
16 bytes for Mifare Classic
4 bytes for Mifare UL and UL C
Response APDU:
Data
N bytes of block data
Status Word
SW1, SW2
Example:
For a Mifare Classic 1K card with the following content:
30
The following command will read the sixth block and yield the mentioned output:
APDU:
FF B0 00 05 02
SW12:
9000 (OK)
DataOut:
00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
(16 bytes)
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.2. PAPDU_MIFARE_UPDATE_BINARY
This command is used to update the non-volatile memory of a Mifare card. Refer to section
3.2.2.1.9 of [PCSC3] for further details.
Command APDU
:
Data
data
Le
-
Command CLA
Update Binary 0xFF
INS
0xD6
P1
Addr MSB
P2
Addr LSB
Lc
xx
For a description of P1 and P2, see PAPDU_MIFARE_READ_BINARY
Lc has got to match the block size of the used card
16 bytes for Mifare Classic
4 bytes for Mifare UL and UL C
Response APDU:
Data Status Word
- SW1, SW2
Example:
To write the bytes AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 to block 7 of a Mifare Classic 1K, the following command has got to be issued:
APDU:
FF D6 00 06 10 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55
SW12:
9000 (OK)
Resulting in this content on the card:
31
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
32
6.2.3. PAPDU_MIFARE_LOAD_KEYS
This command is used to load the key to the volatile memory of the reader. It can be used for all kinds of contactless cards. Refer to section 3.2.2.1.4 of [PCSC3] for further details.
Command APDU :
Command CLA INS P1 P2 Lc
Key data
Data Le
Load Keys 0xFF 0x82 Key Struct Key Num
The Key Structure (P1) is defined as follows:
Key -
b7 b6 b5 b4 b3 b2 b1 b0 Description x x x
0: Card Key; 1 Reader Key
0: Plain Transmission, 1: Secured Transmission
0: Keys are loaded into the volatile memory
1: Keys are loaded into the non-volatile memory. x xxxx
RFU
If b6 is set, it is the Reader Key number that has been used for the encryption, else it is ignored.
Only one reader key (0x00) is supported by CLOUD
45x0 F
Notes
:
1)
Card keys can be loaded in both “secure” and “non-secure” mode. Card keys can only be loaded to the Volatile memory of the reader.
2) To load the card keys in secure mode, the application developer has to know the 128 bit AES key of the reader. The default key is “00010203 05060708 0A0B0C0D
0F101112
”.
As a Mifare key is only 6 bytes in length, data needs to be padded as per pkcs7 padding scheme (see example below).
3) The Reader-key can only be loaded in the secure-mode to the non-volatile memory of the reader. The new key is first XORed with the old key and encrypted with the old key.
In order to validate the integrity of the processed key data, a 2 byte CRC has got to be sent following the key data. Refer to the example Load Keys
– Reader – Secure
for details.
4) The CRC16 is calculated as defined in CRC-16-CCITT (polynomial 0x8408) with an initial value of 0x0000.
Response APDU:
Data Status Word
- SW1, SW2
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
33
Examples
Load Keys
– Card – Non-Secure
The command to load Mifare key A “FF FFFFFFFFFF” is
FF82006006 FFFFFFFFFFFF
Load Keys
– Card – Secure:
If the default AES128 reader is key is 00010203 05060708 0A0B0C0D 0F101112 then the following explains the steps needed to calculate the key for secure mode.
Default reader key
: 00010203 05060708 0A0B0C0D 0F101112
Mifare Key to be loaded
: FFFFFFFF FFFF
Mifare key after padding
: FFFFFFFF FFFF0A0A 0A0A0A0A 0A0A0A0A
AES128 Encrypted
Load keys command
: 10229E33 189403FD A9C14110 B1BB02B4
: FF82406010 10229E33 189403FD A9C14110 B1BB02B4
Load Keys
– Reader – Secure
If the default AES128 reader is key is 00010203 05060708 0A0B0C0D 0F101112 then the following explains the steps needed to change the reader key to 10111213 15161718
1A1B1C1D 1F202122.
Reader old-key : A: 00010203 05060708 0A0B0C0D 0F101112
Reader new-key : B: 10111213 15161718 1A1B1C1D 1F202122
C = XOR (A, B) : C: 10101010 10101010 10101010 10303030
D = CRC16(C) : D: 1C5F
E = 0x00 - D : E: E3A1 (should be appended in LSB order)
F = AES-Encrypt (C) : F: 886B0872 7BDA4996 D296FB46 09D2C75F
Load-Keys Command : G: FF82E00012 886B0872 7BDA4996 D296FB46 09D2C75F A1E3
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.4. PAPDU_MIFARE_AUTHENTICATE
This command is used to authenticate using the key number. Refer to section 3.2.2.1.6 of
[PCSC3] for further details.
Command APDU :
Command CLA INS P1
General
Authenticate 0xFF 0x86 0x00
The data structure is defined as follows:
Byte # Value Description
P2
0x00
Lc
0x05
Data
data
Le
xx
B0
B1
B2
B3
0x01
0x60
0x61
B4
Response APDU:
Version
Block Number MSB (always 0x00 for Mifare
Classic cards)
Block Number LSB
Mifare Classic Key A
Mifare Classic Key B
Key number
– shall be set to 0x01
Data Status Word
- SW1, SW2
Example:
Load Key A unencrypted and authenticate for block 6 (sector 1, actually) with that key:
APDU:
FF 82 00 60 06 FF FF FF FF FF FF
SW12:
9000 (OK)
APDU:
FF 86 00 00 05 01 00 06 60 01
SW12:
9000 (OK)
34
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.5. PAPDU_MIFARE_READ_SECTOR
This command reads the specified sector from a Mifare Classic card (first 3 blocks of the sector, excluding the Key block) or the entire content of Mifare UL/UL C cards.
Command APDU:
Command CLA INS P1 P2 P3 Data
Read Sector FF B1 Addr MSB Addr LSB 0 -
Response APDU:
Data
Mifare classic - 48 bytes of sector data read from card /
Mifare UL
– Entire card data is returned (64 bytes)
Example
:
Status Word
SW1, SW2
Read sector 1 of a Mifare Classic 1K
APDU:
FF B1 00 01 00
SW12:
9000 (OK)
DataOut:
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55
(48 bytes)
Read entire content of a Mifare UL:
APDU:
FF B1 00 01 10
SW12:
9000 (OK)
DataOut:
04 6B 5D BA 09 F8 01 80 70 48 00 00 E1 10 06 00
00 01 02 03 1D 6E 6F 6B 69 61 2E 63 6F 6D 3A 62
74 01 00 11 67 9F 5F B6 04 06 80 30 30 30 30 00
00 00 00 00 00 00 00 00 00 00 00 02 42 54 FE 00
(64 bytes)
35
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.6. PAPDU_MIFARE_READ_SECTOR_EX
This command read the specified sector from a Mifare Classic card (all the 4 blocks of the sector, including the Key block) or the entire content of Mifare UL/UL C cards.
Command APDU:
Command
Read Sector
Extended
Response APDU:
CLA
FF
INS
B3
P1
Data
Mifare classic - 64 bytes of sector data read from card /
Mifare UL
– Entire card data is returned (64 bytes)
P2
Addr MSB Addr LSB
SW1, SW2
P3
0
Status Word
Example
:
Read sector 1 of a Mifare Classic 1K
APDU:
FF B3 00 01 10
SW12:
9000 (OK)
DataOut:
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55 AA 55
00 00 00 00 00 00 FF 07 80 69 FF FF FF FF FF FF
(64 bytes)
Data
-
36
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.7. PAPDU_MIFARE_WRITE_SECTOR
This command writes the contained data to the specified sector of a Mifare classic or Mifare
UL/UL C card (first blocks of the sector, excluding the Key block are written in case of Mifare
Classic).
Command APDU:
Command CLA INS P1 P2 P3 Data
Write Sector FF D7 AddrMsb AddrLsb Lc Data
Lc (P3) has got to be 0x30 when writing to the small sectors of a Mifare Classic and 0xF0 when writing to the large sectors of a Mifare Classic 4K.
Lc has got to be 0x30 for Mifare UL and the data will get written from block 4 till the end of the memory.
Response APDU:
Data Status Word
- SW1, SW2
6.2.8. PAPDU_MIFARE_VALUE_BLK_OLD
This command increments or decrements the data in a Value Block on a Mifare Classic card.
Command APDU:
P2 P3 Data Command
Increment/
Decrement
OLD
CLA
FF
INS
F0
P1
00 where P2 codes the block number.
The data field is structured as follows
Byte # Value Description
B0
B1
B2-B5
0xC0
0xC1
Decrement
Increment
Block number
Value (LSB first)
Block
Num
Lc Data
37
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
38
Response APDU:
Data
-
Status Word
SW1, SW2
Example: decrement block 4 by 1 (key loading and authentication not shown)
(block 4 has got to be set up as value block prior to executing this command, see datasheet for
Mifare Classic cards)
APDU:
FF B0 00 04 00 // Read Block 4
SW12:
9000 (OK)
DataOut:
A9 AA AA AA 56 55 55 55 A9 AA AA AA 05 FA 05 FA
(16 bytes)
APDU:
FF F0 00 04 06 C0 04 01 00 00 00 // decrement block 4 by 1
SW12:
9000 (OK)
APDU:
FF B0 00 04 00 // Read Block 4
SW12:
9000 (OK)
DataOut:
A8 AA AA AA 57 55 55 55 A8 AA AA AA 05 FA 05 FA
(16 bytes)
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.9. PAPDU_MIFARE_VALUE_BLK_NEW
This command increments or decrements the value of a data object if the card supports it. Refer to section 3.2.2.1.10 of [PCSC3-AMD1] for further details.
Command APDU:
Command
Increment/
Decrement
CLA
FF
INS
C2
P1
00
P2
03
Lc
xx
Data
BER-
TLV
Le
00
The data object consists of a TLV structure that defines, which action should be performed, which block the actions pertain to (the destination(s)) and which value should be applied for the action.
Tags for the action include:
0xA0: Increment
0xA1: Decrement
The Tag to define the destination is:
0x80: Destination
The Tag to define the value is:
0x81: value to increment or decrement Destination by, LSB first
Example
:
Increment block 5 by 100
FF C2 00 03 0B
A0 09
80 01 05 increment block 5
81 04 64 00 00 00 by 100
00
This command returns a Response APDU according to section 2.2 of [PCSC3-SUP2].
Response APDU:
Data
C0 03 Error status, see below
Status Word
SW1, SW2 (card itself will send SW1, SW2)
39
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Error Status
XX SW1 SW2
00 90 00
XX 62 82
XX 63 00
XX 63 01
XX 6A 81
XX 67 00
XX 6A 80
XX 64 00
XX 64 01
XX 6F 00
Description
XX = number of the bad data object in the APDU;
00 = general error of APDU;
01 = error in the 1
st
data object;
02 = error in the 2
nd
data object; etc.
No error occurred
Data object XX warning, requested information not available
No information.
Execution stooped due to failure in other data object
Data object XX not supported
Data object XX with unexpected length
Data object XX with unexpected vale
Data Object XX execution error (no response from IFD)
Data Object XX execution error (no response from ICC)
Data object XX failed, no precise diagnosis
6.2.10. PAPDU_TCL_PASS_THRU (T=CL Pass Thru)
This command can be used to send raw data using T=CL protocol to a card. Please refer to the status words defined by the PICC manufacturer for a description of the status words
Command APDU:
Command CLA INS P1 P2 P3 Data
Pass-through FF FE 00 00 Lc Data
Response APDU:
Data
PICC response data
Status Word
SW1, SW2 (card itself will send SW1, SW2)
40
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
41
6.2.11.
Thru)
PAPDU_ISO14443_PART3_PASS_THRU (Mifare Pass
This command is used to send raw data using Type A standard framing to a card. CRC bytes will be appended automatically. The reader will not add transport protocol data to the raw data
– e.g. PCB, NAD, CID etc.
Command APDU:
Command
Part 3 Passthrough
CLA
FF
INS
EF
P1
Transmit
CRC
P2
00
P3
Lc
P1 = 0x00 will transmit the CRC bytes form the card as is to the application.
P1 = 0x01 will discard the CRC bytes.
Response APDU:
Data Status Word
Data
Data
Data returned by card SW1, SW2
6.2.12. PAPDU_ISO14443_PART4_PART3_SWITCH (TCL
–
Mifare Switch)
This command switches the card state between TCL and MIFARE modes
Command APDU:
Command
Part 4-Part 3
Switch
CLA
FF
INS
F8
P1
P1
P1 = 0x00 switches from MIFARE mode to TCL mode
P1 = 0x01 switches from TCL mode to MIFARE mode
Response APDU:
Data
P2
00
P3
00
Status Word
Data
-
- SW1, SW2
NOTE: This command is mainly targeted at Mifare plus S0 cards. Mifare plus card at S0 level get detected as Mifare memory card. In order to personalize these cards first it needs to be switched to Part 4 mode. For this purpose this user command needs to be issued using
SCardTransmit function.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.13. PAPDU_FELICA_REQC
This command Issues REQC as defined in JIS 7.5.1. It is used to detect the presence of a NFC
Forum tag type 3 in the field
Command APDU:
Command
FeliCa REQC
CLA
FF
INS
40
P1
00
P2
00
P3
04
Data
2 bytes of system code,
1 byte RFU, 1 byte TSN
Response APDU:
Data
16 bytes of NFCID2 + 2 bytes of System Code (sent only if the RFU byte is 0x01)
Status Word
SW1, SW2
6.2.14. PAPDU_FELICA_REQ_SERVICE
This command issues a REQ SERVICE as defined in JIS 9.6.2. P1. On receiving this command an NFC Forum tag type 3 will respond with the area key version of the specified area and the service key version of the specified service.
Command APDU:
Command
FeliCa REQ
Service
CLA
FF
Response APDU:
INS
42
P1
Number of services/areas
Data
8 bytes IDm + No. of Service or areas(n) + Service version or area version list (2*n)
P2
00
P3
2 *
P1
Status Word
SW1, SW2
Data
Service Code List
/ Area Code List
42
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.15. PAPDU_FELICA_REQ_RESPONSE
This command issues a REQ RESPONSE as defined in JIS 9.6.1. When an NFC Forum tag type 3 receives this command, it responds with its current mode (0/1/2).
Command APDU:
Command
FeliCa REQ
Response
CLA
FF
Response APDU:
INS
44
P1
00
P2
00
P3
00
Data
-
Data Status Word
8 bytes IDm + Mode SW1, SW2
6.2.16. PAPDU_FELICA_READ_BLK
This command issues a READ as defined in JIS 9.6.3
P1 specifies the number of service
P2 specifies the number of blocks
Data buffer specifies the service code and block list
When an NFC Forum tag type 3 receives this command, it responds with the record value of the specified service.
Command APDU:
Command CLA INS P1 P2 P3
FeliCa REQ
Response
FF 46
Number of service
Number of blocks
2*(P1 + P2)
Data
Service
Code List,
Block List
Response APDU:
Data
8 bytes IDm + Status Flag 1 + Status Flag 2 +
No. of blocks(n) + Block data (n*16)
Status Word
SW1, SW2
43
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.17. PAPDU_FELICA_WRITE_BLK
This command issues a WRITE as defined in JIS 9.6.4
P1 specifies the number of service
P2 specifies the number of blocks
When an NFC Forum tag type 3 receives this command, it writes the records of the specified service.
Command APDU:
Command
FeliCa Write
Block
CLA
0xFF
INS
0x48
P1
Number of service
P2
Number of blocks
P3
2*(P1 +
P2) + (16
* P2)
Data
Service Code
List, Block List,
Block Data
Response APDU:
Data Status Word
8 bytes IDm + Status Flag 1 + Status Flag 2 SW1, SW2
6.2.18. PAPDU_FELICA_SYS_CODE
This command issues a REQ SYSTEM CODE as defined in RC-S850 / 860 Command-Ref-
Manual Section 6.1.7
Command APDU:
Command
FeliCa REQ
SYSTEM
CODE
CLA
FF
Response APDU:
INS
4A
P1
00
Data
8 bytes IDm + No. of System Codes (n) + System Code
List (2n)
P2
00
P3
00
Status Word
SW1, SW2
Data
-
44
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.19. PAPDU_NFC_TYPE1_TAG_RID
This command issues a RID to get the tag’s identification data.
Command APDU:
Command CLA INS P1 P2
50 00 00 TYPE1 Tag RID
Response APDU:
FF
Data
P3
00
Status Word
Data
-
HR0 HR1 UID0 UID1 UID2 UID3 SW1, SW2
Where
HR0 and HR1 are the 2 bytes Header ROM which identify the tag
UID0 through UID3 are the first 3 bytes of the tag’s UID.
Topaz tags have 7 bytes long UID which can be fully fetched using the GET_UID APDU
described earlier in this manual.
6.2.20. PAPDU_NFC_TYPE1_TAG_RALL
This command issues a RALL to read the two header ROM bytes and the whole of the static memory blocks 0x0-0xE.
Command APDU:
Command
TYPE1 Tag
RALL
CLA
FF
INS
52
P1
00
P2
00
P3
00
Data
-
Response APDU:
Data Status Word
HR0 HR1 120 bytes (Blocks 0
– E)
SW1, SW2
45
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.21. PAPDU_NFC_TYPE1_TAG_READ
This command issues a READ to read a single EEPROM memory byte within the static memory model area of blocks 0x0-0xE.
Command APDU:
Data Command
TYPE1 Tag
READ
CLA
FF
INS
54
P1
00
P2
Byte Addr
P3
00
Where P2 codes the address of the memory byte in the following way:
Bit numbers
b7
– b3 b2
– b0
Description
Block # (value between 0x0 and 0xE)
Byte # within the block (value between 0 and 7)
Response APDU:
Data Status Word
-
Data returned by card SW1, SW2
6.2.22. PAPDU_NFC_TYPE1_TAG_WRITE_E
This command issues a WRITE to erase and then write the value of 1 memory byte within the static memory model area of blocks 0x0-0xE.
Command APDU:
Command
TYPE1 Tag
WRITE ERASE
CLA
FF
INS
56
P1
00
P2
Byte Addr
P3
01
Where P2 codes the address of the memory byte in the following way:
Bit numbers
b7
– b3 b2
– b0
Description
Block # (value between 0x0 and 0xE)
Byte # within the block (value between 0 and 7)
Response APDU:
Data Status Word
Data
Data
Data returned by card SW1, SW2
46
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.23. PAPDU_NFC_TYPE1_TAG_WRITE_NE
This command issues a WRITE-NE to write a byte value to one byte within the static memory model area of blocks 0x0-0xE. It does not erase the value of the targeted byte before writing the new data. Execution time of this command for NFC Forum tags type 1 is approximately half that of the normal write command (WRITE-E). Using this command, EEPROM bits can only be set, not reset.
Command APDU:
Command
TYPE1 Tag WRITE
No ERASE
CLA
FF
INS
58
P1
00
P2
Byte Addr
P3
01
Where P2 codes the address of the memory byte in the following way:
Bit numbers
b7
– b3 b2
– b0
Description
Block # (value between 0x0 and 0xE)
Byte # within the block (value between 0 and 7)
Response APDU:
Data Status Word
Data
Data
Data returned by card SW1, SW2
47
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.24. PAPDU_NFC_TYPE1_TAG_RSEG
This command issues a RSEG to read out a complete segment (or block) of the memory within dynamic memory model.
Please note that this command works only on specific Topaz tags in the dynamic memory model.
Command APDU:
Command
TYPE1 Tag READ
SEGMENT
CLA
FF
INS
5A
P1
00
P2
SegAddr
P3
00
Data
-
Where P2 Segment Address is:
Bit numbers
b7
– b4 b2
– b0
Response APDU:
Data
Description
Segment (0x0
– 0xF)
0
Status Word
128 bytes of data SW1, SW2
6.2.25. PAPDU_NFC_TYPE1_TAG_READ8
This command issues a READ8 to read out a block of eight bytes.
Please note that this command only works on Topaz tags in dynamic memory model.
Command APDU:
Command
TYPE1 Tag
READ BLOCK
CLA
FF
Where P2 Block Address is:
Bit numbers
b7
– b0
Response APDU:
Data
INS
5C
P1
00
P2
Block
Addr
Description
General block (0x00 -0xFF)
P3
00
Status Word
Data
-
8 bytes of data SW1, SW2
48
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.2.26. PAPDU_NFC_TYPE1_TAG_WRITE_E8
This command issues a WRITE8 to erase and then write a block of eight bytes.
Please note that this command only works on Topaz tags in dynamic memory model.
Command APDU:
Command
TYPE1 Tag
WRITE and
ERASE BLOCK
CLA
FF
Where P2 Block Address is:
Bit numbers
b7
– b0
Response APDU:
Data
INS
5E
P1
00
Block
Addr
Description
P2
General block (0x00 -0xFF)
P3
08
Status Word
Data
Data
8 bytes of data that have been written SW1, SW2
6.2.27. PAPDU_NFC_TYPE1_TAG_WRITE_NE8
This command issues a WRITE8 to write a block of eight bytes. It does not erase the value of the targeted byte before writing the new data. Using this command, EEPROM bits can be set but not reset.
Please note that this command only works on Topaz tags in dynamic memory model.
Command APDU:
Command
TYPE1 Tag
WRITE and NO
ERASE BLOCK
CLA
FF
Where P2 Block Address is:
INS
60
P1
00
P2
Block
Addr
P3
08
Data
Data
Bit numbers
b7
– b0
Response APDU:
Description
General block (0x00 -0xFF)
Data Status Word
8 bytes of data SW1, SW2
49
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3. Escape commands for the CLOUD 45x0 F
With Amendment 1 of the PC/SC specification, Part 3, a method to define vendor specific commands has been introduced.
CLOUD 45x0 F provides the command
READER_GENERIC_ESCAPE to send commands
using this method. However, most of the escape commands listed here is not defined according to this method because of backward compatibility reasons.
All newly defined commands will adhere to this new standard. See the command
CONTACT_READ_INSERTION_COUNTER as an example.
6.3.1. Sending Escape commands to CLOUD 45x0 F
A developer can use the following methods to send Escape commands to CLOUD 45x0 F
SCardControl method defined in PC/SC API
SCardTransmit method defined in PC/SC API in conjunction with the Escape command APDU
Please note, that SCardTransmit will only work when connected to a card.
When using the CCID driver for Windows, in order to be able to send Escape commands for the CLOUD 45x0 F, this feature has got to be enabled by setting a REG_DWORD value named
‘EscapeCommandEnable’ in the registry to a value of ‘1’.
When using the Identive supplied driver, this will not be necessary.
For Windows XP and Windows Vista, the key to hold the value for CLOUD 4500 F would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_5720\
Device-Instance-xxxx \Device Parameters
The one for CLOUD 4510 F would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_5721\
Device-Instance-xxxx \Device Parameters
For Windows 7 and Windows 8, the value for CLOUD 4500 F would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_5720\Devi ce-Instance-xxxx \Device Parameters\WUDFUsbccidDriver
The one for CLOUD 4510 F would be
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Enum\USB\VID_04E6&PID_5721\Devi ce-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.
50
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.2. Escape command codes
Escape commands can be used by an application to configure CLOUD 45x0 F to function in a mode that is not its default configured mode or to get specific information. To put the CLOUD
45x0 F 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 45x0 F:
6.3.3. Common for Contact and Contactless Interfaces
ESCAPE COMMAND
READER_SETMODE
READER_GETMODE
READER_GETIFDTYPE
READER_LED_CONTROL
READER_GETINFO_EXTENDED
ESCAPE CODE
0x01
0x02
0x12
0x19
0x1E
READER_LED_CONTROL_BY_FW
READER_RDWR_USR_AREA
READER_GENERIC_ESCAPE
0xB2
0xF0
FF 70 04 E6 XX
6.3.3.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 ISO7816, EMV,
Memory card and NFC test mode operations. Upon power on the reader will reset to the default
ISO7816 mode.
Input:
The first byte of the input buffer contains the escape code value and the second one contains the value for the desired mode of operation. The output buffer field shall be NULL.
Byte0 Byte1
Escape code (0x01) Mode
51
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
52
The following table defines the values for the Mode parameter:
Mode
ISO 7816
EMV
Synchronous 0x02
NFC Test
Value
0x00
0x01
0x04
Remarks
ISO 7816 mode
– Applicable for both contact slot and contactless slot
EMV
– Applicable only for contact slot and ignored by contactless interface
Memory card mode (Synchronous)
– Applicable only for contact slot and ignored by contactless interface
NFC Test Mode
– Applicable only for contactless interface
ISO mode uses APDU mode of data transfer and is used for normal operation. 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 Smartcard detection and Communication as per EMV4.2 spec.
Synchronous mode is used for communicating only with Memory cards.
NFC test mode is used to ignore deactivate-activate sequence during SCardConnect.
(PC_TO_RDR_ICCPOWERON - 0x62, and PC_TO_RDR_ICCPOWEROFF
– 0x63)
Output:
Output buffer
NULL
6.3.3.2. READER_GETMODE
This Escape command retrieves the current mode of the reader.
Input:
The input buffer contains the escape code value.
Byte0
Escape code(0x02)
Output:
The currently active reader mode will be returned as a byte value
Mode
ISO
Value
0x00
Remarks
ISO 7816 mode
EMV 0x01
Synchronous 0x02
NFC Test 0x04
EMV mode
Memory card mode (synchronous)
NFC Test Mode
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.3.3. 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.
Byte0
Escape code(0x12)
Output:
The reader returns its PID LSB first.
PID value
B0 B1
Description
0x20 0x57 Identive CLOUD 4500 F Dual Interface Reader
0x21 0x57 Identive CLOUD 4510 F Contactless + SAM Reader
6.3.3.4. READER_LED_CONTROL
This Escape command is 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 when using this IOCTL.
Input:
The first byte of the input buffer contains the escape code, followed by LED number (if more than one LED is present, else set to 0) and then desired LED state. This will be required for production purpose.
Byte0 Byte 1 Byte2
Escape code(0x19) LED number (0-RED,1-GREEN) LED state (0-OFF, 1-ON)
Output:
Output buffer
NULL
53
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.3.5. READER_GET_INFO_EXTENDED
This Escape command is used to get the firmware version, reader capabilities, and Unicode serial number of the reader.
Input:
The first byte of the input buffer contains the escape code.
Byte0
Escape code(0x1E)
Output:
The firmware will return data as per structure SCARD_READER_GETINFO_PARAMS_EX mentioned below.
Field Size in
Bytes
Field Name Field Description Value/Default
1
1
1
2 byMajorVersion Major Version in BCD
Based on current firmware version byMinorVersion bySupportedModes
Minor Version in BCD
Bit map indicating the supported modes of the reader.
0x01 => EMV mode
0x02 => Memory card mode
0x04 =>NFC test mode
0x07 for Contact +
Contactless readers
0x03 for Contact only readers
Note: ISO mode is not indicated as it is always supported. wSupportedProtocols
Protocols supported by the
Reader
Bit 0
– T0
Bit 1
– T1
0x0003
Received as LSB first
2
1
1
1
28 winputDevice byPersonality byMaxSlots bySerialNoLength abySerialNumber
IO_DEV_NONE
IO_DEV_KEYPAD
IO_DEV_BIOMETRIC
0x00
0x01
0x02
0x0000
Received as LSB first
Reader Personality (Not Used )
Maximum number of slots
Serial number length (0x1C)
0x00
0x02 (contact and contactless)
0x1C
Unicode serial number
Reader number serial
Received as MSB first
54
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.3.6. READER_LED_CONTROL_BY_FW
This Escape command is used to enable/disable LED control by firmware.
Input:
The first byte of the input buffer contains the escape code. The second byte specifies if LED control by firmware should be disabled or enabled. The output buffer is NULL.
Byte1
Byte0
Value Description
Escape code(0xB2)
0 Enable LED Control by firmware
1 Disable LED Control by firmware
FF
Get State:
0 -- LED control by firmware enabled
1 -- LED control by firmware disabled
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
6.3.3.7. READER_RD_WR_USER_AREA
This Escape command is used to access the user data area in the reader. The user area is located in the non-volatile memory of the reader and hence data will be retained even after power cycle.
Note:
Frequent writes should be avoided (The non-volatile memory supports only 100K writing cycles).
A maximum of 249 bytes can be read and written. The sector can be read and written only as a whole.
If complete data (249 bytes) is not given during write operation then random data will be padded to the given data and then written. If you want to modify only part of the data, read the entire 249 bytes, modify the data you want to change and then write it back to the reader.
55
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Input:
The first byte of the input buffer contains the escape code. The second byte specifies if user area is to be read or written as described below.
Byte1
Byte0
Byte2 to Byte251
Value Description
1 Read 249 bytes of user data None
Escape code(0xF0)
2 Write 249 bytes of user data Data to be written
Output:
Operation Data (Byte0-BYTE248)
Read
Write
249 bytes of user data
No bytes returned
6.3.3.8. READER_GENERIC_ESCAPE
This Escape command is used to invoke newly defined escape functions and send proprietary commands to the reader. It is defined in line with vendor specific generic command defined in
[PCSC3-AMD1].
Input:
The first five bytes of the input buffer shall follow APDU structure as per [PCSC3-AMD1]. 6
TH byte shall be the command code used to identify the specific command.
Byte0 Byte1 Byte2 Byte3 Byte4
0xFF 0x70 0x04 0xE6
From Byte5 (up to Lc bytes)
Byte 5 Byte 6 onwards
Lc (always
> 0)
Cmd
Opcode
Command parameters or data
ByteLc+5
Le
(optional)
Output:
Depending on the command, the output shall be Le bytes of data + SW1 + SW2 or SW1+
SW2. The escape message shall at least return 2 bytes status word SW1, SW2. In case of success, SW1=0x90 and SW2=0x00 shall be returned. In error scenario, appropriate error status shall be returned (as defined in Error Code section 8.0).
56
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.3.9. READER _CONTROL_CONTACT_SLOT
This Escape command is supported through the READER_GENERIC_ESCAPE message.
This command can be used to disable the contact slot until it is re-enabled through the same command or until the reader is re-plugged. When a dual interface card is placed in the contact slot it will get detected in both “contact” and “contactless” mode. To enable applications to actively switch the detection from contact-only mode to contactless-only mode this Escape
command can be used along with CNTLESS_ SWITCH_RF_ON_OFF .
Input
To Enable / Disable / “Get-Current-Status” of Contact Slot
Byte0
CLA
Byte1 Byte2 Byte3 Byte4
INS P1 P2 Lc
Byte5 Byte6
0xFF
0xFF
0x70
0x70
0x04
0x04
0xE6
0xE6
0x03
0x02
Byte7
0x05
(opcode)
0x01
0x01
– to enable
0x00
– to disable
00
0x05
(opcode)
0x00 - to get current contact status
00
Le
Byte2 and Byte3 constitute the world wide unique vendor ID as assigned by the USB organization. For Identive based readers Byte2 = 0x04 and Byte3 = 0xE6 since it USB Vendor
ID is 0x04E6
Output:
If the command is successful, a single byte is returned. This byte indicates the status of contact slot which needs to be interpreted as below.
Byte 0 Description
0x01
0x00
Contact slot is enabled
Contact slot is disabled
57
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4. Specific for Contactless Interface
ESCAPE COMMAND
CNTLESS_GETCARDINFO
ESCAPE CODE
0x11
CNTLESS_GET_ATS_ATQB
CNTLESS_CONTROL_PPS
CNTLESS_RF_SWITCH
CNTLESS_SWITCH_RF_ON_OFF
CNTLESS_GET_BAUDRATE
CNTLESS_CONTROL_RETRIES
CNTLESS_CONTROL_POLLING
CNTLESS_GET_CARD_DETAILS
CNTLESS_SET_CONFIG_PARAMS
CNTLESS_IS_COLLISION_DETECTED
CNTLESS_FELICA_PASS_THRU
0x93
0x99
0x96
0x9C
0x9E
0xA7
0xAC
0xDA
0xE1
0xE4
0xF3
CNTLESS_P2P_SWITCH_MODES
CNTLESS_P2P_TARGET_RECEIVE
CNTLESS_P2P_TARGET_SEND
CNTLESS_P2P_INITIATOR_DESELECT
0xE9
0xEA
0xEB
0xE6
CNTLESS_P2P_INITIATOR_TRANSCEIVE
CNTLESS_NFC_SINGLESHOT
0xE7
0xEC
CNTLESS_NFC_LOOPBACK 0xED
CNTLESS_GET_SET_NFC_PARAMS READER_ESCAPE_GENERIC (0x04)
CNTLESS_GET_P2P_EXTERNAL_RF_STATE READER_ESCAPE_GENERIC (0x06)
6.3.4.1. CNTLESS_GET_CARD_INFO
This Escape command is used to get information about the contactless card placed in the field of the reader.
Input:
The first byte of input buffer contains the escape code.
Byte0
Escape code(0x11)
58
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
59
Output:
Byte0
Contactless card present
(0x01)
Byte1 Byte2
Card to Reader communication baud rate (0xNN - see table below for details)
Card Type Info
(Upper nibble indicates memory card/T=CL/dual mode card;
Lower nibble indicates Type
A/ Type B card
See Table below for values)
Card to Reader communication baud rate BYTE is defined as follows:
b0
– 212kbps supported (direction reader to card) b1
– 424kbps supported (direction reader to card) b2
– 848kbps supported (direction reader to card) b3
– always 0 b4
– 212kbps supported (direction card to reader) b5
– 424kbps supported (direction card to reader) b6
– 848kbps supported (direction card to reader) b7
– 1 – indicates same baud rate in both directions
0
– indicates different baud rates in both directions
Example:
If 0xNN = 0x77, the card supports all baud rates namely 106, 212, 424 and 848 kbps in both directions.
If 0xNN = 0xB3, the card supports 106, 212 and 424 kbps in both directions.
Card Type Info:
Upper Nibble Value Description
0 Memory card
1
2
1
T=CL card
Dual mode card
Lower Nibble Value
0 Type A card
Type B card
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.2. CNTLESS_GET_ATS_ATQB
This Escape command retrieves the ATS for Type A T= CL or the ATQB for Type B cards.
Input:
The first byte of input buffer contains the escape code.
Byte0
Escape code(0x93)
Output:
The output buffer contains the ATS bytes or the ATQB bytes depending on the type of PICC placed on the reader
6.3.4.3. CNTLESS_CONTROL_PPS
This Escape command disables the automatic PPS done by the firmware/device for contactless cards.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Input Output
Byte0
0
Byte1 - PPS control byte
Enable
Byte0
No Output
Escape code(0x99)
1
FF
Disable
Get current status
No Output
0
– PPS is enabled
1
– PPS is disabled
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
60
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.4. CNTLESS_RF_SWITCH
This Escape command can be used to switch the RF field ON or OFF.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Byte0
Byte1
Value Description
Output
Byte0
0x00
Escape code(0x96)
0x01
0xFF
Switch RF Field OFF
No Output
Switch RF Field ON
No Output
0
– RF field is ON
Get current field state
1
– RF field is OFF
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
6.3.4.5. CNTLESS_SWITCH_RF_ON_OFF
This Escape command is used to switch the RF field ON or OFF when a contact smart card is inserted into the reader. By default, the RF field is always in the ON state and when a contact smart card is inserted in the reader, the RF field is turned OFF.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Byte0
Value
Byte1
Description
Output
Byte 0
0x00
Escape code(0x9C)
0x01
Switch RF Field OFF when contact card is present in the reader
Leave RF Field ON when contact card is present in the reader
No Output
No Output
0xFF
Get current field state
0x00 - RF is OFF when contact card is present in the reader
0x01 - RF is ON when contact card is present in the reader
After the RF is turned off, to turn the RF ON again, card connect has to be done in direct mode.
61
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
6.3.4.6. CNTLESS_GET_BAUDRATE
This Escape command is used to get the current baud rate of card-reader communication.
Input:
The first byte of input buffer contains the escape code.
Byte0
Escape code(0x9E)
Output:
The output contains a byte with the following possible values
Byte0 Description
0x00 106Kbps in both directions
0x01 106Kbps from PICC to PCD, 212Kbps from PCD to PICC
0x02 106Kbps from PICC to PCD, 424Kbps from PCD to PICC
0x03 106Kbps from PICC to PCD, 848Kbps from PCD to PICC
0x10 212Kbps from PICC to PCD, 106Kbps from PCD to PICC
0x11 212Kbps in both directions
0x12 212Kbps from PICC to PCD, 424Kbps from PCD to PICC
0x13 212Kbps from PICC to PCD, 848Kbps from PCD to PICC
0x20 424Kbps from PICC to PCD, 106Kbps from PCD to PICC
0x21 424Kbps from PICC to PCD, 212Kbps from PCD to PICC
0x22 424Kbps in both directions
0x23 424Kbps from PICC to PCD, 848Kbps from PCD to PICC
0x30 848Kbps from PICC to PCD, 106Kbps from PCD to PICC
0x31 848Kbps from PICC to PCD, 212Kbps from PCD to PICC
0x32 848Kbps from PICC to PCD, 424Kbps from PCD to PICC
0x33 848Kbps in both directions
62
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.7. CNTLESS_CONTROL_RETRIES
This Escape command is used to enable/disable CRC/PROTOCOL/TIMEOUT error retries which are enabled by default for contactless cards.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Byte0
Input
Byte1- Description
Output
Byte 0
0x00
Enable RNAK retries No Output
Escape code(0xA7)
0x01
0xFF
Disable RNAK retries
Get current state of retries
No Output
0x00 - Retries are enabled
0x01 - Retries are disabled
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
63
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.8. CNTLESS_CONTROL_POLLING
This Escape command is used to enable/disable firmware polling for contactless cards.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Byte0
Input
Byte1 - Description
Output
Byte 0
0x00 Enable polling No output
Escape code(0xAC)
0x01
0XFF
Disable polling
Get current state of polling
No output
0x00
– Polling enabled
0x01
– Polling disabled
Output:
No response is returned for set state. For Get State 1 byte response is received.
Output buffer
NULL or current state
6.3.4.9. CNTLESS_GET_CARD_DETAILS
This Escape command is used to get details about the PICC placed in the field of the reader.
Input:
The first byte of input buffer contains the escape code.
Byte0
Escape code(0xDA)
64
B14
B15
B16
B17
B18
B19
B20
B3-B12
B13
0x00
0x01
0x00
0x01
B3
–B10
B11
B12
B13
B14
B15
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Output:
Byte # Value
B0
B1
B2
0x00
0x01
0x04
0x08
0x00
0x01
0x02
0x43
0x44
0x45
0x46
‘xx’
0x08
Description
Type A card
Type B card
FeliCa 212
FeliCa 424
Memory card
T-CL card
Dual interface card
FeliCa
Topaz
B-prime i-Class
‘xx’ is the PUPI / UID Length
For FeliCa cards
THEN EITHER
PUPI/UID bytes
0x00 byte padding used if length smaller than 10
CID not supported
CID supported
NAD not supported
NAD supported
Bit Rate Capability
FWI
IFSC
MBLI
SAK
SFGI
OR
8 Bytes NFCID2
Request service command response time parameter (see
JIS-6319 specification)
Request response command response time parameter
Authentication command response time parameter
Read command response time parameter
Write command response time parameter
65
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.10. CNTLESS_SET_CONFIG_PARAMS
This Escape command is used to configure RXGAIN and RXTHRESHOLD of the RF receiver for different baud rates and card types. All configured parameters are volatile.
Input:
The first byte of input buffer contains the escape code. The following 16 bytes contain the below defined parameters.
Byte # Value
B0 0XE1
B1
B2
Description
Escape code
Type A RXGAIN for polling or 106Kbps
Type A RXGAIN for 212 Kbps
B3
B4
B5
B6
B7
B8
B9
B10
Type A RXGAIN for 424 Kbps
Type A RXGAIN for 848 Kbps
Type A RX THRESHOLD for polling or 106Kbps
Type A RX THRESHOLD for 212 Kbps
Type A RX THRESHOLD for 424 Kbps
Type A RX THRESHOLD for 848 Kbps
Type B RXGAIN for polling or 106Kbps
Type B RXGAIN for 212 Kbps
B11
B12
B13
B14
Type B RXGAIN for 424 Kbps
Type B RXGAIN for 848 Kbps
Type B RX THRESHOLD for polling or 106Kbps
Type B RX THRESHOLD for 212 Kbps
B15
B16
Output:
Output buffer
NULL
Type B RX THRESHOLD for 424 Kbps
Type B RX THRESHOLD for 848 Kbps
66
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.11. CNTLESS_IS_COLLISION_DETECTED
This Escape command is used to identify if multiple Type A cards are detected in the field.
Input:
The first byte of input buffer contains the escape code.
Byte0
Escape code(0xE4)
Output:
Byte0
Value Description
0x00
0x01
Collision is not detected
Collision is detected
6.3.4.12. CNTLESS_FELICA_PASS_THRU
This Escape command is used as a pass through to send FeliCa commands to FeliCa cards.
Input:
The first byte of input buffer contains the escape code followed by FeliCa command to be sent to the card. At least 1 byte of command is required to be sent to the card. Otherwise an error will be reported.
Byte0 Byte1 onwards
Escape code (0xF3) FeliCa command bytes
Output:
The response received from the FeliCa card is sent as output for this escape command.
67
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.13. CNTLESS_P2P_SWITCH_MODES
This Escape command is used to switch the device between the reader/writer and P2P modes of operation and to query the current mode. By default, the device is in the reader/writer mode.
Input:
The first byte of input buffer contains the escape code.
The second byte either sets the mode or contains a code to retrieve the setting.
Additional data bytes will be needed for Initiator/Target mode.
Offset Description Detailed description
0
1
0xE9
0
– P2P Initiator mode
1
– P2P Target mode
2
– Reader / writer mode
0xFF
– Get current mode
Switch mode
For the switch to Initiator / Target mode, the bytes from offset 0x02 give additional information as described below
Offset
2
3
4
5
6
7 to N+7
Initiator Mode Bytes Detailed description
RFU
RFU
Timeout Low Byte
Timeout High Byte
N
General bytes to be sent in
ATR-REQUEST
Number of General Bytes
68
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
69
Offset
22
23
24
25
26
27
18
19
20
21
14
15
16
17
7
8
9
10
11
12
13
2
3
4
5
6
28
29
30
31
32 to N+32
0xFE
0x0F
0x40
0x01
0xFE
0x0F
0xBB
Target Mode Bytes
(Sample Values)
0x00
0x00
0x04
0x03
0x01
RFU
RFU
SENS_RES
SENS_RES
NFCID1
NFCID1
NFCID1
SEL_RES
NFCID2
NFCID2
NFCID2
NFCID2
Detailed description
C0
C1
C2
C3
0xBA
0xA6
0xC9
0x89
NFCID2
NFCID2
NFCID2
NFCID2
FeliCa Padding Bytes
FeliCa Padding Bytes
FeliCa Padding Bytes
FeliCa Padding Bytes
C4
C5
C6
C7
FF
FF
0x00
FeliCa Padding Bytes
FeliCa Padding Bytes
FeliCa Padding Bytes
FeliCa Padding Bytes
FeliCa System Code
FeliCa System Code
NFCID3 ( XOR of 0x08 and 3 bytes of
NFCID1)
0x88
0x13
N
General byte to be sent in
ATR_RES
Timeout Low Byte
Timeout High Byte
Number of G bytes in ATR_RES
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Output Buffer:
Initiator Mode : On successful detection of target, the entire ATR_RES buffer from the target device would be given to the host computer
Target Mode : On successful detection by the initiator the entire ATR_REQ buffer from the initiator device would be given to the host computer
Reader Mode : The output buffer would be empty
Get Current Mode : A single byte response indicating the currently selected mode as described below o 0x00
=> P2P Initiator mode o 0x01
=> P2P Target mode o 0x02
=> Reader / Writer mode
70
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.14. CNTLESS_P2P_TARGET_RECEIVE
This Escape command is used to receive data from the initiator device. Prior to using this command, the device should have been successfully switched to target mode using
CNTLESS_P2P_SWITCH_MODES (E9) .
Input Buffer:
Offset
0
1
0xEA
Description Detailed description
Target Receive
RFU
2
3
4
0 - No Chaining
1 - Chaining
--
--
RFU
RFU
Chaining byte
5
6
Timeout Low Byte
Timeout High Byte
Output Buffer:
On successful reception, the entire data from the initiator device would be returned from offset
0x04
Offset
0
1
2
3
Offset 4 to offset 4+N
0
Description
– No Chaining
1
– Chaining
N data bytes
RFU
RFU
RFU
Chaining
Detailed description
Bytes Received.
71
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.15. CNTLESS_P2P_TARGET_SEND
This Escape command is used to send data to an initiator device. Prior to using this command, the device should have been successfully switched to target mode using
CNTLESS_P2P_SWITCH_MODES (E9) .
Input:
Offset
0
1
0xEB
0x00
Description Detailed description
Target Send
RFU
2
3
4
0x00
0x00
0 - No Chaining
1 - Chaining
RFU
RFU
Chaining byte
5
6
Timeout Low Byte
Timeout High Byte
Offset 7 to offset 7+N
Output:
Once the data bytes are sent successfully, the firmware would indicate if it is ready to send more bytes through the chaining byte
Offset
0
1
2
N data bytes
Description
Bytes to be sent to Initiator device
RFU
RFU
Detailed description
3 0
– No Chaining
1
– Chaining
RFU
Chaining
6.3.4.16. CNTLESS_P2P_INITIATOR_DESELECT
This escape command is used by the application to deselect the target device towards the end of P2P communication.
Input
Byte0
Escape code(0xE6)
Output
The deselect response as received from the target will be sent in the response buffer from offset 0x00
72
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.17. CNTLESS_P2P_INITIATOR_TRANCEIVE
This Escape command is used to send data to a target device. Prior to using this command, the device should have been successfully switched to initiator mode using
CNTLESS_P2P_SWITCH_MODES (E9) .
Input:
Offset
0
1
0xE7
0x00
0x00
Description Detailed description
Initiator transceive
RFU
RFU
2
3
4
5
6
0x00
0
– No Chaining
1
– Chaining
--
--
RFU
Chaining
Timeout Low Byte
Timeout High Byte
Offset 7 to
7+N
Output:
On successful reception of data from the target, the entire data would be available from offset
0x04. Presence of additional data is indicated by the chaining byte.
Offset
0
1
2
3
Offset 4 to offset 4+N
N bytes of data
0
Description
– No Chaining
1
– Chaining
N data bytes
Bytes to be sent to target device
RFU
RFU
RFU
Chaining
Detailed description
Bytes Received.
73
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
74
6.3.4.18. CNTLESS_NFC_SINGLESHOT
This Escape command is used to switch the device to Single-shot mode.
Input:
Offset Description Detailed description
0
1
0xEC
0x01
NFC Single-shot
NFC_DEP supported.
If a value other than 0x01 is given,
NFC_DEP is not supported in the preceding I-Blocks.
Output:
Output buffer
NULL
6.3.4.19. CNTLESS_NFC_LOOPBACK
This Escape command is used to switch the device to Loop-back mode.
Input:
Offset
0
1
0xED
0x01
Description Detailed description
NFC Loop-back
NFC_DEP supported.
If a value other than 0x01 is given,
NFC_DEP is not supported in the preceding I-Blocks.
Output:
Output buffer
NULL
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.20. CNTLESS_GET_SET_NFC_PARAMS
This Escape command is supported through the READER_GENERIC_ESCAPE command.
During NFC operation, number parameters like DID, LRi, PSL_REQ_BRS and PSL_REQ_FSL can be controlled from application.
Input:
To set the parameters the command syntax is:
Byte0
CLA
Byte1
INS
Byte2
P1
Byte3
P2
Byte4
Lc
Byte5 Byte6 Byte7
0xFF 0x70 0x04 0xE6 0x04
0x04
(opcode)
To get the parameters the command syntax is:
0x01
–
SET
NFC
Parameter
Byte0
CLA
Byte1
INS
Byte2
P1
Byte3
P2
Byte4
Lc
Byte5 Byte6
Byte 8
Value
Byte7
Le
00
Le
0xFF 0x70 0x04 0xE6 0x03
0x04
(opcode)
The value of byte 7 is interpreted from this table
Byte 7 Value
0x00
– DID
0x01
– LRi
0x02
– PSL_REQ_BRS
0x03
– PS_REQ_FSL
0x00
– GET
Description
Device Identification Number
Length Reduction field
BRS used in PSL_REQ
FSL used in PSL_REQ
NFC
Parameter
00
75
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.4.21. CNTLESS_GET_P2P_EXTERNAL_RF_STATE
This Escape command is supported through the READER_GENERIC_ESCAPE message.
This command is used to check if external RF is reset after the reader got detected in target mode.
Input:
Byte0
CLA
Byte1
INS
Byte2
P1
Byte3
P2
Byte4
Lc
Byte5 Le
0xFF 0x70 0x04 0xE6 0x01 0x06 (opcode) 00
Output:
If the command is successful, a single byte is returned. This byte indicates the value of parameter.
Bit 0 => Set to logic 1, when a present external RF field is switched off
Bit 1 => Set to logic 1, when an external RF field is detected.
Bit 2 to Bit 7 => RFU bits always read as 0
76
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5. Specific for Contact Interface
ESCAPE COMMAND
CONTACT_GET_SET_PWR_UP_SEQUENCE
CONTACT_EMV_LOOPBACK
CONTACT_EMV_SINGLEMODE
CONTACT_EMV_TIMERMODE
CONTACT_APDU_TRANSFER
CONTACT_DISABLE_PPS
CONTACT_EXCHANGE_RAW
CONTACT_GET_SET_CLK_FREQUENCY
CONTACT_CONTROL_ATR_VALIDATION
CONTACT_GET_SET_MCARD_TIMEOUT
CONTACT_GET_SET_ETU
CONTACT_GET_SET_WAITTIME
CONTACT_GET_SET_GUARDTIME
CONTACT_READ_INSERTION_COUNTER
Escape code
0x04
0x05
0x06
0x07
0x08
0x0F
0x10
0x1F
0x88
0x85
0x80
0x81
0x82
READER_ESCAPE_GENERIC (0x00)
77
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.1. CONTACT_GET_SET_PWR_UP_SEQUENCE
This Escape command is used to get or set the following parameters:
Smart card Power-on sequence
Delay between successive Activation retires
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.
Input:
The first byte of the input buffer will contain the escape code. The next byte shall contain the function to be performed. Third byte shall contain the parameter for the function.
Byte0
Byte1
Value Description
0x00
0x01
Starts with Class C voltage.
(1.8V
– 3V – 5V order)
Starts with Class A voltage.
(5V
– 3V – 1.8V order)
Byte2
-
-
Escape code(0x04)
0x08 Time delay between resets
0x09
0xFE
0xFF
Delay value in milliseconds
Bit Map of all Voltage Classes
[Bit0
– Class A; Bit1 – Class B;
Bit2
– Class C]
Enable/Disable a Voltage
Class
Set bit to enable the Voltage class
Clear bit to disable the Voltage class
Retrieves all the Activation
Configuration
-
Retrieves the current Power up sequence
-
78
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
79
Output:
For retrieving all settings (0xFE), the output will be:
Byte0
Value Description
Byte 1 Byte2
0x00
0x01
Starts with Class C voltage.
(1.8V
– 3V – 5V order)
Time delay between resets in milliseconds
Starts with Class A voltage.
(5V
– 3V – 1.8V order)
Bit Map of all Voltage
Classes
[Bit0
– Class A; Bit1 –
Class B; Bit2
– Class C]
For retrieving current Power up sequence (0xFF), the output will be:
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)
6.3.5.2. CONTACT_EMV_LOOPBACK
This Escape command lets the host force the firmware to perform an EMV Loop-back application.
Input:
The input buffer contains the escape code value.
Byte0
Escape code(0x05)
Output:
Output buffer
NULL
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.3. 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.
Input:
Byte0
Escape code(0x06)
Output:
Output buffer
NULL
6.3.5.4. CONTACT_EMV_TIMERMODE
This Escape command lets the host perform a timer mode EMV Loop-back application as specified in the EMV Level 1 Testing Requirements document
Input:
The input buffer contains the escape code value.
Byte0
Escape code(0x07)
Output:
Output buffer
NULL
80
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.5. 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.
Byte0
Escape code(0x08)
Byte1 onwards
Short APDU to be sent to card
Output:
Output buffer
Response APDU
6.3.5.6. CONTACT_DISABLE_PPS
This Escape command disables 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 the input buffer contains the Escape code and the following byte, if 1 disables
PPS and if 0 enables PPS.
Byte0 Byte1
Escape code(0x0F) PPS control byte (1-DISABLES PPS, 0-ENABLES PPS)
Output:
Output buffer
NULL
81
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.7. 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 contains 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.
Byte0
Escape code(0x10)
Byte1 Byte2
LSB of send length
MSB of send length
Byte3 Byte4 Byte 5 onwards
LSB of expected length
MSB expected length of Raw data to the card
Output:
Output buffer
Response APDU
82
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.8. CONTACT_GET_SET_CLK_FREQUENCY
This Escape command is used to instruct the reader to change the clock for the smart card 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 contains the Escape code; the next byte contains the clock divisor value to set the clock frequency or 0xFF to get the clock frequency.
Byte0 Byte1
Value Description
Escape code(0x1F) Clock divisor The value to be Set in the smartcard CLK divisor register
0xFF Get current Clock divisor value
Output:
Set clock frequency: None
Get clock frequency: One byte value indicating the current Clock divisor.
Output buffer
7
6
5
4
3
NULL or current divisor
Clock Divisor values:
DIVISOR VALUE SCCLK Frequency
12 4 MHz
10
8
4.8 MHz
6 MHz
6.8 MHz
8 MHz
9.6 MHz
12 MHz
16 MHz
83
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.9. 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.
Byte0 Byte1
Escape code(0x88)
Value Description
0x00 Enable ATR validation
0x01 Disable ATR validation
Output:
Output buffer
NULL
84
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.10. 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.
Byte0 Byte1
Value Description
Escape code(0x85)
0x01 Delay in milliseconds for memory card Write
Any value other than
1
Read the current applied delay for memory card
Write
Output:
Write delay: No response byte
Read delay value: A byte value specifying the current delay applied during memory card Write in milliseconds
Byte0
Null or
Delay in ms
85
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.11. CONTACT_GET_SET_ETU
This Escape command is 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 code followed by an 8 bit GET/SET identifier. For SET
ETU, a DWORD specifying the value to be set is following.
Byte0 Byte1
Value Description
Byte2 Byte3 Byte4
Wait time
Byte5
Escape code(0x80)
0x01 SET ETU BIT31-
BIT24
0x00 GET ETU -
Output:
For both Set and Get ETU, the output will be the following.
Byte0 Byte1
ETU value
Byte2 Byte3
BIT31-BIT24 BIT23-BIT16 BIT15-BIT8 BIT7-BIT0
-
BIT23-
BIT16
-
BIT15-
BIT8
-
BIT7-
BIT0
86
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
87
6.3.5.12. CONTACT_GET_SET_WAITTIME
This Escape command is used to get/set the Character/Block Waiting Time for smartcards. 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.
Byte0
Escape code(0x81)
Byte1 Byte2
CWT
BWT
Byte3 Byte4 Byte5
Value Description Value Description
0x01 SET time
Wait 0x00
0x01
CWT
BWT
BIT31-
BIT24
Wait time in ETU
BIT23-
BIT16
BIT15-
BIT8
BIT7-
BIT0
0x00 GET Wait time
0x00
0x01
- - - -
Byte6
Output:
For both Get/Set Wait time, the output will be the following.
Byte0 Byte1 Byte2
Wait time in ETU
Byte3
BIT31-BIT24 BIT23-BIT16 BIT15-BIT8 BIT7-BIT0
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
6.3.5.13. 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.
Byte0
Escape code(0x82)
Byte1 Byte2
Value Description Value Description
0x01 SET Guard time
0x00
0x01
CGT
BGT
Byte3 Byte4 Byte5 Byte
6
BIT31-
BIT24
Guard time in ETU
BIT23-
BIT16
BIT15-
BIT8
BIT7-
BIT0
- 0x00 GET Guard time
0x00
0x01
CGT
BGT
- -
Output:
For Get/Set guard time, the output will be the Character/Block Guard Time value.
-
Byte0
Character Guard time in ETU
BIT31-BIT24
Byte1
BIT23-BIT16
Byte2
BIT15-BIT8
Byte3
BIT7-BIT0
88
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
89
6.3.5.14. CONTACT_READ_INSERTION_COUNTER
This Escape command is supported through the READER_GENERIC_ESCAPE command and
retrieves the number of times a contact smart card has been inserted into the reader.
Input:
The first five bytes of the input buffer follow APDU structure as per [PCSC3-AMD1]. The 6 th byte is the Escape code 0x00 to identify the command.
Byte0 Byte1 Byte2 Byte3 Byte4 Byte5
0xFF 0x70 0x04 0xE6 0x01
0x00
(Escape code)
Output:
Le
4 (Insertion counter is a 4 byte value)
Byte0 Byte1 Byte2 Byte3 Byte4 Byte5
Insertion counter value SW1 SW2
BIT31-BIT24 BIT23-BIT16 BIT15-BIT8 BIT7-BIT0 0x90 0x00
In case of any error, only SW1 and SW2 set with error status will be returned.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
7. Mechanical Integration
7.1. Module Mounting Holes, HF Antenna and LED
Details
Figure 1 locates the 5 mounting holes. All mounting holes have a diameter of 3.0mm.
The mounting hole called H5 provides the possibility to ground the PCBA. The LED dimension is L3.2mm x W2.8mm x H1.9mm. The LED is bi color Yellow green and RED.
NOTE: CLOUD4500F & CLOUD 4510F TOP SIDE VIEW ARE SAME
90
Figure 1
– CLOUD 4500F & 4510F MODULE TOP SIDE VIEW DETAILS
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
7.2. CLOUD 4500F USB Interface and Smart Card
Connector Details
Connector Description Reference-Part No.
USB
CLOUD4500F
Smart Card
Default Molex 5-pin connector
Part No. 53325-0560
Optional: mini-B connector MOLEX 54819-0572
Default: Friction contact
4
Hamburg ICA-602
Optional: Landing contact
5
Hamburg ICA-703
91
Pin 1
USB receptacle
ICA 602
OR
ICA-703
Friction or
Landing
Connector
Figure 2 - CLOUD 4500F MODULE BOTTOM VIEW
4
100.000 insertion cycles typ.
5
500.000 insertion cycles typ.
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
92
Figure 2 shows, how the ID1 smart card extends out of the module when it is fully inserted into the connector.
Note: Both Friction and Landing Connector are exactly same in dimensions
Figure 3 shows the same in side view, dimensions not to scale
Figure 3 - CLOUD 4500F SIDE VIEW MODULE - SMART CARD DETAILS
Figure 4 shows the details of Smart Card Connector from connector vendor. The Measurement is same for Landing or Friction Type Connector.
Figure 4 - Friction or Landing Type Smart Card Connector Details
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
7.3. CLOUD 4510F USB Interface and SAM Card
Connector Details
Connector Description Reference-Part No.
USB
CLOUD4510F
SAM Card
Default Molex 5-pin connector
Part No. 53325-0560
Optional: mini-B connector MOLEX 54819-0572
Default: Open/Close Type Hamburg ICA-560
Pin 1
93
USB receptacle
SAM card connector, toploading
Figure 5- CLOUD 4510F MODULE BOTTOM SIDE VIEW
7.4. Module thickness
CLOUD 4500F
–SMART CARD CONNECTOR MODULE TOTAL THICKNESS 10.91mm
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
Figure 6- CLOUD 4500F MODULE THICKNESS DETAILS
CLOUD 4510F
– SAM CONNECTOR MODULE TOTAL THICKNESS 9.98mm
Figure 7- CLOUD 4510F MODULE THICKNESS DETAILS
94
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
7.5. General recommendations
7.5.1. Smart Card Insertion
To avoid damage of the smart card connector due to improper card insertion, it is recommended that the housing mechanics around the CLOUD 4500 F module provide good horizontal and vertical guidance to the card. Objective is that even when the card is inserted with a certain angle, it is guided towards J4 without any blocking points.
A housing/mounting environment for the CLOUD 4510 F should be designed such, that the toploading connector for the SAM will be accessible to be opened and a card can be inserted.
7.5.2. Contactless Reading
In order to provide optimum contactless reading distance the following recommendations should be followed:
The module top surface must be placed as close as possible to the front bezel of the casing you design.
The casing you design should provide a landing area that invites the user to place his/her credential centered on the HF antenna area (see figure 1)
Avoid any metal plate in the area of the HF antenna. Metal planes detune the antenna and can even make the module not function at all.
It is recommended for proper communication, that a minimum distance of 2.5cm (1”) will be kept to metallic objects. No metallic objects should be present between antenna and card.
To prevent the fields of adjacent readers to interfere with each other, a minimum distance between readers of 2.5cm (1”) should be kept.
The minimum distance between antenna and card should not be less than 5mm (0.2”).
8. Electrical integration recommendations
8.1. USB connector and Cable specification
This module has USB Connection interface using Molex Part No. 53325-0560.
To connect with above Receptacle Connector, Plug of Molex 51090-0500 housing and Molex
50212-0800 Crimp Terminal can be used.
The Wire Connections of USB [Molex] Connector is shown below.
PIN NUMBER
1
2
3
WIRE COLOR
RED
SIGNAL NAME
VBUS
D
– [ D MINUS]
WHITE
GREEN D + [ D PLUS ]
BLACK GND
SHEILD [ DRAIN+BRAID] SHEILD GND
4
5
Identive recommends using USB 2.0 certified cables. The length of the cable should be limited to 1.5 meter maximum, with 28 AWG# 1P, 28 AWG# 2C specifications.
95
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
8.2. ESD and EMI recommendations
Depending on your mechanical design, the LED may be an ESD injection channel. Identive recommends that, your casing integrates a light pipe that creates a gap of at least 7mm on top of the LED surface
The ISO7816 contacts have been tested to resist +/-4KV [HBM Model] contact ESD discharge.
Beyond this value, the microcontroller may be reset. If your application has higher ESD resistance requirements, we recommend that, you consider adding brushes connected to ground on the card slot to discharge charges, which may be carried by smart cards.
Identive used Ferrite core on Cable for FCC Certification. As per your requirement and environmental conditions you can choose appropriate Ferrite Core.
96
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
9. Annexes
9.1. Annex A
– Status words table
SW1 SW2 Description
0x90 0x00 NO ERROR
0x63
0x65
0x67
0x68
0x6A
0x6B
0x6D
0x6E
0x6F
0x00
0x81
0x00
0x00
0x81
0x00
0x00
0x00
0x00
NO INFORMATION GIVEN
MEMORY FAILURE
LENGTH INCORRECT
CLASS BYTE INCORRECT
FUNCTION NOT SUPPORTED
WRONG PARAMETER P1-P2
INVALID INSTRUCTION BYTE
CLASS NOT SUPPORTED
UNKNOWN COMMAND
97
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
9.2. Annex B
– Sample code using escape commands
File Name: CLOUD 45x0 F Escape.h
#ifndef _CLOUD_45x0F_ESCAPE_H_
#define _CLOUD_45x0F_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 READER_GETIFDTYPE 0x12
#define READER_LED_CONTROL 0x19
#define READER_LED_CONTROL_BY_FW 0xB2
#define READER_GETINFO_EXTENDED 0x1E
#define READER_RDWR_USR_AREA 0xF0
#define CONTACT_GET_SET_POWERUPSEQUENCE 0x04
#define CONTACT_EMV_LOOPBACK 0x05
#define CONTACT_EMV_SINGLEMODE 0x06
#define CONTACT_EMV_TIMERMODE 0x07
#define CONTACT_APDU_TRANSFER 0x08
#define CONTACT_CONTROL_PPS 0x0F
#define CONTACT_EXCHANGE_RAW 0x10
#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
#define CNTLESS_GETCARDINFO 0x11
#define CNTLESS_GET_ATS_ATQB 0x93
#define CNTLESS_CONTROL_PPS 0x99
#define CNTLESS_RF_SWITCH 0x96
#define CNTLESS_SWITCH_RF_ON_OFF 0x9C
#define CNTLESS_GET_BAUDRATE 0x9E
#define CNTLESS_CONTROL_RETRIES 0xA7
#define CNTLESS_CONTROL_POLLING 0xAC
#define CNTLESS_GET_CARD_DETAILS 0xDA
#define CNTLESS_SET_CONFIG_PARAMS 0xE1
#define CNTLESS_IS_COLLISION_DETECTED 0xE4
#define CNTLESS_FELICA_PASS_THRU 0xF3
#define CNTLESS_P2P_SWITCH_MODES 0xE9
#define CNTLESS_P2P_TARGET_RECEIVE 0xEA
#define CNTLESS_P2P_TARGET_SEND 0xEB
#define CNTLESS_P2P_INITIATOR_TRANSCEIVE 0xE7
#define CNTLESS_NFC_SINGLESHOT 0xEC
#define CNTLESS_NFC_LOOPBACK 0xED
#ifdef __cplusplus
}
#endif
#endif
98
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
99
File Name: CLOUD 45x0 F Escape.c
#include <windows.h>
#include <winbase.h>
#include <stdio.h>
#include <conio.h>
#include "winscard.h"
#include "winerror.h"
#include "CLOUD 45x0F Escape.h"
VOID main(VOID)
{
SCARDCONTEXT ContextHandle;
SCARDHANDLE CardHandle;
ReaderInfoExtended strReaderInfo;
BYTE InByte, i;
DWORD
ULONG char char
BytesRead, ActiveProtocol; ret;
*s;
*ReaderName[] = {"Identive CLOUD 4500 F Contact Reader 0",
"Identive CLOUD 4500 F Contactless Reader 0",
NULL};
/***************************************************************************************
*****************/
ContextHandle = -1; ret = SCardEstablishContext(SCARD_SCOPE_USER, NULL, NULL, &ContextHandle); if (ret == SCARD_S_SUCCESS)
{ s = ReaderName[0]; printf("Connecting to reader %s\n", s); ret = SCardConnect( ContextHandle, s,
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("maxslots:\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++) if (strReaderInfo.abySerialNumber[i] != 0) printf("%c", strReaderInfo.abySerialNumber[i]);
} else { printf("SCardControl failed: %08X\n", ret);
}
} else { printf("SCardConnect failed: %08X\n", ret);
}
CLOUD 45
X
0 F R
EFERENCE
M
ANUAL
ret = SCardReleaseContext(ContextHandle);
} else
{ printf("\n SCardEstablishContext failed with %.8lX",ret);
} printf("\npress any key to close the test tool\n"); getch();
}
100
Download
Public link updated
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Document public link
Advertisement
Key features
Dual Interface Smartcard Reader
Contact and Contactless Card Support
PC/SC v2.0 Compliant
Full CCID Support
Secure In-Field Firmware Upgrade
Unique Reader Serial Number
Supports Variety of Card Technologies
NFC P2P Capable(passive)
Frequently asked questions
The CLOUD 45x0 F series offers a number of benefits, including its support for both contact and contactless smart cards, PC/SC v2.0 compliance, and full CCID support. It also features secure in-field firmware upgrade capabilities and a unique reader serial number for easy plug-and-play functionality.
The CLOUD 45x0 F series supports a variety of card technologies, including ISO 7816 compliant cards, MIFARE series, FeliCa, and NFC forum tags.
The CLOUD 45x0 F series can be used in a variety of applications, such as access control, identity management, and payment systems.
