drivers/char/tpm/tpm_i2c_nuvoton.c

   1 /******************************************************************************
   2  * Nuvoton TPM I2C Device Driver Interface for WPCT301/NPCT501,
   3  * based on the TCG TPM Interface Spec version 1.2.
   4  * Specifications at www.trustedcomputinggroup.org
   5  *
   6  * Copyright (C) 2011, Nuvoton Technology Corporation.
   7  *  Dan Morav <dan.morav@nuvoton.com>
   8  * Copyright (C) 2013, Obsidian Research Corp.
   9  *  Jason Gunthorpe <jgunthorpe@obsidianresearch.com>
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see http://www.gnu.org/licenses/>.
  23  *
  24  * Nuvoton contact information: APC.Support@nuvoton.com
  25  *****************************************************************************/
  26
  27 #include <linux/init.h>
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/slab.h>
  31 #include <linux/interrupt.h>
  32 #include <linux/wait.h>
  33 #include <linux/i2c.h>
  34 #include "tpm.h"
  35
  36 /* I2C interface offsets */
  37 #define TPM_STS                0x00
  38 #define TPM_BURST_COUNT        0x01
  39 #define TPM_DATA_FIFO_W        0x20
  40 #define TPM_DATA_FIFO_R        0x40
  41 #define TPM_VID_DID_RID        0x60
  42 /* TPM command header size */
  43 #define TPM_HEADER_SIZE        10
  44 #define TPM_RETRY      5
  45 /*
  46  * I2C bus device maximum buffer size w/o counting I2C address or command
  47  * i.e. max size required for I2C write is 34 = addr, command, 32 bytes data
  48  */
  49 #define TPM_I2C_MAX_BUF_SIZE           32
  50 #define TPM_I2C_RETRY_COUNT            32
  51 #define TPM_I2C_BUS_DELAY              1       /* msec */
  52 #define TPM_I2C_RETRY_DELAY_SHORT      2       /* msec */
  53 #define TPM_I2C_RETRY_DELAY_LONG       10      /* msec */
  54
  55 #define I2C_DRIVER_NAME "tpm_i2c_nuvoton"
  56
  57 struct priv_data {
  58         unsigned int intrs;
  59 };
  60
  61 static s32 i2c_nuvoton_read_buf(struct i2c_client *client, u8 offset, u8 size,
  62                                 u8 *data)
  63 {
  64         s32 status;
  65
  66         status = i2c_smbus_read_i2c_block_data(client, offset, size, data);
  67         dev_dbg(&client->dev,
  68                 "%s(offset=%u size=%u data=%*ph) -> sts=%d\n", __func__,
  69                 offset, size, (int)size, data, status);
  70         return status;
  71 }
  72
  73 static s32 i2c_nuvoton_write_buf(struct i2c_client *client, u8 offset, u8 size,
  74                                  u8 *data)
  75 {
  76         s32 status;
  77
  78         status = i2c_smbus_write_i2c_block_data(client, offset, size, data);
  79         dev_dbg(&client->dev,
  80                 "%s(offset=%u size=%u data=%*ph) -> sts=%d\n", __func__,
  81                 offset, size, (int)size, data, status);
  82         return status;
  83 }
  84
  85 #define TPM_STS_VALID          0x80
  86 #define TPM_STS_COMMAND_READY  0x40
  87 #define TPM_STS_GO             0x20
  88 #define TPM_STS_DATA_AVAIL     0x10
  89 #define TPM_STS_EXPECT         0x08
  90 #define TPM_STS_RESPONSE_RETRY 0x02
  91 #define TPM_STS_ERR_VAL        0x07    /* bit2...bit0 reads always 0 */
  92
  93 #define TPM_I2C_SHORT_TIMEOUT  750     /* ms */
  94 #define TPM_I2C_LONG_TIMEOUT   2000    /* 2 sec */
  95
  96 /* read TPM_STS register */
  97 static u8 i2c_nuvoton_read_status(struct tpm_chip *chip)
  98 {
  99         struct i2c_client *client = to_i2c_client(chip->dev);
 100         s32 status;
 101         u8 data;
 102
 103         status = i2c_nuvoton_read_buf(client, TPM_STS, 1, &data);
 104         if (status <= 0) {
 105                 dev_err(chip->dev, "%s() error return %d\n", __func__,
 106                         status);
 107                 data = TPM_STS_ERR_VAL;
 108         }
 109
 110         return data;
 111 }
 112
 113 /* write byte to TPM_STS register */
 114 static s32 i2c_nuvoton_write_status(struct i2c_client *client, u8 data)
 115 {
 116         s32 status;
 117         int i;
 118
 119         /* this causes the current command to be aborted */
 120         for (i = 0, status = -1; i < TPM_I2C_RETRY_COUNT && status < 0; i++) {
 121                 status = i2c_nuvoton_write_buf(client, TPM_STS, 1, &data);
 122                 msleep(TPM_I2C_BUS_DELAY);
 123         }
 124         return status;
 125 }
 126
 127 /* write commandReady to TPM_STS register */
 128 static void i2c_nuvoton_ready(struct tpm_chip *chip)
 129 {
 130         struct i2c_client *client = to_i2c_client(chip->dev);
 131         s32 status;
 132
 133         /* this causes the current command to be aborted */
 134         status = i2c_nuvoton_write_status(client, TPM_STS_COMMAND_READY);
 135         if (status < 0)
 136                 dev_err(chip->dev,
 137                         "%s() fail to write TPM_STS.commandReady\n", __func__);
 138 }
 139
 140 /* read burstCount field from TPM_STS register
 141  * return -1 on fail to read */
 142 static int i2c_nuvoton_get_burstcount(struct i2c_client *client,
 143                                       struct tpm_chip *chip)
 144 {
 145         unsigned long stop = jiffies + chip->vendor.timeout_d;
 146         s32 status;
 147         int burst_count = -1;
 148         u8 data;
 149
 150         /* wait for burstcount to be non-zero */
 151         do {
 152                 /* in I2C burstCount is 1 byte */
 153                 status = i2c_nuvoton_read_buf(client, TPM_BURST_COUNT, 1,
 154                                               &data);
 155                 if (status > 0 && data > 0) {
 156                         burst_count = min_t(u8, TPM_I2C_MAX_BUF_SIZE, data);
 157                         break;
 158                 }
 159                 msleep(TPM_I2C_BUS_DELAY);
 160         } while (time_before(jiffies, stop));
 161
 162         return burst_count;
 163 }
 164
 165 /*
 166  * WPCT301/NPCT501 SINT# supports only dataAvail
 167  * any call to this function which is not waiting for dataAvail will
 168  * set queue to NULL to avoid waiting for interrupt
 169  */
 170 static bool i2c_nuvoton_check_status(struct tpm_chip *chip, u8 mask, u8 value)
 171 {
 172         u8 status = i2c_nuvoton_read_status(chip);
 173         return (status != TPM_STS_ERR_VAL) && ((status & mask) == value);
 174 }
 175
 176 static int i2c_nuvoton_wait_for_stat(struct tpm_chip *chip, u8 mask, u8 value,
 177                                      u32 timeout, wait_queue_head_t *queue)
 178 {
 179         if (chip->vendor.irq && queue) {
 180                 s32 rc;
 181                 struct priv_data *priv = chip->vendor.priv;
 182                 unsigned int cur_intrs = priv->intrs;
 183
 184                 enable_irq(chip->vendor.irq);
 185                 rc = wait_event_interruptible_timeout(*queue,
 186                                                       cur_intrs != priv->intrs,
 187                                                       timeout);
 188                 if (rc > 0)
 189                         return 0;
 190                 /* At this point we know that the SINT pin is asserted, so we
 191                  * do not need to do i2c_nuvoton_check_status */
 192         } else {
 193                 unsigned long ten_msec, stop;
 194                 bool status_valid;
 195
 196                 /* check current status */
 197                 status_valid = i2c_nuvoton_check_status(chip, mask, value);
 198                 if (status_valid)
 199                         return 0;
 200
 201                 /* use polling to wait for the event */
 202                 ten_msec = jiffies + msecs_to_jiffies(TPM_I2C_RETRY_DELAY_LONG);
 203                 stop = jiffies + timeout;
 204                 do {
 205                         if (time_before(jiffies, ten_msec))
 206                                 msleep(TPM_I2C_RETRY_DELAY_SHORT);
 207                         else
 208                                 msleep(TPM_I2C_RETRY_DELAY_LONG);
 209                         status_valid = i2c_nuvoton_check_status(chip, mask,
 210                                                                 value);
 211                         if (status_valid)
 212                                 return 0;
 213                 } while (time_before(jiffies, stop));
 214         }
 215         dev_err(chip->dev, "%s(%02x, %02x) -> timeout\n", __func__, mask,
 216                 value);
 217         return -ETIMEDOUT;
 218 }
 219
 220 /* wait for dataAvail field to be set in the TPM_STS register */
 221 static int i2c_nuvoton_wait_for_data_avail(struct tpm_chip *chip, u32 timeout,
 222                                            wait_queue_head_t *queue)
 223 {
 224         return i2c_nuvoton_wait_for_stat(chip,
 225                                          TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 226                                          TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 227                                          timeout, queue);
 228 }
 229
 230 /* Read @count bytes into @buf from TPM_RD_FIFO register */
 231 static int i2c_nuvoton_recv_data(struct i2c_client *client,
 232                                  struct tpm_chip *chip, u8 *buf, size_t count)
 233 {
 234         s32 rc;
 235         int burst_count, bytes2read, size = 0;
 236
 237         while (size < count &&
 238                i2c_nuvoton_wait_for_data_avail(chip,
 239                                                chip->vendor.timeout_c,
 240                                                &chip->vendor.read_queue) == 0) {
 241                 burst_count = i2c_nuvoton_get_burstcount(client, chip);
 242                 if (burst_count < 0) {
 243                         dev_err(chip->dev,
 244                                 "%s() fail to read burstCount=%d\n", __func__,
 245                                 burst_count);
 246                         return -EIO;
 247                 }
 248                 bytes2read = min_t(size_t, burst_count, count - size);
 249                 rc = i2c_nuvoton_read_buf(client, TPM_DATA_FIFO_R,
 250                                           bytes2read, &buf[size]);
 251                 if (rc < 0) {
 252                         dev_err(chip->dev,
 253                                 "%s() fail on i2c_nuvoton_read_buf()=%d\n",
 254                                 __func__, rc);
 255                         return -EIO;
 256                 }
 257                 dev_dbg(chip->dev, "%s(%d):", __func__, bytes2read);
 258                 size += bytes2read;
 259         }
 260
 261         return size;
 262 }
 263
 264 /* Read TPM command results */
 265 static int i2c_nuvoton_recv(struct tpm_chip *chip, u8 *buf, size_t count)
 266 {
 267         struct device *dev = chip->dev;
 268         struct i2c_client *client = to_i2c_client(dev);
 269         s32 rc;
 270         int expected, status, burst_count, retries, size = 0;
 271
 272         if (count < TPM_HEADER_SIZE) {
 273                 i2c_nuvoton_ready(chip);    /* return to idle */
 274                 dev_err(dev, "%s() count < header size\n", __func__);
 275                 return -EIO;
 276         }
 277         for (retries = 0; retries < TPM_RETRY; retries++) {
 278                 if (retries > 0) {
 279                         /* if this is not the first trial, set responseRetry */
 280                         i2c_nuvoton_write_status(client,
 281                                                  TPM_STS_RESPONSE_RETRY);
 282                 }
 283                 /*
 284                  * read first available (> 10 bytes), including:
 285                  * tag, paramsize, and result
 286                  */
 287                 status = i2c_nuvoton_wait_for_data_avail(
 288                         chip, chip->vendor.timeout_c, &chip->vendor.read_queue);
 289                 if (status != 0) {
 290                         dev_err(dev, "%s() timeout on dataAvail\n", __func__);
 291                         size = -ETIMEDOUT;
 292                         continue;
 293                 }
 294                 burst_count = i2c_nuvoton_get_burstcount(client, chip);
 295                 if (burst_count < 0) {
 296                         dev_err(dev, "%s() fail to get burstCount\n", __func__);
 297                         size = -EIO;
 298                         continue;
 299                 }
 300                 size = i2c_nuvoton_recv_data(client, chip, buf,
 301                                              burst_count);
 302                 if (size < TPM_HEADER_SIZE) {
 303                         dev_err(dev, "%s() fail to read header\n", __func__);
 304                         size = -EIO;
 305                         continue;
 306                 }
 307                 /*
 308                  * convert number of expected bytes field from big endian 32 bit
 309                  * to machine native
 310                  */
 311                 expected = be32_to_cpu(*(__be32 *) (buf + 2));
 312                 if (expected > count) {
 313                         dev_err(dev, "%s() expected > count\n", __func__);
 314                         size = -EIO;
 315                         continue;
 316                 }
 317                 rc = i2c_nuvoton_recv_data(client, chip, &buf[size],
 318                                            expected - size);
 319                 size += rc;
 320                 if (rc < 0 || size < expected) {
 321                         dev_err(dev, "%s() fail to read remainder of result\n",
 322                                 __func__);
 323                         size = -EIO;
 324                         continue;
 325                 }
 326                 if (i2c_nuvoton_wait_for_stat(
 327                             chip, TPM_STS_VALID | TPM_STS_DATA_AVAIL,
 328                             TPM_STS_VALID, chip->vendor.timeout_c,
 329                             NULL)) {
 330                         dev_err(dev, "%s() error left over data\n", __func__);
 331                         size = -ETIMEDOUT;
 332                         continue;
 333                 }
 334                 break;
 335         }
 336         i2c_nuvoton_ready(chip);
 337         dev_dbg(chip->dev, "%s() -> %d\n", __func__, size);
 338         return size;
 339 }
 340
 341 /*
 342  * Send TPM command.
 343  *
 344  * If interrupts are used (signaled by an irq set in the vendor structure)
 345  * tpm.c can skip polling for the data to be available as the interrupt is
 346  * waited for here
 347  */
 348 static int i2c_nuvoton_send(struct tpm_chip *chip, u8 *buf, size_t len)
 349 {
 350         struct device *dev = chip->dev;
 351         struct i2c_client *client = to_i2c_client(dev);
 352         u32 ordinal;
 353         size_t count = 0;
 354         int burst_count, bytes2write, retries, rc = -EIO;
 355
 356         for (retries = 0; retries < TPM_RETRY; retries++) {
 357                 i2c_nuvoton_ready(chip);
 358                 if (i2c_nuvoton_wait_for_stat(chip, TPM_STS_COMMAND_READY,
 359                                               TPM_STS_COMMAND_READY,
 360                                               chip->vendor.timeout_b, NULL)) {
 361                         dev_err(dev, "%s() timeout on commandReady\n",
 362                                 __func__);
 363                         rc = -EIO;
 364                         continue;
 365                 }
 366                 rc = 0;
 367                 while (count < len - 1) {
 368                         burst_count = i2c_nuvoton_get_burstcount(client,
 369                                                                  chip);
 370                         if (burst_count < 0) {
 371                                 dev_err(dev, "%s() fail get burstCount\n",
 372                                         __func__);
 373                                 rc = -EIO;
 374                                 break;
 375                         }
 376                         bytes2write = min_t(size_t, burst_count,
 377                                             len - 1 - count);
 378                         rc = i2c_nuvoton_write_buf(client, TPM_DATA_FIFO_W,
 379                                                    bytes2write, &buf[count]);
 380                         if (rc < 0) {
 381                                 dev_err(dev, "%s() fail i2cWriteBuf\n",
 382                                         __func__);
 383                                 break;
 384                         }
 385                         dev_dbg(dev, "%s(%d):", __func__, bytes2write);
 386                         count += bytes2write;
 387                         rc = i2c_nuvoton_wait_for_stat(chip,
 388                                                        TPM_STS_VALID |
 389                                                        TPM_STS_EXPECT,
 390                                                        TPM_STS_VALID |
 391                                                        TPM_STS_EXPECT,
 392                                                        chip->vendor.timeout_c,
 393                                                        NULL);
 394                         if (rc < 0) {
 395                                 dev_err(dev, "%s() timeout on Expect\n",
 396                                         __func__);
 397                                 rc = -ETIMEDOUT;
 398                                 break;
 399                         }
 400                 }
 401                 if (rc < 0)
 402                         continue;
 403
 404                 /* write last byte */
 405                 rc = i2c_nuvoton_write_buf(client, TPM_DATA_FIFO_W, 1,
 406                                            &buf[count]);
 407                 if (rc < 0) {
 408                         dev_err(dev, "%s() fail to write last byte\n",
 409                                 __func__);
 410                         rc = -EIO;
 411                         continue;
 412                 }
 413                 dev_dbg(dev, "%s(last): %02x", __func__, buf[count]);
 414                 rc = i2c_nuvoton_wait_for_stat(chip,
 415                                                TPM_STS_VALID | TPM_STS_EXPECT,
 416                                                TPM_STS_VALID,
 417                                                chip->vendor.timeout_c, NULL);
 418                 if (rc) {
 419                         dev_err(dev, "%s() timeout on Expect to clear\n",
 420                                 __func__);
 421                         rc = -ETIMEDOUT;
 422                         continue;
 423                 }
 424                 break;
 425         }
 426         if (rc < 0) {
 427                 /* retries == TPM_RETRY */
 428                 i2c_nuvoton_ready(chip);
 429                 return rc;
 430         }
 431         /* execute the TPM command */
 432         rc = i2c_nuvoton_write_status(client, TPM_STS_GO);
 433         if (rc < 0) {
 434                 dev_err(dev, "%s() fail to write Go\n", __func__);
 435                 i2c_nuvoton_ready(chip);
 436                 return rc;
 437         }
 438         ordinal = be32_to_cpu(*((__be32 *) (buf + 6)));
 439         rc = i2c_nuvoton_wait_for_data_avail(chip,
 440                                              tpm_calc_ordinal_duration(chip,
 441                                                                        ordinal),
 442                                              &chip->vendor.read_queue);
 443         if (rc) {
 444                 dev_err(dev, "%s() timeout command duration\n", __func__);
 445                 i2c_nuvoton_ready(chip);
 446                 return rc;
 447         }
 448
 449         dev_dbg(dev, "%s() -> %zd\n", __func__, len);
 450         return len;
 451 }
 452
 453 static bool i2c_nuvoton_req_canceled(struct tpm_chip *chip, u8 status)
 454 {
 455         return (status == TPM_STS_COMMAND_READY);
 456 }
 457
 458 static DEVICE_ATTR(pubek, S_IRUGO, tpm_show_pubek, NULL);
 459 static DEVICE_ATTR(pcrs, S_IRUGO, tpm_show_pcrs, NULL);
 460 static DEVICE_ATTR(enabled, S_IRUGO, tpm_show_enabled, NULL);
 461 static DEVICE_ATTR(active, S_IRUGO, tpm_show_active, NULL);
 462 static DEVICE_ATTR(owned, S_IRUGO, tpm_show_owned, NULL);
 463 static DEVICE_ATTR(temp_deactivated, S_IRUGO, tpm_show_temp_deactivated, NULL);
 464 static DEVICE_ATTR(caps, S_IRUGO, tpm_show_caps, NULL);
 465 static DEVICE_ATTR(cancel, S_IWUSR | S_IWGRP, NULL, tpm_store_cancel);
 466 static DEVICE_ATTR(durations, S_IRUGO, tpm_show_durations, NULL);
 467 static DEVICE_ATTR(timeouts, S_IRUGO, tpm_show_timeouts, NULL);
 468
 469 static struct attribute *i2c_nuvoton_attrs[] = {
 470         &dev_attr_pubek.attr,
 471         &dev_attr_pcrs.attr,
 472         &dev_attr_enabled.attr,
 473         &dev_attr_active.attr,
 474         &dev_attr_owned.attr,
 475         &dev_attr_temp_deactivated.attr,
 476         &dev_attr_caps.attr,
 477         &dev_attr_cancel.attr,
 478         &dev_attr_durations.attr,
 479         &dev_attr_timeouts.attr,
 480         NULL,
 481 };
 482
 483 static struct attribute_group i2c_nuvoton_attr_grp = {
 484         .attrs = i2c_nuvoton_attrs
 485 };
 486
 487 static const struct tpm_vendor_specific tpm_i2c = {
 488         .status = i2c_nuvoton_read_status,
 489         .recv = i2c_nuvoton_recv,
 490         .send = i2c_nuvoton_send,
 491         .cancel = i2c_nuvoton_ready,
 492         .req_complete_mask = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 493         .req_complete_val = TPM_STS_DATA_AVAIL | TPM_STS_VALID,
 494         .req_canceled = i2c_nuvoton_req_canceled,
 495         .attr_group = &i2c_nuvoton_attr_grp,
 496 };
 497
 498 /* The only purpose for the handler is to signal to any waiting threads that
 499  * the interrupt is currently being asserted. The driver does not do any
 500  * processing triggered by interrupts, and the chip provides no way to mask at
 501  * the source (plus that would be slow over I2C). Run the IRQ as a one-shot,
 502  * this means it cannot be shared. */
 503 static irqreturn_t i2c_nuvoton_int_handler(int dummy, void *dev_id)
 504 {
 505         struct tpm_chip *chip = dev_id;
 506         struct priv_data *priv = chip->vendor.priv;
 507
 508         priv->intrs++;
 509         wake_up(&chip->vendor.read_queue);
 510         disable_irq_nosync(chip->vendor.irq);
 511         return IRQ_HANDLED;
 512 }
 513
 514 static int get_vid(struct i2c_client *client, u32 *res)
 515 {
 516         static const u8 vid_did_rid_value[] = { 0x50, 0x10, 0xfe };
 517         u32 temp;
 518         s32 rc;
 519
 520         if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 521                 return -ENODEV;
 522         rc = i2c_nuvoton_read_buf(client, TPM_VID_DID_RID, 4, (u8 *)&temp);
 523         if (rc < 0)
 524                 return rc;
 525
 526         /* check WPCT301 values - ignore RID */
 527         if (memcmp(&temp, vid_did_rid_value, sizeof(vid_did_rid_value))) {
 528                 /*
 529                  * f/w rev 2.81 has an issue where the VID_DID_RID is not
 530                  * reporting the right value. so give it another chance at
 531                  * offset 0x20 (FIFO_W).
 532                  */
 533                 rc = i2c_nuvoton_read_buf(client, TPM_DATA_FIFO_W, 4,
 534                                           (u8 *) (&temp));
 535                 if (rc < 0)
 536                         return rc;
 537
 538                 /* check WPCT301 values - ignore RID */
 539                 if (memcmp(&temp, vid_did_rid_value,
 540                            sizeof(vid_did_rid_value)))
 541                         return -ENODEV;
 542         }
 543
 544         *res = temp;
 545         return 0;
 546 }
 547
 548 static int i2c_nuvoton_probe(struct i2c_client *client,
 549                              const struct i2c_device_id *id)
 550 {
 551         int rc;
 552         struct tpm_chip *chip;
 553         struct device *dev = &client->dev;
 554         u32 vid = 0;
 555
 556         rc = get_vid(client, &vid);
 557         if (rc)
 558                 return rc;
 559
 560         dev_info(dev, "VID: %04X DID: %02X RID: %02X\n", (u16) vid,
 561                  (u8) (vid >> 16), (u8) (vid >> 24));
 562
 563         chip = tpm_register_hardware(dev, &tpm_i2c);
 564         if (!chip) {
 565                 dev_err(dev, "%s() error in tpm_register_hardware\n", __func__);
 566                 return -ENODEV;
 567         }
 568
 569         chip->vendor.priv = devm_kzalloc(dev, sizeof(struct priv_data),
 570                                          GFP_KERNEL);
 571         init_waitqueue_head(&chip->vendor.read_queue);
 572         init_waitqueue_head(&chip->vendor.int_queue);
 573
 574         /* Default timeouts */
 575         chip->vendor.timeout_a = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
 576         chip->vendor.timeout_b = msecs_to_jiffies(TPM_I2C_LONG_TIMEOUT);
 577         chip->vendor.timeout_c = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
 578         chip->vendor.timeout_d = msecs_to_jiffies(TPM_I2C_SHORT_TIMEOUT);
 579
 580         /*
 581          * I2C intfcaps (interrupt capabilitieis) in the chip are hard coded to:
 582          *   TPM_INTF_INT_LEVEL_LOW | TPM_INTF_DATA_AVAIL_INT
 583          * The IRQ should be set in the i2c_board_info (which is done
 584          * automatically in of_i2c_register_devices, for device tree users */
 585         chip->vendor.irq = client->irq;
 586
 587         if (chip->vendor.irq) {
 588                 dev_dbg(dev, "%s() chip-vendor.irq\n", __func__);
 589                 rc = devm_request_irq(dev, chip->vendor.irq,
 590                                       i2c_nuvoton_int_handler,
 591                                       IRQF_TRIGGER_LOW,
 592                                       chip->vendor.miscdev.name,
 593                                       chip);
 594                 if (rc) {
 595                         dev_err(dev, "%s() Unable to request irq: %d for use\n",
 596                                 __func__, chip->vendor.irq);
 597                         chip->vendor.irq = 0;
 598                 } else {
 599                         /* Clear any pending interrupt */
 600                         i2c_nuvoton_ready(chip);
 601                         /* - wait for TPM_STS==0xA0 (stsValid, commandReady) */
 602                         rc = i2c_nuvoton_wait_for_stat(chip,
 603                                                        TPM_STS_COMMAND_READY,
 604                                                        TPM_STS_COMMAND_READY,
 605                                                        chip->vendor.timeout_b,
 606                                                        NULL);
 607                         if (rc == 0) {
 608                                 /*
 609                                  * TIS is in ready state
 610                                  * write dummy byte to enter reception state
 611                                  * TPM_DATA_FIFO_W <- rc (0)
 612                                  */
 613                                 rc = i2c_nuvoton_write_buf(client,
 614                                                            TPM_DATA_FIFO_W,
 615                                                            1, (u8 *) (&rc));
 616                                 if (rc < 0)
 617                                         goto out_err;
 618                                 /* TPM_STS <- 0x40 (commandReady) */
 619                                 i2c_nuvoton_ready(chip);
 620                         } else {
 621                                 /*
 622                                  * timeout_b reached - command was
 623                                  * aborted. TIS should now be in idle state -
 624                                  * only TPM_STS_VALID should be set
 625                                  */
 626                                 if (i2c_nuvoton_read_status(chip) !=
 627                                     TPM_STS_VALID) {
 628                                         rc = -EIO;
 629                                         goto out_err;
 630                                 }
 631                         }
 632                 }
 633         }
 634
 635         if (tpm_get_timeouts(chip)) {
 636                 rc = -ENODEV;
 637                 goto out_err;
 638         }
 639
 640         if (tpm_do_selftest(chip)) {
 641                 rc = -ENODEV;
 642                 goto out_err;
 643         }
 644
 645         return 0;
 646
 647 out_err:
 648         tpm_dev_vendor_release(chip);
 649         tpm_remove_hardware(chip->dev);
 650         return rc;
 651 }
 652
 653 static int i2c_nuvoton_remove(struct i2c_client *client)
 654 {
 655         struct device *dev = &(client->dev);
 656         struct tpm_chip *chip = dev_get_drvdata(dev);
 657
 658         if (chip)
 659                 tpm_dev_vendor_release(chip);
 660         tpm_remove_hardware(dev);
 661         kfree(chip);
 662         return 0;
 663 }
 664
 665
 666 static const struct i2c_device_id i2c_nuvoton_id[] = {
 667         {I2C_DRIVER_NAME, 0},
 668         {}
 669 };
 670 MODULE_DEVICE_TABLE(i2c, i2c_nuvoton_id);
 671
 672 #ifdef CONFIG_OF
 673 static const struct of_device_id i2c_nuvoton_of_match[] = {
 674         {.compatible = "nuvoton,npct501"},
 675         {.compatible = "winbond,wpct301"},
 676         {},
 677 };
 678 MODULE_DEVICE_TABLE(of, i2c_nuvoton_of_match);
 679 #endif
 680
 681 static SIMPLE_DEV_PM_OPS(i2c_nuvoton_pm_ops, tpm_pm_suspend, tpm_pm_resume);
 682
 683 static struct i2c_driver i2c_nuvoton_driver = {
 684         .id_table = i2c_nuvoton_id,
 685         .probe = i2c_nuvoton_probe,
 686         .remove = i2c_nuvoton_remove,
 687         .driver = {
 688                 .name = I2C_DRIVER_NAME,
 689                 .owner = THIS_MODULE,
 690                 .pm = &i2c_nuvoton_pm_ops,
 691                 .of_match_table = of_match_ptr(i2c_nuvoton_of_match),
 692         },
 693 };
 694
 695 module_i2c_driver(i2c_nuvoton_driver);
 696
 697 MODULE_AUTHOR("Dan Morav (dan.morav@nuvoton.com)");
 698 MODULE_DESCRIPTION("Nuvoton TPM I2C Driver");
 699 MODULE_LICENSE("GPL");