€•      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ%/translations/zh_CN/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/zh_TW/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/it_IT/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/ja_JP/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/ko_KR/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/pt_BR/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ%/translations/sp_SP/hid/intel-ish-hid”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ!Intel Integrated Sensor Hub (ISH)”h]”hŒ!Intel Integrated Sensor Hub (ISH)”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³Œ?/var/lib/git/docbuild/linux/Documentation/hid/intel-ish-hid.rst”h´KubhŒ	paragraph”“”)”}”(hŒåA sensor hub enables the ability to offload sensor polling and algorithm
processing to a dedicated low power co-processor. This allows the core
processor to go into low power modes more often, resulting in increased
battery life.”h]”hŒåA sensor hub enables the ability to offload sensor polling and algorithm
processing to a dedicated low power co-processor. This allows the core
processor to go into low power modes more often, resulting in increased
battery life.”…””}”(hhÍh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hŒÙThere are many vendors providing external sensor hubs conforming to HID
Sensor usage tables. These may be found in tablets, 2-in-1 convertible laptops
and embedded products. Linux has had this support since Linux 3.9.”h]”hŒÙThere are many vendors providing external sensor hubs conforming to HID
Sensor usage tables. These may be found in tablets, 2-in-1 convertible laptops
and embedded products. Linux has had this support since Linux 3.9.”…””}”(hhÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K
hh·h²hubhÌ)”}”(hXÉ  IntelÂ® introduced integrated sensor hubs as a part of the SoC starting from
Cherry Trail and now supported on multiple generations of CPU packages. There
are many commercial devices already shipped with Integrated Sensor Hubs (ISH).
These ISH also comply to HID sensor specification, but the difference is the
transport protocol used for communication. The current external sensor hubs
mainly use HID over I2C or USB. But ISH doesn't use either I2C or USB.”h]”hXË  IntelÂ® introduced integrated sensor hubs as a part of the SoC starting from
Cherry Trail and now supported on multiple generations of CPU packages. There
are many commercial devices already shipped with Integrated Sensor Hubs (ISH).
These ISH also comply to HID sensor specification, but the difference is the
transport protocol used for communication. The current external sensor hubs
mainly use HID over I2C or USB. But ISH doesnâ€™t use either I2C or USB.”…””}”(hhéh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒOverview”h]”hŒOverview”…””}”(hhúh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh÷h²hh³hÊh´KubhÌ)”}”(hŒsUsing a analogy with a usbhid implementation, the ISH follows a similar model
for a very high speed communication::”h]”hŒrUsing a analogy with a usbhid implementation, the ISH follows a similar model
for a very high speed communication:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh÷h²hubhŒliteral_block”“”)”}”(hXs  -----------------               ----------------------
|    USB HID    |       -->     |    ISH HID         |
-----------------               ----------------------
-----------------               ----------------------
|  USB protocol |       -->     |    ISH Transport   |
-----------------               ----------------------
-----------------               ----------------------
|  EHCI/XHCI    |       -->     |    ISH IPC         |
-----------------               ----------------------
      PCI                                PCI
-----------------               ----------------------
|Host controller|       -->     |    ISH processor   |
-----------------               ----------------------
     USB Link
-----------------               ----------------------
| USB End points|       -->     |    ISH Clients     |
-----------------               ----------------------”h]”hXs  -----------------               ----------------------
|    USB HID    |       -->     |    ISH HID         |
-----------------               ----------------------
-----------------               ----------------------
|  USB protocol |       -->     |    ISH Transport   |
-----------------               ----------------------
-----------------               ----------------------
|  EHCI/XHCI    |       -->     |    ISH IPC         |
-----------------               ----------------------
      PCI                                PCI
-----------------               ----------------------
|Host controller|       -->     |    ISH processor   |
-----------------               ----------------------
     USB Link
-----------------               ----------------------
| USB End points|       -->     |    ISH Clients     |
-----------------               ----------------------”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j  h³hÊh´Khh÷h²hubhÌ)”}”(hX	  Like USB protocol provides a method for device enumeration, link management
and user data encapsulation, the ISH also provides similar services. But it is
very light weight tailored to manage and communicate with ISH client
applications implemented in the firmware.”h]”hX	  Like USB protocol provides a method for device enumeration, link management
and user data encapsulation, the ISH also provides similar services. But it is
very light weight tailored to manage and communicate with ISH client
applications implemented in the firmware.”…””}”(hj(  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K-hh÷h²hubhÌ)”}”(hXF  The ISH allows multiple sensor management applications executing in the
firmware. Like USB endpoints the messaging can be to/from a client. As part of
enumeration process, these clients are identified. These clients can be simple
HID sensor applications, sensor calibration applications or sensor firmware
update applications.”h]”hXF  The ISH allows multiple sensor management applications executing in the
firmware. Like USB endpoints the messaging can be to/from a client. As part of
enumeration process, these clients are identified. These clients can be simple
HID sensor applications, sensor calibration applications or sensor firmware
update applications.”…””}”(hj6  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K2hh÷h²hubhÌ)”}”(hX-  The implementation model is similar, like USB bus, ISH transport is also
implemented as a bus. Each client application executing in the ISH processor
is registered as a device on this bus. The driver, which binds each device
(ISH HID driver) identifies the device type and registers with the HID core.”h]”hX-  The implementation model is similar, like USB bus, ISH transport is also
implemented as a bus. Each client application executing in the ISH processor
is registered as a device on this bus. The driver, which binds each device
(ISH HID driver) identifies the device type and registers with the HID core.”…””}”(hjD  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K8hh÷h²hubeh}”(h]”Œoverview”ah ]”h"]”Œoverview”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒ!ISH Implementation: Block Diagram”h]”hŒ!ISH Implementation: Block Diagram”…””}”(hj]  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjZ  h²hh³hÊh´K>ubj  )”}”(hX         ---------------------------
      |  User Space Applications  |
       ---------------------------

----------------IIO ABI----------------
       --------------------------
      |  IIO Sensor Drivers     |
       --------------------------
       --------------------------
      |        IIO core         |
       --------------------------
       --------------------------
      |   HID Sensor Hub MFD    |
       --------------------------
       --------------------------
      |       HID Core          |
       --------------------------
       --------------------------
      |   HID over ISH Client   |
       --------------------------
       --------------------------
      |   ISH Transport (ISHTP) |
       --------------------------
       --------------------------
      |      IPC Drivers        |
       --------------------------
OS
---------------- PCI -----------------
Hardware + Firmware
       ----------------------------
      | ISH Hardware/Firmware(FW) |
       ----------------------------”h]”hX         ---------------------------
      |  User Space Applications  |
       ---------------------------

----------------IIO ABI----------------
       --------------------------
      |  IIO Sensor Drivers     |
       --------------------------
       --------------------------
      |        IIO core         |
       --------------------------
       --------------------------
      |   HID Sensor Hub MFD    |
       --------------------------
       --------------------------
      |       HID Core          |
       --------------------------
       --------------------------
      |   HID over ISH Client   |
       --------------------------
       --------------------------
      |   ISH Transport (ISHTP) |
       --------------------------
       --------------------------
      |      IPC Drivers        |
       --------------------------
OS
---------------- PCI -----------------
Hardware + Firmware
       ----------------------------
      | ISH Hardware/Firmware(FW) |
       ----------------------------”…””}”hjk  sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´KBhjZ  h²hubeh}”(h]”Œ ish-implementation-block-diagram”ah ]”h"]”Œ!ish implementation: block diagram”ah$]”h&]”uh1hµhh·h²hh³hÊh´K>ubh¶)”}”(hhh]”(h»)”}”(hŒ%High level processing in above blocks”h]”hŒ%High level processing in above blocks”…””}”(hj„  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´Kdubh¶)”}”(hhh]”(h»)”}”(hŒHardware Interface”h]”hŒHardware Interface”…””}”(hj•  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj’  h²hh³hÊh´KgubhÌ)”}”(hŒôThe ISH is exposed as "Non-VGA unclassified PCI device" to the host. The PCI
