/*- * Public platform independent Near Field Communication (NFC) library * * Copyright (C) 2009, Roel Verdult * Copyright (C) 2010, Romain Tartière, Romuald Conty * Copyright (C) 2011, Romain Tartière, Romuald Conty * * This program 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 3 of the License, or (at your * option) any later version. * * This program 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 General Public License for * more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see <http://www.gnu.org/licenses/> */ /** * @file acr122_usb.c * @brief Driver for ACR122 using direct USB (without PCSC) */ #ifdef HAVE_CONFIG_H # include "config.h" #endif // HAVE_CONFIG_H /* Thanks to d18c7db and Okko for example code */ #include <stdio.h> #include <stdlib.h> #include <inttypes.h> #include <sys/select.h> #include <errno.h> #ifndef _WIN32 // Under POSIX system, we use libusb (>= 0.1.12) #include <usb.h> #define USB_TIMEDOUT ETIMEDOUT #define _usb_strerror( X ) strerror(-X) #else // Under Windows we use libusb-win32 (>= 1.2.5) #include <lusb0_usb.h> #define USB_TIMEDOUT 116 #define _usb_strerror( X ) usb_strerror() #endif #include <string.h> #include <nfc/nfc.h> #include "nfc-internal.h" #include "chips/pn53x.h" #include "chips/pn53x-internal.h" #include "drivers/acr122_usb.h" #define PN53X_USB_DRIVER_NAME "acr122_usb" #define LOG_CATEGORY "libnfc.driver.acr122_usb" #define USB_INFINITE_TIMEOUT 0 #define DRIVER_DATA(pnd) ((struct acr122_usb_data*)(pnd->driver_data)) typedef enum { UNKNOWN, ACR122, TOUCHATAG, } acr122_usb_model; struct acr122_usb_data { usb_dev_handle *pudh; acr122_usb_model model; uint32_t uiEndPointIn; uint32_t uiEndPointOut; uint32_t uiMaxPacketSize; volatile bool abort_flag; }; const struct pn53x_io acr122_usb_io; bool acr122_usb_get_usb_device_name (struct usb_device *dev, usb_dev_handle *udev, char *buffer, size_t len); int acr122_usb_init (nfc_device *pnd); int acr122_usb_bulk_read (struct acr122_usb_data *data, uint8_t abtRx[], const size_t szRx, const int timeout) { int res = usb_bulk_read (data->pudh, data->uiEndPointIn, (char *) abtRx, szRx, timeout); if (res > 0) { LOG_HEX ("RX", abtRx, res); } else if (res < 0) { if (res != -USB_TIMEDOUT) log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to read from USB (%s)", _usb_strerror (res)); } return res; } int acr122_usb_bulk_write (struct acr122_usb_data *data, uint8_t abtTx[], const size_t szTx, const int timeout) { LOG_HEX ("TX", abtTx, szTx); int res = usb_bulk_write (data->pudh, data->uiEndPointOut, (char *) abtTx, szTx, timeout); if (res > 0) { // HACK This little hack is a well know problem of USB, see http://www.libusb.org/ticket/6 for more details if ((res % data->uiMaxPacketSize) == 0) { usb_bulk_write (data->pudh, data->uiEndPointOut, "\0", 0, timeout); } } else { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to write to USB (%s)", _usb_strerror (res)); } return res; } struct acr122_usb_supported_device { uint16_t vendor_id; uint16_t product_id; acr122_usb_model model; const char *name; }; const struct acr122_usb_supported_device acr122_usb_supported_devices[] = { { 0x072F, 0x2200, ACR122, "ACS ACR122" }, { 0x072F, 0x90CC, TOUCHATAG, "Touchatag" }, }; acr122_usb_model acr122_usb_get_device_model (uint16_t vendor_id, uint16_t product_id) { for (size_t n = 0; n < sizeof (acr122_usb_supported_devices) / sizeof (struct acr122_usb_supported_device); n++) { if ((vendor_id == acr122_usb_supported_devices[n].vendor_id) && (product_id == acr122_usb_supported_devices[n].product_id)) return acr122_usb_supported_devices[n].model; } return UNKNOWN; } int acr122_usb_ack (nfc_device *pnd); // Find transfer endpoints for bulk transfers void acr122_usb_get_end_points (struct usb_device *dev, struct acr122_usb_data *data) { uint32_t uiIndex; uint32_t uiEndPoint; struct usb_interface_descriptor *puid = dev->config->interface->altsetting; // 3 Endpoints maximum: Interrupt In, Bulk In, Bulk Out for (uiIndex = 0; uiIndex < puid->bNumEndpoints; uiIndex++) { // Only accept bulk transfer endpoints (ignore interrupt endpoints) if (puid->endpoint[uiIndex].bmAttributes != USB_ENDPOINT_TYPE_BULK) continue; // Copy the endpoint to a local var, makes it more readable code uiEndPoint = puid->endpoint[uiIndex].bEndpointAddress; // Test if we dealing with a bulk IN endpoint if ((uiEndPoint & USB_ENDPOINT_DIR_MASK) == USB_ENDPOINT_IN) { data->uiEndPointIn = uiEndPoint; data->uiMaxPacketSize = puid->endpoint[uiIndex].wMaxPacketSize; } // Test if we dealing with a bulk OUT endpoint if ((uiEndPoint & USB_ENDPOINT_DIR_MASK) == USB_ENDPOINT_OUT) { data->uiEndPointOut = uiEndPoint; data->uiMaxPacketSize = puid->endpoint[uiIndex].wMaxPacketSize; } } } bool acr122_usb_probe (nfc_connstring connstrings[], size_t connstrings_len, size_t *pszDeviceFound) { usb_init (); int res; // usb_find_busses will find all of the busses on the system. Returns the // number of changes since previous call to this function (total of new // busses and busses removed). if ((res = usb_find_busses () < 0)) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to find USB busses (%s)", _usb_strerror (res)); return false; } // usb_find_devices will find all of the devices on each bus. This should be // called after usb_find_busses. Returns the number of changes since the // previous call to this function (total of new device and devices removed). if ((res = usb_find_devices () < 0)) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to find USB devices (%s)", _usb_strerror (res)); return false; } *pszDeviceFound = 0; uint32_t uiBusIndex = 0; struct usb_bus *bus; for (bus = usb_get_busses (); bus; bus = bus->next) { struct usb_device *dev; for (dev = bus->devices; dev; dev = dev->next, uiBusIndex++) { for (size_t n = 0; n < sizeof (acr122_usb_supported_devices) / sizeof (struct acr122_usb_supported_device); n++) { if ((acr122_usb_supported_devices[n].vendor_id == dev->descriptor.idVendor) && (acr122_usb_supported_devices[n].product_id == dev->descriptor.idProduct)) { // Make sure there are 2 endpoints available // with libusb-win32 we got some null pointers so be robust before looking at endpoints: if (dev->config == NULL || dev->config->interface == NULL || dev->config->interface->altsetting == NULL) { // Nope, we maybe want the next one, let's try to find another continue; } if (dev->config->interface->altsetting->bNumEndpoints < 2) { // Nope, we maybe want the next one, let's try to find another continue; } usb_dev_handle *udev = usb_open (dev); // Set configuration int res = usb_set_configuration (udev, 1); if (res < 0) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to set USB configuration (%s)", _usb_strerror (res)); usb_close (udev); // we failed to use the device continue; } // acr122_usb_get_usb_device_name (dev, udev, pnddDevices[*pszDeviceFound].acDevice, sizeof (pnddDevices[*pszDeviceFound].acDevice)); log_put (LOG_CATEGORY, NFC_PRIORITY_TRACE, "device found: Bus %s Device %s", bus->dirname, dev->filename); usb_close (udev); snprintf (connstrings[*pszDeviceFound], sizeof(nfc_connstring), "%s:%s:%s", PN53X_USB_DRIVER_NAME, bus->dirname, dev->filename); (*pszDeviceFound)++; // Test if we reach the maximum "wanted" devices if ((*pszDeviceFound) == connstrings_len) { return true; } } } } } return true; } struct acr122_usb_descriptor { uint16_t bus; uint16_t dev; }; int acr122_usb_connstring_decode (const nfc_connstring connstring, struct acr122_usb_descriptor *desc) { char *cs = malloc (strlen (connstring) + 1); if (!cs) { perror ("malloc"); return -1; } strcpy (cs, connstring); const char *driver_name = strtok (cs, ":"); if (!driver_name) { // Parse error free (cs); return -1; } if (0 != strcmp (driver_name, PN53X_USB_DRIVER_NAME)) { // Driver name does not match. free (cs); return 0; } const char *bus_s = strtok (NULL, ":"); if (!bus_s) { // bus not specified (or parsing error) free (cs); return 1; } unsigned int bus; if (sscanf (bus_s, "%u", &bus) != 1) { // bus_s is not a number free (cs); return 1; } desc->bus = bus; const char *dev_s = strtok (NULL, ":"); if (!dev_s) { // dev not specified (or parsing error) free (cs); return 2; } unsigned int dev; if (sscanf (dev_s, "%u", &dev) != 1) { // dev_s is not a number free (cs); return 2; } desc->dev = dev; free (cs); return 3; } bool acr122_usb_get_usb_device_name (struct usb_device *dev, usb_dev_handle *udev, char *buffer, size_t len) { *buffer = '\0'; if (dev->descriptor.iManufacturer || dev->descriptor.iProduct) { if (udev) { usb_get_string_simple (udev, dev->descriptor.iManufacturer, buffer, len); if (strlen (buffer) > 0) strcpy (buffer + strlen (buffer), " / "); usb_get_string_simple (udev, dev->descriptor.iProduct, buffer + strlen (buffer), len - strlen (buffer)); } } if (!*buffer) { for (size_t n = 0; n < sizeof (acr122_usb_supported_devices) / sizeof (struct acr122_usb_supported_device); n++) { if ((acr122_usb_supported_devices[n].vendor_id == dev->descriptor.idVendor) && (acr122_usb_supported_devices[n].product_id == dev->descriptor.idProduct)) { strncpy (buffer, acr122_usb_supported_devices[n].name, len); return true; } } } return false; } nfc_device * acr122_usb_open (const nfc_connstring connstring) { struct acr122_usb_descriptor desc; int connstring_decode_level = acr122_usb_connstring_decode (connstring, &desc); log_put (LOG_CATEGORY, NFC_PRIORITY_TRACE, "%d element(s) have been decoded from \"%s\"", connstring_decode_level, connstring); if (connstring_decode_level < 1) { return NULL; } nfc_device *pnd = NULL; struct acr122_usb_data data = { .pudh = NULL, .uiEndPointIn = 0, .uiEndPointOut = 0, }; struct usb_bus *bus; struct usb_device *dev; usb_init (); for (bus = usb_get_busses (); bus; bus = bus->next) { if (connstring_decode_level > 1) { // A specific bus have been specified unsigned int bus_current; sscanf (bus->dirname, "%u", &bus_current); if (bus_current != desc.bus) continue; } for (dev = bus->devices; dev; dev = dev->next) { if (connstring_decode_level > 2) { // A specific dev have been specified unsigned int dev_current; sscanf (dev->filename, "%u", &dev_current); if (dev_current != desc.dev) continue; } // Open the USB device data.pudh = usb_open (dev); // Retrieve end points acr122_usb_get_end_points (dev, &data); // Set configuration int res = usb_set_configuration (data.pudh, 1); if (res < 0) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to set USB configuration (%s)", _usb_strerror (res)); if (EPERM == -res) { log_put (LOG_CATEGORY, NFC_PRIORITY_WARN, "Please double check USB permissions for device %04x:%04x", dev->descriptor.idVendor, dev->descriptor.idProduct); } usb_close (data.pudh); // we failed to use the specified device return NULL; } res = usb_claim_interface (data.pudh, 0); if (res < 0) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to claim USB interface (%s)", _usb_strerror (res)); usb_close (data.pudh); // we failed to use the specified device return NULL; } data.model = acr122_usb_get_device_model (dev->descriptor.idVendor, dev->descriptor.idProduct); // Allocate memory for the device info and specification, fill it and return the info pnd = nfc_device_new (connstring); acr122_usb_get_usb_device_name (dev, data.pudh, pnd->name, sizeof (pnd->name)); pnd->driver_data = malloc(sizeof(struct acr122_usb_data)); *DRIVER_DATA (pnd) = data; // Alloc and init chip's data pn53x_data_new (pnd, &acr122_usb_io); switch (DRIVER_DATA (pnd)->model) { // empirical tuning case ACR122: CHIP_DATA (pnd)->timer_correction = 46; break; case TOUCHATAG: CHIP_DATA (pnd)->timer_correction = 50; break; default: break; } pnd->driver = &acr122_usb_driver; // HACK1: Send first an ACK as Abort command, to reset chip before talking to it: acr122_usb_ack (pnd); // HACK2: Then send a GetFirmware command to resync USB toggle bit between host & device // in case host used set_configuration and expects the device to have reset its toggle bit, which PN53x doesn't do if (acr122_usb_init (pnd) < 0) { usb_close (data.pudh); goto error; } DRIVER_DATA (pnd)->abort_flag = false; return pnd; } } // We ran out of devices before the index required return NULL; error: // Free allocated structure on error. nfc_device_free (pnd); return NULL; } void acr122_usb_close (nfc_device *pnd) { acr122_usb_ack (pnd); pn53x_idle (pnd); int res; if ((res = usb_release_interface (DRIVER_DATA (pnd)->pudh, 0)) < 0) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to release USB interface (%s)", _usb_strerror (res)); } if ((res = usb_close (DRIVER_DATA (pnd)->pudh)) < 0) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to close USB connection (%s)", _usb_strerror (res)); } pn53x_data_free (pnd); nfc_device_free (pnd); } #define PN53X_USB_BUFFER_LEN (PN53x_EXTENDED_FRAME__DATA_MAX_LEN + PN53x_EXTENDED_FRAME__OVERHEAD) int acr122_usb_send (nfc_device *pnd, const uint8_t *pbtData, const size_t szData, const int timeout) { uint8_t abtFrame[PN53X_USB_BUFFER_LEN] = { 0x00, 0x00, 0xff }; // Every packet must start with "00 00 ff" size_t szFrame = 0; pn53x_build_frame (abtFrame, &szFrame, pbtData, szData); int res = acr122_usb_bulk_write (DRIVER_DATA (pnd), abtFrame, szFrame, timeout); if (res < 0) { pnd->last_error = NFC_EIO; return pnd->last_error; } uint8_t abtRxBuf[PN53X_USB_BUFFER_LEN]; res = acr122_usb_bulk_read (DRIVER_DATA (pnd), abtRxBuf, sizeof (abtRxBuf), timeout); if (res < 0) { pnd->last_error = NFC_EIO; // try to interrupt current device state acr122_usb_ack(pnd); return pnd->last_error; } if (pn53x_check_ack_frame (pnd, abtRxBuf, res) == 0) { // The PN53x is running the sent command } else { // For some reasons (eg. send another command while a previous one is // running), the PN533 sometimes directly replies the response packet // instead of ACK frame, so we send a NACK frame to force PN533 to resend // response packet. With this hack, the nextly executed function (ie. // acr122_usb_receive()) will be able to retreive the correct response // packet. // FIXME Sony reader is also affected by this bug but NACK is not supported int res = acr122_usb_bulk_write (DRIVER_DATA (pnd), (uint8_t *)pn53x_nack_frame, sizeof(pn53x_nack_frame), timeout); if (res < 0) { pnd->last_error = NFC_EIO; // try to interrupt current device state acr122_usb_ack(pnd); return pnd->last_error; } } return NFC_SUCCESS; } #define USB_TIMEOUT_PER_PASS 200 int acr122_usb_receive (nfc_device *pnd, uint8_t *pbtData, const size_t szDataLen, const int timeout) { size_t len; off_t offset = 0; uint8_t abtRxBuf[PN53X_USB_BUFFER_LEN]; int res; /* * If no timeout is specified but the command is blocking, force a 200ms (USB_TIMEOUT_PER_PASS) * timeout to allow breaking the loop if the user wants to stop it. */ int usb_timeout; int remaining_time = timeout; read: if (timeout == USB_INFINITE_TIMEOUT) { usb_timeout = USB_TIMEOUT_PER_PASS; } else { // A user-provided timeout is set, we have to cut it in multiple chunk to be able to keep an nfc_abort_command() mecanism remaining_time -= USB_TIMEOUT_PER_PASS; if (remaining_time <= 0) { pnd->last_error = NFC_ETIMEOUT; return pnd->last_error; } else { usb_timeout = MIN(remaining_time, USB_TIMEOUT_PER_PASS); } } res = acr122_usb_bulk_read (DRIVER_DATA (pnd), abtRxBuf, sizeof (abtRxBuf), usb_timeout); if (res == -USB_TIMEDOUT) { if (DRIVER_DATA (pnd)->abort_flag) { DRIVER_DATA (pnd)->abort_flag = false; acr122_usb_ack (pnd); pnd->last_error = NFC_EOPABORTED; return pnd->last_error; } else { goto read; } } if (res < 0) { pnd->last_error = NFC_EIO; // try to interrupt current device state acr122_usb_ack(pnd); return pnd->last_error; } const uint8_t pn53x_preamble[3] = { 0x00, 0x00, 0xff }; if (0 != (memcmp (abtRxBuf, pn53x_preamble, 3))) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Frame preamble+start code mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } offset += 3; if ((0x01 == abtRxBuf[offset]) && (0xff == abtRxBuf[offset + 1])) { // Error frame log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Application level error detected"); pnd->last_error = NFC_EIO; return pnd->last_error; } else if ((0xff == abtRxBuf[offset]) && (0xff == abtRxBuf[offset + 1])) { // Extended frame offset += 2; // (abtRxBuf[offset] << 8) + abtRxBuf[offset + 1] (LEN) include TFI + (CC+1) len = (abtRxBuf[offset] << 8) + abtRxBuf[offset + 1] - 2; if (((abtRxBuf[offset] + abtRxBuf[offset + 1] + abtRxBuf[offset + 2]) % 256) != 0) { // TODO: Retry log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Length checksum mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } offset += 3; } else { // Normal frame if (256 != (abtRxBuf[offset] + abtRxBuf[offset + 1])) { // TODO: Retry log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Length checksum mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } // abtRxBuf[3] (LEN) include TFI + (CC+1) len = abtRxBuf[offset] - 2; offset += 2; } if (len > szDataLen) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "Unable to receive data: buffer too small. (szDataLen: %zu, len: %zu)", szDataLen, len); pnd->last_error = NFC_EIO; return pnd->last_error; } // TFI + PD0 (CC+1) if (abtRxBuf[offset] != 0xD5) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "TFI Mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } offset += 1; if (abtRxBuf[offset] != CHIP_DATA (pnd)->last_command + 1) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Command Code verification failed"); pnd->last_error = NFC_EIO; return pnd->last_error; } offset += 1; memcpy (pbtData, abtRxBuf + offset, len); offset += len; uint8_t btDCS = (256 - 0xD5); btDCS -= CHIP_DATA (pnd)->last_command + 1; for (size_t szPos = 0; szPos < len; szPos++) { btDCS -= pbtData[szPos]; } if (btDCS != abtRxBuf[offset]) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Data checksum mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } offset += 1; if (0x00 != abtRxBuf[offset]) { log_put (LOG_CATEGORY, NFC_PRIORITY_ERROR, "%s", "Frame postamble mismatch"); pnd->last_error = NFC_EIO; return pnd->last_error; } // The PN53x command is done and we successfully received the reply pnd->last_error = 0; return len; } int acr122_usb_ack (nfc_device *pnd) { return acr122_usb_bulk_write (DRIVER_DATA (pnd), (uint8_t *) pn53x_ack_frame, sizeof (pn53x_ack_frame), 1000); } int acr122_usb_init (nfc_device *pnd) { int res = 0; // Sometimes PN53x USB doesn't reply ACK one the first frame, so we need to send a dummy one... const uint8_t abtCmd[] = { GetFirmwareVersion }; pn53x_transceive (pnd, abtCmd, sizeof (abtCmd), NULL, 0, -1); // ...and we don't care about error pnd->last_error = 0; if ((res = pn53x_init (pnd)) < 0) return res; return NFC_SUCCESS; } int acr122_usb_abort_command (nfc_device *pnd) { DRIVER_DATA (pnd)->abort_flag = true; return NFC_SUCCESS; } const struct pn53x_io acr122_usb_io = { .send = acr122_usb_send, .receive = acr122_usb_receive, }; const struct nfc_driver acr122_usb_driver = { .name = PN53X_USB_DRIVER_NAME, .probe = acr122_usb_probe, .open = acr122_usb_open, .close = acr122_usb_close, .strerror = pn53x_strerror, .initiator_init = pn53x_initiator_init, .initiator_select_passive_target = pn53x_initiator_select_passive_target, .initiator_poll_target = pn53x_initiator_poll_target, .initiator_select_dep_target = pn53x_initiator_select_dep_target, .initiator_deselect_target = pn53x_initiator_deselect_target, .initiator_transceive_bytes = pn53x_initiator_transceive_bytes, .initiator_transceive_bits = pn53x_initiator_transceive_bits, .initiator_transceive_bytes_timed = pn53x_initiator_transceive_bytes_timed, .initiator_transceive_bits_timed = pn53x_initiator_transceive_bits_timed, .target_init = pn53x_target_init, .target_send_bytes = pn53x_target_send_bytes, .target_receive_bytes = pn53x_target_receive_bytes, .target_send_bits = pn53x_target_send_bits, .target_receive_bits = pn53x_target_receive_bits, .device_set_property_bool = pn53x_set_property_bool, .device_set_property_int = pn53x_set_property_int, .abort_command = acr122_usb_abort_command, .idle = pn53x_idle, };