[coreboot-gerrit] New patch to review for coreboot: 9447e24 spi_flash: document expected return values

[Aaron Durbin (adurbin@chromium.org)]

Aaron Durbin (adurbin at chromium.org) just uploaded a new patch set to gerrit, which you can find at http://review.coreboot.org/10206

-gerrit

commit 9447e247604b9a3e6abf977570754ed075222c2f
Author: Aaron Durbin <adurbin at chromium.org>
Date:   Thu May 14 14:46:59 2015 -0500

    spi_flash: document expected return values
    
    The spi_flash API did not have any of its callbacks
    documented. Do that so that people don't have to go
    into the guts of an implementation to figure out the
    proper expectations.
    
    Change-Id: I55a0515445cab3697813d88373ee413f30b557b5
    Signed-off-by: Aaron Durbin <adurbin at chromium.org>
---
 src/include/spi_flash.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/include/spi_flash.h b/src/include/spi_flash.h
index 3865a53..19df269 100644
--- a/src/include/spi_flash.h
+++ b/src/include/spi_flash.h
@@ -42,6 +42,7 @@ struct spi_flash {
 
 	u8		status_cmd;
 
+	/* All callbacks return 0 on success and != 0 on error. */
 	int		(*read)(struct spi_flash *flash, u32 offset,
 				size_t len, void *buf);
 	int		(*write)(struct spi_flash *flash, u32 offset,