[004/108] tpm: cr50: Tidy up various comments

Message ID 20200126220508.4.I405998b384e2bb25cbfb3179a8375c586bf0ce7a@changeid
State New
Headers show
Series
  • RFC: dm: Add programatic generation of ACPI tables
Related show

Commit Message

Simon Glass Jan. 27, 2020, 5:05 a.m.
Add a comment for the private structure and drop the incorrect coreboot
reference in one function.

Signed-off-by: Simon Glass <sjg at chromium.org>
---

 drivers/tpm/cr50_i2c.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

Patch

diff --git a/drivers/tpm/cr50_i2c.c b/drivers/tpm/cr50_i2c.c
index 42faee4d9b..1af943d6ff 100644
--- a/drivers/tpm/cr50_i2c.c
+++ b/drivers/tpm/cr50_i2c.c
@@ -34,6 +34,15 @@  enum {
 	CR50_MAX_BUF_SIZE = 63,
 };
 
+/**
+ * struct cr50_priv - Private driver data
+ *
+ * @ready_gpio: GPIO to use to check if the TPM is ready
+ * @irq: IRQ to use check if the TPM is ready (has priority over @ready_gpio)
+ * @locality: Currenttly claimed locality (-1 if none)
+ * @vendor: vendor: Vendor ID for TPM
+ * @use_irq: true to use @irq, false to use @ready if available
+ */
 struct cr50_priv {
 	struct gpio_desc ready_gpio;
 	struct irq irq;
@@ -493,8 +502,8 @@  static int process_reset(struct udevice *dev)
 }
 
 /*
- * Locality could be already claimed (if this is a later coreboot stage and
- * the RO did not release it), or not yet claimed, if this is verstage or the
+ * Locality could be already claimed (if this is a later U-Boot phase and
+ * RO did not release it), or not yet claimed, if this is TPL or the
  * older RO did release it.
  */
 static int claim_locality(struct udevice *dev, int loc)