staging: rtl8192u: fix comments in r819xU_cmdpkt.h
authorXenia Ragiadakou <burzalodowa@gmail.com>
Thu, 10 Oct 2013 07:43:50 +0000 (10:43 +0300)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Fri, 11 Oct 2013 22:42:53 +0000 (15:42 -0700)
This patch fixes the comments in r819xU_cmdpkt.h by:
* removing any empty or unnecessary comments
* replacing the // comments with /* */ comments
* removing date and author information from comments

This is done to improve code readability and to conform to linux kernel
coding style.

Signed-off-by: Xenia Ragiadakou <burzalodowa@gmail.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/rtl8192u/r819xU_cmdpkt.h

index 2e079c7..f7c68e2 100644 (file)
@@ -1,17 +1,17 @@
 #ifndef R819XUSB_CMDPKT_H
 #define R819XUSB_CMDPKT_H
 /* Different command packet have dedicated message length and definition. */
-#define                CMPK_RX_TX_FB_SIZE              sizeof(cmpk_txfb_t)     //20
-#define                CMPK_TX_SET_CONFIG_SIZE         sizeof(cmpk_set_cfg_t)  //16
-#define                CMPK_BOTH_QUERY_CONFIG_SIZE     sizeof(cmpk_set_cfg_t)  //16
-#define                CMPK_RX_TX_STS_SIZE             sizeof(cmpk_tx_status_t)//
-#define                CMPK_RX_DBG_MSG_SIZE            sizeof(cmpk_rx_dbginfo_t)//
+#define                CMPK_RX_TX_FB_SIZE              sizeof(cmpk_txfb_t)     /* 20 */
+#define                CMPK_TX_SET_CONFIG_SIZE         sizeof(cmpk_set_cfg_t)  /* 16 */
+#define                CMPK_BOTH_QUERY_CONFIG_SIZE     sizeof(cmpk_set_cfg_t)  /* 16 */
+#define                CMPK_RX_TX_STS_SIZE             sizeof(cmpk_tx_status_t)
+#define                CMPK_RX_DBG_MSG_SIZE            sizeof(cmpk_rx_dbginfo_t)
 #define                CMPK_TX_RAHIS_SIZE              sizeof(cmpk_tx_rahis_t)
 
 /* 2008/05/08 amy For USB constant. */
-#define ISR_TxBcnOk            BIT27           // Transmit Beacon OK
-#define ISR_TxBcnErr           BIT26           // Transmit Beacon Error
-#define ISR_BcnTimerIntr       BIT13           // Beacon Timer Interrupt
+#define ISR_TxBcnOk            BIT27           /* Transmit Beacon OK */
+#define ISR_TxBcnErr           BIT26           /* Transmit Beacon Error */
+#define ISR_BcnTimerIntr       BIT13           /* Beacon Timer Interrupt */
 
 
 /* Define element ID of command packet. */
 /* Define different command packet structure. */
 /* 1. RX side: TX feedback packet. */
 typedef struct tag_cmd_pkt_tx_feedback {
-       // DWORD 0
+       /* DWORD 0 */
        u8      element_id;                     /* Command packet type. */
        u8      length;                         /* Command packet length. */
-       /* 2007/07/05 MH Change tx feedback info field. */
+       /* Change tx feedback info field. */
        /*------TX Feedback Info Field */
-       u8      TID:4;                          /* */
-       u8      fail_reason:3;          /* */
+       u8      TID:4;
+       u8      fail_reason:3;
        u8      tok:1;                          /* Transmit ok. */
-       u8      reserve1:4;                     /* */
-       u8      pkt_type:2;             /* */
-       u8      bandwidth:1;            /* */
-       u8      qos_pkt:1;                      /* */
+       u8      reserve1:4;
+       u8      pkt_type:2;
+       u8      bandwidth:1;
+       u8      qos_pkt:1;
 
-       // DWORD 1
-       u8      reserve2;                       /* */
+       /* DWORD 1 */
+       u8      reserve2;
        /*------TX Feedback Info Field */
-       u8      retry_cnt;                      /* */
-       u16     pkt_id;                         /* */
+       u8      retry_cnt;
+       u16     pkt_id;
 
-       // DWORD 3
-       u16     seq_num;                        /* */
+       /* DWORD 3 */
+       u16     seq_num;
        u8      s_rate;                         /* Start rate. */
        u8      f_rate;                         /* Final rate. */
 
-       // DWORD 4
-       u8      s_rts_rate;                     /* */
-       u8      f_rts_rate;                     /* */
-       u16     pkt_length;                     /* */
+       /* DWORD 4 */
+       u8      s_rts_rate;
+       u8      f_rts_rate;
+       u16     pkt_length;
 
-       // DWORD 5
-       u16     reserve3;                       /* */
-       u16     duration;                       /* */
+       /* DWORD 5 */
+       u16     reserve3;
+       u16     duration;
 } cmpk_txfb_t;
 
 /* 2. RX side: Interrupt status packet. It includes Beacon State,
@@ -68,17 +68,18 @@ typedef struct tag_cmd_pkt_interrupt_status {
 typedef struct tag_cmd_pkt_set_configuration {
        u8      element_id;                     /* Command packet type. */
        u8      length;                         /* Command packet length. */
-       u16     reserve1;                       /* */
+       u16     reserve1;
+       /* Configuration info. */
        u8      cfg_reserve1:3;
