check: device setUSBParameters

Author: motla

CMakeLists.txt

@@ -31,6 +31,7 @@ list(APPEND SRC "src/api/FTDI_Device_setDataCharacteristics.c")
 list(APPEND SRC "src/api/FTDI_Device_setFlowControl.c")
 list(APPEND SRC "src/api/FTDI_Device_setLatencyTimer.c")
 list(APPEND SRC "src/api/FTDI_Device_setTimeouts.c")
+list(APPEND SRC "src/api/FTDI_Device_setUSBParameters.c")
 list(APPEND SRC "src/api/FTDI_Device_simpleFunctions.c")
 list(APPEND SRC "src/api/FTDI_Device_write.c")
 list(APPEND SRC "src/api/FTDI_Device_writeEE.c")

inc/api/FTDI_Device.h

@@ -34,6 +34,7 @@ napi_value device_setDataCharacteristics(napi_env env, napi_callback_info info);
 napi_value device_setFlowControl(napi_env env, napi_callback_info info);
 napi_value device_setLatencyTimer(napi_env env, napi_callback_info info);
 napi_value device_setTimeouts(napi_env env, napi_callback_info info);
+napi_value device_setUSBParameters(napi_env env, napi_callback_info info);
 napi_value device_setDtr(napi_env env, napi_callback_info info);
 napi_value device_setRts(napi_env env, napi_callback_info info);
 napi_value device_setBreakOn(napi_env env, napi_callback_info info);

main.d.ts

