Changeset 58340 in vbox for trunk/src/VBox/HostDrivers/VBoxNetFlt

Timestamp:

Oct 20, 2015 1:58:41 PM (10 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

103540

Message:

HostDrivers: Doxygen fixes

Location:

trunk/src/VBox/HostDrivers/VBoxNetFlt

Files:

• VBoxNetFltInternal.h (modified) (1 diff)
• linux/VBoxNetFlt-linux.c (modified) (4 diffs)
• solaris/VBoxNetFlt-solaris.c (modified) (11 diffs)
• solaris/VBoxNetFltBow-solaris.c (modified) (5 diffs)

trunk/src/VBox/HostDrivers/VBoxNetFlt/VBoxNetFltInternal.h

@@ -382 +382 @@
  *
  * @param   pThis           The instance.
+ * @param   fActive         Whether to active (@c true) or deactive.
  *
  * @remarks Owns the lock for the out-bound trunk port.

trunk/src/VBox/HostDrivers/VBoxNetFlt/linux/VBoxNetFlt-linux.c

@@ -771 +771 @@
  * @param   pBuf                The sk_buff.
  * @param   pSG                 The SG.
- * @param   pvFrame             The frame pointer, optional.
  * @param   cSegs               The number of segments allocated for the SG.
  *                              This should match the number in the mbuf exactly!
  * @param   fSrc                The source of the frame.
- * @param   pGso                Pointer to the GSO context if it's a GSO
+ * @param   pGsoCtx             Pointer to the GSO context if it's a GSO
  *                              internal network frame.  NULL if regular frame.
  */
@@ -846 +845 @@
 
 /**
- * Packet handler,
- *
- * @returns 0 or EJUSTRETURN.
- * @param   pThis           The instance.
- * @param   pMBuf           The mbuf.
- * @param   pvFrame         The start of the frame, optional.
- * @param   fSrc            Where the packet (allegedly) comes from, one INTNETTRUNKDIR_* value.
- * @param   eProtocol       The protocol.
+ * Packet handler; not really documented - figure it out yourself.
+ *
+ * @returns 0 or EJUSTRETURN - this is probably copy & pastry and thus wrong.
  */
 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 14)
@@ -1372 +1366 @@
 
 /**
- *
+ * I won't disclose what I do, figure it out yourself, including pThis referencing.
+ *
+ * @param   pThis       The net filter instance.
  * @param   pBuf        The socket buffer.  This is consumed by this function.
  */
@@ -1609 +1605 @@
  * @returns VBox status code.
  * @param   pThis           The instance.
- * @param   fRediscovery    If set we're doing a rediscovery attempt, so, don't
- *                          flood the release log.
+ * @param   pDev            The device to attach to.
  */
 static int vboxNetFltLinuxAttachToInterface(PVBOXNETFLTINS pThis, struct net_device *pDev)

trunk/src/VBox/HostDrivers/VBoxNetFlt/solaris/VBoxNetFlt-solaris.c

@@ -124 +124 @@
  * Stream Driver hooks.
  */
-static int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pArg, void **ppResult);
+static int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pArg, void **ppvResult);
 static int VBoxNetFltSolarisAttach(dev_info_t *pDip, ddi_attach_cmd_t enmCmd);
 static int VBoxNetFltSolarisDetach(dev_info_t *pDip, ddi_detach_cmd_t enmCmd);
@@ -718 +718 @@
  * @returns  corresponding solaris error code.
  */