product and vendor IDs are changed from different generations of processors. So
the source code which enumerates drivers needs to update from generation to
generation.”h]”hŒøThe ISH is exposed as â€œNon-VGA unclassified PCI deviceâ€ to the host. The PCI
product and vendor IDs are changed from different generations of processors. So
the source code which enumerates drivers needs to update from generation to
generation.”…””}”(hj£  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kihj’  h²hubeh}”(h]”Œhardware-interface”ah ]”h"]”Œhardware interface”ah$]”h&]”uh1hµhj  h²hh³hÊh´Kgubh¶)”}”(hhh]”(h»)”}”(hŒ*Inter Processor Communication (IPC) driver”h]”hŒ*Inter Processor Communication (IPC) driver”…””}”(hj¼  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj¹  h²hh³hÊh´KoubhÌ)”}”(hŒ'Location: drivers/hid/intel-ish-hid/ipc”h]”hŒ'Location: drivers/hid/intel-ish-hid/ipc”…””}”(hjÊ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kqhj¹  h²hubhÌ)”}”(hŒSThe IPC message uses memory mapped I/O. The registers are defined in
hw-ish-regs.h.”h]”hŒSThe IPC message uses memory mapped I/O. The registers are defined in
hw-ish-regs.h.”…””}”(hjØ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kshj¹  h²hubh¶)”}”(hhh]”(h»)”}”(hŒIPC/FW message types”h]”hŒIPC/FW message types”…””}”(hjé  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjæ  h²hh³hÊh´KwubhÌ)”}”(hŒrThere are two types of messages, one for management of link and another for
messages to and from transport layers.”h]”hŒrThere are two types of messages, one for management of link and another for
messages to and from transport layers.”…””}”(hj÷  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kyhjæ  h²hubh¶)”}”(hhh]”(h»)”}”(hŒTX and RX of Transport messages”h]”hŒTX and RX of Transport messages”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´K}ubhÌ)”}”(hX   A set of memory mapped register offers support of multi-byte messages TX and
RX (e.g. IPC_REG_ISH2HOST_MSG, IPC_REG_HOST2ISH_MSG). The IPC layer maintains
internal queues to sequence messages and send them in order to the firmware.
Optionally the caller can register handler to get notification of completion.
A doorbell mechanism is used in messaging to trigger processing in host and
client firmware side. When ISH interrupt handler is called, the ISH2HOST
doorbell register is used by host drivers to determine that the interrupt
is for ISH.”h]”hX   A set of memory mapped register offers support of multi-byte messages TX and
RX (e.g. IPC_REG_ISH2HOST_MSG, IPC_REG_HOST2ISH_MSG). The IPC layer maintains
internal queues to sequence messages and send them in order to the firmware.
Optionally the caller can register handler to get notification of completion.
A doorbell mechanism is used in messaging to trigger processing in host and
client firmware side. When ISH interrupt handler is called, the ISH2HOST
doorbell register is used by host drivers to determine that the interrupt
is for ISH.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khj  h²hubhÌ)”}”(hŒmEach side has 32 32-bit message registers and a 32-bit doorbell. Doorbell
register has the following format::”h]”hŒlEach side has 32 32-bit message registers and a 32-bit doorbell. Doorbell
register has the following format:”…””}”(hj$  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kˆhj  h²hubj  )”}”(hŒõBits 0..6: fragment length (7 bits are used)
Bits 10..13: encapsulated protocol
Bits 16..19: management command (for IPC management protocol)
Bit 31: doorbell trigger (signal H/W interrupt to the other side)
Other bits are reserved, should be 0.”h]”hŒõBits 0..6: fragment length (7 bits are used)
Bits 10..13: encapsulated protocol
Bits 16..19: management command (for IPC management protocol)
Bit 31: doorbell trigger (signal H/W interrupt to the other side)
Other bits are reserved, should be 0.”…””}”hj2  sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´K‹hj  h²hubeh}”(h]”Œtx-and-rx-of-transport-messages”ah ]”h"]”Œtx and rx of transport messages”ah$]”h&]”uh1hµhjæ  h²hh³hÊh´K}ubeh}”(h]”Œipc-fw-message-types”ah ]”h"]”Œipc/fw message types”ah$]”h&]”uh1hµhj¹  h²hh³hÊh´Kwubh¶)”}”(hhh]”(h»)”}”(hŒTransport layer interface”h]”hŒTransport layer interface”…””}”(hjS  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjP  h²hh³hÊh´K’ubhÌ)”}”(hŒ±To abstract HW level IPC communication, a set of callbacks is registered.
The transport layer uses them to send and receive messages.
Refer to struct ishtp_hw_ops for callbacks.”h]”hŒ±To abstract HW level IPC communication, a set of callbacks is registered.
The transport layer uses them to send and receive messages.
Refer to struct ishtp_hw_ops for callbacks.”…””}”(hja  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K”hjP  h²hubeh}”(h]”Œtransport-layer-interface”ah ]”h"]”Œtransport layer interface”ah$]”h&]”uh1hµhj¹  h²hh³hÊh´K’ubeh}”(h]”Œ(inter-processor-communication-ipc-driver”ah ]”h"]”Œ*inter processor communication (ipc) driver”ah$]”h&]”uh1hµhj  h²hh³hÊh´Koubh¶)”}”(hhh]”(h»)”}”(hŒISH Transport layer”h]”hŒISH Transport layer”…””}”(hj‚  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´K™ubhÌ)”}”(hŒ*Location: drivers/hid/intel-ish-hid/ishtp/”h]”hŒ*Location: drivers/hid/intel-ish-hid/ishtp/”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K›hj  h²hubh¶)”}”(hhh]”(h»)”}”(hŒA Generic Transport Layer”h]”hŒA Generic Transport Layer”…””}”(hj¡  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjž  h²hh³hÊh´KžubhÌ)”}”(hŒÚThe transport layer is a bi-directional protocol, which defines:
- Set of commands to start, stop, connect, disconnect and flow control
(see ishtp/hbm.h for details)
- A flow control mechanism to avoid buffer overflows”h]”hŒÚThe transport layer is a bi-directional protocol, which defines:
- Set of commands to start, stop, connect, disconnect and flow control
(see ishtp/hbm.h for details)
- A flow control mechanism to avoid buffer overflows”…””}”(hj¯  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K hjž  h²hubhÌ)”}”(hŒÓThis protocol resembles bus messages described in the following document:
http://www.intel.com/content/dam/www/public/us/en/documents/technical-specifications/dcmi-hi-1-0-spec.pdf
"Chapter 7: Bus Message Layer".”h]”(hŒJThis protocol resembles bus messages described in the following document:
”…””}”(hj½  h²hh³Nh´NubhŒ	reference”“”)”}”(hŒihttp://www.intel.com/content/dam/www/public/us/en/documents/technical-specifications/dcmi-hi-1-0-spec.pdf”h]”hŒihttp://www.intel.com/content/dam/www/public/us/en/documents/technical-specifications/dcmi-hi-1-0-spec.pdf”…””}”(hjÇ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”jÉ  uh1jÅ  hj½  ubhŒ$
â€œChapter 7: Bus Message Layerâ€.”…””}”(hj½  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¥hjž  h²hubeh}”(h]”Œa-generic-transport-layer”ah ]”h"]”Œa generic transport layer”ah$]”h&]”uh1hµhj  h²hh³hÊh´Kžubh¶)”}”(hhh]”(h»)”}”(hŒ%Connection and Flow Control Mechanism”h]”hŒ%Connection and Flow Control Mechanism”…””}”(hjë  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjè  h²hh³hÊh´KªubhÌ)”}”(hX  Each FW client and a protocol is identified by a UUID. In order to communicate
to a FW client, a connection must be established using connect request and
response bus messages. If successful, a pair (host_client_id and fw_client_id)
will identify the connection.”h]”hX  Each FW client and a protocol is identified by a UUID. In order to communicate
to a FW client, a connection must be established using connect request and
response bus messages. If successful, a pair (host_client_id and fw_client_id)
will identify the connection.”…””}”(hjù  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¬hjè  h²hubhÌ)”}”(hX›  Once connection is established, peers send each other flow control bus messages
independently. Every peer may send a message only if it has received a
flow-control credit before. Once it has sent a message, it may not send another one
before receiving the next flow control credit.
Either side can send disconnect request bus message to end communication. Also
the link will be dropped if major FW reset occurs.”h]”hX›  Once connection is established, peers send each other flow control bus messages
independently. Every peer may send a message only if it has received a
flow-control credit before. Once it has sent a message, it may not send another one
before receiving the next flow control credit.
Either side can send disconnect request bus message to end communication. Also
the link will be dropped if major FW reset occurs.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K±hjè  h²hubeh}”(h]”Œ%connection-and-flow-control-mechanism”ah ]”h"]”Œ%connection and flow control mechanism”ah$]”h&]”uh1hµhj  h²hh³hÊh´Kªubh¶)”}”(hhh]”(h»)”}”(hŒPeer to Peer data transfer”h]”hŒPeer to Peer data transfer”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´K¹ubhÌ)”}”(hŒ¼Peer to Peer data transfer can happen with or without using DMA. Depending on
the sensor bandwidth requirement DMA can be enabled by using module parameter
ishtp_use_dma under intel_ishtp.”h]”hŒ¼Peer to Peer data transfer can happen with or without using DMA. Depending on
the sensor bandwidth requirement DMA can be enabled by using module parameter
ishtp_use_dma under intel_ishtp.”…””}”(hj.  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K»hj  h²hubhÌ)”}”(hX  Each side (host and FW) manages its DMA transfer memory independently. When an
ISHTP client from either host or FW side wants to send something, it decides
whether to send over IPC or over DMA; for each transfer the decision is
independent. The sending side sends DMA_XFER message when the message is in
the respective host buffer (TX when host client sends, RX when FW client
sends). The recipient of DMA message responds with DMA_XFER_ACK, indicating
the sender that the memory region for that message may be reused.”h]”hX  Each side (host and FW) manages its DMA transfer memory independently. When an
ISHTP client from either host or FW side wants to send something, it decides
whether to send over IPC or over DMA; for each transfer the decision is
independent. The sending side sends DMA_XFER message when the message is in
the respective host buffer (TX when host client sends, RX when FW client
sends). The recipient of DMA message responds with DMA_XFER_ACK, indicating
the sender that the memory region for that message may be reused.”…””}”(hj<  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K¿hj  h²hubhÌ)”}”(hXÀ  DMA initialization is started with host sending DMA_ALLOC_NOTIFY bus message
(that includes RX buffer) and FW responds with DMA_ALLOC_NOTIFY_ACK.
Additionally to DMA address communication, this sequence checks capabilities:
if the host doesn't support DMA, then it won't send DMA allocation, so FW can't
send DMA; if FW doesn't support DMA then it won't respond with
DMA_ALLOC_NOTIFY_ACK, in which case host will not use DMA transfers.
Here ISH acts as busmaster DMA controller. Hence when host sends DMA_XFER,
it's request to do host->ISH DMA transfer; when FW sends DMA_XFER, it means
that it already did DMA and the message resides at host. Thus, DMA_XFER
and DMA_XFER_ACK act as ownership indicators.”h]”hXÌ  DMA initialization is started with host sending DMA_ALLOC_NOTIFY bus message
(that includes RX buffer) and FW responds with DMA_ALLOC_NOTIFY_ACK.
Additionally to DMA address communication, this sequence checks capabilities:
if the host doesnâ€™t support DMA, then it wonâ€™t send DMA allocation, so FW canâ€™t
send DMA; if FW doesnâ€™t support DMA then it wonâ€™t respond with
DMA_ALLOC_NOTIFY_ACK, in which case host will not use DMA transfers.
Here ISH acts as busmaster DMA controller. Hence when host sends DMA_XFER,
itâ€™s request to do host->ISH DMA transfer; when FW sends DMA_XFER, it means
that it already did DMA and the message resides at host. Thus, DMA_XFER
and DMA_XFER_ACK act as ownership indicators.”…””}”(hjJ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÇhj  h²hubhÌ)”}”(hXp  At initial state all outgoing memory belongs to the sender (TX to host, RX to
FW), DMA_XFER transfers ownership on the region that contains ISHTP message to
the receiving side, DMA_XFER_ACK returns ownership to the sender. A sender
need not wait for previous DMA_XFER to be ack'ed, and may send another message
as long as remaining continuous memory in its ownership is enough.
In principle, multiple DMA_XFER and DMA_XFER_ACK messages may be sent at once
(up to IPC MTU), thus allowing for interrupt throttling.
Currently, ISH FW decides to send over DMA if ISHTP message is more than 3 IPC
fragments and via IPC otherwise.”h]”hXr  At initial state all outgoing memory belongs to the sender (TX to host, RX to
FW), DMA_XFER transfers ownership on the region that contains ISHTP message to
the receiving side, DMA_XFER_ACK returns ownership to the sender. A sender
need not wait for previous DMA_XFER to be ackâ€™ed, and may send another message
as long as remaining continuous memory in its ownership is enough.
In principle, multiple DMA_XFER and DMA_XFER_ACK messages may be sent at once
(up to IPC MTU), thus allowing for interrupt throttling.
Currently, ISH FW decides to send over DMA if ISHTP message is more than 3 IPC
fragments and via IPC otherwise.”…””}”(hjX  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÒhj  h²hubeh}”(h]”Œpeer-to-peer-data-transfer”ah ]”h"]”Œpeer to peer data transfer”ah$]”h&]”uh1hµhj  h²hh³hÊh´K¹ubh¶)”}”(hhh]”(h»)”}”(hŒRing Buffers”h]”hŒRing Buffers”…””}”(hjq  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjn  h²hh³hÊh´KÝubhÌ)”}”(hX  When a client initiates a connection, a ring of RX and TX buffers is allocated.
The size of ring can be specified by the client. HID client sets 16 and 32 for
TX and RX buffers respectively. On send request from client, the data to be
sent is copied to one of the send ring buffer and scheduled to be sent using
bus message protocol. These buffers are required because the FW may have not
have processed the last message and may not have enough flow control credits
to send. Same thing holds true on receive side and flow control is required.”h]”hX  When a client initiates a connection, a ring of RX and TX buffers is allocated.
The size of ring can be specified by the client. HID client sets 16 and 32 for
TX and RX buffers respectively. On send request from client, the data to be
sent is copied to one of the send ring buffer and scheduled to be sent using
bus message protocol. These buffers are required because the FW may have not
have processed the last message and may not have enough flow control credits
to send. Same thing holds true on receive side and flow control is required.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kßhjn  h²hubeh}”(h]”Œring-buffers”ah ]”h"]”Œring buffers”ah$]”h&]”uh1hµhj  h²hh³hÊh´KÝubh¶)”}”(hhh]”(h»)”}”(hŒHost Enumeration”h]”hŒHost Enumeration”…””}”(hj˜  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj•  h²hh³hÊh´KèubhÌ)”}”(hŒšThe host enumeration bus command allows discovery of clients present in the FW.
There can be multiple sensor clients and clients for calibration function.”h]”hŒšThe host enumeration bus command allows discovery of clients present in the FW.
There can be multiple sensor clients and clients for calibration function.”…””}”(hj¦  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kêhj•  h²hubhÌ)”}”(hŒÑTo ease implementation and allow independent drivers to handle each client,
this transport layer takes advantage of Linux Bus driver model. Each
client is registered as device on the transport bus (ishtp bus).”h]”hŒÑTo ease implementation and allow independent drivers to handle each client,
this transport layer takes advantage of Linux Bus driver model. Each
client is registered as device on the transport bus (ishtp bus).”…””}”(hj´  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kíhj•  h²hubhÌ)”}”(hŒ!Enumeration sequence of messages:”h]”hŒ!Enumeration sequence of messages:”…””}”(hjÂ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kñhj•  h²hubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hŒFHost sends HOST_START_REQ_CMD, indicating that host ISHTP layer is up.”h]”hÌ)”}”(hjÙ  h]”hŒFHost sends HOST_START_REQ_CMD, indicating that host ISHTP layer is up.”…””}”(hjÛ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kóhj×  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒ#FW responds with HOST_START_RES_CMD”h]”hÌ)”}”(hjð  h]”hŒ#FW responds with HOST_START_RES_CMD”…””}”(hjò  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kôhjî  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒ3Host sends HOST_ENUM_REQ_CMD (enumerate FW clients)”h]”hÌ)”}”(hj  h]”hŒ3Host sends HOST_ENUM_REQ_CMD (enumerate FW clients)”…””}”(hj	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kõhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒRFW responds with HOST_ENUM_RES_CMD that includes bitmap of available FW
client IDs”h]”hÌ)”}”(hŒRFW responds with HOST_ENUM_RES_CMD that includes bitmap of available FW
client IDs”h]”hŒRFW responds with HOST_ENUM_RES_CMD that includes bitmap of available FW
client IDs”…””}”(hj   h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Köhj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒMFor each FW ID found in that bitmap host sends
HOST_CLIENT_PROPERTIES_REQ_CMD”h]”hÌ)”}”(hŒMFor each FW ID found in that bitmap host sends
HOST_CLIENT_PROPERTIES_REQ_CMD”h]”hŒMFor each FW ID found in that bitmap host sends
HOST_CLIENT_PROPERTIES_REQ_CMD”…””}”(hj8  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Køhj4  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒfFW responds with HOST_CLIENT_PROPERTIES_RES_CMD. Properties include UUID,
max ISHTP message size, etc.”h]”hÌ)”}”(hŒfFW responds with HOST_CLIENT_PROPERTIES_RES_CMD. Properties include UUID,
max ISHTP message size, etc.”h]”hŒfFW responds with HOST_CLIENT_PROPERTIES_RES_CMD. Properties include UUID,
max ISHTP message size, etc.”…””}”(hjP  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KúhjL  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´NubjÖ  )”}”(hŒ†Once host received properties for that last discovered client, it considers
ISHTP device fully functional (and allocates DMA buffers)
”h]”hÌ)”}”(hŒ…Once host received properties for that last discovered client, it considers
ISHTP device fully functional (and allocates DMA buffers)”h]”hŒ…Once host received properties for that last discovered client, it considers
ISHTP device fully functional (and allocates DMA buffers)”…””}”(hjh  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kühjd  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÒ  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1jÐ  h³hÊh´Kóhj•  h²hubeh}”(h]”Œhost-enumeration”ah ]”h"]”Œhost enumeration”ah$]”h&]”uh1hµhj  h²hh³hÊh´Kèubeh}”(h]”Œish-transport-layer”ah ]”h"]”Œish transport layer”ah$]”h&]”uh1hµhj  h²hh³hÊh´K™ubh¶)”}”(hhh]”(h»)”}”(hŒHID over ISH Client”h]”hŒHID over ISH Client”…””}”(hj—  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj”  h²hh³hÊh´M ubhÌ)”}”(hŒ#Location: drivers/hid/intel-ish-hid”h]”hŒ#Location: drivers/hid/intel-ish-hid”…””}”(hj¥  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj”  h²hubhÌ)”}”(hŒ+The ISHTP client driver is responsible for:”h]”hŒ+The ISHTP client driver is responsible for:”…””}”(hj³  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhj”  h²hubjÑ  )”}”(hhh]”(jÖ  )”}”(hŒ)enumerate HID devices under FW ISH client”h]”hÌ)”}”(hjÆ  h]”hŒ)enumerate HID devices under FW ISH client”…””}”(hjÈ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MhjÄ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hŒGet Report descriptor”h]”hÌ)”}”(hjÝ  h]”hŒGet Report descriptor”…””}”(hjß  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MhjÛ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hŒ%Register with HID core as a LL driver”h]”hÌ)”}”(hjô  h]”hŒ%Register with HID core as a LL driver”…””}”(hjö  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mhjò  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hŒProcess Get/Set feature request”h]”hÌ)”}”(hj  h]”hŒProcess Get/Set feature request”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M	hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hŒGet input reports
”h]”hÌ)”}”(hŒGet input reports”h]”hŒGet input reports”…””}”(hj$  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M
hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”j‚  jƒ  uh1jÐ  h³hÊh´Mhj”  h²hubeh}”(h]”Œhid-over-ish-client”ah ]”h"]”Œhid over ish client”ah$]”h&]”uh1hµhj  h²hh³hÊh´M ubh¶)”}”(hhh]”(h»)”}”(hŒ)HID Sensor Hub MFD and IIO sensor drivers”h]”hŒ)HID Sensor Hub MFD and IIO sensor drivers”…””}”(hjI  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjF  h²hh³hÊh´MubhÌ)”}”(hŒÆThe functionality in these drivers is the same as an external sensor hub.
Refer to
Documentation/hid/hid-sensor.rst for HID sensor
Documentation/ABI/testing/sysfs-bus-iio for IIO ABIs to user space.”h]”hŒÆThe functionality in these drivers is the same as an external sensor hub.
Refer to
Documentation/hid/hid-sensor.rst for HID sensor
Documentation/ABI/testing/sysfs-bus-iio for IIO ABIs to user space.”…””}”(hjW  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MhjF  h²hubeh}”(h]”Œ)hid-sensor-hub-mfd-and-iio-sensor-drivers”ah ]”h"]”Œ)hid sensor hub mfd and iio sensor drivers”ah$]”h&]”uh1hµhj  h²hh³hÊh´Mubh¶)”}”(hhh]”(h»)”}”(hŒ)End to End HID transport Sequence Diagram”h]”hŒ)End to End HID transport Sequence Diagram”…””}”(hjp  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjm  h²hh³hÊh´Mubj  )”}”(hXÕ  HID-ISH-CLN                    ISHTP                    IPC                             HW
        |                        |                       |                               |
        |                        |                       |-----WAKE UP------------------>|
        |                        |                       |                               |
        |                        |                       |-----HOST READY--------------->|
        |                        |                       |                               |
        |                        |                       |<----MNG_RESET_NOTIFY_ACK----- |
        |                        |                       |                               |
        |                        |<----ISHTP_START------ |                               |
        |                        |                       |                               |
        |                        |<-----------------HOST_START_RES_CMD-------------------|
        |                        |                       |                               |
        |                        |------------------QUERY_SUBSCRIBER-------------------->|
        |                        |                       |                               |
        |                        |------------------HOST_ENUM_REQ_CMD------------------->|
        |                        |                       |                               |
        |                        |<-----------------HOST_ENUM_RES_CMD--------------------|
        |                        |                       |                               |
        |                        |------------------HOST_CLIENT_PROPERTIES_REQ_CMD------>|
        |                        |                       |                               |
        |                        |<-----------------HOST_CLIENT_PROPERTIES_RES_CMD-------|
        |       Create new device on in ishtp bus        |                               |
        |                        |                       |                               |
        |                        |------------------HOST_CLIENT_PROPERTIES_REQ_CMD------>|
        |                        |                       |                               |
        |                        |<-----------------HOST_CLIENT_PROPERTIES_RES_CMD-------|
        |       Create new device on in ishtp bus        |                               |
        |                        |                       |                               |
        |                        |--Repeat HOST_CLIENT_PROPERTIES_REQ_CMD-till last one--|
        |                        |                       |                               |
     probed()
        |----ishtp_cl_connect--->|----------------- CLIENT_CONNECT_REQ_CMD-------------->|
        |                        |                       |                               |
        |                        |<----------------CLIENT_CONNECT_RES_CMD----------------|
        |                        |                       |                               |
        |register event callback |                       |                               |
        |                        |                       |                               |
        |ishtp_cl_send(
        HOSTIF_DM_ENUM_DEVICES)  |----------fill ishtp_msg_hdr struct write to HW-----  >|
        |                        |                       |                               |
        |                        |                       |<-----IRQ(IPC_PROTOCOL_ISHTP---|
        |                        |                       |                               |
        |<--ENUM_DEVICE RSP------|                       |                               |
        |                        |                       |                               |
for each enumerated device
        |ishtp_cl_send(
        HOSTIF_GET_HID_DESCRIPTOR|----------fill ishtp_msg_hdr struct write to HW-----  >|
        |                        |                       |                               |
        ...Response
        |                        |                       |                               |
for each enumerated device
        |ishtp_cl_send(
     HOSTIF_GET_REPORT_DESCRIPTOR|--------------fill ishtp_msg_hdr struct write to HW-- >|
        |                        |                       |                               |
        |                        |                       |                               |
 hid_allocate_device
        |                        |                       |                               |
 hid_add_device                  |                       |                               |
        |                        |                       |                               |”h]”hXÕ  HID-ISH-CLN                    ISHTP                    IPC                             HW
        |                        |                       |                               |
        |                        |                       |-----WAKE UP------------------>|
        |                        |                       |                               |
        |                        |                       |-----HOST READY--------------->|
        |                        |                       |                               |
        |                        |                       |<----MNG_RESET_NOTIFY_ACK----- |
        |                        |                       |                               |
        |                        |<----ISHTP_START------ |                               |
        |                        |                       |                               |
        |                        |<-----------------HOST_START_RES_CMD-------------------|
        |                        |                       |                               |
        |                        |------------------QUERY_SUBSCRIBER-------------------->|
        |                        |                       |                               |
        |                        |------------------HOST_ENUM_REQ_CMD------------------->|
        |                        |                       |                               |
        |                        |<-----------------HOST_ENUM_RES_CMD--------------------|
        |                        |                       |                               |
        |                        |------------------HOST_CLIENT_PROPERTIES_REQ_CMD------>|
        |                        |                       |                               |
        |                        |<-----------------HOST_CLIENT_PROPERTIES_RES_CMD-------|
        |       Create new device on in ishtp bus        |                               |
        |                        |                       |                               |
        |                        |------------------HOST_CLIENT_PROPERTIES_REQ_CMD------>|
        |                        |                       |                               |
        |                        |<-----------------HOST_CLIENT_PROPERTIES_RES_CMD-------|
        |       Create new device on in ishtp bus        |                               |
        |                        |                       |                               |
        |                        |--Repeat HOST_CLIENT_PROPERTIES_REQ_CMD-till last one--|
        |                        |                       |                               |
     probed()
        |----ishtp_cl_connect--->|----------------- CLIENT_CONNECT_REQ_CMD-------------->|
        |                        |                       |                               |
        |                        |<----------------CLIENT_CONNECT_RES_CMD----------------|
        |                        |                       |                               |
        |register event callback |                       |                               |
        |                        |                       |                               |
        |ishtp_cl_send(
        HOSTIF_DM_ENUM_DEVICES)  |----------fill ishtp_msg_hdr struct write to HW-----  >|
        |                        |                       |                               |
        |                        |                       |<-----IRQ(IPC_PROTOCOL_ISHTP---|
        |                        |                       |                               |
        |<--ENUM_DEVICE RSP------|                       |                               |
        |                        |                       |                               |
for each enumerated device
        |ishtp_cl_send(
        HOSTIF_GET_HID_DESCRIPTOR|----------fill ishtp_msg_hdr struct write to HW-----  >|
        |                        |                       |                               |
        ...Response
        |                        |                       |                               |
for each enumerated device
        |ishtp_cl_send(
     HOSTIF_GET_REPORT_DESCRIPTOR|--------------fill ishtp_msg_hdr struct write to HW-- >|
        |                        |                       |                               |
        |                        |                       |                               |
 hid_allocate_device
        |                        |                       |                               |
 hid_add_device                  |                       |                               |
        |                        |                       |                               |”…””}”hj~  sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´Mhjm  h²hubeh}”(h]”Œ)end-to-end-hid-transport-sequence-diagram”ah ]”h"]”Œ)end to end hid transport sequence diagram”ah$]”h&]”uh1hµhj  h²hh³hÊh´Mubh¶)”}”(hhh]”(h»)”}”(hŒ#ISH Firmware Loading from Host Flow”h]”hŒ#ISH Firmware Loading from Host Flow”…””}”(hj—  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj”  h²hh³hÊh´MWubhÌ)”}”(hX-  Starting from the Lunar Lake generation, the ISH firmware has been divided into two components for better space optimization and increased flexibility. These components include a bootloader that is integrated into the BIOS, and a main firmware that is stored within the operating system's file system.”h]”hX/  Starting from the Lunar Lake generation, the ISH firmware has been divided into two components for better space optimization and increased flexibility. These components include a bootloader that is integrated into the BIOS, and a main firmware that is stored within the operating systemâ€™s file system.”…””}”(hj¥  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MYhj”  h²hubhÌ)”}”(hŒThe process works as follows:”h]”hŒThe process works as follows:”…””}”(hj³  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M[hj”  h²hubjÑ  )”}”(hhh]”(jÖ  )”}”(hXE  Initially, the ISHTP driver sends a command, HOST_START_REQ_CMD, to the ISH bootloader. In response, the bootloader sends back a HOST_START_RES_CMD. This response includes the ISHTP_SUPPORT_CAP_LOADER bit. Subsequently, the ISHTP driver checks if this bit is set. If it is, the firmware loading process from the host begins.
”h]”hÌ)”}”(hXD  Initially, the ISHTP driver sends a command, HOST_START_REQ_CMD, to the ISH bootloader. In response, the bootloader sends back a HOST_START_RES_CMD. This response includes the ISHTP_SUPPORT_CAP_LOADER bit. Subsequently, the ISHTP driver checks if this bit is set. If it is, the firmware loading process from the host begins.”h]”hXD  Initially, the ISHTP driver sends a command, HOST_START_REQ_CMD, to the ISH bootloader. In response, the bootloader sends back a HOST_START_RES_CMD. This response includes the ISHTP_SUPPORT_CAP_LOADER bit. Subsequently, the ISHTP driver checks if this bit is set. If it is, the firmware loading process from the host begins.”…””}”(hjÈ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M]hjÄ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hX‰  During this process, the ISHTP driver first invokes the request_firmware() function, followed by sending a LOADER_CMD_XFER_QUERY command. Upon receiving a response from the bootloader, the ISHTP driver sends a LOADER_CMD_XFER_FRAGMENT command. After receiving another response, the ISHTP driver sends a LOADER_CMD_START command. The bootloader responds and then proceeds to the Main Firmware.
”h]”hÌ)”}”(hXˆ  During this process, the ISHTP driver first invokes the request_firmware() function, followed by sending a LOADER_CMD_XFER_QUERY command. Upon receiving a response from the bootloader, the ISHTP driver sends a LOADER_CMD_XFER_FRAGMENT command. After receiving another response, the ISHTP driver sends a LOADER_CMD_START command. The bootloader responds and then proceeds to the Main Firmware.”h]”hXˆ  During this process, the ISHTP driver first invokes the request_firmware() function, followed by sending a LOADER_CMD_XFER_QUERY command. Upon receiving a response from the bootloader, the ISHTP driver sends a LOADER_CMD_XFER_FRAGMENT command. After receiving another response, the ISHTP driver sends a LOADER_CMD_START command. The bootloader responds and then proceeds to the Main Firmware.”…””}”(hjà  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M_hjÜ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´NubjÖ  )”}”(hŒUAfter the process concludes, the ISHTP driver calls the release_firmware() function.
”h]”hÌ)”}”(hŒTAfter the process concludes, the ISHTP driver calls the release_firmware() function.”h]”hŒTAfter the process concludes, the ISHTP driver calls the release_firmware() function.”…””}”(hjø  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mahjô  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjÁ  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”j‚  jƒ  uh1jÐ  h³hÊh´M]hj”  h²hubhÌ)”}”(hŒTFor more detailed information, please refer to the flow descriptions provided below:”h]”hŒTFor more detailed information, please refer to the flow descriptions provided below:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mchj”  h²hubj  )”}”(hXo  +---------------+                                                    +-----------------+
| ISHTP Driver  |                                                    | ISH Bootloader  |
+---------------+                                                    +-----------------+
        |                                                                     |
        |~~~Send HOST_START_REQ_CMD~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send HOST_START_RES_CMD(Includes ISHTP_SUPPORT_CAP_LOADER bit)----|
        |                                                                     |
****************************************************************************************
* if ISHTP_SUPPORT_CAP_LOADER bit is set                                               *
****************************************************************************************
        |                                                                     |
        |~~~start loading firmware from host process~~~+                      |
        |                                              |                      |
        |<---------------------------------------------+                      |
        |                                                                     |
---------------------------                                                   |
| Call request_firmware() |                                                   |
---------------------------                                                   |
        |                                                                     |
        |~~~Send LOADER_CMD_XFER_QUERY~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |~~~Send LOADER_CMD_XFER_FRAGMENT~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |~~~Send LOADER_CMD_START~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |                                                                     |~~~Jump to Main Firmware~~~+
        |                                                                     |                           |
        |                                                                     |<--------------------------+
        |                                                                     |
---------------------------                                                   |
| Call release_firmware() |                                                   |
---------------------------                                                   |
        |                                                                     |
****************************************************************************************
* end if                                                                               *
****************************************************************************************
        |                                                                     |
+---------------+                                                    +-----------------+
| ISHTP Driver  |                                                    | ISH Bootloader  |
+---------------+                                                    +-----------------+”h]”hXo  +---------------+                                                    +-----------------+
| ISHTP Driver  |                                                    | ISH Bootloader  |
+---------------+                                                    +-----------------+
        |                                                                     |
        |~~~Send HOST_START_REQ_CMD~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send HOST_START_RES_CMD(Includes ISHTP_SUPPORT_CAP_LOADER bit)----|
        |                                                                     |
