From owner-p4-projects@FreeBSD.ORG Tue Feb 19 18:31:32 2008 Return-Path: Delivered-To: p4-projects@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 32767) id A306816A46B; Tue, 19 Feb 2008 18:31:32 +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 675F016A41B for ; Tue, 19 Feb 2008 18:31:32 +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 5177013C4FD for ; Tue, 19 Feb 2008 18:31:32 +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 m1JIVVBn086018 for ; Tue, 19 Feb 2008 18:31:31 GMT (envelope-from hselasky@FreeBSD.org) Received: (from perforce@localhost) by repoman.freebsd.org (8.14.1/8.14.1/Submit) id m1JIVVLO086015 for perforce@freebsd.org; Tue, 19 Feb 2008 18:31:31 GMT (envelope-from hselasky@FreeBSD.org) Date: Tue, 19 Feb 2008 18:31:31 GMT Message-Id: <200802191831.m1JIVVLO086015@repoman.freebsd.org> X-Authentication-Warning: repoman.freebsd.org: perforce set sender to hselasky@FreeBSD.org using -f From: Hans Petter Selasky To: Perforce Change Reviews Cc: Subject: PERFORCE change 135734 for review X-BeenThere: p4-projects@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: p4 projects tree changes List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 19 Feb 2008 18:31:33 -0000 http://perforce.freebsd.org/chv.cgi?CH=135734 Change 135734 by hselasky@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)