usbhidctl(1) [freebsd man page]

USBHIDCTL(1)						    BSD General Commands Manual 					      USBHIDCTL(1)

NAME

     usbhidctl -- manipulate USB HID devices

SYNOPSIS

     usbhidctl -f device [-t table] [-v] [-x] -r
     usbhidctl -f device [-t table] [-l] [-v] [-x] [-z] -a
     usbhidctl -f device [-t table] [-l] [-n] [-v] [-x] [-z] item ...
     usbhidctl -f device [-t table] [-v] [-z] -w item=value ...

DESCRIPTION

     The usbhidctl utility can be used to dump and modify the state of a USB HID (Human Interface Device).  Each named item is printed.  If the -w
     flag is specified usbhidctl attempts to set the specified items to the given values.

     The options are as follows:

     -a      Show all items and their current values if device returns.

     -f device
	     Specify a path name for the device to operate on.

     -l      Loop and dump the device data every time it changes.

     -n      Suppress printing of the item name.

     -r      Dump the report descriptor.

     -t table
	     Specify a path name for the HID usage table file.

     -v      Be verbose.

     -w      Change item values.  Only 'output' and 'feature' kinds can be set with this option.

     -x      Dump data in hexadecimal as well as decimal.

     -z      Reset reports to zero before processing other arguments.  If not specified, current values will be requested from device.

SYNTAX

     usbhidctl compares the names of items specified on the command line against the human interface items reported by the USB device.	Each human
     interface item is mapped from its native form to a human readable name, using the HID usage table file.  Command line items are compared with
     the generated item names, and the USB HID device is operated on when a match is found.

     Each human interface item is named by the "page" it appears in, the "usage" within that page, and the list of "collections" containing the
     item.  Each collection in turn is also identified by page, and the usage within that page.

     On the usbhidctl command line the page name is separated from the usage name with the character ':'.  The collections are separated by the
     character '.'.

     Some devices give the same name to more than one item.  usbhidctl supports isolating each item by appending a '#'.  character and a decimal
     item instance number, starting at zero.

FILES

     /usr/share/misc/usb_hid_usages  The default HID usage table.

SEE ALSO

     usbhid(3), uhid(4), usb(4)

HISTORY

     The usbhidctl command appeared in NetBSD 1.4.

BSD
								  August 1, 2011							       BSD

Check Out this Related Man Page

UHID(4) 						   BSD Kernel Interfaces Manual 						   UHID(4)

NAME

     uhid -- USB generic HID support

SYNOPSIS

     To compile this driver into the kernel, place the following line in your kernel configuration file:

	   device uhid

     Alternatively, to load the driver as a module at boot time, place the following line in loader.conf(5):

	   uhid_load="YES"

DESCRIPTION

     The uhid driver provides support for all HID (Human Interface Device) interfaces in USB devices that do not have a special driver.

     The device handles the following ioctl(2) calls:

     USB_GET_REPORT_ID (int)
	     Get the report identifier used by this HID report.

     USB_GET_REPORT_DESC (struct usb_ctl_report_desc)
	     Get the HID report descriptor.  Using this descriptor the exact layout and meaning of data to/from the device can be found.  The
	     report descriptor is delivered without any processing.

	     struct usb_ctl_report_desc {
		 int	 ucrd_size;
		 u_char  ucrd_data[1024];    /* filled data size will vary */
	     };

     USB_SET_IMMED (int)
	     Sets the device in a mode where each read(2) will return the current value of the input report.  Normally a read(2) will only return
	     the data that the device reports on its interrupt pipe.  This call may fail if the device does not support this feature.

     USB_GET_REPORT (struct usb_ctl_report)
	     Get a report from the device without waiting for data on the interrupt pipe.  The report field indicates which report is requested.
	     It should be UHID_INPUT_REPORT, UHID_OUTPUT_REPORT, or UHID_FEATURE_REPORT.  This call may fail if the device does not support this
	     feature.

	     struct usb_ctl_report {
		     int ucr_report;
		     u_char  ucr_data[1024]; /* used data size will vary */
	     };

     USB_SET_REPORT (struct usb_ctl_report)
	     Set a report in the device.  The report field indicates which report is to be set.  It should be UHID_INPUT_REPORT,
	     UHID_OUTPUT_REPORT, or UHID_FEATURE_REPORT.  This call may fail if the device does not support this feature.

     Use read(2) to get data from the device.  Data should be read in chunks of the size prescribed by the report descriptor.

     Use write(2) to send data to the device.  Data should be written in chunks of the size prescribed by the report descriptor.

FILES

     /dev/uhid?

SEE ALSO

     usbhidctl(1), usb(4)

HISTORY

     The uhid driver appeared in NetBSD 1.4.  This manual page was adopted from NetBSD by Tom Rhodes <trhodes@FreeBSD.org> in April 2002.

BSD
								 November 22, 2006							       BSD

Linux and UNIX Man Pages

usbhidctl(1) [freebsd man page]

Check Out this Related Man Page