Begin to abstract the ABI.
Different architectures or standards will require different ABIs but
this should be hidden from the Hafnium API. Further changes are required
to support returning multiple registers but that will be hidden from the
API.
Change-Id: I35bc674c35bd4bb4c8c30e02f1075024a3bc44db
diff --git a/inc/vmapi/hf/abi.h b/inc/vmapi/hf/abi.h
new file mode 100644
index 0000000..9866059
--- /dev/null
+++ b/inc/vmapi/hf/abi.h
@@ -0,0 +1,120 @@
+/*
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "hf/types.h"
+
+enum hf_vcpu_run_code {
+ HF_VCPU_RUN_YIELD,
+ HF_VCPU_RUN_WAIT_FOR_INTERRUPT,
+ HF_VCPU_RUN_WAKE_UP,
+ HF_VCPU_RUN_MESSAGE,
+ HF_VCPU_RUN_SLEEP,
+};
+
+struct hf_vcpu_run_return {
+ enum hf_vcpu_run_code code;
+ union {
+ struct {
+ uint32_t vm_id;
+ uint16_t vcpu;
+ } wake_up;
+ struct {
+ uint32_t size;
+ } message;
+ struct {
+ uint64_t ns;
+ } sleep;
+ };
+};
+
+struct hf_mailbox_receive_return {
+ uint32_t vm_id;
+ uint32_t size;
+};
+
+/**
+ * Encode an hf_vcpu_run_return struct in the 64-bit packing ABI.
+ */
+static inline uint64_t hf_vcpu_run_return_encode(struct hf_vcpu_run_return res)
+{
+ uint64_t ret = res.code & 0xff;
+ switch (res.code) {
+ case HF_VCPU_RUN_WAKE_UP:
+ ret |= (uint64_t)res.wake_up.vm_id << 32;
+ ret |= (uint64_t)res.wake_up.vcpu << 16;
+ break;
+ case HF_VCPU_RUN_MESSAGE:
+ ret |= (uint64_t)res.message.size << 32;
+ break;
+ case HF_VCPU_RUN_SLEEP:
+ ret |= res.sleep.ns << 8;
+ break;
+ default:
+ break;
+ }
+ return ret;
+}
+
+/**
+ * Decode an hf_vcpu_run_return struct from the 64-bit packing ABI.
+ */
+static inline struct hf_vcpu_run_return hf_vcpu_run_return_decode(uint64_t res)
+{
+ struct hf_vcpu_run_return ret;
+
+ ret.code = (enum hf_vcpu_run_code)(res & 0xff);
+
+ /* Some codes include more data. */
+ switch (ret.code) {
+ case HF_VCPU_RUN_WAKE_UP:
+ ret.wake_up.vm_id = res >> 32;
+ ret.wake_up.vcpu = (res >> 16) & 0xffff;
+ break;
+ case HF_VCPU_RUN_MESSAGE:
+ ret.message.size = res >> 32;
+ break;
+ case HF_VCPU_RUN_SLEEP:
+ ret.sleep.ns = res >> 8;
+ break;
+ default:
+ break;
+ }
+
+ return ret;
+}
+
+/**
+ * Encode an hf_mailbox_receive_return struct in the 64-bit packing ABI.
+ */
+static inline uint64_t hf_mailbox_receive_return_encode(
+ struct hf_mailbox_receive_return res)
+{
+ return res.vm_id | ((uint64_t)res.size << 32);
+}
+
+/**
+ * Decode an hf_mailbox_receive_return struct from the 64-bit packing ABI.
+ */
+static inline struct hf_mailbox_receive_return hf_mailbox_receive_return_decode(
+ uint64_t res)
+{
+ return (struct hf_mailbox_receive_return){
+ .vm_id = (uint32_t)(res & 0xffffffff),
+ .size = (uint32_t)(res >> 32),
+ };
+}