PERFORCE change 135734 for review

[Hans Petter Selasky]

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

Change 135734 by hselasky at hselasky_laptop001 on 2008/02/19 18:30:36

	
	Add more documentation.

Affected files ...

.. //depot/projects/usb/src/sys/dev/usb/usb_transfer.c#116 edit

Differences ...

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

@@ -208,6 +208,10 @@
  *
  * This function searches for an USB pipe by endpoint address and
  * direction.
+ *
+ * Returns:
+ * NULL: Failure
+ * Else: Success
  *------------------------------------------------------------------------*/
 struct usbd_pipe *
 usbd_get_pipe_by_addr(struct usbd_device *udev, uint8_t ea_val)
@@ -363,6 +367,10 @@
  * This function stores the number of USB interfaces excluding
  * alternate settings, which the USB config descriptor reports into
  * the unsigned 8-bit integer pointed to by "count".
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 usbd_status_t
 usbd_interface_count(struct usbd_device *udev, uint8_t *count)
@@ -3047,6 +3055,10 @@
 
 /*------------------------------------------------------------------------*
  *	usbd_handle_set_config
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 static usbd_status_t
 usbd_handle_set_config(struct usbd_xfer *xfer, uint8_t conf_no)
@@ -3084,6 +3096,10 @@
  *
  * This function is used to make a BULK or INTERRUPT endpoint
  * send STALL tokens.
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 static usbd_status_t
 usbd_handle_set_stall_sub(struct usbd_device *udev, uint8_t ea_val,
@@ -3160,6 +3176,10 @@
 
 /*------------------------------------------------------------------------*
  *	usbd_handle_stall
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 static usbd_status_t
 usbd_handle_set_stall(struct usbd_xfer *xfer, uint8_t ep, uint8_t do_stall)
@@ -3174,6 +3194,10 @@
 
 /*------------------------------------------------------------------------*
  *	usbd_handle_get_stall
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 static uint8_t
 usbd_handle_get_stall(struct usbd_device *udev, uint8_t ea_val)
@@ -3196,6 +3220,10 @@
 
 /*------------------------------------------------------------------------*
  *	usbd_handle_remote_wakeup
+ *
+ * Returns:
+ *    0: Success
+ * Else: Failure
  *------------------------------------------------------------------------*/
 static usbd_status_t
 usbd_handle_remote_wakeup(struct usbd_xfer *xfer, uint8_t is_on)