Rework I2C module (#951)

- remove similar API
 - remove global variable
 - test coverage

IoT.js-DCO-1.0-Signed-off-by: Hosung Kim [email protected]

Author: hs0225

docs/api/IoT.js-API-I2C.md

@@ -6,11 +6,7 @@ The following shows I2C module APIs available for each platform.
 | :---: | :---: | :---: | :---: |
 | i2c.open | O | O | O |
 | i2cbus.read | O | O | O |
-| i2cbus.readByte | O | O | O |
-| i2cbus.readBytes | O | O | O |
 | i2cbus.write | O | O | O |
-| i2cbus.writeByte | O | O | O |
-| i2cbus.writeBytes | O | O | O |
 | i2cbus.close | O | O | O |
 
 
@@ -82,55 +78,6 @@ i2c_bus.read(2, function(err, res) {
 });
 ```
 
-
-### i2cbus.readByte([callback])
-* `callback` {Function}
-  * `err` {Error|null}
-  * `res` {number} Result byte.
-
-Read one byte from I2C device.
-
-**Example**
-
-```js
-var I2C = require('i2c');
-
-var i2c = new I2C();
-var i2c_bus = i2c.open({device: '/dev/i2c-1', address: 0x23});
-
-i2c_bus.readByte(function(err, res) {
-  if(!err) {
-    console.log('readByte result: ' + res);
-  }
-});
-```
-
-
-### i2cbus.readBytes(cmd, length[, callback])
-* `cmd` {number} Command to the device.
-* `length` {number} Number of bytes to read.
-* `callback` {Function}
-  * `err` {Error|null}
-  * `res` {Array} Array of bytes.
-
-Read bytes from I2C device with command.
-
-**Example**
-
-```js
-var I2C = require('i2c');
-
-var i2c = new I2C();
-var i2c_bus = i2c.open({device: '/dev/i2c-1', address: 0x23});
-
-i2c_bus.readBytes(0x20, 2, function(err, res) {
-  if(!err) {
-    console.log('readBytes result: ' + res);
-  }
-});
-```
-
-
 ### i2cbus.write(bytes[, callback])
 * `bytes` {Array} Array of bytes to write.
 * `callback` {Function}
@@ -154,53 +101,6 @@ i2c_bus.write([0x10], function(err) {
 ```
 
 
-### i2cbus.writeByte(byte[, callback])
-* `byte` {number} Byte to write.
-* `callback` {Function}
-  * `err` {Error|null}
-
-Write one byte to I2C device.
-
-**Example**
-
-```js
-var I2C = require('i2c');
-
-var i2c = new I2C();
-var i2c_bus = i2c.open({device: '/dev/i2c-1', address: 0x23});
-
-i2c_bus.writeByte(0x10, function(err) {
-  if(!err) {
-    console.log('writeByte done');
-  } 
-});
-```
-
-
-### i2cbus.writeBytes(cmd, bytes[, callback])
-* `cmd` {number} Command to the device.
-* `bytes` {Array} Array of bytes to write.
-* `callback` {Function}
-  * `err` {Error|null}
-
-Write bytes to I2C device with command.
-
-**Example**
-
-```js
-var I2C = require('i2c');
-
-var i2c = new I2C();
-var i2c_bus = i2c.open({device: '/dev/i2c-1', address: 0x23});
-
-i2c_bus.writeBytes(0x10, [0x10], function(err) {
-  if(!err) {
-    console.log('writeBytes done');
-  }
-});
-```
-
-
 ### i2cbus.close()
 
 Close I2C device.

docs/targets/nuttx/stm32f4dis/IoT.js-API-Stm32f4dis.md

@@ -165,3 +165,13 @@ Note: You can add more ports according to the patch file.
 
 ```
 
+## I2C Port Information
+
+In order to use the I2C on stm32f4-discovery board, you must use proper pins.
+Currently only I2C1 is supported.
+
+The following table shows the I2C pin map:
+| I2C Pin Name | GPIO Name |
+| :--- | :---: |
+| I2C1_SCL | PB8 |
+| I2C1_SDA | PB7 |

docs/targets/nuttx/stm32f4dis/README.md

@@ -128,6 +128,9 @@ Followings are the options to set:
 * For `uart` module
   * Enable `System Type -> STM32 Peripheral Support -> U[S]ART(N)`
 
+* For `i2c` module
+  * Enable `System Type -> STM32 Peripheral Support -> I2C1`
+
 #### 4. Build IoT.js for NuttX
 
 ##### Follow the instruction

src/iotjs_magic_strings.h

@@ -130,8 +130,6 @@
 #define IOTJS_MAGIC_STRING_PULLDOWN "PULLDOWN"
 #define IOTJS_MAGIC_STRING_PULLUP "PULLUP"
 #define IOTJS_MAGIC_STRING_PUSHPULL "PUSHPULL"
-#define IOTJS_MAGIC_STRING_READBLOCK "readBlock"
-#define IOTJS_MAGIC_STRING_READBYTE "readByte"
 #define IOTJS_MAGIC_STRING_READDIR "readdir"
 #define IOTJS_MAGIC_STRING_READ "read"
 #define IOTJS_MAGIC_STRING_READSOURCE "readSource"
@@ -181,8 +179,6 @@
 #define IOTJS_MAGIC_STRING_UNREF "unref"
 #define IOTJS_MAGIC_STRING_UPGRADE "upgrade"
 #define IOTJS_MAGIC_STRING_URL "url"
-#define IOTJS_MAGIC_STRING_WRITEBLOCK "writeBlock"
-#define IOTJS_MAGIC_STRING_WRITEBYTE "writeByte"
 #define IOTJS_MAGIC_STRING_WRITESYNC "writeSync"
 #define IOTJS_MAGIC_STRING_WRITEUINT8 "writeUInt8"
 #define IOTJS_MAGIC_STRING_WRITE "write"

src/js/i2c.js

@@ -115,31 +115,6 @@ function i2cBusOpen(configurable, callback) {
     });
   };
 
-  I2CBus.prototype.writeByte = function(byte, callback) {
-    if (!util.isNumber(byte)) {
-      throw new TypeError('Bad argument - byte: Number');
-    }
-
-    this.setAddress(this.address);
-    _binding.writeByte(byte, function(err) {
-      util.isFunction(callback) && callback(err);
-    });
-  };
-
-  I2CBus.prototype.writeBytes = function(cmd, array, callback) {
-    if (!util.isNumber(cmd)) {
-      throw new TypeError('Bad argument - cmd: Number');
-    }
-    if (!util.isArray(array)) {
-      throw new TypeError('Bad argument - array: Array');
-    }
-
-    this.setAddress(this.address);
-    _binding.writeBlock(cmd, array, function(err) {
-      util.isFunction(callback) && callback(err);
-    });
-  };
-
   I2CBus.prototype.read = function(length, callback) {
     if (!util.isNumber(length)) {
       throw new TypeError('Bad argument - length: Number');
@@ -151,27 +126,6 @@ function i2cBusOpen(configurable, callback) {
     });
   };
 
-  I2CBus.prototype.readByte = function(callback) {
-    this.setAddress(this.address);
-    _binding.readByte(function(err, data) {
-      util.isFunction(callback) && callback(err, data);
-    });
-  };
-
-  I2CBus.prototype.readBytes = function(cmd, length, callback) {
-    if (!util.isNumber(cmd)) {
-      throw new TypeError('Bad argument - cmd: Number');
-    }
-    if (!util.isNumber(length)) {
-      throw new TypeError('Bad argument - length: Number');
-    }
-
-    this.setAddress(this.address);
-    _binding.readBlock(cmd, length, 0, function(err, resArray) {
-      util.isFunction(callback) && callback(err, resArray);
-    });
-  };
-
   return new I2CBus(configurable, callback);
 }
 

src/modules/iotjs_module_i2c.c

@@ -94,7 +94,9 @@ iotjs_i2c_t* iotjs_i2c_create(const iotjs_jval_t* ji2c) {
   iotjs_i2c_t* i2c = IOTJS_ALLOC(iotjs_i2c_t);
   IOTJS_VALIDATED_STRUCT_CONSTRUCTOR(iotjs_i2c_t, i2c);
 
-#if defined(__NUTTX__)
+#if defined(__linux__)
+  _this->device_fd = -1;
+#elif defined(__NUTTX__)
   _this->i2c_master = NULL;
 #endif
 
@@ -139,9 +141,7 @@ void AfterI2CWork(uv_work_t* work_req, int status) {
         }
         break;
       }
-      case kI2cOpWrite:
-      case kI2cOpWriteByte:
-      case kI2cOpWriteBlock: {
+      case kI2cOpWrite: {
         if (req_data->error == kI2cErrWrite) {
           iotjs_jval_t error =
               iotjs_jval_create_error("Cannot write to device");
@@ -152,20 +152,13 @@ void AfterI2CWork(uv_work_t* work_req, int status) {
         }
         break;
       }
-      case kI2cOpRead:
-      case kI2cOpReadBlock: {
+      case kI2cOpRead: {
         if (req_data->error == kI2cErrRead) {
           iotjs_jval_t error =
               iotjs_jval_create_error("Cannot read from device");
           iotjs_jargs_append_jval(&jargs, &error);
           iotjs_jargs_append_null(&jargs);
           iotjs_jval_destroy(&error);
-        } else if (req_data->error == kI2cErrReadBlock) {
-          iotjs_jval_t error =
-              iotjs_jval_create_error("Error reading length of bytes");
-          iotjs_jargs_append_jval(&jargs, &error);
-          iotjs_jargs_append_null(&jargs);
-          iotjs_jval_destroy(&error);
         } else {
           iotjs_jargs_append_null(&jargs);
           iotjs_jval_t result =
@@ -184,19 +177,6 @@ void AfterI2CWork(uv_work_t* work_req, int status) {
         }
         break;
       }
-      case kI2cOpReadByte: {
-        if (req_data->error == kI2cErrRead) {
-          iotjs_jval_t error =
-              iotjs_jval_create_error("Cannot read from device");
-          iotjs_jargs_append_jval(&jargs, &error);
-          iotjs_jargs_append_null(&jargs);
-          iotjs_jval_destroy(&error);
-        } else {
-          iotjs_jargs_append_null(&jargs);
-          iotjs_jargs_append_number(&jargs, req_data->byte);
-        }
-        break;
-      }
       default: {
         IOTJS_ASSERT(!"Unreachable");
         break;
@@ -315,46 +295,6 @@ JHANDLER_FUNCTION(Write) {
 }
 
 
-JHANDLER_FUNCTION(WriteByte) {
-  DJHANDLER_CHECK_THIS(object);
-  DJHANDLER_CHECK_ARGS(2, number, function);
-
-  uint8_t byte = JHANDLER_GET_ARG(0, number);
-  const iotjs_jval_t* jcallback = JHANDLER_GET_ARG(1, function);
-  const iotjs_jval_t* ji2c = JHANDLER_GET_THIS(object);
-
-  iotjs_i2c_reqwrap_t* req_wrap =
-      iotjs_i2c_reqwrap_create(jcallback, ji2c, kI2cOpWriteByte);
-
-  iotjs_i2c_reqdata_t* req_data = iotjs_i2c_reqwrap_data(req_wrap);
-  req_data->byte = byte;
-
-  I2C_ASYNC(WriteByte);
-
-  iotjs_jhandler_return_null(jhandler);
-}
-
-
-JHANDLER_FUNCTION(WriteBlock) {
-  DJHANDLER_CHECK_THIS(object);
-  DJHANDLER_CHECK_ARGS(3, number, array, function);
-
-  const iotjs_jval_t* jcallback = JHANDLER_GET_ARG(2, function);
-  const iotjs_jval_t* ji2c = JHANDLER_GET_THIS(object);
-
-  iotjs_i2c_reqwrap_t* req_wrap =
-      iotjs_i2c_reqwrap_create(jcallback, ji2c, kI2cOpWriteBlock);
-
-  iotjs_i2c_reqdata_t* req_data = iotjs_i2c_reqwrap_data(req_wrap);
-  req_data->cmd = JHANDLER_GET_ARG(0, number);
-  GetI2cArray(JHANDLER_GET_ARG(1, array), req_data);
-
-  I2C_ASYNC(WriteBlock);
-
-  iotjs_jhandler_return_null(jhandler);
-}
-
-
 JHANDLER_FUNCTION(Read) {
   DJHANDLER_CHECK_THIS(object);
   DJHANDLER_CHECK_ARGS(2, number, function);
@@ -375,43 +315,6 @@ JHANDLER_FUNCTION(Read) {
 }
 
 
-JHANDLER_FUNCTION(ReadByte) {
-  DJHANDLER_CHECK_THIS(object);
-  DJHANDLER_CHECK_ARGS(1, function);
-
-  const iotjs_jval_t* jcallback = JHANDLER_GET_ARG(0, function);
-  const iotjs_jval_t* ji2c = JHANDLER_GET_THIS(object);
-
-  iotjs_i2c_reqwrap_t* req_wrap =
-      iotjs_i2c_reqwrap_create(jcallback, ji2c, kI2cOpReadByte);
-
-  I2C_ASYNC(ReadByte);
-
-  iotjs_jhandler_return_null(jhandler);
-}
-
-
-JHANDLER_FUNCTION(ReadBlock) {
-  DJHANDLER_CHECK_THIS(object);
-  DJHANDLER_CHECK_ARGS(4, number, number, number, function);
-
-  const iotjs_jval_t* jcallback = JHANDLER_GET_ARG(3, function);
-  const iotjs_jval_t* ji2c = JHANDLER_GET_THIS(object);
-
-  iotjs_i2c_reqwrap_t* req_wrap =
-      iotjs_i2c_reqwrap_create(jcallback, ji2c, kI2cOpReadBlock);
-
-  iotjs_i2c_reqdata_t* req_data = iotjs_i2c_reqwrap_data(req_wrap);
-  req_data->cmd = JHANDLER_GET_ARG(0, number);
-  req_data->buf_len = JHANDLER_GET_ARG(1, number);
-  req_data->delay = JHANDLER_GET_ARG(2, number);
-
-  I2C_ASYNC(ReadBlock);
-
-  iotjs_jhandler_return_null(jhandler);
-}
-
-
 iotjs_jval_t InitI2c() {
   iotjs_jval_t jI2cCons = iotjs_jval_create_function_with_dispatch(I2cCons);
 
@@ -420,11 +323,7 @@ iotjs_jval_t InitI2c() {
   iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_SETADDRESS, SetAddress);
   iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_CLOSE, Close);
   iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_WRITE, Write);
-  iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_WRITEBYTE, WriteByte);
-  iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_WRITEBLOCK, WriteBlock);
   iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_READ, Read);
-  iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_READBYTE, ReadByte);
-  iotjs_jval_set_method(&prototype, IOTJS_MAGIC_STRING_READBLOCK, ReadBlock);
 
   iotjs_jval_set_property_jval(&jI2cCons, IOTJS_MAGIC_STRING_PROTOTYPE,
                                &prototype);