Macintosh-HW/RASCSI
1
0
Fork 0
mirror of https://github.com/akuker/RASCSI.git synced 2024-12-26 10:30:23 +00:00
Code Issues Projects Releases Wiki Activity

Clarify docs and error strings for scsimon (#1175)

Browse Source 
* Better usage hints in scsimon man page

* In error message, clarify that piscsi needs to be shut down
This commit is contained in:
Daniel Markstedt 2023-06-24 13:20:15 -07:00 committed by GitHub
parent c08667a81d
commit ee658c359d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
cpp/hal/gpiobus_raspberry.cpp
View File

@ -183,7 +183,7 @@ bool GPIOBUS_Raspberry::Init(mode_e mode)
// GPIO chip open // GPIO chip open
fd = open("/dev/gpiochip0", 0); fd = open("/dev/gpiochip0", 0);
if (fd == -1) { if (fd == -1) {
LOGERROR("Unable to open /dev/gpiochip0. Is PiSCSI or RaSCSI already running?") LOGERROR("Unable to open /dev/gpiochip0. If PiSCSI is running, please shut it down first.")
return false; return false;
} }
@ -199,7 +199,7 @@ bool GPIOBUS_Raspberry::Init(mode_e mode)
// Get event request // Get event request
if (ioctl(fd, GPIO_GET_LINEEVENT_IOCTL, &selevreq) == -1) { if (ioctl(fd, GPIO_GET_LINEEVENT_IOCTL, &selevreq) == -1) {
LOGERROR("Unable to register event request. Is PiSCSI or RaSCSI already running?") LOGERROR("Unable to register event request. If PiSCSI is running, please shut it down first.")
close(fd); close(fd);
return false; return false;
} }

4
doc/scsimon.1
View File

@ -18,9 +18,11 @@ To quit scsimon, press Control + C.
None None
.SH EXAMPLES .SH EXAMPLES
Launch scsimon to capture all SCSI traffic available to the PiSCSI hardware: Make sure you've stopped the piscsi service. Then launch scsimon to capture all SCSI traffic available to the PiSCSI hardware:
scsimon scsimon
If you're trying to capture a specific scenario, you'll want to wait to start scsimon until immediately before the scenario.
.SH SEE ALSO .SH SEE ALSO
scsictl(1), piscsi(1), scsidump(1) scsictl(1), piscsi(1), scsidump(1)

22
doc/scsimon_man_page.txt
View File

@ -2,20 +2,22 @@
!! ------ The native file is scsimon.1. Re-run 'make docs' after updating !! ------ The native file is scsimon.1. Re-run 'make docs' after updating
scsimon(1) General Commands Manual scsimon(1) scsimon(1) General Commands Manual scsimon(1)
NAME NAME
scsimon - Acts as a data capture tool for all traffic on the SCSI bus. Data is stored in a Value Change Dump (VCD) file. scsimon - Acts as a data capture tool for all traffic on the SCSI bus. Data is stored in a Value Change Dump
(VCD) file.
SYNOPSIS SYNOPSIS
scsimon scsimon
DESCRIPTION DESCRIPTION
scsimon monitors all of the traffic on the SCSI bus, using a PiSCSI device. The data is cached in memory while the tool is scsimon monitors all of the traffic on the SCSI bus, using a PiSCSI device. The data is cached in memory while
running. A circular buffer is used so that only the most recent 1,000,000 transactions are stored. The tool will continue the tool is running. A circular buffer is used so that only the most recent 1,000,000 transactions are stored.
to run until the user presses CTRL-C, or the process receives a SIGINT signal. The tool will continue to run until the user presses CTRL-C, or the process receives a SIGINT signal.
The logged data is stored in a file called "log.vcd" in the current working directory from where scsimon was launched. The logged data is stored in a file called "log.vcd" in the current working directory from where scsimon was
launched.
Currently, scsimon doesn't accept any arguments. Currently, scsimon doesn't accept any arguments.
@ -25,12 +27,16 @@ OPTIONS
None None
EXAMPLES EXAMPLES
Launch scsimon to capture all SCSI traffic available to the PiSCSI hardware: Make sure you've stopped the piscsi service. Then launch scsimon to capture all SCSI traffic available to the
PiSCSI hardware:
scsimon scsimon
If you're trying to capture a specific scenario, you'll want to wait to start scsimon until immediately before
the scenario.
SEE ALSO SEE ALSO
scsictl(1), piscsi(1), scsidump(1) scsictl(1), piscsi(1), scsidump(1)
Full documentation is available at: <https://www.piscsi.com> Full documentation is available at: <https://www.piscsi.com>
scsimon(1) scsimon(1)