Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions libsel4vm/docs/libsel4vm_arm_guest_vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Register a callback for processing unhandled vcpu faults

- 0 on success, -1 on error

Back to [interface description](#module-guest_vm_archh).
Back to [interface description](#interface-guest_vm_archh).


## Structs
Expand All @@ -57,7 +57,7 @@ Structure representing ARM specific vcpu properties
- `unhandled_vcpu_callback {unhandled_vcpu_fault_callback_fn}`: A callback for processing unhandled vcpu faults
- `unhandled_vcpu_callback_cookie {void *}`: A cookie to supply to the vcpu fault handler

Back to [interface description](#module-guest_vm_archh).
Back to [interface description](#interface-guest_vm_archh).


Back to [top](#).
Expand Down
6 changes: 3 additions & 3 deletions libsel4vm/docs/libsel4vm_boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Initialise/Create VM

- 0 on success, otherwise -1 for error

Back to [interface description](#module-booth).
Back to [interface description](#interface-booth).

### Function `vm_create_vcpu(vm, priority)`

Expand All @@ -56,7 +56,7 @@ Create a VCPU for a given VM

- NULL for error, otherwise pointer to created vm_vcpu_t object

Back to [interface description](#module-booth).
Back to [interface description](#interface-booth).

### Function `vm_assign_vcpu_target(vcpu, target_cpu)`

Expand All @@ -71,7 +71,7 @@ Assign a vcpu with logical target cpu to run on

- -1 for error, otherwise 0 for success

Back to [interface description](#module-booth).
Back to [interface description](#interface-booth).


Back to [top](#).
Expand Down
12 changes: 6 additions & 6 deletions libsel4vm/docs/libsel4vm_guest_arm_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Set a VCPU's thread registers given a TCB user context

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).

### Function `vm_set_thread_context_reg(vcpu, reg, value)`

Expand All @@ -60,7 +60,7 @@ Set a single VCPU's TCB register

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).

### Function `vm_get_thread_context(vcpu, context)`

Expand All @@ -75,7 +75,7 @@ Get a VCPU's TCB user context

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).

### Function `vm_get_thread_context_reg(vcpu, reg, value)`

Expand All @@ -91,7 +91,7 @@ Get a single VCPU's TCB register

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).

### Function `vm_set_arm_vcpu_reg(vcpu, reg, value)`

Expand All @@ -107,7 +107,7 @@ Set an ARM VCPU register

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).

### Function `vm_get_arm_vcpu_reg(vcpu, reg, value)`

Expand All @@ -123,7 +123,7 @@ Get an ARM VCPU register

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_arm_contexth).
Back to [interface description](#interface-guest_arm_contexth).


Back to [top](#).
Expand Down
2 changes: 1 addition & 1 deletion libsel4vm/docs/libsel4vm_guest_iospace.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Attach an additional IO space to the given VM

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_iospaceh).
Back to [interface description](#interface-guest_iospaceh).


Back to [top](#).
Expand Down
8 changes: 4 additions & 4 deletions libsel4vm/docs/libsel4vm_guest_irq_controller.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Inject an IRQ into a VM's interrupt controller

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_irq_controllerh).
Back to [interface description](#interface-guest_irq_controllerh).

### Function `vm_set_irq_level(vcpu, irq, irq_level)`

Expand All @@ -55,7 +55,7 @@ Set level of IRQ number into a VM's interrupt controller

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_irq_controllerh).
Back to [interface description](#interface-guest_irq_controllerh).

### Function `vm_register_irq(vcpu, irq, ack_fn, cookie)`

Expand All @@ -72,7 +72,7 @@ Register irq with an acknowledgment function

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_irq_controllerh).
Back to [interface description](#interface-guest_irq_controllerh).

### Function `vm_create_default_irq_controller(vm)`

Expand All @@ -86,7 +86,7 @@ Install the default interrupt controller into the VM

- 0 on success, otherwise -1 for error

Back to [interface description](#module-guest_irq_controllerh).
Back to [interface description](#interface-guest_irq_controllerh).


Back to [top](#).
Expand Down
16 changes: 8 additions & 8 deletions libsel4vm/docs/libsel4vm_guest_memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Reserve a region of the VM's memory at a given base address

- NULL on failure otherwise a pointer to a reservation object representing the reserved region

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_reserve_anon_memory(vm, size, align, fault_callback, cookie, addr)`

Expand All @@ -79,7 +79,7 @@ through the `vm_memory_make_anon` function.

- NULL on failure otherwise a pointer to a reservation object representing the reserved region

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_free_reserved_memory(vm, reservation)`

Expand All @@ -94,7 +94,7 @@ Free memory reservation from the VM

- -1 on failure otherwise 0 for success

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_map_reservation(vm, reservation, map_iterator, cookie)`

Expand All @@ -111,7 +111,7 @@ Map a reservation into the VM's virtual address space

- -1 on failure otherwise 0 for success

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_map_reservation_frames(vm, reservation, frames, num_frames, frame_size_bits)`

Expand All @@ -129,7 +129,7 @@ Map a reservation into the VM's virtual address space from given frames

- -1 on failure otherwise 0 for success

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_get_reservation_memory_region(reservation, addr, size)`

Expand All @@ -145,7 +145,7 @@ Get the memory region information (address & size) from a given reservation

No return

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).

### Function `vm_memory_init(vm)`

Expand All @@ -159,7 +159,7 @@ Initialise a VM's memory management interface

- -1 on failure otherwise 0 for success

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).


## Structs
Expand All @@ -177,7 +177,7 @@ Structure representing a mappable memory frame
- `vaddr {uintptr_t}`: Virtual address of which to map the frame into
- `size_bits {size_t}`: Size of frame in bits

Back to [interface description](#module-guest_memoryh).
Back to [interface description](#interface-guest_memoryh).


Back to [top](#).
Expand Down
2 changes: 1 addition & 1 deletion libsel4vm/docs/libsel4vm_guest_memory_helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Useful to avoid having to re-define a fault callback on regions that should be m

- Always returns FAULT_ERROR

Back to [interface description](#module-guest_memory_helpersh).
Back to [interface description](#interface-guest_memory_helpersh).


Back to [top](#).
Expand Down
18 changes: 9 additions & 9 deletions libsel4vm/docs/libsel4vm_guest_ram.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Common guest ram touch callback for reading from a guest address into a user sup

- 0 on success, -1 on error

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_guest_ram_write_callback(vm, guest_addr, vaddr, size, offset, buf)`

Expand All @@ -72,7 +72,7 @@ Common guest ram touch callback for writing a user supplied buffer into a guest

- 0 on success, -1 on error

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_touch(vm, addr, size, touch_callback, cookie)`

Expand All @@ -90,7 +90,7 @@ Touch a series of pages in the guest vm and invoke a callback for each page acce

- 0 on success, -1 on error

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_find_largest_free_region(vm, addr, size)`

Expand All @@ -106,7 +106,7 @@ Find the largest free ram region

- -1 on failure, otherwise 0 for success

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_register(vm, bytes)`

Expand All @@ -121,7 +121,7 @@ Reserve a region of memory for RAM in the guest VM

- Starting address of registered ram region

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_register_at(vm, start, bytes, untyped)`

Expand All @@ -138,7 +138,7 @@ Reserve a region of memory for RAM in the guest VM at a starting guest physical

- 0 on success, -1 on error

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_mark_allocated(vm, start, bytes)`

Expand All @@ -154,7 +154,7 @@ Mark a registered region of RAM as allocated

No return

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_allocate(vm, bytes)`

Expand All @@ -169,7 +169,7 @@ Allocate a region of registered ram

- Starting address of allocated ram region

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).

### Function `vm_ram_free(vm, start, bytes)`

Expand All @@ -185,7 +185,7 @@ Free a RAM a previously allocated RAM region

No return

Back to [interface description](#module-guest_ramh).
Back to [interface description](#interface-guest_ramh).


Back to [top](#).
Expand Down
20 changes: 10 additions & 10 deletions libsel4vm/docs/libsel4vm_guest_vcpu_fault.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Get current fault address of vcpu

- Current fault address of vcpu

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `get_vcpu_fault_ip(vcpu)`

Expand All @@ -65,7 +65,7 @@ Get instruction pointer of current vcpu fault

- Intruction pointer of vcpu fault

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `get_vcpu_fault_data(vcpu)`

Expand All @@ -79,7 +79,7 @@ Get the data of the current vcpu fault

- Data of vcpu fault

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `get_vcpu_fault_data_mask(vcpu)`

Expand All @@ -93,7 +93,7 @@ Get data mask of the current vcpu fault

- Data mask of vcpu fault

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `get_vcpu_fault_size(vcpu)`

Expand All @@ -107,7 +107,7 @@ Get access size of the current vcpu fault

- Access size of vcpu fault

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `is_vcpu_read_fault(vcpu)`

Expand All @@ -121,7 +121,7 @@ Is current vcpu fault a read fault

- True if read fault, False if write fault

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `set_vcpu_fault_data(vcpu, data)`

Expand All @@ -136,7 +136,7 @@ Set the data of the current vcpu fault

- 0 for success, otherwise -1 for error

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `emulate_vcpu_fault(vcpu, data)`

Expand All @@ -151,7 +151,7 @@ Emulate a read or write fault on a given data value

- Emulation result of vcpu fault over given data value

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `advance_vcpu_fault(vcpu)`

Expand All @@ -165,7 +165,7 @@ Advance the current vcpu fault to the next stage/instruction

No return

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).

### Function `restart_vcpu_fault(vcpu)`

Expand All @@ -179,7 +179,7 @@ Restart the current vcpu fault

No return

Back to [interface description](#module-guest_vcpu_faulth).
Back to [interface description](#interface-guest_vcpu_faulth).


Back to [top](#).
Expand Down
Loading