drivers/nfc/pn544_hci.c

   1 /*
   2  * HCI based Driver for NXP PN544 NFC Chip
   3  *
   4  * Copyright (C) 2012  Intel Corporation. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the
  17  * Free Software Foundation, Inc.,
  18  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #include <linux/crc-ccitt.h>
  22 #include <linux/module.h>
  23 #include <linux/delay.h>
  24 #include <linux/slab.h>
  25 #include <linux/miscdevice.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/gpio.h>
  28 #include <linux/i2c.h>
  29
  30 #include <linux/nfc.h>
  31 #include <net/nfc/hci.h>
  32 #include <net/nfc/llc.h>
  33
  34 #include <linux/nfc/pn544.h>
  35
  36 #define DRIVER_DESC "HCI NFC driver for PN544"
  37
  38 #define PN544_HCI_DRIVER_NAME "pn544_hci"
  39
  40 /* Timing restrictions (ms) */
  41 #define PN544_HCI_RESETVEN_TIME         30
  42
  43 static struct i2c_device_id pn544_hci_id_table[] = {
  44         {"pn544", 0},
  45         {}
  46 };
  47
  48 MODULE_DEVICE_TABLE(i2c, pn544_hci_id_table);
  49
  50 #define HCI_MODE 0
  51 #define FW_MODE 1
  52
  53 /* framing in HCI mode */
  54 #define PN544_HCI_LLC_LEN               1
  55 #define PN544_HCI_LLC_CRC               2
  56 #define PN544_HCI_LLC_LEN_CRC           (PN544_HCI_LLC_LEN + PN544_HCI_LLC_CRC)
  57 #define PN544_HCI_LLC_MIN_SIZE          (1 + PN544_HCI_LLC_LEN_CRC)
  58 #define PN544_HCI_LLC_MAX_PAYLOAD       29
  59 #define PN544_HCI_LLC_MAX_SIZE          (PN544_HCI_LLC_LEN_CRC + 1 + \
  60                                          PN544_HCI_LLC_MAX_PAYLOAD)
  61
  62 enum pn544_state {
  63         PN544_ST_COLD,
  64         PN544_ST_FW_READY,
  65         PN544_ST_READY,
  66 };
  67
  68 #define FULL_VERSION_LEN 11
  69
  70 /* Proprietary commands */
  71 #define PN544_WRITE             0x3f
  72
  73 /* Proprietary gates, events, commands and registers */
  74
  75 /* NFC_HCI_RF_READER_A_GATE additional registers and commands */
  76 #define PN544_RF_READER_A_AUTO_ACTIVATION                       0x10
  77 #define PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION               0x12
  78 #define PN544_MIFARE_CMD                                        0x21
  79
  80 /* Commands that apply to all RF readers */
  81 #define PN544_RF_READER_CMD_PRESENCE_CHECK      0x30
  82 #define PN544_RF_READER_CMD_ACTIVATE_NEXT       0x32
  83
  84 /* NFC_HCI_ID_MGMT_GATE additional registers */
  85 #define PN544_ID_MGMT_FULL_VERSION_SW           0x10
  86
  87 #define PN544_RF_READER_ISO15693_GATE           0x12
  88
  89 #define PN544_RF_READER_F_GATE                  0x14
  90 #define PN544_FELICA_ID                         0x04
  91 #define PN544_FELICA_RAW                        0x20
  92
  93 #define PN544_RF_READER_JEWEL_GATE              0x15
  94 #define PN544_JEWEL_RAW_CMD                     0x23
  95
  96 #define PN544_RF_READER_NFCIP1_INITIATOR_GATE   0x30
  97 #define PN544_RF_READER_NFCIP1_TARGET_GATE      0x31
  98
  99 #define PN544_SYS_MGMT_GATE                     0x90
 100 #define PN544_SYS_MGMT_INFO_NOTIFICATION        0x02
 101
 102 #define PN544_POLLING_LOOP_MGMT_GATE            0x94
 103 #define PN544_PL_RDPHASES                       0x06
 104 #define PN544_PL_EMULATION                      0x07
 105 #define PN544_PL_NFCT_DEACTIVATED               0x09
 106
 107 #define PN544_SWP_MGMT_GATE                     0xA0
 108
 109 #define PN544_NFC_WI_MGMT_GATE                  0xA1
 110
 111 static struct nfc_hci_gate pn544_gates[] = {
 112         {NFC_HCI_ADMIN_GATE, NFC_HCI_INVALID_PIPE},
 113         {NFC_HCI_LOOPBACK_GATE, NFC_HCI_INVALID_PIPE},
 114         {NFC_HCI_ID_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 115         {NFC_HCI_LINK_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 116         {NFC_HCI_RF_READER_B_GATE, NFC_HCI_INVALID_PIPE},
 117         {NFC_HCI_RF_READER_A_GATE, NFC_HCI_INVALID_PIPE},
 118         {PN544_SYS_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 119         {PN544_SWP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 120         {PN544_POLLING_LOOP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 121         {PN544_NFC_WI_MGMT_GATE, NFC_HCI_INVALID_PIPE},
 122         {PN544_RF_READER_F_GATE, NFC_HCI_INVALID_PIPE},
 123         {PN544_RF_READER_JEWEL_GATE, NFC_HCI_INVALID_PIPE},
 124         {PN544_RF_READER_ISO15693_GATE, NFC_HCI_INVALID_PIPE},
 125         {PN544_RF_READER_NFCIP1_INITIATOR_GATE, NFC_HCI_INVALID_PIPE},
 126         {PN544_RF_READER_NFCIP1_TARGET_GATE, NFC_HCI_INVALID_PIPE}
 127 };
 128
 129 /* Largest headroom needed for outgoing custom commands */
 130 #define PN544_CMDS_HEADROOM     2
 131 #define PN544_FRAME_HEADROOM 1
 132 #define PN544_FRAME_TAILROOM 2
 133
 134 struct pn544_hci_info {
 135         struct i2c_client *i2c_dev;
 136         struct nfc_hci_dev *hdev;
 137
 138         enum pn544_state state;
 139
 140         struct mutex info_lock;
 141
 142         unsigned int gpio_en;
 143         unsigned int gpio_irq;
 144         unsigned int gpio_fw;
 145         unsigned int en_polarity;
 146
 147         int hard_fault;         /*
 148                                  * < 0 if hardware error occured (e.g. i2c err)
 149                                  * and prevents normal operation.
 150                                  */
 151         int async_cb_type;
 152         data_exchange_cb_t async_cb;
 153         void *async_cb_context;
 154 };
 155
 156 static void pn544_hci_platform_init(struct pn544_hci_info *info)
 157 {
 158         int polarity, retry, ret;
 159         char rset_cmd[] = { 0x05, 0xF9, 0x04, 0x00, 0xC3, 0xE5 };
 160         int count = sizeof(rset_cmd);
 161
 162         pr_info(DRIVER_DESC ": %s\n", __func__);
 163         dev_info(&info->i2c_dev->dev, "Detecting nfc_en polarity\n");
 164
 165         /* Disable fw download */
 166         gpio_set_value(info->gpio_fw, 0);
 167
 168         for (polarity = 0; polarity < 2; polarity++) {
 169                 info->en_polarity = polarity;
 170                 retry = 3;
 171                 while (retry--) {
 172                         /* power off */
 173                         gpio_set_value(info->gpio_en, !info->en_polarity);
 174                         usleep_range(10000, 15000);
 175
 176                         /* power on */
 177                         gpio_set_value(info->gpio_en, info->en_polarity);
 178                         usleep_range(10000, 15000);
 179
 180                         /* send reset */
 181                         dev_dbg(&info->i2c_dev->dev, "Sending reset cmd\n");
 182                         ret = i2c_master_send(info->i2c_dev, rset_cmd, count);
 183                         if (ret == count) {
 184                                 dev_info(&info->i2c_dev->dev,
 185                                          "nfc_en polarity : active %s\n",
 186                                          (polarity == 0 ? "low" : "high"));
 187                                 goto out;
 188                         }
 189                 }
 190         }
 191
 192         dev_err(&info->i2c_dev->dev,
 193                 "Could not detect nfc_en polarity, fallback to active high\n");
 194
 195 out:
 196         gpio_set_value(info->gpio_en, !info->en_polarity);
 197 }
 198
 199 static int pn544_hci_enable(struct pn544_hci_info *info, int mode)
 200 {
 201         pr_info(DRIVER_DESC ": %s\n", __func__);
 202
 203         gpio_set_value(info->gpio_fw, 0);
 204         gpio_set_value(info->gpio_en, info->en_polarity);
 205         usleep_range(10000, 15000);
 206
 207         return 0;
 208 }
 209
 210 static void pn544_hci_disable(struct pn544_hci_info *info)
 211 {
 212         pr_info(DRIVER_DESC ": %s\n", __func__);
 213
 214         gpio_set_value(info->gpio_fw, 0);
 215         gpio_set_value(info->gpio_en, !info->en_polarity);
 216         usleep_range(10000, 15000);
 217
 218         gpio_set_value(info->gpio_en, info->en_polarity);
 219         usleep_range(10000, 15000);
 220
 221         gpio_set_value(info->gpio_en, !info->en_polarity);
 222         usleep_range(10000, 15000);
 223 }
 224
 225 static int pn544_hci_i2c_write(struct i2c_client *client, u8 *buf, int len)
 226 {
 227         int r;
 228
 229         usleep_range(3000, 6000);
 230
 231         r = i2c_master_send(client, buf, len);
 232
 233         if (r == -EREMOTEIO) {  /* Retry, chip was in standby */
 234                 usleep_range(6000, 10000);
 235                 r = i2c_master_send(client, buf, len);
 236         }
 237
 238         if (r >= 0 && r != len)
 239                 r = -EREMOTEIO;
 240
 241         return r;
 242 }
 243
 244 static int check_crc(u8 *buf, int buflen)
 245 {
 246         int len;
 247         u16 crc;
 248
 249         len = buf[0] + 1;
 250         crc = crc_ccitt(0xffff, buf, len - 2);
 251         crc = ~crc;
 252
 253         if (buf[len - 2] != (crc & 0xff) || buf[len - 1] != (crc >> 8)) {
 254                 pr_err(PN544_HCI_DRIVER_NAME ": CRC error 0x%x != 0x%x 0x%x\n",
 255                        crc, buf[len - 1], buf[len - 2]);
 256
 257                 pr_info(DRIVER_DESC ": %s : BAD CRC\n", __func__);
 258                 print_hex_dump(KERN_DEBUG, "crc: ", DUMP_PREFIX_NONE,
 259                                16, 2, buf, buflen, false);
 260                 return -EPERM;
 261         }
 262         return 0;
 263 }
 264
 265 /*
 266  * Reads an shdlc frame and returns it in a newly allocated sk_buff. Guarantees
 267  * that i2c bus will be flushed and that next read will start on a new frame.
 268  * returned skb contains only LLC header and payload.
 269  * returns:
 270  * -EREMOTEIO : i2c read error (fatal)
 271  * -EBADMSG : frame was incorrect and discarded
 272  * -ENOMEM : cannot allocate skb, frame dropped
 273  */
 274 static int pn544_hci_i2c_read(struct i2c_client *client, struct sk_buff **skb)
 275 {
 276         int r;
 277         u8 len;
 278         u8 tmp[PN544_HCI_LLC_MAX_SIZE - 1];
 279
 280         r = i2c_master_recv(client, &len, 1);
 281         if (r != 1) {
 282                 dev_err(&client->dev, "cannot read len byte\n");
 283                 return -EREMOTEIO;
 284         }
 285
 286         if ((len < (PN544_HCI_LLC_MIN_SIZE - 1)) ||
 287             (len > (PN544_HCI_LLC_MAX_SIZE - 1))) {
 288                 dev_err(&client->dev, "invalid len byte\n");
 289                 r = -EBADMSG;
 290                 goto flush;
 291         }
 292
 293         *skb = alloc_skb(1 + len, GFP_KERNEL);
 294         if (*skb == NULL) {
 295                 r = -ENOMEM;
 296                 goto flush;
 297         }
 298
 299         *skb_put(*skb, 1) = len;
 300
 301         r = i2c_master_recv(client, skb_put(*skb, len), len);
 302         if (r != len) {
 303                 kfree_skb(*skb);
 304                 return -EREMOTEIO;
 305         }
 306
 307         r = check_crc((*skb)->data, (*skb)->len);
 308         if (r != 0) {
 309                 kfree_skb(*skb);
 310                 r = -EBADMSG;
 311                 goto flush;
 312         }
 313
 314         skb_pull(*skb, 1);
 315         skb_trim(*skb, (*skb)->len - 2);
 316
 317         usleep_range(3000, 6000);
 318
 319         return 0;
 320
 321 flush:
 322         if (i2c_master_recv(client, tmp, sizeof(tmp)) < 0)
 323                 r = -EREMOTEIO;
 324
 325         usleep_range(3000, 6000);
 326
 327         return r;
 328 }
 329
 330 /*
 331  * Reads an shdlc frame from the chip. This is not as straightforward as it
 332  * seems. There are cases where we could loose the frame start synchronization.
 333  * The frame format is len-data-crc, and corruption can occur anywhere while
 334  * transiting on i2c bus, such that we could read an invalid len.
 335  * In order to recover synchronization with the next frame, we must be sure
 336  * to read the real amount of data without using the len byte. We do this by
 337  * assuming the following:
 338  * - the chip will always present only one single complete frame on the bus
 339  *   before triggering the interrupt
 340  * - the chip will not present a new frame until we have completely read
 341  *   the previous one (or until we have handled the interrupt).
 342  * The tricky case is when we read a corrupted len that is less than the real
 343  * len. We must detect this here in order to determine that we need to flush
 344  * the bus. This is the reason why we check the crc here.
 345  */
 346 static irqreturn_t pn544_hci_irq_thread_fn(int irq, void *dev_id)
 347 {
 348         struct pn544_hci_info *info = dev_id;
 349         struct i2c_client *client;
 350         struct sk_buff *skb = NULL;
 351         int r;
 352
 353         if (!info || irq != info->i2c_dev->irq) {
 354                 WARN_ON_ONCE(1);
 355                 return IRQ_NONE;
 356         }
 357
 358         client = info->i2c_dev;
 359         dev_dbg(&client->dev, "IRQ\n");
 360
 361         if (info->hard_fault != 0)
 362                 return IRQ_HANDLED;
 363
 364         r = pn544_hci_i2c_read(client, &skb);
 365         if (r == -EREMOTEIO) {
 366                 info->hard_fault = r;
 367
 368                 nfc_hci_recv_frame(info->hdev, NULL);
 369
 370                 return IRQ_HANDLED;
 371         } else if ((r == -ENOMEM) || (r == -EBADMSG)) {
 372                 return IRQ_HANDLED;
 373         }
 374
 375         nfc_hci_recv_frame(info->hdev, skb);
 376
 377         return IRQ_HANDLED;
 378 }
 379
 380 static int pn544_hci_open(struct nfc_hci_dev *hdev)
 381 {
 382         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 383         int r = 0;
 384
 385         mutex_lock(&info->info_lock);
 386
 387         if (info->state != PN544_ST_COLD) {
 388                 r = -EBUSY;
 389                 goto out;
 390         }
 391
 392         r = pn544_hci_enable(info, HCI_MODE);
 393
 394         if (r == 0)
 395                 info->state = PN544_ST_READY;
 396
 397 out:
 398         mutex_unlock(&info->info_lock);
 399         return r;
 400 }
 401
 402 static void pn544_hci_close(struct nfc_hci_dev *hdev)
 403 {
 404         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 405
 406         mutex_lock(&info->info_lock);
 407
 408         if (info->state == PN544_ST_COLD)
 409                 goto out;
 410
 411         pn544_hci_disable(info);
 412
 413         info->state = PN544_ST_COLD;
 414
 415 out:
 416         mutex_unlock(&info->info_lock);
 417 }
 418
 419 static int pn544_hci_ready(struct nfc_hci_dev *hdev)
 420 {
 421         struct sk_buff *skb;
 422         static struct hw_config {
 423                 u8 adr[2];
 424                 u8 value;
 425         } hw_config[] = {
 426                 {{0x9f, 0x9a}, 0x00},
 427
 428                 {{0x98, 0x10}, 0xbc},
 429
 430                 {{0x9e, 0x71}, 0x00},
 431
 432                 {{0x98, 0x09}, 0x00},
 433
 434                 {{0x9e, 0xb4}, 0x00},
 435
 436                 {{0x9e, 0xd9}, 0xff},
 437                 {{0x9e, 0xda}, 0xff},
 438                 {{0x9e, 0xdb}, 0x23},
 439                 {{0x9e, 0xdc}, 0x21},
 440                 {{0x9e, 0xdd}, 0x22},
 441                 {{0x9e, 0xde}, 0x24},
 442
 443                 {{0x9c, 0x01}, 0x08},
 444
 445                 {{0x9e, 0xaa}, 0x01},
 446
 447                 {{0x9b, 0xd1}, 0x0d},
 448                 {{0x9b, 0xd2}, 0x24},
 449                 {{0x9b, 0xd3}, 0x0a},
 450                 {{0x9b, 0xd4}, 0x22},
 451                 {{0x9b, 0xd5}, 0x08},
 452                 {{0x9b, 0xd6}, 0x1e},
 453                 {{0x9b, 0xdd}, 0x1c},
 454
 455                 {{0x9b, 0x84}, 0x13},
 456                 {{0x99, 0x81}, 0x7f},
 457                 {{0x99, 0x31}, 0x70},
 458
 459                 {{0x98, 0x00}, 0x3f},
 460
 461                 {{0x9f, 0x09}, 0x00},
 462
 463                 {{0x9f, 0x0a}, 0x05},
 464
 465                 {{0x9e, 0xd1}, 0xa1},
 466                 {{0x99, 0x23}, 0x00},
 467
 468                 {{0x9e, 0x74}, 0x80},
 469
 470                 {{0x9f, 0x28}, 0x10},
 471
 472                 {{0x9f, 0x35}, 0x14},
 473
 474                 {{0x9f, 0x36}, 0x60},
 475
 476                 {{0x9c, 0x31}, 0x00},
 477
 478                 {{0x9c, 0x32}, 0xc8},
 479
 480                 {{0x9c, 0x19}, 0x40},
 481
 482                 {{0x9c, 0x1a}, 0x40},
 483
 484                 {{0x9c, 0x0c}, 0x00},
 485
 486                 {{0x9c, 0x0d}, 0x00},
 487
 488                 {{0x9c, 0x12}, 0x00},
 489
 490                 {{0x9c, 0x13}, 0x00},
 491
 492                 {{0x98, 0xa2}, 0x0e},
 493
 494                 {{0x98, 0x93}, 0x40},
 495
 496                 {{0x98, 0x7d}, 0x02},
 497                 {{0x98, 0x7e}, 0x00},
 498                 {{0x9f, 0xc8}, 0x01},
 499         };
 500         struct hw_config *p = hw_config;
 501         int count = ARRAY_SIZE(hw_config);
 502         struct sk_buff *res_skb;
 503         u8 param[4];
 504         int r;
 505
 506         param[0] = 0;
 507         while (count--) {
 508                 param[1] = p->adr[0];
 509                 param[2] = p->adr[1];
 510                 param[3] = p->value;
 511
 512                 r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE, PN544_WRITE,
 513                                      param, 4, &res_skb);
 514                 if (r < 0)
 515                         return r;
 516
 517                 if (res_skb->len != 1) {
 518                         kfree_skb(res_skb);
 519                         return -EPROTO;
 520                 }
 521
 522                 if (res_skb->data[0] != p->value) {
 523                         kfree_skb(res_skb);
 524                         return -EIO;
 525                 }
 526
 527                 kfree_skb(res_skb);
 528
 529                 p++;
 530         }
 531
 532         param[0] = NFC_HCI_UICC_HOST_ID;
 533         r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
 534                               NFC_HCI_ADMIN_WHITELIST, param, 1);
 535         if (r < 0)
 536                 return r;
 537
 538         param[0] = 0x3d;
 539         r = nfc_hci_set_param(hdev, PN544_SYS_MGMT_GATE,
 540                               PN544_SYS_MGMT_INFO_NOTIFICATION, param, 1);
 541         if (r < 0)
 542                 return r;
 543
 544         param[0] = 0x0;
 545         r = nfc_hci_set_param(hdev, NFC_HCI_RF_READER_A_GATE,
 546                               PN544_RF_READER_A_AUTO_ACTIVATION, param, 1);
 547         if (r < 0)
 548                 return r;
 549
 550         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 551                                NFC_HCI_EVT_END_OPERATION, NULL, 0);
 552         if (r < 0)
 553                 return r;
 554
 555         param[0] = 0x1;
 556         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 557                               PN544_PL_NFCT_DEACTIVATED, param, 1);
 558         if (r < 0)
 559                 return r;
 560
 561         param[0] = 0x0;
 562         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 563                               PN544_PL_RDPHASES, param, 1);
 564         if (r < 0)
 565                 return r;
 566
 567         r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
 568                               PN544_ID_MGMT_FULL_VERSION_SW, &skb);
 569         if (r < 0)
 570                 return r;
 571
 572         if (skb->len != FULL_VERSION_LEN) {
 573                 kfree_skb(skb);
 574                 return -EINVAL;
 575         }
 576
 577         print_hex_dump(KERN_DEBUG, "FULL VERSION SOFTWARE INFO: ",
 578                        DUMP_PREFIX_NONE, 16, 1,
 579                        skb->data, FULL_VERSION_LEN, false);
 580
 581         kfree_skb(skb);
 582
 583         return 0;
 584 }
 585
 586 static void pn544_hci_add_len_crc(struct sk_buff *skb)
 587 {
 588         u16 crc;
 589         int len;
 590
 591         len = skb->len + 2;
 592         *skb_push(skb, 1) = len;
 593
 594         crc = crc_ccitt(0xffff, skb->data, skb->len);
 595         crc = ~crc;
 596         *skb_put(skb, 1) = crc & 0xff;
 597         *skb_put(skb, 1) = crc >> 8;
 598 }
 599
 600 static void pn544_hci_remove_len_crc(struct sk_buff *skb)
 601 {
 602         skb_pull(skb, PN544_FRAME_HEADROOM);
 603         skb_trim(skb, PN544_FRAME_TAILROOM);
 604 }
 605
 606 static int pn544_hci_xmit(struct nfc_hci_dev *hdev, struct sk_buff *skb)
 607 {
 608         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 609         struct i2c_client *client = info->i2c_dev;
 610         int r;
 611
 612         if (info->hard_fault != 0)
 613                 return info->hard_fault;
 614
 615         pn544_hci_add_len_crc(skb);
 616         r = pn544_hci_i2c_write(client, skb->data, skb->len);
 617         pn544_hci_remove_len_crc(skb);
 618
 619         return r;
 620 }
 621
 622 static int pn544_hci_start_poll(struct nfc_hci_dev *hdev,
 623                                 u32 im_protocols, u32 tm_protocols)
 624 {
 625         u8 phases = 0;
 626         int r;
 627         u8 duration[2];
 628         u8 activated;
 629
 630         pr_info(DRIVER_DESC ": %s protocols 0x%x 0x%x\n",
 631                 __func__, im_protocols, tm_protocols);
 632
 633         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 634                                NFC_HCI_EVT_END_OPERATION, NULL, 0);
 635         if (r < 0)
 636                 return r;
 637
 638         duration[0] = 0x18;
 639         duration[1] = 0x6a;
 640         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 641                               PN544_PL_EMULATION, duration, 2);
 642         if (r < 0)
 643                 return r;
 644
 645         activated = 0;
 646         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 647                               PN544_PL_NFCT_DEACTIVATED, &activated, 1);
 648         if (r < 0)
 649                 return r;
 650
 651         if (im_protocols & (NFC_PROTO_ISO14443_MASK | NFC_PROTO_MIFARE_MASK |
 652                          NFC_PROTO_JEWEL_MASK))
 653                 phases |= 1;            /* Type A */
 654         if (im_protocols & NFC_PROTO_FELICA_MASK) {
 655                 phases |= (1 << 2);     /* Type F 212 */
 656                 phases |= (1 << 3);     /* Type F 424 */
 657         }
 658
 659         phases |= (1 << 5);             /* NFC active */
 660
 661         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 662                               PN544_PL_RDPHASES, &phases, 1);
 663         if (r < 0)
 664                 return r;
 665
 666         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 667                                NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
 668         if (r < 0)
 669                 nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 670                                    NFC_HCI_EVT_END_OPERATION, NULL, 0);
 671
 672         return r;
 673 }
 674
 675 static int pn544_hci_target_from_gate(struct nfc_hci_dev *hdev, u8 gate,
 676                                       struct nfc_target *target)
 677 {
 678         switch (gate) {
 679         case PN544_RF_READER_F_GATE:
 680                 target->supported_protocols = NFC_PROTO_FELICA_MASK;
 681                 break;
 682         case PN544_RF_READER_JEWEL_GATE:
 683                 target->supported_protocols = NFC_PROTO_JEWEL_MASK;
 684                 target->sens_res = 0x0c00;
 685                 break;
 686         default:
 687                 return -EPROTO;
 688         }
 689
 690         return 0;
 691 }
 692
 693 static int pn544_hci_complete_target_discovered(struct nfc_hci_dev *hdev,
 694                                                 u8 gate,
 695                                                 struct nfc_target *target)
 696 {
 697         struct sk_buff *uid_skb;
 698         int r = 0;
 699
 700         if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
 701                 if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
 702                     target->nfcid1_len != 10)
 703                         return -EPROTO;
 704
 705                 r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
 706                                      PN544_RF_READER_CMD_ACTIVATE_NEXT,
 707                                      target->nfcid1, target->nfcid1_len, NULL);
 708         } else if (target->supported_protocols & NFC_PROTO_FELICA_MASK) {
 709                 r = nfc_hci_get_param(hdev, PN544_RF_READER_F_GATE,
 710                                       PN544_FELICA_ID, &uid_skb);
 711                 if (r < 0)
 712                         return r;
 713
 714                 if (uid_skb->len != 8) {
 715                         kfree_skb(uid_skb);
 716                         return -EPROTO;
 717                 }
 718
 719                 r = nfc_hci_send_cmd(hdev, PN544_RF_READER_F_GATE,
 720                                      PN544_RF_READER_CMD_ACTIVATE_NEXT,
 721                                      uid_skb->data, uid_skb->len, NULL);
 722                 kfree_skb(uid_skb);
 723         } else if (target->supported_protocols & NFC_PROTO_ISO14443_MASK) {
 724                 /*
 725                  * TODO: maybe other ISO 14443 require some kind of continue
 726                  * activation, but for now we've seen only this one below.
 727                  */
 728                 if (target->sens_res == 0x4403) /* Type 4 Mifare DESFire */
 729                         r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
 730                               PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION,
 731                               NULL, 0, NULL);
 732         }
 733
 734         return r;
 735 }
 736
 737 #define PN544_CB_TYPE_READER_F 1
 738
 739 static void pn544_hci_data_exchange_cb(void *context, struct sk_buff *skb,
 740                                        int err)
 741 {
 742         struct pn544_hci_info *info = context;
 743
 744         switch (info->async_cb_type) {
 745         case PN544_CB_TYPE_READER_F:
 746                 if (err == 0)
 747                         skb_pull(skb, 1);
 748                 info->async_cb(info->async_cb_context, skb, err);
 749                 break;
 750         default:
 751                 if (err == 0)
 752                         kfree_skb(skb);
 753                 break;
 754         }
 755 }
 756
 757 #define MIFARE_CMD_AUTH_KEY_A   0x60
 758 #define MIFARE_CMD_AUTH_KEY_B   0x61
 759 #define MIFARE_CMD_HEADER       2
 760 #define MIFARE_UID_LEN          4
 761 #define MIFARE_KEY_LEN          6
 762 #define MIFARE_CMD_LEN          12
 763 /*
 764  * Returns:
 765  * <= 0: driver handled the data exchange
 766  *    1: driver doesn't especially handle, please do standard processing
 767  */
 768 static int pn544_hci_data_exchange(struct nfc_hci_dev *hdev,
 769                                    struct nfc_target *target,
 770                                    struct sk_buff *skb, data_exchange_cb_t cb,
 771                                    void *cb_context)
 772 {
 773         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 774
 775         pr_info(DRIVER_DESC ": %s for gate=%d\n", __func__,
 776                 target->hci_reader_gate);
 777
 778         switch (target->hci_reader_gate) {
 779         case NFC_HCI_RF_READER_A_GATE:
 780                 if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
 781                         /*
 782                          * It seems that pn544 is inverting key and UID for
 783                          * MIFARE authentication commands.
 784                          */
 785                         if (skb->len == MIFARE_CMD_LEN &&
 786                             (skb->data[0] == MIFARE_CMD_AUTH_KEY_A ||
 787                              skb->data[0] == MIFARE_CMD_AUTH_KEY_B)) {
 788                                 u8 uid[MIFARE_UID_LEN];
 789                                 u8 *data = skb->data + MIFARE_CMD_HEADER;
 790
 791                                 memcpy(uid, data + MIFARE_KEY_LEN,
 792                                        MIFARE_UID_LEN);
 793                                 memmove(data + MIFARE_UID_LEN, data,
 794                                         MIFARE_KEY_LEN);
 795                                 memcpy(data, uid, MIFARE_UID_LEN);
 796                         }
 797
 798                         return nfc_hci_send_cmd_async(hdev,
 799                                                       target->hci_reader_gate,
 800                                                       PN544_MIFARE_CMD,
 801                                                       skb->data, skb->len,
 802                                                       cb, cb_context);
 803                 } else
 804                         return 1;
 805         case PN544_RF_READER_F_GATE:
 806                 *skb_push(skb, 1) = 0;
 807                 *skb_push(skb, 1) = 0;
 808
 809                 info->async_cb_type = PN544_CB_TYPE_READER_F;
 810                 info->async_cb = cb;
 811                 info->async_cb_context = cb_context;
 812
 813                 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
 814                                               PN544_FELICA_RAW, skb->data,
 815                                               skb->len,
 816                                               pn544_hci_data_exchange_cb, info);
 817         case PN544_RF_READER_JEWEL_GATE:
 818                 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
 819                                               PN544_JEWEL_RAW_CMD, skb->data,
 820                                               skb->len, cb, cb_context);
 821         default:
 822                 return 1;
 823         }
 824 }
 825
 826 static int pn544_hci_check_presence(struct nfc_hci_dev *hdev,
 827                                    struct nfc_target *target)
 828 {
 829         return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
 830                                 PN544_RF_READER_CMD_PRESENCE_CHECK,
 831                                 NULL, 0, NULL);
 832 }
 833
 834 static struct nfc_hci_ops pn544_hci_ops = {
 835         .open = pn544_hci_open,
 836         .close = pn544_hci_close,
 837         .hci_ready = pn544_hci_ready,
 838         .xmit = pn544_hci_xmit,
 839         .start_poll = pn544_hci_start_poll,
 840         .target_from_gate = pn544_hci_target_from_gate,
 841         .complete_target_discovered = pn544_hci_complete_target_discovered,
 842         .data_exchange = pn544_hci_data_exchange,
 843         .check_presence = pn544_hci_check_presence,
 844 };
 845
 846 static int __devinit pn544_hci_probe(struct i2c_client *client,
 847                                      const struct i2c_device_id *id)
 848 {
 849         struct pn544_hci_info *info;
 850         struct pn544_nfc_platform_data *pdata;
 851         int r = 0;
 852         u32 protocols;
 853         struct nfc_hci_init_data init_data;
 854
 855         dev_dbg(&client->dev, "%s\n", __func__);
 856         dev_dbg(&client->dev, "IRQ: %d\n", client->irq);
 857
 858         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
 859                 dev_err(&client->dev, "Need I2C_FUNC_I2C\n");
 860                 return -ENODEV;
 861         }
 862
 863         info = kzalloc(sizeof(struct pn544_hci_info), GFP_KERNEL);
 864         if (!info) {
 865                 dev_err(&client->dev,
 866                         "Cannot allocate memory for pn544_hci_info.\n");
 867                 r = -ENOMEM;
 868                 goto err_info_alloc;
 869         }
 870
 871         info->i2c_dev = client;
 872         info->state = PN544_ST_COLD;
 873         mutex_init(&info->info_lock);
 874         i2c_set_clientdata(client, info);
 875
 876         pdata = client->dev.platform_data;
 877         if (pdata == NULL) {
 878                 dev_err(&client->dev, "No platform data\n");
 879                 r = -EINVAL;
 880                 goto err_pdata;
 881         }
 882
 883         if (pdata->request_resources == NULL) {
 884                 dev_err(&client->dev, "request_resources() missing\n");
 885                 r = -EINVAL;
 886                 goto err_pdata;
 887         }
 888
 889         r = pdata->request_resources(client);
 890         if (r) {
 891                 dev_err(&client->dev, "Cannot get platform resources\n");
 892                 goto err_pdata;
 893         }
 894
 895         info->gpio_en = pdata->get_gpio(NFC_GPIO_ENABLE);
 896         info->gpio_fw = pdata->get_gpio(NFC_GPIO_FW_RESET);
 897         info->gpio_irq = pdata->get_gpio(NFC_GPIO_IRQ);
 898
 899         pn544_hci_platform_init(info);
 900
 901         r = request_threaded_irq(client->irq, NULL, pn544_hci_irq_thread_fn,
 902                                  IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 903                                  PN544_HCI_DRIVER_NAME, info);
 904         if (r < 0) {
 905                 dev_err(&client->dev, "Unable to register IRQ handler\n");
 906                 goto err_rti;
 907         }
 908
 909         init_data.gate_count = ARRAY_SIZE(pn544_gates);
 910
 911         memcpy(init_data.gates, pn544_gates, sizeof(pn544_gates));
 912
 913         /*
 914          * TODO: Session id must include the driver name + some bus addr
 915          * persistent info to discriminate 2 identical chips
 916          */
 917         strcpy(init_data.session_id, "ID544HCI");
 918
 919         protocols = NFC_PROTO_JEWEL_MASK |
 920                     NFC_PROTO_MIFARE_MASK |
 921                     NFC_PROTO_FELICA_MASK |
 922                     NFC_PROTO_ISO14443_MASK |
 923                     NFC_PROTO_ISO14443_B_MASK |
 924                     NFC_PROTO_NFC_DEP_MASK;
 925
 926         info->hdev = nfc_hci_allocate_device(&pn544_hci_ops, &init_data,
 927                                              protocols, LLC_SHDLC_NAME,
 928                                              PN544_FRAME_HEADROOM +
 929                                              PN544_CMDS_HEADROOM,
 930                                              PN544_FRAME_TAILROOM,
 931                                              PN544_HCI_LLC_MAX_PAYLOAD);
 932         if (!info->hdev) {
 933                 dev_err(&client->dev, "Cannot allocate nfc hdev.\n");
 934                 r = -ENOMEM;
 935                 goto err_alloc_hdev;
 936         }
 937
 938         nfc_hci_set_clientdata(info->hdev, info);
 939
 940         r = nfc_hci_register_device(info->hdev);
 941         if (r)
 942                 goto err_regdev;
 943
 944         return 0;
 945
 946 err_regdev:
 947         nfc_hci_free_device(info->hdev);
 948
 949 err_alloc_hdev:
 950         free_irq(client->irq, info);
 951
 952 err_rti:
 953         if (pdata->free_resources != NULL)
 954                 pdata->free_resources();
 955
 956 err_pdata:
 957         kfree(info);
 958
 959 err_info_alloc:
 960         return r;
 961 }
 962
 963 static __devexit int pn544_hci_remove(struct i2c_client *client)
 964 {
 965         struct pn544_hci_info *info = i2c_get_clientdata(client);
 966         struct pn544_nfc_platform_data *pdata = client->dev.platform_data;
 967
 968         dev_dbg(&client->dev, "%s\n", __func__);
 969
 970         nfc_hci_free_device(info->hdev);
 971
 972         if (info->state != PN544_ST_COLD) {
 973                 if (pdata->disable)
 974                         pdata->disable();
 975         }
 976
 977         free_irq(client->irq, info);
 978         if (pdata->free_resources)
 979                 pdata->free_resources();
 980
 981         kfree(info);
 982
 983         return 0;
 984 }
 985
 986 static struct i2c_driver pn544_hci_driver = {
 987         .driver = {
 988                    .name = PN544_HCI_DRIVER_NAME,
 989                   },
 990         .probe = pn544_hci_probe,
 991         .id_table = pn544_hci_id_table,
 992         .remove = __devexit_p(pn544_hci_remove),
 993 };
 994
 995 static int __init pn544_hci_init(void)
 996 {
 997         int r;
 998
 999         pr_debug(DRIVER_DESC ": %s\n", __func__);
1000
1001         r = i2c_add_driver(&pn544_hci_driver);
1002         if (r) {
1003                 pr_err(PN544_HCI_DRIVER_NAME ": driver registration failed\n");
1004                 return r;
1005         }
1006
1007         return 0;
1008 }
1009
1010 static void __exit pn544_hci_exit(void)
1011 {
1012         i2c_del_driver(&pn544_hci_driver);
1013 }
1014
1015 module_init(pn544_hci_init);
1016 module_exit(pn544_hci_exit);
1017
1018 MODULE_LICENSE("GPL");
1019 MODULE_DESCRIPTION(DRIVER_DESC);