Add missing doc comments
Add documentation comments for flag types and
NotificationInfoGetIterator type.
Signed-off-by: Imre Kis <imre.kis@arm.com>
Change-Id: I55321629723718587b67019142492e69170da69c
diff --git a/src/lib.rs b/src/lib.rs
index a92e792..ee3ed71 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -540,7 +540,7 @@
}
}
-/// Flags field of the FFA_MSG_SEND2 interface.
+/// Flags field of the `FFA_MSG_SEND2` interface.
#[derive(Debug, Eq, Default, PartialEq, Clone, Copy)]
pub struct MsgSend2Flags {
pub delay_schedule_receiver: bool,
@@ -697,6 +697,7 @@
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub struct DirectMsg2Args(pub [u64; 14]);
+/// Flags field of the `FFA_MSG_WAIT` interface.
#[derive(Debug, Default, Eq, PartialEq, Clone, Copy)]
pub struct MsgWaitFlags {
pub retain_rx_buffer: bool,
@@ -815,6 +816,7 @@
/// Specialized type for 64-bit `FFA_CONSOLE_LOG` payload.
pub type ConsoleLogChars64 = LogChars<[u64; 16]>;
+/// Flags field of the `FFA_NOTIFICATION_BIND` interface.
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub struct NotificationBindFlags {
pub per_vcpu_notification: bool,
@@ -842,6 +844,7 @@
}
}
+/// Flags field of the `FFA_NOTIFICATION_SET` interface.
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub struct NotificationSetFlags {
pub delay_schedule_receiver: bool,
@@ -898,6 +901,7 @@
}
}
+/// Flags field of the `FFA_NOTIFICATION_GET` interface.
#[derive(Debug, Eq, PartialEq, Clone, Copy)]
pub struct NotificationGetFlags {
pub sp_bitmap_id: bool,
@@ -1186,6 +1190,8 @@
}
}
+/// Iterator implementation for parsing the (partition ID, vCPU ID list) pairs of the `FFA_SUCCESS`
+/// of an `FFA_NOTIFICATION_INFO_GET` call.
pub struct NotificationInfoGetIterator<'a> {
list_index: usize,
id_index: usize,