manual: Friendly names for arch-specific methods

This commit is contained in:
Stephen Sherratt 2017-05-24 17:10:00 +10:00
parent c4500519a5
commit c2ca76a3eb
4 changed files with 49 additions and 34 deletions

View file

@ -44,28 +44,29 @@
<param dir="in" name="rights" type="seL4_CapRights_t"/>
<param dir="in" name="ioaddr" type="seL4_Word"/>
</method>
<method id="ARMPageClean_Data" name="Clean_Data">
<method id="ARMPageClean_Data" name="Clean_Data" manual_name="Clean Data">
<param dir="in" name="start_offset" type="seL4_Word"/>
<param dir="in" name="end_offset" type="seL4_Word"/>
</method>
<method id="ARMPageInvalidate_Data" name="Invalidate_Data">
<method id="ARMPageInvalidate_Data" name="Invalidate_Data" manual_name="Invalidate Data">
<param dir="in" name="start_offset" type="seL4_Word"/>
<param dir="in" name="end_offset" type="seL4_Word"/>
</method>
<method id="ARMPageCleanInvalidate_Data" name="CleanInvalidate_Data">
<method id="ARMPageCleanInvalidate_Data" name="CleanInvalidate_Data"
manual_name="Clean and Invalidate Data">
<param dir="in" name="start_offset" type="seL4_Word"/>
<param dir="in" name="end_offset" type="seL4_Word"/>
</method>
<method id="ARMPageUnify_Instruction" name="Unify_Instruction">
<method id="ARMPageUnify_Instruction" name="Unify_Instruction" manual_name="Unify Instruction">
<param dir="in" name="start_offset" type="seL4_Word"/>
<param dir="in" name="end_offset" type="seL4_Word"/>
</method>
<method id="ARMPageGetAddress" name="GetAddress">
<method id="ARMPageGetAddress" name="GetAddress" manual_name="Get Address">
<param dir="out" name="paddr" type="seL4_Word"/>
</method>
</interface>
<interface name="seL4_ARM_ASIDControl" manual_name="ASID Control">
<method id="ARMASIDControlMakePool" name="MakePool">
<method id="ARMASIDControlMakePool" name="MakePool" manual_name="Make Pool">
<param dir="in" name="untyped" type="seL4_Untyped"/>
<param dir="in" name="root" type="seL4_CNode"/>
<param dir="in" name="index" type="seL4_Word"/>
@ -73,7 +74,8 @@
</method>
</interface>
<interface name="seL4_ARM_ASIDPool" manual_name="ASID Pool">
<method id="ARMASIDPoolAssign" name="Assign" manual_label="asidpool_assign">
<method id="ARMASIDPoolAssign" name="Assign" manual_label="asidpool_assign"
manual_name="Asid Pool Assign">
<param dir="in" name="vroot" type="seL4_CPtr"/>
</method>
</interface>

View file

