ccid/src/ccid_usb.c

/*
    ccid_usb.c: USB access routines using the libusb library
    Copyright (C) 2003-2004   Ludovic Rousseau

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
*/

/*
 * $Id$
 */

#define __CCID_USB__

#include <stdio.h>
#include <string.h> 
#include <errno.h>
# ifdef S_SPLINT_S
# include <sys/types.h>
# endif
#include <usb.h>

#include "ccid.h"
#include "config.h"
#include "debug.h"
#include "defs.h"
#include "utils.h"
#include "parser.h"
#include "ccid_ifdhandler.h"


/* write timeout
 * we don't have to wait a long time since the card was doing nothing */
#define USB_WRITE_TIMEOUT (5 * 1000)  /* 5 seconds timeout */

/*
 * Proprietary USB Class (0xFF) are (or are not) accepted
 * A proprietary class is used for devices released before the final CCID
 * specifications were ready.
 * We should not have problems with non CCID devices becasue the
 * Manufacturer and Product ID are also used to identify the device */
#define ALLOW_PROPRIETARY_CLASS

/*
 * The O2Micro OZ776S reader has a wrong USB descriptor
 * The extra[] field is associated with the last endpoint instead of the
 * main USB descriptor
 */
#define O2MICRO_OZ776_PATCH

#define BUS_DEVICE_STRSIZE 32

typedef struct
{
        usb_dev_handle *handle;
        struct usb_device *dev;
        int interface;

        /*
         * Endpoints
         */
        int bulk_in;
        int bulk_out;

        /*
         * CCID infos common to USB and serial
         */
        _ccid_descriptor ccid;

} _usbDevice;

/* The _usbDevice structure must be defined before including ccid_usb.h */
#include "ccid_usb.h"

static int get_end_points(struct usb_device *dev, _usbDevice *usb_device);
int ccid_check_firmware(struct usb_device *dev);
static unsigned int *get_data_rates(unsigned int reader_index);

/* ne need to initialize to 0 since it is static */
static _usbDevice usbDevice[CCID_DRIVER_MAX_READERS];

#define PCSCLITE_MANUKEY_NAME                   "ifdVendorID"
#define PCSCLITE_PRODKEY_NAME                   "ifdProductID"
#define PCSCLITE_NAMEKEY_NAME                   "ifdFriendlyName"

struct _bogus_firmware
{
        int vendor;             /* idVendor */
        int product;    /* idProduct */
        int firmware;   /* bcdDevice: previous firmwares have bugs */
};

static struct _bogus_firmware Bogus_firmwares[] = {
        { 0x0b97, 0x7762, 0x0111 },     /* Oz776S */ /* the firmware version if not correct since I don't have received a working reader yet */
        { 0x04e6, 0xe001, 0x0516 },     /* SCR 331 */
        { 0x04e6, 0x5111, 0x0620 },     /* SCR 331-DI */
        { 0x04e6, 0x5115, 0x0514 },     /* SCR 335 */
        { 0x04e6, 0xe003, 0x0504 },     /* SPR 532 */
        { 0x0D46, 0x3001, 0x0037 },     /* KAAN Base */
        { 0x0D46, 0x3002, 0x0037 },     /* KAAN Advanced */
};


/*****************************************************************************
 *
 *                                      OpenUSB
 *
 ****************************************************************************/
status_t OpenUSB(unsigned int reader_index, /*@unused@*/ int Channel)
{
        return OpenUSBByName(reader_index, NULL);
} /* OpenUSB */


/*****************************************************************************
 *
 *                                      OpenUSBByName
 *
 ****************************************************************************/
