SpringCard H663 and H512 families are a group of NFC devices / contactless smartcard readers. This document explains how to upgrade their firmware, using the new SpringCard Firmware Upgrade Utility.

At the date of writing, this document refers to the products listed below:

  • H663A and H663S ‘bare’ modules, H663-USB module plus antenna,
  • CrazyWriter-HSP,
  • CSB-HSP,
  • H663A and H512S ‘bare’ modules, H512-USB module plus antenna,

Please read the datasheet of every product for specifications and the detailed list of features.

Important disclaimer:

Please note that SpringCard is not responsible for any procedure that end user performs. Please note that not products can be recovered from improper firmware upgrade or mis-configuration !! YOU’RE FOLLOWING THIS PROCEDURE AT YOUR OWN RISK.

Non-Windows OS

Linux/Mac/Unix users are welcomed to use the open-source DFU-Programmer provided by Atmel and contributors and available at http://dfu-programmer.sourceforge.net/ . SpringCard H663 and H512 use the at32uc3b0256 chip.

The syntax is:

dfu-programmer at32uc3b0256 erase
dfu-programmer at32uc3b0256 flash --suppress-bootloader-mem
dfu-programmer at32uc3b0256 start

Getting started

Requirements

The SpringCard Firmware Utility 2013 works on Windows XP/Vista/7/8, on both x86 and x64 releases.

Download and install SpringCard SU13168 package

Download

Download the SU13168 installation package at address

Installation

Double-click the downloaded executable.

Make sure you install those 2 components:

  • “SpringCard Firmware Upgrade Utility”
  • “DFU USB Driver for Atmel CPUs”

Notes regarding the DFU USB Driver

The microcontroller used by SpringCard H663 and H512 families is an Atmel AVR32 (AT320UC3B0256). This microcontroller is upgradeable on the field, through its USB link. A driver is provided by Atmel to connect the microcontroller through USB, using the USB DFU (Device Firmware Upgrade) standard.

The SpringCard SU13168 package contains release 1.2.2 of Atmel USB Driver for DFU. For any issue related to the driver itself, please visit http://dfu-programmer.sourceforge.net/ and http://sourceforge.net/projects/dfu-programmer/ do download a newer version or to look for support.

Open-source components

The FUU software make uses of pieces of source code released under various open-source licences, including the GNU Public Licence (GPL).

To comply with the GPL, the FUU software it itself released under the GPL.

Check “source code to the open-source components” during install to get the source code.

Locate and download the firmware for your reader

PC/SC readers

The firmware files for the PC/SC Readers are located under https://files.springcard.com/firmwares/springprox/

