sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget>/translations/zh_CN/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/zh_TW/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/it_IT/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/ja_JP/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/ko_KR/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/pt_BR/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget>/translations/sp_SP/driver-api/surface_aggregator/clients/cdevmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h!SPDX-License-Identifier: GPL-2.0+h]h!SPDX-License-Identifier: GPL-2.0+}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhX/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev.rsthKubhsubstitution_definition)}(hW.. |ssam_cdev_request| replace:: :c:type:`struct ssam_cdev_request `h]h)}(h6:c:type:`struct ssam_cdev_request `h]hliteral)}(hhh]hstruct ssam_cdev_request}(hhhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdoc*driver-api/surface_aggregator/clients/cdev refdomainhߌreftypetype refexplicitrefwarn reftargetssam_cdev_requestuh1hhhhKhhubah}(h]h ]h"]ssam_cdev_requestah$]h&]uh1hhhhKhhhhubh)}(hg.. |ssam_cdev_request_flags| replace:: :c:type:`enum ssam_cdev_request_flags `h]h)}(h@:c:type:`enum ssam_cdev_request_flags `h]h)}(hjh]henum ssam_cdev_request_flags}(hjhhhNhNubah}(h]h ](hhߌc-typeeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypetype refexplicitrefwarnhssam_cdev_request_flagsuh1hhhhKhhubah}(h]h ]h"]ssam_cdev_request_flagsah$]h&]uh1hhhhKhhhhubh)}(hR.. |ssam_cdev_event| replace:: :c:type:`struct ssam_cdev_event ` h]h)}(h2:c:type:`struct ssam_cdev_event `h]h)}(hj*h]hstruct ssam_cdev_event}(hj,hhhNhNubah}(h]h ](hhߌc-typeeh"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypetype refexplicitrefwarnhssam_cdev_eventuh1hhhhKhj$ubah}(h]h ]h"]ssam_cdev_eventah$]h&]uh1hhhhKhhhhubhsection)}(hhh](htitle)}(hUser-Space EC Interface (cdev)h]hUser-Space EC Interface (cdev)}(hjUhhhNhNubah}(h]h ]h"]h$]h&]refidid2uh1jShjPhhhhhK ubh paragraph)}(hXwThe ``surface_aggregator_cdev`` module provides a misc-device for the SSAM controller to allow for a (more or less) direct connection from user-space to the SAM EC. It is intended to be used for development and debugging, and therefore should not be used or relied upon in any other way. Note that this module is not loaded automatically, but instead must be loaded manually.h](hThe }(hjghhhNhNubh)}(h``surface_aggregator_cdev``h]hsurface_aggregator_cdev}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjgubhXX module provides a misc-device for the SSAM controller to allow for a (more or less) direct connection from user-space to the SAM EC. It is intended to be used for development and debugging, and therefore should not be used or relied upon in any other way. Note that this module is not loaded automatically, but instead must be loaded manually.}(hjghhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhK hjPhhubjf)}(hXThe provided interface is accessible through the ``/dev/surface/aggregator`` device-file. All functionality of this interface is provided via IOCTLs. These IOCTLs and their respective input/output parameter structs are defined in ``include/uapi/linux/surface_aggregator/cdev.h``.h](h1The provided interface is accessible through the }(hjhhhNhNubh)}(h``/dev/surface/aggregator``h]h/dev/surface/aggregator}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh device-file. All functionality of this interface is provided via IOCTLs. These IOCTLs and their respective input/output parameter structs are defined in }(hjhhhNhNubh)}(h0``include/uapi/linux/surface_aggregator/cdev.h``h]h,include/uapi/linux/surface_aggregator/cdev.h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhjPhhubjf)}(hA small python library and scripts for accessing this interface can be found at https://github.com/linux-surface/surface-aggregator-module/tree/master/scripts/ssam.h](hPA small python library and scripts for accessing this interface can be found at }(hjhhhNhNubh reference)}(hShttps://github.com/linux-surface/surface-aggregator-module/tree/master/scripts/ssamh]hShttps://github.com/linux-surface/surface-aggregator-module/tree/master/scripts/ssam}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1jhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhjPhhubhtopic)}(h Contents h](jT)}(hContentsh]hContents}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jShjhhhKubh bullet_list)}(hhh]h list_item)}(hhh](jf)}(hhh]j)}(hhh]hUser-Space EC Interface (cdev)}(hjhhhNhNubah}(h]jdah ]h"]h$]h&]refiduser-space-ec-interface-cdevuh1jhjubah}(h]h ]h"]h$]h&]uh1jehjubj)}(hhh](j)}(hhh]jf)}(hhh]j)}(hhh]hReceiving Events}(hjhhhNhNubah}(h]id3ah ]h"]h$]h&]refidreceiving-eventsuh1jhjubah}(h]h ]h"]h$]h&]uh1jehjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh](jf)}(hhh]j)}(hhh]hController IOCTLs}(hj=hhhNhNubah}(h]id4ah ]h"]h$]h&]refidcontroller-ioctlsuh1jhj:ubah}(h]h ]h"]h$]h&]uh1jehj7ubj)}(hhh](j)}(hhh]jf)}(hhh]j)}(hhh]h)}(h``SSAM_CDEV_REQUEST``h]hSSAM_CDEV_REQUEST}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhNhNhj\ubah}(h]id5ah ]h"]h$]h&]refidssam-cdev-requestuh1jhjYubah}(h]h ]h"]h$]h&]uh1jehjVubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]jf)}(hhh]j)}(hhh]h)}(h``SSAM_CDEV_NOTIF_REGISTER``h]hSSAM_CDEV_NOTIF_REGISTER}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhNhNhjubah}(h]id6ah ]h"]h$]h&]refidssam-cdev-notif-registeruh1jhjubah}(h]h ]h"]h$]h&]uh1jehjubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]jf)}(hhh]j)}(hhh]h)}(h``SSAM_CDEV_NOTIF_UNREGISTER``h]hSSAM_CDEV_NOTIF_UNREGISTER}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhNhNhjubah}(h]id7ah ]h"]h$]h&]refidssam-cdev-notif-unregisteruh1jhjubah}(h]h ]h"]h$]h&]uh1jehjubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]jf)}(hhh]j)}(hhh]h)}(h``SSAM_CDEV_EVENT_ENABLE``h]hSSAM_CDEV_EVENT_ENABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhNhNhjubah}(h]id8ah ]h"]h$]h&]refidssam-cdev-event-enableuh1jhjubah}(h]h ]h"]h$]h&]uh1jehjubah}(h]h ]h"]h$]h&]uh1jhjSubj)}(hhh]jf)}(hhh]j)}(hhh]h)}(h``SSAM_CDEV_EVENT_DISABLE``h]hSSAM_CDEV_EVENT_DISABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhNhNhj ubah}(h]id9ah ]h"]h$]h&]refidssam-cdev-event-disableuh1jhj ubah}(h]h ]h"]h$]h&]uh1jehjubah}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hhh]j)}(hhh]hStructures and Enums}(hjDhhhNhNubah}(h]id10ah ]h"]h$]h&]refidstructures-and-enumsuh1jhjAubah}(h]h ]h"]h$]h&]uh1jehj>ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjhhhNhNubeh}(h]contentsah ]contentsah"]contentsah$]h&]uh1jhhhKhjPhhubjO)}(hhh](jT)}(hReceiving Eventsh]hReceiving Events}(hj~hhhNhNubah}(h]h ]h"]h$]h&]jcj$uh1jShj{hhhhhKubjf)}(hnEvents can be received by reading from the device-file. The are represented by the |ssam_cdev_event| datatype.h](hSEvents can be received by reading from the device-file. The are represented by the }(hjhhhNhNubh)}(hj*h]h)}(hj*h]hstruct ssam_cdev_event}(hjhhhNhNubah}(h]h ](hhj6eh"]h$]h&]uh1hhNhNhjubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypejC refexplicitrefwarn reftargetjFuh1hhhhKhjhhubh datatype.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj{hhubjf)}(hXBefore events are available to be read, however, the desired notifiers must be registered via the ``SSAM_CDEV_NOTIF_REGISTER`` IOCTL. Notifiers are, in essence, callbacks, called when the EC sends an event. They are, in this interface, associated with a specific target category and device-file-instance. They forward any event of this category to the buffer of the corresponding instance, from which it can then be read.h](hbBefore events are available to be read, however, the desired notifiers must be registered via the }(hjhhhNhNubh)}(h``SSAM_CDEV_NOTIF_REGISTER``h]hSSAM_CDEV_NOTIF_REGISTER}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhX' IOCTL. Notifiers are, in essence, callbacks, called when the EC sends an event. They are, in this interface, associated with a specific target category and device-file-instance. They forward any event of this category to the buffer of the corresponding instance, from which it can then be read.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhK"hj{hhubjf)}(hXNotifiers themselves do not enable events on the EC. Thus, it may additionally be necessary to enable events via the ``SSAM_CDEV_EVENT_ENABLE`` IOCTL. While notifiers work per-client (i.e. per-device-file-instance), events are enabled globally, for the EC and all of its clients (regardless of userspace or non-userspace). The ``SSAM_CDEV_EVENT_ENABLE`` and ``SSAM_CDEV_EVENT_DISABLE`` IOCTLs take care of reference counting the events, such that an event is enabled as long as there is a client that has requested it.h](huNotifiers themselves do not enable events on the EC. Thus, it may additionally be necessary to enable events via the }(hjhhhNhNubh)}(h``SSAM_CDEV_EVENT_ENABLE``h]hSSAM_CDEV_EVENT_ENABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh IOCTL. While notifiers work per-client (i.e. per-device-file-instance), events are enabled globally, for the EC and all of its clients (regardless of userspace or non-userspace). The }(hjhhhNhNubh)}(h``SSAM_CDEV_EVENT_ENABLE``h]hSSAM_CDEV_EVENT_ENABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h``SSAM_CDEV_EVENT_DISABLE``h]hSSAM_CDEV_EVENT_DISABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh IOCTLs take care of reference counting the events, such that an event is enabled as long as there is a client that has requested it.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhK)hj{hhubjf)}(hXvNote that enabled events are not automatically disabled once the client instance is closed. Therefore any client process (or group of processes) should balance their event enable calls with the corresponding event disable calls. It is, however, perfectly valid to enable and disable events on different client instances. For example, it is valid to set up notifiers and read events on client instance ``A``, enable those events on instance ``B`` (note that these will also be received by A since events are enabled/disabled globally), and after no more events are desired, disable the previously enabled events via instance ``C``.h](hXNote that enabled events are not automatically disabled once the client instance is closed. Therefore any client process (or group of processes) should balance their event enable calls with the corresponding event disable calls. It is, however, perfectly valid to enable and disable events on different client instances. For example, it is valid to set up notifiers and read events on client instance }(hjhhhNhNubh)}(h``A``h]hA}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh", enable those events on instance }(hjhhhNhNubh)}(h``B``h]hB}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh (note that these will also be received by A since events are enabled/disabled globally), and after no more events are desired, disable the previously enabled events via instance }(hjhhhNhNubh)}(h``C``h]hC}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhK1hj{hhubeh}(h]j*ah ]h"]receiving eventsah$]h&]uh1jNhjPhhhhhKubjO)}(hhh](jT)}(hController IOCTLsh]hController IOCTLs}(hjlhhhNhNubah}(h]h ]h"]h$]h&]jcjFuh1jShjihhhhhK=ubjf)}(h"The following IOCTLs are provided:h]h"The following IOCTLs are provided:}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhK?hjihhubhtable)}(hhh](jT)}(hController IOCTLsh]hController IOCTLs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jShhhKAhjubhtgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubj)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1jhjubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]jf)}(hTypeh]hType}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKEhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hNumberh]hNumber}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKFhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h Directionh]h Direction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKGhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hNameh]hName}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKHhj%ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h Descriptionh]h Description}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKIhj<ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1jhjubhtbody)}(hhh](j)}(hhh](j)}(hhh]jf)}(h``0xA5``h]h)}(hjlh]h0xA5}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjubah}(h]h ]h"]h$]h&]uh1jehhhKKhjgubah}(h]h ]h"]h$]h&]uh1jhjdubj)}(hhh]jf)}(h``1``h]h)}(hjh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjdubj)}(hhh]jf)}(h``WR``h]h)}(hjh]hWR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKMhjubah}(h]h ]h"]h$]h&]uh1jhjdubj)}(hhh]jf)}(h ``REQUEST``h]h)}(hjh]hREQUEST}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKNhjubah}(h]h ]h"]h$]h&]uh1jhjdubj)}(hhh]jf)}(h Perform synchronous SAM request.h]h Perform synchronous SAM request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKOhjubah}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhjaubj)}(hhh](j)}(hhh]jf)}(h``0xA5``h]h)}(hj h]h0xA5}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jehhhKQhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``2``h]h)}(hj,h]h2}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jehhhKRhj'ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``W``h]h)}(hjLh]hW}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJubah}(h]h ]h"]h$]h&]uh1jehhhKShjGubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``NOTIF_REGISTER``h]h)}(hjlh]hNOTIF_REGISTER}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjubah}(h]h ]h"]h$]h&]uh1jehhhKThjgubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hRegister event notifier.h]hRegister event notifier.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKUhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjaubj)}(hhh](j)}(hhh]jf)}(h``0xA5``h]h)}(hjh]h0xA5}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKWhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``3``h]h)}(hjh]h3}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKXhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``W``h]h)}(hjh]hW}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKYhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``NOTIF_UNREGISTER``h]h)}(hj h]hNOTIF_UNREGISTER}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jehhhKZhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hUnregister event notifier.h]hUnregister event notifier.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhK[hj'ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjaubj)}(hhh](j)}(hhh]jf)}(h``0xA5``h]h)}(hjLh]h0xA5}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJubah}(h]h ]h"]h$]h&]uh1jehhhK]hjGubah}(h]h ]h"]h$]h&]uh1jhjDubj)}(hhh]jf)}(h``4``h]h)}(hjlh]h4}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjubah}(h]h ]h"]h$]h&]uh1jehhhK^hjgubah}(h]h ]h"]h$]h&]uh1jhjDubj)}(hhh]jf)}(h``W``h]h)}(hjh]hW}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhK_hjubah}(h]h ]h"]h$]h&]uh1jhjDubj)}(hhh]jf)}(h``EVENT_ENABLE``h]h)}(hjh]h EVENT_ENABLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhK`hjubah}(h]h ]h"]h$]h&]uh1jhjDubj)}(hhh]jf)}(hEnable event source.h]hEnable event source.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKahjubah}(h]h ]h"]h$]h&]uh1jhjDubeh}(h]h ]h"]h$]h&]uh1jhjaubj)}(hhh](j)}(hhh]jf)}(h``0xA5``h]h)}(hjh]h0xA5}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jehhhKchjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``5``h]h)}(hj h]h5}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jehhhKdhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``W``h]h)}(hj,h]hW}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jehhhKehj'ubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(h``EVENT_DISABLE``h]h)}(hjLh]h EVENT_DISABLE}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJubah}(h]h ]h"]h$]h&]uh1jehhhKfhjGubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hhh]jf)}(hDisable event source.h]hDisable event source.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKghjgubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjaubeh}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]colsKuh1jhjubeh}(h]id1ah ]h"]h$]h&]uh1jhjihhhNhNubjO)}(hhh](jT)}(hjah]h)}(hjah]hSSAM_CDEV_REQUEST}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]jcjouh1jShjhhhhhKkubjf)}(h8Defined as ``_IOWR(0xA5, 1, struct ssam_cdev_request)``.h](h Defined as }(hjhhhNhNubh)}(h,``_IOWR(0xA5, 1, struct ssam_cdev_request)``h]h(_IOWR(0xA5, 1, struct ssam_cdev_request)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKmhjhhubjf)}(hExecutes a synchronous SAM request. The request specification is passed in as argument of type |ssam_cdev_request|, which is then written to/modified by the IOCTL to return status and result of the request.h](h_Executes a synchronous SAM request. The request specification is passed in as argument of type }(hjhhhNhNubh)}(hhh]h)}(hhh]hstruct ssam_cdev_request}(hjhhhNhNubah}(h]h ](hhheh"]h$]h&]uh1hhNhNhjubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypeh refexplicitrefwarn reftargethuh1hhhhKhjhhubh\, which is then written to/modified by the IOCTL to return status and result of the request.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKohjhhubjf)}(hX-Request payload data must be allocated separately and is passed in via the ``payload.data`` and ``payload.length`` members. If a response is required, the response buffer must be allocated by the caller and passed in via the ``response.data`` member. The ``response.length`` member must be set to the capacity of this buffer, or if no response is required, zero. Upon completion of the request, the call will write the response to the response buffer (if its capacity allows it) and overwrite the length field with the actual size of the response, in bytes.h](hKRequest payload data must be allocated separately and is passed in via the }(hjhhhNhNubh)}(h``payload.data``h]h payload.data}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh and }(hjhhhNhNubh)}(h``payload.length``h]hpayload.length}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubho members. If a response is required, the response buffer must be allocated by the caller and passed in via the }(hjhhhNhNubh)}(h``response.data``h]h response.data}(hj+ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh member. The }(hjhhhNhNubh)}(h``response.length``h]hresponse.length}(hj= hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubhX member must be set to the capacity of this buffer, or if no response is required, zero. Upon completion of the request, the call will write the response to the response buffer (if its capacity allows it) and overwrite the length field with the actual size of the response, in bytes.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKshjhhubjf)}(hAdditionally, if the request has a response, this must be indicated via the request flags, as is done with in-kernel requests. Request flags can be set via the ``flags`` member and the values correspond to the values found in |ssam_cdev_request_flags|.h](hAdditionally, if the request has a response, this must be indicated via the request flags, as is done with in-kernel requests. Request flags can be set via the }(hjU hhhNhNubh)}(h ``flags``h]hflags}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjU ubh9 member and the values correspond to the values found in }(hjU hhhNhNubh)}(hjh]h)}(hjh]henum ssam_cdev_request_flags}(hjr hhhNhNubah}(h]h ](hhj eh"]h$]h&]uh1hhNhNhjo ubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypej refexplicitrefwarn reftargetjuh1hhhhKhjU hhubh.}(hjU hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhK|hjhhubjf)}(hXxFinally, the status of the request itself is returned in the ``status`` member (a negative errno value indicating failure). Note that failure indication of the IOCTL is separated from failure indication of the request: The IOCTL returns a negative status code if anything failed during setup of the request (``-EFAULT``) or if the provided argument or any of its fields are invalid (``-EINVAL``). In this case, the status value of the request argument may be set, providing more detail on what went wrong (e.g. ``-ENOMEM`` for out-of-memory), but this value may also be zero. The IOCTL will return with a zero status code in case the request has been set up, submitted, and completed (i.e. handed back to user-space) successfully from inside the IOCTL, but the request ``status`` member may still be negative in case the actual execution of the request failed after it has been submitted.h](h=Finally, the status of the request itself is returned in the }(hj hhhNhNubh)}(h ``status``h]hstatus}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh member (a negative errno value indicating failure). Note that failure indication of the IOCTL is separated from failure indication of the request: The IOCTL returns a negative status code if anything failed during setup of the request (}(hj hhhNhNubh)}(h ``-EFAULT``h]h-EFAULT}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh@) or if the provided argument or any of its fields are invalid (}(hj hhhNhNubh)}(h ``-EINVAL``h]h-EINVAL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubhu). In this case, the status value of the request argument may be set, providing more detail on what went wrong (e.g. }(hj hhhNhNubh)}(h ``-ENOMEM``h]h-ENOMEM}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh for out-of-memory), but this value may also be zero. The IOCTL will return with a zero status code in case the request has been set up, submitted, and completed (i.e. handed back to user-space) successfully from inside the IOCTL, but the request }(hj hhhNhNubh)}(h ``status``h]hstatus}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubhm member may still be negative in case the actual execution of the request failed after it has been submitted.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhjhhubjf)}(h;A full definition of the argument struct is provided below.h]h;A full definition of the argument struct is provided below.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKhjhhubeh}(h]juah ]h"]ssam_cdev_requestah$]h&]uh1jNhjihhhhhKkubjO)}(hhh](jT)}(hjh]h)}(hjh]hSSAM_CDEV_NOTIF_REGISTER}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]jcjuh1jShj hhhhhKubjf)}(h=Defined as ``_IOW(0xA5, 2, struct ssam_cdev_notifier_desc)``.h](h Defined as }(hj+ hhhNhNubh)}(h1``_IOW(0xA5, 2, struct ssam_cdev_notifier_desc)``h]h-_IOW(0xA5, 2, struct ssam_cdev_notifier_desc)}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+ ubh.}(hj+ hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubjf)}(hX Register a notifier for the event target category specified in the given notifier description with the specified priority. Notifiers registration is required to receive events, but does not enable events themselves. After a notifier for a specific target category has been registered, all events of that category will be forwarded to the userspace client and can then be read from the device file instance. Note that events may have to be enabled, e.g. via the ``SSAM_CDEV_EVENT_ENABLE`` IOCTL, before the EC will send them.h](hXRegister a notifier for the event target category specified in the given notifier description with the specified priority. Notifiers registration is required to receive events, but does not enable events themselves. After a notifier for a specific target category has been registered, all events of that category will be forwarded to the userspace client and can then be read from the device file instance. Note that events may have to be enabled, e.g. via the }(hjK hhhNhNubh)}(h``SSAM_CDEV_EVENT_ENABLE``h]hSSAM_CDEV_EVENT_ENABLE}(hjS hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjK ubh% IOCTL, before the EC will send them.}(hjK hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubjf)}(hOnly one notifier can be registered per target category and client instance. If a notifier has already been registered, this IOCTL will fail with ``-EEXIST``.h](hOnly one notifier can be registered per target category and client instance. If a notifier has already been registered, this IOCTL will fail with }(hjk hhhNhNubh)}(h ``-EEXIST``h]h-EEXIST}(hjs hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjk ubh.}(hjk hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubjf)}(hPNotifiers will automatically be removed when the device file instance is closed.h]hPNotifiers will automatically be removed when the device file instance is closed.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jehhhKhj hhubeh}(h]jah ]h"]ssam_cdev_notif_registerah$]h&]uh1jNhjihhhhhKubjO)}(hhh](jT)}(hjh]h)}(hjh]hSSAM_CDEV_NOTIF_UNREGISTER}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]jcjuh1jShj hhhhhKubjf)}(h=Defined as ``_IOW(0xA5, 3, struct ssam_cdev_notifier_desc)``.h](h Defined as }(hj hhhNhNubh)}(h1``_IOW(0xA5, 3, struct ssam_cdev_notifier_desc)``h]h-_IOW(0xA5, 3, struct ssam_cdev_notifier_desc)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubjf)}(hUnregisters the notifier associated with the specified target category. The priority field will be ignored by this IOCTL. If no notifier has been registered for this client instance and the given category, this IOCTL will fail with ``-ENOENT``.h](hUnregisters the notifier associated with the specified target category. The priority field will be ignored by this IOCTL. If no notifier has been registered for this client instance and the given category, this IOCTL will fail with }(hj hhhNhNubh)}(h ``-ENOENT``h]h-ENOENT}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubeh}(h]jah ]h"]ssam_cdev_notif_unregisterah$]h&]uh1jNhjihhhhhKubjO)}(hhh](jT)}(hjh]h)}(hjh]hSSAM_CDEV_EVENT_ENABLE}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]jcjuh1jShj hhhhhKubjf)}(h:Defined as ``_IOW(0xA5, 4, struct ssam_cdev_event_desc)``.h](h Defined as }(hj hhhNhNubh)}(h.``_IOW(0xA5, 4, struct ssam_cdev_event_desc)``h]h*_IOW(0xA5, 4, struct ssam_cdev_event_desc)}(hj! hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehhhKhj hhubjf)}(h`). ``status`` Request status (output). ``payload`` Request payload (input data). ``payload.data`` Pointer to request payload data. ``payload.length`` Length of request payload data (in bytes). ``response`` Request response (output data). ``response.data`` Pointer to response buffer. ``response.length`` On input: Capacity of response buffer (in bytes). On output: Length of request response (number of bytes in the buffer that are actually used).h](jf)}(h**Definition**::h](j )}(h**Definition**h]h Definition}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubh:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK+hj ubh literal_block)}(hXTstruct ssam_cdev_request { __u8 target_category; __u8 target_id; __u8 command_id; __u8 instance_id; __u16 flags; __s16 status; struct { __u64 data; __u16 length; __u8 __pad[6]; } payload; struct { __u64 data; __u16 length; __u8 __pad[6]; } response; };h]hXTstruct ssam_cdev_request { __u8 target_category; __u8 target_id; __u8 command_id; __u8 instance_id; __u16 flags; __s16 status; struct { __u64 data; __u16 length; __u8 __pad[6]; } payload; struct { __u64 data; __u16 length; __u8 __pad[6]; } response; };}hj sbah}(h]h ]h"]h$]h&]hhuh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK-hj ubjf)}(h **Members**h]j )}(hj h]hMembers}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK@hj ubj )}(hhh](j )}(h8``target_category`` Target category of the SAM request. h](j )}(h``target_category``h]h)}(hjh]htarget_category}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK)hjubj )}(hhh]jf)}(h#Target category of the SAM request.h]h#Target category of the SAM request.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1jehj,hK)hj-ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj,hK)hjubj )}(h,``target_id`` Target ID of the SAM request. h](j )}(h ``target_id``h]h)}(hjPh]h target_id}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK*hjJubj )}(hhh]jf)}(hTarget ID of the SAM request.h]hTarget ID of the SAM request.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1jehjehK*hjfubah}(h]h ]h"]h$]h&]uh1j hjJubeh}(h]h ]h"]h$]h&]uh1j hjehK*hjubj )}(h.``command_id`` Command ID of the SAM request. h](j )}(h``command_id``h]h)}(hjh]h command_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK+hjubj )}(hhh]jf)}(hCommand ID of the SAM request.h]hCommand ID of the SAM request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK+hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK+hjubj )}(h0``instance_id`` Instance ID of the SAM request. h](j )}(h``instance_id``h]h)}(hjh]h instance_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK,hjubj )}(hhh]jf)}(hInstance ID of the SAM request.h]hInstance ID of the SAM request.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK,hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK,hjubj )}(h```flags`` Request flags (see :c:type:`enum ssam_cdev_request_flags `). h](j )}(h ``flags``h]h)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK-hjubj )}(hhh]jf)}(hURequest flags (see :c:type:`enum ssam_cdev_request_flags `).h](hRequest flags (see }(hjhhhNhNubh)}(h@:c:type:`enum ssam_cdev_request_flags `h]h)}(hjh]henum ssam_cdev_request_flags}(hj hhhNhNubah}(h]h ](hhߌc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypetype refexplicitrefwarn c:parent_keysphinx.domains.c LookupKey)}data]sbhssam_cdev_request_flagsuh1hhjhK-hjubh).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jehjhK-hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK-hjubj )}(h$``status`` Request status (output). h](j )}(h ``status``h]h)}(hj_h]hstatus}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]ubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK.hjYubj )}(hhh]jf)}(hRequest status (output).h]hRequest status (output).}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjthK.hjuubah}(h]h ]h"]h$]h&]uh1j hjYubeh}(h]h ]h"]h$]h&]uh1j hjthK.hjubj )}(h*``payload`` Request payload (input data). h](j )}(h ``payload``h]h)}(hjh]hpayload}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK/hjubj )}(hhh]jf)}(hRequest payload (input data).h]hRequest payload (input data).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK/hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK/hjubj )}(h2``payload.data`` Pointer to request payload data. h](j )}(h``payload.data``h]h)}(hjh]h payload.data}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK0hjubj )}(hhh]jf)}(h Pointer to request payload data.h]h Pointer to request payload data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK0hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK0hjubj )}(h>``payload.length`` Length of request payload data (in bytes). h](j )}(h``payload.length``h]h)}(hj h]hpayload.length}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK1hjubj )}(hhh]jf)}(h*Length of request payload data (in bytes).h]h*Length of request payload data (in bytes).}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK1hj ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK1hjubj )}(h-``response`` Request response (output data). h](j )}(h ``response``h]h)}(hjCh]hresponse}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK2hj=ubj )}(hhh]jf)}(hRequest response (output data).h]hRequest response (output data).}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jehjXhK2hjYubah}(h]h ]h"]h$]h&]uh1j hj=ubeh}(h]h ]h"]h$]h&]uh1j hjXhK2hjubj )}(h.``response.data`` Pointer to response buffer. h](j )}(h``response.data``h]h)}(hj|h]h response.data}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK3hjvubj )}(hhh]jf)}(hPointer to response buffer.h]hPointer to response buffer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhK3hjubah}(h]h ]h"]h$]h&]uh1j hjvubeh}(h]h ]h"]h$]h&]uh1j hjhK3hjubj )}(h``response.length`` On input: Capacity of response buffer (in bytes). On output: Length of request response (number of bytes in the buffer that are actually used).h](j )}(h``response.length``h]h)}(hjh]hresponse.length}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK5hjubj )}(hhh]jf)}(hOn input: Capacity of response buffer (in bytes). On output: Length of request response (number of bytes in the buffer that are actually used).h]hOn input: Capacity of response buffer (in bytes). On output: Length of request response (number of bytes in the buffer that are actually used).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK4hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhK5hjubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj hhhNhNubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j "ssam_cdev_notifier_desc (C struct)c.ssam_cdev_notifier_deschNtauh1j hj hhhNhNubj )}(hhh](j )}(hssam_cdev_notifier_desch]j )}(hstruct ssam_cdev_notifier_desch](j )}(hjg h]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hj hhh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK``reg.cid_disable`` Command ID for the event-disable request. h](j )}(h``reg.cid_disable``h]h)}(hj h]hreg.cid_disable}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKdhjubj )}(hhh]jf)}(h)Command ID for the event-disable request.h]h)Command ID for the event-disable request.}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jehj hKdhj!ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj hKdhjubj )}(h ``id`` ID specifying the event. h](j )}(h``id``h]h)}(hjDh]hid}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjBubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKehj>ubj )}(hhh]jf)}(hID specifying the event.h]hID specifying the event.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jehjYhKehjZubah}(h]h ]h"]h$]h&]uh1j hj>ubeh}(h]h ]h"]h$]h&]uh1j hjYhKehjubj )}(h<``id.target_category`` Target category of the event source. h](j )}(h``id.target_category``h]h)}(hj}h]hid.target_category}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{ubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKfhjwubj )}(hhh]jf)}(h$Target category of the event source.h]h$Target category of the event source.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhKfhjubah}(h]h ]h"]h$]h&]uh1j hjwubeh}(h]h ]h"]h$]h&]uh1j hjhKfhjubj )}(h1``id.instance`` Instance ID of the event source. h](j )}(h``id.instance``h]h)}(hjh]h id.instance}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKghjubj )}(hhh]jf)}(h Instance ID of the event source.h]h Instance ID of the event source.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhKghjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhKghjubj )}(h,``flags`` Flags used for enabling the event.h](j )}(h ``flags``h]h)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKghjubj )}(hhh]jf)}(h"Flags used for enabling the event.h]h"Flags used for enabling the event.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhKghjubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj hhhNhNubjf)}(h**Description**h]j )}(hj2h]h Description}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1j hj0ubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKkhj hhubjf)}(hDSpecifies which event should be enabled/disabled and how to do that.h]hDSpecifies which event should be enabled/disabled and how to do that.}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhhj hhubj )}(hhh]h}(h]h ]h"]h$]h&]entries](j ssam_cdev_event (C struct)c.ssam_cdev_eventhNtauh1j hj hhhNhNubj )}(hhh](j )}(hssam_cdev_eventh]j )}(hstruct ssam_cdev_eventh](j )}(hjg h]hstruct}(hjphhhNhNubah}(h]h ]j ah"]h$]h&]uh1j hjlhhh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKmubj% )}(h h]h }(hj~hhhNhNubah}(h]h ]j1 ah"]h$]h&]uh1j$ hjlhhhj}hKmubj6 )}(hssam_cdev_eventh]j< )}(hjjh]hssam_cdev_event}(hjhhhNhNubah}(h]h ]jG ah"]h$]h&]uh1j; hjubah}(h]h ](jN jO eh"]h$]h&]hhuh1j5 hjlhhhj}hKmubeh}(h]h ]h"]h$]h&]hhjY uh1j jZ j[ hjhhhhj}hKmubah}(h]jcah ](j_ j` eh"]h$]h&]jd je )jf huh1j hj}hKmhjehhubjh )}(hhh]jf)}(hSSAM event sent by the EC.h]hSSAM event sent by the EC.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK|hjhhubah}(h]h ]h"]h$]h&]uh1jg hjehhhj}hKmubeh}(h]h ](hߌstructeh"]h$]h&]j hj jj jj j j uh1j hhhj hNhNubj )}(hX**Definition**:: struct ssam_cdev_event { __u8 target_category; __u8 target_id; __u8 command_id; __u8 instance_id; __u16 length; __u8 data[]; }; **Members** ``target_category`` Target category of the event source. See :c:type:`enum ssam_ssh_tc `. ``target_id`` Target ID of the event source. ``command_id`` Command ID of the event. ``instance_id`` Instance ID of the event source. ``length`` Length of the event payload in bytes. ``data`` Event payload data.h](jf)}(h**Definition**::h](j )}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjubj )}(hstruct ssam_cdev_event { __u8 target_category; __u8 target_id; __u8 command_id; __u8 instance_id; __u16 length; __u8 data[]; };h]hstruct ssam_cdev_event { __u8 target_category; __u8 target_id; __u8 command_id; __u8 instance_id; __u16 length; __u8 data[]; };}hjsbah}(h]h ]h"]h$]h&]hhuh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjubjf)}(h **Members**h]j )}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjubj )}(hhh](j )}(hg``target_category`` Target category of the event source. See :c:type:`enum ssam_ssh_tc `. h](j )}(h``target_category``h]h)}(hjh]htarget_category}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhK~hjubj )}(hhh]jf)}(hRTarget category of the event source. See :c:type:`enum ssam_ssh_tc `.h](h)Target category of the event source. See }(hj8hhhNhNubh)}(h(:c:type:`enum ssam_ssh_tc `h]h)}(hjBh]henum ssam_ssh_tc}(hjDhhhNhNubah}(h]h ](hhߌc-typeeh"]h$]h&]uh1hhj@ubah}(h]h ]h"]h$]h&]refdoch refdomainhߌreftypetype refexplicitrefwarnj:j>h ssam_ssh_tcuh1hhj4hK~hj8ubh.}(hj8hhhNhNubeh}(h]h ]h"]h$]h&]uh1jehj4hK~hj5ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj4hK~hjubj )}(h-``target_id`` Target ID of the event source. h](j )}(h ``target_id``h]h)}(hj{h]h target_id}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjuubj )}(hhh]jf)}(hTarget ID of the event source.h]hTarget ID of the event source.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhKhjubah}(h]h ]h"]h$]h&]uh1j hjuubeh}(h]h ]h"]h$]h&]uh1j hjhKhjubj )}(h(``command_id`` Command ID of the event. h](j )}(h``command_id``h]h)}(hjh]h command_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjubj )}(hhh]jf)}(hCommand ID of the event.h]hCommand ID of the event.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhKhjubj )}(h1``instance_id`` Instance ID of the event source. h](j )}(h``instance_id``h]h)}(hjh]h instance_id}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjubj )}(hhh]jf)}(h Instance ID of the event source.h]h Instance ID of the event source.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jehjhKhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjhKhjubj )}(h1``length`` Length of the event payload in bytes. h](j )}(h ``length``h]h)}(hj&h]hlength}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhj ubj )}(hhh]jf)}(h%Length of the event payload in bytes.h]h%Length of the event payload in bytes.}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jehj;hKhj<ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj;hKhjubj )}(h``data`` Event payload data.h](j )}(h``data``h]h)}(hj_h]hdata}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]ubah}(h]h ]h"]h$]h&]uh1j h/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjYubj )}(hhh]jf)}(hEvent payload data.h]hEvent payload data.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jeh/var/lib/git/docbuild/linux/Documentation/driver-api/surface_aggregator/clients/cdev:204: ./include/uapi/linux/surface_aggregator/cdev.hhKhjuubah}(h]h ]h"]h$]h&]uh1j hjYubeh}(h]h ]h"]h$]h&]uh1j hjthKhjubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j hj hhhNhNubeh}(h]jSah ]h"]structures and enumsah$]h&]uh1jNhjPhhhhhKubeh}(h]j ah ]h"]user-space ec interface (cdev)ah$]h&]uh1jNhhhhhhhK ubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(jSN generatorN datestampN source_linkN source_urlN toc_backlinksjfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}(hhj!hjKj$usubstitution_names}(ssam_cdev_requesthssam_cdev_request_flagsj!ssam_cdev_eventjKurefnames}refids}nameids}(jj jxjtjfj*j jLj juj jj jjy jj j%jjSu nametypes}(jjxjfj j j j jy j juh}(j jPjtjj*j{jLjijujjj jj jj j%j| jSj j j jX j] jjjkjpjcjhjjjdjj$jjFj=joj\jjjjjjjj jMjDu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jK sRparse_messages]transform_messages] transformerN include_log] decorationNhhub.