2020-07-09 18:21:15 +00:00
.TH rascsi 1
.SH NAME
rascsi \- Emulates SCSI devices using the Raspberry Pi GPIO pins
.SH SYNOPSIS
.B rascsi
2021-08-07 00:30:35 +00:00
[\fB \- f\f ® \fI FOLDER\fR ]
[\fB \- g\f ® \fI LOG_LEVEL\fR ]
[\fB \- h\fR ]
[\fB \- p\f ® \fI PORT\fR ]
[\fB \- v\fR ]
[\fB \- IDn\fR \fI FILE\fR ]
[\fB \- HDn\fR \fI FILE\fR ]...
2020-07-09 18:21:15 +00:00
.SH DESCRIPTION
.B rascsi
Emulates SCSI devices using the Raspberry Pi GPIO pins.
.PP
In the arguments to RaSCSI, one or more SCSI (-IDn) or SASI (-HDn) devices can be specified.
2021-06-19 15:17:23 +00:00
The number (n) after the ID or HD identifier specifies the ID number for that device.
2021-08-07 00:30:35 +00:00
For SCSI: The ID is limited from 0-7. However, typically SCSI ID 7 is reserved for the "initiator" (the host computer). Note that SASI is considered rare and only used on very early Sharp X68000 computers.
2020-07-09 18:21:15 +00:00
.PP
2021-06-19 15:17:23 +00:00
RaSCSI will determine the type of device based upon the file extension of the FILE argument.
2020-07-09 18:21:15 +00:00
hdf: SASI Hard Disk image (XM6 SASI HD image - typically only used with X68000)
2021-08-07 00:30:35 +00:00
hds: SCSI Hard Disk image (generic)
2020-07-09 18:21:15 +00:00
hdn: SCSI Hard Disk image (NEC GENUINE)
hdi: SCSI Hard Disk image (Anex86 HD image)
nhd: SCSI Hard Disk image (T98Next HD image)
hda: SCSI Hard Disk image (APPLE GENUINE - typically used with Mac SCSI emulation)
mos: SCSI Magneto-optical image (XM6 SCSI MO image - typically only used with X68000)
iso: SCSI CD-ROM image (ISO 9660 image)
For example, if you want to specify an Apple-compatible HD image on ID 0, you can use the following command:
sudo rascsi -ID0 /path/to/drive/hdimage.hda
2021-08-07 00:30:35 +00:00
Once RaSCSI starts, it will open a socket (default port is 6868) to allow external management commands.
If another process is using the rascsi port, RaSCSI will terminate, since it is likely another instance of RaSCSI.
2020-07-09 18:21:15 +00:00
Once RaSCSI has initialized, the rasctl utility can be used to send commands.
To quit RaSCSI, press Control + C. If it is running in the background, you can kill it using an INT signal.
.SH OPTIONS
.TP
2021-08-07 00:30:35 +00:00
.BR \- f\fI " " \fI FOLDER
The default folder for image files. For files in this folder no absolute path needs to be specified. The default folder is '/home/pi/images'.
.TP
.BR \- g\fI " " \fI LOG_LEVEL
The rascsi log level (trace, debug, info, warn, err, critical, off). The default log level is 'trace'.
.TP
.BR \- h\fI " " \fI
Show a help page.
.TP
.BR \- p\fI " " \fI PORT
The rascsi server port, default is 6868.
.TP
.BR \- v\fI " " \fI
Display the rascsi version.
.TP
2021-08-10 02:20:58 +00:00
.BR \- ID\fIn " " \fI FILE[:TYPE]
2020-07-09 18:21:15 +00:00
n is the SCSI ID number (0-7)
.IP
2021-08-10 02:20:58 +00:00
FILE is the name of the image file to attach to that ID. An optional explicit device type (SASI_HD, SCSI_HD, CD, MO, BR, NUVOLINK, DAYNAPORT) can be provided after a colon.
2020-07-09 18:21:15 +00:00
.TP
.BR \- HD\fIn " " \fI FILE
n is the SASI ID number (0-15)
.IP
2021-08-07 00:30:35 +00:00
FILE is the name of the image file to attach to that ID. If FILE starts with '/dev/' the extension, which encodes the device type, is stripped, so that device files can conveniently be used as image files.
2020-07-09 18:21:15 +00:00
.IP
Note: SASI usage is rare, and is typically limited to early Sharp X68000 systems.
.SH EXAMPLES
Launch RaSCSI with no emulated drives attached:
rascsi
2021-08-07 00:30:35 +00:00
Launch RaSCSI with an Apple hard drive image as ID 0 and a CD-ROM as ID 2
2020-07-09 18:21:15 +00:00
rascsi -ID0 /path/to/harddrive.hda -ID2 /path/to/cdimage.iso
2021-08-10 02:20:58 +00:00
Launch RaSCSI with a SCSI hard drive image as ID 0 and the raw device file /dev/hdb (e.g. a USB stick) as a SCSI hard disk image file:
rascsi -ID0 /dev/hdb:SCSI_HD
2021-08-07 00:30:35 +00:00
2020-07-09 18:21:15 +00:00
To create an empty, 100MB HD image, use the following command:
dd if=/dev/zero of=/path/to/newimage.hda bs=512 count=204800
2021-08-07 00:30:35 +00:00
In case the fallocate command is available a much faster alternative to the dd command is:
fallocate -l 104857600 /path/to/newimage.hda
2020-07-09 18:21:15 +00:00
.SH SEE ALSO
2020-10-19 12:31:06 +00:00
rasctl(1), scsimon(1)
2020-07-09 18:21:15 +00:00
Full documentation is available at: <https://www.github.com/akuker/RASCSI/wiki/>