The subdirectories are named after the version (for instance https://files.springcard.com/firmwares/springprox/1-74 stores all the firmware in the 1.74 branch).

In every subdirectory, the files targeting these families of products are named

  • uc3b0256_rc663_h663_(version).hex for H663 group
  • uc3b0256_pn512_h512_(version).hex for H512 group

Download the firmware you want to use and save it locally on your hard drive.

Quickly download latest firmware’s version

The links below will enable you to download directly the latest version of each firmware :

Working with SpringCard Firmware Upgrade Utility (FUU)

Create your 1st project

When you launch the software for the first time, the list of Existing Projects is empty.

fuu-1

Check Create a new Project, and click OK.

fuu-2

Check Product group: H663/H512. The software opens a dialog box to let you select the firmware you want to put into the product (click Browse if the dialog box doesn’t open automatically).

Browse to the folder where you have downloaded the firmware earlier, and select the firmware file (extension is .HEX).

fuu-3

Back to the “Firmware Upgrade Settings” box, note that a Project Name has been generated from the name of the firmware file.

fuu-4

You may change the name, or just proceed by clicking OK.

Flash your device

Put the device into Flash Mode (see below for a detailed procedure, depending on the hardware). Wait until the USB driver “Atmel DFU for AT32UC3B” is installed and activated by Windows.

fuu-5

fuu-6

Click Flash under the File menu.

fuu-7

The procedure takes less than 20 seconds to terminate.

fuu-8

Don’t forget to put the reader back into operation mode!

Troubleshooting

In case the software says “No DFU device found”, please open Windows’ Device Manager, and check that your device is listed as “Atmel USB” and without error mark.

  • If the device is not listed at all –> check hardware (cable, ower supply etc)
  • If the device is listed as PC/SC reader, RFID Scanner, or other SpringCard, device –> make sur the device is in Flash Mode and reset it until it boots on its DFU bootloader,
  • If an error mark is present –> check the DFU USB Driver version, contact developers of the driver for support.

Open an Existing Project

Once a Project has been created, FUU allows you to re-open it later on.

fuu-9

Make sure the Existing Projects box is checked, select the Project in the list and click OK.

You may also double-click the Project you want in the list.

Putting your device into Flash Mode

Bare H663 or H512 modules

Tie the /FLASH pin to GND before resetting (or powering up) the device to make it starts on its DFU bootloader.

For the H512, you can use a simple cable like this (connect the second pin to the reader’s housing) :

How to flash the H512

If a switch is available, you can use it (set to ON for firmware update):

twisty-writer-hsp

Modules on antennas

Use the method depicted below for the bare modules, or shunt pins 1 and 7 on the JST connector.

CrazyWriter-HSP

Locate the 4 configuration switches and set them to ON ON ON OFF to load the firmware.

Remember to put the switches back to normal position ON OFF ON OFF afterwards.

crazywriter-hsp_switches

CSB-HSP

Remove the 4 screws to open the product’s shell.

Locate the 4 configuration switches and set them to ON ON ON OFF to load the firmware.

Remember to put the switches back to normal position ON OFF ON OFF afterwards.

CSB HSP

Pay attention when closing the shell that the screws at the front are shorter than the screws at the back!

 

NOTE : Products without SAM nor contact slot (like Prox’N’Roll) could be used with Microsoft’s CCID driver (shipped with Windows or available on Windows Update). Only our driver gives access to the SAM or contact slots of the other products.

Please unplug any PC/SC reader from your computer before starting this procedure.

First, download our driver from our main website:

Then, install the downloaded driver. When executing the installation file sdd480-xx.exe file, if you have a Security Warning pop up, simply click “Run”:

Security Warning – click on “Run”

 

 

 

 

 

 

 

 

The installation of the driver is starting, click on “Next” on the following windows:

Click on “Next”

 

 

 

 

 

 

 

 

Click on “Next”

 

 

 

 

 

 

 

 

 

 

The files are installing on your computer:

Wait for the drivers file to install

 

 

 

 

 

 

 

 

 

Once the files have installed, the installation of the driver is done. Click on the “Finish” button:

Installation finished – click on “Finish”

 

 

 

 

 

 

 

 

 

Installation finished – click on “Finish”

 

 

 

 

 

 

 

 

 

 

Now plug in your PC/SC reader. You should see an icon in the bottom right corner of your screen:

Installing the reader

Reader Installed

 

 

 

 

To check that the reader has been correctly installed, run PC/SC Diag available in our PC/SC SDK:

Installation is successfull : you can see all the slots of your PC/SC reader

 

APPENDIX

If you don’t see anything in PC/SC Diag, even after doing this procedure, your Smart Card Service might be disabled.

PC/SC Diag shows no reader

In that case, go to the Control Panel of your computer, and look for “Services” under the “Administrative Tool” section.

Services Manager – look for the Smart Card service

If the “Startup Type” (4th Column) of the Smart Card service is set to “Disabled” , right click and open the “Properties” window of the Smart Card service:

Properties of Smart Card Service

 

 

 

 

 

 

 

 

 

 

 

Set startup type as “Automatic”. If “Service status” is set to “Stopped”, click on the “Start” button and wait until the Service status is set to “Start” (as shown on picture above).

In order to retrieve the firmware version of your SpringCard PC/SC reader, please use the Springcard PC/SC Diagnostic Tool, available in our PC/SC SDK (PcscDiag2.exe).

Once launched, the tool should display your smart card reader (in these snapshots, we use a SpringCard Prox’N’Roll PC/SC, but it would be the same for any other SpringCard PC/SC reader). Right click on it, and choose Reader Info :

A pop-up window will then appear, indicating the firmware version (1-64 in this example):

Note: Instead of right clicking on the reader, you can also press Ctl+R to get the same information.

Retrieving the firmware version of your SpringCard PC/SC reader

In order to retrieve the firmware version of your SpringCard PC/SC reader (CSB6Prox’N’Roll PC/SCEasyFinger and CrazyWriter), you’ll need the Springcard PC/SC Diagnostic Tool, available in our SDK (PcscDiag2.exe).

Once launched, the tool should display your smart card reader. In the following snapshots, the reader is a Prox’N’Roll PC/SC, but it would be same for other PC/SC readers (CSB6, CrazyWriter, CrazyWriter-HSP, CSB-HSP, H663, …).

Right click on it, and choose Reader Info :

A pop-up window will then appear, indicating the firmware version (1-64 in this example):

Note: Instead of right clicking on the reader, you can also press Ctl+R to get the same information.

Products in the SpringCard CSB6 Family (CSB6, Prox’N’Roll PC/SC, EasyFinger and CrazyWriter) are smartcard readers, compliant with both standards PC/SC and CCID.

This makes those products usable on non-Windows operating systems thanks to PCSC-Lite CCID driver.

Introduction

PC/SC standard

PC/SC is the de-facto standard to interface Personal Computers with Smart Cards (and smartcard readers of course). Even if PC/SC has been initialy promoted by Microsoft -and has been implemented for long in Windows-, the standard is not limited to MS’ operating systems.

PCSC-Lite is an open source implementation of PC/SC, part of a global project named MUSCLE (Movement for the Use of Smart Cards in a Linux Environment). Despite its name, the PC/SC stack offered by MUSCLE is not limited to GNU/Linux anymore. Their compatibility list now includes other popular UNIXes, including Apple Mac OS X and Solaris.

CCID standard

The USB CCID specification published by the USB Workgroup aims to normalize USB smartcard readers, in order to have a single driver (supplied once for all with the operating system) for virtually any reader from any manufacturer.

PCSC-Lite project includes an open source CCID driver. This driver has been tested with SpringCard CSB6 on GNU/Linux, and should work on the other operating systems targetted by the project.

Disclaimer and warning

There’s no relationship between SpringCard and the developers involved in the open source PCSC-Lite project.

Apart from this explanation page, SpringCard can’t provide any technical support related to PCSC-Lite middleware nor PCSC-Lite CCID driver.

CSB6 Family on GNU/Linux

In this part we’re going to install PCSC-Lite and CSB6‘s drivers on Ubuntu 8.04.1 (Hardy). Some parts of the procedure may vary a little, depending on the GNU/Linux distribution you’re working with.

Do not connect the device to your computer now ! You must download and install the driver before connecting the product.

Download

Go to pcsclite.alioth.debian.org to download both PCSC-Lite and its CCID Driver :

PCSC-Lite : file named pcsc-lite-x.y.z.tar.bz2, “x.y.z” being the version number,
CCID driver : file named ccid-x.y.z.tar.bz2, “x.y.z” being the version number.

Installation

Connect as root.

Uncompress both archives.

N.B. : On Ubuntu (and on some other Linuxes), connecting as root is not possible. In this case, one must prefix every command by “sudo”, to gain root’s priviledges temporary.

Installing PCSC-Lite

Warning, on some Linux distributions, like Raspbian for example, the system comes with a pre installed lib but in an old version of pcsc-lite (for example an 1.8.3 or 1.8.5 version).

First uninstall the current version then install a new one, for example use the 1.8.11 version). Without an update, you should have some problems to run the daemon.

