Re: [PATCH 1/1] TPM: STMicroelectronics st33 driver SPI

Kent Yoder
2013-05-06T19:15:06Z

Hi Mathias,

On Mon, May 06, 2013 at 01:14:44PM +0200, Matthias Leblanc wrote:
> From: Mathias Leblanc <mathias.leblanc@st.com>
>
> * STMicroelectronics version 1.2.0, Copyright (C) 2010
> * STMicroelectronics comes with ABSOLUTELY NO WARRANTY.
> * This is free software, and you are welcome to redistribute it
> * under certain conditions.
>
> This is the driver for TPM chip from ST Microelectronics.
>
> If you have a TPM security chip from STMicroelectronics working with
> an SPI, in menuconfig or .config choose the tpm driver on
> device --> tpm and activate the protocol of your choice before compiling
> the kernel.
> The driver will be accessible from within Linux.
>
> Tested on linux x86/x64 and beagleboard REV B & XM REV C
>
> Signed-off-by: Mathias Leblanc <mathias.leblanc@st.com>
> ---

As Peter mentioned, please provide a changelog, it makes the
maintainer very happy.

> drivers/char/tpm/Kconfig | 10 +
> drivers/char/tpm/Makefile | 1 +
> drivers/char/tpm/tpm_spi_stm_st33.c | 956 +++++++++++++++++++++++++++++++++++
> drivers/char/tpm/tpm_spi_stm_st33.h | 86 ++++
> 4 files changed, 1053 insertions(+), 0 deletions(-)
> create mode 100644 drivers/char/tpm/tpm_spi_stm_st33.c
> create mode 100644 drivers/char/tpm/tpm_spi_stm_st33.h
>
> diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig
> index dbfd564..2fc1254 100644
> --- a/drivers/char/tpm/Kconfig
> +++ b/drivers/char/tpm/Kconfig
> @@ -91,4 +91,14 @@ config TCG_ST33_I2C
> To compile this driver as a module, choose M here; the module will be
> called tpm_stm_st33_i2c.
>
> +config TCG_ST33_SPI
> + tristate "STMicroelectronics ST33 SPI"
> + depends on SPI
> + depends on GPIOLIB
> + ---help---
> + If you have a TPM security chip from STMicroelectronics working with
> + an SPI bus say Yes and it will be accessible from within Linux.
> + To compile this driver as a module, choose M here; the module will be
> + called tpm_stm_st33_spi.
> +
> endif # TCG_TPM
> diff --git a/drivers/char/tpm/Makefile b/drivers/char/tpm/Makefile
> index a3736c9..a1db3dd 100644
> --- a/drivers/char/tpm/Makefile
> +++ b/drivers/char/tpm/Makefile
> @@ -18,3 +18,4 @@ obj-$(CONFIG_TCG_ATMEL) += tpm_atmel.o
> obj-$(CONFIG_TCG_INFINEON) += tpm_infineon.o
> obj-$(CONFIG_TCG_IBMVTPM) += tpm_ibmvtpm.o
> obj-$(CONFIG_TCG_ST33_I2C) += tpm_i2c_stm_st33.o
> +obj-$(CONFIG_TCG_ST33_SPI) += tpm_spi_stm_st33.o
> diff --git a/drivers/char/tpm/tpm_spi_stm_st33.c b/drivers/char/tpm/tpm_spi_stm_st33.c
> new file mode 100644
> index 0000000..f1bac19
> --- /dev/null
> +++ b/drivers/char/tpm/tpm_spi_stm_st33.c
> @@ -0,0 +1,954 @@

Something is weird with this patch -- if you count down 954 lines,
that chops the last 2 lines of this patch hunk (last 2 lines of
tpm_spi_stm_st33.c). The only reason I noticed this was that the
compile complained that there was no MODULE_LICENSE() in the file.

> +/*
> + * STMicroelectronics TPM SPI Linux driver for TPM ST33ZP24
> + * Copyright (C) 2009, 2010 STMicroelectronics
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License along
> + * with this program; if not, write to the Free Software Foundation, Inc.,
> + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
> + *
> + * STMicroelectronics version 1.2.0, Copyright (C) 2010
> + * STMicroelectronics comes with ABSOLUTELY NO WARRANTY.
> + * This is free software, and you are welcome to redistribute it
> + * under certain conditions.
> + *
> + * @Author: Christophe RICARD tpmsupport@st.com
> + *
> + * @File: tpm_stm_st33_spi.c
> + *
> + * @Synopsis:
> + * 09/15/2010: First shot driver tpm_tis driver for lpc is
> + * used as model.
> + */
> +
> +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

Still here, still unused.

> +
> +#include <linux/module.h>
> +#include <linux/kernel.h>
> +#include <linux/delay.h>
> +#include <linux/init.h>
> +#include <linux/spi/spi.h>
> +#include <linux/wait.h>
> +#include <linux/string.h>
> +#include <linux/interrupt.h>
> +#include <linux/spinlock.h>
> +#include <linux/sysfs.h>
> +#include <linux/gpio.h>
> +#include <linux/sched.h>
> +#include <linux/uaccess.h>
> +#include <linux/io.h>
> +#include <linux/slab.h>
> +#include <linux/sched.h>
> +
> +#include "tpm.h"
> +
> +#include "tpm_spi_stm_st33.h"
> +
> +enum stm33zp24_access {
> + TPM_ACCESS_VALID = 0x80,
> + TPM_ACCESS_ACTIVE_LOCALITY = 0x20,
> + TPM_ACCESS_REQUEST_PENDING = 0x04,
> + TPM_ACCESS_REQUEST_USE = 0x02,
> +};
> +
> +enum stm33zp24_status {
> + TPM_STS_VALID = 0x80,
> + TPM_STS_COMMAND_READY = 0x40,
> + TPM_STS_GO = 0x20,
> + TPM_STS_DATA_AVAIL = 0x10,
> + TPM_STS_DATA_EXPECT = 0x08,
> +};
> +
> +enum stm33zp24_int_flags {
> + TPM_GLOBAL_INT_ENABLE = 0x80,
> + TPM_INTF_CMD_READY_INT = 0x080,
> + TPM_INTF_FIFO_AVALAIBLE_INT = 0x040,
> + TPM_INTF_WAKE_UP_READY_INT = 0x020,
> + TPM_INTF_LOC4SOFTRELEASE_INT = 0x008,
> + TPM_INTF_LOCALITY_CHANGE_INT = 0x004,
> + TPM_INTF_STS_VALID_INT = 0x002,
> + TPM_INTF_DATA_AVAIL_INT = 0x001,
> +};
> +
> +enum tis_defaults {
> + TIS_SHORT_TIMEOUT = 750, /* ms */
> + TIS_LONG_TIMEOUT = 2000, /* 2 sec */
> +};
> +
> +
> +static inline int spi_read_write(struct spi_device *spi,
> + struct spi_transfer xfer) {
> + struct spi_message msg;
> + spi_message_init(&msg);
> + spi_message_add_tail(&xfer, &msg);
> + return spi_sync(spi, &msg);
> +}
> +
> +/*
> + * spi_write8_reg
> + * Send byte to the TIS register according to the ST33ZP24 SPI protocol.
> + * @param: tpm, the chip description
> + * @param: tpm_register, the tpm tis register where the data should be written
> + * @param: tpm_data, the tpm_data to write inside the tpm_register
> + * @param: tpm_size, The length of the data
> + * @return: should be zero if success else a negative error code.
> + */
> +static int spi_write8_reg(struct tpm_chip *tpm, u8 tpm_register,
> + u8 *tpm_data, u16 tpm_size)
> +{
> + u8 data;
> + int total_length = 0, nbr_dummy_bytes;
> + int value = 0;
> + struct spi_device *dev = (struct spi_device *)tpm->vendor.iobase;
> + struct st33zp24_platform_data *platform_data = dev->dev.platform_data;
> + u8 *data_buffer = platform_data->tpm_spi_buffer[0];
> + struct spi_transfer xfer = {
> + .tx_buf = data_buffer,
> + .rx_buf = platform_data->tpm_spi_buffer[1],
> + };
> +
> + u8 latency = platform_data->latency + tpm_size + 1;
> +
> + /* Pre-Header */
> + data = TPM_WRITE_DIRECTION | tpm->vendor.locality;
> + memcpy(data_buffer + total_length, &data, sizeof(data));
> + total_length++;
> + data = tpm_register;
> + memcpy(data_buffer + total_length, &data, sizeof(data));
> + total_length++;
> +
> + if (tpm_size > 0 &&
> + (tpm_register == TPM_DATA_FIFO ||
> + tpm_register == TPM_HASH_DATA)) {
> + data = (tpm_size >> 8) & 0x00ff;
> + data_buffer[total_length++] = data;
> + data = tpm_size & 0x00ff;
> + data_buffer[total_length++] = data;
> + latency -= 2;
> + }
> +
> + memcpy(&data_buffer[total_length], tpm_data, tpm_size);
> + total_length += tpm_size;
> +
> + nbr_dummy_bytes = platform_data->latency + 1;
> + memset(&data_buffer[total_length], TPM_DUMMY_BYTE,
> + platform_data->latency + 1);
> +
> + xfer.len = total_length;
> +
> + value = spi_read_write(dev, xfer);
> +
> + if (value == 0) {
> + nbr_dummy_bytes = total_length - 1 - nbr_dummy_bytes;
> + while (nbr_dummy_bytes < total_length &&
> + ((u8 *)xfer.rx_buf)[nbr_dummy_bytes] == 0)
> + nbr_dummy_bytes++;
> +
> + if (((u8 *)xfer.rx_buf)[nbr_dummy_bytes] != 0)
> + value = ((u8 *)xfer.rx_buf)[nbr_dummy_bytes];
> + }
> +
> + return value;
> +} /* spi_write8_reg() */
> +
> +/*
> + * spi_read8_reg
> + * Recv byte from the TIS register according to the ST33ZP24 SPI protocol.
> + * @param: tpm, the chip description
> + * @param: tpm_register, the tpm tis register where the data should be read
> + * @param: tpm_data, the TPM response
> + * @param: tpm_size, tpm TPM response size to read.
> + * @return: should be zero if success else a negative error code.
> + */
> +static u8 spi_read8_reg(struct tpm_chip *tpm, u8 tpm_register,
> + u8 *tpm_data, u16 tpm_size)
> +{
> + u8 data;
> + int total_length = 0, nbr_dummy_bytes;
> + int value = 0;
> + struct spi_device *dev = (struct spi_device *)tpm->vendor.iobase;
> + struct st33zp24_platform_data *platform_data = dev->dev.platform_data;
> + u8 *data_buffer = platform_data->tpm_spi_buffer[0];
> + struct spi_transfer xfer = {
> + .tx_buf = data_buffer,
> + .rx_buf = platform_data->tpm_spi_buffer[1],
> + };
> +
> + /* Pre-Header */
> +
> + data = tpm->vendor.locality;
> + memcpy(data_buffer + total_length, &data, sizeof(data));
> + total_length++;
> + data = tpm_register;
> + memcpy(data_buffer + total_length, &data, sizeof(data));
> + total_length++;
> +
> + nbr_dummy_bytes = platform_data->latency + 1;
> + memset(&data_buffer[total_length], TPM_DUMMY_BYTE,
> + platform_data->latency + 1);
> +
> + xfer.len = total_length;
> +
> + /* header + status byte + size of the data + status byte */
> + value = spi_read_write(dev, xfer);
> +
> + if (tpm_size > 0 && value == 0) {
> + nbr_dummy_bytes = 2;
> + for (; nbr_dummy_bytes < total_length &&
> + ((u8 *)xfer.rx_buf)[nbr_dummy_bytes] == 0;
> + nbr_dummy_bytes++)
> + ;
> +
> + if (nbr_dummy_bytes + 1 < total_length) {
> + value = ((u8 *)xfer.rx_buf)[nbr_dummy_bytes];
> +
> + if (tpm_size > 0)
> + memcpy(tpm_data, xfer.rx_buf +
> + nbr_dummy_bytes + 1,
> + tpm_size);
> + }
> + }
> + return value;
> +} /* spi_read8_reg() */
> +
> +/*
> + * clear_interruption
> + * clear the TPM interrupt register.
> + * @param: tpm, the chip description
> + */
> +static void clear_interruption(struct tpm_chip *tpm)
> +{
> + u8 interrupt;
> + spi_read8_reg(tpm, TPM_INT_STATUS, &interrupt, 1);
> + /* Clear interrupts handled with TPM_EOI */
> + spi_write8_reg(tpm, TPM_INT_STATUS, &interrupt, 1);
> + spi_read8_reg(tpm, TPM_INT_STATUS, &interrupt, 1);
> +} /* clear_interruption() */
> +
> +/*
> + * _wait_for_serirq_timeout
> + * @param: tpm, the chip description
> + * @param: timeout, the timeout of the interrupt
> + * @return: the status of the interruption.
> + */
> +unsigned long wait_for_serirq_timeout(struct tpm_chip *chip, bool condition,
> + unsigned long timeout)
> +{
> + unsigned long status;
> + struct spi_device *client;
> + struct st33zp24_platform_data *pin_infos;
> +
> + client = (struct spi_device *)chip->vendor.iobase;
> + pin_infos = client->dev.platform_data;
> +
> + status = wait_for_completion_interruptible_timeout(
> + &pin_infos->irq_detection, timeout);
> + if (status > 0)
> + enable_irq(gpio_to_irq(pin_infos->io_serirq));
> + gpio_direction_input(pin_infos->io_serirq);
> +
> + if (!status) {
> + status = -EBUSY;
> + goto wait_end;
> + }
> + clear_interruption(chip);
> + if (condition)
> + status = 1;
> +
> +wait_end:
> + return status;
> +}
> +
> +
> +/*
> + * tpm_stm_spi_cancel, cancel is not implemented.
> + * @param: chip, the tpm chip description as specified in
> + * driver/char/tpm/tpm.h.
> + */
> +static void tpm_stm_spi_cancel(struct tpm_chip *chip)
> +{
> + u8 data = TPM_STS_COMMAND_READY;
> +
> + /* this causes the current command to be aborted */
> + spi_write8_reg(chip, TPM_STS, &data, 1);
> +} /* tpm_stm_spi_cancel() */
> +
> +/*
> + * tpm_stm_spi_status return the TPM_STS register
> + * @param: chip, the tpm chip description
> + * @return: the TPM_STS register value.
> + */
> +static u8 tpm_stm_spi_status(struct tpm_chip *chip)
> +{
> + u8 data;
> +
> + spi_read8_reg(chip, TPM_STS, &data, 1);
> + return data;
> +} /* tpm_stm_spi_status() */
> +
> +
> +
> +/*
> + * check_locality if the locality is active
> + * @param: chip, the tpm chip description
> + * @return: the active locality or -EACCESS.
> + */
> +static int check_locality(struct tpm_chip *chip)
> +{
> + u8 data;
> + u8 status;
> +
> + status = spi_read8_reg(chip, TPM_ACCESS, &data, 1);
> + if (status && (data &
> + (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID)) ==
> + (TPM_ACCESS_ACTIVE_LOCALITY | TPM_ACCESS_VALID))
> + return chip->vendor.locality;
> +
> + return -EACCES;
> +} /* check_locality() */
> +
> +/*
> + * request_locality request the TPM locality
> + * @param: chip, the chip description
> + * @return: the active locality or EACCESS.
> + */
> +static int request_locality(struct tpm_chip *chip)
> +{
> + unsigned long stop;
> + long rc;
> + u8 data;
> +
> + /* Check locality */
> + if (check_locality(chip) == chip->vendor.locality)
> + return chip->vendor.locality;
> +
> + /* Request locality */
> + data = TPM_ACCESS_REQUEST_USE;
> + rc = spi_write8_reg(chip, TPM_ACCESS, &data, 1);
> + if (rc < 0)
> + goto end;
> +
> + /* wait for burstcount */
> + if (chip->vendor.irq) {
> + rc = wait_for_serirq_timeout(chip, (check_locality
> + (chip) >= 0),
> + chip->vendor.timeout_a);
> + if (rc > 0)
> + return chip->vendor.locality;
> + } else {
> + stop = jiffies + chip->vendor.timeout_a;
> + do {
> + if (check_locality(chip) >= 0)
> + return chip->vendor.locality;
> + msleep(TPM_TIMEOUT);
> + } while (time_before(jiffies, stop));
> + }
> +end:
> + return -EACCES;
> +} /* request_locality() */
> +
> +/*
> + * release_locality release the active locality
> + * @param: chip, the tpm chip description.
> + */
> +static void release_locality(struct tpm_chip *chip)
> +{
> + u8 data;
> +
> + data = TPM_ACCESS_ACTIVE_LOCALITY;
> + spi_write8_reg(chip, TPM_ACCESS, &data, 1);
> +} /* release_locality()*/
> +
> +/*
> + * get_burstcount return the burstcount address 0x19 0x1A
> + * @param: chip, the chip description
> + * return: the burstcount.
> + */
> +static int get_burstcount(struct tpm_chip *chip)
> +{
> + unsigned long stop;
> + u32 burstcnt, status;
> + u8 tpm_reg, temp;
> +
> + /* wait for burstcount */
> + /* which timeout value, spec has 2 answers (c & d) */
> + stop = jiffies + chip->vendor.timeout_d;
> + do {
> + tpm_reg = TPM_STS + 1;
> + status = spi_read8_reg(chip, tpm_reg, &temp, 1);
> + if (status < 0)
> + goto end;
> +
> + tpm_reg = tpm_reg + 1;
> + burstcnt = temp;
> + status = spi_read8_reg(chip, tpm_reg, &temp, 1);
> + if (status < 0)
> + goto end;
> +
> + burstcnt |= temp << 8;
> + if (burstcnt)
> + return burstcnt;
> + msleep(TPM_TIMEOUT);
> + } while (time_before(jiffies, stop));
> +
> +end:
> + return -EBUSY;
> +} /* get_burstcount() */
> +
> +/*
> + * wait_for_stat wait for a TPM_STS value
> + * @param: chip, the tpm chip description
> + * @param: mask, the value mask to wait
> + * @param: timeout, the timeout
> + * @param: queue, the wait queue.
> + * @return: the tpm status, 0 if success, -ETIME if timeout is reached.
> + */
> +static int wait_for_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
> + wait_queue_head_t *queue)
> +{
> + unsigned long stop;
> + long rc;
> + u8 status;
> +
> + /* check current status */
> + status = tpm_stm_spi_status(chip);
> + if (!chip->vendor.irq && (status & mask) == mask)
> + return 0;
> +
> + if (chip->vendor.irq) {
> + rc = wait_for_serirq_timeout(chip, ((tpm_stm_spi_status
> + (chip) & mask) ==
> + mask), timeout);
> + if (rc > 0)
> + return 0;
> + } else {
> + stop = jiffies + timeout;
> + do {
> + msleep(TPM_TIMEOUT);
> + status = tpm_stm_spi_status(chip);
> + if ((status & mask) == mask)
> + return 0;
> + } while (time_before(jiffies, stop));
> + }
> + return -ETIME;
> +} /* wait_for_stat() */
> +
> +/*
> + * recv_data receive data
> + * @param: chip, the tpm chip description
> + * @param: buf, the buffer where the data are received
> + * @param: count, the number of data to receive
> + * @return: the tpm status, 0 if success, -ETIME if timeout is reached.
> + */
> +static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count)
> +{
> + u32 size = 0, burstcnt, status, len;
> +
> + while (size < count &&
> + wait_for_stat(chip,
> + TPM_STS_DATA_AVAIL | TPM_STS_VALID,
> + chip->vendor.timeout_c,
> + &chip->vendor.read_queue)
> + == 0) {
> + burstcnt = get_burstcount(chip);
> + len = min_t(int, burstcnt, count - size);
> + status = spi_read8_reg(chip, TPM_DATA_FIFO, buf + size, len);
> + if (status < 0)
> + return status;
> +
> +
> + size += len;
> + }
> + return size;
> +}
> +
> +/*
> + * tpm_ioserirq_handler the serirq irq handler
> + * @param: irq, the tpm chip description
> + * @param: dev_id, the description of the chip
> + * @return: the status of the handler.
> + */
> +static irqreturn_t tpm_ioserirq_handler(int irq, void *dev_id)
> +{
> + struct tpm_chip *chip = dev_id;
> + struct spi_device *client;
> + struct st33zp24_platform_data *pin_infos;
> +
> + disable_irq_nosync(irq);
> +
> + client = (struct spi_device *)chip->vendor.iobase;
> + pin_infos = client->dev.platform_data;
> +
> + complete(&pin_infos->irq_detection);
> + return IRQ_HANDLED;
> +} /* tpm_ioserirq_handler() */
> +
> +/*
> + * tpm_stm_spi_send send TPM commands through the SPI bus.
> + * @param: chip, the tpm chip description
> + * @param: buf, the tpm command buffer
> + * @param: len, the tpm command size
> + * @return: should be zero if success else the negative error code.
> + */
> +static int tpm_stm_spi_send(struct tpm_chip *chip, unsigned char *buf,
> + size_t len)
> +{
> + u32 ret = 0, status, burstcnt = 0, i, size = 0;
> + u8 data;
> +
> + if (chip == NULL)
> + return -EBUSY;
> + if (len < TPM_HEADER_SIZE)
> + return -EBUSY;
> +
> + ret = request_locality(chip);
> + if (ret < 0)
> + return ret;
> +
> + status = tpm_stm_spi_status(chip);
> + if ((status & TPM_STS_COMMAND_READY) == 0) {
> + tpm_stm_spi_cancel(chip);
> + if (wait_for_stat
> + (chip, TPM_STS_COMMAND_READY, chip->vendor.timeout_b,
> + &chip->vendor.int_queue) < 0) {
> + ret = -ETIME;
> + goto out_err;
> + }
> + }
> +
> + for (i = 0; i < len - 1;) {
> + burstcnt = get_burstcount(chip);
> + size = min_t(int, len - i - 1, burstcnt);
> + ret = spi_write8_reg(chip, TPM_DATA_FIFO, buf, size);
> + if (ret < 0)
> + goto out_err;
> + i += size;
> + }
> +
> + status = tpm_stm_spi_status(chip);
> + if ((status & TPM_STS_DATA_EXPECT) == 0) {
> + ret = -EIO;
> + goto out_err;
> + }
> +
> + /* write last byte */
> + spi_write8_reg(chip, TPM_DATA_FIFO, buf + len - 1, 1);
> +
> + status = tpm_stm_spi_status(chip);
> + if ((status & TPM_STS_DATA_EXPECT) != 0) {
> + ret = -EIO;
> + goto out_err;
> + }
> +
> + /* go and do it */
> + data = TPM_STS_GO;
> + ret = spi_write8_reg(chip, TPM_STS, &data, 1);
> + if (ret < 0)
> + goto out_err;
> +
> + return len;
> +out_err:
> + tpm_stm_spi_cancel(chip);
> + release_locality(chip);
> + return ret;
> +}
> +
> +/*
> + * tpm_stm_spi_recv received TPM response through the SPI bus.
> + * @param: chip, the tpm chip description
> + * @param: buf, the tpm command buffer
> + * @param: len, the tpm command size
> +* @return: should be zero if success else the negative error code.
> + */
> +static int tpm_stm_spi_recv(struct tpm_chip *chip, unsigned char *buf,
> + size_t count)
> +{
> + int size = 0;
> + int expected;
> +
> + if (chip == NULL)
> + return -EBUSY;
> + if (count < TPM_HEADER_SIZE) {
> + size = -EIO;
> + goto out;
> + }
> +
> + size = recv_data(chip, buf, TPM_HEADER_SIZE);
> +
> + /* read first 10 bytes, including tag, paramsize, and result */
> + if (size < TPM_HEADER_SIZE) {
> + dev_err(chip->dev, "Unable to read header\n");
> + goto out;
> + }
> +
> + expected = be32_to_cpu(*(__be32 *)(buf + 2));
> + if (expected > count) {
> + size = -EIO;
> + goto out;
> + }
> +
> + size += recv_data(chip, &buf[TPM_HEADER_SIZE],
> + expected - TPM_HEADER_SIZE);
> + if (size < expected) {
> + dev_err(chip->dev, "Unable to read remainder of result\n");
> + size = -ETIME;
> + goto out;
> + }
> +
> +out:
> + chip->vendor.cancel(chip);
> + release_locality(chip);
> + return size;
> +}
> +
> +
> +static const struct file_operations tpm_st33_spi_fops = {
> + .owner = THIS_MODULE,
> + .llseek = no_llseek,
> + .read = tpm_read,
> + .write = tpm_write,
> + .open = tpm_open,
> + .release = tpm_release,
> +};
> +
> +static DEVICE_ATTR(pubek, S_IRUGO, tpm_show_pubek, NULL);
> +static DEVICE_ATTR(pcrs, S_IRUGO, tpm_show_pcrs, NULL);
> +static DEVICE_ATTR(enabled, S_IRUGO, tpm_show_enabled, NULL);
> +static DEVICE_ATTR(active, S_IRUGO, tpm_show_active, NULL);
> +static DEVICE_ATTR(owned, S_IRUGO, tpm_show_owned, NULL);
> +static DEVICE_ATTR(temp_deactivated, S_IRUGO, tpm_show_temp_deactivated, NULL);
> +static DEVICE_ATTR(caps, S_IRUGO, tpm_show_caps_1_2, NULL);
> +static DEVICE_ATTR(cancel, S_IWUSR | S_IWGRP, NULL, tpm_store_cancel);
> +
> +static struct attribute *stm_tpm_attrs[] = {
> + &dev_attr_pubek.attr,
> + &dev_attr_pcrs.attr,
> + &dev_attr_enabled.attr,
> + &dev_attr_active.attr,
> + &dev_attr_owned.attr,
> + &dev_attr_temp_deactivated.attr,
> + &dev_attr_caps.attr,
> + &dev_attr_cancel.attr, NULL,
> +};
> +
> +static struct attribute_group stm_tpm_attr_grp = {
> + .attrs = stm_tpm_attrs
> +};
> +
> +static struct tpm_vendor_specific st_spi_tpm = {
> + .send = tpm_stm_spi_send,
> + .recv = tpm_stm_spi_recv,
> + .cancel = tpm_stm_spi_cancel,
> + .status = tpm_stm_spi_status,
> + .attr_group = &stm_tpm_attr_grp,
> + .miscdev = {.fops = &tpm_st33_spi_fops,},
> +};
> +
> +static int evaluate_latency(struct tpm_chip *chip)
> +{
> + int latency = 0;
> + struct spi_device *dev = (struct spi_device *)chip->vendor.iobase;
> + struct st33zp24_platform_data *platform_data = dev->dev.platform_data;
> + int status = 0;
> + u8 data;
> +
> + for (; status == 0x00 && latency < MAX_SPI_LATENCY; latency++) {
> + platform_data->latency = latency;
> + status = spi_read8_reg(chip, TPM_INTF_CAPABILITY, &data, 1);
> + }
> + return latency - 1;
> +} /* evaluate_latency() */
> +
> +static int interrupts;
> +module_param(interrupts, int, 0444);
> +MODULE_PARM_DESC(interrupts, "Enable interrupts");
> +
> +static int power_mgt = 1;
> +module_param(power_mgt, int, 0444);
> +MODULE_PARM_DESC(power_mgt, "Power Management");
> +
> +/*
> + * tpm_st33_spi_probe initialize the TPM device
> + * @param: client, the spi_device drescription (TPM SPI description).
> + * @param: id, the spi_device_id struct.
> + * @return: 0 in case of success.
> + * -1 in other case.
> + */
> +static int
> +tpm_st33_spi_probe(struct spi_device *dev)
> +{
> + u32 err = 0;
> + u8 intmask;
> + struct tpm_chip *chip;
> + struct st33zp24_platform_data *platform_data;
> +
> + /* Check SPI platform functionnalities */
> + if (dev == NULL) {
> + pr_info("dev is NULL. exiting.\n");
> + err = -ENODEV;
> + goto end;
> + }
> +
> + chip = tpm_register_hardware(&dev->dev, &st_spi_tpm);
> + if (!chip) {
> + err = -ENODEV;
> + goto end;
> + }
> +
> + /* Allocation of SPI buffers MISO and MOSI */
> + /* Size is as follow: */
> + /* Request burstcount value = 0x800 = 2048 */
> + /* + */
> + /* Response burstcount value = 0x400 = 1024 */
> + /* + */
> + /* At least: */
> + /* 1 byte for direction/locality */
> + /* 1 byte tpm tis register */
> + /* 2 bytes spi data length (for request only) */
> + /* 2 latency bytes */
> + /* 1 status byte */
> + /* = 2048 + 1024 + 7 */
> + /* We reserved 2048 + 1024 + 20 in case latency byte */
> + /* change */
> + platform_data = dev->dev.platform_data;
> + platform_data->tpm_spi_buffer[0] =
> + kmalloc((TPM_BUFSIZE + (TPM_BUFSIZE / 2) +
> + TPM_DIGEST_SIZE) * sizeof(u8), GFP_KERNEL);
> + if (platform_data->tpm_spi_buffer[0] == NULL) {
> + err = -ENOMEM;
> + goto _tpm_clean_answer;
> + }
> + platform_data->tpm_spi_buffer[1] =
> + kmalloc((TPM_BUFSIZE + (TPM_BUFSIZE / 2) +
> + TPM_DIGEST_SIZE) * sizeof(u8) , GFP_KERNEL);
> + if (platform_data->tpm_spi_buffer[1] == NULL) {
> + err = -ENOMEM;
> + goto _tpm_clean_response;
> + }
> +
> + chip->vendor.iobase = dev;
> +
> + /* Default timeouts */
> + chip->vendor.timeout_a = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
> + chip->vendor.timeout_b = msecs_to_jiffies(TIS_LONG_TIMEOUT);
> + chip->vendor.timeout_c = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
> + chip->vendor.timeout_d = msecs_to_jiffies(TIS_SHORT_TIMEOUT);
> + chip->vendor.locality = LOCALITY0;
> +
> + if (power_mgt) {
> + err = gpio_request(platform_data->io_lpcpd, "TPM IO_LPCPD");
> + if (err)
> + goto _gpio_init1;
> + gpio_set_value(platform_data->io_lpcpd, 1);
> + }
> +
> + platform_data->latency = evaluate_latency(chip);
> + if (platform_data->latency <= 0x00) {
> + err = -ENODEV;
> + goto _gpio_init1;
> + }
> +
> + /* Enable interrupt */
> + /* Register GPIO pin through generic Linux GPIO API */
> + if (interrupts) {
> + init_completion(&platform_data->irq_detection);
> + if (request_locality(chip) != LOCALITY0) {
> + err = -ENODEV;
> + goto _tpm_clean_response;
> + }
> + err = gpio_request(platform_data->io_serirq, "TPM IO_SERIRQ");
> + if (err)
> + goto _gpio_init2;
> +
> + /* Clear all existing */
> + clear_interruption(chip);
> + err = request_irq(gpio_to_irq(platform_data->io_serirq),
> + &tpm_ioserirq_handler,
> + IRQF_TRIGGER_HIGH | IRQF_SHARED,
> + "TPM SERIRQ management", chip);
> + if (err < 0) {
> + pr_info("TPM SERIRQ signals %d not available\n",
> + gpio_to_irq(platform_data->io_serirq));
> + goto _irq_set;
> + }
> + err = spi_read8_reg(chip, TPM_INT_ENABLE, &intmask, 1);
> + if (err < 0)
> + goto _irq_set;
> +
> + intmask |= TPM_INTF_CMD_READY_INT
> + | TPM_INTF_FIFO_AVALAIBLE_INT
> + | TPM_INTF_WAKE_UP_READY_INT
> + | TPM_INTF_LOC4SOFTRELEASE_INT
> + | TPM_INTF_LOCALITY_CHANGE_INT
> + | TPM_INTF_STS_VALID_INT
> + | TPM_INTF_DATA_AVAIL_INT;
> +
> + err = spi_write8_reg(chip, TPM_INT_ENABLE, &intmask, 1);
> + if (err < 0)
> + goto _irq_set;
> +
> + intmask = TPM_GLOBAL_INT_ENABLE;
> + err = spi_write8_reg(chip, TPM_INT_ENABLE + 3, &intmask, 1);
> + if (err < 0)
> + goto _irq_set;
> +
> + err = spi_read8_reg(chip, TPM_INT_STATUS, &intmask, 1);
> + if (err < 0)
> + goto _irq_set;
> +
> + chip->vendor.irq = interrupts;
> +
> + tpm_gen_interrupt(chip);
> + }
> +
> + tpm_get_timeouts(chip);
> +
> + /* attach chip datas to client */
> + spi_set_drvdata(dev, chip);
> + platform_data->bchipf = false;
> +
> + pr_info("TPM SPI Initialized\n");
> + return 0;
> +_irq_set:
> + free_irq(gpio_to_irq(platform_data->io_serirq), chip);
> +_gpio_init2:
> + if (platform_data && interrupts)
> + gpio_free(platform_data->io_serirq);
> +_gpio_init1:
> + if (platform_data && power_mgt)
> + gpio_free(platform_data->io_lpcpd);
> +_tpm_clean_response:
> + tpm_remove_hardware(chip->dev);
> + if (platform_data->tpm_spi_buffer[1] != NULL) {
> + kfree(platform_data->tpm_spi_buffer[1]);
> + platform_data->tpm_spi_buffer[1] = NULL;
> + }
> +_tpm_clean_answer:
> + if (platform_data->tpm_spi_buffer[0] != NULL) {
> + kfree(platform_data->tpm_spi_buffer[0]);
> + platform_data->tpm_spi_buffer[0] = NULL;
> + }
> +
> + platform_data->bchipf = true;
> +end:
> + pr_info("TPM SPI initialisation fail\n");
> + return err;
> +}
> +
> +/*
> + * tpm_st33_spi_remove remove the TPM device
> + * @param: client, the spi_device drescription (TPM SPI description).
> + clear_bit(0, &chip->is_open);
> + * @return: 0 in case of success.
> + */
> +static int tpm_st33_spi_remove(struct spi_device *client)
> +{
> + struct tpm_chip *chip = (struct tpm_chip *)spi_get_drvdata(client);
> + struct st33zp24_platform_data *pin_infos =
> + ((struct spi_device *)chip->vendor.iobase)->dev.platform_data;
> +
> + if (pin_infos != NULL) {
> + gpio_free(pin_infos->io_lpcpd);
> +
> + /* Check if chip has been previously clean */
> + if (pin_infos->bchipf != true)
> + tpm_remove_hardware(chip->dev);
> + if (pin_infos->tpm_spi_buffer[1] != NULL) {
> + kfree(pin_infos->tpm_spi_buffer[1]);
> + pin_infos->tpm_spi_buffer[1] = NULL;
> + }
> + if (pin_infos->tpm_spi_buffer[0] != NULL) {
> + kfree(pin_infos->tpm_spi_buffer[0]);
> + pin_infos->tpm_spi_buffer[0] = NULL;
> + }
> + }
> +
> + return 0;
> +}
> +
> +#ifdef CONFIG_PM_SLEEP
> +/*
> + * tpm_st33_spi_pm_suspend suspend the TPM device
> + * Added: Work around when suspend and no tpm application is running, suspend
> + * may fail because chip->data_buffer is not set (only set in tpm_open in Linux
> + * TPM core)
> + * @return: 0 in case of success.
> + */
> +static int tpm_st33_spi_pm_suspend(struct device *dev)
> +{
> + struct tpm_chip *chip = dev_get_drvdata(dev);
> + struct st33zp24_platform_data *pin_infos = dev->platform_data;
> + int ret = 0;
> +
> + if (power_mgt) {
> + gpio_set_value(pin_infos->io_lpcpd, 0);
> + } else {
> + if (chip->data_buffer == NULL)
> + chip->data_buffer = pin_infos->tpm_spi_buffer[0];
> + ret = tpm_pm_suspend(dev);
> + }
> + return ret;
> +} /* tpm_st33_spi_suspend() */
> +
> +/*
> + * tpm_st33_spi_pm_resume resume the TPM device
> + * @param: spi, the spi_device drescription (TPM SPI description).
> + * @return: 0 in case of success.
> + */
> +static int tpm_st33_spi_pm_resume(struct device *dev)
> +{
> + struct tpm_chip *chip = dev_get_drvdata(dev);
> + struct st33zp24_platform_data *pin_infos = dev->platform_data;
> +
> + int ret = 0;
> + if (power_mgt) {
> + gpio_set_value(pin_infos->io_lpcpd, 1);
> + ret = wait_for_serirq_timeout(chip,
> + (chip->vendor.status(chip) &&
> + TPM_STS_VALID) == TPM_STS_VALID,
> + chip->vendor.timeout_b);
> + } else {
> + if (chip->data_buffer == NULL)
> + chip->data_buffer = pin_infos->tpm_spi_buffer[0];
> + ret = tpm_pm_resume(dev);
> + if (!ret)
> + tpm_do_selftest(chip);
> + }
> + return ret;
> +} /* tpm_st33_spi_pm_resume() */
> +#endif
> +
> +static SIMPLE_DEV_PM_OPS(tpm_st33_spi_ops, tpm_st33_spi_pm_suspend,
> + tpm_st33_spi_pm_resume);
> +static struct spi_driver tpm_st33_spi_driver = {
> + .driver = {
> + .owner = THIS_MODULE,
> + .name = TPM_ST33_SPI,
> + .pm = &tpm_st33_spi_ops,
> + },
> + .probe = tpm_st33_spi_probe,
> + .remove = tpm_st33_spi_remove,
> +};
> +
> +/*
> + * tpm_st33_spi_exit The kernel calls this function during unloading the
> + * module or during shut down process
> + */
> +static void __exit tpm_st33_spi_exit(void)
> +{
> + spi_unregister_driver(&tpm_st33_spi_driver);
> +}