@@ -153,27 +153,6 @@ declare class FTDI_Device {
    */
   setFlowControl(flow_control: number, xon: number, xoff: number): void;
 
-  /** Sets the latency timer value (supported devices only)
-   * @param timer Latency timer value, in milliseconds. Valid range is 2 to 255.
-   */
-  setLatencyTimer(timer: number): void;
-
-  /** Enables different chip modes (puts the device in a mode other than the default UART or FIFO mode).
-   * @param mask Bit mode mask
-   * Sets up which bits are inputs and which are outputs. 
-   * A bit value of 0 sets the corresponding pin to an input, a bit value of 1 sets the corresponding pin to an output. 
-   * In the case of CBUS Bit Bang, the upper nibble of this value controls which pins are inputs and outputs, while the lower nibble controls which of the outputs are high and low.
-   * @param bit_mode Mode value. Can be one of the following:
-   * For FT232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_CBUS_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL, FT_BIT_MODE_SYNC_FIFO.
-   * For FT2232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL, FT_BIT_MODE_SYNC_FIFO.
-   * For FT4232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG.
-   * For FT232R devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_CBUS_BITBANG.
-   * For FT245R devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_SYNC_BITBANG.
-   * For FT2232 devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL.
-   * For FT232B and FT245B devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG.
-   */
-  setBitMode(mask: number, bit_mode: number): void;
-
   /** Sets the Data Terminal Ready (DTR) control signal */
   setDtr(): void;
 
@@ -209,6 +188,41 @@ declare class FTDI_Device {
 
   /** Erases the device EEPROM */
   eraseEE(): Promise<void>;
+
+  /** Sets the latency timer value (supported devices only)
+   * @param timer Latency timer value, in milliseconds. Valid range is 2 to 255.
+   */
+  setLatencyTimer(timer: number): void;
+
+  /** Enables different chip modes (puts the device in a mode other than the default UART or FIFO mode).
+    * @param mask Bit mode mask
+    * Sets up which bits are inputs and which are outputs. 
+    * A bit value of 0 sets the corresponding pin to an input, a bit value of 1 sets the corresponding pin to an output. 
+    * In the case of CBUS Bit Bang, the upper nibble of this value controls which pins are inputs and outputs, while the lower nibble controls which of the outputs are high and low.
+    * @param bit_mode Mode value. Can be one of the following:
+    * For FT232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_CBUS_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL, FT_BIT_MODE_SYNC_FIFO.
+    * For FT2232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL, FT_BIT_MODE_SYNC_FIFO.
+    * For FT4232H devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG.
+    * For FT232R devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_CBUS_BITBANG.
+    * For FT245R devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_SYNC_BITBANG.
+    * For FT2232 devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG, FT_BIT_MODE_MPSSE, FT_BIT_MODE_SYNC_BITBANG, FT_BIT_MODE_MCU_HOST, FT_BIT_MODE_FAST_SERIAL.
+    * For FT232B and FT245B devices, valid values are FT_BIT_MODE_RESET, FT_BIT_MODE_ASYNC_BITBANG.
+    */
+  setBitMode(mask: number, bit_mode: number): void;
+
+  /** Sets the USB request transfer size
+   * 
+   * This function can be used to change the transfer sizes from the default transfer size of 4096 bytes to
+   * better suit the application requirements. Transfer sizes must be set to a multiple of 64 bytes between 64
+   * bytes and 64k bytes.
+   * When FT_SetUSBParameters is called, the change comes into effect immediately and any data that was
+   * held in the driver at the time of the change is lost.
+   * Note that, at present, only `in_transfer_size` is supported by the FTDI vendor driver.
+   *
+   * @param in_transfer_size Transfer size in bits for USB IN request
+   * @param out_transfer_size Transfer size in bits for USB OUT request (unsupported yet)
+   */
+  setUSBParameters(in_transfer_size: number, out_transfer_size: number): void;
 }
 
 /** Get the list of FTDI devices connected to the system */

src/api/FTDI_Device.c

@@ -70,8 +70,6 @@ void device_initialize_class(napi_env env, napi_value* result) {
     { "setDataCharacteristics", NULL, device_setDataCharacteristics, NULL, NULL, NULL, napi_enumerable, NULL },
     { "setTimeouts", NULL, device_setTimeouts, NULL, NULL, NULL, napi_enumerable, NULL },
     { "setFlowControl", NULL, device_setFlowControl, NULL, NULL, NULL, napi_enumerable, NULL },
-    { "setLatencyTimer", NULL, device_setLatencyTimer, NULL, NULL, NULL, napi_enumerable, NULL },
-    { "setBitMode", NULL, device_setBitMode, NULL, NULL, NULL, napi_enumerable, NULL },
     { "setDtr", NULL, device_setDtr, NULL, NULL, NULL, napi_enumerable, NULL },
     { "clrDtr", NULL, device_clrDtr, NULL, NULL, NULL, napi_enumerable, NULL },
     { "setRts", NULL, device_setRts, NULL, NULL, NULL, napi_enumerable, NULL },
@@ -82,6 +80,9 @@ void device_initialize_class(napi_env env, napi_value* result) {
     { "readEE", NULL, device_readEE, NULL, NULL, NULL, napi_enumerable, NULL },
     { "writeEE", NULL, device_writeEE, NULL, NULL, NULL, napi_enumerable, NULL },
     { "eraseEE", NULL, device_eraseEE, NULL, NULL, NULL, napi_enumerable, NULL },
+    { "setLatencyTimer", NULL, device_setLatencyTimer, NULL, NULL, NULL, napi_enumerable, NULL },
+    { "setBitMode", NULL, device_setBitMode, NULL, NULL, NULL, napi_enumerable, NULL },
+    { "setUSBParameters", NULL, device_setUSBParameters, NULL, NULL, NULL, napi_enumerable, NULL },
   };
   size_t nb_props = sizeof(props) / sizeof(napi_property_descriptor);
 

src/api/FTDI_Device_setUSBParameters.c

@@ -0,0 +1,29 @@
+#include "api/FTDI_Device.h"
+#include "ftd2xx.h"
+#include "utils.h"
+
+napi_value device_setUSBParameters(napi_env env, napi_callback_info info) {
+  // Get JavaScript `this` corresponding to this instance of the class and `argc`/`argv` passed to the function
+  #define NB_ARGS 2 // number of expected arguments
+  size_t argc = NB_ARGS; // size of the argv buffer
+  napi_value this_arg, argv[NB_ARGS];
+  utils_check(napi_get_cb_info(env, info, &argc, argv, &this_arg, NULL));
+  if(utils_check(argc < NB_ARGS, "Missing argument", "missarg")) return NULL;
+
+  // Get the class instance data containing FTDI device handle
+  device_instance_data_t* instance_data;
+  utils_check(napi_unwrap(env, this_arg, (void**)(&instance_data)));
+
+  // Check the device is open if its handle is still there
+  if(utils_check(instance_data->ftHandle == NULL, "Dead device object", "deadobj")) return NULL;
+
+  // Check arguments, and convert JavaScript values to C values
+  uint32_t in_transfer_size, out_transfer_size;
+  if(utils_check(napi_get_value_uint32(env, argv[0], &in_transfer_size), "Transfer size for USB IN request must be a number", "wrongarg")) return NULL;
+  if(utils_check(napi_get_value_uint32(env, argv[1], &out_transfer_size), "Transfer size for USB OUT request must be a number", "wrongarg")) return NULL;
+
+  // Update FTDI device
+  utils_check(FT_SetUSBParameters(instance_data->ftHandle, (ULONG)in_transfer_size, (ULONG)out_transfer_size));
+
+  return NULL;
+}