Before to install pcsc-lite you should also verify that libusb is up to date and if necessary install the dev version.

Open a terminal and go to the directory where you have uncompressed the PCSC-Lite archive. Enter the commands :

./configure
make
make install
Troubleshooting

If the configure step fails with message error: usb.h not found, check that you have the libusb library installed. If needed, please install it, and then give the path to this library to the configuration script: ./configure LIBUSB_CFLAGS=....

On Ubuntu or Debian, you may alternatively use apt-get to download and install the libusb-dev package :
apt-get install libusb-dev

Installing CCID driver

Open a terminal and go to the directory where you have uncompressed the CCID Driver archive. Enter the commands :

./configure
make
make install

Change Info.plist

With some old Linux distributions, the file called info.plist is not up to date so you may have to change it to work with our readers.

Locate the file called Info.plist, for example with a command like this one :

sudo find / -name Info.plist

You will, for example, find it in /usr/local/lib/pcsc/drivers/ifd-ccid.bundle/Contents/Info.plist

Edit the file to add your product’s IDs.

You can refer to the section dedicated to Mac Os X to see what you need to change.

Enabling PCSC-Lite daemon

PCSC-Lite’s pcscd process must be running in the background.

If you have some problems with the daemon you can launch it this way to see some error messages : pcscd -fd

If you see some error messages related to “permission denied”, try to launch make fix-rights from the folder where you have downloaded pcsc-lite (use sudo if necessary).

