[PATCH 03/12] staging: ks7010: convert comments to kernel doc format

Tobin C. Harding me at tobin.cc
Mon Mar 13 22:54:01 UTC 2017


Function comments use a custom format. We have a standard function
comment format, kernel doc format. Using the standard format aids
readability and allows documentation to be produced using kernel
tools.

Convert function comments to use kernel doc format.

Signed-off-by: Tobin C. Harding <me at tobin.cc>
---
 drivers/staging/ks7010/ks_wlan_net.c | 554 +++++++++++++++++++++++++----------
 1 file changed, 395 insertions(+), 159 deletions(-)

diff --git a/drivers/staging/ks7010/ks_wlan_net.c b/drivers/staging/ks7010/ks_wlan_net.c
index 1ff1948..c6f891e 100644
--- a/drivers/staging/ks7010/ks_wlan_net.c
+++ b/drivers/staging/ks7010/ks_wlan_net.c
@@ -163,8 +163,7 @@ int ks_wlan_setup_parameter(struct ks_wlan_private *priv,
 	return 0;
 }
 
-/*
- * Initial Wireless Extension code for Ks_Wlannet driver by :
+/* Initial Wireless Extension code for Ks_Wlannet driver by :
  *	Jean Tourrilhes <jt at hpl.hp.com> - HPL - 17 November 00
  * Conversion to new driver API by :
  *	Jean Tourrilhes <jt at hpl.hp.com> - HPL - 26 March 02
@@ -173,8 +172,11 @@ int ks_wlan_setup_parameter(struct ks_wlan_private *priv,
  * would not work at all... - Jean II
  */
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get protocol name */
+/**
+ * ks_wlan_get_name() - Get protocol name.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_name(struct net_device *dev,
 			    struct iw_request_info *info, char *cwrq,
 			    char *extra)
@@ -198,8 +200,11 @@ static int ks_wlan_get_name(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set frequency */
+/**
+ * ks_wlan_set_freq() - Set frequency.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_freq(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_freq *fwrq,
 			    char *extra)
@@ -247,8 +252,11 @@ static int ks_wlan_set_freq(struct net_device *dev,
 	return rc;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get frequency */