-       u8      cfg_size:2;                     /* Configuration info. */
-       u8      cfg_type:2;                     /* Configuration info. */
-       u8      cfg_action:1;           /* Configuration info. */
-       u8      cfg_reserve2;           /* Configuration info. */
-       u8      cfg_page:4;                     /* Configuration info. */
-       u8      cfg_reserve3:4;         /* Configuration info. */
-       u8      cfg_offset;                     /* Configuration info. */
-       u32     value;                          /* */
-       u32     mask;                           /* */
+       u8      cfg_size:2;
+       u8      cfg_type:2;
+       u8      cfg_action:1;
+       u8      cfg_reserve2;
+       u8      cfg_page:4;
+       u8      cfg_reserve3:4;
+       u8      cfg_offset;
+       u32     value;
+       u32     mask;
 } cmpk_set_cfg_t;
 
 /* 4. Both side : TX/RX query configuraton packet. The query structure is the
@@ -86,88 +87,78 @@ typedef struct tag_cmd_pkt_set_configuration {
 #define                cmpk_query_cfg_t        cmpk_set_cfg_t
 
 /* 5. Multi packet feedback status. */
-typedef struct tag_tx_stats_feedback { // PJ quick rxcmd 09042007
-       // For endian transfer --> Driver will not the same as firmware structure.
-       // DW 0
+typedef struct tag_tx_stats_feedback {
+       /* For endian transfer --> Driver will not the same as
+          firmware structure. */
+       /* DW 0 */
        u16     reserve1;
-       u8      length;                         // Command packet length
-       u8      element_id;                     // Command packet type
+       u8      length;                         /* Command packet length */
+       u8      element_id;                     /* Command packet type */
 
-       // DW 1
-       u16     txfail;                         // Tx Fail count
-       u16     txok;                           // Tx ok count
+       /* DW 1 */
+       u16     txfail;                         /* Tx fail count */
+       u16     txok;                           /* Tx ok count */
 
-       // DW 2
-       u16     txmcok;                         // tx multicast
-       u16     txretry;                        // Tx Retry count
+       /* DW 2 */
+       u16     txmcok;                         /* Tx multicast */
+       u16     txretry;                        /* Tx retry count */
 
-       // DW 3
-       u16  txucok;                            // tx unicast
-       u16     txbcok;                         // tx broadcast
+       /* DW 3 */
+       u16  txucok;                            /* Tx unicast */
+       u16     txbcok;                         /* Tx broadcast */
 
-       // DW 4
-       u16     txbcfail;                       //
-       u16     txmcfail;                       //
+       /* DW 4 */
+       u16     txbcfail;
+       u16     txmcfail;
 
-       // DW 5
-       u16     reserve2;                       //
-       u16     txucfail;                       //
+       /* DW 5 */
+       u16     reserve2;
+       u16     txucfail;
 
-       // DW 6-8
+       /* DW 6-8 */
        u32     txmclength;
        u32     txbclength;
        u32     txuclength;
 
-       // DW 9
+       /* DW 9 */
        u16     reserve3_23;
        u8      reserve3_1;
        u8      rate;
 } __attribute__((packed)) cmpk_tx_status_t;
 
 /* 6. Debug feedback message. */
-/* 2007/10/23 MH Define RX debug message  */
+/* Define RX debug message  */
 typedef struct tag_rx_debug_message_feedback {
-       // For endian transfer --> for driver
-       // DW 0
+       /* For endian transfer --> for driver */
+       /* DW 0 */
        u16     reserve1;
-       u8      length;                         // Command packet length
-       u8      element_id;                     // Command packet type
+       u8      length;                         /* Command packet length */
+       u8      element_id;                     /* Command packet type */
 
-       // DW 1-??
-       // Variable debug message.
+       /* DW 1-?? */
+       /* Variable debug message. */
 
 } cmpk_rx_dbginfo_t;
 
-/* 2008/03/20 MH Define transmit rate history. For big endian format. */
+/* Define transmit rate history. For big endian format. */
 typedef struct tag_tx_rate_history {
-       // For endian transfer --> for driver
-       // DW 0
-       u8      element_id;                     // Command packet type
-       u8      length;                         // Command packet length
+       /* For endian transfer --> for driver */
+       /* DW 0 */
+       u8      element_id;                     /* Command packet type */
+       u8      length;                         /* Command packet length */
        u16     reserved1;
 
-       // DW 1-2       CCK rate counter
+       /* DW 1-2       CCK rate counter */
        u16     cck[4];
 
-       // DW 3-6
+       /* DW 3-6 */
        u16     ofdm[8];
 
-       // DW 7-14
-       //UINT16        MCS_BW0_SG0[16];
-
-       // DW 15-22
-       //UINT16        MCS_BW1_SG0[16];
-
-       // DW 23-30
-       //UINT16        MCS_BW0_SG1[16];
-
-       // DW 31-38
-       //UINT16        MCS_BW1_SG1[16];
-
-       // DW 7-14      BW=0 SG=0
-       // DW 15-22     BW=1 SG=0
-       // DW 23-30     BW=0 SG=1
-       // DW 31-38     BW=1 SG=1
+       /* DW 7-14      BW=0 SG=0
+        * DW 15-22     BW=1 SG=0
+        * DW 23-30     BW=0 SG=1
+        * DW 31-38     BW=1 SG=1
+        */
        u16     ht_mcs[4][16];
 
 } __attribute__((packed)) cmpk_tx_rahis_t;