Fix a bunch of "sentence not on new line" warnings in section 9.
MFC after: 1 month
This commit is contained in:
parent
2597250955
commit
7851d429a6
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=301590
@ -256,8 +256,8 @@ Pointer to
|
|||||||
.Pq Vt "struct ifnet *"
|
.Pq Vt "struct ifnet *"
|
||||||
is passed as the first argument, interface
|
is passed as the first argument, interface
|
||||||
.Fa dlt
|
.Fa dlt
|
||||||
follows. Last argument indicates listener is attached (1) or
|
follows.
|
||||||
detached (0).
|
Last argument indicates listener is attached (1) or detached (0).
|
||||||
Note that handler is invoked with
|
Note that handler is invoked with
|
||||||
.Nm
|
.Nm
|
||||||
global lock held, which implies restriction on sleeping and calling
|
global lock held, which implies restriction on sleeping and calling
|
||||||
|
@ -97,7 +97,8 @@ by calling the function
|
|||||||
.Fn firmware_get
|
.Fn firmware_get
|
||||||
with the
|
with the
|
||||||
.Nm imagename
|
.Nm imagename
|
||||||
they want as an argument. If a matching image is not already registered,
|
they want as an argument.
|
||||||
|
If a matching image is not already registered,
|
||||||
the firmware subsystem will try to load it using the
|
the firmware subsystem will try to load it using the
|
||||||
mechanisms specified below (typically, a kernel module
|
mechanisms specified below (typically, a kernel module
|
||||||
with
|
with
|
||||||
@ -127,7 +128,8 @@ pointer to the image requested.
|
|||||||
.Fn firmware_unregister
|
.Fn firmware_unregister
|
||||||
tries to unregister the firmware image
|
tries to unregister the firmware image
|
||||||
.Nm imagename
|
.Nm imagename
|
||||||
from the system. The function is successful and returns 0
|
from the system.
|
||||||
|
The function is successful and returns 0
|
||||||
if there are no pending references to the image, otherwise
|
if there are no pending references to the image, otherwise
|
||||||
it does not unregister the image and returns EBUSY.
|
it does not unregister the image and returns EBUSY.
|
||||||
.Pp
|
.Pp
|
||||||
@ -148,7 +150,8 @@ already mounted.
|
|||||||
On success,
|
On success,
|
||||||
.Fn firmware_get
|
.Fn firmware_get
|
||||||
returns a pointer to the image description and increases the reference count
|
returns a pointer to the image description and increases the reference count
|
||||||
for this image. On failure, the function returns NULL.
|
for this image.
|
||||||
|
On failure, the function returns NULL.
|
||||||
.Pp
|
.Pp
|
||||||
.Fn firmware_put
|
.Fn firmware_put
|
||||||
drops a reference to a firmware image.
|
drops a reference to a firmware image.
|
||||||
|
@ -215,7 +215,8 @@ The flag allows exclusive requests to preempt the current shared request
|
|||||||
even if the current thread owns shared locks.
|
even if the current thread owns shared locks.
|
||||||
This is safe since shared lock is guaranteed to not recurse, and is used
|
This is safe since shared lock is guaranteed to not recurse, and is used
|
||||||
when thread is known to held unrelated shared locks, to not cause
|
when thread is known to held unrelated shared locks, to not cause
|
||||||
unnecessary starvation. An example is
|
unnecessary starvation.
|
||||||
|
An example is
|
||||||
.Dv vp
|
.Dv vp
|
||||||
locking in VFS
|
locking in VFS
|
||||||
.Xr lookup 9 ,
|
.Xr lookup 9 ,
|
||||||
|
@ -335,7 +335,8 @@ running inside an interrupt thread.
|
|||||||
.El
|
.El
|
||||||
.Ss Interaction table
|
.Ss Interaction table
|
||||||
The following table shows what you can and can not do while holding
|
The following table shows what you can and can not do while holding
|
||||||
one of the locking primitives discussed. Note that
|
one of the locking primitives discussed.
|
||||||
|
Note that
|
||||||
.Dq sleep
|
.Dq sleep
|
||||||
includes
|
includes
|
||||||
.Fn sema_wait ,
|
.Fn sema_wait ,
|
||||||
|
@ -628,7 +628,8 @@ system boot.
|
|||||||
.It Dv CTLFLAG_NOFETCH
|
.It Dv CTLFLAG_NOFETCH
|
||||||
In case the node is marked as a tunable using the CTLFLAG_[XX]TUN,
|
In case the node is marked as a tunable using the CTLFLAG_[XX]TUN,
|
||||||
this flag will prevent fetching the initial value from the system
|
this flag will prevent fetching the initial value from the system
|
||||||
environment. Typically this flag should only be used for very early
|
environment.
|
||||||
|
Typically this flag should only be used for very early
|
||||||
low level system setup code, and not by common drivers and modules.
|
low level system setup code, and not by common drivers and modules.
|
||||||
.El
|
.El
|
||||||
.Pp
|
.Pp
|
||||||
@ -780,7 +781,8 @@ Use positive logic instead:
|
|||||||
.Va foobar_enable .
|
.Va foobar_enable .
|
||||||
.Pp
|
.Pp
|
||||||
A temporary sysctl node OID that should not be relied upon must be designated
|
A temporary sysctl node OID that should not be relied upon must be designated
|
||||||
as such by a leading underscore character in its name. For example:
|
as such by a leading underscore character in its name.
|
||||||
|
For example:
|
||||||
.Va _dirty_hack .
|
.Va _dirty_hack .
|
||||||
.Sh SEE ALSO
|
.Sh SEE ALSO
|
||||||
.Xr sysctl 3 ,
|
.Xr sysctl 3 ,
|
||||||
|
@ -268,7 +268,8 @@ then that lock must be held when this function is called.
|
|||||||
Note that when stopping multiple callouts that use the same lock it is possible
|
Note that when stopping multiple callouts that use the same lock it is possible
|
||||||
to get multiple return's of zero and multiple calls to the
|
to get multiple return's of zero and multiple calls to the
|
||||||
.Fa drain
|
.Fa drain
|
||||||
function, depending upon which CPU's the callouts are running. The
|
function, depending upon which CPU's the callouts are running.
|
||||||
|
The
|
||||||
.Fa drain
|
.Fa drain
|
||||||
function itself is called from the context of the completing callout
|
function itself is called from the context of the completing callout
|
||||||
i.e. softclock or hardclock, just like a callout itself.
|
i.e. softclock or hardclock, just like a callout itself.
|
||||||
@ -813,7 +814,8 @@ and
|
|||||||
.Fn callout_drain
|
.Fn callout_drain
|
||||||
functions return a value of one if the callout was still pending when it was
|
functions return a value of one if the callout was still pending when it was
|
||||||
called, a zero if the callout could not be stopped and a negative one is it
|
called, a zero if the callout could not be stopped and a negative one is it
|
||||||
was either not running or haas already completed. The
|
was either not running or haas already completed.
|
||||||
|
The
|
||||||
.Fn timeout
|
.Fn timeout
|
||||||
function returns a
|
function returns a
|
||||||
.Ft struct callout_handle
|
.Ft struct callout_handle
|
||||||
|
@ -157,7 +157,8 @@ available.
|
|||||||
.Fa udev
|
.Fa udev
|
||||||
is a pointer to "struct usb_device".
|
is a pointer to "struct usb_device".
|
||||||
.Fa ifaces
|
.Fa ifaces
|
||||||
is an array of interface index numbers to use. See "if_index".
|
is an array of interface index numbers to use.
|
||||||
|
See "if_index".
|
||||||
.Fa pxfer
|
.Fa pxfer
|
||||||
is a pointer to an array of USB transfer pointers that are initialized
|
is a pointer to an array of USB transfer pointers that are initialized
|
||||||
to NULL, and then pointed to allocated USB transfers.
|
to NULL, and then pointed to allocated USB transfers.
|
||||||
@ -171,9 +172,10 @@ is the private softc pointer, which will be used to initialize
|
|||||||
"xfer->priv_sc".
|
"xfer->priv_sc".
|
||||||
.Fa priv_mtx
|
.Fa priv_mtx
|
||||||
is the private mutex protecting the transfer structure and the
|
is the private mutex protecting the transfer structure and the
|
||||||
softc. This pointer is used to initialize "xfer->priv_mtx".
|
softc.
|
||||||
This function returns
|
This pointer is used to initialize "xfer->priv_mtx".
|
||||||
zero upon success. A non-zero return value indicates failure.
|
This function returns zero upon success.
|
||||||
|
A non-zero return value indicates failure.
|
||||||
.
|
.
|
||||||
.Pp
|
.Pp
|
||||||
.
|
.
|
||||||
@ -245,8 +247,8 @@ pointer.
|
|||||||
.
|
.
|
||||||
The USB callback has three states.
|
The USB callback has three states.
|
||||||
.
|
.
|
||||||
USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR. USB_ST_SETUP is the
|
USB_ST_SETUP, USB_ST_TRANSFERRED and USB_ST_ERROR.
|
||||||
initial state.
|
USB_ST_SETUP is the initial state.
|
||||||
.
|
.
|
||||||
After the callback has been called with this state it will always be
|
After the callback has been called with this state it will always be
|
||||||
called back at a later stage in one of the other two states.
|
called back at a later stage in one of the other two states.
|
||||||
@ -323,7 +325,8 @@ The SETUP packet is always pointed to by frame 0 and the
|
|||||||
length is set by
|
length is set by
|
||||||
.Fn usbd_xfer_frame_len
|
.Fn usbd_xfer_frame_len
|
||||||
also if there should not be
|
also if there should not be
|
||||||
sent any SETUP packet! If an USB control transfer has no DATA stage,
|
sent any SETUP packet!
|
||||||
|
If an USB control transfer has no DATA stage,
|
||||||
then the number of frames should be set to 1.
|
then the number of frames should be set to 1.
|
||||||
.
|
.
|
||||||
Else the default number of frames is 2.
|
Else the default number of frames is 2.
|
||||||
@ -440,10 +443,12 @@ Depending on the endpoint type, this field has different meaning:
|
|||||||
"0" use the default interrupt interval based on endpoint descriptor.
|
"0" use the default interrupt interval based on endpoint descriptor.
|
||||||
"Else" use the given value for polling rate.
|
"Else" use the given value for polling rate.
|
||||||
.It UE_ISOCHRONOUS
|
.It UE_ISOCHRONOUS
|
||||||
"0" use default. "Else" the value is ignored.
|
"0" use default.
|
||||||
|
"Else" the value is ignored.
|
||||||
.It UE_BULK
|
.It UE_BULK
|
||||||
.It UE_CONTROL
|
.It UE_CONTROL
|
||||||
"0" no transfer pre-delay. "Else" a delay as given by this field in
|
"0" no transfer pre-delay.
|
||||||
|
"Else" a delay as given by this field in
|
||||||
milliseconds is inserted before the hardware is started when
|
milliseconds is inserted before the hardware is started when
|
||||||
"usbd_transfer_submit()" is called.
|
"usbd_transfer_submit()" is called.
|
||||||
.Pp
|
.Pp
|
||||||
@ -453,14 +458,14 @@ pre-delay has elapsed!
|
|||||||
.
|
.
|
||||||
.Pp
|
.Pp
|
||||||
.Fa timeout
|
.Fa timeout
|
||||||
field, if non-zero, will set the transfer timeout in milliseconds. If
|
field, if non-zero, will set the transfer timeout in milliseconds.
|
||||||
the "timeout" field is zero and the transfer type is ISOCHRONOUS a
|
If the "timeout" field is zero and the transfer type is ISOCHRONOUS a
|
||||||
timeout of 250ms will be used.
|
timeout of 250ms will be used.
|
||||||
.
|
.
|
||||||
.Pp
|
.Pp
|
||||||
.Fa frames
|
.Fa frames
|
||||||
field sets the maximum number of frames. If zero is specified it will
|
field sets the maximum number of frames.
|
||||||
yield the following results:
|
If zero is specified it will yield the following results:
|
||||||
.Bl -tag -width "UE_INTERRUPT"
|
.Bl -tag -width "UE_INTERRUPT"
|
||||||
.It UE_BULK
|
.It UE_BULK
|
||||||
xfer->nframes = 1;
|
xfer->nframes = 1;
|
||||||
@ -469,7 +474,8 @@ xfer->nframes = 1;
|
|||||||
.It UE_CONTROL
|
.It UE_CONTROL
|
||||||
xfer->nframes = 2;
|
xfer->nframes = 2;
|
||||||
.It UE_ISOCHRONOUS
|
.It UE_ISOCHRONOUS
|
||||||
Not allowed. Will cause an error.
|
Not allowed.
|
||||||
|
Will cause an error.
|
||||||
.El
|
.El
|
||||||
.
|
.
|
||||||
.Pp
|
.Pp
|
||||||
@ -486,26 +492,29 @@ be used when setting up the given USB transfer.
|
|||||||
.Pp
|
.Pp
|
||||||
.Fa flags
|
.Fa flags
|
||||||
field has type "struct usb_xfer_flags" and allows one to set initial
|
field has type "struct usb_xfer_flags" and allows one to set initial
|
||||||
flags an USB transfer. Valid flags are:
|
flags an USB transfer.
|
||||||
|
Valid flags are:
|
||||||
.Bl -tag -width "force_short_xfer"
|
.Bl -tag -width "force_short_xfer"
|
||||||
.It force_short_xfer
|
.It force_short_xfer
|
||||||
This flag forces the last transmitted USB packet to be short. A short
|
This flag forces the last transmitted USB packet to be short.
|
||||||
packet has a length of less than "xfer->max_packet_size", which
|
A short packet has a length of less than "xfer->max_packet_size", which
|
||||||
derives from "wMaxPacketSize". This flag can be changed during
|
derives from "wMaxPacketSize".
|
||||||
operation.
|
This flag can be changed during operation.
|
||||||
.It short_xfer_ok
|
.It short_xfer_ok
|
||||||
This flag allows the received transfer length, "xfer->actlen" to be
|
This flag allows the received transfer length, "xfer->actlen" to be
|
||||||
less than "xfer->sumlen" upon completion of a transfer. This flag can
|
less than "xfer->sumlen" upon completion of a transfer.
|
||||||
be changed during operation.
|
This flag can be changed during operation.
|
||||||
.It short_frames_ok
|
.It short_frames_ok
|
||||||
This flag allows the reception of multiple short USB frames. This flag
|
This flag allows the reception of multiple short USB frames.
|
||||||
|
This flag
|
||||||
only has effect for BULK and INTERRUPT endpoints and if the number of
|
only has effect for BULK and INTERRUPT endpoints and if the number of
|
||||||
frames received is greater than 1. This flag can be changed during
|
frames received is greater than 1.
|
||||||
operation.
|
This flag can be changed during operation.
|
||||||
.It pipe_bof
|
.It pipe_bof
|
||||||
This flag causes a failing USB transfer to remain first in the PIPE
|
This flag causes a failing USB transfer to remain first in the PIPE
|
||||||
queue except in the case of "xfer->error" equal to
|
queue except in the case of "xfer->error" equal to
|
||||||
"USB_ERR_CANCELLED". No other USB transfers in the affected PIPE queue
|
"USB_ERR_CANCELLED".
|
||||||
|
No other USB transfers in the affected PIPE queue
|
||||||
will be started until either:
|
will be started until either:
|
||||||
.Bl -tag -width "X"
|
.Bl -tag -width "X"
|
||||||
.It 1
|
.It 1
|
||||||
@ -569,8 +578,8 @@ This flag can be changed during operation.
|
|||||||
.
|
.
|
||||||
.
|
.
|
||||||
.It no_pipe_ok
|
.It no_pipe_ok
|
||||||
Setting this flag causes the USB_ERR_NO_PIPE error to be ignored. This
|
Setting this flag causes the USB_ERR_NO_PIPE error to be ignored.
|
||||||
flag can not be changed during operation.
|
This flag can not be changed during operation.
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
.It stall_pipe
|
.It stall_pipe
|
||||||
@ -614,7 +623,8 @@ request structure.
|
|||||||
.
|
.
|
||||||
.Pp
|
.Pp
|
||||||
.Fa callback
|
.Fa callback
|
||||||
pointer sets the USB callback. This field is mandatory.
|
pointer sets the USB callback.
|
||||||
|
This field is mandatory.
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
.Sh USB LINUX COMPAT LAYER
|
.Sh USB LINUX COMPAT LAYER
|
||||||
@ -635,7 +645,8 @@ module complies with the USB 2.0 standard.
|
|||||||
The
|
The
|
||||||
.Nm usb
|
.Nm usb
|
||||||
module has been inspired by the NetBSD USB stack initially written by
|
module has been inspired by the NetBSD USB stack initially written by
|
||||||
Lennart Augustsson. The
|
Lennart Augustsson.
|
||||||
|
The
|
||||||
.Nm usb
|
.Nm usb
|
||||||
module was written by
|
module was written by
|
||||||
.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
|
.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org .
|
||||||
|
@ -73,7 +73,8 @@ The thread performing the call; this pointer will be dereferenced to find
|
|||||||
the process and its file descriptor structure, in order to identify the
|
the process and its file descriptor structure, in order to identify the
|
||||||
root vnode to use.
|
root vnode to use.
|
||||||
.It Fa vp
|
.It Fa vp
|
||||||
The vnode to search for. No need to be locked by the caller.
|
The vnode to search for.
|
||||||
|
No need to be locked by the caller.
|
||||||
.It Fa retbuf
|
.It Fa retbuf
|
||||||
Pointer to a
|
Pointer to a
|
||||||
.Vt "char *"
|
.Vt "char *"
|
||||||
|
@ -320,8 +320,10 @@ The
|
|||||||
.Fn uma_zone_set_maxaction
|
.Fn uma_zone_set_maxaction
|
||||||
function sets a function that will be called when the given zone becomes full
|
function sets a function that will be called when the given zone becomes full
|
||||||
and fails to allocate an item.
|
and fails to allocate an item.
|
||||||
The function will be called with the zone locked. Also, the function
|
The function will be called with the zone locked.
|
||||||
that called the allocation function may have held additional locks. Therefore,
|
Also, the function
|
||||||
|
that called the allocation function may have held additional locks.
|
||||||
|
Therefore,
|
||||||
this function should do very little work (similar to a signal handler).
|
this function should do very little work (similar to a signal handler).
|
||||||
.Pp
|
.Pp
|
||||||
The
|
The
|
||||||
|
Loading…
Reference in New Issue
Block a user