****************************************************************************************
* if ISHTP_SUPPORT_CAP_LOADER bit is set                                               *
****************************************************************************************
        |                                                                     |
        |~~~start loading firmware from host process~~~+                      |
        |                                              |                      |
        |<---------------------------------------------+                      |
        |                                                                     |
---------------------------                                                   |
| Call request_firmware() |                                                   |
---------------------------                                                   |
        |                                                                     |
        |~~~Send LOADER_CMD_XFER_QUERY~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |~~~Send LOADER_CMD_XFER_FRAGMENT~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |~~~Send LOADER_CMD_START~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~>|
        |                                                                     |
        |<--Send response-----------------------------------------------------|
        |                                                                     |
        |                                                                     |~~~Jump to Main Firmware~~~+
        |                                                                     |                           |
        |                                                                     |<--------------------------+
        |                                                                     |
---------------------------                                                   |
| Call release_firmware() |                                                   |
---------------------------                                                   |
        |                                                                     |
****************************************************************************************
* end if                                                                               *
****************************************************************************************
        |                                                                     |
+---------------+                                                    +-----------------+
| ISHTP Driver  |                                                    | ISH Bootloader  |
+---------------+                                                    +-----------------+”…””}”hj   sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´Mghj”  h²hubh¶)”}”(hhh]”(h»)”}”(hŒVendor Custom Firmware Loading”h]”hŒVendor Custom Firmware Loading”…””}”(hj1  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj.  h²hh³hÊh´M˜ubhÌ)”}”(hX×  The firmware running inside ISH can be provided by Intel or developed by vendors using the Firmware Development Kit (FDK) provided by Intel.
Intel will upstream the Intel-built firmware to the ``linux-firmware.git`` repository, located under the path ``intel/ish/``. For the Lunar Lake platform, the Intel-built ISH firmware will be named ``ish_lnlm.bin``.
Vendors who wish to upstream their custom firmware should follow these guidelines for naming their firmware files:”h]”(hŒÁThe firmware running inside ISH can be provided by Intel or developed by vendors using the Firmware Development Kit (FDK) provided by Intel.
Intel will upstream the Intel-built firmware to the ”…””}”(hj?  h²hh³Nh´NubhŒliteral”“”)”}”(hŒ``linux-firmware.git``”h]”hŒlinux-firmware.git”…””}”(hjI  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj?  ubhŒ$ repository, located under the path ”…””}”(hj?  h²hh³Nh´NubjH  )”}”(hŒ``intel/ish/``”h]”hŒ
intel/ish/”…””}”(hj[  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj?  ubhŒJ. For the Lunar Lake platform, the Intel-built ISH firmware will be named ”…””}”(hj?  h²hh³Nh´NubjH  )”}”(hŒ``ish_lnlm.bin``”h]”hŒish_lnlm.bin”…””}”(hjm  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj?  ubhŒt.
Vendors who wish to upstream their custom firmware should follow these guidelines for naming their firmware files:”…””}”(hj?  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mšhj.  h²hubjÑ  )”}”(hhh]”(jÖ  )”}”(hXí  The firmware filename should use one of the following patterns:

- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_SKU_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}.bin``
- ``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin``
”h]”(hÌ)”}”(hŒ?The firmware filename should use one of the following patterns:”h]”hŒ?The firmware filename should use one of the following patterns:”…””}”(hjŒ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mžhjˆ  ubjÑ  )”}”(hhh]”(jÖ  )”}”(hŒt``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hjŸ  h]”jH  )”}”(hjŸ  h]”hŒpish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hj¤  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj¡  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒ^``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hj¿  h]”jH  )”}”(hj¿  h]”hŒZish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hjÄ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjÁ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¡hj½  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒ_``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}.bin``”h]”hÌ)”}”(hjß  h]”jH  )”}”(hjß  h]”hŒ[ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}.bin”…””}”(hjä  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjá  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¢hjÝ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒI``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}.bin``”h]”hÌ)”}”(hjÿ  h]”jH  )”}”(hjÿ  h]”hŒEish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}.bin”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M£hjý  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒ\``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hj  h]”jH  )”}”(hj  h]”hŒXish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hj$  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj!  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¤hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒF``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hj?  h]”jH  )”}”(hj?  h]”hŒBish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hjD  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjA  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¥hj=  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒG``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}.bin``”h]”hÌ)”}”(hj_  h]”jH  )”}”(hj_  h]”hŒCish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}.bin”…””}”(hjd  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hja  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¦hj]  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubjÖ  )”}”(hŒ2``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin``
”h]”hÌ)”}”(hŒ1``ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin``”h]”jH  )”}”(hjƒ  h]”hŒ-ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin”…””}”(hj…  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M§hj}  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hjš  ubeh}”(h]”h ]”h"]”h$]”h&]”j‚  jƒ  uh1jÐ  h³hÊh´M hjˆ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³Nh´NubjÖ  )”}”(hŒ‰``${intel_plat_gen}`` indicates the Intel platform generation (e.g., ``lnlm`` for Lunar Lake) and must not exceed 8 characters in length.”h]”hÌ)”}”(hj¬  h]”(jH  )”}”(hŒ``${intel_plat_gen}``”h]”hŒ${intel_plat_gen}”…””}”(hj±  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj®  ubhŒ0 indicates the Intel platform generation (e.g., ”…””}”(hj®  h²hh³Nh´NubjH  )”}”(hŒ``lnlm``”h]”hŒlnlm”…””}”(hjÃ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj®  ubhŒ< for Lunar Lake) and must not exceed 8 characters in length.”…””}”(hj®  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M©hjª  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³hÊh´NubjÖ  )”}”(hŒp``${SYS_VENDOR_CRC32}`` is the CRC32 checksum of the ``sys_vendor`` value from the DMI field ``DMI_SYS_VENDOR``.”h]”hÌ)”}”(hjã  h]”(jH  )”}”(hŒ``${SYS_VENDOR_CRC32}``”h]”hŒ${SYS_VENDOR_CRC32}”…””}”(hjè  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjå  ubhŒ is the CRC32 checksum of the ”…””}”(hjå  h²hh³Nh´NubjH  )”}”(hŒ``sys_vendor``”h]”hŒ
sys_vendor”…””}”(hjú  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjå  ubhŒ value from the DMI field ”…””}”(hjå  h²hh³Nh´NubjH  )”}”(hŒ``DMI_SYS_VENDOR``”h]”hŒDMI_SYS_VENDOR”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjå  ubhŒ.”…””}”(hjå  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Mªhjá  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³hÊh´NubjÖ  )”}”(hŒ|``${PRODUCT_FAMILY_CRC32}`` is the CRC32 checksum of the ``product_family`` value from the DMI field ``DMI_PRODUCT_FAMILY``.”h]”hÌ)”}”(hj,  h]”(jH  )”}”(hŒ``${PRODUCT_FAMILY_CRC32}``”h]”hŒ${PRODUCT_FAMILY_CRC32}”…””}”(hj1  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj.  ubhŒ is the CRC32 checksum of the ”…””}”(hj.  h²hh³Nh´NubjH  )”}”(hŒ``product_family``”h]”hŒproduct_family”…””}”(hjC  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj.  ubhŒ value from the DMI field ”…””}”(hj.  h²hh³Nh´NubjH  )”}”(hŒ``DMI_PRODUCT_FAMILY``”h]”hŒDMI_PRODUCT_FAMILY”…””}”(hjU  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj.  ubhŒ.”…””}”(hj.  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M«hj*  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³hÊh´NubjÖ  )”}”(hŒv``${PRODUCT_NAME_CRC32}`` is the CRC32 checksum of the ``product_name`` value from the DMI field ``DMI_PRODUCT_NAME``.”h]”hÌ)”}”(hju  h]”(jH  )”}”(hŒ``${PRODUCT_NAME_CRC32}``”h]”hŒ${PRODUCT_NAME_CRC32}”…””}”(hjz  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjw  ubhŒ is the CRC32 checksum of the ”…””}”(hjw  h²hh³Nh´NubjH  )”}”(hŒ``product_name``”h]”hŒproduct_name”…””}”(hjŒ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjw  ubhŒ value from the DMI field ”…””}”(hjw  h²hh³Nh´NubjH  )”}”(hŒ``DMI_PRODUCT_NAME``”h]”hŒDMI_PRODUCT_NAME”…””}”(hjž  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjw  ubhŒ.”…””}”(hjw  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¬hjs  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³hÊh´NubjÖ  )”}”(hŒt``${PRODUCT_SKU_CRC32}`` is the CRC32 checksum of the ``product_sku`` value from the DMI field ``DMI_PRODUCT_SKU``.
”h]”hÌ)”}”(hŒs``${PRODUCT_SKU_CRC32}`` is the CRC32 checksum of the ``product_sku`` value from the DMI field ``DMI_PRODUCT_SKU``.”h]”(jH  )”}”(hŒ``${PRODUCT_SKU_CRC32}``”h]”hŒ${PRODUCT_SKU_CRC32}”…””}”(hjÄ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjÀ  ubhŒ is the CRC32 checksum of the ”…””•,^      }”(hjÀ  h²hh³Nh´NubjH  )”}”(hŒ``product_sku``”h]”hŒproduct_sku”…””}”(hjÖ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjÀ  ubhŒ value from the DMI field ”…””}”(hjÀ  h²hh³Nh´NubjH  )”}”(hŒ``DMI_PRODUCT_SKU``”h]”hŒDMI_PRODUCT_SKU”…””}”(hjè  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjÀ  ubhŒ.”…””}”(hjÀ  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M­hj¼  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj…  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”j‚  jƒ  uh1jÐ  h³hÊh´Mžhj.  h²hubhÌ)”}”(hŒ¤During system boot, the ISH Linux driver will attempt to load the firmware in the following order, prioritizing custom firmware with more precise matching patterns:”h]”hŒ¤During system boot, the ISH Linux driver will attempt to load the firmware in the following order, prioritizing custom firmware with more precise matching patterns:”…””}”(hj	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¯hj.  h²hubhŒenumerated_list”“”)”}”(hhh]”(jÖ  )”}”(hŒ~``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hj!	  h]”jH  )”}”(hj!	  h]”hŒzintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hj&	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj#	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M±hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒh``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hjA	  h]”jH  )”}”(hjA	  h]”hŒdintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hjF	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjC	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M²hj?	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒi``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}.bin``”h]”hÌ)”}”(hja	  h]”jH  )”}”(hja	  h]”hŒeintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}_${PRODUCT_NAME_CRC32}.bin”…””}”(hjf	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjc	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M³hj_	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒS``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}.bin``”h]”hÌ)”}”(hj	  h]”jH  )”}”(hj	  h]”hŒOintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_FAMILY_CRC32}.bin”…””}”(hj†	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjƒ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M´hj	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒf``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hj¡	  h]”jH  )”}”(hj¡	  h]”hŒbintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hj¦	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj£	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MµhjŸ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒP``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin``”h]”hÌ)”}”(hjÁ	  h]”jH  )”}”(hjÁ	  h]”hŒLintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_SKU_CRC32}.bin”…””}”(hjÆ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjÃ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¶hj¿	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒQ``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}.bin``”h]”hÌ)”}”(hjá	  h]”jH  )”}”(hjá	  h]”hŒMintel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}_${PRODUCT_NAME_CRC32}.bin”…””}”(hjæ	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hjã	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M·hjß	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒ;``intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin``”h]”hÌ)”}”(hj
  h]”jH  )”}”(hj
  h]”hŒ7intel/ish/ish_${intel_plat_gen}_${SYS_VENDOR_CRC32}.bin”…””}”(hj
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¸hjÿ	  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´NubjÖ  )”}”(hŒ(``intel/ish/ish_${intel_plat_gen}.bin``
”h]”hÌ)”}”(hŒ'``intel/ish/ish_${intel_plat_gen}.bin``”h]”jH  )”}”(hj%
  h]”hŒ#intel/ish/ish_${intel_plat_gen}.bin”…””}”(hj'
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1jG  hj#
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M¹hj
  ubah}”(h]”h ]”h"]”h$]”h&]”uh1jÕ  hj	  h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œenumtype”Œarabic”Œprefix”hŒsuffix”Œ.”uh1j	  hj.  h²hh³hÊh´M±ubhÌ)”}”(hX  The driver will load the first matching firmware and skip the rest. If no matching firmware is found, it will proceed to the next pattern in the specified order. If all searches fail, the default Intel firmware, listed last in the order above, will be loaded.”h]”hX  The driver will load the first matching firmware and skip the rest. If no matching firmware is found, it will proceed to the next pattern in the specified order. If all searches fail, the default Intel firmware, listed last in the order above, will be loaded.”…””}”(hjK
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´M»hj.  h²hubeh}”(h]”Œvendor-custom-firmware-loading”ah ]”h"]”Œvendor custom firmware loading”ah$]”h&]”uh1hµhj”  h²hh³hÊh´M˜ubeh}”(h]”Œ#ish-firmware-loading-from-host-flow”ah ]”h"]”Œ#ish firmware loading from host flow”ah$]”h&]”uh1hµhj  h²hh³hÊh´MWubh¶)”}”(hhh]”(h»)”}”(hŒISH Debugging”h]”hŒISH Debugging”…””}”(hjl
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhji
  h²hh³hÊh´M¾ubhÌ)”}”(hŒETo debug ISH, event tracing mechanism is used. To enable debug logs::”h]”hŒDTo debug ISH, event tracing mechanism is used. To enable debug logs:”…””}”(hjz
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´MÀhji
  h²hubj  )”}”(hŒRecho 1 > /sys/kernel/tracing/events/intel_ish/enable
cat /sys/kernel/tracing/trace”h]”hŒRecho 1 > /sys/kernel/tracing/events/intel_ish/enable
cat /sys/kernel/tracing/trace”…””}”hjˆ
  sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´MÂhji
  h²hubeh}”(h]”Œish-debugging”ah ]”h"]”Œish debugging”ah$]”h&]”uh1hµhj  h²hh³hÊh´M¾ubh¶)”}”(hhh]”(h»)”}”(hŒ1ISH IIO sysfs Example on Lenovo thinkpad Yoga 260”h]”hŒ1ISH IIO sysfs Example on Lenovo thinkpad Yoga 260”…””}”(hj¡
  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjž
  h²hh³hÊh´MÆubj  )”}”(hX4  root@otcpl-ThinkPad-Yoga-260:~# tree -l /sys/bus/iio/devices/
/sys/bus/iio/devices/
â”œâ”€â”€ iio:device0 -> ../../../devices/0044:8086:22D8.0001/HID-SENSOR-200073.9.auto/iio:device0
â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
...
â”‚Â Â  â”œâ”€â”€ in_accel_hysteresis
â”‚Â Â  â”œâ”€â”€ in_accel_offset
â”‚Â Â  â”œâ”€â”€ in_accel_sampling_frequency
â”‚Â Â  â”œâ”€â”€ in_accel_scale
â”‚Â Â  â”œâ”€â”€ in_accel_x_raw
â”‚Â Â  â”œâ”€â”€ in_accel_y_raw
â”‚Â Â  â”œâ”€â”€ in_accel_z_raw
â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_index
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_type
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_index
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_type
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_z_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_z_index
â”‚Â Â  â”‚Â Â  â””â”€â”€ in_accel_z_type
...
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ devices
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_intensity_both_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_rot_from_north_magnetic_tilt_comp_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_anglvel_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_anglvel_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...”h]”hX4  root@otcpl-ThinkPad-Yoga-260:~# tree -l /sys/bus/iio/devices/
/sys/bus/iio/devices/
â”œâ”€â”€ iio:device0 -> ../../../devices/0044:8086:22D8.0001/HID-SENSOR-200073.9.auto/iio:device0
â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
...
â”‚Â Â  â”œâ”€â”€ in_accel_hysteresis
â”‚Â Â  â”œâ”€â”€ in_accel_offset
â”‚Â Â  â”œâ”€â”€ in_accel_sampling_frequency
â”‚Â Â  â”œâ”€â”€ in_accel_scale
â”‚Â Â  â”œâ”€â”€ in_accel_x_raw
â”‚Â Â  â”œâ”€â”€ in_accel_y_raw
â”‚Â Â  â”œâ”€â”€ in_accel_z_raw
â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_index
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_x_type
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_index
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_y_type
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_z_en
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_accel_z_index
â”‚Â Â  â”‚Â Â  â””â”€â”€ in_accel_z_type
...
â”‚Â Â  â”‚Â Â  â”œâ”€â”€ devices
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_intensity_both_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_intensity_both_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_magn_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_rot_from_north_magnetic_tilt_comp_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_rot_from_north_magnetic_tilt_comp_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_anglvel_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ buffer
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ enable
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ length
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ watermark
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ dev
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_hysteresis
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_offset
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_sampling_frequency
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_scale
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_raw
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ name
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ scan_elements
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_x_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_y_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_en
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ in_anglvel_z_index
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ in_anglvel_z_type
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”œâ”€â”€ trigger
â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â”‚Â Â  â””â”€â”€ current_trigger
...”…””}”hj¯
  sbah}”(h]”h ]”h"]”h$]”h&]”j&  j'  uh1j  h³hÊh´MÊhjž
  h²hubeh}”(h]”Œ1ish-iio-sysfs-example-on-lenovo-thinkpad-yoga-260”ah ]”h"]”Œ1ish iio sysfs example on lenovo thinkpad yoga 260”ah$]”h&]”uh1hµhj  h²hh³hÊh´MÆubeh}”(h]”Œ%high-level-processing-in-above-blocks”ah ]”h"]”Œ%high level processing in above blocks”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kdubeh}”(h]”Œintel-integrated-sensor-hub-ish”ah ]”h"]”Œ!intel integrated sensor hub (ish)”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jø
  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(jÒ
  jÏ
  jW  jT  j~  j{  jÊ
  jÇ
  j¶  j³  j|  jy  jM  jJ  jE  jB  jt  jq  j‘  jŽ  jå  jâ  j  j  jk  jh  j’  j  j‰  j†  jC  j@  jj  jg  j‘  jŽ  jf
  jc
  j^
  j[
  j›
  j˜
  jÂ
  j¿
  uŒ	nametypes”}”(jÒ
  ‰jW  ‰j~  ‰jÊ
  ‰j¶  ‰j|  ‰jM  ‰jE  ‰jt  ‰j‘  ‰jå  ‰j  ‰jk  ‰j’  ‰j‰  ‰jC  ‰jj  ‰j‘  ‰jf
  ‰j^
  ‰j›
  ‰jÂ
  ‰uh}”(jÏ
  h·jT  h÷j{  jZ  jÇ
  j  j³  j’  jy  j¹  jJ  jæ  jB  j  jq  jP  jŽ  j  jâ  jž  j  jè  jh  j  j  jn  j†  j•  j@  j”  jg  jF  jŽ  jm  jc
  j”  j[
  j.  j˜
  ji
  j¿
  jž
  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.