@ -18,7 +18,8 @@
<member name="edi"/>
<member name="ebp"/>
</struct>
<interface name="seL4_X86_PageDirectory" manual_name="Page Directory">
<interface name="seL4_X86_PageDirectory" manual_name="Page Directory"
cap_description="Capability to the page directory being operated on">
<method id="X86PageDirectoryMap" name="Map">
<param dir="in" name="vroot" type="seL4_CPtr"/>
<param dir="in" name="vaddr" type="seL4_Word"/>
@ -26,7 +27,7 @@
</method>
<method id="X86PageDirectoryUnmap" name="Unmap">
</method>
<method id="X86PageDirectoryGetStatusBits" name="GetStatusBits">
<method id="X86PageDirectoryGetStatusBits" name="GetStatusBits" manual_name="Get Status Bits">
<param dir="in" name="vaddr" type="seL4_Word"/>
<param dir="out" name="accessed" type="seL4_Word"/>
<param dir="out" name="dirty" type="seL4_Word"/>
@ -65,15 +66,15 @@
<param dir="in" name="attr" type="seL4_X86_VMAttributes"/>
</method>
<method id="X86PageUnmap" name="Unmap"/>
<method id="X86PageMapIO" name="MapIO">
<method id="X86PageMapIO" name="MapIO" manual_name="Map IO">
<param dir="in" name="iospace" type="seL4_X86_IOSpace"/>
<param dir="in" name="rights" type="seL4_CapRights_t"/>
<param dir="in" name="ioaddr" type="seL4_Word"/>
</method>
<method id="X86PageGetAddress" name="GetAddress">
<method id="X86PageGetAddress" name="GetAddress" manual_name="Get Address">
<param dir="out" name="paddr" type="seL4_Word"/>
</method>
<method id="X86PageMapEPT" name="MapEPT" condition="defined(CONFIG_VTX)">
<method id="X86PageMapEPT" name="MapEPT" condition="defined(CONFIG_VTX)" manual_name="Map EPT">
<param dir="in" name="vroot" type="seL4_X86_EPTPML4"/>
<param dir="in" name="vaddr" type="seL4_Word"/>
<param dir="in" name="rights" type="seL4_CapRights_t"/>
@ -82,7 +83,7 @@
</interface>
<interface name="seL4_X86_ASIDControl" manual_name="ASID Control">
<method id="X86ASIDControlMakePool" name="MakePool">
<method id="X86ASIDControlMakePool" name="MakePool" manual_name="Make Pool">
<param dir="in" name="untyped" type="seL4_Untyped"/>
<param dir="in" name="root" type="seL4_CNode"/>
<param dir="in" name="index" type="seL4_Word"/>
@ -124,7 +125,7 @@
</interface>
<interface name="seL4_IRQControl" manual_name="IRQ Control">
<method id="X86IRQIssueIRQHandlerIOAPIC" name="GetIOAPIC">
<method id="X86IRQIssueIRQHandlerIOAPIC" name="GetIOAPIC" manual_name="Get IOAPIC">
<param dir="in" name="root" type="seL4_CNode"/>
<param dir="in" name="index" type="seL4_Word"/>
<param dir="in" name="depth" type="seL4_Word"/>
@ -134,7 +135,7 @@
<param dir="in" name="polarity" type="seL4_Word"/>
<param dir="in" name="vector" type="seL4_Word"/>
</method>
<method id="X86IRQIssueIRQHandlerMSI" name="GetMSI">
<method id="X86IRQIssueIRQHandlerMSI" name="GetMSI" manual_name="Get MSI">
<param dir="in" name="root" type="seL4_CNode"/>
<param dir="in" name="index" type="seL4_Word"/>
<param dir="in" name="depth" type="seL4_Word"/>
@ -146,33 +147,36 @@
</method>
</interface>
<interface name="seL4_TCB" manual_name="TCB">
<method id="TCBSetEPTRoot" name="SetEPTRoot" condition="defined(CONFIG_VTX)">
<method id="TCBSetEPTRoot" name="SetEPTRoot" condition="defined(CONFIG_VTX)" manual_name="Set EPT Root">
<param dir="in" name="vcpu" type="seL4_CPtr"/>
</method>
</interface>
<interface name="seL4_X86_VCPU" manual_name="VCPU">
<method id="X86VCPUSetTCB" name="SetTCB" condition="defined(CONFIG_VTX)">
<method id="X86VCPUSetTCB" name="SetTCB" condition="defined(CONFIG_VTX)" manual_name="Set TCB">
<param dir="in" name="tcb" type="seL4_CNode" />
</method>
<method id="X86VCPUReadVMCS" name="ReadVMCS" condition="defined(CONFIG_VTX)">
<method id="X86VCPUReadVMCS" name="ReadVMCS" condition="defined(CONFIG_VTX)" manual_name="Read VMCS">
<param dir="in" name="field" type="seL4_Word"/>
<param dir="out" name="value" type="seL4_Word"/>
</method>
<method id="X86VCPUWriteVMCS" name="WriteVMCS" condition="defined(CONFIG_VTX)">
<method id="X86VCPUWriteVMCS" name="WriteVMCS" condition="defined(CONFIG_VTX)" manual_name="Write VMCS">
<param dir="in" name="field" type="seL4_Word"/>
<param dir="in" name="value" type="seL4_Word"/>
<param dir="out" name="written" type="seL4_Word"/>
</method>
<method id="X86VCPUEnableIOPort" name="EnableIOPort" condition="defined(CONFIG_VTX)">
<method id="X86VCPUEnableIOPort" name="EnableIOPort" condition="defined(CONFIG_VTX)"
manual_name="Enable IO Port">
<param dir="in" name="ioPort" type="seL4_CNode"/>
<param dir="in" name="low" type="seL4_Word"/>
<param dir="in" name="high" type="seL4_Word"/>
</method>
<method id="X86VCPUDisableIOPort" name="DisableIOPort" condition="defined(CONFIG_VTX)">
<method id="X86VCPUDisableIOPort" name="DisableIOPort" condition="defined(CONFIG_VTX)"
manual_name="Disable IO Port">
<param dir="in" name="low" type="seL4_Word"/>
<param dir="in" name="high" type="seL4_Word"/>
</method>
<method id="X86VCPUWriteRegisters" name="WriteRegisters" condition="defined(CONFIG_VTX)">
<method id="X86VCPUWriteRegisters" name="WriteRegisters" condition="defined(CONFIG_VTX)"
manual_name="Write Registers">
<param dir="in" name="regs" type="seL4_VCPUContext"/>
</method>
</interface>

