Pedro Correia / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

Diff: hal/i2c_api.h

Revision:
153:fa9ff456f731
Parent:
149:156823d33999
Child:
172:7d866c31b3c5
diff -r 9a67f0b066fc -r fa9ff456f731 hal/i2c_api.h
--- a/hal/i2c_api.h	Thu Dec 15 11:48:27 2016 +0000
+++ b/hal/i2c_api.h	Tue Dec 20 17:27:56 2016 +0000
@@ -117,7 +117,9 @@
  *  @param data    The buffer for sending
  *  @param length  Number of bytes to write
  *  @param stop    Stop to be generated after the transfer is done
- *  @return Number of written bytes
+ *  @return 
+ *      zero or non-zero - Number of written bytes
+ *      negative - I2C_ERROR_XXX status
  */
 int i2c_write(i2c_t *obj, int address, const char *data, int length, int stop);