MonoLibUsb - [Libusb 1.0 API Library]

Much of the official Libusb-1.0 API Documentation also applies to the .NET MonoLibUsb low-level API library. This is an excellent reference for both novice and advanced users. Users unfamiliar with Libusb-1.0 are encouraged to review the official documentation upon getting started.

Before using MonoLibUsb a MonoUsbSessionHandle must be created. A session handle is required for many of the library functions.

The MonoUsbProfileList is your starting point for discovering, querying and opening USB devices. See the Show Info Console Application Example.

The MonoLibUsb source code can be built as a standalone library, seperate from LibUsbDotNet. See the [BaseDir]\LibWinUsb\MonoLibUsb\MonoUsb.sln in the LibUsbDotNet source.

The MonoUsbApi functions have no "libusb_" prefix.and the naming convention is UpperCamelCase. For example, MonoUsbApi.GetConfiguration() instead of libusb_get_configuration().

Functions that deal with freeing, opening and closing (with the exception of asynchronous tranfers) are managed by a SafeContextHandle class. This ensures all unsafe Libusb-1.0 memory pointers get closed/freed.

The user is required to Free()()()() asynchronous transfers. Failure to do so will result in memory leaks.

The following functions do not exist in the MonoUsbApi:

• libusb_init()
• libusb_exit()

  A MonoUsbSessionHandle class is used to manage a libusb_context.

  CopyC++

  // Initialize Context
  libusb_context *context;
  libusb_init(&context);
  
  // Exit Context
  libusb_exit(context);

  CopyC#

  // Initialize Context
  MonoUsbSessionHandle context = new MonoUsbSessionHandle();
  
  // Exit Context
  context.Close();

• libusb_free_device_list()

  A MonoUsbProfileListHandle class is used to manage a device list handle. To free a device list handle, call the list handles Close() method.

• libusb_free_config_descriptor()

  A MonoUsbConfigHandle class is used to manage a config descriptor. To free a config descriptor, call the config handles Close() method.

• libusb_open()
• libusb_close()

  A MonoUsbDeviceHandle class is used to manage a libusb_device_handle.

  CopyC++

  // Open Device
  libusb_device_handle *device_handle;
  libusb_open(profileHandle,&device_handle);
  
  // Close Device
  libusb_close(device_handle);

  CopyC#

  // Open Device
  MonoUsbDeviceHandle deviceHandle = new MonoUsbDeviceHandle(profileHandle);
  
  // Close Device
  deviceHandle.Close();

• libusb_ref_device()
• libusb_unref_device()

  Device referencing is handled internally by the MonoUsbProfileHandle class.

• libusb_alloc_transfer()
• libusb_submit_transfer()
• libusb_cancel_transfer()
• libusb_free_transfer()

  Asynchronous device I/O functions are implemented in the MonoUsbTransfer structure.

Asynchronous transfers must be freed by the user with the Free()()()() method. Failure to do so will result in memory leaks.