Starting pcscd manually

Open a terminal and go to the directory where PCSC-Lite has been installed. Typically, this is /usr/local/sbin/pcscd.

In this directory, enter the command ./pcscd.

Configuring pcscd to be launched on startup

It is better to have pcscd automatically started when the computer starts. To do so, you must add pcscd in the list of processes started in rc.local or equivalent startup script.

Connecting the device

Plug the device onto an unused USB connector.

In a terminal, use the command lsusb to verify device’s information.

lsusb result

In the above screenshot, we have a CSB6 connected : Vendor ID=0x1C34 (Pro Active and SpringCard), Product ID=0x7124 (CSB6 Ultimate, PC/SC mode).
Other devices will have different ProductIDs ; all products in the CSB6 PC/SC family have a ProductID in the 0x7100 to 0x71FF range.

Validating the installation

To test the newly installed reader, we’ll use gscriptor, an open source PERL software, able to exchange APDUs with smartcards through the PCSC-Lite stack.

Installing PCSC-Perl

Go to ludovic.rousseau.free.fr/softwares/pcsc-perl and download pcsc-perl-x.y.z.tar.gz, “x.y.z” being the version number.

Uncompress the archive. Install the package as follow :

perl Makefile.PL
make
make install

Go to ludovic.rousseau.free.fr/softwares/pcsc-tools and download pcsc-tools-x.y.z.tar.gz, “x.y.z” being the version number.

Uncompress the archive. Launch the gscriptor program.

gscriptor windows

Card connect

Select the contactless slot of your CSB6 reader (usually the first reader in the the list),

Put any compliant contactless card on the reader,

Connect to the card (Reader -> Connect).

APDU exchange

Write the APDU command in the script panel. You may use the command FF CA 00 00 00 (get card serial number) as a test.

Click Run. Observe card’s response in the result panel.

Well, in this test this not actually a response from the card… The command FFCA000000 is interpreted by the reader (CLA=FF is reserved for the embedded APDU interpreter), so it is the reader that actually answers. The returned data are the serial number of the contactless card. Remember, we’ve put ‘any’ contactless card on the reader, and querying the serial number is more or less the only command that is available for any kind of card…

Troubleshooting

If invoking gscriptor fails with message Can't locate Chipcard/PCSC.pm, re-install PCSC-Perl and/or verify PERL’s include directories.

Other tools

If you are not using a graphical user interface, you can still use pcsc scan to test your reader with some cards. From the command line, juste type pcsc_scan.

CSB6 Family on Mac OS X

Starting with MacOS X version 10.4, the PCSC-Lite package and the CCID driver are included in the system. We just need to add entries for SpringCard readers into the configuration file of the CCID driver to have them supported.

Configuring CCID driver to support our readers

Open CCID driver’s Info.plist

Open a Terminal window and enter this command :

sudo nano /usr/libexec/SmartCardServices/drivers/ifd-ccid.bundle/Contents/Info.plist

Note : the command may be splited into a few lines if your screen is too narrow. You must enter it at once, with only a single <Enter> at the end, after Info.plist

Enter your password if prompted to do so.

Note, if you can’t modify (or save) this file :

  • Turn off your Mac
  • Boot into recovery (when you press power button, you should be already holding cmd R keys, hold them as long as the display is clear white)
  • In the recovery system, go in the menubar to Utilities > Terminal
  • Terminal window will pop-up. Enter:
    • csrutil disable
  • Confirm with enter
  • Close Terminal, restart the computer through Apple logo in top left corner
  • From here on, the SIP is disabled and you can edit your file. It should be noted, that after you are done with your modifications, you should definitely re-enable the SIP. The method is same as above, the only difference is that you will type into Terminal:
    • csrutil enable

Add SpringCard’s USB Vendor ID

Scroll down, locate the block beginning by <key>ifdVendorID</key>,

Scroll down until you reach the end of the block,

Add 3 occurences of the line <string>0x1C34</string>.

Note : We need to add our Vendor ID 3 times, because we are to support 3 different Product IDs.

Add the Product IDs of SpringCard’s readers

Scroll down, locate the block beginning by <key>ifdProductID</key>,

Scroll down until you reach the end of the block,

Add the following lines :

<string>0x7113</string>
<string>0x7124</string>
<string>0x7141</string>

Add the names of SpringCard’s readers

