PERFORCE change 135749 for review

[Hans Petter Selasky]

http://perforce.freebsd.org/chv.cgi?CH=135749

Change 135749 by hselasky at hselasky_laptop001 on 2008/02/19 21:01:14

	
	Add more documentation.

Affected files ...

.. //depot/projects/usb/src/sys/dev/usb/usb_hid.c#14 edit

Differences ...

==== //depot/projects/usb/src/sys/dev/usb/usb_hid.c#14 (text+ko) ====

@@ -493,6 +493,13 @@
 
 /*------------------------------------------------------------------------*
  *	hid_get_descriptor_from_usb
+ *
+ * This function will search for a HID descriptor inside between two
+ * USB interface descriptors.
+ *
+ * Return values:
+ * NULL: No more HID descriptors.
+ * Else: Pointer to HID descriptor.
  *------------------------------------------------------------------------*/
 usb_hid_descriptor_t *
 hid_get_descriptor_from_usb(usb_config_descriptor_t *cd,
@@ -517,6 +524,13 @@
 
 /*------------------------------------------------------------------------*
  *	hid_read_report_desc_from_usb
+ *
+ * This function will read out an USB report descriptor from the USB
+ * device.
+ *
+ * Return values:
+ * NULL: Failure.
+ * Else: Success. The pointer should eventually be passed to free().
  *------------------------------------------------------------------------*/
 usbd_status_t
 hid_read_report_desc_from_usb(struct usbd_device *udev, struct mtx *mtx,