[Cryptech-Commits] [sw/tamper] 04/20: Explain SPI dummy write in comments.

[git at cryptech.is]

This is an automated email from the git hooks/post-receive script.

paul at psgd.org pushed a commit to branch master
in repository sw/tamper.

commit c114fb9c06b3547cd90990610cda98cc6e5be495
Author: Linus Nordberg <linus at nordberg.se>
AuthorDate: Thu May 19 15:55:05 2016 +0200

    Explain SPI dummy write in comments.
---
 tamper.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/tamper.c b/tamper.c
index d4db2b9..2893a6c 100644
--- a/tamper.c
+++ b/tamper.c
@@ -111,14 +111,23 @@ spi_setup(int on_flag)
 static inline void
 spi_write(uint8_t val)
 {
+  /* Move the value to be sent to the SPI slave into the SPI
+     register. This starts the SPI clock. */
   SPDR = val;
+
+  /* Wait for the byte to be shifted into the slave. */
   loop_until_bit_is_set(SPSR, SPIF);
 }
 
 static inline uint8_t
 spi_read()
 {
+  /* Start clocking the SPI slave by moving a dummy byte (0) into the
+     SPI register and wait for the byte from the slave to be shifted
+     in. */
   spi_write(0);
+
+  /* Read the SPI register and return the value. */
   return SPDR;
 }