summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/sg.4 4.html
blob: f672cfe264348480f43308552035ff14b6591296 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<table class="head">
  <tr>
    <td class="head-ltitle">SG(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">SG(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">sg</code> &#x2014; <span class="Nd">Linux
    ioctl-compatible SCSI passthru device</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device sg</code>
  <br/>
  <code class="Cd">device scbus</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">sg</code> driver provides a Linux compatible
    scsi passthru device. This driver attaches to all <a class="Xr">cam(4)</a>
    peripheral devices. It is similar to the <a class="Xr">pass(4)</a> device,
    but uses the Linux interfaces, rather than the FreeBSD CAM interfaces.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IOCTL"><a class="permalink" href="#IOCTL">IOCTL</a></h1>
<p class="Pp">The following subset of the Linux sg ioctl interfaces are
    implemented:</p>
<dl class="Bl-tag">
  <dt id="SG_SET_TIMEOUT"><var class="Va">SG_SET_TIMEOUT</var></dt>
  <dd><var class="Fa">u_int to</var> Set the timeout in milliseconds.</dd>
  <dt id="SG_GET_TIMEOUT"><var class="Va">SG_GET_TIMEOUT</var></dt>
  <dd>Get the timeout in milliseconds</dd>
  <dt id="SG_GET_RESERVED_SIZE"><var class="Va">SG_GET_RESERVED_SIZE</var></dt>
  <dd><var class="Fa">u_int</var> Returns the size of the I/O one can do this
      device.</dd>
  <dt id="SG_GET_SCSI_ID"><var class="Va">SG_GET_SCSI_ID</var></dt>
  <dd><var class="Fa">struct sg_scsi_id</var> Returns the bus number, channel,
      scsi bus ID number, lun and other information about the SCSI device.</dd>
  <dt id="SG_GET_SG_TABLESIZE"><var class="Va">SG_GET_SG_TABLESIZE</var></dt>
  <dd><var class="Fa">u_int</var> Returns the table size, though hard wired to
      0.</dd>
  <dt id="SG_GET_VERSION_NUM"><var class="Va">SG_GET_VERSION_NUM</var></dt>
  <dd><var class="Fa">u_int</var> Return the version number that is
    implemented.</dd>
  <dt id="SG_IO"><var class="Va">SG_IO</var></dt>
  <dd><var class="Fa">struct sg_io_hdr</var></dd>
</dl>
All other ioctl interfaces return <var class="Va">ENODEV</var>.
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
  <dt><span class="Pa">/dev/sg*</span></dt>
  <dd>Passthru devices.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">cam(4)</a>, <a class="Xr">pass(4)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">sg</code> driver first appeared in
    <span class="Ux">FreeBSD 7.0</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 6, 2024</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>