+/**
+ * ks_wlan_get_freq() - Get frequency.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_freq(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_freq *fwrq,
 			    char *extra)
@@ -271,8 +279,11 @@ static int ks_wlan_get_freq(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set ESSID */
+/**
+ * ks_wlan_set_essid() - Set ESSID.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_essid(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -330,8 +341,11 @@ static int ks_wlan_set_essid(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get ESSID */
+/**
+ * ks_wlan_get_essid() - Get ESSID.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_essid(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -374,8 +388,11 @@ static int ks_wlan_get_essid(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set AP address */
+/**
+ * ks_wlan_set_wap() - Set AP address.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_wap(struct net_device *dev, struct iw_request_info *info,
 			   struct sockaddr *ap_addr, char *extra)
 {
@@ -410,8 +427,11 @@ static int ks_wlan_set_wap(struct net_device *dev, struct iw_request_info *info,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get AP address */
+/**
+ * ks_wlan_get_wap() - Get AP address.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_wap(struct net_device *dev, struct iw_request_info *info,
 			   struct sockaddr *awrq, char *extra)
 {
@@ -432,8 +452,11 @@ static int ks_wlan_get_wap(struct net_device *dev, struct iw_request_info *info,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Nickname */
+/**
+ * ks_wlan_set_nick() - Set Nickname.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_nick(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_point *dwrq,
 			    char *extra)
@@ -455,8 +478,11 @@ static int ks_wlan_set_nick(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Nickname */
+/**
+ * ks_wlan_get_nick() - Get Nickname.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_nick(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_point *dwrq,
 			    char *extra)
@@ -475,8 +501,11 @@ static int ks_wlan_get_nick(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Bit-Rate */
+/**
+ * ks_wlan_set_rate() - Set bit-rate.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_rate(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -710,8 +739,11 @@ static int ks_wlan_set_rate(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Bit-Rate */
+/**
+ * ks_wlan_get_rate() - Get bit-rate.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_rate(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -738,8 +770,11 @@ static int ks_wlan_get_rate(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set RTS threshold */
+/**
+ * ks_wlan_set_rts() - Set RTS threshold.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_rts(struct net_device *dev, struct iw_request_info *info,
 			   struct iw_param *vwrq, char *extra)
 {
@@ -762,8 +797,11 @@ static int ks_wlan_set_rts(struct net_device *dev, struct iw_request_info *info,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get RTS threshold */
+/**
+ * ks_wlan_get_rts() - Get RTS threshold.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_rts(struct net_device *dev, struct iw_request_info *info,
 			   struct iw_param *vwrq, char *extra)
 {
@@ -781,8 +819,11 @@ static int ks_wlan_get_rts(struct net_device *dev, struct iw_request_info *info,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Fragmentation threshold */
+/**
+ * ks_wlan_set_frag() - Set fragmentation threshold.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_frag(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -807,8 +848,11 @@ static int ks_wlan_set_frag(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Fragmentation threshold */
+/**
+ * ks_wlan_get_frag() - Get fragmentation threshold.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_frag(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -827,8 +871,11 @@ static int ks_wlan_get_frag(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Mode of Operation */
+/**
+ * ks_wlan_set_mode() - Set mode of operation.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_mode(struct net_device *dev,
 			    struct iw_request_info *info, __u32 *uwrq,
 			    char *extra)
@@ -863,8 +910,11 @@ static int ks_wlan_set_mode(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Mode of Operation */
+/**
+ * ks_wlan_get_mode() - Get mode of operation.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_mode(struct net_device *dev,
 			    struct iw_request_info *info, __u32 *uwrq,
 			    char *extra)
@@ -891,8 +941,11 @@ static int ks_wlan_get_mode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Encryption Key */
+/**
+ * ks_wlan_set_encode() - Set encryption key.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_encode(struct net_device *dev,
 			      struct iw_request_info *info,
 			      struct iw_point *dwrq, char *extra)
@@ -1009,8 +1062,11 @@ static int ks_wlan_set_encode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Encryption Key */
+/**
+ * ks_wlan_get_encode() - Get encryption key.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_encode(struct net_device *dev,
 			      struct iw_request_info *info,
 			      struct iw_point *dwrq, char *extra)
@@ -1065,8 +1121,12 @@ static int ks_wlan_get_encode(struct net_device *dev,
 }
 
 #ifndef KSC_OPNOTSUPP
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Tx-Power */
+
+/**
+ * ks_wlan_set_txpow() - Set Tx power.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_txpow(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1074,8 +1134,11 @@ static int ks_wlan_set_txpow(struct net_device *dev,
 	return -EOPNOTSUPP;	/* Not Support */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Tx-Power */
+/**
+ * ks_wlan_get_txpow() - Get Tx power.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_txpow(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1091,8 +1154,11 @@ static int ks_wlan_get_txpow(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Retry limits */
+/**
+ * ks_wlan_set_retry() - Set retry limits.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_retry(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1100,8 +1166,11 @@ static int ks_wlan_set_retry(struct net_device *dev,
 	return -EOPNOTSUPP;	/* Not Support */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Retry limits */
