System.USB.IO.Synchronous

usb-0.1.0.1: Communicate with USB devices

System.USB.IO.Synchronous

Contents

Control transfers
Bulk transfers
Interrupt transfers

Synopsis

type Timeout = Int

type Size = Int

data RequestType

control :: DeviceHandle -> RequestType -> Recipient -> Word8 -> Word16 -> Word16 -> Timeout -> IO ()

readControl :: DeviceHandle -> RequestType -> Recipient -> Word8 -> Word16 -> Word16 -> Size -> Timeout -> IO ByteString

writeControl :: DeviceHandle -> RequestType -> Recipient -> Word8 -> Word16 -> Word16 -> ByteString -> Timeout -> IO Size

readBulk :: DeviceHandle -> EndpointAddress -> Size -> Timeout -> IO ByteString

writeBulk :: DeviceHandle -> EndpointAddress -> ByteString -> Timeout -> IO Size

readInterrupt :: DeviceHandle -> EndpointAddress -> Size -> Timeout -> IO ByteString

writeInterrupt :: DeviceHandle -> EndpointAddress -> ByteString -> Timeout -> IO Size

Documentation

type Timeout = Int

A timeout in milliseconds. Use 0 to indicate no timeout.

type Size = Int

Number of bytes transferred.

data RequestType

Constructors

Standard
Class
Vendor

show/hide

Instances

Enum RequestType

Data RequestType

Show RequestType

Typeable RequestType

data Recipient

Constructors

ToDevice
ToInterface
ToEndpoint
ToOther

show/hide

Instances

Typeable Recipient

Control transfers

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

:: 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.
-> Size	The maximum number of bytes to read.
-> 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 ByteString
Perform a USB control read. 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`.

writeControl

:: 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.
-> ByteString	The ByteString to write,
-> 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 Size
Perform a USB control write. 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`.

readBulk

:: DeviceHandle	A handle for the device to communicate with.
-> EndpointAddress	The address of a valid endpoint to communicate with. Because we are reading, make sure this is an `In` endpoint!!! If it isn't the behaviour is undefined.
-> Size	The maximum number of bytes to read.
-> 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 ByteString	The function returns the ByteString that was read. Note that the length of this ByteString <= the requested size to read.
Perform a USB bulk read. Exceptions: `TimeoutException` if the transfer timed out. `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 endpoint to communicate with. Because we are writing, make sure this is an `Out` endpoint!!! If it isn't the behaviour is undefined.
-> ByteString	The ByteString to write.
-> 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 Size	The function returns the number of bytes actually written.
Perform a USB bulk write. Exceptions: `TimeoutException` if the transfer timed out. `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

:: DeviceHandle	A handle for the device to communicate with.
-> EndpointAddress	The address of a valid endpoint to communicate with. Because we are reading, make sure this is an `In` endpoint!!! If it isn't the behaviour is undefined.
-> Size	The maximum number of bytes to read.
-> 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 ByteString	The function returns the ByteString that was read. Note that the length of this ByteString <= the requested size to read.
Perform a USB interrupt read. Exceptions: `TimeoutException` if the transfer timed out. `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 endpoint to communicate with. Because we are writing, make sure this is an `Out` endpoint!!! If it isn't the behaviour is undefined.
-> ByteString	The ByteString to write.
-> 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 Size	The function returns the number of bytes actually written.
Perform a USB interrupt write. Exceptions: `TimeoutException` if the transfer timed out. `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