status_t OpenUSBByName(unsigned int reader_index, /*@null@*/ char *device)
{
        static struct usb_bus *busses = NULL;
        int alias = 0;
        struct usb_bus *bus;
        struct usb_dev_handle *dev_handle;
        char keyValue[TOKEN_MAX_VALUE_SIZE];
        int vendorID, productID;
        char infofile[FILENAME_MAX];
        unsigned int device_vendor, device_product;
        char *dirname = NULL, *filename = NULL;
        static int previous_reader_index = -1;

        DEBUG_COMM3("Reader index: %X, Device: %s", reader_index, device);

        /* device name specified */
        if (device)
        {
                /* format: usb:%04x/%04x, vendor, product */
                if (strncmp("usb:", device, 4) != 0)
                {
                        DEBUG_CRITICAL2("device name does not start with \"usb:\": %s",
                                device);
                        return STATUS_UNSUCCESSFUL;
                }

                if (sscanf(device, "usb:%x/%x", &device_vendor, &device_product) != 2)
                {
                        DEBUG_CRITICAL2("device name can't be parsed: %s", device);
                        return STATUS_UNSUCCESSFUL;
                }

                /* format usb:%04x/%04x:libusb:%s
                 * with %s set to %s:%s, dirname, filename */
                if ((dirname = strstr(device, "libusb:")) != NULL)
                {
                        /* dirname points to the first char after libusb: */
                        dirname += strlen("libusb:");

                        /* search the : (separation) char */
                        filename = strchr(dirname, ':');

                        if (filename)
                        {
                                /* end the dirname string */
                                *filename = '\0';

                                /* filename points to the first char after : */
                                filename++;
                        }
                        else
                        {
                                /* parse failed */
                                dirname = NULL;

                                DEBUG_CRITICAL2("can't parse using libusb scheme: %s", device);
                        }
                }
        }

        if (busses == NULL)
                usb_init();

        usb_find_busses();
        usb_find_devices();

        busses = usb_get_busses();

        if (busses == NULL)
        {
                DEBUG_CRITICAL("No USB busses found");
                return STATUS_UNSUCCESSFUL;
        }

        /* is the reader_index already used? */
        if (usbDevice[reader_index].handle != NULL)
        {
                DEBUG_CRITICAL2("USB driver with index %X already in use",
                        reader_index);
                return STATUS_UNSUCCESSFUL;
        }

        /* Info.plist full patch filename */
        snprintf(infofile, sizeof(infofile), "%s/%s/Contents/Info.plist",
                PCSCLITE_HP_DROPDIR, BUNDLE);

        /* general driver info */
        if (!LTPBundleFindValueWithKey(infofile, "ifdManufacturerString", keyValue, 0))
        {
                DEBUG_CRITICAL2("Manufacturer: %s", keyValue);
        }
        else
        {
                DEBUG_CRITICAL2("LTPBundleFindValueWithKey error. Can't find %s?",
                        infofile);
                return STATUS_UNSUCCESSFUL;
        }
        if (!LTPBundleFindValueWithKey(infofile, "ifdProductString", keyValue, 0))
        {
                DEBUG_CRITICAL2("ProductString: %s", keyValue);
        }
        else
                return STATUS_UNSUCCESSFUL;
        if (!LTPBundleFindValueWithKey(infofile, "Copyright", keyValue, 0))
        {
                DEBUG_CRITICAL2("Copyright: %s", keyValue);
        }
        else
                return STATUS_UNSUCCESSFUL;
        vendorID = strlen(keyValue);
        alias = 0x1D;
        for (; vendorID--;)
                alias ^= keyValue[vendorID];

        /* for any supported reader */
        while (LTPBundleFindValueWithKey(infofile, PCSCLITE_MANUKEY_NAME, keyValue, alias) == 0)
        {
                vendorID = strtoul(keyValue, NULL, 0);

                if (LTPBundleFindValueWithKey(infofile, PCSCLITE_PRODKEY_NAME, keyValue, alias))
                        goto end;
                productID = strtoul(keyValue, NULL, 0);

                if (LTPBundleFindValueWithKey(infofile, PCSCLITE_NAMEKEY_NAME, keyValue, alias))
                        goto end;

                /* go to next supported reader for next round */
                alias++;

                /* the device was specified but is not the one we are trying to find */
                if (device
                        && (vendorID != device_vendor || productID != device_product))
                        continue;

                /* on any USB buses */
                for (bus = busses; bus; bus = bus->next)
                {
                        struct usb_device *dev;

                        /* any device on this bus */
                        for (dev = bus->devices; dev; dev = dev->next)
                        {
                                /* device defined by name? */
                                if (dirname && (strcmp(dirname, bus->dirname)
                                        || strcmp(filename, dev->filename)))
                                        continue;

                                if (dev->descriptor.idVendor == vendorID
                                        && dev->descriptor.idProduct == productID)
                                {
                                        int r, already_used;
                                        struct usb_interface *usb_interface = NULL;
                                        int interface;

                                        /* is it already opened? */
                                        already_used = FALSE;

                                        for (r=0; r<CCID_DRIVER_MAX_READERS; r++)
                                        {
                                                if (usbDevice[r].dev)
                                                {
                                                        DEBUG_COMM3("Checking device: %s/%s",
                                                                bus->dirname, dev->filename);
                                                        /* same busname, same filename */
                                                        if (strcmp(usbDevice[r].dev->bus->dirname, bus->dirname) == 0 && strcmp(usbDevice[r].dev->filename, dev->filename) == 0)
                                                                already_used = TRUE;
                                                }
                                        }

                                        /* this reader is already managed by us */
                                        if (already_used)
                                        {
                                                if ((previous_reader_index != -1)
                                                        && (strcmp(usbDevice[previous_reader_index].dev->bus->dirname, bus->dirname)  == 0)
                                                        && (strcmp(usbDevice[previous_reader_index].dev->filename, dev->filename) == 0)
                                                        && usbDevice[previous_reader_index].ccid.bCurrentSlotIndex < usbDevice[previous_reader_index].ccid.bMaxSlotIndex)
                                                {
                                                        /* we reuse the same device
                                                         * and the reader is multi-slot */
                                                        usbDevice[reader_index] = usbDevice[previous_reader_index];
                                                        usbDevice[reader_index].ccid.pbSeq = usbDevice[previous_reader_index].ccid.pbSeq;
                                                        usbDevice[reader_index].ccid.bCurrentSlotIndex++;
                                                        DEBUG_INFO2("Opening slot: %d",
                                                                usbDevice[reader_index].ccid.bCurrentSlotIndex);
                                                        goto end;
                                                }
                                                else
                                                {
                                                        DEBUG_INFO3("USB device %s/%s already in use."
                                                                " Checking next one.",
                                                                bus->dirname, dev->filename);
                                                }

                                                continue;
                                        }

                                        DEBUG_COMM3("Trying to open USB bus/device: %s/%s",
                                                 bus->dirname, dev->filename);

                                        dev_handle = usb_open(dev);
                                        if (dev_handle == NULL)
                                        {
                                                DEBUG_CRITICAL4("Can't usb_open(%s/%s): %s",
                                                        bus->dirname, dev->filename, strerror(errno));

                                                continue;
                                        }

                                        /* now we found a free reader and we try to use it */
                                        if (dev->config == NULL)
                                        {
                                                DEBUG_CRITICAL3("No dev->config found for %s/%s",
                                                         bus->dirname, dev->filename);
                                                return STATUS_UNSUCCESSFUL;
                                        }

                                        usb_interface = get_ccid_usb_interface(dev);
                                        if (usb_interface == NULL)
                                        {
                                                DEBUG_CRITICAL3("Can't find a CCID interface on %s/%s",
                                                        bus->dirname, dev->filename);
                                                return STATUS_UNSUCCESSFUL;
                                        }                       

                                        if (usb_interface->altsetting->extralen != 54)
                                        {
                                                DEBUG_CRITICAL4("Extra field for %s/%s has a wrong length: %d", bus->dirname, dev->filename, usb_interface->altsetting->extralen);
                                                return STATUS_UNSUCCESSFUL;
                                        }

                                        interface = usb_interface->altsetting->bInterfaceNumber;
                                        if (usb_claim_interface(dev_handle, interface) < 0)
                                        {
                                                DEBUG_CRITICAL4("Can't claim interface %s/%s: %s",
                                                        bus->dirname, dev->filename, strerror(errno));
                                                return STATUS_UNSUCCESSFUL;
                                        }

                                        DEBUG_INFO4("Found Vendor/Product: %04X/%04X (%s)",
                                                dev->descriptor.idVendor,
                                                dev->descriptor.idProduct, keyValue);
                                        DEBUG_INFO3("Using USB bus/device: %s/%s",
                                                 bus->dirname, dev->filename);

                                        /* check for firmware bugs */
                                        if (ccid_check_firmware(dev))
                                                return STATUS_UNSUCCESSFUL;

                                        /* Get Endpoints values*/
                                        get_end_points(dev, &usbDevice[reader_index]);

                                        /* store device information */
                                        usbDevice[reader_index].handle = dev_handle;
                                        usbDevice[reader_index].dev = dev;
                                        usbDevice[reader_index].interface = interface;

                                        /* CCID common informations */
                                        usbDevice[reader_index].ccid.real_bSeq = 0;
                                        usbDevice[reader_index].ccid.pbSeq = &usbDevice[reader_index].ccid.real_bSeq;
                                        usbDevice[reader_index].ccid.readerID =
                                                (dev->descriptor.idVendor << 16) +
                                                dev->descriptor.idProduct;
                                        usbDevice[reader_index].ccid.dwFeatures = dw2i(usb_interface->altsetting->extra, 40);
                                        usbDevice[reader_index].ccid.bPINSupport = usb_interface->altsetting->extra[52];
                                        usbDevice[reader_index].ccid.dwMaxCCIDMessageLength = dw2i(usb_interface->altsetting->extra, 44);
                                        usbDevice[reader_index].ccid.dwMaxIFSD = dw2i(usb_interface->altsetting->extra, 28);
                                        usbDevice[reader_index].ccid.dwDefaultClock = dw2i(usb_interface->altsetting->extra, 10);
                                        usbDevice[reader_index].ccid.dwMaxDataRate = dw2i(usb_interface->altsetting->extra, 23);
                                        usbDevice[reader_index].ccid.bMaxSlotIndex = usb_interface->altsetting->extra[4];
                                        usbDevice[reader_index].ccid.bCurrentSlotIndex = 0;
                                        usbDevice[reader_index].ccid.readTimeout = DEFAULT_COM_READ_TIMEOUT;
                                        usbDevice[reader_index].ccid.arrayOfSupportedDataRates = get_data_rates(reader_index);
                                        goto end;
                                }
                        }
                }
        }
end:
        if (usbDevice[reader_index].handle == NULL)
                return STATUS_UNSUCCESSFUL;

        /* memorise the current reader_index so we can detect
         * a new OpenUSBByName on a multi slot reader */
        previous_reader_index = reader_index;

        return STATUS_SUCCESS;
} /* OpenUSBByName */


