Patchwork eepro100: Better documentation for temporary data

login
register
mail settings
Submitter Stefan Weil
Date Dec. 14, 2009, 9:25 a.m.
Message ID <1260782734-11399-1-git-send-email-weil@mail.berlios.de>
Download mbox | patch
Permalink /patch/41072/
State New
Headers show

Comments

Stefan Weil - Dec. 14, 2009, 9:25 a.m.
Michael S. Tsirkin suggested more documentation for
two temporary status values. Well, here it is.

Signed-off-by: Stefan Weil <weil@mail.berlios.de>
---
 hw/eepro100.c |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)
Michael S. Tsirkin - Dec. 15, 2009, 3:49 p.m.
On Mon, Dec 14, 2009 at 10:25:34AM +0100, Stefan Weil wrote:
> Michael S. Tsirkin suggested more documentation for
> two temporary status values. Well, here it is.
> 
> Signed-off-by: Stefan Weil <weil@mail.berlios.de>

Looks good to me.

> ---
>  hw/eepro100.c |    7 ++++---
>  1 files changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/hw/eepro100.c b/hw/eepro100.c
> index 22e5bed..5a77409 100644
> --- a/hw/eepro100.c
> +++ b/hw/eepro100.c
> @@ -213,9 +213,10 @@ typedef struct {
>      uint32_t ru_offset;         /* RU address offset */
>      uint32_t statsaddr;         /* pointer to eepro100_stats_t */
>  
> -    /* Temporary data. */
> -    eepro100_tx_t tx;
> -    uint32_t cb_address;
> +    /* Temporary status information (no need to save these values),
> +     * used while processing CU commands. */
> +    eepro100_tx_t tx;           /* transmit buffer descriptor */
> +    uint32_t cb_address;        /* = cu_base + cu_offset */
>  
>      /* Statistical counters. Also used for wake-up packet (i82559). */
>      eepro100_stats_t statistics;
> -- 
> 1.6.5

Patch

diff --git a/hw/eepro100.c b/hw/eepro100.c
index 22e5bed..5a77409 100644
--- a/hw/eepro100.c
+++ b/hw/eepro100.c
@@ -213,9 +213,10 @@  typedef struct {
     uint32_t ru_offset;         /* RU address offset */
     uint32_t statsaddr;         /* pointer to eepro100_stats_t */
 
-    /* Temporary data. */
-    eepro100_tx_t tx;
-    uint32_t cb_address;
+    /* Temporary status information (no need to save these values),
+     * used while processing CU commands. */
+    eepro100_tx_t tx;           /* transmit buffer descriptor */
+    uint32_t cb_address;        /* = cu_base + cu_offset */
 
     /* Statistical counters. Also used for wake-up packet (i82559). */
     eepro100_stats_t statistics;