summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/atopcase.4 4.html
blob: 12b5d03b09e1afc4ad36937f1309843365c62b19 (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<table class="head">
  <tr>
    <td class="head-ltitle">ATOPCASE(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">ATOPCASE(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">atopcase</code> &#x2014; <span class="Nd">Apple
    HID-over-SPI transport driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device atopcase</code>
<br/>
<code class="Cd">device intelspi</code>
<br/>
<code class="Cd">device spibus</code>
<br/>
<code class="Cd">device hidbus</code>
<br/>
<code class="Cd">device hkbd</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>atopcase_load=&quot;YES&quot;
hkbd_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">atopcase</code> driver provides support for
    Human Interface Devices (HID) on Serial Peripheral Interface (SPI) buses on
    Apple Intel Macs.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">atopcase</code> driver supports the following
    MacBooks produced in 2015-2018 years:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Macbook8,1</li>
  <li>Macbook9,1</li>
  <li>Macbook10,1</li>
  <li>MacbookPro11,4</li>
  <li>MacbookPro12,1</li>
  <li>MacbookPro13,1</li>
  <li>MacbookPro13,2</li>
  <li>MacbookPro13,3</li>
  <li>MacbookPro14,1</li>
  <li>MacbookPro14,2</li>
  <li>MacbookPro14,3</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
  VARIABLES</a></h1>
<p class="Pp">The following variables are available as both
    <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a>
    tunables:</p>
<dl class="Bl-tag">
  <dt id="hw.hid.atopcase.debug"><var class="Va">hw.hid.atopcase.debug</var></dt>
  <dd>Debug output level, where 0 is debugging disabled and larger values
      increase debug message verbosity. Default is 0.</dd>
</dl>
</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/backlight/atopcase0</span></dt>
  <dd>Keyboard <a class="Xr">backlight(8)</a> device node.</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">acpi(4)</a>, <a class="Xr">loader.conf(5)</a>,
    <a class="Xr">backlight(8)</a>, <a class="Xr">loader(8)</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">atopcase</code> driver first appeared in
    <span class="Ux">FreeBSD 14.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">atopcase</code> driver was originally written
    by <span class="An">Val Packett</span>
    &lt;<a class="Mt" href="mailto:val@packett.cool">val@packett.cool</a>&gt;
    and marginally improved upon by <span class="An">Vladimir Kondratyev</span>
    &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;.</p>
<p class="Pp">This manual page was written by <span class="An">Vladimir
    Kondratyev</span>
    &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp">Device interrupts are not acknowledged on some hardware that
    results in interrupt storm. Installation of Darwin OSI in
    <a class="Xr">acpi(4)</a> driver fixes the issue. To install Darwin OSI add
    following lines to <a class="Xr">loader.conf(5)</a>:</p>
<dl class="Bl-tag">
  <dt id="hw.acpi.install_interface=_Darwin_"><var class="Va">hw.acpi.install_interface=&quot;Darwin&quot;</var></dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt id="hw.acpi.remove_interface=_Windows"><var class="Va">hw.acpi.remove_interface=&quot;Windows
    2009, Windows 2012&quot;</var></dt>
  <dd style="width: auto;">&#x00A0;</dd>
</dl>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">August 17, 2023</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>