Kconfig 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. # SPDX-License-Identifier: GPL-2.0-only
  2. #
  3. # Microsoft Surface Platform-Specific Drivers
  4. #
  5. menuconfig SURFACE_PLATFORMS
  6. bool "Microsoft Surface Platform-Specific Device Drivers"
  7. depends on ARM64 || X86 || COMPILE_TEST
  8. default y
  9. help
  10. Say Y here to get to see options for platform-specific device drivers
  11. for Microsoft Surface devices. This option alone does not add any
  12. kernel code.
  13. If you say N, all options in this submenu will be skipped and disabled.
  14. if SURFACE_PLATFORMS
  15. config SURFACE3_WMI
  16. tristate "Surface 3 WMI Driver"
  17. depends on ACPI_WMI
  18. depends on DMI
  19. depends on INPUT
  20. depends on SPI
  21. help
  22. Say Y here if you have a Surface 3.
  23. To compile this driver as a module, choose M here: the module will
  24. be called surface3-wmi.
  25. config SURFACE_3_POWER_OPREGION
  26. tristate "Surface 3 battery platform operation region support"
  27. depends on ACPI
  28. depends on I2C
  29. help
  30. This driver provides support for ACPI operation
  31. region of the Surface 3 battery platform driver.
  32. config SURFACE_ACPI_NOTIFY
  33. tristate "Surface ACPI Notify Driver"
  34. depends on SURFACE_AGGREGATOR
  35. help
  36. Surface ACPI Notify (SAN) driver for Microsoft Surface devices.
  37. This driver provides support for the ACPI interface (called SAN) of
  38. the Surface System Aggregator Module (SSAM) EC. This interface is used
  39. on 5th- and 6th-generation Microsoft Surface devices (including
  40. Surface Pro 5 and 6, Surface Book 2, Surface Laptops 1 and 2, and in
  41. reduced functionality on the Surface Laptop 3) to execute SSAM
  42. requests directly from ACPI code, as well as receive SSAM events and
  43. turn them into ACPI notifications. It essentially acts as a
  44. translation layer between the SSAM controller and ACPI.
  45. Specifically, this driver may be needed for battery status reporting,
  46. thermal sensor access, and real-time clock information, depending on
  47. the Surface device in question.
  48. config SURFACE_AGGREGATOR_CDEV
  49. tristate "Surface System Aggregator Module User-Space Interface"
  50. depends on SURFACE_AGGREGATOR
  51. help
  52. Provides a misc-device interface to the Surface System Aggregator
  53. Module (SSAM) controller.
  54. This option provides a module (called surface_aggregator_cdev), that,
  55. when loaded, will add a client device (and its respective driver) to
  56. the SSAM controller. Said client device manages a misc-device
  57. interface (/dev/surface/aggregator), which can be used by user-space
  58. tools to directly communicate with the SSAM EC by sending requests and
  59. receiving the corresponding responses.
  60. The provided interface is intended for debugging and development only,
  61. and should not be used otherwise.
  62. config SURFACE_AGGREGATOR_HUB
  63. tristate "Surface System Aggregator Module Subsystem Device Hubs"
  64. depends on SURFACE_AGGREGATOR
  65. depends on SURFACE_AGGREGATOR_BUS
  66. help
  67. Device-hub drivers for Surface System Aggregator Module (SSAM) subsystem
  68. devices.
  69. Provides subsystem hub drivers which manage client devices on various
  70. SSAM subsystems. In some subsystems, notably the BAS subsystem managing
  71. devices contained in the base of the Surface Book 3 and the KIP subsystem
  72. managing type-cover devices in the Surface Pro 8 and Surface Pro X,
  73. devices can be (hot-)removed. Hub devices and drivers are required to
  74. manage these subdevices.
  75. Devices managed via these hubs are:
  76. - Battery/AC devices (Surface Book 3).
  77. - HID input devices (7th-generation and later models with detachable
  78. input devices).
  79. Select M (recommended) or Y here if you want support for the above
  80. mentioned devices on the corresponding Surface models. Without this
  81. module, the respective devices mentioned above will not be instantiated
  82. and thus any functionality provided by them will be missing, even when
  83. drivers for these devices are present. This module only provides the
  84. respective subsystem hubs. Both drivers and device specification (e.g.
  85. via the Surface Aggregator Registry) for these devices still need to be
  86. selected via other options.
  87. config SURFACE_AGGREGATOR_REGISTRY
  88. tristate "Surface System Aggregator Module Device Registry"
  89. depends on SURFACE_AGGREGATOR
  90. depends on SURFACE_AGGREGATOR_BUS
  91. help
  92. Device-registry for Surface System Aggregator Module (SSAM) devices.
  93. Provides a module and driver which act as a device-registry for SSAM
  94. client devices that cannot be detected automatically, e.g. via ACPI.
  95. Such devices are instead provided and managed via this registry.
  96. Devices provided via this registry are:
  97. - Platform profile (performance-/cooling-mode) device (5th- and later
  98. generations).
  99. - Battery/AC devices (7th-generation).
  100. - HID input devices (7th-generation).
  101. Select M (recommended) or Y here if you want support for the above
  102. mentioned devices on the corresponding Surface models. Without this
  103. module, the respective devices will not be instantiated and thus any
  104. functionality provided by them will be missing, even when drivers for
  105. these devices are present. In other words, this module only provides
  106. the respective client devices. Drivers for these devices still need to
  107. be selected via the other options.
  108. config SURFACE_AGGREGATOR_TABLET_SWITCH
  109. tristate "Surface Aggregator Generic Tablet-Mode Switch Driver"
  110. depends on SURFACE_AGGREGATOR
  111. depends on SURFACE_AGGREGATOR_BUS
  112. depends on INPUT
  113. help
  114. Provides a tablet-mode switch input device on Microsoft Surface models
  115. using the KIP subsystem for detachable keyboards (e.g. keyboard covers)
  116. or the POS subsystem for device/screen posture changes.
  117. The KIP subsystem is used on newer Surface generations to handle
  118. detachable input peripherals, specifically the keyboard cover (containing
  119. keyboard and touchpad) on the Surface Pro 8 and Surface Pro X. The POS
  120. subsystem is used for device posture change notifications on the Surface
  121. Laptop Studio. This module provides a driver to let user-space know when
  122. the device should be considered in tablet-mode due to the keyboard cover
  123. being detached or folded back (essentially signaling when the keyboard is
  124. not available for input). It does so by creating a tablet-mode switch
  125. input device, sending the standard SW_TABLET_MODE event on mode change.
  126. Select M or Y here, if you want to provide tablet-mode switch input
  127. events on the Surface Pro 8, Surface Pro X, and Surface Laptop Studio.
  128. config SURFACE_DTX
  129. tristate "Surface DTX (Detachment System) Driver"
  130. depends on SURFACE_AGGREGATOR
  131. depends on INPUT
  132. help
  133. Driver for the Surface Book clipboard detachment system (DTX).
  134. On the Surface Book series devices, the display part containing the
  135. CPU (called the clipboard) can be detached from the base (containing a
  136. battery, the keyboard, and, optionally, a discrete GPU) by (if
  137. necessary) unlocking and opening the latch connecting both parts.
  138. This driver provides a user-space interface that can influence the
  139. behavior of this process, which includes the option to abort it in
  140. case the base is still in use or speed it up in case it is not.
  141. Note that this module can be built without support for the Surface
  142. Aggregator Bus (i.e. CONFIG_SURFACE_AGGREGATOR_BUS=n). In that case,
  143. some devices, specifically the Surface Book 3, will not be supported.
  144. config SURFACE_GPE
  145. tristate "Surface GPE/Lid Support Driver"
  146. depends on ACPI
  147. depends on DMI
  148. help
  149. This driver marks the GPEs related to the ACPI lid device found on
  150. Microsoft Surface devices as wakeup sources and prepares them
  151. accordingly. It is required on those devices to allow wake-ups from
  152. suspend by opening the lid.
  153. config SURFACE_HOTPLUG
  154. tristate "Surface Hot-Plug Driver"
  155. depends on ACPI
  156. depends on GPIOLIB
  157. help
  158. Driver for out-of-band hot-plug event signaling on Microsoft Surface
  159. devices with hot-pluggable PCIe cards.
  160. This driver is used on Surface Book (2 and 3) devices with a
  161. hot-pluggable discrete GPU (dGPU). When not in use, the dGPU on those
  162. devices can enter D3cold, which prevents in-band (standard) PCIe
  163. hot-plug signaling. Thus, without this driver, detaching the base
  164. containing the dGPU will not correctly update the state of the
  165. corresponding PCIe device if it is in D3cold. This driver adds support
  166. for out-of-band hot-plug notifications, ensuring that the device state
  167. is properly updated even when the device in question is in D3cold.
  168. Select M or Y here, if you want to (fully) support hot-plugging of
  169. dGPU devices on the Surface Book 2 and/or 3 during D3cold.
  170. config SURFACE_PLATFORM_PROFILE
  171. tristate "Surface Platform Profile Driver"
  172. depends on ACPI
  173. depends on SURFACE_AGGREGATOR_REGISTRY
  174. select ACPI_PLATFORM_PROFILE
  175. help
  176. Provides support for the ACPI platform profile on 5th- and later
  177. generation Microsoft Surface devices.
  178. More specifically, this driver provides ACPI platform profile support
  179. on Microsoft Surface devices with a Surface System Aggregator Module
  180. (SSAM) connected via the Surface Serial Hub (SSH / SAM-over-SSH). In
  181. other words, this driver provides platform profile support on the
  182. Surface Pro 5, Surface Book 2, Surface Laptop, Surface Laptop Go and
  183. later. On those devices, the platform profile can significantly
  184. influence cooling behavior, e.g. setting it to 'quiet' (default) or
  185. 'low-power' can significantly limit performance of the discrete GPU on
  186. Surface Books, while in turn leading to lower power consumption and/or
  187. less fan noise.
  188. Select M or Y here, if you want to include ACPI platform profile
  189. support on the above mentioned devices.
  190. config SURFACE_PRO3_BUTTON
  191. tristate "Power/home/volume buttons driver for Microsoft Surface Pro 3/4 tablet"
  192. depends on ACPI
  193. depends on INPUT
  194. help
  195. This driver handles the power/home/volume buttons on the Microsoft Surface Pro 3/4 tablet.
  196. source "drivers/platform/surface/aggregator/Kconfig"
  197. endif # SURFACE_PLATFORMS