spi_flash: document expected return values
commita3565ae7c6046cafc0fd1361a711c1f8468d0eec
authorAaron Durbin <adurbin@chromium.org>
Thu, 14 May 2015 19:46:59 +0000 (14 14:46 -0500)
committerAaron Durbin <adurbin@chromium.org>
Thu, 14 May 2015 22:39:25 +0000 (15 00:39 +0200)
treeaed7748c90c0839ec2b602e4f5dc71d4ea649096
parentd4a72f724f95deefa622b9dccf950e7dba1a3bcf
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>
src/include/spi_flash.h