/*****************************************************************************
 *
 *                                      WriteUSB
 *
 ****************************************************************************/
status_t WriteUSB(unsigned int reader_index, unsigned int length,
        unsigned char *buffer)
{
        int rv;
#ifdef DEBUG_LEVEL_COMM
        char debug_header[] = "-> 121234 ";

        sprintf(debug_header, "-> %06X ", (int)reader_index);
#endif

#ifdef DEBUG_LEVEL_COMM
        DEBUG_XXD(debug_header, buffer, length);
#endif

        rv = usb_bulk_write(usbDevice[reader_index].handle,
                usbDevice[reader_index].bulk_out, (char *)buffer, length,
                USB_WRITE_TIMEOUT);

        if (rv < 0)
        {
                if (usbDevice[reader_index].dev->bus)
                {
                        DEBUG_CRITICAL4("usb_bulk_write(%s/%s): %s",
                                usbDevice[reader_index].dev->bus->dirname,
                                usbDevice[reader_index].dev->filename, strerror(errno));
                }
                else
                        DEBUG_CRITICAL2("usb_bulk_write(no device): %s", strerror(errno));

                return STATUS_UNSUCCESSFUL;
        }

        return STATUS_SUCCESS;
} /* WriteUSB */


/*****************************************************************************
 *
 *                                      ReadUSB
 *
 ****************************************************************************/
