It might be a bit late for this note now, but perhaps a separate patch could
add it:
> UINT32 devOp; /* Device operation of the userspace call. */
"devOp" is as vague as "Device operation" IMHO.
Could you please refer to these flags (defined in Datapath.c):
> #define OVS_READ_DEV_OP (1 << 0)
> #define OVS_WRITE_DEV_OP (1 << 1)
> #define OVS_TRANSACTION_DEV_OP (1 << 2)
in this comment?
E.g.
UINT32 devOp; /* OVS_*_DEV_OP of the userspace call. */
And also, perhaps, #define the flags in Datapath.h instead of Datapath.c
Regards,
Sam
________________________________________
Date: Fri, 29 Aug 2014 12:04:29 -0700
From: Ankur Sharma <ankursha...@vmware.com>
To: dev@openvswitch.org
Subject: [ovs-dev] [PATCH 5/9 v3] datapath-windows: add description to
members of OVS_USER_PARAMS_CONTEXT
Message-ID: <1409339069-15651-1-git-send-email-ankursha...@vmware.com>
Signed-off-by: Nithin Raju <nit...@vmware.com>
Signed-off-by: Ankur Sharma <ankursha...@vmware.com>
Acked-by: Ankur Sharma <ankursha...@vmware.com>
---
Please attribute this to Nithin Raju <nit...@vmware.com>
---
datapath-windows/ovsext/Datapath.h | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/datapath-windows/ovsext/Datapath.h
b/datapath-windows/ovsext/Datapath.h
index 2b55919..5afa9d6 100644
--- a/datapath-windows/ovsext/Datapath.h
+++ b/datapath-windows/ovsext/Datapath.h
@@ -89,14 +89,15 @@ NTSTATUS OvsCompleteIrpRequest(PIRP irp, ULONG_PTR infoPtr,
NTSTATUS status);
* passed during a call from userspace.
*/
typedef struct _OVS_USER_PARAMS_CONTEXT {
- PIRP irp;
- POVS_OPEN_INSTANCE ovsInstance;
- UINT32 devOp;
- POVS_MESSAGE ovsMsg;
- PVOID inputBuffer;
- UINT32 inputLength;
- PVOID outputBuffer;
- UINT32 outputLength;
+ PIRP irp; /* The IRP used for the userspace call. */
+ POVS_OPEN_INSTANCE ovsInstance; /* Private data of the device handle. */
+ UINT32 devOp; /* Device operation of the userspace call. */
+ POVS_MESSAGE ovsMsg; /* OVS message that userspace passed down. */
+ PVOID inputBuffer; /* Input data specified by userspace. Maybe NULL. */
+ UINT32 inputLength; /* Length of input buffer. */
+ PVOID outputBuffer; /* Output buffer specified by userspace for reading
+ * data. Maybe NULL. */
+ UINT32 outputLength; /* Length of output buffer. */
} OVS_USER_PARAMS_CONTEXT, *POVS_USER_PARAMS_CONTEXT;
static __inline VOID
--
1.8.3.2
------------------------------
_______________________________________________
dev mailing list
dev@openvswitch.org
http://openvswitch.org/mailman/listinfo/dev
