The cl-libusb Reference Manual

Table of Contents

The cl-libusb Reference Manual

This is the cl-libusb Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:20:48 2020 GMT+0.

1 Introduction

cl-libusb provides an easy interface to libusb-0.1. There are two
systems/packages: libusb-ffi, which provides a (somewhat lispified)
ffi to libusb-0.1, and cl-libusb, which provides an easier interface.

Buffers are dealt with using unsigned byte static vectors. Converting
existing software to use static vectors instead of foreign arrays
should be straight-forward:
1. In your project, make sure to use static-vectors instead of antik
   and grid,
2. If you call USB-BULK-WRITE or USB-INTERRUPT-WRITE, make sure the
   buffer is a static vector instead of a foreign array:
   Instead of (GRID:MAKE-FOREIGN-ARRAY '(UNSIGNED-BYTE 8) :DIMENSIONS LENGTH)
   to make the array, use (STATIC-VECTORS:MAKE-STATIC-VECTOR LENGTH) and
   fill the array as if it is a normal common lisp array. After the
   call to -WRITE functions, make sure to use STATIC-VECTORS:FREE-STATIC-VECTOR
   to ensure the memory will be freed.
3. If you call USB-BULK-READ or USB-INTERRUPT-READ, be aware that the
   buffer is a static vector instead of a foreign array:
   The returned array can be simply be used as if it is a normal common
   lisp array for reading / parsing the output of the -READ functions.
   Make sure to use STATIC-VECTORS:FREE-STATIC-VECTOR to ensure that the
   associated memory will be freed.

libusb-ffi (and thus cl-libusb) is not complete, but should be usable.

Tested and found to work on:
linux amd64 (sbcl)
linux raspberry pi (sbcl-1.3.1-debian)

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-libusb

Author

Sumant Oemrawsingh

Description

Lispified bindings to libusb-0.1.

Dependencies

• libusb-ffi (system)
• trivial-garbage

Source

cl-libusb.asd (file)

Components

• package.lisp (file)
• cl-libusb.lisp (file)

2.2 libusb-ffi

Author

Sumant Oemrawsingh

Description

Common Lisp FFI bindings to libusb-0.1.

Dependencies

• cffi
• cffi-grovel
• static-vectors

Source

libusb-ffi.asd (file)

Components

• package.lisp (file)
• libusb-grovel.lisp (file)
• libusb-ffi.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-libusb.asd

Location

cl-libusb.asd

Systems

cl-libusb (system)

3.1.2 libusb-ffi.asd

Location

libusb-ffi.asd

Systems

libusb-ffi (system)

3.1.3 cl-libusb/package.lisp

Parent

cl-libusb (system)

Location

package.lisp

Packages

• cl-libusb
• libusb-ffi

3.1.4 cl-libusb/cl-libusb.lisp

Dependency

package.lisp (file)

Parent

cl-libusb (system)

Location

cl-libusb.lisp

Exported Definitions

• usb-bulk-read (function)
• usb-bulk-write (function)
• usb-claim-interface (function)
• usb-clear-halt (function)
• usb-close (function)
• usb-control-msg (function)
• usb-detach-kernel-driver-np (function)
• usb-device (class)
• usb-get-devices-by-ids (function)
• usb-get-driver-name (function)
• usb-get-product-id (function)
• usb-get-string (function)
• usb-get-vendor-id (function)
• usb-interrupt-read (function)
• usb-interrupt-write (function)
• usb-open (function)
• usb-open-p (function)
• usb-release-interface (function)
• usb-set-configuration (function)
• usb-simple-setup (function)

Internal Definitions

• usb-device-pointer (method)
• usb-handle-pointer (method)
• usb-rebuild-finalization (function)
• usb-set-altinterface (function)

3.1.5 libusb-ffi/package.lisp

Parent

libusb-ffi (system)

Location

package.lisp

Packages

• cl-libusb
• libusb-ffi

3.1.6 libusb-ffi/libusb-grovel.lisp

Dependency

package.lisp (file)

Parent

libusb-ffi (system)

Location

libusb-grovel.lisp

3.1.7 libusb-ffi/libusb-ffi.lisp

Dependency

libusb-grovel.lisp (file)

Parent

libusb-ffi (system)

Location

libusb-ffi.lisp

Exported Definitions

• endpoint-in-p (function)
• endpoint-out-p (function)
• usb-bulk-read (function)
• usb-bulk-write (function)
• usb-claim-interface (function)
• usb-clear-halt (function)
• usb-close (function)
• usb-configuration-get-interfaces (function)
• usb-configuration-get-value (function)
• usb-control-msg (function)
• usb-detach-kernel-driver-np* (function)
• usb-device-get-descriptor (function)
• usb-endpoint-get-address (function)
• usb-get-busses (function)
• usb-get-configuration-by-value (function)
• usb-get-configurations (function)
• usb-get-devices (function)
• usb-get-devices-by-ids (function)
• usb-get-driver-name (function)
• usb-get-product-id (function)
• usb-get-string (function)
• usb-get-string-index (function)
• usb-get-vendor-id (function)
• usb-interface-get-settings (function)
• usb-interface-setting-get-alternate (function)
• usb-interface-setting-get-endpoints (function)
• usb-interface-setting-get-number (function)
• usb-interrupt-read (function)
• usb-interrupt-write (function)
• usb-open (function)
• usb-release-interface (function)
• usb-reset (function)
• usb-set-altinterface (function)
• usb-set-configuration (function)

Internal Definitions

• *libusb-initialized* (special variable)
• ensure-libusb-initialized (function)
• libusb-error (condition)
• return-static-buffer-with-length (function)
• usb-bulk-read* (function)
• usb-bulk-write* (function)
• usb-claim-interface* (function)
• usb-clear-halt* (function)
• usb-control-msg* (function)
• usb-endpoint-type (function)
• usb-find-busses (function)
• usb-find-busses* (function)
• usb-find-devices (function)
• usb-find-devices* (function)
• usb-get-busses* (function)
• usb-get-devices* (function)
• usb-get-driver-np (function)
• usb-get-string* (function)
• usb-get-string-simple* (function)
• usb-init (function)
• usb-init* (function)
• usb-interrupt-read* (function)
• usb-interrupt-write* (function)
• usb-release-interface* (function)
• usb-reset* (function)
• usb-set-altinterface* (function)
• usb-set-configuration* (function)

4 Packages

Packages are listed by definition order.

4.1 cl-libusb

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• usb-bulk-read (function)
• usb-bulk-write (function)
• usb-claim-interface (function)
• usb-clear-halt (function)
• usb-close (function)
• usb-control-msg (function)
• usb-detach-kernel-driver-np (function)
• usb-device (class)
• usb-get-devices-by-ids (function)
• usb-get-driver-name (function)
• usb-get-product-id (function)
• usb-get-string (function)
• usb-get-vendor-id (function)
• usb-interrupt-read (function)
• usb-interrupt-write (function)
• usb-open (function)
• usb-open-p (function)
• usb-release-interface (function)
• usb-set-configuration (function)
• usb-simple-setup (function)

Internal Definitions

• usb-device-pointer (generic function)
• usb-device-pointer (method)
• usb-handle-pointer (generic function)
• usb-handle-pointer (method)
• usb-rebuild-finalization (function)
• usb-set-altinterface (function)

4.2 libusb-ffi

Source

package.lisp (file)

Use List

• cffi
• common-lisp

Exported Definitions

• endpoint-in-p (function)
• endpoint-out-p (function)
• usb-bulk-read (function)
• usb-bulk-write (function)
• usb-claim-interface (function)
• usb-clear-halt (function)
• usb-close (function)
• usb-configuration-get-interfaces (function)
• usb-configuration-get-value (function)
• usb-control-msg (function)
• usb-detach-kernel-driver-np* (function)
• usb-device-get-descriptor (function)
• usb-endpoint-get-address (function)
• usb-get-busses (function)
• usb-get-configuration-by-value (function)
• usb-get-configurations (function)
• usb-get-devices (function)
• usb-get-devices-by-ids (function)
• usb-get-driver-name (function)
• usb-get-product-id (function)
• usb-get-string (function)
• usb-get-string-index (function)
• usb-get-vendor-id (function)
• usb-interface-get-settings (function)
• usb-interface-setting-get-alternate (function)
• usb-interface-setting-get-endpoints (function)
• usb-interface-setting-get-number (function)
• usb-interrupt-read (function)
• usb-interrupt-write (function)
• usb-open (function)
• usb-release-interface (function)
• usb-reset (function)
• usb-set-altinterface (function)
• usb-set-configuration (function)

Internal Definitions

• *libusb-initialized* (special variable)
• bus-tclass (class)
• configuration-tclass (class)
• device-descriptor-tclass (class)
• device-tclass (class)
• endpoint-descriptor-tclass (class)
• ensure-libusb-initialized (function)
• interface-tclass (class)
• libusb-error (condition)
• return-static-buffer-with-length (function)
• setting-tclass (class)
• size-of-bus (constant)
• size-of-configuration (constant)
• size-of-device (constant)
• size-of-device-descriptor (constant)
• size-of-endpoint-descriptor (constant)
• size-of-interface (constant)
• size-of-setting (constant)
• size-of-size-t (constant)
• usb-bulk-read* (function)
• usb-bulk-write* (function)
• usb-claim-interface* (function)
• usb-clear-halt* (function)
• usb-control-msg* (function)
• usb-endpoint-type (function)
• usb-find-busses (function)
• usb-find-busses* (function)
• usb-find-devices (function)
• usb-find-devices* (function)
• usb-get-busses* (function)
• usb-get-devices* (function)
• usb-get-driver-np (function)
• usb-get-string* (function)
• usb-get-string-simple* (function)
• usb-init (function)
• usb-init* (function)
• usb-interrupt-read* (function)
• usb-interrupt-write* (function)
• usb-release-interface* (function)
• usb-reset* (function)
• usb-set-altinterface* (function)
• usb-set-configuration* (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: endpoint-in-p ENDPOINT

Check if an endpoint is an in endpoint (and thus can be read from).

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: endpoint-out-p ENDPOINT

Check if an endpoint is and out endpoint (and thus can be written to).

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-bulk-read DEVICE ENDPOINT BYTES-TO-READ TIMEOUT

Read the given amount of bytes in a bulk transfer and return the buffer (a static vector).

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-bulk-read HANDLE ENDPOINT BYTES-TO-READ TIMEOUT

Perform a bulk read request to the endpoint, which can be specified by its address or pointer to the endpoint. Returns the buffer of bytes read, which is a static vector with element type ’(unsigned-byte 8).

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-bulk-write DEVICE ENDPOINT BUFFER TIMEOUT

Write data in the given buffer (a static vector) in a bulk transfer and return the amount of bytes actually written.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-bulk-write HANDLE ENDPOINT BUFFER TIMEOUT

Perform a bulk write request to the endpoint, which can alternatively be specified by its address. Buffer should be a static vector with element type ’(unsigned-byte 8). Returns number of bytes written.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-claim-interface DEVICE SETTING-OR-NUMBER

Claim the given interface for the handle. The interface can be specified by its setting, or its (integer) number.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-claim-interface HANDLE SETTING-OR-NUMBER

Claim the given interface for the handle. The interface can be specified by its setting, or its (integer) number.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-clear-halt DEVICE ENDPOINT

Clear the halt flag on the given endpoint of the device.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-clear-halt HANDLE ENDPOINT

Clear the halt status on the specified endpoint. The endpoint can also be specified by its address.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-close DEVICE

Close a usb device. If a device is already closed, do nothing.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-close HANDLE

Close a usb device by the pointer to its handle.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-configuration-get-interfaces CONFIGURATION

Returns all the interfaces from the given configuration.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-configuration-get-value CONFIGURATION

Returns the configuration value of the given configuration.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-control-msg DEVICE REQUESTTYPE REQUEST VALUE INDEX BUFFER TIMEOUT

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-control-msg HANDLE REQUESTTYPE REQUEST VALUE INDEX BUFFER TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-detach-kernel-driver-np DEV INTERFACE

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-detach-kernel-driver-np* HANDLE INTERFACE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-device-get-descriptor DEVICE

Returns the device descriptor for the given device.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-endpoint-get-address ENDPOINT

Returns the endpoint’s address.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-busses ()

Return a list of busses.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-configuration-by-value DEVICE VALUE

Returns a configuration which has the given configuration value.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-configurations DEVICE

Returns a list of usb configurations for the given device.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-devices &optional BUS-OR-LIST

Returns a list of all usb devices. Optionally, a bus or list of busses can also be specified, to confine the results to devices on those busses.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-devices-by-ids VENDOR-ID PRODUCT-ID

Return a list of devices that match the given vendor id and product id. If either is NIL, that parameter is not used as a filter. Thus if both are NIL, a list containing all devices is returned.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-get-devices-by-ids VENDOR-ID PRODUCT-ID

Returns a list of all devices with the given vendor id and product id. If any of the arguments is NIL, then the device id can match any value. Thus (usb-get-devices-by-ids nil nil) is equivalent
to (usb-get-devices).

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-driver-name DEV

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-get-driver-name DEV

Returns the name of the driver currently assigned to this device.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-product-id DEVICE

Return the product id of the device.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-get-product-id DEVICE

Returns the product id of the device.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-string DEVICE INDEX-OR-SYMBOL &optional LANGUAGE-ID

Return the string associated with the given index or symbol. If no language id is given, a simple ascii string is returned, else the string with the given language id is returned. The allowed symbols are :manufacturer, :product or :serial-number. If the device was not open, it is opened to obtain the string and then closed again.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-get-string DEVICE-HANDLE INDEX &optional LANGUAGE-ID

Returns the string descriptor specified by index and langid from a device. The string will be returned in Unicode as specified by the USB specification. If language id is nil (the default), returns the string descriptor specified by index in the first language for the descriptor and converts it into C style ASCII. Returns the number of bytes returned.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-string-index DEVICE STRING-SYMBOL

Returns the string index associated with the given symbol. This symbol can be :MANUFACTURER, :PRODUCT or :SERIAL-NUMBER.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-vendor-id DEVICE

Return the vendor id of the device.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-get-vendor-id DEVICE

Returns the vendor id of the device.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interface-get-settings INTERFACE

Returns all the possible settings from a given interface.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interface-setting-get-alternate SETTING

Return the alternate interface setting value for the given setting.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interface-setting-get-endpoints SETTING

Return a list of endpoints for the given interface setting.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interface-setting-get-number SETTING

Return the interface number for the given interface setting.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interrupt-read DEVICE ENDPOINT BYTES-TO-READ TIMEOUT

Read the given amount of bytes in an interrupt transfer and return the buffer (a static vector).

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-interrupt-read HANDLE ENDPOINT BYTES-TO-READ TIMEOUT

Perform an interrupt read request to the endpoint, which can be specified by its address or pointer to the endpoint. Returns the buffer of bytes read, which is a static vector with element type ’(unsigned-byte 8).

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interrupt-write DEVICE ENDPOINT BUFFER TIMEOUT

Write data in the given buffer (a static vector) in an interrupt transfer and return the amount of bytes actually written.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-interrupt-write HANDLE ENDPOINT BUFFER TIMEOUT

Perform an interrupt write request to the endpoint, which can alternatively be specified by its address. Buffer should be a static vector with element type ’(unsigned-byte 8). Returns number of bytes written.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-open DEVICE

Open a usb device. If the device is already open, do nothing.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-open DEVICE

Open a usb device and return a pointer to the handle to be used for communications.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-open-p DEVICE

Predicate to see if a device has been opened.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-release-interface DEVICE SETTING-OR-NUMBER

Release the given interface for the handle. The interface can be specified by its setting, or its (integer) number.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-release-interface HANDLE SETTING-OR-NUMBER

Release the given interface for the handle. The interface can be specified by its setting, or its (integer) number.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-reset HANDLE

Resets the specified device by sending a RESET down the port it is connected to. Note that this causes re-enumeration: After calling usb-reset, the device will need to re-enumerate and thusly, requires you to find the new device and open a new handle. The handle used to call usb-reset will no longer work.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-set-altinterface HANDLE SETTING-OR-NUMBER

Set the alternate interface setting to that of the given setting. The alternate interface setting can be specified by setting, or by its (integer) value.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-set-configuration DEVICE CONFIGURATION-OR-NUMBER

Set the given configuration for the handle. The configuration can be specified also by its (integer) value.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-set-configuration HANDLE CONFIGURATION-OR-NUMBER

Set the given configuration for the handle. The configuration can be specified also by its (integer) value.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-simple-setup DEVICE

Set up the device by using the first found configuration, interface and settings.

Package

cl-libusb

Source

cl-libusb.lisp (file)

5.1.2 Classes

Class: usb-device ()

Package

cl-libusb

Source

cl-libusb.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• usb-handle-pointer (method)
• usb-device-pointer (method)

Direct slots

Slot: device-pointer

Initargs

:device-pointer

Readers

usb-device-pointer (generic function)

Slot: handle-pointer

Readers

usb-handle-pointer (generic function)

Slot: claimed-interfaces

5.2 Internal definitions

5.2.1 Constants

Constant: size-of-bus

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-configuration

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-device

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-device-descriptor

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-endpoint-descriptor

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-interface

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-setting

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Constant: size-of-size-t

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

5.2.2 Special variables

Special Variable: *libusb-initialized*

Boolean indicating if libusb has been initialized.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

5.2.3 Functions

Function: ensure-libusb-initialized ()

Make sure the libusb library is initialised and all busses and devices are found.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: return-static-buffer-with-length BUFFER BYTES-READ

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-bulk-read* HANDLE ENDPOINT BYTES SIZE TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-bulk-write* HANDLE ENDPOINT BYTES SIZE TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-claim-interface* HANDLE INTERFACE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-clear-halt* HANDLE ENDPOINT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-control-msg* HANDLE REQUESTTYPE REQUEST VALUE INDEX BYTES SIZE TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-endpoint-type ENDPOINT

Returns the endpoint’s type. This can be :control, :isosynchronous, :bulk or :interrupt.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-find-busses ()

Find all of the busses on the system. Returns the number of changes, which specifies the total of new busses and busses removed since previous call to this function.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-find-busses* ()

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-find-devices ()

Find all of the devices on each bus. This should be called after usb-find-busses. Returns the number of changes, which specifies the total of new devices and devices removed since the previous call to this function.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-find-devices* ()

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-busses* ()

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-devices* BUS

Returns a list of all devices in the given bus.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-driver-np HANDLE INTERFACE NAME NAME-LEN

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-string* HANDLE INDEX LANGUAGE-ID BUFFER BUFFER-SIZE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-get-string-simple* HANDLE INDEX BUFFER BUFFER-SIZE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-init ()

Initialize the libusb library. It’s not necessary to call this directly, since other (Lisp) functions will do so if required.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-init* ()

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interrupt-read* HANDLE ENDPOINT BYTES SIZE TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-interrupt-write* HANDLE ENDPOINT BYTES SIZE TIMEOUT

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-rebuild-finalization DEVICE

Rebuild the finalization list for the given USB device.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-release-interface* HANDLE INTERFACE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-reset* HANDLE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-set-altinterface DEVICE SETTING-OR-NUMBER

Set the alternate interface setting to that of the given setting. The alternate interface setting can be specified by setting, or by its (integer) value.

Package

cl-libusb

Source

cl-libusb.lisp (file)

Function: usb-set-altinterface* HANDLE ALTERNATE

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Function: usb-set-configuration* HANDLE CONFIGURATION

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

5.2.4 Generic functions

Generic Function: usb-device-pointer OBJECT

Package

cl-libusb

Methods

Method: usb-device-pointer (USB-DEVICE usb-device)

automatically generated reader method

Source

cl-libusb.lisp (file)

Generic Function: usb-handle-pointer OBJECT

Package

cl-libusb

Methods

Method: usb-handle-pointer (USB-DEVICE usb-device)

automatically generated reader method

Source

cl-libusb.lisp (file)

5.2.5 Conditions

Condition: libusb-error ()

An error from the libusb library.

Package

libusb-ffi

Source

libusb-ffi.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: text

Initargs

:text

5.2.6 Classes

Class: bus-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: configuration-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: device-descriptor-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: device-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: endpoint-descriptor-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: interface-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Class: setting-tclass ()

Package

libusb-ffi

Source

/home/quickref/.cache/common-lisp/sbcl-1.5.8-linux-x64/home/quickref/quicklisp/dists/quicklisp/software/cl-libusb-20200218-git/libusb-grovel.processed-grovel-file

Direct superclasses

• translatable-foreign-type (class)
• foreign-struct-type (class)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types