-static int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pvArg, void **ppResult)
+static int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pvArg, void **ppvResult)
 {
     LogFunc((DEVICE_NAME ":VBoxNetFltSolarisGetInfo pDip=%p enmCmd=%d pArg=%p instance=%d\n", pDip, enmCmd,
@@ -727 +727 @@
         case DDI_INFO_DEVT2DEVINFO:
         {
-            *ppResult = g_pVBoxNetFltSolarisDip;
+            *ppvResult = g_pVBoxNetFltSolarisDip;
             return DDI_SUCCESS;
         }
@@ -734 +734 @@
         {
             int instance = getminor((dev_t)pvArg);
-            *ppResult = (void *)(uintptr_t)instance;
+            *ppvResult = (void *)(uintptr_t)instance;
             return DDI_SUCCESS;
         }
@@ -1318 +1318 @@
  *
  * @returns VBox status code.
- * @param   pQueue      Pointer to the read queue.
+ * @param   pPromiscStream  Pointer to the read queue.
  */
 static int vboxNetFltSolarisSetRawMode(vboxnetflt_promisc_stream_t *pPromiscStream)
@@ -1822 +1822 @@
  *
  * @returns VBox status code.
+ * @param   pVNode  Pointer to the device vnode.
  * @param   MuxId   The multiplexor ID.
  * @param   pFd     Where to store the lower stream file descriptor.
@@ -1909 +1910 @@
  *
  * @returns VBox status code.
+ * @param   fAttach     Is this an attach or detach.
  * @param   pVNode      Pointer to the lower stream vnode.
  * @param   pModPos     Where to store the module position.
@@ -2645 +2647 @@
  * Ipv6 dynamic attachment timer callback to attach to the Ipv6 stream if needed.
  *
- * @param   pThis           Pointer to the timer.
+ * @param   pTimer          Pointer to the timer.
  * @param   pvData          Opaque pointer to the instance.
  * @param   iTick           Timer tick (unused).
@@ -2851 +2853 @@
  * @param   pThis           The instance.
  * @param   pSG             Pointer to the scatter-gather list.
+ * @param   fDst            The destination mask, INTNETTRUNKDIR_XXX. Ignored.
  */
 static mblk_t *vboxNetFltSolarisMBlkFromSG(PVBOXNETFLTINS pThis, PINTNETSG pSG, uint32_t fDst)
@@ -2967 +2970 @@
  * @returns VBox status code.
  * @param   pMsg        Pointer to the raw message.
- * @param   pDlpiMsg    Where to store the M_PROTO message.
+ * @param   ppDlpiMsg   Where to store the M_PROTO message.
  *
  * @remarks The original raw message would be no longer valid and will be
@@ -3370 +3373 @@
  * @param   pStream     Pointer to the stream.
  * @param   pQueue      Pointer to the read queue.
- * @param   pOrigMsg    Pointer to the message.
+ * @param   pMsg        Pointer to the message.
  */
 static int vboxNetFltSolarisRecv(PVBOXNETFLTINS pThis, vboxnetflt_stream_t *pStream, queue_t *pQueue, mblk_t *pMsg)

trunk/src/VBox/HostDrivers/VBoxNetFlt/solaris/VBoxNetFltBow-solaris.c

@@ -121 +121 @@
 LOCAL int VBoxNetFltSolarisAttach(dev_info_t *pDip, ddi_attach_cmd_t enmCmd);
 LOCAL int VBoxNetFltSolarisDetach(dev_info_t *pDip, ddi_detach_cmd_t enmCmd);
-LOCAL int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pArg, void **ppResult);
+LOCAL int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pArg, void **ppvResult);
 
 
@@ -425 +425 @@
  * @returns corresponding solaris error code.
  */
-LOCAL int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pvArg, void **ppResult)
+LOCAL int VBoxNetFltSolarisGetInfo(dev_info_t *pDip, ddi_info_cmd_t enmCmd, void *pvArg, void **ppvResult)
 {
     Log((DEVICE_NAME ":VBoxNetFltSolarisGetInfo pDip=%p enmCmd=%d pArg=%p instance=%d\n", pDip, enmCmd, getminor((dev_t)pvArg)));
@@ -433 +433 @@
         case DDI_INFO_DEVT2DEVINFO:
         {
-            *ppResult = g_pVBoxNetFltSolarisDip;
+            *ppvResult = g_pVBoxNetFltSolarisDip;
             return DDI_SUCCESS;
         }
@@ -440 +440 @@
         {
             int instance = getminor((dev_t)pvArg);
-            *ppResult = (void *)(uintptr_t)instance;
+            *ppvResult = (void *)(uintptr_t)instance;
             return DDI_SUCCESS;
         }
@@ -812 +812 @@
  * @param   pThis           The instance.
  * @param   pVNIC           Pointer to the VNIC.
- * @param   pVNICTemplate   Pointer to the VNIC template initialize from, can be
- *                          NULL.
  *
  * @returns VBox status code.