status_t ReadUSB(unsigned int reader_index, unsigned int * length,
        unsigned char *buffer)
{
        int rv;
#ifdef DEBUG_LEVEL_COMM
        char debug_header[] = "<- 121234 ";

        sprintf(debug_header, "<- %06X ", (int)reader_index);
#endif

        rv = usb_bulk_read(usbDevice[reader_index].handle,
                usbDevice[reader_index].bulk_in, (char *)buffer, *length,
                usbDevice[reader_index].ccid.readTimeout * 1000);

        if (rv < 0)
        {
                *length = 0;
                DEBUG_CRITICAL4("usb_bulk_read(%s/%s): %s",
                        usbDevice[reader_index].dev->bus->dirname,
                        usbDevice[reader_index].dev->filename, strerror(errno));
                return STATUS_UNSUCCESSFUL;
        }

        *length = rv;

#ifdef DEBUG_LEVEL_COMM
        DEBUG_XXD(debug_header, buffer, *length);
#endif

        return STATUS_SUCCESS;
} /* ReadUSB */


/*****************************************************************************
 *
 *                                      CloseUSB
 *
 ****************************************************************************/
status_t CloseUSB(unsigned int reader_index)
{
        /* device not opened */
        if (usbDevice[reader_index].dev == NULL)
                return STATUS_UNSUCCESSFUL;

        DEBUG_COMM3("Closing USB device: %s/%s",
                usbDevice[reader_index].dev->bus->dirname,
                usbDevice[reader_index].dev->filename);

        if (usbDevice[reader_index].ccid.arrayOfSupportedDataRates)
                free(usbDevice[reader_index].ccid.arrayOfSupportedDataRates);

        /* reset so that bSeq starts at 0 again */
        usb_reset(usbDevice[reader_index].handle);

        usb_release_interface(usbDevice[reader_index].handle,
                usbDevice[reader_index].interface);
        usb_close(usbDevice[reader_index].handle);

        /* mark the resource unused */
        usbDevice[reader_index].handle = NULL;
        usbDevice[reader_index].dev = NULL;
        usbDevice[reader_index].interface = 0;

        return STATUS_SUCCESS;
} /* CloseUSB */