+/**
+ * ks_wlan_get_retry() - Get retry limits.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_retry(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1118,8 +1187,11 @@ static int ks_wlan_get_retry(struct net_device *dev,
 }
 #endif /* KSC_OPNOTSUPP */
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get range info */
+/**
+ * ks_wlan_get_range() - Get range info.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_range(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -1253,8 +1325,11 @@ static int ks_wlan_get_range(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Power Management */
+/**
+ * ks_wlan_set_power() - Set power management.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_power(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1289,8 +1364,11 @@ static int ks_wlan_set_power(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Power Management */
+/**
+ * ks_wlan_get_power() - Get power management.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_power(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_param *vwrq, char *extra)
@@ -1309,8 +1387,11 @@ static int ks_wlan_get_power(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get wirless statistics */
+/**
+ * ks_wlan_get_iwstats() - Get wireless statistics.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_iwstats(struct net_device *dev,
 			       struct iw_request_info *info,
 			       struct iw_quality *vwrq, char *extra)
@@ -1330,8 +1411,12 @@ static int ks_wlan_get_iwstats(struct net_device *dev,
 }
 
 #ifndef KSC_OPNOTSUPP
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set Sensitivity */
+
+/**
+ * ks_wlan_set_sens() - Set sensitivity.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_sens(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -1339,8 +1424,11 @@ static int ks_wlan_set_sens(struct net_device *dev,
 	return -EOPNOTSUPP;	/* Not Support */
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get Sensitivity */
+/**
+ * ks_wlan_get_sens() - Get sensitivity.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_sens(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_param *vwrq,
 			    char *extra)
@@ -1353,9 +1441,13 @@ static int ks_wlan_get_sens(struct net_device *dev,
 }
 #endif /* KSC_OPNOTSUPP */
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get AP List */
-/* Note : this is deprecated in favor of IWSCAN */
+/**
+ * ks_wlan_get_aplist() - Get AP list.
+ *
+ * Note: this is deprecated in favor of IWSCAN.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_aplist(struct net_device *dev,
 			      struct iw_request_info *info,
 			      struct iw_point *dwrq, char *extra)
@@ -1389,8 +1481,11 @@ static int ks_wlan_get_aplist(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : Initiate Scan */
+/**
+ * ks_wlan_set_scan() - Initiate scan.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_scan(struct net_device *dev,
 			    struct iw_request_info *info,
 			    union iwreq_data *wrqu, char *extra)
@@ -1423,10 +1518,11 @@ static int ks_wlan_set_scan(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/*
+/**
+ * ks_wlan_translate_scan() - Translate scan.
+ *
  * Translate scan data returned from the card to a card independent
- * format that the Wireless Tools will understand - Jean II
+ * format that the Wireless Tools will understand - Jean II.
  */
 static inline char *ks_wlan_translate_scan(struct net_device *dev,
 					   struct iw_request_info *info,
@@ -1584,8 +1680,11 @@ static inline char *ks_wlan_translate_scan(struct net_device *dev,
 	return current_ev;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : Read Scan Results */
+/**
+ * ks_wlan_get_scan() - Read scan results.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_scan(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_point *dwrq,
 			    char *extra)
@@ -1644,8 +1743,11 @@ static int ks_wlan_get_scan(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Commit handler : called after a bunch of SET operations */
+/**
+ * ks_wlan_config_commit()
+ *
+ * Commit handler: Called after a bunch of SET operations.
+ */
 static int ks_wlan_config_commit(struct net_device *dev,
 				 struct iw_request_info *info, void *zwrq,
 				 char *extra)
@@ -1661,8 +1763,11 @@ static int ks_wlan_config_commit(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless handler : set association ie params */
+/**
+ * ks_wlan_set_genie() - Set association.
+ *
+ * Wireless Handler: Set association i.e params
+ */
 static int ks_wlan_set_genie(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -1679,8 +1784,11 @@ static int ks_wlan_set_genie(struct net_device *dev,
 //      return -EOPNOTSUPP;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless handler : set authentication mode params */
+/**
+ * ks_wlan_set_auth_mode() - Set authentication mode params.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_auth_mode(struct net_device *dev,
 				 struct iw_request_info *info,
 				 struct iw_param *vwrq, char *extra)
@@ -1816,8 +1924,11 @@ static int ks_wlan_set_auth_mode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless handler : get authentication mode params */
+/**
+ * ks_wlan_get_auth_mode() - Get authentication mode params.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_auth_mode(struct net_device *dev,
 				 struct iw_request_info *info,
 				 struct iw_param *vwrq, char *extra)
@@ -1862,8 +1973,11 @@ static int ks_wlan_get_auth_mode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set encoding token & mode (WPA)*/
+/**
+ * ks_wlan_set_encode_ext() - Set encoding token & mode (WPA).
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_encode_ext(struct net_device *dev,
 				  struct iw_request_info *info,
 				  struct iw_point *dwrq, char *extra)
@@ -1970,8 +2084,11 @@ static int ks_wlan_set_encode_ext(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : get encoding token & mode (WPA)*/
+/**
+ * ks_wlan_get_encode_ext() - Get encoding token & mode (WPA).
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_get_encode_ext(struct net_device *dev,
 				  struct iw_request_info *info,
 				  struct iw_point *dwrq, char *extra)
@@ -1993,8 +2110,11 @@ static int ks_wlan_get_encode_ext(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : PMKSA cache operation (WPA2) */
+/**
+ * ks_wlan_set_pmksa() - PMKSA cache operation (WPA2).
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_pmksa(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -2131,8 +2251,11 @@ static struct iw_statistics *ks_get_wireless_stats(struct net_device *dev)
 	return wstats;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set stop request */
+/**
+ * ks_wlan_set_stop_request() - Set stop request.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_stop_request(struct net_device *dev,
 				    struct iw_request_info *info, __u32 *uwrq,
 				    char *extra)
@@ -2152,9 +2275,12 @@ static int ks_wlan_set_stop_request(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Wireless Handler : set MLME */
 #include <linux/ieee80211.h>
+/**
+ * ks_wlan_set_mlme() - Set MLME.
+ *
+ * Wireless Handler
+ */
 static int ks_wlan_set_mlme(struct net_device *dev,
 			    struct iw_request_info *info, struct iw_point *dwrq,
 			    char *extra)
@@ -2182,8 +2308,11 @@ static int ks_wlan_set_mlme(struct net_device *dev,
 	}
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get firemware version */
+/**
+ * ks_wlan_get_firmware_version() - Get firmware version.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_firmware_version(struct net_device *dev,
 					struct iw_request_info *info,
 					struct iw_point *dwrq, char *extra)
@@ -2196,8 +2325,12 @@ static int ks_wlan_get_firmware_version(struct net_device *dev,
 }
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : set force disconnect status */
+
+/**
+ * ks_wlan_set_detach() - Set force disconnect status.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_detach(struct net_device *dev,
 			      struct iw_request_info *info, __u32 *uwrq,
 			      char *extra)
@@ -2222,8 +2355,11 @@ static int ks_wlan_set_detach(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get force disconnect status */
+/**
+ * ks_wlan_get_detach() - Get force disconnect status.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_detach(struct net_device *dev,
 			      struct iw_request_info *info, __u32 *uwrq,
 			      char *extra)
@@ -2238,8 +2374,11 @@ static int ks_wlan_get_detach(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get connect status */
+/**
+ * ks_wlan_get_connect() - Get connect status.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_connect(struct net_device *dev,
 			       struct iw_request_info *info, __u32 *uwrq,
 			       char *extra)
@@ -2255,8 +2394,11 @@ static int ks_wlan_get_connect(struct net_device *dev,
 }
 #endif
 
-/*------------------------------------------------------------------*/
-/* Private handler : set preamble */
+/**
+ * ks_wlan_set_preamble() - Set preamble.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_preamble(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2280,8 +2422,11 @@ static int ks_wlan_set_preamble(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get preamble */
+/**
+ * ks_wlan_get_preamble() - Get preamble.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_preamble(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2297,8 +2442,11 @@ static int ks_wlan_get_preamble(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set power save mode */
+/**
+ * ks_wlan_set_powermgt() - Set power save mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_powermgt(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2331,8 +2479,11 @@ static int ks_wlan_set_powermgt(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get power save made */
+/**
+ * ks_wlan_get_powermgt() - Get power save mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_powermgt(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2348,8 +2499,11 @@ static int ks_wlan_get_powermgt(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set scan type */
+/**
+ * ks_wlan_set_scan_type() - Set scan type.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_scan_type(struct net_device *dev,
 				 struct iw_request_info *info, __u32 *uwrq,
 				 char *extra)
@@ -2371,8 +2525,11 @@ static int ks_wlan_set_scan_type(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get scan type */
+/**
+ * ks_wlan_get_scan_type() - Get scan type.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_scan_type(struct net_device *dev,
 				 struct iw_request_info *info, __u32 *uwrq,
 				 char *extra)
@@ -2388,8 +2545,12 @@ static int ks_wlan_get_scan_type(struct net_device *dev,
 }
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : write raw data to device */
+
+/**
+ * ks_wlan_data_write() - Write raw data to device.
+ *
+ * Private Handler
+ */
 static int ks_wlan_data_write(struct net_device *dev,
 			      struct iw_request_info *info,
 			      struct iw_point *dwrq, char *extra)
@@ -2411,8 +2572,11 @@ static int ks_wlan_data_write(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : read raw data form device */
+/**
+ * ks_wlan_data_read() - Read raw data to device.
+ *
+ * Private Handler
+ */
 static int ks_wlan_data_read(struct net_device *dev,
 			     struct iw_request_info *info,
 			     struct iw_point *dwrq, char *extra)
@@ -2468,9 +2632,12 @@ static int ks_wlan_data_read(struct net_device *dev,
 #endif
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : get wep string */
 #define WEP_ASCII_BUFF_SIZE (17 + 64 * 4 + 1)
+/**
+ * ks_wlan_get_wep_ascii() - Get WEP string.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_wep_ascii(struct net_device *dev,
 				 struct iw_request_info *info,
 				 struct iw_point *dwrq, char *extra)
@@ -2518,8 +2685,11 @@ static int ks_wlan_get_wep_ascii(struct net_device *dev,
 }
 #endif
 
-/*------------------------------------------------------------------*/
-/* Private handler : set beacon lost count */
+/**
+ * ks_wlan_set_beacon_lost() - Set beacon lost count.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_beacon_lost(struct net_device *dev,
 				   struct iw_request_info *info, __u32 *uwrq,
 				   char *extra)
@@ -2543,8 +2713,11 @@ static int ks_wlan_set_beacon_lost(struct net_device *dev,
 	}
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get beacon lost count */
+/**
+ * ks_wlan_get_beacon_lost() - Get beacon lost count.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_beacon_lost(struct net_device *dev,
 				   struct iw_request_info *info, __u32 *uwrq,
 				   char *extra)
@@ -2559,8 +2732,11 @@ static int ks_wlan_get_beacon_lost(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set phy type */
+/**
+ * ks_wlan_set_phy_type() - Set phy type.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_phy_type(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2585,8 +2761,11 @@ static int ks_wlan_set_phy_type(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get phy type */
+/**
+ * ks_wlan_get_phy_type() - Get phy type.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_phy_type(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2601,8 +2780,11 @@ static int ks_wlan_get_phy_type(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set cts mode */
+/**
+ * ks_wlan_set_cts_mode() - Set CTS mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_cts_mode(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2630,8 +2812,11 @@ static int ks_wlan_set_cts_mode(struct net_device *dev,
 	return -EINPROGRESS;	/* Call commit handler */
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get cts mode */
+/**
+ * ks_wlan_get_cts_mode() - Get CTS mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_cts_mode(struct net_device *dev,
 				struct iw_request_info *info, __u32 *uwrq,
 				char *extra)
@@ -2646,8 +2831,11 @@ static int ks_wlan_get_cts_mode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set sleep mode */
+/**
+ * ks_wlan_set_sleep_mode() - Set sleep mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_sleep_mode(struct net_device *dev,
 				  struct iw_request_info *info,
 				  __u32 *uwrq, char *extra)
@@ -2676,8 +2864,11 @@ static int ks_wlan_set_sleep_mode(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get sleep mode */
+/**
+ * ks_wlan_get_sleep_mode() - Get sleep mode.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_sleep_mode(struct net_device *dev,
 				  struct iw_request_info *info,
 				  __u32 *uwrq, char *extra)
@@ -2692,8 +2883,12 @@ static int ks_wlan_get_sleep_mode(struct net_device *dev,
 }
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : set phy information timer */
+
+/**
+ * ks_wlan_set_phy_information_timer() - Set phy information timer.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_phy_information_timer(struct net_device *dev,
 					     struct iw_request_info *info,
 					     __u32 *uwrq, char *extra)
@@ -2713,8 +2908,11 @@ static int ks_wlan_set_phy_information_timer(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get phy information timer */
+/**
+ * ks_wlan_get_phy_information_timer() - Get phy information timer.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_phy_information_timer(struct net_device *dev,
 					     struct iw_request_info *info,
 					     __u32 *uwrq, char *extra)
@@ -2730,8 +2928,12 @@ static int ks_wlan_get_phy_information_timer(struct net_device *dev,
 #endif
 
 #ifdef WPS
-/*------------------------------------------------------------------*/
-/* Private handler : set WPS enable */
+
+/**
+ * ks_wlan_set_wps_enable() - Set WPS enable.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_wps_enable(struct net_device *dev,
 				  struct iw_request_info *info, __u32 *uwrq,
 				  char *extra)
@@ -2753,8 +2955,11 @@ static int ks_wlan_set_wps_enable(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get WPS enable */
+/**
+ * ks_wlan_get_wps_enable() - Get WPS enable.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_wps_enable(struct net_device *dev,
 				  struct iw_request_info *info, __u32 *uwrq,
 				  char *extra)
@@ -2772,8 +2977,11 @@ static int ks_wlan_get_wps_enable(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set WPS probe req */
+/**
+ * ks_wlan_set_wps_probe_req() - Set WPS probe req.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_wps_probe_req(struct net_device *dev,
 				     struct iw_request_info *info,
 				     struct iw_point *dwrq, char *extra)
@@ -2811,8 +3019,12 @@ static int ks_wlan_set_wps_probe_req(struct net_device *dev,
 }
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : get WPS probe req */
+
+/**
+ * ks_wlan_get_wps_probe_req() - Get WPS probe req.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_wps_probe_req(struct net_device *dev,
 				     struct iw_request_info *info,
 				     __u32 *uwrq, char *extra)
@@ -2829,8 +3041,11 @@ static int ks_wlan_get_wps_probe_req(struct net_device *dev,
 #endif
 #endif /* WPS */
 
-/*------------------------------------------------------------------*/
-/* Private handler : set tx gain control value */
+/**
+ * ks_wlan_set_tx_gain() - Set tx gain control value.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_tx_gain(struct net_device *dev,
 			       struct iw_request_info *info, __u32 *uwrq,
 			       char *extra)
@@ -2855,8 +3070,11 @@ static int ks_wlan_set_tx_gain(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get tx gain control value */
+/**
+ * ks_wlan_get_tx_gain() - Get Tx gain control value.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_tx_gain(struct net_device *dev,
 			       struct iw_request_info *info, __u32 *uwrq,
 			       char *extra)
@@ -2872,8 +3090,11 @@ static int ks_wlan_get_tx_gain(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : set rx gain control value */
+/**
+ * ks_wlan_set_rx_gain() - Set Rx gain control value.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_rx_gain(struct net_device *dev,
 			       struct iw_request_info *info, __u32 *uwrq,
 			       char *extra)
@@ -2898,8 +3119,11 @@ static int ks_wlan_set_rx_gain(struct net_device *dev,
 	return 0;
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get rx gain control value */
+/**
+ * ks_wlan_get_rx_gain() - Get Rx gain control value.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_rx_gain(struct net_device *dev,
 			       struct iw_request_info *info, __u32 *uwrq,
 			       char *extra)
@@ -2916,8 +3140,12 @@ static int ks_wlan_get_rx_gain(struct net_device *dev,
 }
 
 #if 0
-/*------------------------------------------------------------------*/
-/* Private handler : set region value */
+
+/**
+ * ks_wlan_set_region() - Set region value.
+ *
+ * Private Handler
+ */
 static int ks_wlan_set_region(struct net_device *dev,
 			      struct iw_request_info *info, __u32 *uwrq,
 			      char *extra)
@@ -2937,8 +3165,11 @@ static int ks_wlan_set_region(struct net_device *dev,
 }
 #endif
 
-/*------------------------------------------------------------------*/
-/* Private handler : get eeprom checksum result */
+/**
+ * ks_wlan_get_eeprom_cksum() - Get eeprom checksum result.
+ *
+ * Private Handler
+ */
 static int ks_wlan_get_eeprom_cksum(struct net_device *dev,
 				    struct iw_request_info *info, __u32 *uwrq,
 				    char *extra)
@@ -3063,8 +3294,11 @@ static void print_hif_event(struct net_device *dev, int event)
 	}
 }
 
-/*------------------------------------------------------------------*/
-/* Private handler : get host command history */
+/**
+ * ks_wlan_hostt() - Get host command history.
+ *
+ * Private Handler
+ */
 static int ks_wlan_hostt(struct net_device *dev, struct iw_request_info *info,
 			 __u32 *uwrq, char *extra)
 {
@@ -3373,9 +3607,11 @@ void send_packet_complete(void *arg1, void *arg2)
 	}
 }
 
-/*
- * Set or clear the multicast filter for this adaptor.
- * This routine is not state sensitive and need not be SMP locked.
+/**
+ * ks_wlan_set_multicast() - Set or clear the multicast filter.
+ *
+ * Set or clear the multicast filter for this adaptor. This routine is
+ * not state sensitive and need not be SMP locked.
  */
 static
 void ks_wlan_set_multicast_list(struct net_device *dev)
-- 
2.7.4



More information about the devel mailing list