{-# LANGUAGE UnicodeSyntax, NoImplicitPrelude, DeriveDataTypeable #-}moduleSystem.USB.Internalwhere---------------------------------------------------------------------------------- Imports---------------------------------------------------------------------------------- from base:importPrelude(Num,(+),(-),(*),fromInteger,Integral,fromIntegral,div,Enum,error)importForeign(unsafePerformIO)importForeign.C.Types(CUChar,CInt,CUInt)importForeign.C.String(CStringLen)importForeign.Marshal.Alloc(alloca)importForeign.Marshal.Array(peekArray,allocaArray)importForeign.Storable(Storable,peek,peekElemOff)importForeign.Ptr(Ptr,castPtr,plusPtr,nullPtr)importForeign.ForeignPtr(ForeignPtr,newForeignPtr,withForeignPtr)importControl.Applicative(liftA2)importControl.Exception(Exception,throwIO,bracket,bracket_,block,unblock,onException,assert)importControl.Monad(Monad,return,(>>=),(>>),(=<<),fail,when,forM)importControl.Arrow((&&&))importData.Function(($),flip,on)importData.Functor(Functor,fmap,(<$>))importData.Data(Data)importData.Typeable(Typeable)importData.Maybe(Maybe(Nothing,Just),fromMaybe)importData.List(lookup,map,(++))importData.Int(Int)importData.Word(Word8,Word16)importData.Char(String)importData.Eq(Eq,(==))importData.Ord(Ord,(<),(>))importData.Bool(Bool(False,True),not,otherwise)importData.Bits(Bits,(.|.),setBit,testBit,shiftL)importSystem.IO(IO)importText.Show(Show,show)importText.Read(Read)importText.Printf(printf)-- from base-unicode-symbols:importData.Function.Unicode((∘))importData.Bool.Unicode((∧))importData.Eq.Unicode((≢),(≡))-- from bytestring:importqualifiedData.ByteStringasB(ByteString,packCStringLen,drop)importqualifiedData.ByteString.InternalasBI(createAndTrim,createAndTrim')importqualifiedData.ByteString.UnsafeasBU(unsafeUseAsCStringLen)-- from text:importqualifiedData.TextasT(unpack)importqualifiedData.Text.EncodingasTE(decodeUtf16LE)-- from bindings-libusb:importBindings.Libusb-- from usb:importUtils(bits,between,void,genToEnum,genFromEnum,mapPeekArray,ifM,decodeBCD)---------------------------------------------------------------------------------- * Initialization--------------------------------------------------------------------------------{-| Abstract type representing a USB session.
The concept of individual sessions allows your program to use multiple threads
that can independently use this library without interfering with eachother.
Sessions are created and initialized by 'newCtx' and are automatically closed
when they are garbage collected.
The only functions that receive a @Ctx@ are 'setDebug' and 'getDevices'.
-}newtypeCtx=Ctx{unCtx∷ForeignPtrC'libusb_context}deriving(Eq,Typeable)withCtxPtr∷Ctx→(PtrC'libusb_context→IOα)→IOαwithCtxPtr=withForeignPtr∘unCtx-- | Create and initialize a new USB context.---- This function may throw 'USBException's.newCtx∷IOCtxnewCtx=alloca$\ctxPtrPtr→dohandleUSBException$c'libusb_initctxPtrPtrpeekctxPtrPtr>>=fmapCtx∘newForeignPtrp'libusb_exit{-| Set message verbosity.
The default level is 'PrintNothing'. This means no messages are ever
printed. If you choose to increase the message verbosity level you must ensure
that your application does not close the @stdout@/@stderr@ file descriptors.
You are advised to set the debug level to 'PrintWarnings'. Libusb is
conservative with its message logging. Most of the time it will only log
messages that explain error conditions and other oddities. This will help you
debug your software.
The LIBUSB_DEBUG environment variable overrules the debug level set by this
function. The message verbosity is fixed to the value in the environment
variable if it is defined.
If @libusb@ was compiled without any message logging, this function does nothing:
you'll never get any messages.
If @libusb@ was compiled with verbose debug message logging, this function does
nothing: you'll always get messages from all levels.
-}setDebug∷Ctx→Verbosity→IO()setDebugctxverbosity=withCtxPtrctx$\ctxPtr→c'libusb_set_debugctxPtr$genFromEnumverbosity-- | Message verbositydataVerbosity=PrintNothing-- ^ No messages are ever printed by the library|PrintErrors-- ^ Error messages are printed to stderr|PrintWarnings-- ^ Warning and error messages are printed to stderr|PrintInfo-- ^ Informational messages are printed to stdout,-- warning and error messages are printed to stderrderiving(Enum,Show,Read,Eq,Ord,Data,Typeable)---------------------------------------------------------------------------------- * Enumeration--------------------------------------------------------------------------------{-| Abstract type representing a USB device detected on the system.
You can only obtain a USB device from the 'getDevices' function.
Certain operations can be performed on a device, but in order to do any I/O you
will have to first obtain a 'DeviceHandle' using 'openDevice'. Alternatively you
can use the /usb-safe/ package which provides type-safe device handling. See:
<http://hackage.haskell.org/package/usb-safe>
Just because you have a reference to a device does not mean it is necessarily
usable. The device may have been unplugged, you may not have permission to
operate such device or another process or driver may be using the device.
To get additional information about a device you can retrieve its descriptor
using 'deviceDesc'.
Note that equality on devices is defined by comparing their descriptors:
@(==) = (==) \`on\` `deviceDesc`@
-}dataDevice=Device{_ctx∷!Ctx-- ^ This reference to the 'Ctx' is needed so that it won't-- get garbage collected. The finalizer "p'libusb_exit" is-- run only when all references to 'Devices' are gone.,getDevFrgnPtr∷!(ForeignPtrC'libusb_device),deviceDesc∷!DeviceDesc-- ^ Get the descriptor of the device.}derivingTypeableinstanceEqDevicewhere(==)=(==)`on`deviceDescinstanceShowDevicewhereshowd=printf"Bus %03d Device %03d: ID %04x:%04x"(busNumberd)(deviceAddressd)(deviceVendorIddesc)(deviceProductIddesc)wheredesc=deviceDescdwithDevicePtr∷Device→(PtrC'libusb_device→IOα)→IOαwithDevicePtr=withForeignPtr∘getDevFrgnPtr{-| Returns a list of USB devices currently attached to the system.
This is your entry point into finding a USB device.
Exceptions:
* 'NoMemException' on a memory allocation failure.
-}{-
Visual description of the 'devPtrArrayPtr':
D
^ D
D │ ^
^ │ │
│ │ │
devPtrArrayPtr: ┏━┷━┳━┷━┳━━━┳━━━┳━┷━┓
P ───> ┃ P ┃ P ┃ P ┃ P ┃ P ┃
┗━━━┻━━━┻━┯━┻━┯━┻━━━┛
│ │
P = pointer v │
D = device structure D │
v
D
-}getDevices∷Ctx→IO[Device]getDevicesctx=alloca$\devPtrArrayPtr→block$donumDevs←withCtxPtrctx$flipc'libusb_get_device_listdevPtrArrayPtrwhen(numDevs≡c'LIBUSB_ERROR_NO_MEM)$throwIONoMemExceptiondevPtrArray←peekdevPtrArrayPtrletfreeDevPtrArray=c'libusb_free_device_listdevPtrArray0devs←unblock(mapPeekArraymkDev(fromIntegralnumDevs)devPtrArray)`onException`freeDevPtrArrayfreeDevPtrArrayreturndevswheremkDev∷PtrC'libusb_device→IODevicemkDevdevPtr=liftA2(Devicectx)(newForeignPtrp'libusb_unref_devicedevPtr)(getDeviceDescdevPtr)-- | The number of the bus that a device is connected to.busNumber∷Device→Word8busNumberdev=-- Getting the bus number from libusb is a side-effect free-- operation. The bus number is a static variable in the device-- structure. That's why it's safe to use:unsafePerformIO$withDevicePtrdevc'libusb_get_bus_number-- | The address of the device on the bus it is connected to.deviceAddress∷Device→Word8deviceAddressdev=-- Getting the device address from libusb is a side-effect-- free operation. The device address is a static variable-- in the device structure. That's why it's safe to use:unsafePerformIO$withDevicePtrdevc'libusb_get_device_address---------------------------------------------------------------------------------- * Device handling------------------------------------------------------------------------------------------------------------------------------------------------------------------ ** Opening & closing devices--------------------------------------------------------------------------------{-| Abstract type representing a handle of a USB device.
You can acquire a handle from 'openDevice'.
A device handle is used to perform I/O and other operations. When finished with
a device handle you should close it by applying 'closeDevice' to it.
-}dataDeviceHandle=DeviceHandle{getDevice∷!Device-- This reference is needed for keeping the 'Device'-- and therefor the 'Ctx' alive.-- ^ Retrieve the 'Device' from the 'DeviceHandle'.,getDevHndlPtr∷!(PtrC'libusb_device_handle)-- ^ Retrieve the pointer to the @libusb@ device handle.}derivingTypeableinstanceEqDeviceHandlewhere(==)=(==)`on`getDevHndlPtrinstanceShowDeviceHandlewhereshowdevHndl="{USB device handle to: "++show(getDevicedevHndl)++"}"{-| Open a device and obtain a device handle.
A handle allows you to perform I/O on the device in question.
This is a non-blocking function; no requests are sent over the bus.
It is advisable to use 'withDeviceHandle' because it automatically closes the
device when the computation terminates.
Exceptions:
* 'NoMemException' if there is a memory allocation failure.
* 'AccessException' if the user has insufficient permissions.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}openDevice∷Device→IODeviceHandleopenDevicedev=withDevicePtrdev$\devPtr→alloca$\devHndlPtrPtr→dohandleUSBException$c'libusb_opendevPtrdevHndlPtrPtrDeviceHandledev<$>peekdevHndlPtrPtr{-| Close a device handle.
Should be called on all open handles before your application exits.
This is a non-blocking function; no requests are sent over the bus.
-}closeDevice∷DeviceHandle→IO()closeDevice=c'libusb_close∘getDevHndlPtr{-| @withDeviceHandle dev act@ opens the 'Device' @dev@ and passes
the resulting handle to the computation @act@. The handle will be closed on exit
from @withDeviceHandle@ whether by normal termination or by raising an
exception.
-}withDeviceHandle∷Device→(DeviceHandle→IOα)→IOαwithDeviceHandledev=bracket(openDevicedev)closeDevice---------------------------------------------------------------------------------- ** Getting & setting the configuration---------------------------------------------------------------------------------- | Identifier for configurations.---- Can be retrieved by 'getConfig' or by 'configValue'.typeConfigValue=Word8{-| Determine the value of the currently active configuration.
You could formulate your own control request to obtain this information, but
this function has the advantage that it may be able to retrieve the information
from operating system caches (no I/O involved).
If the OS does not cache this information, then this function will block while
a control transfer is submitted to retrieve the information.
This function will return a value of 0 if the device is in unconfigured state.
Exceptions:
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}getConfig∷DeviceHandle→IOConfigValuegetConfigdevHndl=alloca$\configPtr→dohandleUSBException$c'libusb_get_configuration(getDevHndlPtrdevHndl)configPtrfromIntegral<$>peekconfigPtr{-| Set the active configuration for a device.
The operating system may or may not have already set an active configuration on
the device. It is up to your application to ensure the correct configuration is
selected before you attempt to claim interfaces and perform other operations.
If you call this function on a device already configured with the selected
configuration, then this function will act as a lightweight device reset: it
will issue a SET_CONFIGURATION request using the current configuration, causing
most USB-related device state to be reset (altsetting reset to zero, endpoint
halts cleared, toggles reset).
You cannot change/reset configuration if your application has claimed interfaces
- you should free them with 'releaseInterface' first. You cannot change/reset
configuration if other applications or drivers have claimed interfaces.
A configuration value of -1 will put the device in an unconfigured state. The
USB specification states that a configuration value of 0 does this, however
buggy devices exist which actually have a configuration 0.
You should always use this function rather than formulating your own
SET_CONFIGURATION control request. This is because the underlying operating
system needs to know when such changes happen.
This is a blocking function.
Exceptions:
* 'NotFoundException' if the requested configuration does not exist.
* 'BusyException' if interfaces are currently claimed.
* 'NoDeviceException' if the device has been disconnected
* Another 'USBException'.
-}setConfig∷DeviceHandle→ConfigValue→IO()setConfigdevHndl=handleUSBException∘c'libusb_set_configuration(getDevHndlPtrdevHndl)∘fromIntegral---------------------------------------------------------------------------------- ** Claiming & releasing interfaces--------------------------------------------------------------------------------{-| Identifier for interfaces.
Can be retrieved by 'interfaceNumber'.
-}typeInterfaceNumber=Word8{-| Claim an interface on a given device handle.
You must claim the interface you wish to use before you can perform I/O on any
of its endpoints.
It is legal to attempt to claim an already-claimed interface, in which case this
function just returns without doing anything.
Claiming of interfaces is a purely logical operation; it does not cause any
requests to be sent over the bus. Interface claiming is used to instruct the
underlying operating system that your application wishes to take ownership of
the interface.
This is a non-blocking function.
Exceptions:
* 'NotFoundException' if the requested interface does not exist.
* 'BusyException' if the interface is already claimed.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}claimInterface∷DeviceHandle→InterfaceNumber→IO()claimInterfacedevHndlifNum=handleUSBException$c'libusb_claim_interface(getDevHndlPtrdevHndl)(fromIntegralifNum){-| Release an interface previously claimed with 'claimInterface'.
You should release all claimed interfaces before closing a device handle.
This is a blocking function. A SET_INTERFACE control request will be sent to the
device, resetting interface state to the first alternate setting.
Exceptions:
* 'NotFoundException' if the interface was not claimed.
* 'NoDeviceException' if the device has been disconnected
* Another 'USBException'.
-}releaseInterface∷DeviceHandle→InterfaceNumber→IO()releaseInterfacedevHndlifNum=handleUSBException$c'libusb_release_interface(getDevHndlPtrdevHndl)(fromIntegralifNum){-| @withClaimedInterface@ claims the interface on the given device handle then
executes the given computation. On exit from @withClaimedInterface@, the
interface is released whether by normal termination or by raising an exception.
-}withClaimedInterface∷DeviceHandle→InterfaceNumber→IOα→IOαwithClaimedInterfacedevHndlifNum=bracket_(claimInterfacedevHndlifNum)(releaseInterfacedevHndlifNum)---------------------------------------------------------------------------------- ** Setting interface alternate settings---------------------------------------------------------------------------------- | Identifier for interface alternate settings.---- Can be retrieved by 'interfaceAltSetting'.typeInterfaceAltSetting=Word8{-| Activate an alternate setting for an interface.
The interface must have been previously claimed with 'claimInterface' or
'withInterfaceHandle'.
You should always use this function rather than formulating your own
SET_INTERFACE control request. This is because the underlying operating system
needs to know when such changes happen.
This is a blocking function.
Exceptions:
* 'NotFoundException' if the interface was not claimed or the requested
alternate setting does not exist.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}setInterfaceAltSetting∷DeviceHandle→InterfaceNumber→InterfaceAltSetting→IO()setInterfaceAltSettingdevHndlifNumalternateSetting=handleUSBException$c'libusb_set_interface_alt_setting(getDevHndlPtrdevHndl)(fromIntegralifNum)(fromIntegralalternateSetting)---------------------------------------------------------------------------------- ** Clearing & Resetting devices--------------------------------------------------------------------------------{-| Clear the halt/stall condition for an endpoint.
Endpoints with halt status are unable to receive or transmit data until the halt
condition is stalled.
You should cancel all pending transfers before attempting to clear the halt
condition.
This is a blocking function.
Exceptions:
* 'NotFoundException' if the endpoint does not exist.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}clearHalt∷DeviceHandle→EndpointAddress→IO()clearHaltdevHndl=handleUSBException∘c'libusb_clear_halt(getDevHndlPtrdevHndl)∘marshalEndpointAddress{-| Perform a USB port reset to reinitialize a device.
The system will attempt to restore the previous configuration and alternate
settings after the reset has completed.
If the reset fails, the descriptors change, or the previous state cannot be
restored, the device will appear to be disconnected and reconnected. This means
that the device handle is no longer valid (you should close it) and rediscover
the device. A 'NotFoundException' is raised to indicate that this is the
case.
This is a blocking function which usually incurs a noticeable delay.
Exceptions:
* 'NotFoundException' if re-enumeration is required, or if the
device has been disconnected.
* Another 'USBException'.
-}resetDevice∷DeviceHandle→IO()resetDevice=handleUSBException∘c'libusb_reset_device∘getDevHndlPtr---------------------------------------------------------------------------------- ** USB kernel drivers--------------------------------------------------------------------------------{-| Determine if a kernel driver is active on an interface.
If a kernel driver is active, you cannot claim the interface, and libusb will be
unable to perform I/O.
Exceptions:
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}kernelDriverActive∷DeviceHandle→InterfaceNumber→IOBoolkernelDriverActivedevHndlifNum=dor←c'libusb_kernel_driver_active(getDevHndlPtrdevHndl)(fromIntegralifNum)caserof0→returnFalse1→returnTrue_→throwIO$convertUSBExceptionr{-| Detach a kernel driver from an interface.
If successful, you will then be able to claim the interface and perform I/O.
Exceptions:
* 'NotFoundException' if no kernel driver was active.
* 'InvalidParamException' if the interface does not exist.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}detachKernelDriver∷DeviceHandle→InterfaceNumber→IO()detachKernelDriverdevHndlifNum=handleUSBException$c'libusb_detach_kernel_driver(getDevHndlPtrdevHndl)(fromIntegralifNum){-| Re-attach an interface's kernel driver, which was previously
detached using 'detachKernelDriver'.
Exceptions:
* 'NotFoundException' if no kernel driver was active.
* 'InvalidParamException' if the interface does not exist.
* 'NoDeviceException' if the device has been disconnected.
* 'BusyException' if the driver cannot be attached because the interface
is claimed by a program or driver.
* Another 'USBException'.
-}attachKernelDriver∷DeviceHandle→InterfaceNumber→IO()attachKernelDriverdevHndlifNum=handleUSBException$c'libusb_attach_kernel_driver(getDevHndlPtrdevHndl)(fromIntegralifNum){-| If a kernel driver is active on the specified interface the driver is
detached and the given action is executed. If the action terminates, whether by
normal termination or by raising an exception, the kernel driver is attached
again. If a kernel driver is not active on the specified interface the action is
just executed.
Exceptions:
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}withDetachedKernelDriver∷DeviceHandle→InterfaceNumber→IOα→IOαwithDetachedKernelDriverdevHndlifNumaction=ifM(kernelDriverActivedevHndlifNum)(bracket_(detachKernelDriverdevHndlifNum)(attachKernelDriverdevHndlifNum)action)action---------------------------------------------------------------------------------- * Descriptors------------------------------------------------------------------------------------------------------------------------------------------------------------------ ** Device descriptor--------------------------------------------------------------------------------{-| A structure representing the standard USB device descriptor.
This descriptor is documented in section 9.6.1 of the USB 2.0 specification.
This structure can be retrieved by 'deviceDesc'.
-}dataDeviceDesc=DeviceDesc{-- | USB specification release number.deviceUSBSpecReleaseNumber∷!ReleaseNumber-- | USB-IF class code for the device.,deviceClass∷!Word8-- | USB-IF subclass code for the device, qualified by the 'deviceClass'-- value.,deviceSubClass∷!Word8-- | USB-IF protocol code for the device, qualified by the 'deviceClass'-- and 'deviceSubClass' values.,deviceProtocol∷!Word8-- | Maximum packet size for endpoint 0.,deviceMaxPacketSize0∷!Word8-- | USB-IF vendor ID.,deviceVendorId∷!VendorId-- | USB-IF product ID.,deviceProductId∷!ProductId-- | Device release number.,deviceReleaseNumber∷!ReleaseNumber-- | Optional index of string descriptor describing manufacturer.,deviceManufacturerStrIx∷!(MaybeStrIx)-- | Optional index of string descriptor describing product.,deviceProductStrIx∷!(MaybeStrIx)-- | Optional index of string descriptor containing device serial number.,deviceSerialNumberStrIx∷!(MaybeStrIx)-- | Number of possible configurations.,deviceNumConfigs∷!Word8-- | List of configurations supported by the device.,deviceConfigs∷![ConfigDesc]}deriving(Show,Read,Eq,Data,Typeable)typeReleaseNumber=(Int,Int,Int,Int)typeVendorId=Word16typeProductId=Word16---------------------------------------------------------------------------------- ** Configuration descriptor--------------------------------------------------------------------------------{-| A structure representing the standard USB configuration descriptor.
This descriptor is documented in section 9.6.3 of the USB 2.0 specification.
This structure can be retrieved by 'deviceConfigs'.
-}dataConfigDesc=ConfigDesc{-- | Identifier value for the configuration.configValue∷!ConfigValue-- | Optional index of string descriptor describing the configuration.,configStrIx∷!(MaybeStrIx)-- | Configuration characteristics.,configAttribs∷!ConfigAttribs-- | Maximum power consumption of the USB device from the bus in the-- configuration when the device is fully operational. Expressed in 2 mA-- units (i.e., 50 = 100 mA).,configMaxPower∷!Word8-- | Number of interfaces supported by the configuration.,configNumInterfaces∷!Word8-- | List of interfaces supported by the configuration. Note that the-- length of this list should equal 'configNumInterfaces'.,configInterfaces∷![Interface]-- | Extra descriptors. If @libusb@ encounters unknown configuration-- descriptors, it will store them here, should you wish to parse them.,configExtra∷!B.ByteString}deriving(Show,Read,Eq,Data,Typeable)-- | An interface is represented as a list of alternate interface settings.typeInterface=[InterfaceDesc]---------------------------------------------------------------------------------- *** Configuration attributes---------------------------------------------------------------------------------- | The USB 2.0 specification specifies that the configuration attributes only-- describe the device status.typeConfigAttribs=DeviceStatusdataDeviceStatus=DeviceStatus{remoteWakeup∷!Bool-- ^ The Remote Wakeup field indicates whether the-- device is currently enabled to request remote-- wakeup. The default mode for devices that-- support remote wakeup is disabled.,selfPowered∷!Bool-- ^ The Self Powered field indicates whether the-- device is currently self-powered}deriving(Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- ** Interface descriptor--------------------------------------------------------------------------------{-| A structure representing the standard USB interface descriptor.
This descriptor is documented in section 9.6.5 of the USB 2.0 specification.
This structure can be retrieved using 'configInterfaces'.
-}dataInterfaceDesc=InterfaceDesc{-- | Number of the interface.interfaceNumber∷!InterfaceNumber-- | Value used to select the alternate setting for the interface.,interfaceAltSetting∷!InterfaceAltSetting-- | USB-IF class code for the interface.,interfaceClass∷!Word8-- | USB-IF subclass code for the interface, qualified by the-- 'interfaceClass' value.,interfaceSubClass∷!Word8-- | USB-IF protocol code for the interface, qualified by the-- 'interfaceClass' and 'interfaceSubClass' values.,interfaceProtocol∷!Word8-- | Optional index of string descriptor describing the interface.,interfaceStrIx∷!(MaybeStrIx)-- | List of endpoints supported by the interface.,interfaceEndpoints∷![EndpointDesc]-- | Extra descriptors. If @libusb@ encounters unknown interface-- descriptors, it will store them here, should you wish to parse them.,interfaceExtra∷!B.ByteString}deriving(Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- ** Endpoint descriptor--------------------------------------------------------------------------------{-| A structure representing the standard USB endpoint descriptor.
This descriptor is documented in section 9.6.3 of the USB 2.0 specification. All
multiple-byte fields are represented in host-endian format.
-}dataEndpointDesc=EndpointDesc{-- | The address of the endpoint described by the descriptor.endpointAddress∷!EndpointAddress-- | Attributes which apply to the endpoint when it is configured using the-- 'configValue'.,endpointAttribs∷!EndpointAttribs-- | Maximum packet size the endpoint is capable of sending/receiving.,endpointMaxPacketSize∷!MaxPacketSize-- | Interval for polling endpoint for data transfers. Expressed in frames-- or microframes depending on the device operating speed (i.e., either 1-- millisecond or 125 &#956;s units).,endpointInterval∷!Word8-- | /For audio devices only:/ the rate at which synchronization feedback-- is provided.,endpointRefresh∷!Word8-- | /For audio devices only:/ the address if the synch endpoint.,endpointSynchAddress∷!Word8-- | Extra descriptors. If @libusb@ encounters unknown endpoint descriptors,-- it will store them here, should you wish to parse them.,endpointExtra∷!B.ByteString}deriving(Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- *** Endpoint address---------------------------------------------------------------------------------- | The address of an endpoint.dataEndpointAddress=EndpointAddress{endpointNumber∷!Int-- ^ Must be >= 0 and <= 15,transferDirection∷!TransferDirection}deriving(Show,Read,Eq,Data,Typeable)-- | The direction of data transfer relative to the host.dataTransferDirection=Out-- ^ Out transfer direction (host -> device) used-- for writing.|In-- ^ In transfer direction (device -> host) used-- for reading.deriving(Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- *** Endpoint attributes---------------------------------------------------------------------------------- | The USB 2.0 specification specifies that the endpoint attributes only-- describe the endpoint transfer type.typeEndpointAttribs=TransferType-- | Describes what types of transfers are allowed on the endpoint.dataTransferType=-- | Control transfers are typically used for command and status-- operations.Control-- | Isochronous transfers occur continuously and periodically.|Isochronous!Synchronization!Usage-- | Bulk transfers can be used for large bursty data.|Bulk-- | Interrupt transfers are typically non-periodic, small device-- \"initiated\" communication requiring bounded latency.|Interruptderiving(Show,Read,Eq,Data,Typeable)dataSynchronization=NoSynchronization|Asynchronous|Adaptive|Synchronousderiving(Enum,Show,Read,Eq,Data,Typeable)dataUsage=Data|Feedback|Implicitderiving(Enum,Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- *** Endpoint max packet size--------------------------------------------------------------------------------dataMaxPacketSize=MaxPacketSize{maxPacketSize∷!Size,transactionOpportunities∷!TransactionOpportunities}deriving(Show,Read,Eq,Data,Typeable)-- | Number of additional transactions.dataTransactionOpportunities=Zero|One|Twoderiving(Enum,Ord,Show,Read,Eq,Data,Typeable)---------------------------------------------------------------------------------- Retrieving and converting descriptors--------------------------------------------------------------------------------getDeviceDesc∷PtrC'libusb_device→IODeviceDescgetDeviceDescdevPtr=alloca$\devDescPtr→dohandleUSBException$c'libusb_get_device_descriptordevPtrdevDescPtrpeekdevDescPtr>>=convertDeviceDescdevPtrconvertDeviceDesc∷PtrC'libusb_device→C'libusb_device_descriptor→IODeviceDescconvertDeviceDescdevPtrd=doletnumConfigs=c'libusb_device_descriptor'bNumConfigurationsdconfigs←forM[0..numConfigs-1]$getConfigDescdevPtrreturnDeviceDesc{deviceUSBSpecReleaseNumber=unmarshalReleaseNumber$c'libusb_device_descriptor'bcdUSBd,deviceClass=c'libusb_device_descriptor'bDeviceClassd,deviceSubClass=c'libusb_device_descriptor'bDeviceSubClassd,deviceProtocol=c'libusb_device_descriptor'bDeviceProtocold,deviceMaxPacketSize0=c'libusb_device_descriptor'bMaxPacketSize0d,deviceVendorId=c'libusb_device_descriptor'idVendord,deviceProductId=c'libusb_device_descriptor'idProductd,deviceReleaseNumber=unmarshalReleaseNumber$c'libusb_device_descriptor'bcdDeviced,deviceManufacturerStrIx=unmarshalStrIx$c'libusb_device_descriptor'iManufacturerd,deviceProductStrIx=unmarshalStrIx$c'libusb_device_descriptor'iProductd,deviceSerialNumberStrIx=unmarshalStrIx$c'libusb_device_descriptor'iSerialNumberd,deviceNumConfigs=numConfigs,deviceConfigs=configs}unmarshalReleaseNumber∷Word16→ReleaseNumberunmarshalReleaseNumberabcd=(a,b,c,d)where[a,b,c,d]=mapfromIntegral$decodeBCD4abcdunmarshalStrIx∷Word8→MaybeStrIxunmarshalStrIxstrIx|strIx≡0=Nothing|otherwise=JuststrIxgetConfigDesc∷PtrC'libusb_device→Word8→IOConfigDescgetConfigDescdevPtrix=bracketgetConfigDescPtrc'libusb_free_config_descriptor((convertConfigDesc=<<)∘peek)wheregetConfigDescPtr=alloca$\configDescPtrPtr→dohandleUSBException$c'libusb_get_config_descriptordevPtrixconfigDescPtrPtrpeekconfigDescPtrPtrconvertConfigDesc∷C'libusb_config_descriptor→IOConfigDescconvertConfigDescc=doletnumInterfaces=c'libusb_config_descriptor'bNumInterfacescinterfaces←mapPeekArrayconvertInterface(fromIntegralnumInterfaces)(c'libusb_config_descriptor'interfacec)extra←getExtra(c'libusb_config_descriptor'extrac)(c'libusb_config_descriptor'extra_lengthc)returnConfigDesc{configValue=c'libusb_config_descriptor'bConfigurationValuec,configStrIx=unmarshalStrIx$c'libusb_config_descriptor'iConfigurationc,configAttribs=unmarshalConfigAttribs$c'libusb_config_descriptor'bmAttributesc,configMaxPower=c'libusb_config_descriptor'MaxPowerc,configNumInterfaces=numInterfaces,configInterfaces=interfaces,configExtra=extra}unmarshalConfigAttribs∷Word8→ConfigAttribsunmarshalConfigAttribsa=DeviceStatus{remoteWakeup=testBita5,selfPowered=testBita6}getExtra∷PtrCUChar→CInt→IOB.ByteStringgetExtraextraextraLength=B.packCStringLen(castPtrextra,fromIntegralextraLength)convertInterface∷C'libusb_interface→IO[InterfaceDesc]convertInterfacei=mapPeekArrayconvertInterfaceDesc(fromIntegral$c'libusb_interface'num_altsettingi)(c'libusb_interface'altsettingi)convertInterfaceDesc∷C'libusb_interface_descriptor→IOInterfaceDescconvertInterfaceDesci=doletnumEndpoints=c'libusb_interface_descriptor'bNumEndpointsiendpoints←mapPeekArrayconvertEndpointDesc(fromIntegralnumEndpoints)(c'libusb_interface_descriptor'endpointi)extra←getExtra(c'libusb_interface_descriptor'extrai)(c'libusb_interface_descriptor'extra_lengthi)returnInterfaceDesc{interfaceNumber=c'libusb_interface_descriptor'bInterfaceNumberi,interfaceAltSetting=c'libusb_interface_descriptor'bAlternateSettingi,interfaceClass=c'libusb_interface_descriptor'bInterfaceClassi,interfaceSubClass=c'libusb_interface_descriptor'bInterfaceSubClassi,interfaceStrIx=unmarshalStrIx$c'libusb_interface_descriptor'iInterfacei,interfaceProtocol=c'libusb_interface_descriptor'bInterfaceProtocoli,interfaceEndpoints=endpoints,interfaceExtra=extra}convertEndpointDesc∷C'libusb_endpoint_descriptor→IOEndpointDescconvertEndpointDesce=doextra←getExtra(c'libusb_endpoint_descriptor'extrae)(c'libusb_endpoint_descriptor'extra_lengthe)returnEndpointDesc{endpointAddress=unmarshalEndpointAddress$c'libusb_endpoint_descriptor'bEndpointAddresse,endpointAttribs=unmarshalEndpointAttribs$c'libusb_endpoint_descriptor'bmAttributese,endpointMaxPacketSize=unmarshalMaxPacketSize$c'libusb_endpoint_descriptor'wMaxPacketSizee,endpointInterval=c'libusb_endpoint_descriptor'bIntervale,endpointRefresh=c'libusb_endpoint_descriptor'bRefreshe,endpointSynchAddress=c'libusb_endpoint_descriptor'bSynchAddresse,endpointExtra=extra}unmarshalEndpointAddress∷Word8→EndpointAddressunmarshalEndpointAddressa=EndpointAddress{endpointNumber=fromIntegral$bits03a,transferDirection=iftestBita7thenInelseOut}-- | Marshal an @EndpointAddress@ so that it can be used by the @libusb@-- transfer functions.marshalEndpointAddress∷(Bitsa,Numa)⇒EndpointAddress→amarshalEndpointAddress(EndpointAddressnumtransDir)=assert(betweennum015)$letn=fromIntegralnumincasetransDirofOut→nIn→setBitn7unmarshalEndpointAttribs∷Word8→EndpointAttribsunmarshalEndpointAttribsa=casebits01aof0→Control1→Isochronous(genToEnum$bits23a)(genToEnum$bits45a)2→Bulk3→Interrupt_→error"unmarshalEndpointAttribs: this can't happen!"unmarshalMaxPacketSize∷Word16→MaxPacketSizeunmarshalMaxPacketSizem=MaxPacketSize{maxPacketSize=fromIntegral$bits010m,transactionOpportunities=genToEnum$bits1112m}---------------------------------------------------------------------------------- ** String descriptors---------------------------------------------------------------------------------- | The size in number of bytes of the header of string descriptorsstrDescHeaderSize∷SizestrDescHeaderSize=2{-| Retrieve a list of supported languages.
This function may throw 'USBException's.
-}getLanguages∷DeviceHandle→IO[LangId]getLanguagesdevHndl=allocaArraymaxSize$\dataPtr→doreportedSize←writedataPtrletstrSize=(reportedSize-strDescHeaderSize)`div`2strPtr=castPtr$dataPtr`plusPtr`strDescHeaderSizemapunmarshalLangId<$>peekArraystrSizestrPtrwheremaxSize=255-- Some devices choke on size > 255write=putStrDescdevHndl00maxSize{-| @putStrDesc devHndl strIx langId maxSize dataPtr@ retrieves the
string descriptor @strIx@ in the language @langId@ from the @devHndl@
and writes at most @maxSize@ bytes from that string descriptor to the
location that @dataPtr@ points to. So ensure there is at least space
for @maxSize@ bytes there. Next, the header of the string descriptor
is checked for correctness. If it's incorrect an 'IOException' is
thrown. Finally, the size reported in the header is returned.
-}putStrDesc∷DeviceHandle→StrIx→Word16→Size→PtrCUChar→IOSizeputStrDescdevHndlstrIxlangIdmaxSizedataPtr=doactualSize←checkUSBException$c'libusb_get_string_descriptor(getDevHndlPtrdevHndl)strIxlangIddataPtr(fromIntegralmaxSize)when(actualSize<strDescHeaderSize)$throwIO$IOException"Incomplete header"reportedSize←peekdataPtrwhen(reportedSize>fromIntegralactualSize)$throwIO$IOException"Not enough space to hold data"descType←peekElemOffdataPtr1when(descType≢c'LIBUSB_DT_STRING)$throwIO$IOException"Invalid header"return$fromIntegralreportedSize{-| The language ID consists of the primary language identifier and the
sublanguage identififier as described in:
<http://www.usb.org/developers/docs/USB_LANGIDs.pdf>
For a mapping between IDs and languages see the @usb-id-database@ package at:
<http://hackage.haskell.org/package/usb-id-database>
To see which 'LangId's are supported by a device see 'getLanguages'.
-}typeLangId=(PrimaryLangId,SubLangId)typePrimaryLangId=Word16typeSubLangId=Word16unmarshalLangId∷Word16→LangIdunmarshalLangId=bits09&&&bits1015marshalLangId∷LangId→Word16marshalLangId(p,s)=p.|.s`shiftL`10-- | Type of indici of string descriptors.---- Can be retrieved by all the *StrIx functions.typeStrIx=Word8{-| Retrieve a string descriptor from a device.
This is a convenience function which formulates the appropriate control message
to retrieve the descriptor. The string returned is Unicode, as detailed in the
USB specifications.
This function may throw 'USBException's.
-}getStrDesc∷DeviceHandle→StrIx→LangId→Int-- ^ Maximum number of characters in the requested string. An-- 'IOException' will be thrown when the requested string is-- larger than this number.→IOStringgetStrDescdevHndlstrIxlangIdnrOfChars=assert(strIx≢0)$fmapdecode$BI.createAndTrimsize$write∘castPtrwherewrite=putStrDescdevHndlstrIx(marshalLangIdlangId)sizesize=strDescHeaderSize+2*nrOfChars-- characters are 2 bytesdecode=T.unpack∘TE.decodeUtf16LE∘B.dropstrDescHeaderSize{-| Retrieve a string descriptor from a device using the first supported
language.
This is a convenience function which formulates the appropriate control message
to retrieve the descriptor. The string returned is Unicode, as detailed in the
USB specifications.
This function may throw 'USBException's.
-}getStrDescFirstLang∷DeviceHandle→StrIx→Int-- ^ Maximum number of characters in the requested-- string. An 'IOException' will be thrown when the-- requested string is larger than this number.→IOStringgetStrDescFirstLangdevHndlstrIxnrOfChars=dolangIds←getLanguagesdevHndlcaselangIdsof[]→throwIO$IOException"Zero languages"langId:_→getStrDescdevHndlstrIxlangIdnrOfChars---------------------------------------------------------------------------------- * Asynchronous device I/O---------------------------------------------------------------------------------- TODO: Not implemented yet. I'm not sure if I should implement it because you-- can simulate asynchronous IO using threads.---------------------------------------------------------------------------------- * Synchronous device I/O--------------------------------------------------------------------------------{-| Handy type synonym for read transfers.
A @ReadAction@ is a function which takes a 'Size' which defines how many bytes
to read and a 'Timeout'. The function returns an 'IO' action which, when
executed, performs the actual read and returns the 'B.ByteString' that was read
paired with a flag which indicates whether a transfer timed out.
-}typeReadAction=Size→Timeout→IO(B.ByteString,TimedOut){-| Handy type synonym for write transfers.
A @WriteAction@ is a function which takes a 'B.ByteString' to write and a
'Timeout'. The function returns an 'IO' action which, when exectued, returns the
number of bytes that were actually written paired with an flag which indicates
whether a transfer timed out.
-}typeWriteAction=B.ByteString→Timeout→IO(Size,TimedOut)-- | A timeout in milliseconds. A timeout defines how long a transfer should wait-- before giving up due to no response being received. For no timeout, use value-- 0.typeTimeout=Int-- | 'True' when a transfer timed out and 'False' otherwise.typeTimedOut=Bool-- | Number of bytes transferred.typeSize=Int--------------------------------------------------------------------------------- ** Control transfers--------------------------------------------------------------------------------- | Handy type synonym that names the parameters of a control transfer.typeControlActionα=RequestType→Recipient→Request→Value→Index→αdataRequestType=Standard|Class|Vendorderiving(Enum,Show,Read,Eq,Data,Typeable)dataRecipient=ToDevice|ToInterface|ToEndpoint|ToOtherderiving(Enum,Show,Read,Eq,Data,Typeable)typeRequest=Word8-- | (Host-endian)typeValue=Word16-- | (Host-endian)typeIndex=Word16marshalRequestType∷RequestType→Recipient→Word8marshalRequestTypetr=genFromEnumt`shiftL`5.|.genFromEnumr{-| Perform a USB /control/ request that does not transfer data.
Exceptions:
* 'TimeoutException' if the transfer timed out.
* 'PipeException' if the control request was not supported by the device
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}control∷DeviceHandle→ControlAction(Timeout→IO())controldevHndl=\reqTypereqRecipientrequestvalueindex→\timeout→void$checkUSBException$c'libusb_control_transfer(getDevHndlPtrdevHndl)(marshalRequestTypereqTypereqRecipient)requestvalueindexnullPtr0(fromIntegraltimeout){-| Perform a USB /control/ read.
Exceptions:
* 'PipeException' if the control request was not supported by the device
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}readControl∷DeviceHandle→ControlActionReadActionreadControldevHndl=\reqTypereqRecipientrequestvalueindex→\sizetimeout→BI.createAndTrim'size$\dataPtr→doerr←c'libusb_control_transfer(getDevHndlPtrdevHndl)(marshalRequestTypereqTypereqRecipient`setBit`7)requestvalueindex(castPtrdataPtr)(fromIntegralsize)(fromIntegraltimeout)lettimedOut=err≡c'LIBUSB_ERROR_TIMEOUTiferr<0∧nottimedOutthenthrowIO$convertUSBExceptionerrelsereturn(0,fromIntegralerr,timedOut)-- | A convenience function similar to 'readControl' which checks if the-- specified number of bytes to read were actually read. Throws an 'IOException'-- if this is not the case.readControlExact∷DeviceHandle→ControlAction(Size→Timeout→IOB.ByteString)readControlExactdevHndl=\reqTypereqRecipientrequestvalueindex→\sizetimeout→doBI.createAndTrimsize$\dataPtr→doerr←c'libusb_control_transfer(getDevHndlPtrdevHndl)(marshalRequestTypereqTypereqRecipient`setBit`7)requestvalueindex(castPtrdataPtr)(fromIntegralsize)(fromIntegraltimeout)iferr<0∧err≢c'LIBUSB_ERROR_TIMEOUTthenthrowIO$convertUSBExceptionerrelseiferr≢fromIntegralsizethenthrowIO$IOException"The read number of bytes doesn't equal the requested number"elsereturn$fromIntegralerr{-| Perform a USB /control/ write.
Exceptions:
* 'PipeException' if the control request was not supported by the device
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}writeControl∷DeviceHandle→ControlActionWriteActionwriteControldevHndl=\reqTypereqRecipientrequestvalueindex→\inputtimeout→BU.unsafeUseAsCStringLeninput$\(dataPtr,size)→doerr←c'libusb_control_transfer(getDevHndlPtrdevHndl)(marshalRequestTypereqTypereqRecipient)requestvalueindex(castPtrdataPtr)(fromIntegralsize)(fromIntegraltimeout)lettimedOut=err≡c'LIBUSB_ERROR_TIMEOUTiferr<0∧nottimedOutthenthrowIO$convertUSBExceptionerrelsereturn(fromIntegralerr,timedOut)---------------------------------------------------------------------------------- ** Bulk transfers--------------------------------------------------------------------------------{-| Perform a USB /bulk/ read.
Exceptions:
* 'PipeException' if the endpoint halted.
* 'OverflowException' if the device offered more data,
see /Packets and overflows/ in the @libusb@ documentation:
<http://libusb.sourceforge.net/api-1.0/packetoverflow.html>.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}readBulk∷DeviceHandle-- ^ A handle for the device to communicate with.→EndpointAddress-- ^ The address of a valid 'In' and 'Bulk' endpoint-- to communicate with. Make sure the endpoint-- belongs to the current alternate setting of a-- claimed interface which belongs to the device.→ReadActionreadBulk=readTransferc'libusb_bulk_transfer{-| Perform a USB /bulk/ write.
Exceptions:
* 'PipeException' if the endpoint halted.
* 'OverflowException' if the device offered more data,
see /Packets and overflows/ in the @libusb@ documentation:
<http://libusb.sourceforge.net/api-1.0/packetoverflow.html>.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}writeBulk∷DeviceHandle-- ^ A handle for the device to communicate with.→EndpointAddress-- ^ The address of a valid 'Out' and 'Bulk'-- endpoint to communicate with. Make sure the-- endpoint belongs to the current alternate-- setting of a claimed interface which belongs to-- the device.→WriteActionwriteBulk=writeTransferc'libusb_bulk_transfer---------------------------------------------------------------------------------- ** Interrupt transfers--------------------------------------------------------------------------------{-| Perform a USB /interrupt/ read.
Exceptions:
* 'PipeException' if the endpoint halted.
* 'OverflowException' if the device offered more data,
see /Packets and overflows/ in the libusb documentation:
<http://libusb.sourceforge.net/api-1.0/packetoverflow.html>.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}readInterrupt∷DeviceHandle-- ^ A handle for the device to communicate-- with.→EndpointAddress-- ^ The address of a valid 'In' and 'Interrupt'-- endpoint to communicate with. Make sure the-- endpoint belongs to the current alternate-- setting of a claimed interface which-- belongs to the device.→ReadActionreadInterrupt=readTransferc'libusb_interrupt_transfer{-| Perform a USB /interrupt/ write.
Exceptions:
* 'PipeException' if the endpoint halted.
* 'OverflowException' if the device offered more data,
see /Packets and overflows/ in the @libusb@ documentation:
<http://libusb.sourceforge.net/api-1.0/packetoverflow.html>.
* 'NoDeviceException' if the device has been disconnected.
* Another 'USBException'.
-}writeInterrupt∷DeviceHandle-- ^ A handle for the device to communicate-- with.→EndpointAddress-- ^ The address of a valid 'Out' and-- 'Interrupt' endpoint to communicate-- with. Make sure the endpoint belongs to-- the current alternate setting of a claimed-- interface which belongs to the device.→WriteActionwriteInterrupt=writeTransferc'libusb_interrupt_transfer---------------------------------------------------------------------------------- | Handy type synonym for the @libusb@ transfer functions.typeC'TransferFunc=PtrC'libusb_device_handle-- devHndlPtr→CUChar-- endpoint address→PtrCUChar-- dataPtr→CInt-- size→PtrCInt-- transferredPtr→CUInt-- timeout→IOCInt-- errorreadTransfer∷C'TransferFunc→(DeviceHandle→EndpointAddress→ReadAction)readTransferc'transfer=\devHndlendpointAddr→\sizetimeout→BI.createAndTrim'size$\dataPtr→do(transferred,timedOut)←transferc'transferdevHndlendpointAddrtimeout(castPtrdataPtr,size)return(0,transferred,timedOut)writeTransfer∷C'TransferFunc→(DeviceHandle→EndpointAddress→WriteAction)writeTransferc'transfer=\devHndlendpointAddr→\inputtimeout→BU.unsafeUseAsCStringLeninput$transferc'transferdevHndlendpointAddrtimeouttransfer∷C'TransferFunc→DeviceHandle→EndpointAddress→Timeout→CStringLen→IO(Size,TimedOut)transferc'transferdevHndlendpointAddrtimeout(dataPtr,size)=alloca$\transferredPtr→doerr←c'transfer(getDevHndlPtrdevHndl)(marshalEndpointAddressendpointAddr)(castPtrdataPtr)(fromIntegralsize)transferredPtr(fromIntegraltimeout)lettimedOut=err≡c'LIBUSB_ERROR_TIMEOUTiferr≢c'LIBUSB_SUCCESS∧nottimedOutthenthrowIO$convertUSBExceptionerrelsedotransferred←peektransferredPtrreturn(fromIntegraltransferred,timedOut)---------------------------------------------------------------------------------- * Exceptions---------------------------------------------------------------------------------- | @handleUSBException action@ executes @action@. If @action@ returned an-- error code other than 'c\'LIBUSB_SUCCESS', the error is converted to a-- 'USBException' and thrown.handleUSBException∷IOCInt→IO()handleUSBExceptionaction=doerr←actionwhen(err≢c'LIBUSB_SUCCESS)(throwIO$convertUSBExceptionerr)-- | @checkUSBException action@ executes @action@. If @action@ returned a-- negative integer the integer is converted to a 'USBException' and thrown. If-- not, the integer is returned.checkUSBException∷IOCInt→IOIntcheckUSBExceptionaction=dor←actionifr<0thenthrowIO$convertUSBExceptionrelsereturn$fromIntegralr-- | Convert a C'libusb_error to a 'USBException'. If the C'libusb_error is-- unknown an 'error' is thrown.convertUSBException∷CInt→USBExceptionconvertUSBExceptionerr=fromMaybeunknownLibUsbError$lookuperrlibusb_error_to_USBExceptionunknownLibUsbError∷errorunknownLibUsbError=error"Unknown Libusb error"-- | Association list mapping 'C'libusb_error's to 'USBException's.libusb_error_to_USBException∷[(CInt,USBException)]libusb_error_to_USBException=[(c'LIBUSB_ERROR_IO,IOException""),(c'LIBUSB_ERROR_INVALID_PARAM,InvalidParamException),(c'LIBUSB_ERROR_ACCESS,AccessException),(c'LIBUSB_ERROR_NO_DEVICE,NoDeviceException),(c'LIBUSB_ERROR_NOT_FOUND,NotFoundException),(c'LIBUSB_ERROR_BUSY,BusyException),(c'LIBUSB_ERROR_TIMEOUT,TimeoutException),(c'LIBUSB_ERROR_OVERFLOW,OverflowException),(c'LIBUSB_ERROR_PIPE,PipeException),(c'LIBUSB_ERROR_INTERRUPTED,InterruptedException),(c'LIBUSB_ERROR_NO_MEM,NoMemException),(c'LIBUSB_ERROR_NOT_SUPPORTED,NotSupportedException),(c'LIBUSB_ERROR_OTHER,OtherException)]-- | Type of USB exceptions.dataUSBException=IOExceptionString-- ^ Input/output exception.|InvalidParamException-- ^ Invalid parameter.|AccessException-- ^ Access denied (insufficient permissions).|NoDeviceException-- ^ No such device (it may have been disconnected).|NotFoundException-- ^ Entity not found.|BusyException-- ^ Resource busy.|TimeoutException-- ^ Operation timed out.|OverflowException-- ^ Overflow.|PipeException-- ^ Pipe exception.|InterruptedException-- ^ System call interrupted (perhaps due to signal).|NoMemException-- ^ Insufficient memory.|NotSupportedException-- ^ Operation not supported or unimplemented on this-- platform.|OtherException-- ^ Other exception.deriving(Eq,Show,Read,Data,Typeable)instanceExceptionUSBException-- The End ---------------------------------------------------------------------