diff --git a/share/man/man4/acpi_wmi.4 b/share/man/man4/acpi_wmi.4 index 0f73573cf876..eaf85440702c 100644 --- a/share/man/man4/acpi_wmi.4 +++ b/share/man/man4/acpi_wmi.4 @@ -1,122 +1,121 @@ .\" Copyright (c) 2009 Michael Gmelin .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd September 5, 2019 .Dt ACPI_WMI 4 .Os .Sh NAME .Nm acpi_wmi .Nd "ACPI to WMI mapping driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following line in your kernel configuration file: .Bd -ragged -offset indent .Cd "device acpi_wmi" .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent acpi_wmi_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides an interface for vendor specific WMI implementations (e.g. HP and Acer laptops). It creates /dev/wmistat%d, which can be read to get information about GUIDs found in the system. .Sh FILES .Bl -tag -width /dev/wmistat%d -compact .It Pa /dev/wmistat%d WMI status device. .El .Sh SYSCTLS The following sysctl node is currently implemented: .Bl -tag .It Va dev.acpi_wmi.%d.bmof Managed Object Format (MOF) blob. You can obtain human readable output by bmf2mof in bmfdec tool. (https://github.com/pali/bmfdec) .El - .Sh EXAMPLES .Bd -literal # cat /dev/wmistat0 GUID INST EXPE METH STR EVENT OID {5FB7F034-2C63-45E9-BE91-3D44E2C707E4} 1 NO WMAA NO NO AA {95F24279-4D7B-4334-9387-ACCDC67EF61C} 1 NO NO NO 0x80+ - {2B814318-4BE8-4707-9D84-A190A859B5D0} 1 NO NO NO 0xA0 - {05901221-D566-11D1-B2F0-00A0C9062910} 1 NO NO NO NO AB {1F4C91EB-DC5C-460B-951D-C7CB9B4B8D5E} 1 NO WMBA NO NO BA {2D114B49-2DFB-4130-B8FE-4A3C09E75133} 57 NO NO NO NO BC {988D08E3-68F4-4C35-AF3E-6A1B8106F83C} 20 NO NO NO NO BD {14EA9746-CE1F-4098-A0E0-7045CB4DA745} 1 NO NO NO NO BE {322F2028-0F84-4901-988E-015176049E2D} 2 NO NO NO NO BF {8232DE3D-663D-4327-A8F4-E293ADB9BF05} 0 NO NO NO NO BG {8F1F6436-9F42-42C8-BADC-0E9424F20C9A} 0 NO NO NO NO BH {8F1F6435-9F42-42C8-BADC-0E9424F20C9A} 0 NO NO NO NO BI # sysctl -b dev.acpi_wmi.0.bmof |bmf2mof [abstract] class Lenovo_BIOSElement { }; [WMI, Dynamic, Provider("WMIProv"), WmiExpense(1), Description("Bios Setting"), GUID("{51F5230E-9677-46cd-A1CF-C0B23EE34DB7}"), Locale("MS\\0x409")] class Lenovo_BiosSetting : Lenovo_BiosElement { [key, read] String InstanceName; [read] Boolean Active; [WmiDataId(1), Description("BIOS setting")] String CurrentSetting; }; ... .Ed .Sh SEE ALSO .Xr acpi 4 .Sh HISTORY The .Nm device driver first appeared in .Fx 8.0 . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Michael Gmelin Aq Mt freebsd@grem.de . .Pp Work has been inspired by the Linux acpi-wmi driver written by Carlos Corbacho. .Pp See http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx for the specification of ACPI-WMI. .Pp MOF part has been inspired by the Linux wmi-bmof driver written by Andy Lutomirski. .Pp This manual page was written by .An Michael Gmelin Aq Mt freebsd@grem.de . diff --git a/share/man/man4/hmt.4 b/share/man/man4/hmt.4 index d939c655d24d..e5d0100c6b42 100644 --- a/share/man/man4/hmt.4 +++ b/share/man/man4/hmt.4 @@ -1,80 +1,79 @@ .\" Copyright (c) 2014-2020 Vladimir Kondratyev .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd August 11, 2020 .Dt HMT 4 .Os .Sh NAME .Nm hmt .Nd MS Windows 7/8/10 - compatible HID multi-touch device driver .Sh SYNOPSIS To compile this driver into the kernel, place the following lines into your kernel configuration file: .Bd -ragged -offset indent .Cd "device hmt" .Cd "device hidbus" .Cd "device hid" .Cd "device hconf" .Cd "device evdev" - .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent hmt_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for the MS Windows 7/8/10 - compatible HID multi-touch devices found in many laptops. .Pp To get multi-touch device working in .Xr X 7 , install .Pa ports/x11-drivers/xf86-input-evdev . .Sh FILES .Nm creates a pseudo-device file, .Pa /dev/input/eventX which presents the multi-touch device as an input event device. .Sh SEE ALSO .Xr hid 4 , .Xr loader.conf 5 , .Xr xorg.conf 5 Pq Pa ports/x11/xorg , .Xr evdev 4 Pq Pa ports/x11-drivers/xf86-input-evdev . .Sh AUTHORS .An -nosplit The .Nm driver was written by .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org . .Sh BUGS .Nm cannot act like .Xr sysmouse 4 diff --git a/share/man/man4/md.4 b/share/man/man4/md.4 index 621d1a55c12d..d6b92d86507d 100644 --- a/share/man/man4/md.4 +++ b/share/man/man4/md.4 @@ -1,172 +1,170 @@ .\" ---------------------------------------------------------------------------- .\" "THE BEER-WARE LICENSE" (Revision 42): .\" wrote this file. As long as you retain this notice you .\" can do whatever you want with this stuff. If we meet some day, and you think .\" this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp .\" ---------------------------------------------------------------------------- .\" .\" $FreeBSD$ .\" .Dd January 8, 2020 .Dt MD 4 .Os .Sh NAME .Nm md .Nd memory disk .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your kernel configuration file: .Bd -ragged -offset indent .Cd "device md" .Ed .Pp Alternatively, to load the driver as a module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent geom_md_load="YES" .Ed .Sh DESCRIPTION The .Nm driver provides support for four kinds of memory backed virtual disks: .Bl -tag -width preload .It Cm malloc Backing store is allocated using .Xr malloc 9 . Only one malloc-bucket is used, which means that all .Nm devices with .Cm malloc backing must share the malloc-per-bucket-quota. The exact size of this quota varies, in particular with the amount of RAM in the system. The exact value can be determined with .Xr vmstat 8 . .It Cm preload A module loaded by .Xr loader 8 with type .Sq md_image is used for backing store. For backwards compatibility the type .Sq mfs_root is also recognized. See the description of module loading directives in .Xr loader.conf 5 and note that the module name will either be an absolute path to the image file or the name of a file in the .Va module_path . .Pp If the kernel is created with option .Dv MD_ROOT the first preloaded image found will become the root file system. .It Cm vnode A regular file is used as backing store. This allows for mounting ISO images without the tedious detour over actual physical media. .It Cm swap Backing store is allocated from buffer memory. Pages get pushed out to the swap when the system is under memory pressure, otherwise they stay in the operating memory. Using .Cm swap backing is generally preferable over .Cm malloc backing. .El .Pp For more information, please see .Xr mdconfig 8 . .Sh EXAMPLES To create a kernel with a ramdisk or MD file system, your kernel config needs the following options: .Bd -literal -offset indent options MD_ROOT # MD is a potential root device options MD_ROOT_READONLY # disallow mounting root writeable options MD_ROOT_SIZE=8192 # 8MB ram disk makeoptions MFS_IMAGE=/h/foo/ARM-MD options ROOTDEVNAME=\\"ufs:md0\\" .Ed .Pp The image in .Pa /h/foo/ARM-MD will be loaded as the initial image each boot. To create the image to use, please follow the steps to create a file-backed disk found in the .Xr mdconfig 8 man page. Other tools will also create these images, such as NanoBSD. .Sh ARM KERNEL OPTIONS On armv6 and armv7 architectures, an MD_ROOT image larger than approximately 55 MiB may require building a custom kernel using several tuning options related to kernel memory usage. .Bl -tag -width indent .It Cd options LOCORE_MAP_MB= This configures how much memory is mapped for the kernel during the early initialization stages. The value must be at least as large as the kernel plus all preloaded modules, including the root image. There is no downside to setting this value too large, as long as it does not exceed the amount of physical memory. The default is 64 MiB. .It Cd options NKPT2PG= This configures the number of kernel L2 page table pages to preallocate during kernel initialization. Each L2 page can map 4 MiB of kernel space. The value must be large enough to map the kernel plus all preloaded modules, including the root image. The default value is 32, which is sufficient to map 128 MiB. .It Cd options VM_KMEM_SIZE_SCALE= This configures the amount of kernel virtual address (KVA) space to dedicate to the kmem_arena map. The scale value is the ratio of physical to virtual pages. The default value of 3 allocates a page of KVA for each 3 pages of physical ram in the system. - The kernel and modules, including the root image, also consume KVA. The combination of a large root image and the default scaling may preallocate so much KVA that there is not enough remaining address space to allocate kernel stacks, IO buffers, and other resources that are not part of kmem_arena. Overallocating kmem_arena space is likely to manifest as failure to launch userland processes with "cannot allocate kernel stack" messages. - Setting the scale value too high may result in kernel failure to allocate memory because kmem_arena is too small, and the failure may require significant runtime to manifest. Empirically, a value of 5 works well for a 200 MiB root image on a system with 2 GiB of physical ram. .El .Sh SEE ALSO .Xr gpart 8 , .Xr loader 8 , .Xr mdconfig 8 , .Xr mdmfs 8 , .Xr newfs 8 , .Xr vmstat 8 .Sh HISTORY The .Nm driver first appeared in .Fx 4.0 as a cleaner replacement for the MFS functionality previously used in .Tn PicoBSD and in the .Fx installation process. .Pp The .Nm driver did a hostile takeover of the .Xr vn 4 driver in .Fx 5.0 . .Sh AUTHORS The .Nm driver was written by .An Poul-Henning Kamp Aq Mt phk@FreeBSD.org . diff --git a/share/man/man4/sa.4 b/share/man/man4/sa.4 index 35ffcdb877d6..928bf5e90292 100644 --- a/share/man/man4/sa.4 +++ b/share/man/man4/sa.4 @@ -1,503 +1,503 @@ .\" Copyright (c) 1996 .\" Julian Elischer . All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd January 18, 2022 .Dt SA 4 .Os .Sh NAME .Nm sa .Nd SCSI Sequential Access device driver .Sh SYNOPSIS .Cd device sa .Sh DESCRIPTION The .Nm driver provides support for all .Tn SCSI devices of the sequential access class that are attached to the system through a supported .Tn SCSI Host Adapter. The sequential access class includes tape and other linear access devices. .Pp A .Tn SCSI Host adapter must also be separately configured into the system before a .Tn SCSI sequential access device can be configured. .Sh MOUNT SESSIONS The .Nm driver is based around the concept of a .Dq Em mount session , which is defined as the period between the time that a tape is mounted, and the time when it is unmounted. Any parameters set during a mount session remain in effect for the remainder of the session or until replaced. The tape can be unmounted, bringing the session to a close in several ways. These include: .Bl -enum .It Closing a `rewind device', referred to as sub-mode 00 below. An example is .Pa /dev/sa0 . .It Using the MTOFFL .Xr ioctl 2 command, reachable through the .Sq Cm offline command of .Xr mt 1 . .El .Pp It should be noted that tape devices are exclusive open devices, except in the case where a control mode device is opened. In the latter case, exclusive access is only sought when needed (e.g., to set parameters). .Sh SUB-MODES Bits 0 and 1 of the minor number are interpreted as .Sq sub-modes . The sub-modes differ in the action taken when the device is closed: .Bl -tag -width XXXX .It 00 A close will rewind the device; if the tape has been written, then a file mark will be written before the rewind is requested. The device is unmounted. .It 01 A close will leave the tape mounted. If the tape was written to, a file mark will be written. No other head positioning takes place. Any further reads or writes will occur directly after the last read, or the written file mark. .It 10 A close will rewind the device. If the tape has been written, then a file mark will be written before the rewind is requested. On completion of the rewind an unload command will be issued. The device is unmounted. .El .Sh BLOCKING MODES .Tn SCSI tapes may run in either .Sq Em variable or .Sq Em fixed block-size modes. Most .Tn QIC Ns -type devices run in fixed block-size mode, where most nine-track tapes and many new cartridge formats allow variable block-size. The difference between the two is as follows: .Bl -inset .It Variable block-size: Each write made to the device results in a single logical record written to the tape. One can never read or write .Em part of a record from tape (though you may request a larger block and read a smaller record); nor can one read multiple blocks. Data from a single write is therefore read by a single read. The block size used may be any value supported by the device, the .Tn SCSI adapter and the system (usually between 1 byte and 64 Kbytes, sometimes more). .Pp When reading a variable record/block from the tape, the head is logically considered to be immediately after the last item read, and before the next item after that. If the next item is a file mark, but it was never read, then the next process to read will immediately hit the file mark and receive an end-of-file notification. .It Fixed block-size: Data written by the user is passed to the tape as a succession of fixed size blocks. It may be contiguous in memory, but it is considered to be a series of independent blocks. One may never write an amount of data that is not an exact multiple of the blocksize. One may read and write the same data as a different set of records. In other words, blocks that were written together may be read separately, and vice-versa. .Pp If one requests more blocks than remain in the file, the drive will encounter the file mark. As there is some data to return (unless there were no records before the file mark), the read will succeed, returning that data. The next read will return immediately with a value of 0. (As above, if the file mark is never read, it remains for the next process to read if in no-rewind mode.) .El .Sh BLOCK SIZES By default, the driver will NOT accept reads or writes to a tape device that are larger than may be written to or read from the mounted tape using a single write or read request. Because of this, the application author may have confidence that his wishes are respected in terms of the block size written to tape. For example, if the user tries to write a 256KB block to the tape, but the controller can handle no more than 128KB, the write will fail. The previous .Fx behavior, prior to .Fx 10.0, was to break up large reads or writes into smaller blocks when going to the tape. The problem with that behavior, though, is that it hides the actual on-tape block size from the application writer, at least in variable block mode. .Pp If the user would like his large reads and writes broken up into separate pieces, he may set the following loader tunables. Note that these tunables WILL GO AWAY in .Fx 11.0 . They are provided for transition purposes only. .Bl -tag -width 12 .It kern.cam.sa.allow_io_split .Pp This variable, when set to 1, will configure all .Nm devices to split large buffers into smaller pieces when needed. .It kern.cam.sa.%d.allow_io_split .Pp This variable, when set to 1, will configure the given .Nm unit to split large buffers into multiple pieces. This will override the global setting, if it exists. .El .Pp There are several .Xr sysctl 8 variables available to view block handling parameters: .Bl -tag -width 12 .It kern.cam.sa.%d.allow_io_split .Pp This variable allows the user to see, but not modify, the current I/O split setting. The user is not permitted to modify this setting so that there is no chance of behavior changing for the application while a tape is mounted. .It kern.cam.sa.%d.maxio .Pp This variable shows the maximum I/O size in bytes that is allowed by the combination of kernel tuning parameters (MAXPHYS, DFLTPHYS) and the capabilities of the controller that is attached to the tape drive. Applications may look at this value for a guide on how large an I/O may be permitted, but should keep in mind that the actual maximum may be restricted further by the tape drive via the .Tn SCSI READ BLOCK LIMITS command. .It kern.cam.sa.%d.cpi_maxio .Pp This variable shows the maximum I/O size supported by the controller, in bytes, that is reported via the CAM Path Inquiry CCB (XPT_PATH_INQ). If this is 0, that means that the controller has not reported a maximum I/O size. .El .Sh FILE MARK HANDLING The handling of file marks on write is automatic. If the user has written to the tape, and has not done a read since the last write, then a file mark will be written to the tape when the device is closed. If a rewind is requested after a write, then the driver assumes that the last file on the tape has been written, and ensures that there are two file marks written to the tape. The exception to this is that there seems to be a standard (which we follow, but do not understand why) that certain types of tape do not actually write two file marks to tape, but when read, report a `phantom' file mark when the last file is read. These devices include the QIC family of devices. (It might be that this set of devices is the same set as that of fixed block devices. This has not been determined yet, and they are treated as separate behaviors by the driver at this time.) .Sh PARAMETERS The .Nm driver supports a number of parameters. The user can query parameters using .Dq mt param -l (which uses the .Dv MTIOCPARAMGET ioctl) and the user can set parameters using .Dq mt param -s (which uses the .Dv MTIOCPARAMSET ioctl). See .Xr mt 1 and .Xr mtio 4 for more details on the interface. .Pp Supported parameters: .Bl -tag -width 5n .It sili The default is 0. When set to 1, it sets the Suppress Incorrect Length Indicator (SILI) bit on tape reads. Tape drives normally return sense data (which contains the residual) when the application reads a block that is not the same length as the amount of data requested. The SILI bit suppresses that notification in most cases. See the SSC-5 spec (available at t10.org), specifically the section on the READ(6) command, for more information. .It eot_warn The default is 0. By default, the .Nm driver reports entering Programmable Early Warning, Early Warning and End of Media conditions by returning a write with 0 bytes written, and .Dv errno set to 0. If .Va eot_warn is set to 1, the .Nm driver will set .Dv errno to .Dv ENOSPC when it enters any of the out of space conditions. .It protection.protection_supported This is a read-only parameter, and is set to 1 if the tape drive supports protection information. .It protection.prot_method If protection is supported, set this to the desired protection method supported by the tape drive. As of SSC-5r03 (available at t10.org), the protection method values are: .Bl -tag -width 3n .It 0 No protection. .It 1 Reed-Solomon CRC, 4 bytes in length. .It 2 CRC32C, 4 bytes in length. .El .It protection.pi_length Length of the protection information, see above for lengths. .It protection.lbp_w If set to 1, enable logical block protection on writes. The CRC must be appended to the end of the block written to the tape driver. The tape drive will verify the CRC when it receives the block. .It protection.lbp_r If set to 1, enable logical block protection on reads. The CRC will be appended to the end of the block read from the tape driver. The application should verify the CRC when it receives the block. .It protection.rdbp If set to 1, enable logical block protection on the RECOVER BUFFERED DATA command. The .Nm driver does not currently use the RECOVER BUFFERED DATA command. .El .Sh TIMEOUTS The .Nm driver has a set of default timeouts for SCSI commands (READ, WRITE, TEST UNIT READY, etc.) that will likely work in most cases for many tape drives. .Pp For newer tape drives that claim to support the SPC-4 standard (SCSI Primary Commands 4) or later standards, the .Nm driver will attempt to use the REPORT SUPPORTED OPERATION CODES command to fetch timeout descriptors from the drive. If the drive does report timeout descriptors, the .Nm driver will use the drive's recommended timeouts for commands. .Pp The timeouts in use are reported in units of .Sy thousandths -of a second via the +of a second via the .Va kern.cam.sa.%d.timeout.* .Xr sysctl 8 variables. .Pp To override either the default timeouts, or the timeouts recommended by the drive, you can set one of two sets of loader tunable values. If you have a drive that supports the REPORT SUPPORTED OPERATION CODES timeout descriptors (see the .Xr camcontrol 8 .Va opcodes subcommand) it is generally best to use those values. The global .Va kern.cam.sa.timeout.* values will override the timeouts for all .Nm driver instances. If there are 5 tape drives in the system, they'll all get the same timeouts. The .Va kern.cam.sa.%d.timeout.* values (where %d is the numeric .Nm instance number) will override the global timeouts as well as either the default timeouts or the timeouts recommended by the drive. .Pp To set timeouts after boot, the per-instance timeout values, for example: .Va kern.cam.sa.0.timeout.read , are available as sysctl variables. .Pp If a tape drive arrives after boot, the global tunables or per-instance tunables that apply to the newly arrived drive will be used. .Pp Loader tunables: .Pp .Bl -tag -compact .It kern.cam.sa.timeout.erase .It kern.cam.sa.timeout.locate .It kern.cam.sa.timeout.mode_select .It kern.cam.sa.timeout.mode_sense .It kern.cam.sa.timeout.prevent .It kern.cam.sa.timeout.read .It kern.cam.sa.timeout.read_position .It kern.cam.sa.timeout.read_block_limits .It kern.cam.sa.timeout.report_density .It kern.cam.sa.timeout.reserve .It kern.cam.sa.timeout.rewind .It kern.cam.sa.timeout.space .It kern.cam.sa.timeout.tur .It kern.cam.sa.timeout.write .It kern.cam.sa.timeout.write_filemarks .El .Pp Loader tunable values and .Xr sysctl 8 values: .Pp .Bl -tag -compact .It kern.cam.sa.%d.timeout.erase .It kern.cam.sa.%d.timeout.locate .It kern.cam.sa.%d.timeout.mode_select .It kern.cam.sa.%d.timeout.mode_sense .It kern.cam.sa.%d.timeout.prevent .It kern.cam.sa.%d.timeout.read .It kern.cam.sa.%d.timeout.read_position .It kern.cam.sa.%d.timeout.read_block_limits .It kern.cam.sa.%d.timeout.report_density .It kern.cam.sa.%d.timeout.reserve .It kern.cam.sa.%d.timeout.rewind .It kern.cam.sa.%d.timeout.space .It kern.cam.sa.%d.timeout.tur .It kern.cam.sa.%d.timeout.write .It kern.cam.sa.%d.timeout.write_filemarks .El .Pp As mentioned above, the timeouts are set and reported in .Sy thousandths of a second, so be sure to account for that when setting them. .Sh IOCTLS The .Nm driver supports all of the ioctls of .Xr mtio 4 . .Sh FILES .Bl -tag -width /dev/[n][e]sa[0-9] -compact .It Pa /dev/[n][e]sa[0-9] general form: .It Pa /dev/sa0 Rewind on close .It Pa /dev/nsa0 No rewind on close .It Pa /dev/esa0 Eject on close (if capable) .It Pa /dev/sa0.ctl Control mode device (to examine state while another program is accessing the device, e.g.). .El .Sh DIAGNOSTICS The .Nm driver supports injecting End Of Media (EOM) notification to aid application development and testing. EOM is indicated to the application by returning the read or write with 0 bytes written. In addition, when EOM is injected, the tape position status will be updated to temporarily show Beyond of the Programmable Early Warning (BPEW) status. To see BPEW status, use the .Dv MTIOCEXTGET ioctl, which is used by the .Dq mt status command. To inject an EOM notification, set the .Pp .Va kern.cam.sa.%d.inject_eom .Pp sysctl variable to 1. One EOM notification will be sent, BPEW status will be set for one position query, and then the driver state will be reset to normal. .Sh SEE ALSO .Xr mt 1 , .Xr cam 4 .Sh AUTHORS .An -nosplit The .Nm driver was written for the .Tn CAM .Tn SCSI subsystem by .An Justin T. Gibbs and .An Kenneth Merry . Many ideas were gleaned from the .Nm st device driver written and ported from .Tn Mach 2.5 by .An Julian Elischer . .Pp The owner of record for many years was .An Matthew Jacob . The current maintainer is .An Kenneth Merry .Sh BUGS This driver lacks many of the hacks required to deal with older devices. Many older .Tn SCSI-1 devices may not work properly with this driver yet. .Pp Additionally, certain tapes (QIC tapes mostly) that were written under .Fx 2.X are not automatically read correctly with this driver: you may need to explicitly set variable block mode or set to the blocksize that works best for your device in order to read tapes written under .Fx 2.X. .Pp Partitions are only supported for status information and location. It would be nice to add support for creating and editing tape partitions. diff --git a/share/man/man4/vmm.4 b/share/man/man4/vmm.4 index 9a39cec665da..5f2ebcd8c9c0 100644 --- a/share/man/man4/vmm.4 +++ b/share/man/man4/vmm.4 @@ -1,104 +1,102 @@ .\" Copyright (c) 2013 Peter Grehan .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" $FreeBSD$ .\" .Dd December 19, 2013 .Dt VMM 4 .Os .Sh NAME .Nm vmm.ko .Nd "bhyve virtual machine monitor" .Sh SYNOPSIS To load the driver as a module at boot, add this line to .Xr loader.conf 5 : .Bd -literal -offset indent .Cd vmm_load="YES" .Ed .Pp The module can also be loaded manually with .Xr kldload 8 : .Bd -literal -offset indent kldload vmm .Ed .Sh DESCRIPTION .Nm provides the kernel portion of the .Xr bhyve 4 hypervisor. .Pp An Intel CPU with VT-x/EPT or AMD CPU with SVM support is required. .Pp PCI device passthrough to a virtual machine requires hardware with VT-d support. .Sh PCI PASSTHROUGH When the hardware supports VT-d, and .Nm has been loaded at boot time, PCI devices can be reserved for use by the hypervisor. Entries consisting of the PCI .Ar bus Ns / Ns Ar slot Ns / Ns Ar function are added to the .Va pptdevs .Xr loader.conf 5 variable. Additional entries are separated by spaces. Host PCI devices that match an entry will be assigned to the hypervisor and will not be probed by .Fx device drivers. See the .Sx EXAMPLES section below for sample usage. .Pp A large number of PCI device entries may require a string longer than the 128-character limit of .Xr loader.conf 5 variables. The .Va pptdevs2 and .Va pptdevs3 variables can be used for additional entries. .Sh EXAMPLES Reserve three PCI devices for use by the hypervisor: bus 10 slot 0 function 0, bus 6 slot 5 function 0, and bus 6 slot 5 function 1. .Bd -literal -offset indent pptdevs="10/0/0 6/5/0 6/5/1" .Ed .Sh SEE ALSO .Xr bhyve 4 , .Xr loader.conf 5 , .Xr bhyve 8 , .Xr bhyveload 8 , .Xr kldload 8 .Sh HISTORY .Nm vmm.ko first appeared in .Fx 10.0 . .Sh AUTHORS .An Neel Natu Aq neel@freebsd.org .An Peter Grehan Aq grehan@freebsd.org - -