/*****************************************************************************
 *
 *                                      get_ccid_descriptor
 *
 ****************************************************************************/
_ccid_descriptor *get_ccid_descriptor(unsigned int reader_index)
{
        return &usbDevice[reader_index].ccid;
} /* get_ccid_descriptor */


/*****************************************************************************
 *
 *                                      get_desc
 *
 ****************************************************************************/
int get_desc(int lun, usb_dev_handle **handle, struct
        usb_device **dev)
{
        int reader_index;

        if (-1 == (reader_index = LunToReaderIndex(lun)))
                return FALSE;

        *handle = usbDevice[reader_index].handle;
        *dev = usbDevice[reader_index].dev;

        return TRUE;
} /* get_desc */


/*****************************************************************************
 *
 *                                      get_end_points
 *
 ****************************************************************************/
static int get_end_points(struct usb_device *dev, _usbDevice *usb_device)
{
        int i;
        int bEndpointAddress;
        struct usb_interface *usb_interface = get_ccid_usb_interface(dev);
        
        /*
         * 3 Endpoints maximum: Interrupt In, Bulk In, Bulk Out
         */
        for (i=0; i<3; i++)
        {
                if (usb_interface->altsetting->endpoint[i].bmAttributes != USB_ENDPOINT_TYPE_BULK)
                        continue;

                bEndpointAddress = usb_interface->altsetting->endpoint[i].bEndpointAddress;

                if ((bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_ENDPOINT_IN)
                        usb_device->bulk_in = bEndpointAddress;

                if ((bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_ENDPOINT_OUT)
                        usb_device->bulk_out = bEndpointAddress;
        }

        return 0;
} /* get_end_points */


/*****************************************************************************
 *
 *                                      get_ccid_usb_interface
 *
 ****************************************************************************/
/*@null@*/ struct usb_interface * get_ccid_usb_interface(struct usb_device *dev)
{
        struct usb_interface *usb_interface = NULL; 

        /* if multiple interfaces use the first one with CCID class type */
        if (dev->config->bNumInterfaces > 1)
        {
                int ii;
                for (ii=0; ii<dev->config->bNumInterfaces; ii++)
                {
                        /* CCID Class? */
                        if (dev->config->interface[ii].altsetting->bInterfaceClass == 0xb
#ifdef ALLOW_PROPRIETARY_CLASS
                                || dev->config->interface[ii].altsetting->bInterfaceClass == 0xff
#endif
                                )
                        {
                                usb_interface = &dev->config->interface[ii];
                                break;
                        }
                }
        }
        else
                /* only one interface found */
                usb_interface = dev->config->interface;

#ifdef O2MICRO_OZ776_PATCH
        if (usb_interface != NULL
                && (OZ776 == (dev->descriptor.idVendor << 16)
                + dev->descriptor.idProduct)
                && (0 == usb_interface->altsetting->extralen)) /* this is the bug */
        {
                int i;

                for (i=0; i<usb_interface->altsetting->bNumEndpoints; i++)
                {
                        /* find the extra[] array */
                        if (54 == usb_interface->altsetting->endpoint[i].extralen)
                        {
                                /* get the extra[] from the endpoint */
                                usb_interface->altsetting->extralen = 54;
                                usb_interface->altsetting->extra =
                                        usb_interface->altsetting->endpoint[i].extra;
                                break;
                        }
                }
        }
#endif

        return usb_interface;
} /* get_ccid_usb_interface */


/*****************************************************************************
 *
 *                                      ccid_check_firmware
 *
 ****************************************************************************/
int ccid_check_firmware(struct usb_device *dev)
{
        int i;

        for (i=0; i<sizeof(Bogus_firmwares)/sizeof(Bogus_firmwares[0]); i++)
        {
                if (dev->descriptor.idVendor != Bogus_firmwares[i].vendor)
                                continue;

                if (dev->descriptor.idProduct != Bogus_firmwares[i].product)
                        continue;

                /* firmware too old and buggy */
                if (dev->descriptor.bcdDevice < Bogus_firmwares[i].firmware)
                {
                        if (DriverOptions & DRIVER_OPTION_USE_BOGUS_FIRMWARE)
                        {
                                DEBUG_INFO3("Firmware (%X.%02X) is bogus! but you choosed to use it",
                                        dev->descriptor.bcdDevice >> 8,
                                        dev->descriptor.bcdDevice & 0xFF);
                                return FALSE;
                        }
                        else
                        {
                                DEBUG_CRITICAL3("Firmware (%X.%02X) is bogus! Upgrade the reader firmware or get a new reader.",
                                        dev->descriptor.bcdDevice >> 8,
                                        dev->descriptor.bcdDevice & 0xFF);
                                return TRUE;
                        }
                }
        }

        /* by default the firmware is not bogus */
        return FALSE;
} /* ccid_check_firmware */

/*****************************************************************************
 *
 *                                      get_data_rates
 *
 ****************************************************************************/
static unsigned int *get_data_rates(unsigned int reader_index)
{
        int n, i;
        unsigned char buffer[256*sizeof(int)];  /* maximum is 256 records */
        unsigned int *int_array;

        /* See CCID 3.7.3 page 25 */
        n = usb_control_msg(usbDevice[reader_index].handle,
                0xA1, /* request type */
                0x03, /* GET_DATA_RATES */
                0x00, /* value */
                usbDevice[reader_index].interface, /* interface */
                (char *)buffer,
                sizeof(buffer),
                usbDevice[reader_index].ccid.readTimeout * 1000);

        /* we got an error? */
        if (n <= 0)
        {
                DEBUG_INFO2("IFD does not support GET_DATA_RATES request: %s",
                        strerror(errno));
                return NULL;
        }

        /* we got a strange value */
        if (n % 4)
        {
                DEBUG_INFO2("Wrong GET DATA RATES size: %d", n);
                return NULL;
        }

        /* allocate the buffer (including the end marker) */
        n /= sizeof(int);
        int_array = calloc(n+1, sizeof(int));
        if (NULL == int_array)
        {
                DEBUG_CRITICAL("Memory allocation failed");
                return NULL;
        }

        /* convert in correct endianess */
        for (i=0; i<n; i++)
        {
                int_array[i] = dw2i(buffer, i*4);
                DEBUG_INFO2("declared: %d bps", int_array[i]);
        }

        /* end of array marker */
        int_array[i] = 0;

        return int_array;
}

Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision