Commit f04510f2 authored by Sohaib Mohamed's avatar Sohaib Mohamed Committed by Jarkko Sakkinen

tpm/st33zp24: drop unneeded over-commenting

Remove parameter descriptions from all static functions.
Remove the comment altogether that does not tell what the function does.
Suggested-by: default avatarJarkko Sakkinen <jarkko@kernel.org>
Signed-off-by: default avatarSohaib Mohamed <sohaib.amhmd@gmail.com>
Reviewed-by: default avatarJarkko Sakkinen <jarkko@kernel.org>
Signed-off-by: default avatarJarkko Sakkinen <jarkko@kernel.org>
parent 0ef333f5
...@@ -61,9 +61,7 @@ enum tis_defaults { ...@@ -61,9 +61,7 @@ enum tis_defaults {
}; };
/* /*
* clear_interruption clear the pending interrupt. * clear the pending interrupt.
* @param: tpm_dev, the tpm device device.
* @return: the interrupt status value.
*/ */
static u8 clear_interruption(struct st33zp24_dev *tpm_dev) static u8 clear_interruption(struct st33zp24_dev *tpm_dev)
{ {
...@@ -72,12 +70,10 @@ static u8 clear_interruption(struct st33zp24_dev *tpm_dev) ...@@ -72,12 +70,10 @@ static u8 clear_interruption(struct st33zp24_dev *tpm_dev)
tpm_dev->ops->recv(tpm_dev->phy_id, TPM_INT_STATUS, &interrupt, 1); tpm_dev->ops->recv(tpm_dev->phy_id, TPM_INT_STATUS, &interrupt, 1);
tpm_dev->ops->send(tpm_dev->phy_id, TPM_INT_STATUS, &interrupt, 1); tpm_dev->ops->send(tpm_dev->phy_id, TPM_INT_STATUS, &interrupt, 1);
return interrupt; return interrupt;
} /* clear_interruption() */ }
/* /*
* st33zp24_cancel, cancel the current command execution or * cancel the current command execution or set STS to COMMAND READY.
* set STS to COMMAND READY.
* @param: chip, the tpm_chip description as specified in driver/char/tpm/tpm.h
*/ */
static void st33zp24_cancel(struct tpm_chip *chip) static void st33zp24_cancel(struct tpm_chip *chip)
{ {
...@@ -86,12 +82,10 @@ static void st33zp24_cancel(struct tpm_chip *chip) ...@@ -86,12 +82,10 @@ static void st33zp24_cancel(struct tpm_chip *chip)
data = TPM_STS_COMMAND_READY; data = TPM_STS_COMMAND_READY;
tpm_dev->ops->send(tpm_dev->phy_id, TPM_STS, &data, 1); tpm_dev->ops->send(tpm_dev->phy_id, TPM_STS, &data, 1);
} /* st33zp24_cancel() */ }
/* /*
* st33zp24_status return the TPM_STS register * return the TPM_STS register
* @param: chip, the tpm chip description
* @return: the TPM_STS register value.
*/ */
static u8 st33zp24_status(struct tpm_chip *chip) static u8 st33zp24_status(struct tpm_chip *chip)
{ {
...@@ -100,12 +94,10 @@ static u8 st33zp24_status(struct tpm_chip *chip) ...@@ -100,12 +94,10 @@ static u8 st33zp24_status(struct tpm_chip *chip)
tpm_dev->ops->recv(tpm_dev->phy_id, TPM_STS, &data, 1); tpm_dev->ops->recv(tpm_dev->phy_id, TPM_STS, &data, 1);
return data; return data;
} /* st33zp24_status() */ }
/* /*
* check_locality if the locality is active * if the locality is active
* @param: chip, the tpm chip description
* @return: true if LOCALITY0 is active, otherwise false
*/ */
static bool check_locality(struct tpm_chip *chip) static bool check_locality(struct tpm_chip *chip)
{ {
...@@ -120,13 +112,8 @@ static bool check_locality(struct tpm_chip *chip) ...@@ -120,13 +112,8 @@ static bool check_locality(struct tpm_chip *chip)
return true; return true;
return false; return false;
} /* check_locality() */ }
/*
* request_locality request the TPM locality
* @param: chip, the chip description
* @return: the active locality or negative value.
*/
static int request_locality(struct tpm_chip *chip) static int request_locality(struct tpm_chip *chip)
{ {
struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev); struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev);
...@@ -153,12 +140,8 @@ static int request_locality(struct tpm_chip *chip) ...@@ -153,12 +140,8 @@ static int request_locality(struct tpm_chip *chip)
/* could not get locality */ /* could not get locality */
return -EACCES; return -EACCES;
} /* request_locality() */ }
/*
* release_locality release the active locality
* @param: chip, the tpm chip description.
*/
static void release_locality(struct tpm_chip *chip) static void release_locality(struct tpm_chip *chip)
{ {
struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev); struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev);
...@@ -171,8 +154,6 @@ static void release_locality(struct tpm_chip *chip) ...@@ -171,8 +154,6 @@ static void release_locality(struct tpm_chip *chip)
/* /*
* get_burstcount return the burstcount value * get_burstcount return the burstcount value
* @param: chip, the chip description
* return: the burstcount or negative value.
*/ */
static int get_burstcount(struct tpm_chip *chip) static int get_burstcount(struct tpm_chip *chip)
{ {
...@@ -200,18 +181,8 @@ static int get_burstcount(struct tpm_chip *chip) ...@@ -200,18 +181,8 @@ static int get_burstcount(struct tpm_chip *chip)
msleep(TPM_TIMEOUT); msleep(TPM_TIMEOUT);
} while (time_before(jiffies, stop)); } while (time_before(jiffies, stop));
return -EBUSY; return -EBUSY;
} /* get_burstcount() */ }
/*
* wait_for_tpm_stat_cond
* @param: chip, chip description
* @param: mask, expected mask value
* @param: check_cancel, does the command expected to be canceled ?
* @param: canceled, did we received a cancel request ?
* @return: true if status == mask or if the command is canceled.
* false in other cases.
*/
static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask, static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask,
bool check_cancel, bool *canceled) bool check_cancel, bool *canceled)
{ {
...@@ -228,13 +199,7 @@ static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask, ...@@ -228,13 +199,7 @@ static bool wait_for_tpm_stat_cond(struct tpm_chip *chip, u8 mask,
} }
/* /*
* wait_for_stat wait for a TPM_STS value * 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.
* @param: check_cancel, does the command can be cancelled ?
* @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, static int wait_for_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
wait_queue_head_t *queue, bool check_cancel) wait_queue_head_t *queue, bool check_cancel)
...@@ -292,15 +257,8 @@ static int wait_for_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout, ...@@ -292,15 +257,8 @@ static int wait_for_stat(struct tpm_chip *chip, u8 mask, unsigned long timeout,
} }
return -ETIME; 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 number of bytes read from TPM FIFO.
*/
static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count) static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count)
{ {
struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev); struct st33zp24_dev *tpm_dev = dev_get_drvdata(&chip->dev);
...@@ -325,12 +283,6 @@ static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count) ...@@ -325,12 +283,6 @@ static int recv_data(struct tpm_chip *chip, u8 *buf, size_t count)
return size; 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) static irqreturn_t tpm_ioserirq_handler(int irq, void *dev_id)
{ {
struct tpm_chip *chip = dev_id; struct tpm_chip *chip = dev_id;
...@@ -341,16 +293,10 @@ static irqreturn_t tpm_ioserirq_handler(int irq, void *dev_id) ...@@ -341,16 +293,10 @@ static irqreturn_t tpm_ioserirq_handler(int irq, void *dev_id)
disable_irq_nosync(tpm_dev->irq); disable_irq_nosync(tpm_dev->irq);
return IRQ_HANDLED; return IRQ_HANDLED;
} /* tpm_ioserirq_handler() */ }
/* /*
* st33zp24_send send TPM commands through the I2C bus. * send TPM commands through the I2C bus.
*
* @param: chip, the tpm_chip description as specified in driver/char/tpm/tpm.h
* @param: buf, the buffer to send.
* @param: count, the number of bytes to send.
* @return: In case of success the number of bytes sent.
* In other case, a < 0 value describing the issue.
*/ */
static int st33zp24_send(struct tpm_chip *chip, unsigned char *buf, static int st33zp24_send(struct tpm_chip *chip, unsigned char *buf,
size_t len) size_t len)
...@@ -431,14 +377,6 @@ static int st33zp24_send(struct tpm_chip *chip, unsigned char *buf, ...@@ -431,14 +377,6 @@ static int st33zp24_send(struct tpm_chip *chip, unsigned char *buf,
return ret; return ret;
} }
/*
* st33zp24_recv received TPM response through TPM phy.
* @param: chip, the tpm_chip description as specified in driver/char/tpm/tpm.h.
* @param: buf, the buffer to store datas.
* @param: count, the number of bytes to send.
* @return: In case of success the number of bytes received.
* In other case, a < 0 value describing the issue.
*/
static int st33zp24_recv(struct tpm_chip *chip, unsigned char *buf, static int st33zp24_recv(struct tpm_chip *chip, unsigned char *buf,
size_t count) size_t count)
{ {
...@@ -478,12 +416,6 @@ static int st33zp24_recv(struct tpm_chip *chip, unsigned char *buf, ...@@ -478,12 +416,6 @@ static int st33zp24_recv(struct tpm_chip *chip, unsigned char *buf,
return size; return size;
} }
/*
* st33zp24_req_canceled
* @param: chip, the tpm_chip description as specified in driver/char/tpm/tpm.h.
* @param: status, the TPM status.
* @return: Does TPM ready to compute a new command ? true.
*/
static bool st33zp24_req_canceled(struct tpm_chip *chip, u8 status) static bool st33zp24_req_canceled(struct tpm_chip *chip, u8 status)
{ {
return (status == TPM_STS_COMMAND_READY); return (status == TPM_STS_COMMAND_READY);
...@@ -501,11 +433,7 @@ static const struct tpm_class_ops st33zp24_tpm = { ...@@ -501,11 +433,7 @@ static const struct tpm_class_ops st33zp24_tpm = {
}; };
/* /*
* st33zp24_probe initialize the TPM device * initialize the TPM device
* @param: client, the i2c_client description (TPM I2C description).
* @param: id, the i2c_device_id struct.
* @return: 0 in case of success.
* -1 in other case.
*/ */
int st33zp24_probe(void *phy_id, const struct st33zp24_phy_ops *ops, int st33zp24_probe(void *phy_id, const struct st33zp24_phy_ops *ops,
struct device *dev, int irq, int io_lpcpd) struct device *dev, int irq, int io_lpcpd)
...@@ -583,11 +511,6 @@ int st33zp24_probe(void *phy_id, const struct st33zp24_phy_ops *ops, ...@@ -583,11 +511,6 @@ int st33zp24_probe(void *phy_id, const struct st33zp24_phy_ops *ops,
} }
EXPORT_SYMBOL(st33zp24_probe); EXPORT_SYMBOL(st33zp24_probe);
/*
* st33zp24_remove remove the TPM device
* @param: tpm_data, the tpm phy.
* @return: 0 in case of success.
*/
int st33zp24_remove(struct tpm_chip *chip) int st33zp24_remove(struct tpm_chip *chip)
{ {
tpm_chip_unregister(chip); tpm_chip_unregister(chip);
...@@ -596,12 +519,6 @@ int st33zp24_remove(struct tpm_chip *chip) ...@@ -596,12 +519,6 @@ int st33zp24_remove(struct tpm_chip *chip)
EXPORT_SYMBOL(st33zp24_remove); EXPORT_SYMBOL(st33zp24_remove);
#ifdef CONFIG_PM_SLEEP #ifdef CONFIG_PM_SLEEP
/*
* st33zp24_pm_suspend suspend the TPM device
* @param: tpm_data, the tpm phy.
* @param: mesg, the power management message.
* @return: 0 in case of success.
*/
int st33zp24_pm_suspend(struct device *dev) int st33zp24_pm_suspend(struct device *dev)
{ {
struct tpm_chip *chip = dev_get_drvdata(dev); struct tpm_chip *chip = dev_get_drvdata(dev);
...@@ -615,14 +532,9 @@ int st33zp24_pm_suspend(struct device *dev) ...@@ -615,14 +532,9 @@ int st33zp24_pm_suspend(struct device *dev)
ret = tpm_pm_suspend(dev); ret = tpm_pm_suspend(dev);
return ret; return ret;
} /* st33zp24_pm_suspend() */ }
EXPORT_SYMBOL(st33zp24_pm_suspend); EXPORT_SYMBOL(st33zp24_pm_suspend);
/*
* st33zp24_pm_resume resume the TPM device
* @param: tpm_data, the tpm phy.
* @return: 0 in case of success.
*/
int st33zp24_pm_resume(struct device *dev) int st33zp24_pm_resume(struct device *dev)
{ {
struct tpm_chip *chip = dev_get_drvdata(dev); struct tpm_chip *chip = dev_get_drvdata(dev);
...@@ -640,7 +552,7 @@ int st33zp24_pm_resume(struct device *dev) ...@@ -640,7 +552,7 @@ int st33zp24_pm_resume(struct device *dev)
tpm1_do_selftest(chip); tpm1_do_selftest(chip);
} }
return ret; return ret;
} /* st33zp24_pm_resume() */ }
EXPORT_SYMBOL(st33zp24_pm_resume); EXPORT_SYMBOL(st33zp24_pm_resume);
#endif #endif
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment