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) {
 239                 if (r != len)
 240                         return -EREMOTEIO;
 241                 else
 242                         return 0;
 243         }
 244
 245         return r;
 246 }
 247
 248 static int check_crc(u8 *buf, int buflen)
 249 {
 250         int len;
 251         u16 crc;
 252
 253         len = buf[0] + 1;
 254         crc = crc_ccitt(0xffff, buf, len - 2);
 255         crc = ~crc;
 256
 257         if (buf[len - 2] != (crc & 0xff) || buf[len - 1] != (crc >> 8)) {
 258                 pr_err(PN544_HCI_DRIVER_NAME ": CRC error 0x%x != 0x%x 0x%x\n",
 259                        crc, buf[len - 1], buf[len - 2]);
 260
 261                 pr_info(DRIVER_DESC ": %s : BAD CRC\n", __func__);
 262                 print_hex_dump(KERN_DEBUG, "crc: ", DUMP_PREFIX_NONE,
 263                                16, 2, buf, buflen, false);
 264                 return -EPERM;
 265         }
 266         return 0;
 267 }
 268
 269 /*
 270  * Reads an shdlc frame and returns it in a newly allocated sk_buff. Guarantees
 271  * that i2c bus will be flushed and that next read will start on a new frame.
 272  * returned skb contains only LLC header and payload.
 273  * returns:
 274  * -EREMOTEIO : i2c read error (fatal)
 275  * -EBADMSG : frame was incorrect and discarded
 276  * -ENOMEM : cannot allocate skb, frame dropped
 277  */
 278 static int pn544_hci_i2c_read(struct i2c_client *client, struct sk_buff **skb)
 279 {
 280         int r;
 281         u8 len;
 282         u8 tmp[PN544_HCI_LLC_MAX_SIZE - 1];
 283
 284         r = i2c_master_recv(client, &len, 1);
 285         if (r != 1) {
 286                 dev_err(&client->dev, "cannot read len byte\n");
 287                 return -EREMOTEIO;
 288         }
 289
 290         if ((len < (PN544_HCI_LLC_MIN_SIZE - 1)) ||
 291             (len > (PN544_HCI_LLC_MAX_SIZE - 1))) {
 292                 dev_err(&client->dev, "invalid len byte\n");
 293                 r = -EBADMSG;
 294                 goto flush;
 295         }
 296
 297         *skb = alloc_skb(1 + len, GFP_KERNEL);
 298         if (*skb == NULL) {
 299                 r = -ENOMEM;
 300                 goto flush;
 301         }
 302
 303         *skb_put(*skb, 1) = len;
 304
 305         r = i2c_master_recv(client, skb_put(*skb, len), len);
 306         if (r != len) {
 307                 kfree_skb(*skb);
 308                 return -EREMOTEIO;
 309         }
 310
 311         r = check_crc((*skb)->data, (*skb)->len);
 312         if (r != 0) {
 313                 kfree_skb(*skb);
 314                 r = -EBADMSG;
 315                 goto flush;
 316         }
 317
 318         skb_pull(*skb, 1);
 319         skb_trim(*skb, (*skb)->len - 2);
 320
 321         usleep_range(3000, 6000);
 322
 323         return 0;
 324
 325 flush:
 326         if (i2c_master_recv(client, tmp, sizeof(tmp)) < 0)
 327                 r = -EREMOTEIO;
 328
 329         usleep_range(3000, 6000);
 330
 331         return r;
 332 }
 333
 334 /*
 335  * Reads an shdlc frame from the chip. This is not as straightforward as it
 336  * seems. There are cases where we could loose the frame start synchronization.
 337  * The frame format is len-data-crc, and corruption can occur anywhere while
 338  * transiting on i2c bus, such that we could read an invalid len.
 339  * In order to recover synchronization with the next frame, we must be sure
 340  * to read the real amount of data without using the len byte. We do this by
 341  * assuming the following:
 342  * - the chip will always present only one single complete frame on the bus
 343  *   before triggering the interrupt
 344  * - the chip will not present a new frame until we have completely read
 345  *   the previous one (or until we have handled the interrupt).
 346  * The tricky case is when we read a corrupted len that is less than the real
 347  * len. We must detect this here in order to determine that we need to flush
 348  * the bus. This is the reason why we check the crc here.
 349  */
 350 static irqreturn_t pn544_hci_irq_thread_fn(int irq, void *dev_id)
 351 {
 352         struct pn544_hci_info *info = dev_id;
 353         struct i2c_client *client;
 354         struct sk_buff *skb = NULL;
 355         int r;
 356
 357         if (!info || irq != info->i2c_dev->irq) {
 358                 WARN_ON_ONCE(1);
 359                 return IRQ_NONE;
 360         }
 361
 362         client = info->i2c_dev;
 363         dev_dbg(&client->dev, "IRQ\n");
 364
 365         if (info->hard_fault != 0)
 366                 return IRQ_HANDLED;
 367
 368         r = pn544_hci_i2c_read(client, &skb);
 369         if (r == -EREMOTEIO) {
 370                 info->hard_fault = r;
 371
 372                 nfc_hci_recv_frame(info->hdev, NULL);
 373
 374                 return IRQ_HANDLED;
 375         } else if ((r == -ENOMEM) || (r == -EBADMSG)) {
 376                 return IRQ_HANDLED;
 377         }
 378
 379         nfc_hci_recv_frame(info->hdev, skb);
 380
 381         return IRQ_HANDLED;
 382 }
 383
 384 static int pn544_hci_open(struct nfc_hci_dev *hdev)
 385 {
 386         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 387         int r = 0;
 388
 389         mutex_lock(&info->info_lock);
 390
 391         if (info->state != PN544_ST_COLD) {
 392                 r = -EBUSY;
 393                 goto out;
 394         }
 395
 396         r = pn544_hci_enable(info, HCI_MODE);
 397
 398         if (r == 0)
 399                 info->state = PN544_ST_READY;
 400
 401 out:
 402         mutex_unlock(&info->info_lock);
 403         return r;
 404 }
 405
 406 static void pn544_hci_close(struct nfc_hci_dev *hdev)
 407 {
 408         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 409
 410         mutex_lock(&info->info_lock);
 411
 412         if (info->state == PN544_ST_COLD)
 413                 goto out;
 414
 415         pn544_hci_disable(info);
 416
 417         info->state = PN544_ST_COLD;
 418
 419 out:
 420         mutex_unlock(&info->info_lock);
 421 }
 422
 423 static int pn544_hci_ready(struct nfc_hci_dev *hdev)
 424 {
 425         struct sk_buff *skb;
 426         static struct hw_config {
 427                 u8 adr[2];
 428                 u8 value;
 429         } hw_config[] = {
 430                 {{0x9f, 0x9a}, 0x00},
 431
 432                 {{0x98, 0x10}, 0xbc},
 433
 434                 {{0x9e, 0x71}, 0x00},
 435
 436                 {{0x98, 0x09}, 0x00},
 437
 438                 {{0x9e, 0xb4}, 0x00},
 439
 440                 {{0x9e, 0xd9}, 0xff},
 441                 {{0x9e, 0xda}, 0xff},
 442                 {{0x9e, 0xdb}, 0x23},
 443                 {{0x9e, 0xdc}, 0x21},
 444                 {{0x9e, 0xdd}, 0x22},
 445                 {{0x9e, 0xde}, 0x24},
 446
 447                 {{0x9c, 0x01}, 0x08},
 448
 449                 {{0x9e, 0xaa}, 0x01},
 450
 451                 {{0x9b, 0xd1}, 0x0d},
 452                 {{0x9b, 0xd2}, 0x24},
 453                 {{0x9b, 0xd3}, 0x0a},
 454                 {{0x9b, 0xd4}, 0x22},
 455                 {{0x9b, 0xd5}, 0x08},
 456                 {{0x9b, 0xd6}, 0x1e},
 457                 {{0x9b, 0xdd}, 0x1c},
 458
 459                 {{0x9b, 0x84}, 0x13},
 460                 {{0x99, 0x81}, 0x7f},
 461                 {{0x99, 0x31}, 0x70},
 462
 463                 {{0x98, 0x00}, 0x3f},
 464
 465                 {{0x9f, 0x09}, 0x00},
 466
 467                 {{0x9f, 0x0a}, 0x05},
 468
 469                 {{0x9e, 0xd1}, 0xa1},
 470                 {{0x99, 0x23}, 0x00},
 471
 472                 {{0x9e, 0x74}, 0x80},
 473
 474                 {{0x9f, 0x28}, 0x10},
 475
 476                 {{0x9f, 0x35}, 0x14},
 477
 478                 {{0x9f, 0x36}, 0x60},
 479
 480                 {{0x9c, 0x31}, 0x00},
 481
 482                 {{0x9c, 0x32}, 0xc8},
 483
 484                 {{0x9c, 0x19}, 0x40},
 485
 486                 {{0x9c, 0x1a}, 0x40},
 487
 488                 {{0x9c, 0x0c}, 0x00},
 489
 490                 {{0x9c, 0x0d}, 0x00},
 491
 492                 {{0x9c, 0x12}, 0x00},
 493
 494                 {{0x9c, 0x13}, 0x00},
 495
 496                 {{0x98, 0xa2}, 0x0e},
 497
 498                 {{0x98, 0x93}, 0x40},
 499
 500                 {{0x98, 0x7d}, 0x02},
 501                 {{0x98, 0x7e}, 0x00},
 502                 {{0x9f, 0xc8}, 0x01},
 503         };
 504         struct hw_config *p = hw_config;
 505         int count = ARRAY_SIZE(hw_config);
 506         struct sk_buff *res_skb;
 507         u8 param[4];
 508         int r;
 509
 510         param[0] = 0;
 511         while (count--) {
 512                 param[1] = p->adr[0];
 513                 param[2] = p->adr[1];
 514                 param[3] = p->value;
 515
 516                 r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE, PN544_WRITE,
 517                                      param, 4, &res_skb);
 518                 if (r < 0)
 519                         return r;
 520
 521                 if (res_skb->len != 1) {
 522                         kfree_skb(res_skb);
 523                         return -EPROTO;
 524                 }
 525
 526                 if (res_skb->data[0] != p->value) {
 527                         kfree_skb(res_skb);
 528                         return -EIO;
 529                 }
 530
 531                 kfree_skb(res_skb);
 532
 533                 p++;
 534         }
 535
 536         param[0] = NFC_HCI_UICC_HOST_ID;
 537         r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
 538                               NFC_HCI_ADMIN_WHITELIST, param, 1);
 539         if (r < 0)
 540                 return r;
 541
 542         param[0] = 0x3d;
 543         r = nfc_hci_set_param(hdev, PN544_SYS_MGMT_GATE,
 544                               PN544_SYS_MGMT_INFO_NOTIFICATION, param, 1);
 545         if (r < 0)
 546                 return r;
 547
 548         param[0] = 0x0;
 549         r = nfc_hci_set_param(hdev, NFC_HCI_RF_READER_A_GATE,
 550                               PN544_RF_READER_A_AUTO_ACTIVATION, param, 1);
 551         if (r < 0)
 552                 return r;
 553
 554         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 555                                NFC_HCI_EVT_END_OPERATION, NULL, 0);
 556         if (r < 0)
 557                 return r;
 558
 559         param[0] = 0x1;
 560         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 561                               PN544_PL_NFCT_DEACTIVATED, param, 1);
 562         if (r < 0)
 563                 return r;
 564
 565         param[0] = 0x0;
 566         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 567                               PN544_PL_RDPHASES, param, 1);
 568         if (r < 0)
 569                 return r;
 570
 571         r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
 572                               PN544_ID_MGMT_FULL_VERSION_SW, &skb);
 573         if (r < 0)
 574                 return r;
 575
 576         if (skb->len != FULL_VERSION_LEN) {
 577                 kfree_skb(skb);
 578                 return -EINVAL;
 579         }
 580
 581         print_hex_dump(KERN_DEBUG, "FULL VERSION SOFTWARE INFO: ",
 582                        DUMP_PREFIX_NONE, 16, 1,
 583                        skb->data, FULL_VERSION_LEN, false);
 584
 585         kfree_skb(skb);
 586
 587         return 0;
 588 }
 589
 590 static void pn544_hci_add_len_crc(struct sk_buff *skb)
 591 {
 592         u16 crc;
 593         int len;
 594
 595         len = skb->len + 2;
 596         *skb_push(skb, 1) = len;
 597
 598         crc = crc_ccitt(0xffff, skb->data, skb->len);
 599         crc = ~crc;
 600         *skb_put(skb, 1) = crc & 0xff;
 601         *skb_put(skb, 1) = crc >> 8;
 602 }
 603
 604 static void pn544_hci_remove_len_crc(struct sk_buff *skb)
 605 {
 606         skb_pull(skb, PN544_FRAME_HEADROOM);
 607         skb_trim(skb, PN544_FRAME_TAILROOM);
 608 }
 609
 610 static int pn544_hci_xmit(struct nfc_hci_dev *hdev, struct sk_buff *skb)
 611 {
 612         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 613         struct i2c_client *client = info->i2c_dev;
 614         int r;
 615
 616         if (info->hard_fault != 0)
 617                 return info->hard_fault;
 618
 619         pn544_hci_add_len_crc(skb);
 620         r = pn544_hci_i2c_write(client, skb->data, skb->len);
 621         pn544_hci_remove_len_crc(skb);
 622
 623         return r;
 624 }
 625
 626 static int pn544_hci_start_poll(struct nfc_hci_dev *hdev,
 627                                 u32 im_protocols, u32 tm_protocols)
 628 {
 629         u8 phases = 0;
 630         int r;
 631         u8 duration[2];
 632         u8 activated;
 633
 634         pr_info(DRIVER_DESC ": %s protocols 0x%x 0x%x\n",
 635                 __func__, im_protocols, tm_protocols);
 636
 637         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 638                                NFC_HCI_EVT_END_OPERATION, NULL, 0);
 639         if (r < 0)
 640                 return r;
 641
 642         duration[0] = 0x18;
 643         duration[1] = 0x6a;
 644         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 645                               PN544_PL_EMULATION, duration, 2);
 646         if (r < 0)
 647                 return r;
 648
 649         activated = 0;
 650         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 651                               PN544_PL_NFCT_DEACTIVATED, &activated, 1);
 652         if (r < 0)
 653                 return r;
 654
 655         if (im_protocols & (NFC_PROTO_ISO14443_MASK | NFC_PROTO_MIFARE_MASK |
 656                          NFC_PROTO_JEWEL_MASK))
 657                 phases |= 1;            /* Type A */
 658         if (im_protocols & NFC_PROTO_FELICA_MASK) {
 659                 phases |= (1 << 2);     /* Type F 212 */
 660                 phases |= (1 << 3);     /* Type F 424 */
 661         }
 662
 663         phases |= (1 << 5);             /* NFC active */
 664
 665         r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
 666                               PN544_PL_RDPHASES, &phases, 1);
 667         if (r < 0)
 668                 return r;
 669
 670         r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 671                                NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
 672         if (r < 0)
 673                 nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
 674                                    NFC_HCI_EVT_END_OPERATION, NULL, 0);
 675
 676         return r;
 677 }
 678
 679 static int pn544_hci_target_from_gate(struct nfc_hci_dev *hdev, u8 gate,
 680                                       struct nfc_target *target)
 681 {
 682         switch (gate) {
 683         case PN544_RF_READER_F_GATE:
 684                 target->supported_protocols = NFC_PROTO_FELICA_MASK;
 685                 break;
 686         case PN544_RF_READER_JEWEL_GATE:
 687                 target->supported_protocols = NFC_PROTO_JEWEL_MASK;
 688                 target->sens_res = 0x0c00;
 689                 break;
 690         default:
 691                 return -EPROTO;
 692         }
 693
 694         return 0;
 695 }
 696
 697 static int pn544_hci_complete_target_discovered(struct nfc_hci_dev *hdev,
 698                                                 u8 gate,
 699                                                 struct nfc_target *target)
 700 {
 701         struct sk_buff *uid_skb;
 702         int r = 0;
 703
 704         if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
 705                 if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
 706                     target->nfcid1_len != 10)
 707                         return -EPROTO;
 708
 709                 r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
 710                                      PN544_RF_READER_CMD_ACTIVATE_NEXT,
 711                                      target->nfcid1, target->nfcid1_len, NULL);
 712         } else if (target->supported_protocols & NFC_PROTO_FELICA_MASK) {
 713                 r = nfc_hci_get_param(hdev, PN544_RF_READER_F_GATE,
 714                                       PN544_FELICA_ID, &uid_skb);
 715                 if (r < 0)
 716                         return r;
 717
 718                 if (uid_skb->len != 8) {
 719                         kfree_skb(uid_skb);
 720                         return -EPROTO;
 721                 }
 722
 723                 r = nfc_hci_send_cmd(hdev, PN544_RF_READER_F_GATE,
 724                                      PN544_RF_READER_CMD_ACTIVATE_NEXT,
 725                                      uid_skb->data, uid_skb->len, NULL);
 726                 kfree_skb(uid_skb);
 727         } else if (target->supported_protocols & NFC_PROTO_ISO14443_MASK) {
 728                 /*
 729                  * TODO: maybe other ISO 14443 require some kind of continue
 730                  * activation, but for now we've seen only this one below.
 731                  */
 732                 if (target->sens_res == 0x4403) /* Type 4 Mifare DESFire */
 733                         r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
 734                               PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION,
 735                               NULL, 0, NULL);
 736         }
 737
 738         return r;
 739 }
 740
 741 #define PN544_CB_TYPE_READER_F 1
 742
 743 static void pn544_hci_data_exchange_cb(void *context, struct sk_buff *skb,
 744                                        int err)
 745 {
 746         struct pn544_hci_info *info = context;
 747
 748         switch (info->async_cb_type) {
 749         case PN544_CB_TYPE_READER_F:
 750                 if (err == 0)
 751                         skb_pull(skb, 1);
 752                 info->async_cb(info->async_cb_context, skb, err);
 753                 break;
 754         default:
 755                 if (err == 0)
 756                         kfree_skb(skb);
 757                 break;
 758         }
 759 }
 760
 761 #define MIFARE_CMD_AUTH_KEY_A   0x60
 762 #define MIFARE_CMD_AUTH_KEY_B   0x61
 763 #define MIFARE_CMD_HEADER       2
 764 #define MIFARE_UID_LEN          4
 765 #define MIFARE_KEY_LEN          6
 766 #define MIFARE_CMD_LEN          12
 767 /*
 768  * Returns:
 769  * <= 0: driver handled the data exchange
 770  *    1: driver doesn't especially handle, please do standard processing
 771  */
 772 static int pn544_hci_data_exchange(struct nfc_hci_dev *hdev,
 773                                    struct nfc_target *target,
 774                                    struct sk_buff *skb, data_exchange_cb_t cb,
 775                                    void *cb_context)
 776 {
 777         struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
 778
 779         pr_info(DRIVER_DESC ": %s for gate=%d\n", __func__,
 780                 target->hci_reader_gate);
 781
 782         switch (target->hci_reader_gate) {
 783         case NFC_HCI_RF_READER_A_GATE:
 784                 if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
 785                         /*
 786                          * It seems that pn544 is inverting key and UID for
 787                          * MIFARE authentication commands.
 788                          */
 789                         if (skb->len == MIFARE_CMD_LEN &&
 790                             (skb->data[0] == MIFARE_CMD_AUTH_KEY_A ||
 791                              skb->data[0] == MIFARE_CMD_AUTH_KEY_B)) {
 792                                 u8 uid[MIFARE_UID_LEN];
 793                                 u8 *data = skb->data + MIFARE_CMD_HEADER;
 794
 795                                 memcpy(uid, data + MIFARE_KEY_LEN,
 796                                        MIFARE_UID_LEN);
 797                                 memmove(data + MIFARE_UID_LEN, data,
 798                                         MIFARE_KEY_LEN);
 799                                 memcpy(data, uid, MIFARE_UID_LEN);
 800                         }
 801
 802                         return nfc_hci_send_cmd_async(hdev,
 803                                                       target->hci_reader_gate,
 804                                                       PN544_MIFARE_CMD,
 805                                                       skb->data, skb->len,
 806                                                       cb, cb_context);
 807                 } else
 808                         return 1;
 809         case PN544_RF_READER_F_GATE:
 810                 *skb_push(skb, 1) = 0;
 811                 *skb_push(skb, 1) = 0;
 812
 813                 info->async_cb_type = PN544_CB_TYPE_READER_F;
 814                 info->async_cb = cb;
 815                 info->async_cb_context = cb_context;
 816
 817                 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
 818                                               PN544_FELICA_RAW, skb->data,
 819                                               skb->len,
 820                                               pn544_hci_data_exchange_cb, info);
 821         case PN544_RF_READER_JEWEL_GATE:
 822                 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
 823                                               PN544_JEWEL_RAW_CMD, skb->data,
 824                                               skb->len, cb, cb_context);
 825         default:
 826                 return 1;
 827         }
 828 }
 829
 830 static int pn544_hci_check_presence(struct nfc_hci_dev *hdev,
 831                                    struct nfc_target *target)
 832 {
 833         return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
 834                                 PN544_RF_READER_CMD_PRESENCE_CHECK,
 835                                 NULL, 0, NULL);
 836 }
 837
 838 static struct nfc_hci_ops pn544_hci_ops = {
 839         .open = pn544_hci_open,
 840         .close = pn544_hci_close,
 841         .hci_ready = pn544_hci_ready,
 842         .xmit = pn544_hci_xmit,
 843         .start_poll = pn544_hci_start_poll,
 844         .target_from_gate = pn544_hci_target_from_gate,
 845         .complete_target_discovered = pn544_hci_complete_target_discovered,
 846         .data_exchange = pn544_hci_data_exchange,
 847         .check_presence = pn544_hci_check_presence,
 848 };
 849
 850 static int __devinit pn544_hci_probe(struct i2c_client *client,
 851                                      const struct i2c_device_id *id)
 852 {
 853         struct pn544_hci_info *info;
 854         struct pn544_nfc_platform_data *pdata;
 855         int r = 0;
 856         u32 protocols;
 857         struct nfc_hci_init_data init_data;
 858
 859         dev_dbg(&client->dev, "%s\n", __func__);
 860         dev_dbg(&client->dev, "IRQ: %d\n", client->irq);
 861
 862         if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
 863                 dev_err(&client->dev, "Need I2C_FUNC_I2C\n");
 864                 return -ENODEV;
 865         }
 866
 867         info = kzalloc(sizeof(struct pn544_hci_info), GFP_KERNEL);
 868         if (!info) {
 869                 dev_err(&client->dev,
 870                         "Cannot allocate memory for pn544_hci_info.\n");
 871                 r = -ENOMEM;
 872                 goto err_info_alloc;
 873         }
 874
 875         info->i2c_dev = client;
 876         info->state = PN544_ST_COLD;
 877         mutex_init(&info->info_lock);
 878         i2c_set_clientdata(client, info);
 879
 880         pdata = client->dev.platform_data;
 881         if (pdata == NULL) {
 882                 dev_err(&client->dev, "No platform data\n");
 883                 r = -EINVAL;
 884                 goto err_pdata;
 885         }
 886
 887         if (pdata->request_resources == NULL) {
 888                 dev_err(&client->dev, "request_resources() missing\n");
 889                 r = -EINVAL;
 890                 goto err_pdata;
 891         }
 892
 893         r = pdata->request_resources(client);
 894         if (r) {
 895                 dev_err(&client->dev, "Cannot get platform resources\n");
 896                 goto err_pdata;
 897         }
 898
 899         info->gpio_en = pdata->get_gpio(NFC_GPIO_ENABLE);
 900         info->gpio_fw = pdata->get_gpio(NFC_GPIO_FW_RESET);
 901         info->gpio_irq = pdata->get_gpio(NFC_GPIO_IRQ);
 902
 903         pn544_hci_platform_init(info);
 904
 905         r = request_threaded_irq(client->irq, NULL, pn544_hci_irq_thread_fn,
 906                                  IRQF_TRIGGER_RISING | IRQF_ONESHOT,
 907                                  PN544_HCI_DRIVER_NAME, info);
 908         if (r < 0) {
 909                 dev_err(&client->dev, "Unable to register IRQ handler\n");
 910                 goto err_rti;
 911         }
 912
 913         init_data.gate_count = ARRAY_SIZE(pn544_gates);
 914
 915         memcpy(init_data.gates, pn544_gates, sizeof(pn544_gates));
 916
 917         /*
 918          * TODO: Session id must include the driver name + some bus addr
 919          * persistent info to discriminate 2 identical chips
 920          */
 921         strcpy(init_data.session_id, "ID544HCI");
 922
 923         protocols = NFC_PROTO_JEWEL_MASK |
 924                     NFC_PROTO_MIFARE_MASK |
 925                     NFC_PROTO_FELICA_MASK |
 926                     NFC_PROTO_ISO14443_MASK |
 927                     NFC_PROTO_ISO14443_B_MASK |
 928                     NFC_PROTO_NFC_DEP_MASK;
 929
 930         info->hdev = nfc_hci_allocate_device(&pn544_hci_ops, &init_data,
 931                                              protocols, LLC_SHDLC_NAME,
 932                                              PN544_FRAME_HEADROOM +
 933                                              PN544_CMDS_HEADROOM,
 934                                              PN544_FRAME_TAILROOM,
 935                                              PN544_HCI_LLC_MAX_PAYLOAD);
 936         if (!info->hdev) {
 937                 dev_err(&client->dev, "Cannot allocate nfc hdev.\n");
 938                 r = -ENOMEM;
 939                 goto err_alloc_hdev;
 940         }
 941
 942         nfc_hci_set_clientdata(info->hdev, info);
 943
 944         r = nfc_hci_register_device(info->hdev);
 945         if (r)
 946                 goto err_regdev;
 947
 948         return 0;
 949
 950 err_regdev:
 951         nfc_hci_free_device(info->hdev);
 952
 953 err_alloc_hdev:
 954         free_irq(client->irq, info);
 955
 956 err_rti:
 957         if (pdata->free_resources != NULL)
 958                 pdata->free_resources();
 959
 960 err_pdata:
 961         kfree(info);
 962
 963 err_info_alloc:
 964         return r;
 965 }
 966
 967 static __devexit int pn544_hci_remove(struct i2c_client *client)
 968 {
 969         struct pn544_hci_info *info = i2c_get_clientdata(client);
 970         struct pn544_nfc_platform_data *pdata = client->dev.platform_data;
 971
 972         dev_dbg(&client->dev, "%s\n", __func__);
 973
 974         nfc_hci_free_device(info->hdev);
 975
 976         if (info->state != PN544_ST_COLD) {
 977                 if (pdata->disable)
 978                         pdata->disable();
 979         }
 980
 981         free_irq(client->irq, info);
 982         if (pdata->free_resources)
 983                 pdata->free_resources();
 984
 985         kfree(info);
 986
 987         return 0;
 988 }
 989
 990 static struct i2c_driver pn544_hci_driver = {
 991         .driver = {
 992                    .name = PN544_HCI_DRIVER_NAME,
 993                   },
 994         .probe = pn544_hci_probe,
 995         .id_table = pn544_hci_id_table,
 996         .remove = __devexit_p(pn544_hci_remove),
 997 };
 998
 999 static int __init pn544_hci_init(void)
1000 {
1001         int r;
1002
1003         pr_debug(DRIVER_DESC ": %s\n", __func__);
1004
1005         r = i2c_add_driver(&pn544_hci_driver);
1006         if (r) {
1007                 pr_err(PN544_HCI_DRIVER_NAME ": driver registration failed\n");
1008                 return r;
1009         }
1010
1011         return 0;
1012 }
1013
1014 static void __exit pn544_hci_exit(void)
1015 {
1016         i2c_del_driver(&pn544_hci_driver);
1017 }
1018
1019 module_init(pn544_hci_init);
1020 module_exit(pn544_hci_exit);
1021
1022 MODULE_LICENSE("GPL");
1023 MODULE_DESCRIPTION(DRIVER_DESC);