diff options
| author | Aaron Durbin <adurbin@chromium.org> | 2015-05-14 14:46:59 -0500 |
|---|---|---|
| committer | Aaron Durbin <adurbin@chromium.org> | 2015-05-15 00:39:25 +0200 |
| commit | a3565ae7c6046cafc0fd1361a711c1f8468d0eec (patch) | |
| tree | aed7748c90c0839ec2b602e4f5dc71d4ea649096 | |
| parent | d4a72f724f95deefa622b9dccf950e7dba1a3bcf (diff) | |
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@chromium.org>
Reviewed-on: http://review.coreboot.org/10206
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
| -rw-r--r-- | src/include/spi_flash.h | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/src/include/spi_flash.h b/src/include/spi_flash.h index 3865a53dcc..19df269cb0 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, |