IOTON Technology / mbed-ton

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

Diff: hal/i2c_api.h

Revision:
153:fa9ff456f731
Parent:
149:156823d33999
--- 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);