Scroll down, locate the block beginning by <key>ifdFriendlyName</key>,

Scroll down until you reach the end of the block,

Add the following lines :

<string>CrazyWriter</string>
<string>CSB6 Ultimate</string>
<string>Prox'N'Roll</string>

Save and restart

Save the modified file. Exit nano and restart the computer.

Validation

Plug the reader onto a computer’s USB port,

Open a Terminal window and enter the command pcsctest,

pcsctest displays the list of connected readers (in the following snapshots, only one Prox’N’Roll is connected),

Enter the number of the reader you want to test (in our case, only ‘1’ is allowed).

Put a card on the reader, and check that everything is running as expected.

In case of trouble

If you are experiencing problem(s), you can, in a terminal, launch this command to see if the daemon reports any error message :

sudo /usr/sbin/pcscd --apdu --debug --foreground

For example you could have a syntax error inside your Info.plist file.

You may also check in the activity monitor that you have a process called pcscd (you can use the search on the top right corner). If that’s the case, then the daemon is running.

If you have a problem with OS X 10.8 Mountain Lion, consult this forum (reported here) :

For all on OS X Mountain Lion.

There is an issue with the pcscd where when you boot OS X with your reader connected and card inserted, the daemon will not get launched properly.
Did not delve deeper yet but running pcsctest will say “Service not available”.
Manually killing it so it gets relaunched will do the trick or just not connecting your reader while booting.

For all the eid applets out there, the result is the applet getting stuck on a “Please connect your reader” message.

A bugreport has been filed with apple, also hinting that it would be nice for em to update the ccid-driver and pcsc-lite for a change :)
As Ludovic states, the ccid-driver for example is 3 years old and by consequence is missing possibly bad support for 97 readers since t hat version :)

source: http://ludovicrousseau.blogspot.be/2012/08/mac-os-x-mountain-lion-and-smart-card.html

New WHQL-certified PC/SC driver

Edited 24/04/2012: an updated version has been published to correct a few bugs. Please read this article.

Our new PC/SC driver is now online and ready for download! This driver (code name : SDD480-BA) has been certified my Microsoft’s Windows Hardware Qualification Labs (WHQL) for both 32 and 64 bits operating systems.

It targets all SpringCard USB CCID readers :
CSB6
CrazyWriter
EasyFinger
Prox’N’Roll PC/SC

Note: as the Prox’N’Roll has only one smartcard slot (its contactless card interface), it is not required to use our driver since the default CCID driver supplied by Microsoft also does the job.

The SDD480-BA driver is also ready for the new generation of USB CCID products that will be launched in a near future.

To download the driver, please go to http://www.springcard.com/download/find.php?file=sdd480

Choose either
sdd480_x86-ba.exe for 32 bits targets (certified and signed for Windows 2000, XP, Vista and Seven on i386 core)
sdd480_x64-ba.exe for 64 bits targets (certified and signed for Windows XP, Vista and Seven on amd64 or intel64 core)

The setup package uncompress the driver in Program Files\SpringCard\SDD480_x86-ba (or Program Files\SpringCard\SDD480_x64-ba depending on the target) and then installs the driver into Windows’ system directory. Of course you must run the setup with administrative priviledges.

The driver will also be available through Windows Update very soon.

A few more details for integrators and developers

Should you need to redistribute this driver with your own software or to recreate a setup package bundled with yours, just copy the uncompressed files and invoke DPInst.exe when you want the installation to take place.

Although we’ve done our best to ensure full compatibility with our previous (unsigned) driver and with Microsoft’s default CCID driver, please pay attention that the naming of the slots may be a little different in some cases. In fact slot naming and numbering has been designed to show clearly which slots belongs to which reader. Let’s suppose we have 2 CrazyWriter and 1 CSB6 connected to the PC. The 1st CrazyWriter instanciates 3 slots: CrazyWriter Contactless 0, CrazyWriter SAM A 0, CrazyWriter SAM B 0; the 2nd CrazyWriter instanciates 3 slots as well: CrazyWriter Contactless 1, CrazyWriter SAM A 1, CrazyWriter SAM B 1. Then the CSB6 instanciates 5 slots : CSB6 Contactless 2, CSB6 Contact 2, CSB6 SAM A 2, CSB6 SAM B 2, CSB6 SAM C 2. You see that the number is the same for all slots of one reader. This is the best approach to know which SAM (or contact interface) comes with whatever contactless interface.