]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/commitdiff
iwlwifi: fw api: fix various kernel-doc warnings
authorJohannes Berg <johannes.berg@intel.com>
Tue, 6 Jun 2017 10:19:22 +0000 (12:19 +0200)
committerLuca Coelho <luciano.coelho@intel.com>
Tue, 1 Aug 2017 09:41:43 +0000 (12:41 +0300)
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
Signed-off-by: Luca Coelho <luciano.coelho@intel.com>
drivers/net/wireless/intel/iwlwifi/fw/api/cmdhdr.h
drivers/net/wireless/intel/iwlwifi/fw/api/txq.h

index fd97cccaedb8f93d34d194979c6fb895cb45e381..ea4a3f04a83a526cb8a8f6572626a8aba8c765fb 100644 (file)
@@ -112,15 +112,24 @@ static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version)
 #define IWL_ALWAYS_LONG_GROUP  1
 
 /**
- * struct iwl_cmd_header
+ * struct iwl_cmd_header - (short) command header format
  *
  * This header format appears in the beginning of each command sent from the
  * driver, and each response/notification received from uCode.
  */
 struct iwl_cmd_header {
-       u8 cmd;         /* Command ID:  REPLY_RXON, etc. */
+       /**
+        * @cmd: Command ID: REPLY_RXON, etc.
+        */
+       u8 cmd;
+       /**
+        * @group_id: group ID, for commands with groups
+        */
        u8 group_id;
-       /*
+       /**
+        * @sequence:
+        * Sequence number for the command.
+        *
         * The driver sets up the sequence number to values of its choosing.
         * uCode does not use this value, but passes it back to the driver
         * when sending the response to each driver-originated command, so
@@ -150,6 +159,13 @@ struct iwl_cmd_header {
  * driver, and each response/notification received from uCode.
  * this is the wide version that contains more information about the command
  * like length, version and command type
+ *
+ * @cmd: command ID, like in &struct iwl_cmd_header
+ * @group_id: group ID, like in &struct iwl_cmd_header
+ * @sequence: sequence, like in &struct iwl_cmd_header
+ * @length: length of the command
+ * @reserved: reserved
+ * @version: command version
  */
 struct iwl_cmd_header_wide {
        u8 cmd;
index 7e7ebe82729b0d895aa4156b8259faf00ef46f54..805e161641aaf3459b575cd73be5f892c80ab7fa 100644 (file)
@@ -112,7 +112,7 @@ enum iwl_mvm_tx_fifo {
 };
 
 /**
- * iwl_tx_queue_cfg_actions - TXQ config options
+ * enum iwl_tx_queue_cfg_actions - TXQ config options
  * @TX_QUEUE_CFG_ENABLE_QUEUE: enable a queue
  * @TX_QUEUE_CFG_TFD_SHORT_FORMAT: use short TFD format
  */
@@ -145,6 +145,7 @@ struct iwl_tx_queue_cfg_cmd {
  * @queue_number: queue number assigned to this RA -TID
  * @flags: set on failure
  * @write_pointer: initial value for write pointer
+ * @reserved: reserved
  */
 struct iwl_tx_queue_cfg_rsp {
        __le16 queue_number;