|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [PATCH v2] xenhid: annotate include files
The previous conversion to SAL 2.0 left the files in include directory.
Update the include files to complete conversion.
store_interface.h and suspend_interface.h are synced with xenbus include
files.
No functional change.
Signed-off-by: Césaire Mounah <cesaire.mounah@xxxxxxxxxx>
---
include/hid_interface.h | 108 ++++++++++++++++++------------------
include/store_interface.h | 90 +++++++++++++++---------------
include/suspend_interface.h | 30 +++++-----
3 files changed, 114 insertions(+), 114 deletions(-)
diff --git a/include/hid_interface.h b/include/hid_interface.h
index 2e2d9e6..5de30cf 100644
--- a/include/hid_interface.h
+++ b/include/hid_interface.h
@@ -48,7 +48,7 @@
*/
typedef NTSTATUS
(*XENHID_HID_ACQUIRE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENHID_HID_RELEASE
@@ -58,7 +58,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENHID_HID_RELEASE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENHID_HID_CALLBACK
@@ -70,9 +70,9 @@ typedef VOID
*/
typedef BOOLEAN
(*XENHID_HID_CALLBACK)(
- IN PVOID Argument OPTIONAL,
- IN PVOID Buffer,
- IN ULONG Length
+ _In_opt_ PVOID Argument,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length
);
/*! \typedef XENHID_HID_ENABLE
@@ -87,9 +87,9 @@ typedef BOOLEAN
*/
typedef NTSTATUS
(*XENHID_HID_ENABLE)(
- IN PINTERFACE Interface,
- IN XENHID_HID_CALLBACK Callback,
- IN PVOID Argument OPTIONAL
+ _In_ PINTERFACE Interface,
+ _In_ XENHID_HID_CALLBACK Callback,
+ _In_opt_ PVOID Argument
);
/*! \typedef XENHID_HID_DISABLE
@@ -102,7 +102,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENHID_HID_DISABLE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENHID_HID_GET_DEVICE_ATTRIBUTES
@@ -111,10 +111,10 @@ typedef VOID
*/
typedef NTSTATUS
(*XENHID_HID_GET_DEVICE_ATTRIBUTES)(
- IN PINTERFACE Interface,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_GET_DEVICE_DESCRIPTOR
@@ -127,10 +127,10 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_DEVICE_DESCRIPTOR)(
- IN PINTERFACE Interface,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_GET_REPORT_DESCRIPTOR
@@ -143,10 +143,10 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_REPORT_DESCRIPTOR)(
- IN PINTERFACE Interface,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_GET_STRING
@@ -160,11 +160,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_STRING)(
- IN PINTERFACE Interface,
- IN ULONG Identifier,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ ULONG Identifier,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_GET_INDEXED_STRING
@@ -178,11 +178,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_INDEXED_STRING)(
- IN PINTERFACE Interface,
- IN ULONG Index,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ ULONG Index,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_GET_FEATURE
@@ -196,11 +196,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_FEATURE)(
- IN PINTERFACE Interface,
- IN ULONG ReportId,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ ULONG ReportId,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_SET_FEATURE
@@ -213,10 +213,10 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_SET_FEATURE)(
- IN PINTERFACE Interface,
- IN ULONG ReportId,
- IN PVOID Buffer,
- IN ULONG Length
+ _In_ PINTERFACE Interface,
+ _In_ ULONG ReportId,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length
);
/*! \typedef XENHID_HID_GET_INPUT_REPORT
@@ -230,11 +230,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_GET_INPUT_REPORT)(
- IN PINTERFACE Interface,
- IN ULONG ReportId,
- IN PVOID Buffer,
- IN ULONG Length,
- OUT PULONG Returned
+ _In_ PINTERFACE Interface,
+ _In_ ULONG ReportId,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length,
+ _Out_ PULONG Returned
);
/*! \typedef XENHID_HID_SET_OUTPUT_REPORT
@@ -247,10 +247,10 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENHID_HID_SET_OUTPUT_REPORT)(
- IN PINTERFACE Interface,
- IN ULONG ReportId,
- IN PVOID Buffer,
- IN ULONG Length
+ _In_ PINTERFACE Interface,
+ _In_ ULONG ReportId,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length
);
/*! \typedef XENHID_HID_READ_REPORT
@@ -262,7 +262,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENHID_HID_READ_REPORT)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENHID_HID_WRITE_REPORT
@@ -275,10 +275,10 @@ typedef VOID
*/
typedef NTSTATUS
(*XENHID_HID_WRITE_REPORT)(
- IN PINTERFACE Interface,
- IN ULONG ReportId,
- IN PVOID Buffer,
- IN ULONG Length
+ _In_ PINTERFACE Interface,
+ _In_ ULONG ReportId,
+ _In_ PVOID Buffer,
+ _In_ ULONG Length
);
// {D215E1B5-8C38-420A-AEA6-02520DF3A621}
diff --git a/include/store_interface.h b/include/store_interface.h
index 616bc36..7772b7f 100644
--- a/include/store_interface.h
+++ b/include/store_interface.h
@@ -36,8 +36,8 @@
This interface provides access to XenStore
*/
-#ifndef _XENBUS_STORE_INTERFACE_H
-#define _XENBUS_STORE_INTERFACE_H
+#ifndef _XENHID_STORE_INTERFACE_H
+#define _XENHID_STORE_INTERFACE_H
#ifndef _WINDLL
@@ -75,7 +75,7 @@ typedef struct _XENBUS_STORE_PERMISSION {
*/
typedef NTSTATUS
(*XENBUS_STORE_ACQUIRE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_STORE_RELEASE
@@ -85,7 +85,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENBUS_STORE_RELEASE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_STORE_FREE
@@ -96,8 +96,8 @@ typedef VOID
*/
typedef VOID
(*XENBUS_STORE_FREE)(
- IN PINTERFACE Interface,
- IN PCHAR Buffer
+ _In_ PINTERFACE Interface,
+ _In_ PSTR Buffer
);
/*! \typedef XENBUS_STORE_READ
@@ -116,11 +116,11 @@ typedef VOID
*/
typedef NTSTATUS
(*XENBUS_STORE_READ)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction OPTIONAL,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node,
- OUT PCHAR *Buffer
+ _In_ PINTERFACE Interface,
+ _In_opt_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node,
+ _Outptr_result_z_ PSTR *Buffer
);
/*! \typedef XENBUS_STORE_PRINTF
@@ -139,11 +139,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_PRINTF)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction OPTIONAL,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node,
- IN const CHAR *Format,
+ _In_ PINTERFACE Interface,
+ _In_opt_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node,
+ _In_ PCSTR Format,
...
);
@@ -159,10 +159,10 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_REMOVE)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction OPTIONAL,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node
+ _In_ PINTERFACE Interface,
+ _In_opt_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node
);
/*! \typedef XENBUS_STORE_DIRECTORY
@@ -181,11 +181,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_DIRECTORY)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction OPTIONAL,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node,
- OUT PCHAR *Buffer
+ _In_ PINTERFACE Interface,
+ _In_opt_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node,
+ _Outptr_result_z_ PSTR *Buffer
);
/*! \typedef XENBUS_STORE_TRANSACTION_START
@@ -196,8 +196,8 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_TRANSACTION_START)(
- IN PINTERFACE Interface,
- OUT PXENBUS_STORE_TRANSACTION *Transaction
+ _In_ PINTERFACE Interface,
+ _Outptr_ PXENBUS_STORE_TRANSACTION *Transaction
);
/*! \typedef XENBUS_STORE_TRANSACTION_END
@@ -213,9 +213,9 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_TRANSACTION_END)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction,
- IN BOOLEAN Commit
+ _In_ PINTERFACE Interface,
+ _In_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_ BOOLEAN Commit
);
/*! \typedef XENBUS_STORE_WATCH_ADD
@@ -231,11 +231,11 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_WATCH_ADD)(
- IN PINTERFACE Interface,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node,
- IN PKEVENT Event,
- OUT PXENBUS_STORE_WATCH *Watch
+ _In_ PINTERFACE Interface,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node,
+ _In_ PKEVENT Event,
+ _Outptr_ PXENBUS_STORE_WATCH *Watch
);
/*! \typedef XENBUS_STORE_WATCH_REMOVE
@@ -246,8 +246,8 @@ typedef NTSTATUS
*/
typedef NTSTATUS
(*XENBUS_STORE_WATCH_REMOVE)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_WATCH Watch
+ _In_ PINTERFACE Interface,
+ _In_ PXENBUS_STORE_WATCH Watch
);
/*! \typedef XENBUS_STORE_POLL
@@ -262,7 +262,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENBUS_STORE_POLL)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_STORE_PERMISSIONS_SET
@@ -279,12 +279,12 @@ typedef VOID
*/
typedef NTSTATUS
(*XENBUS_STORE_PERMISSIONS_SET)(
- IN PINTERFACE Interface,
- IN PXENBUS_STORE_TRANSACTION Transaction OPTIONAL,
- IN PCHAR Prefix OPTIONAL,
- IN PCHAR Node,
- IN PXENBUS_STORE_PERMISSION Permissions,
- IN ULONG NumberPermissions
+ _In_ PINTERFACE Interface,
+ _In_opt_ PXENBUS_STORE_TRANSACTION Transaction,
+ _In_opt_ PSTR Prefix,
+ _In_ PSTR Node,
+ _In_ PXENBUS_STORE_PERMISSION Permissions,
+ _In_ ULONG NumberPermissions
);
// {86824C3B-D34E-4753-B281-2F1E3AD214D7}
@@ -325,4 +325,4 @@ typedef struct _XENBUS_STORE_INTERFACE_V2
XENBUS_STORE_INTERFACE, *PXENBUS_STORE
#define XENBUS_STORE_INTERFACE_VERSION_MIN 2
#define XENBUS_STORE_INTERFACE_VERSION_MAX 2
-#endif // _XENBUS_STORE_INTERFACE_H
+#endif // _XENHID_STORE_INTERFACE_H
diff --git a/include/suspend_interface.h b/include/suspend_interface.h
index ee31d95..50b2085 100644
--- a/include/suspend_interface.h
+++ b/include/suspend_interface.h
@@ -36,8 +36,8 @@
This interface provides primitives to handle VM suspend/resume
*/
-#ifndef _XENBUS_SUSPEND_INTERFACE_H
-#define _XENBUS_SUSPEND_INTERFACE_H
+#ifndef _XENHID_SUSPEND_INTERFACE_H
+#define _XENHID_SUSPEND_INTERFACE_H
#ifndef _WINDLL
@@ -62,7 +62,7 @@ typedef struct _XENBUS_SUSPEND_CALLBACK
XENBUS_SUSPEND_CALLBACK, *PXENBUS_SUSP
*/
typedef NTSTATUS
(*XENBUS_SUSPEND_ACQUIRE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_SUSPEND_RELEASE
@@ -72,7 +72,7 @@ typedef NTSTATUS
*/
typedef VOID
(*XENBUS_SUSPEND_RELEASE)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_SUSPEND_FUNCTION
@@ -87,7 +87,7 @@ typedef VOID
*/
typedef VOID
(*XENBUS_SUSPEND_FUNCTION)(
- IN PVOID Argument
+ _In_ PVOID Argument
);
/*! \typedef XENBUS_SUSPEND_REGISTER
@@ -101,11 +101,11 @@ typedef VOID
*/
typedef NTSTATUS
(*XENBUS_SUSPEND_REGISTER)(
- IN PINTERFACE Interface,
- IN XENBUS_SUSPEND_CALLBACK_TYPE Type,
- IN XENBUS_SUSPEND_FUNCTION Function,
- IN PVOID Argument OPTIONAL,
- OUT PXENBUS_SUSPEND_CALLBACK *Callback
+ _In_ PINTERFACE Interface,
+ _In_ XENBUS_SUSPEND_CALLBACK_TYPE Type,
+ _In_ XENBUS_SUSPEND_FUNCTION Function,
+ _In_opt_ PVOID Argument,
+ _Outptr_ PXENBUS_SUSPEND_CALLBACK *Callback
);
/*! \typedef XENBUS_SUSPEND_DEREGISTER
@@ -116,8 +116,8 @@ typedef NTSTATUS
*/
typedef VOID
(*XENBUS_SUSPEND_DEREGISTER)(
- IN PINTERFACE Interface,
- IN PXENBUS_SUSPEND_CALLBACK Callback
+ _In_ PINTERFACE Interface,
+ _In_ PXENBUS_SUSPEND_CALLBACK Callback
);
/*! \typedef XENBUS_SUSPEND_TRIGGER
@@ -129,7 +129,7 @@ typedef VOID
*/
typedef NTSTATUS
(*XENBUS_SUSPEND_TRIGGER)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
/*! \typedef XENBUS_SUSPEND_GET_COUNT
@@ -140,7 +140,7 @@ typedef NTSTATUS
*/
typedef ULONG
(*XENBUS_SUSPEND_GET_COUNT)(
- IN PINTERFACE Interface
+ _In_ PINTERFACE Interface
);
// {0554F2AF-B510-4C71-AC03-1C503E394238}
@@ -174,4 +174,4 @@ typedef struct _XENBUS_SUSPEND_INTERFACE_V1
XENBUS_SUSPEND_INTERFACE, *PXENBUS_S
#define XENBUS_SUSPEND_INTERFACE_VERSION_MIN 1
#define XENBUS_SUSPEND_INTERFACE_VERSION_MAX 1
-#endif // _XENBUS_SUSPEND_INTERFACE_H
+#endif // _XENHID_SUSPEND_INTERFACE_H
--
2.55.0.windows.5
--
Césaire Mounah | Vates Windows Guest Tools Engineer
XCP-ng & Xen Orchestra - Vates solutions
web: https://vates.tech
|
 |
Lists.xenproject.org is hosted with RackSpace, monitoring our |