Print this page
11586 NAME field in man pages should match what's installed
   1 USBA_HCDI_PIPE_RESET(9E)      Driver Entry Points     USBA_HCDI_PIPE_RESET(9E)
   2 
   3 NAME
   4      usba_hcdi_pipe_rest - reset an open USB pipe
   5 
   6 SYNOPSIS
   7      #include <sys/usb/usba/hcdi.h>
   8 
   9      int
  10      prefix_hcdi_pipe_reset(usba_pipe_handle_data_t *ph,
  11          usb_flags_t usb_flags);
  12 
  13 INTERFACE LEVEL
  14      Volatile - illumos USB HCD private function
  15 
  16      This is a private function that is not part of the stable DDI.  It may be
  17      removed or changed at any time.
  18 
  19 PARAMETERS
  20      ph            A pointer to a USB pipe handle as defined in
  21                    usba_pipe_handle_data(9S).
  22 
  23      usb_flags     Flags which describe how allocations should be performed.
  24                    Valid flags are:


  52 
  53      3.   Remove any remaining, scheduled or queued transfers.  For each one
  54           call usba_hcdi_cb(9F) with the code USB_CR_PIPE_RESET.
  55 
  56      4.   Perform any other necessary steps on the controller to have the
  57           endpoint be ready to perform I/O.
  58 
  59      This entry point is called by the broader USBA framework as part of
  60      closing a pipe or in response to a device stall.
  61 
  62 RETURN VALUES
  63      Upon successful completion, the usba_hcdi_pipe_reset() function should
  64      return USB_SUCCESS.  Otherwise, it should return the appropriate USB
  65      error.  If uncertain, use USB_FAILURE.
  66 
  67 SEE ALSO
  68      usba_hcdi_pipe_open(9E), usba_hcdi_pipe_stop_intr_polling(9E),
  69      usba_hcdi_pipe_stop_isoc_polling(9E), usba_hcdi_cb(9F),
  70      usba_pipe_handle_data(9S)
  71 
  72 illumos                        December 22, 2016                       illumos
   1 USBA_HCDI_PIPE_RESET(9E)      Driver Entry Points     USBA_HCDI_PIPE_RESET(9E)
   2 
   3 NAME
   4      usba_hcdi_pipe_reset - reset an open USB pipe
   5 
   6 SYNOPSIS
   7      #include <sys/usb/usba/hcdi.h>
   8 
   9      int
  10      prefix_hcdi_pipe_reset(usba_pipe_handle_data_t *ph,
  11          usb_flags_t usb_flags);
  12 
  13 INTERFACE LEVEL
  14      Volatile - illumos USB HCD private function
  15 
  16      This is a private function that is not part of the stable DDI.  It may be
  17      removed or changed at any time.
  18 
  19 PARAMETERS
  20      ph            A pointer to a USB pipe handle as defined in
  21                    usba_pipe_handle_data(9S).
  22 
  23      usb_flags     Flags which describe how allocations should be performed.
  24                    Valid flags are:


  52 
  53      3.   Remove any remaining, scheduled or queued transfers.  For each one
  54           call usba_hcdi_cb(9F) with the code USB_CR_PIPE_RESET.
  55 
  56      4.   Perform any other necessary steps on the controller to have the
  57           endpoint be ready to perform I/O.
  58 
  59      This entry point is called by the broader USBA framework as part of
  60      closing a pipe or in response to a device stall.
  61 
  62 RETURN VALUES
  63      Upon successful completion, the usba_hcdi_pipe_reset() function should
  64      return USB_SUCCESS.  Otherwise, it should return the appropriate USB
  65      error.  If uncertain, use USB_FAILURE.
  66 
  67 SEE ALSO
  68      usba_hcdi_pipe_open(9E), usba_hcdi_pipe_stop_intr_polling(9E),
  69      usba_hcdi_pipe_stop_isoc_polling(9E), usba_hcdi_cb(9F),
  70      usba_pipe_handle_data(9S)
  71 
  72 illumos                         August 20, 2019                        illumos