mirror of
https://github.com/akuker/RASCSI.git
synced 2026-10-26 04:02:17 +00:00
Daniel Markstedt
1ee4a320b8
Move GPIO mappings into a single module and select a board profile at process startup instead of at compile time: Build every GPIO-facing utility for every supported profile. At the same time, we remove support for the historical AIBOM board type since it's the only one using positive logic, the other three variants share the same electrical behavior. Run piscsi, scsimon, scsiloop, scsidump, or sasidump with -C=STANDARD, FULLSPEC, or GAMERNIUM. FULLSPEC remains the default. To select a profile for the systemd service, set PISCSI_CONNECTION_TYPE and restart the service.
43 lines
2.0 KiB
Groff
43 lines
2.0 KiB
Groff
.Dd December 18, 2025
|
|
.Dt SCSIMON 1
|
|
.Os PiSCSI
|
|
.Sh NAME
|
|
.Nm scsimon
|
|
.Nd Acts as a data capture tool for all traffic on the SCSI bus. Data is stored in a Value Change Dump (VCD) file.
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl C Ar TYPE
|
|
.Op Fl i Ar input_file_json
|
|
.Op Fl b Ar buffer_size
|
|
.Op Ar output_file
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
monitors all of the traffic on the SCSI bus, using a PiSCSI device. The data is cached in memory while the tool is running. A circular buffer is used so that only the most recent transactions are stored, with a default size of 1,000,000 unless overridden by the -b option. The tool will continue to run until the user presses CTRL-C, or the process receives a SIGINT signal.
|
|
.Pp
|
|
If the -i option is specified, scsimon will parse the provided JSON file instead of capturing new data. If -i option is not specified, scsimon will read the GPIO pins.
|
|
.Pp
|
|
The logged data is stored in files with the base name specified by output_file, or "log" if not specified. The appropriate file extension (e.g., .json or .vcd) will be appended.
|
|
.Pp
|
|
To quit scsimon, press Control + C.
|
|
.Sh OPTIONS
|
|
.Fl i Ar input_file_json
|
|
scsimon will parse the json file instead of capturing new data. If -i option is not specified, scsimon will read the gpio pins.
|
|
.Fl C Ar TYPE
|
|
Select STANDARD, FULLSPEC, or GAMERNIUM for live GPIO capture. FULLSPEC is the
|
|
default. Capture files record their selected type and use it when imported.
|
|
.Fl b Ar buffer_size
|
|
Override the default buffer size of 1000000.
|
|
.Ar output_file
|
|
Base name of the output files. The file extension (ex: .json) will be appended to this file name.
|
|
.Sh EXAMPLES
|
|
Make sure you've stopped the piscsi service. Then launch scsimon to capture all SCSI traffic available to the PiSCSI hardware:
|
|
.Dl Nm scsimon
|
|
.Pp
|
|
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
|
|
.Xr scsictl 1 ,
|
|
.Xr piscsi 1 ,
|
|
.Xr scsidump 1
|
|
.Pp
|
|
Full documentation is available at: <https://www.piscsi.com>
|