System.USB.IO.Synchronous

A ReadAction is a function which takes a Timeout and a Size which defines how many bytes to read. The function returns an IO action which, when executed, performs the actual read and returns the ByteString that was read paired with an indication if the transfer timed out.

type WriteAction = Timeout -> ByteString -> IO (Size, Bool)

Source

Handy type synonym for write transfers.

A WriteAction is a function which takes a Timeout and the ByteString to write. The function returns an IO action which, when exectued, returns the number of bytes that were actually written paired with an indication if the transfer timed out.

type Timeout = Int

Source

A timeout in millseconds. A timeout defines how long a transfer should wait before giving up due to no response being received. For no timeout, use value 0.

type Size = Int

Source

Number of bytes transferred.

Control transfers

data RequestType

Source

Constructors

Standard
Class
Vendor

Instances

data Recipient

Constructors

ToDevice
ToInterface
ToEndpoint
ToOther

Instances

control

:: DeviceHandle	A handle for the device to communicate with.
-> RequestType	The type of request.
-> Recipient	The recipient of the request.
-> Word8	Request.
-> Word16	Value.
-> Word16	Index.
-> Timeout	Timeout (in milliseconds) that this function should wait before giving up due to no response being received. For no timeout, use value 0.
-> IO ()
Perform a USB control request that does not transfer data. The value and index values should be given in host-endian byte order. 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`.

readControl

Source

:: DeviceHandle	A handle for the device to communicate with.
-> RequestType	The type of request.
-> Recipient	The recipient of the request.
-> Word8	Request.
-> Word16	Value.
-> Word16	Index.
-> ReadAction
Perform a USB control read. The value and index values should be given in host-endian byte order. Exceptions: `PipeException` if the control request was not supported by the device `NoDeviceException` if the device has been disconnected. Another `USBException`.

writeControl

Source

:: DeviceHandle	A handle for the device to communicate with.
-> RequestType	The type of request.
-> Recipient	The recipient of the request.
-> Word8	Request.
-> Word16	Value.
-> Word16	Index.
-> WriteAction
Perform a USB control write. The value and index values should be given in host-endian byte order. Exceptions: `PipeException` if the control request was not supported by the device `NoDeviceException` if the device has been disconnected. Another `USBException`.

Standard Device Requests

setHalt :: DeviceHandle -> EndpointAddress -> Timeout -> IO ()

Source

See: USB 2.0 Spec. section 9.4.9

clearRemoteWakeup :: DeviceHandle -> Timeout -> IO ()

Source

See: USB 2.0 Spec. section 9.4.1

setRemoteWakeup :: DeviceHandle -> Timeout -> IO ()

Source

See: USB 2.0 Spec. section 9.4.9

setStandardTestMode :: DeviceHandle -> TestMode -> Timeout -> IO ()

Source

See: USB 2.0 Spec. section 9.4.9 TODO: What about vendor-specific test modes?

data TestMode

Source

See: USB 2.0 Spec. table 9-7

Constructors

Test_J
Test_K
Test_SE0_NAK
Test_Packet
Test_Force_Enable

Instances

getInterfaceAltSetting :: DeviceHandle -> InterfaceNumber -> Timeout -> IO InterfaceAltSetting

Source

See: USB 2.0 Spec. section 9.4.4

getDeviceStatus :: DeviceHandle -> Timeout -> IO DeviceStatus

Source

See: USB 2.0 Spec. section 9.4.5

getEndpointStatus :: DeviceHandle -> EndpointAddress -> Timeout -> IO Bool

Source

See: USB 2.0 Spec. section 9.4.5

setDeviceAddress :: DeviceHandle -> Word16 -> Timeout -> IO ()

Source

See: USB 2.0 Spec. section 9.4.6

synchFrame :: DeviceHandle -> EndpointAddress -> Timeout -> IO Int

Source

See: USB 2.0 Spec. section 9.4.11

Bulk transfers

readBulk

Source

:: 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.
-> ReadAction
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`.

writeBulk

Source

:: 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.
-> WriteAction
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`.

Interrupt transfers

readInterrupt

Source

:: 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.
-> ReadAction
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`.

writeInterrupt

Source

:: 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.
-> WriteAction
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`.

Produced by Haddock version 2.4.2