CC [M] drivers/char/tpm/tpm_spi_stm_st33.o
drivers/char/tpm/tpm_spi_stm_st33.c:946:20: error: ‘tpm_st33_spi_exit’
defined but not used [-Werror=unused-function]

Kent

> +
> +module_spi_driver(tpm_st33_spi_driver);
> +
> +MODULE_AUTHOR("Christophe Ricard (tpmsupport@st.com)");
> +MODULE_DESCRIPTION("STM TPM SPI ST33 Driver");
> +MODULE_VERSION("1.2.0");
> +MODULE_LICENSE("GPL");
> diff --git a/drivers/char/tpm/tpm_spi_stm_st33.h b/drivers/char/tpm/tpm_spi_stm_st33.h
> new file mode 100644
> index 0000000..752158e
> --- /dev/null
> +++ b/drivers/char/tpm/tpm_spi_stm_st33.h
> @@ -0,0 +1,86 @@
> +/*
> + * STMicroelectronics TPM SPI Linux driver for TPM ST33NP18
> + * Copyright (C) 2009, 2010 STMicroelectronics
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License along
> + * with this program; if not, write to the Free Software Foundation, Inc.,
> + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
> + *
> + * STMicroelectronics version 1.2.0, Copyright (C) 2010
> + * STMicroelectronics comes with ABSOLUTELY NO WARRANTY.
> + * This is free software, and you are welcome to redistribute it
> + * under certain conditions.
> + *
> + * @Author: Christophe RICARD tpmsupport@st.com
> + *
> + * @File: tpm_spi_stm_st33.h
> + *
> + * @Date: 09/15/2010
> + */
> +#ifndef __STM_ST33_TPM_SPI_MAIN_H__
> +#define __STM_ST33_TPM_SPI_MAIN_H__
> +
> +#include <linux/pci.h>
> +#include <linux/module.h>
> +#include <linux/platform_device.h>
> +#include <linux/fs.h>
> +#include <linux/miscdevice.h>
> +
> +#define MINOR_NUM_SPI 224
> +
> +#define TPM_ACCESS (0x0)
> +#define TPM_STS (0x18)
> +#define TPM_HASH_END (0x20)
> +#define TPM_DATA_FIFO (0x24)
> +#define TPM_HASH_DATA (0x24)
> +#define TPM_HASH_START (0x28)
> +#define TPM_INTF_CAPABILITY (0x14)
> +#define TPM_INT_STATUS (0x10)
> +#define TPM_INT_ENABLE (0x08)
> +
> +#define TPM_DUMMY_BYTE 0x00
> +#define TPM_WRITE_DIRECTION 0x80
> +#define TPM_HEADER_SIZE 10
> +#define TPM_BUFSIZE 2048
> +
> +/* ioctl commands */
> +#define TPMIOC_CANCEL _IO('T', 0x00)
> +#define TPMIOC_TRANSMIT _IO('T', 0x01)
> +#define TPMIOC_HASH _IO('T', 0x02)
> +#define TPMIOC_CHANGELOCALITY _IO('T', 0x03)
> +
> +#define LOCALITY0 0
> +#define LOCALITY4 4
> +
> +#define TPM_ST_SPI_OK 0x5A
> +
> +
> +#define MAX_SPI_LATENCY 15
> +
> +#define TPM_ST33_SPI "st33zp24_spi"
> +
> +struct st33zp24_platform_data {
> + int io_serirq;
> + int io_lpcpd;
> + int latency;
> + bool bchipf;
> + u8 *tpm_spi_buffer[2]; /* 0 Request 1 Response */
> + struct completion irq_detection;
> +};
> +
> +struct st_tpm_hash_t {
> + int size;
> + u8 *data;
> +};

Please remove everything that's unused here. The ioctl stuff,
st_tpm_hash_t, LOCALITY4, etc.

Thanks,
Kent

> +
> +#endif /* __STM_ST33_TPM_SPI_MAIN_H__ */
> --
> 1.7.1
>