usb 1.3.0 · OCaml Package

val handle_error : ('a -> 'b) -> 'a -> 'b

type error =

| Error_io
| Error_invalid_param
| Error_access
| Error_no_device
| Error_not_found
| Error_busy
| Error_timeout
| Error_overflow
| Error_pipe
| Error_interrupted
| Error_no_mem
| Error_not_supported
| Error_other

exception Error of error * string

val error_message : error -> string

type direction =

| In
| Out

type endpoint = int

val init : unit Lazy.t

val set_debug : [ `error | `quiet | `verbose | `warning ] -> unit

type device

val get_device_list : unit -> device list

val get_bus_number : device -> int

val get_device_address : device -> int

val get_max_packet_size : 
  device:device ->
  direction:direction ->
  endpoint:endpoint ->
  int

type handle

type interface = int

val open_device : device -> handle

val close : handle -> unit

val open_device_with : vendor_id:int -> product_id:int -> handle

val get_device : handle -> device

val kernel_driver_active : handle -> interface -> bool

val detach_kernel_driver : handle -> interface -> unit

val attach_kernel_driver : handle -> interface -> unit

val claim_interface : handle -> interface -> unit Lwt.t

val release_interface : handle -> interface -> unit Lwt.t

type configuration = int

val get_configuration : handle -> configuration Lwt.t

val set_configuration : handle -> configuration -> unit Lwt.t

val set_interface_alt_setting : handle -> interface -> int -> unit Lwt.t

val clear_halt : handle -> endpoint -> unit Lwt.t

val reset_device : handle -> unit Lwt.t

module Class : sig ... end

type device_descriptor = {

dd_usb : int;
dd_device_class : Class.t;
dd_device_sub_class : int;
dd_device_protocol : int;
dd_max_packet_size : int;
dd_vendor_id : int;
dd_product_id : int;
dd_device : int;
dd_index_manufacturer : int;
dd_index_product : int;
dd_index_serial_number : int;
dd_configurations : int;

}

val get_device_descriptor : device -> device_descriptor

type endpoint_descriptor = {

ed_endpoint_address : int;
ed_attributes : int;
ed_max_packet_size : int;
ed_interval : int;
ed_refresh : int;
ed_synch_address : int;

}

type interface_descriptor = {

id_interface : int;
id_alternate_setting : int;
id_interface_class : Class.t;
id_interface_sub_class : int;
id_interface_protocol : int;
id_index_interface : int;
id_endpoints : endpoint_descriptor array;

}

type config_descriptor = {

cd_configuration_value : int;
cd_index_configuration : int;
cd_attributes : int;
cd_max_power : int;
cd_interfaces : interface_descriptor array array;

}

val get_active_config_descriptor : device -> config_descriptor

val get_config_descriptor : device -> int -> config_descriptor

val get_config_descriptor_by_value : device -> int -> config_descriptor

module DT : sig ... end

val get_string_descriptor : 
  handle ->
  ?timeout:float ->
  ?lang_id:int ->
  index:int ->
  string Lwt.t

type transfer_error =

| Transfer_error
| Transfer_timed_out
| Transfer_cancelled
| Transfer_stall
| Transfer_no_device
| Transfer_overflow

exception Transfer of transfer_error * string

val transfer_error_message : transfer_error -> string

val bulk_recv : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int ->
  int Lwt.t

val bulk_send : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int ->
  int Lwt.t

val interrupt_recv : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int ->
  int Lwt.t

val interrupt_send : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int ->
  int Lwt.t

type iso_result =

| Iso_ok of int
| Iso_error of transfer_error * string

val iso_recv : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int list ->
  iso_result list Lwt.t

val iso_send : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  string ->
  int ->
  int list ->
  iso_result list Lwt.t

type recipient =

| Device
| Interface
| Endpoint
| Other

type request_type =

| Standard
| Class
| Vendor
| Reserved

type request = int

val control_send : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  ?recipient:recipient ->
  ?request_type:request_type ->
  request:request ->
  value:int ->
  index:int ->
  string ->
  int ->
  int ->
  int Lwt.t

val control_recv : 
  handle:handle ->
  endpoint:endpoint ->
  ?timeout:float ->
  ?recipient:recipient ->
  ?request_type:request_type ->
  request:request ->
  value:int ->
  index:int ->
  string ->
  int ->
  int ->
  int Lwt.t

module Request : sig ... end

package usb