README files are too out-of-date. I updated them a bit. Any improvement to documents (including the web site) are welcome. = From: FUJITA Tomonori <fujita.tomonori at lab.ntt.co.jp> Subject: [PATCH] update README files Signed-off-by: FUJITA Tomonori <fujita.tomonori at lab.ntt.co.jp> --- README | 53 ++++++++++++++++++++++++++++---------------------- doc/README.ibmvstgt | 8 +++++++ doc/README.iscsi | 7 ++++++ 3 files changed, 45 insertions(+), 23 deletions(-) diff --git a/README b/README index 4c95453..22785fc 100644 --- a/README +++ b/README @@ -3,40 +3,47 @@ Introduction Linux target framework (tgt) aims to simplify various SCSI target driver (iSCSI, Fibre Channel, SRP, etc) creation and maintenance. -Tgt consists of kernel modules, user-space daemon, and user-space -tools. Some target drivers uses all of them and some use only -user-space daemon and tools (i.e. they completely runs in user space). +Currently, tgt supports the following target drivers: -Currently, tgt supports three target drivers: +- iSCSI software target driver for Ethernet NICs -- IBM VIO server (ibmvstgt) -- iSCSI -- Xen vscsifront/back +- iSER software target driver for Infiniband and RDMA NICs -Note that tgt is under active development. Don't play with important -data. +- IBM System p VIO server -The code is under the GNU General Public License version 2. +- FCoE software target driver for Ethernet NICs (in progress) +- Qlogic qla2xxx FC target driver (in progress) -Preparation -------------- -The iSCSI target driver can works with the 2.6.X kernels. It requires -OpenSSL library (libssl-dev for debian, openssl-devel for Fedora). +Tgt consists of kernel modules, user-space daemon, and user-space +tools. iSCSI, iSER, and FCoE target drivers use only user-space daemon +and tools (i.e. they are just user-space applications. They don't need +any kernel support). + +tgt can emulate the following device types: -host:~/tgt/usr$ make ISCSI=1 +- SBC: a virtual disk drive that can use a file to store the content. -If you want IBM VIO target driver, get kernel version 2.6.20, rebuild -the kernel, and reboot with the new kernel. Note you need to enable -SCSI_TGT, SCSI_SRP, and SCSI_IBMVSCSIS kernel options. +- SMC: a virtual media jukebox that can be controlled by the "mtx" +tool (partially functional). -host:~/tgt/usr$ make KERNELSRC=<kernel-src-directory> IBMVIO=1 +- MMC: a virtual DVD drive that can read DVD-ROM iso files and create +burnable DVD+R. It can be combined with SMC to provide a fully +operational DVD jukebox. -Make sure that everything is built successfully. +- SSC: a virtual tape device (aka VTL) that can use a file to store +the content (in progress). -Now you can run tgt. Target drivers have their own ways for -configuration. So find an appropriate documentation in the doc -directory. +- OSD: a virtual object-based storage device that can use a file to +store the content (in progress). + +The code is under the GNU General Public License version 2. + + +Preparation +------------- +Target drivers have their own ways to build, configure, etc. So find +an appropriate documentation in the doc directory. Developer Notes diff --git a/doc/README.ibmvstgt b/doc/README.ibmvstgt index 9a9dbd8..d77f932 100644 --- a/doc/README.ibmvstgt +++ b/doc/README.ibmvstgt @@ -1,5 +1,13 @@ Starting ------------- +If you want IBM VIO target driver, get kernel version 2.6.20, rebuild +the kernel, and reboot with the new kernel. Note you need to enable +SCSI_TGT, SCSI_SRP, and SCSI_IBMVSCSIS kernel options. + +host:~/tgt/usr$ make KERNELSRC=<kernel-src-directory> IBMVIO=1 + +Make sure that everything is built successfully. + Try the following commands: host:~/tgt$ su diff --git a/doc/README.iscsi b/doc/README.iscsi index 5aec190..38c3321 100644 --- a/doc/README.iscsi +++ b/doc/README.iscsi @@ -5,6 +5,13 @@ This show a simple example to set up some targets. Starting the daemon ------------- +The iSCSI target driver can works with the 2.6.X kernels. It requires +OpenSSL library (libssl-dev for debian, openssl-devel for Fedora). + +First, you need to compile the source code: + +host:~/tgt/usr$ make ISCSI=1 + Try the following commands: host:~/tgt$ su -- 1.5.4.2 -- To unsubscribe from this list: send the line "unsubscribe stgt" in the body of a message to majordomo at vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html |