sbp.4: Add a hardware section, fix markup nits

+ tag SPDX
+ add sysctl to apropos database
+ fix markup of examples and reflow a overly long line
+ add a hardware section for hw relnotes

MFC after:	3 days
This commit is contained in:
Alexander Ziaee
2025-11-11 13:38:04 -05:00
parent 8225ed665e
commit dee8e38f52
+17 -6
View File
@@ -1,3 +1,6 @@
.\"
.\" SPDX-License-Identifier: BSD-4-Clause
.\"
.\" Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa .\" Copyright (c) 1998-2002 Katsushi Kobayashi and Hidetoshi Shimokawa
.\" All rights reserved. .\" All rights reserved.
.\" .\"
@@ -29,7 +32,7 @@
.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE. .\" POSSIBILITY OF SUCH DAMAGE.
.\" .\"
.Dd February 8, 2012 .Dd November 11, 2025
.Dt SBP 4 .Dt SBP 4
.Os .Os
.Sh NAME .Sh NAME
@@ -62,19 +65,27 @@ might wonder why the device is not detached at the CAM layer when the device
is unplugged. is unplugged.
It is detached only if the device has not been plugged again It is detached only if the device has not been plugged again
during several bus resets. during several bus resets.
This is for preventing to detach an active file system This is for preventing to detach an active file system even when the
even when the device cannot be probed correctly for some reason after a bus reset device cannot be probed correctly for some reason after a bus reset
or when the device is temporary disconnected because the user changes the bus or when the device is temporary disconnected because the user changes the bus
topology. topology.
If you want to force to detach the device, run If you want to force to detach the device, run
.Dq Nm fwcontrol Fl r .Ql fwcontrol -r
several times or set hw.firewire.hold_count=0 by several times or set
.Va hw.firewire.hold_count=0
by
.Xr sysctl 8 . .Xr sysctl 8 .
.Pp .Pp
Some (broken) HDDs do not work well with tagged queuing. Some (broken) HDDs do not work well with tagged queuing.
If you have problems with such drives, try If you have problems with such drives, try
.Dq Nm camcontrol [device id] tags -N 1 .Ql camcontrol [device id] tags -N 1
to disable tagged queuing. to disable tagged queuing.
.Sh HARDWARE
The
.Nm
driver supports FireWire Serial Bus Protocol 2
.Pq SBP-2
storage devices.
.Sh SEE ALSO .Sh SEE ALSO
.Xr cam 4 , .Xr cam 4 ,
.Xr firewire 4 , .Xr firewire 4 ,