Add a README for vm_payload
Add a summary of the API and how it should be used, woth links to
other relevant documentation.
Also add proper documentation for AVmPayload_main().
Bug: 259237660
Test: n/a
Change-Id: I4d8c15763b712653d9686a4b00a23d59118f9661
diff --git a/vm_payload/include/vm_main.h b/vm_payload/include/vm_main.h
index e351174..5158b43 100644
--- a/vm_payload/include/vm_main.h
+++ b/vm_payload/include/vm_main.h
@@ -23,5 +23,17 @@
}
#else
typedef int AVmPayload_main_t(void);
+
+/**
+ * Entry point for the VM payload. This function must be implemented by the
+ * payload binary, and is called by Microdroid to start the payload inside the
+ * VM.
+ *
+ * When the function returns the VM will be shut down. If the host app has set
+ * a `VirtualMachineCallback` for the VM, its `onPayloadFinished` method will be
+ * called with the VM's exit code.
+ *
+ * \return the exit code of the VM.
+ */
extern int AVmPayload_main(void);
#endif