View file

@ -29,38 +29,43 @@
<member name="r14"/>
</struct>
<interface name="seL4_ARM_PageDirectory" manual_name="Page Directory">
<method id="ARMPDClean_Data" name="Clean_Data">
<method id="ARMPDClean_Data" name="Clean_Data" manual_name="Clean Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPDInvalidate_Data" name="Invalidate_Data">
<method id="ARMPDInvalidate_Data" name="Invalidate_Data" manual_name="Invalidate Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPDCleanInvalidate_Data" name="CleanInvalidate_Data">
<method id="ARMPDCleanInvalidate_Data" name="CleanInvalidate_Data"
manual_name="Clean and Invalidate Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPDUnify_Instruction" name="Unify_Instruction">
<method id="ARMPDUnify_Instruction" name="Unify_Instruction" manual_name="Unify Instruction">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
</interface>
<interface name="seL4_ARM_VCPU" manual_name="VCPU">
<method id="ARMVCPUSetTCB" name="SetTCB" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)">
<method id="ARMVCPUSetTCB" name="SetTCB" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)"
manual_name="Set TCB">
<param dir="in" name="tcb" type="seL4_TCB" />
</method>
<method id="ARMVCPUInjectIRQ" name="InjectIRQ" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)">
<method id="ARMVCPUInjectIRQ" name="InjectIRQ" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)"
manual_name="Inject IRQ">
<param dir="in" name="virq" type="seL4_Uint16"/>
<param dir="in" name="priority" type="seL4_Uint8"/>
<param dir="in" name="group" type="seL4_Uint8"/>
<param dir="in" name="index" type="seL4_Uint8"/>
</method>
<method id="ARMVCPUReadReg" name="ReadRegs" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)">
<method id="ARMVCPUReadReg" name="ReadRegs" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)"
manual_name="Read Registers">
<param dir="in" name="field" type="seL4_Uint32"/>
<param dir="out" name="value" type="seL4_Uint32"/>
</method>
<method id="ARMVCPUWriteReg" name="WriteRegs" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)">
<method id="ARMVCPUWriteReg" name="WriteRegs" condition="defined(CONFIG_ARM_HYPERVISOR_SUPPORT)"
manual_name="Write Registers">
<param dir="in" name="field" type="seL4_Uint32"/>
<param dir="in" name="value" type="seL4_Uint32"/>
</method>

View file

@ -48,19 +48,23 @@
<member name="x28"/>
</struct>
<interface name="seL4_ARM_PageGlobalDirectory" manual_name="Page Global Directory">
<method id="ARMPageGlobalDirectoryClean_Data" name="Clean_Data">
<method id="ARMPageGlobalDirectoryClean_Data" name="Clean_Data"
manual_name="Clean Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPageGlobalDirectoryInvalidate_Data" name="Invalidate_Data">
<method id="ARMPageGlobalDirectoryInvalidate_Data" name="Invalidate_Data"
manual_name="Invalidate Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPageGlobalDirectoryCleanInvalidate_Data" name="CleanInvalidate_Data">
<method id="ARMPageGlobalDirectoryCleanInvalidate_Data" name="CleanInvalidate_Data"
manual_name="Clean and Invalidate Data">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>
<method id="ARMPageGlobalDirectoryUnify_Instruction" name="Unify_Instruction">
<method id="ARMPageGlobalDirectoryUnify_Instruction" name="Unify_Instruction"
manual_name="Unify Instruction">
<param dir="in" name="start" type="seL4_Word"/>
<param dir="in" name="end" type="seL4_Word"/>
</method>