xref: /openbsd/share/man/man9/usbd_close_pipe.9 (revision 222941dd)
1.\" $OpenBSD: usbd_close_pipe.9,v 1.2 2018/09/04 12:46:32 mpi Exp $
2.\"
3.\" Copyright (c) 2015 Sean Levy <attila@stalphonsos.com>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: September 4 2018 $
18.Dt USBD_CLOSE_PIPE 9
19.Os
20.Sh NAME
21.Nm usbd_close_pipe , usbd_abort_pipe
22.Nd delete or abort transfers on a USB pipe
23.Sh SYNOPSIS
24.In dev/usb/usb.h
25.In dev/usb/usbdi.h
26.Ft usbd_status
27.Fn usbd_close_pipe "struct usbd_pipe *pipe"
28.Ft void
29.Fn usbd_abort_pipe "struct usbd_pipe *pipe"
30.Sh DESCRIPTION
31The
32.Fn usbd_abort_pipe
33function aborts any transfers queued on
34.Fa pipe .
35.Pp
36The
37.Fn usbd_close_pipe
38function aborts any transfers queued on
39.Fa pipe
40then deletes it.
41.Sh CONTEXT
42.Fn usbd_abort_pipe
43and
44.Fn usbd_close_pipe
45can be called during autoconf or from process context.
46.Sh SEE ALSO
47.Xr usb 4 ,
48.Xr usbd_open_pipe 9
49