PERFORCE change 135736 for review

[Hans Petter Selasky]

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

Change 135736 by hselasky at hselasky_laptop001 on 2008/02/19 18:41:43

	
	Add more documentation.

Affected files ...

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

Differences ...

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

@@ -46,6 +46,9 @@
 #include <dev/usb/usb_template.h>
 #include <dev/usb/usb_cdc.h>
 
+/*------------------------------------------------------------------------*
+ *	usbd_make_raw_desc
+ *------------------------------------------------------------------------*/
 static void
 usbd_make_raw_desc(struct usbd_temp_setup *temp,
     const uint8_t *raw)
@@ -82,6 +85,9 @@
 	return;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_make_endpoint_desc
+ *------------------------------------------------------------------------*/
 static void
 usbd_make_endpoint_desc(struct usbd_temp_setup *temp,
     const struct usb_temp_endpoint_desc *ted)
@@ -176,6 +182,9 @@
 	return;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_make_interface_desc
+ *------------------------------------------------------------------------*/
 static void
 usbd_make_interface_desc(struct usbd_temp_setup *temp,
     const struct usb_temp_interface_desc *tid)
@@ -241,6 +250,9 @@
 	return;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_make_config_desc
+ *------------------------------------------------------------------------*/
 static void
 usbd_make_config_desc(struct usbd_temp_setup *temp,
     const struct usb_temp_config_desc *tcd)
@@ -297,6 +309,9 @@
 	return;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_make_device_desc
+ *------------------------------------------------------------------------*/
 static void
 usbd_make_device_desc(struct usbd_temp_setup *temp,
     const struct usb_temp_device_desc *tdd)
@@ -387,6 +402,9 @@
 	return;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_hw_ep_match
+ *------------------------------------------------------------------------*/
 static uint8_t
 usbd_hw_ep_match(const struct usbd_hw_ep_profile *pf,
     uint8_t ep_type, uint8_t ep_dir_in)
@@ -406,6 +424,9 @@
 	return (0);
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_hw_ep_find_match
+ *------------------------------------------------------------------------*/
 static uint8_t
 usbd_hw_ep_find_match(struct usbd_hw_ep_scratch *ues,
     struct usbd_sw_ep_scratch *ep, uint8_t is_simplex)
@@ -517,6 +538,9 @@
 	return (1);			/* failure */
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_hw_ep_get_needs
+ *------------------------------------------------------------------------*/
 static uint8_t
 usbd_hw_ep_get_needs(struct usbd_hw_ep_scratch *ues,
     uint8_t ep_type, uint8_t is_complete)
@@ -665,6 +689,13 @@
 	goto repeat;
 }
 
+/*------------------------------------------------------------------------*
+ *	usbd_hw_ep_resolve
+ *
+ * Return values:
+ *    0: Success
+ * Else: Failure
+ *------------------------------------------------------------------------*/
 static usbd_status_t
 usbd_hw_ep_resolve(struct usbd_device *udev,
     usb_descriptor_t *desc)