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/PCI/endpoint/pci-endpointmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/zh_TW/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/it_IT/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/ja_JP/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/ko_KR/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/pt_BR/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget-/translations/sp_SP/PCI/endpoint/pci-endpointmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhG/var/lib/git/docbuild/linux/Documentation/PCI/endpoint/pci-endpoint.rsthKubh paragraph)}(hThis document is a guide to use the PCI Endpoint Framework in order to create endpoint controller driver, endpoint function driver, and using configfs interface to bind the function driver to the controller driver.h]hThis document is a guide to use the PCI Endpoint Framework in order to create endpoint controller driver, endpoint function driver, and using configfs interface to bind the function driver to the controller driver.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubhsection)}(hhh](htitle)}(h Introductionh]h Introduction}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hXWLinux has a comprehensive PCI subsystem to support PCI controllers that operates in Root Complex mode. The subsystem has capability to scan PCI bus, assign memory resources and IRQ resources, load PCI driver (based on vendor ID, device ID), support other services like hot-plug, power management, advanced error reporting and virtual channels.h]hXWLinux has a comprehensive PCI subsystem to support PCI controllers that operates in Root Complex mode. The subsystem has capability to scan PCI bus, assign memory resources and IRQ resources, load PCI driver (based on vendor ID, device ID), support other services like hot-plug, power management, advanced error reporting and virtual channels.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hXMHowever the PCI controller IP integrated in some SoCs is capable of operating either in Root Complex mode or Endpoint mode. PCI Endpoint Framework will add endpoint mode support in Linux. This will help to run Linux in an EP system which can have a wide variety of use cases from testing or validation, co-processor accelerator, etc.h]hXMHowever the PCI controller IP integrated in some SoCs is capable of operating either in Root Complex mode or Endpoint mode. PCI Endpoint Framework will add endpoint mode support in Linux. This will help to run Linux in an EP system which can have a wide variety of use cases from testing or validation, co-processor accelerator, etc.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h] introductionah ]h"] introductionah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hPCI Endpoint Coreh]hPCI Endpoint Core}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hThe PCI Endpoint Core layer comprises 3 components: the Endpoint Controller library, the Endpoint Function library, and the configfs layer to bind the endpoint function with the endpoint controller.h]hThe PCI Endpoint Core layer comprises 3 components: the Endpoint Controller library, the Endpoint Function library, and the configfs layer to bind the endpoint function with the endpoint controller.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hhh](h)}(h$PCI Endpoint Controller(EPC) Libraryh]h$PCI Endpoint Controller(EPC) Library}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0hhhhhK ubh)}(hThe EPC library provides APIs to be used by the controller that can operate in endpoint mode. It also provides APIs to be used by function driver/library in order to implement a particular endpoint function.h]hThe EPC library provides APIs to be used by the controller that can operate in endpoint mode. It also provides APIs to be used by function driver/library in order to implement a particular endpoint function.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK"hj0hhubh)}(hhh](h)}(h"APIs for the PCI controller Driverh]h"APIs for the PCI controller Driver}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhhhhhK'ubh)}(hhThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI controller driver.h]hhThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI controller driver.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK)hjOhhubh bullet_list)}(hhh](h list_item)}(hXdevm_pci_epc_create()/pci_epc_create() The PCI controller driver should implement the following ops: * write_header: ops to populate configuration space header * set_bar: ops to configure the BAR * clear_bar: ops to reset the BAR * alloc_addr_space: ops to allocate in PCI controller address space * free_addr_space: ops to free the allocated address space * raise_irq: ops to raise a legacy, MSI or MSI-X interrupt * start: ops to start the PCI link * stop: ops to stop the PCI link The PCI controller driver can then create a new EPC device by invoking devm_pci_epc_create()/pci_epc_create(). h](h)}(h&devm_pci_epc_create()/pci_epc_create()h]h&devm_pci_epc_create()/pci_epc_create()}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK,hjuubh block_quote)}(hX^The PCI controller driver should implement the following ops: * write_header: ops to populate configuration space header * set_bar: ops to configure the BAR * clear_bar: ops to reset the BAR * alloc_addr_space: ops to allocate in PCI controller address space * free_addr_space: ops to free the allocated address space * raise_irq: ops to raise a legacy, MSI or MSI-X interrupt * start: ops to start the PCI link * stop: ops to stop the PCI link The PCI controller driver can then create a new EPC device by invoking devm_pci_epc_create()/pci_epc_create(). h](h)}(h=The PCI controller driver should implement the following ops:h]h=The PCI controller driver should implement the following ops:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hjubj)}(hX* write_header: ops to populate configuration space header * set_bar: ops to configure the BAR * clear_bar: ops to reset the BAR * alloc_addr_space: ops to allocate in PCI controller address space * free_addr_space: ops to free the allocated address space * raise_irq: ops to raise a legacy, MSI or MSI-X interrupt * start: ops to start the PCI link * stop: ops to stop the PCI link h]jo)}(hhh](jt)}(h8write_header: ops to populate configuration space headerh]h)}(hjh]h8write_header: ops to populate configuration space header}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK0hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(h!set_bar: ops to configure the BARh]h)}(hjh]h!set_bar: ops to configure the BAR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK1hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(hclear_bar: ops to reset the BARh]h)}(hjh]hclear_bar: ops to reset the BAR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(hAalloc_addr_space: ops to allocate in PCI controller address spaceh]h)}(hjh]hAalloc_addr_space: ops to allocate in PCI controller address space}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK3hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(h8free_addr_space: ops to free the allocated address spaceh]h)}(hjh]h8free_addr_space: ops to free the allocated address space}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK4hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(h8raise_irq: ops to raise a legacy, MSI or MSI-X interrupth]h)}(hjh]h8raise_irq: ops to raise a legacy, MSI or MSI-X interrupt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK5hjubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(h start: ops to start the PCI linkh]h)}(hj.h]h start: ops to start the PCI link}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK6hj,ubah}(h]h ]h"]h$]h&]uh1jshjubjt)}(hstop: ops to stop the PCI link h]h)}(hstop: ops to stop the PCI linkh]hstop: ops to stop the PCI link}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hjCubah}(h]h ]h"]h$]h&]uh1jshjubeh}(h]h ]h"]h$]h&]bullet*uh1jnhhhK0hjubah}(h]h ]h"]h$]h&]uh1jhhhK0hjubh)}(hnThe PCI controller driver can then create a new EPC device by invoking devm_pci_epc_create()/pci_epc_create().h]hnThe PCI controller driver can then create a new EPC device by invoking devm_pci_epc_create()/pci_epc_create().}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hjubeh}(h]h ]h"]h$]h&]uh1jhhhK.hjuubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_destroy() The PCI controller driver can destroy the EPC device created by pci_epc_create() using pci_epc_destroy(). h](h)}(hpci_epc_destroy()h]hpci_epc_destroy()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhK>hjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_linkup() In order to notify all the function devices that the EPC device to which they are linked has established a link with the host, the PCI controller driver should invoke pci_epc_linkup(). h](h)}(hpci_epc_linkup()h]hpci_epc_linkup()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjubj)}(hIn order to notify all the function devices that the EPC device to which they are linked has established a link with the host, the PCI controller driver should invoke pci_epc_linkup(). h]h)}(hIn order to notify all the function devices that the EPC device to which they are linked has established a link with the host, the PCI controller driver should invoke pci_epc_linkup().h]hIn order to notify all the function devices that the EPC device to which they are linked has established a link with the host, the PCI controller driver should invoke pci_epc_linkup().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKChjubah}(h]h ]h"]h$]h&]uh1jhhhKChjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(h^pci_epc_mem_init() Initialize the pci_epc_mem structure used for allocating EPC addr space. h](h)}(hpci_epc_mem_init()h]hpci_epc_mem_init()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKGhjubj)}(hIInitialize the pci_epc_mem structure used for allocating EPC addr space. h]h)}(hHInitialize the pci_epc_mem structure used for allocating EPC addr space.h]hHInitialize the pci_epc_mem structure used for allocating EPC addr space.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKIhjubah}(h]h ]h"]h$]h&]uh1jhhhKIhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(h]pci_epc_mem_exit() Cleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). h](h)}(hpci_epc_mem_exit()h]hpci_epc_mem_exit()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKKhjubj)}(hHCleanup the pci_epc_mem structure allocated during pci_epc_mem_init(). h]h)}(hFCleanup the pci_epc_mem structure allocated during pci_epc_mem_init().h]hFCleanup the pci_epc_mem structure allocated during pci_epc_mem_init().}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKMhj%ubah}(h]h ]h"]h$]h&]uh1jhhhKMhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhK,hjOhhubeh}(h]"apis-for-the-pci-controller-driverah ]h"]"apis for the pci controller driverah$]h&]uh1hhj0hhhhhK'ubh)}(hhh](h)}(h-EPC APIs for the PCI Endpoint Function Driverh]h-EPC APIs for the PCI Endpoint Function Driver}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQhhhhhKQubh)}(hoThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver.h]hoThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKShjQhhubjo)}(hhh](jt)}(hpci_epc_write_header() The PCI endpoint function driver should use pci_epc_write_header() to write the standard configuration header to the endpoint controller. h](h)}(hpci_epc_write_header()h]hpci_epc_write_header()}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKVhjsubj)}(hThe PCI endpoint function driver should use pci_epc_write_header() to write the standard configuration header to the endpoint controller. h]h)}(hThe PCI endpoint function driver should use pci_epc_write_header() to write the standard configuration header to the endpoint controller.h]hThe PCI endpoint function driver should use pci_epc_write_header() to write the standard configuration header to the endpoint controller.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjubah}(h]h ]h"]h$]h&]uh1jhhhKXhjsubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hXDpci_epc_set_bar() The PCI endpoint function driver should use pci_epc_set_bar() to configure the Base Address Register in order for the host to assign PCI addr space. Register space of the function driver is usually configured using this API. Some endpoint controllers also support calling pci_epc_set_bar() again for the same BAR (without calling pci_epc_clear_bar()) to update inbound address translations after the host has programmed the BAR base address. Endpoint function drivers can check this capability via the dynamic_inbound_mapping EPC feature bit. When pci_epf_bar.num_submap is non-zero, the endpoint function driver is requesting BAR subrange mapping using pci_epf_bar.submap. This requires the EPC to advertise support via the subrange_mapping EPC feature bit. When an EPF driver wants to make use of the inbound subrange mapping feature, it requires that the BAR base address has been programmed by the host during enumeration. Thus, it needs to call pci_epc_set_bar() twice for the same BAR (requires dynamic_inbound_mapping): first with num_submap set to zero and configuring the BAR size, then after the PCIe link is up and the host enumerates the endpoint and programs the BAR base address, again with num_submap set to non-zero value. Note that when making use of the inbound subrange mapping feature, the EPF driver must not call pci_epc_clear_bar() between the two pci_epc_set_bar() calls, because clearing the BAR can clear/disable the BAR register or BAR decode on the endpoint while the host still expects the assigned BAR address to remain valid. h](h)}(hpci_epc_set_bar()h]hpci_epc_set_bar()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK[hjubj)}(hXThe PCI endpoint function driver should use pci_epc_set_bar() to configure the Base Address Register in order for the host to assign PCI addr space. Register space of the function driver is usually configured using this API. Some endpoint controllers also support calling pci_epc_set_bar() again for the same BAR (without calling pci_epc_clear_bar()) to update inbound address translations after the host has programmed the BAR base address. Endpoint function drivers can check this capability via the dynamic_inbound_mapping EPC feature bit. When pci_epf_bar.num_submap is non-zero, the endpoint function driver is requesting BAR subrange mapping using pci_epf_bar.submap. This requires the EPC to advertise support via the subrange_mapping EPC feature bit. When an EPF driver wants to make use of the inbound subrange mapping feature, it requires that the BAR base address has been programmed by the host during enumeration. Thus, it needs to call pci_epc_set_bar() twice for the same BAR (requires dynamic_inbound_mapping): first with num_submap set to zero and configuring the BAR size, then after the PCIe link is up and the host enumerates the endpoint and programs the BAR base address, again with num_submap set to non-zero value. Note that when making use of the inbound subrange mapping feature, the EPF driver must not call pci_epc_clear_bar() between the two pci_epc_set_bar() calls, because clearing the BAR can clear/disable the BAR register or BAR decode on the endpoint while the host still expects the assigned BAR address to remain valid. h](h)}(hThe PCI endpoint function driver should use pci_epc_set_bar() to configure the Base Address Register in order for the host to assign PCI addr space. Register space of the function driver is usually configured using this API.h]hThe PCI endpoint function driver should use pci_epc_set_bar() to configure the Base Address Register in order for the host to assign PCI addr space. Register space of the function driver is usually configured using this API.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK]hjubh)}(hX=Some endpoint controllers also support calling pci_epc_set_bar() again for the same BAR (without calling pci_epc_clear_bar()) to update inbound address translations after the host has programmed the BAR base address. Endpoint function drivers can check this capability via the dynamic_inbound_mapping EPC feature bit.h]hX=Some endpoint controllers also support calling pci_epc_set_bar() again for the same BAR (without calling pci_epc_clear_bar()) to update inbound address translations after the host has programmed the BAR base address. Endpoint function drivers can check this capability via the dynamic_inbound_mapping EPC feature bit.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKbhjubh)}(hWhen pci_epf_bar.num_submap is non-zero, the endpoint function driver is requesting BAR subrange mapping using pci_epf_bar.submap. This requires the EPC to advertise support via the subrange_mapping EPC feature bit.h]hWhen pci_epf_bar.num_submap is non-zero, the endpoint function driver is requesting BAR subrange mapping using pci_epf_bar.submap. This requires the EPC to advertise support via the subrange_mapping EPC feature bit.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhjubh)}(hXWhen an EPF driver wants to make use of the inbound subrange mapping feature, it requires that the BAR base address has been programmed by the host during enumeration. Thus, it needs to call pci_epc_set_bar() twice for the same BAR (requires dynamic_inbound_mapping): first with num_submap set to zero and configuring the BAR size, then after the PCIe link is up and the host enumerates the endpoint and programs the BAR base address, again with num_submap set to non-zero value.h]hXWhen an EPF driver wants to make use of the inbound subrange mapping feature, it requires that the BAR base address has been programmed by the host during enumeration. Thus, it needs to call pci_epc_set_bar() twice for the same BAR (requires dynamic_inbound_mapping): first with num_submap set to zero and configuring the BAR size, then after the PCIe link is up and the host enumerates the endpoint and programs the BAR base address, again with num_submap set to non-zero value.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKlhjubh)}(hX=Note that when making use of the inbound subrange mapping feature, the EPF driver must not call pci_epc_clear_bar() between the two pci_epc_set_bar() calls, because clearing the BAR can clear/disable the BAR register or BAR decode on the endpoint while the host still expects the assigned BAR address to remain valid.h]hX=Note that when making use of the inbound subrange mapping feature, the EPF driver must not call pci_epc_clear_bar() between the two pci_epc_set_bar() calls, because clearing the BAR can clear/disable the BAR register or BAR decode on the endpoint while the host still expects the assigned BAR address to remain valid.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKthjubeh}(h]h ]h"]h$]h&]uh1jhhhK]hjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hipci_epc_clear_bar() The PCI endpoint function driver should use pci_epc_clear_bar() to reset the BAR. h](h)}(hpci_epc_clear_bar()h]hpci_epc_clear_bar()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKzhj ubj)}(hRThe PCI endpoint function driver should use pci_epc_clear_bar() to reset the BAR. h]h)}(hQThe PCI endpoint function driver should use pci_epc_clear_bar() to reset the BAR.h]hQThe PCI endpoint function driver should use pci_epc_clear_bar() to reset the BAR.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK|hjubah}(h]h ]h"]h$]h&]uh1jhhhK|hj ubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_raise_irq() The PCI endpoint function driver should use pci_epc_raise_irq() to raise Legacy Interrupt, MSI or MSI-X Interrupt. h](h)}(hpci_epc_raise_irq()h]hpci_epc_raise_irq()}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj;ubj)}(hsThe PCI endpoint function driver should use pci_epc_raise_irq() to raise Legacy Interrupt, MSI or MSI-X Interrupt. h]h)}(hrThe PCI endpoint function driver should use pci_epc_raise_irq() to raise Legacy Interrupt, MSI or MSI-X Interrupt.h]hrThe PCI endpoint function driver should use pci_epc_raise_irq() to raise Legacy Interrupt, MSI or MSI-X Interrupt.}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjMubah}(h]h ]h"]h$]h&]uh1jhhhKhj;ubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_mem_alloc_addr() The PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to allocate memory address from EPC addr space which is required to access RC's buffer h](h)}(hpci_epc_mem_alloc_addr()h]hpci_epc_mem_alloc_addr()}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjkubj)}(hThe PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to allocate memory address from EPC addr space which is required to access RC's buffer h]h)}(hThe PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to allocate memory address from EPC addr space which is required to access RC's bufferh]hThe PCI endpoint function driver should use pci_epc_mem_alloc_addr(), to allocate memory address from EPC addr space which is required to access RC’s buffer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj}ubah}(h]h ]h"]h$]h&]uh1jhhhKhjkubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_mem_free_addr() The PCI endpoint function driver should use pci_epc_mem_free_addr() to free the memory space allocated using pci_epc_mem_alloc_addr(). h](h)}(hpci_epc_mem_free_addr()h]hpci_epc_mem_free_addr()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hThe PCI endpoint function driver should use pci_epc_mem_free_addr() to free the memory space allocated using pci_epc_mem_alloc_addr(). h]h)}(hThe PCI endpoint function driver should use pci_epc_mem_free_addr() to free the memory space allocated using pci_epc_mem_alloc_addr().h]hThe PCI endpoint function driver should use pci_epc_mem_free_addr() to free the memory space allocated using pci_epc_mem_alloc_addr().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_map_addr() A PCI endpoint function driver should use pci_epc_map_addr() to map to a RC PCI address the CPU address of local memory obtained with pci_epc_mem_alloc_addr(). h](h)}(hpci_epc_map_addr()h]hpci_epc_map_addr()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hA PCI endpoint function driver should use pci_epc_map_addr() to map to a RC PCI address the CPU address of local memory obtained with pci_epc_mem_alloc_addr().h]hA PCI endpoint function driver should use pci_epc_map_addr() to map to a RC PCI address the CPU address of local memory obtained with pci_epc_mem_alloc_addr().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_unmap_addr() A PCI endpoint function driver should use pci_epc_unmap_addr() to unmap the CPU address of local memory mapped to a RC address with pci_epc_map_addr(). h](h)}(hpci_epc_unmap_addr()h]hpci_epc_unmap_addr()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hA PCI endpoint function driver should use pci_epc_unmap_addr() to unmap the CPU address of local memory mapped to a RC address with pci_epc_map_addr().h]hA PCI endpoint function driver should use pci_epc_unmap_addr() to unmap the CPU address of local memory mapped to a RC address with pci_epc_map_addr().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hXpci_epc_mem_map() A PCI endpoint controller may impose constraints on the RC PCI addresses that can be mapped. The function pci_epc_mem_map() allows endpoint function drivers to allocate and map controller memory while handling such constraints. This function will determine the size of the memory that must be allocated with pci_epc_mem_alloc_addr() for successfully mapping a RC PCI address range. This function will also indicate the size of the PCI address range that was actually mapped, which can be less than the requested size, as well as the offset into the allocated memory to use for accessing the mapped RC PCI address range. h](h)}(hpci_epc_mem_map()h]hpci_epc_mem_map()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXkA PCI endpoint controller may impose constraints on the RC PCI addresses that can be mapped. The function pci_epc_mem_map() allows endpoint function drivers to allocate and map controller memory while handling such constraints. This function will determine the size of the memory that must be allocated with pci_epc_mem_alloc_addr() for successfully mapping a RC PCI address range. This function will also indicate the size of the PCI address range that was actually mapped, which can be less than the requested size, as well as the offset into the allocated memory to use for accessing the mapped RC PCI address range.h]hXkA PCI endpoint controller may impose constraints on the RC PCI addresses that can be mapped. The function pci_epc_mem_map() allows endpoint function drivers to allocate and map controller memory while handling such constraints. This function will determine the size of the memory that must be allocated with pci_epc_mem_alloc_addr() for successfully mapping a RC PCI address range. This function will also indicate the size of the PCI address range that was actually mapped, which can be less than the requested size, as well as the offset into the allocated memory to use for accessing the mapped RC PCI address range.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubjt)}(hpci_epc_mem_unmap() A PCI endpoint function driver can use pci_epc_mem_unmap() to unmap and free controller memory that was allocated and mapped using pci_epc_mem_map(). h](h)}(hpci_epc_mem_unmap()h]hpci_epc_mem_unmap()}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj=ubh)}(hA PCI endpoint function driver can use pci_epc_mem_unmap() to unmap and free controller memory that was allocated and mapped using pci_epc_mem_map().h]hA PCI endpoint function driver can use pci_epc_mem_unmap() to unmap and free controller memory that was allocated and mapped using pci_epc_mem_map().}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj=ubeh}(h]h ]h"]h$]h&]uh1jshjphhhhhNubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhKVhjQhhubeh}(h]-epc-apis-for-the-pci-endpoint-function-driverah ]h"]-epc apis for the pci endpoint function driverah$]h&]uh1hhj0hhhhhKQubh)}(hhh](h)}(hOther EPC APIsh]hOther EPC APIs}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqhhhhhKubh)}(hThere are other APIs provided by the EPC library. These are used for binding the EPF device with EPC device. pci-ep-cfs.c can be used as reference for using these APIs.h]hThere are other APIs provided by the EPC library. These are used for binding the EPF device with EPC device. pci-ep-cfs.c can be used as reference for using these APIs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqhhubjo)}(hhh](jt)}(hlpci_epc_get() Get a reference to the PCI endpoint controller based on the device name of the controller. h](h)}(h pci_epc_get()h]h pci_epc_get()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(h[Get a reference to the PCI endpoint controller based on the device name of the controller. h]h)}(hZGet a reference to the PCI endpoint controller based on the device name of the controller.h]hZGet a reference to the PCI endpoint controller based on the device name of the controller.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hcpci_epc_put() Release the reference to the PCI endpoint controller obtained using pci_epc_get() h](h)}(h pci_epc_put()h]h pci_epc_put()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hRRelease the reference to the PCI endpoint controller obtained using pci_epc_get() h]h)}(hQRelease the reference to the PCI endpoint controller obtained using pci_epc_get()h]hQRelease the reference to the PCI endpoint controller obtained using pci_epc_get()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hpci_epc_add_epf() Add a PCI endpoint function to a PCI endpoint controller. A PCIe device can have up to 8 functions according to the specification. h](h)}(hpci_epc_add_epf()h]hpci_epc_add_epf()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hAdd a PCI endpoint function to a PCI endpoint controller. A PCIe device can have up to 8 functions according to the specification. h]h)}(hAdd a PCI endpoint function to a PCI endpoint controller. A PCIe device can have up to 8 functions according to the specification.h]hAdd a PCI endpoint function to a PCI endpoint controller. A PCIe device can have up to 8 functions according to the specification.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hVpci_epc_remove_epf() Remove the PCI endpoint function from PCI endpoint controller. h](h)}(hpci_epc_remove_epf()h]hpci_epc_remove_epf()}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj#ubj)}(h?Remove the PCI endpoint function from PCI endpoint controller. h]h)}(h>Remove the PCI endpoint function from PCI endpoint controller.h]h>Remove the PCI endpoint function from PCI endpoint controller.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj5ubah}(h]h ]h"]h$]h&]uh1jhhhKhj#ubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hpci_epc_start() The PCI endpoint function driver should invoke pci_epc_start() once it has configured the endpoint function and wants to start the PCI link. h](h)}(hpci_epc_start()h]hpci_epc_start()}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjSubj)}(hThe PCI endpoint function driver should invoke pci_epc_start() once it has configured the endpoint function and wants to start the PCI link. h]h)}(hThe PCI endpoint function driver should invoke pci_epc_start() once it has configured the endpoint function and wants to start the PCI link.h]hThe PCI endpoint function driver should invoke pci_epc_start() once it has configured the endpoint function and wants to start the PCI link.}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjeubah}(h]h ]h"]h$]h&]uh1jhhhKhjSubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hgpci_epc_stop() The PCI endpoint function driver should invoke pci_epc_stop() to stop the PCI LINK. h](h)}(hpci_epc_stop()h]hpci_epc_stop()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hUThe PCI endpoint function driver should invoke pci_epc_stop() to stop the PCI LINK. h]h)}(hSThe PCI endpoint function driver should invoke pci_epc_stop() to stop the PCI LINK.h]hSThe PCI endpoint function driver should invoke pci_epc_stop() to stop the PCI LINK.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhKhjqhhubeh}(h]other-epc-apisah ]h"]other epc apisah$]h&]uh1hhj0hhhhhKubeh}(h]#pci-endpoint-controller-epc-libraryah ]h"]$pci endpoint controller(epc) libraryah$]h&]uh1hhjhhhhhK ubh)}(hhh](h)}(h"PCI Endpoint Function(EPF) Libraryh]h"PCI Endpoint Function(EPF) Library}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(h{The EPF library provides APIs to be used by the function driver and the EPC library to provide endpoint mode functionality.h]h{The EPF library provides APIs to be used by the function driver and the EPC library to provide endpoint mode functionality.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hhh](h)}(h-EPF APIs for the PCI Endpoint Function Driverh]h-EPF APIs for the PCI Endpoint Function Driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hoThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver.h]hoThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint function driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjo)}(hhh](jt)}(hXpci_epf_register_driver() The PCI Endpoint Function driver should implement the following ops: * bind: ops to perform when an EPC device has been bound to EPF device * unbind: ops to perform when a binding has been lost between an EPC device and EPF device * add_cfs: optional ops to create function specific configfs attributes The PCI Function driver can then register the PCI EPF driver by using pci_epf_register_driver(). h](h)}(hpci_epf_register_driver()h]hpci_epf_register_driver()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubj)}(hXQThe PCI Endpoint Function driver should implement the following ops: * bind: ops to perform when an EPC device has been bound to EPF device * unbind: ops to perform when a binding has been lost between an EPC device and EPF device * add_cfs: optional ops to create function specific configfs attributes h]hdefinition_list)}(hhh]hdefinition_list_item)}(hX3The PCI Endpoint Function driver should implement the following ops: * bind: ops to perform when an EPC device has been bound to EPF device * unbind: ops to perform when a binding has been lost between an EPC device and EPF device * add_cfs: optional ops to create function specific configfs attributes h](hterm)}(hDThe PCI Endpoint Function driver should implement the following ops:h]hDThe PCI Endpoint Function driver should implement the following ops:}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1j+hhhKhj'ubh definition)}(hhh]jo)}(hhh](jt)}(hDbind: ops to perform when an EPC device has been bound to EPF deviceh]h)}(hjEh]hDbind: ops to perform when an EPC device has been bound to EPF device}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjCubah}(h]h ]h"]h$]h&]uh1jshj@ubjt)}(hXunbind: ops to perform when a binding has been lost between an EPC device and EPF deviceh]h)}(hXunbind: ops to perform when a binding has been lost between an EPC device and EPF deviceh]hXunbind: ops to perform when a binding has been lost between an EPC device and EPF device}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjZubah}(h]h ]h"]h$]h&]uh1jshj@ubjt)}(hFadd_cfs: optional ops to create function specific configfs attributes h]h)}(hEadd_cfs: optional ops to create function specific configfs attributesh]hEadd_cfs: optional ops to create function specific configfs attributes}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjrubah}(h]h ]h"]h$]h&]uh1jshj@ubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhKhj=ubah}(h]h ]h"]h$]h&]uh1j;hj'ubeh}(h]h ]h"]h$]h&]uh1j%hhhKhj"ubah}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1jhhhKhj ubh)}(h`The PCI Function driver can then register the PCI EPF driver by using pci_epf_register_driver().h]h`The PCI Function driver can then register the PCI EPF driver by using pci_epf_register_driver().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(h}pci_epf_unregister_driver() The PCI Function driver can unregister the PCI EPF driver by using pci_epf_unregister_driver(). h](h)}(hpci_epf_unregister_driver()h]hpci_epf_unregister_driver()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h_The PCI Function driver can unregister the PCI EPF driver by using pci_epf_unregister_driver().h]h_The PCI Function driver can unregister the PCI EPF driver by using pci_epf_unregister_driver().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(htpci_epf_alloc_space() The PCI Function driver can allocate space for a particular BAR using pci_epf_alloc_space(). h](h)}(hpci_epf_alloc_space()h]hpci_epf_alloc_space()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h\The PCI Function driver can allocate space for a particular BAR using pci_epf_alloc_space().h]h\The PCI Function driver can allocate space for a particular BAR using pci_epf_alloc_space().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hpci_epf_free_space() The PCI Function driver can free the allocated space (using pci_epf_alloc_space) by invoking pci_epf_free_space(). h](h)}(hpci_epf_free_space()h]hpci_epf_free_space()}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hrThe PCI Function driver can free the allocated space (using pci_epf_alloc_space) by invoking pci_epf_free_space().h]hrThe PCI Function driver can free the allocated space (using pci_epf_alloc_space) by invoking pci_epf_free_space().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhKhjhhubeh}(h]-epf-apis-for-the-pci-endpoint-function-driverah ]h"]-epf apis for the pci endpoint function driverah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h,APIs for the PCI Endpoint Controller Libraryh]h,APIs for the PCI Endpoint Controller Library}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj<hhhhhKubh)}(hrThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint controller library.h]hrThis section lists the APIs that the PCI Endpoint core provides to be used by the PCI endpoint controller library.}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj<hhubjo)}(hhh]jt)}(hpci_epf_linkup() The PCI endpoint controller library invokes pci_epf_linkup() when the EPC device has established the connection to the host. h](h)}(hpci_epf_linkup()h]hpci_epf_linkup()}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj^ubj)}(h}The PCI endpoint controller library invokes pci_epf_linkup() when the EPC device has established the connection to the host. h]h)}(h|The PCI endpoint controller library invokes pci_epf_linkup() when the EPC device has established the connection to the host.h]h|The PCI endpoint controller library invokes pci_epf_linkup() when the EPC device has established the connection to the host.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjpubah}(h]h ]h"]h$]h&]uh1jhhhMhj^ubeh}(h]h ]h"]h$]h&]uh1jshj[hhhhhNubah}(h]h ]h"]h$]h&]jajbuh1jnhhhKhj<hhubeh}(h],apis-for-the-pci-endpoint-controller-libraryah ]h"],apis for the pci endpoint controller libraryah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(hOther EPF APIsh]hOther EPF APIs}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hThere are other APIs provided by the EPF library. These are used to notify the function driver when the EPF device is bound to the EPC device. pci-ep-cfs.c can be used as reference for using these APIs.h]hThere are other APIs provided by the EPF library. These are used to notify the function driver when the EPF device is bound to the EPC device. pci-ep-cfs.c can be used as reference for using these APIs.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjo)}(hhh](jt)}(hpci_epf_create() Create a new PCI EPF device by passing the name of the PCI EPF device. This name will be used to bind the EPF device to a EPF driver. h](h)}(hpci_epf_create()h]hpci_epf_create()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubj)}(hCreate a new PCI EPF device by passing the name of the PCI EPF device. This name will be used to bind the EPF device to a EPF driver. h]h)}(hCreate a new PCI EPF device by passing the name of the PCI EPF device. This name will be used to bind the EPF device to a EPF driver.h]hCreate a new PCI EPF device by passing the name of the PCI EPF device. This name will be used to bind the EPF device to a EPF driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhhhM hjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(h8pci_epf_destroy() Destroy the created PCI EPF device. h](h)}(hpci_epf_destroy()h]hpci_epf_destroy()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(h$Destroy the created PCI EPF device. h]h)}(h#Destroy the created PCI EPF device.h]h#Destroy the created PCI EPF device.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hhpci_epf_bind() pci_epf_bind() should be invoked when the EPF device has been bound to an EPC device. h](h)}(hpci_epf_bind()h]hpci_epf_bind()}(hj" hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj)}(hVpci_epf_bind() should be invoked when the EPF device has been bound to an EPC device. h]h)}(hUpci_epf_bind() should be invoked when the EPF device has been bound to an EPC device.h]hUpci_epf_bind() should be invoked when the EPF device has been bound to an EPC device.}(hj4 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0 ubah}(h]h ]h"]h$]h&]uh1jhhhMhj ubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubjt)}(hrpci_epf_unbind() pci_epf_unbind() should be invoked when the binding between EPC device and EPF device is lost.h](h)}(hpci_epf_unbind()h]hpci_epf_unbind()}(hjR hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjN ubj)}(h^pci_epf_unbind() should be invoked when the binding between EPC device and EPF device is lost.h]h)}(h^pci_epf_unbind() should be invoked when the binding between EPC device and EPF device is lost.h]h^pci_epf_unbind() should be invoked when the binding between EPC device and EPF device is lost.}(hjd hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj` ubah}(h]h ]h"]h$]h&]uh1jhhhMhjN ubeh}(h]h ]h"]h$]h&]uh1jshjhhhhhNubeh}(h]h ]h"]h$]h&]jajbuh1jnhhhM hjhhubeh}(h]other-epf-apisah ]h"]other epf apisah$]h&]uh1hhjhhhhhMubeh}(h]!pci-endpoint-function-epf-libraryah ]h"]"pci endpoint function(epf) libraryah$]h&]uh1hhjhhhhhKubeh}(h]pci-endpoint-coreah ]h"]pci endpoint coreah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_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_handlerj error_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}substitution_names}refnames}refids}nameids}(jj j j jjjNjKjnjkjjj j j9j6jjj j u nametypes}(jj jjNjnjj j9jj uh}(j hj jjj0jKjOjkjQjjqj jj6jjj<j ju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.