System.USB.Misc

This module provides miscellaneous functionality.

Capabilties of libusb

data Capability

Capabilities supported by an instance of libusb on the current running platform.

Test if the loaded libusb library supports a given capability by calling hasCapability.

Constructors

HasCapability

The hasCapability API is available.

HasHotplug

Hotplug support is available on this platform.

HasHidAccess

The library can access HID devices without requiring user intervention.

Note that before being able to actually access an HID device, you may still have to call additional libusb functions such as detachKernelDriver.

SupportsDetachKernelDriver

The library supports detaching of the default USB driver, using detachKernelDriver, if one is set by the OS kernel.

Instances

Enum Capability

Methods

succ :: Capability -> Capability

pred :: Capability -> Capability

toEnum :: Int -> Capability

fromEnum :: Capability -> Int

enumFrom :: Capability -> [Capability]

enumFromThen :: Capability -> Capability -> [Capability]

enumFromTo :: Capability -> Capability -> [Capability]

enumFromThenTo :: Capability -> Capability -> Capability -> [Capability]

Eq Capability

Methods

(==) :: Capability -> Capability -> Bool

(/=) :: Capability -> Capability -> Bool

Data Capability

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Capability -> c Capability

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Capability

toConstr :: Capability -> Constr

dataTypeOf :: Capability -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Capability)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Capability)

gmapT :: (forall b. Data b => b -> b) -> Capability -> Capability

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Capability -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Capability -> r

gmapQ :: (forall d. Data d => d -> u) -> Capability -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Capability -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Capability -> m Capability

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Capability -> m Capability

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Capability -> m Capability

Ord Capability

Methods

compare :: Capability -> Capability -> Ordering

(<) :: Capability -> Capability -> Bool

(<=) :: Capability -> Capability -> Bool

(>) :: Capability -> Capability -> Bool

(>=) :: Capability -> Capability -> Bool

max :: Capability -> Capability -> Capability

min :: Capability -> Capability -> Capability

Read Capability

Methods

readsPrec :: Int -> ReadS Capability

readList :: ReadS [Capability]

readPrec :: ReadPrec Capability

readListPrec :: ReadPrec [Capability]

Show Capability

Methods

showsPrec :: Int -> Capability -> ShowS

show :: Capability -> String

showList :: [Capability] -> ShowS

Generic Capability

Associated Types

type Rep Capability :: * -> *

Methods

from :: Capability -> Rep Capability x

to :: Rep Capability x -> Capability

type Rep Capability

type Rep Capability = D1 * (MetaData "Capability" "System.USB.Base" "usb-1.3.0.6-BxALn33Tmsa87zdhZNpf2H" False) ((:+:) * ((:+:) * (C1 * (MetaCons "HasCapability" PrefixI False) (U1 *)) (C1 * (MetaCons "HasHotplug" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "HasHidAccess" PrefixI False) (U1 *)) (C1 * (MetaCons "SupportsDetachKernelDriver" PrefixI False) (U1 *))))

hasCapability :: Ctx -> Capability -> Bool

Check at runtime if the loaded libusb library has a given capability.

This call should be performed after newCtx, to ensure the backend has updated its capability set. For this reason you need to apply it to a Ctx.

Version of libusb

data LibusbVersion

Structure providing the version of the libusb runtime.

Constructors

LibusbVersion

Fields

• major :: Word16

  Library major version.

• minor :: Word16

  Library minor version.

• micro :: Word16

  Library micro version.

• nano :: Word16

  Library nano version.

• rc :: String

  Library release candidate suffix string, e.g. "-rc4".

Instances

Eq LibusbVersion

Methods

(==) :: LibusbVersion -> LibusbVersion -> Bool

(/=) :: LibusbVersion -> LibusbVersion -> Bool

Data LibusbVersion

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LibusbVersion -> c LibusbVersion

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LibusbVersion

toConstr :: LibusbVersion -> Constr

dataTypeOf :: LibusbVersion -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c LibusbVersion)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LibusbVersion)

gmapT :: (forall b. Data b => b -> b) -> LibusbVersion -> LibusbVersion

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LibusbVersion -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LibusbVersion -> r

gmapQ :: (forall d. Data d => d -> u) -> LibusbVersion -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> LibusbVersion -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> LibusbVersion -> m LibusbVersion

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LibusbVersion -> m LibusbVersion

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LibusbVersion -> m LibusbVersion

Read LibusbVersion

Methods

readsPrec :: Int -> ReadS LibusbVersion

readList :: ReadS [LibusbVersion]

readPrec :: ReadPrec LibusbVersion

readListPrec :: ReadPrec [LibusbVersion]

Show LibusbVersion

Methods

showsPrec :: Int -> LibusbVersion -> ShowS

show :: LibusbVersion -> String

showList :: [LibusbVersion] -> ShowS

Generic LibusbVersion

Associated Types

type Rep LibusbVersion :: * -> *

Methods

from :: LibusbVersion -> Rep LibusbVersion x

to :: Rep LibusbVersion x -> LibusbVersion

type Rep LibusbVersion

type Rep LibusbVersion = D1 * (MetaData "LibusbVersion" "System.USB.Base" "usb-1.3.0.6-BxALn33Tmsa87zdhZNpf2H" False) (C1 * (MetaCons "LibusbVersion" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "major") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word16)) (S1 * (MetaSel (Just Symbol "minor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word16))) ((:*:) * (S1 * (MetaSel (Just Symbol "micro") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word16)) ((:*:) * (S1 * (MetaSel (Just Symbol "nano") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Word16)) (S1 * (MetaSel (Just Symbol "rc") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * String))))))

libusbVersion :: LibusbVersion

Returns the version (major, minor, micro, nano and rc) of the loaded libusb library.

toVersion :: LibusbVersion -> Version

Convert a LibusbVersion to a Version for easy comparison.