From owner-p4-projects@FreeBSD.ORG  Tue Feb 19 21:01:23 2008
Return-Path: <owner-p4-projects@FreeBSD.ORG>
Delivered-To: p4-projects@freebsd.org
Received: by hub.freebsd.org (Postfix, from userid 32767)
	id B4BA716A41A; Tue, 19 Feb 2008 21:01:23 +0000 (UTC)
Delivered-To: perforce@FreeBSD.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 6255416A46D
	for <perforce@FreeBSD.org>; Tue, 19 Feb 2008 21:01:23 +0000 (UTC)
	(envelope-from hselasky@FreeBSD.org)
Received: from repoman.freebsd.org (repoman.freebsd.org
	[IPv6:2001:4f8:fff6::29])
	by mx1.freebsd.org (Postfix) with ESMTP id 52C8F13C448
	for <perforce@FreeBSD.org>; Tue, 19 Feb 2008 21:01:23 +0000 (UTC)
	(envelope-from hselasky@FreeBSD.org)
Received: from repoman.freebsd.org (localhost [127.0.0.1])
	by repoman.freebsd.org (8.14.1/8.14.1) with ESMTP id m1JL1Ng5022903
	for <perforce@FreeBSD.org>; Tue, 19 Feb 2008 21:01:23 GMT
	(envelope-from hselasky@FreeBSD.org)
Received: (from perforce@localhost)
	by repoman.freebsd.org (8.14.1/8.14.1/Submit) id m1JL1Nwx022900
	for perforce@freebsd.org; Tue, 19 Feb 2008 21:01:23 GMT
	(envelope-from hselasky@FreeBSD.org)
Date: Tue, 19 Feb 2008 21:01:23 GMT
Message-Id: <200802192101.m1JL1Nwx022900@repoman.freebsd.org>
X-Authentication-Warning: repoman.freebsd.org: perforce set sender to
	hselasky@FreeBSD.org using -f
From: Hans Petter Selasky <hselasky@FreeBSD.org>
To: Perforce Change Reviews <perforce@FreeBSD.org>
Cc: 
Subject: PERFORCE change 135749 for review
X-BeenThere: p4-projects@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: p4 projects tree changes <p4-projects.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/p4-projects>,
	<mailto:p4-projects-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/p4-projects>
List-Post: <mailto:p4-projects@freebsd.org>
List-Help: <mailto:p4-projects-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/p4-projects>,
	<mailto:p4-projects-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 19 Feb 2008 21:01:24 -0000

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

Change 135749 by hselasky@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,