mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

Diff: hal/i2c_api.h

Revision:
132:9baf128c2fab
Parent:
128:9bcdf88f62b0
Child:
150:a330f0fddbec
--- a/hal/i2c_api.h	Thu Dec 15 11:17:48 2016 +0000
+++ b/hal/i2c_api.h	Tue Dec 20 15:36:52 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);