diff options
author | Ben Hutchings <bhutchings@solarflare.com> | 2012-07-10 06:56:00 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-07-11 02:13:46 -0400 |
commit | 49ce9c2cda18f62b13055dc715e7b514157c2da8 (patch) | |
tree | 432dea5cfd5c5f4b95a71a1e958e13b5cc538a1f /drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c | |
parent | ae86b9e3846f6fc5509dee721f2bdba1db8ab96a (diff) |
drivers/net/ethernet: Fix (nearly-)kernel-doc comments for various functions
Fix incorrect start markers, wrapped summary lines, missing section
breaks, incorrect separators, and some name mismatches. Delete
a few that are content-free.
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c')
-rw-r--r-- | drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c b/drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c index daddd844691f..3456d5617143 100644 --- a/drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c +++ b/drivers/net/ethernet/intel/ixgbe/ixgbe_ptp.c | |||
@@ -107,7 +107,7 @@ static struct sock_filter ptp_filter[] = { | |||
107 | 107 | ||
108 | /** | 108 | /** |
109 | * ixgbe_ptp_read - read raw cycle counter (to be used by time counter) | 109 | * ixgbe_ptp_read - read raw cycle counter (to be used by time counter) |
110 | * @cc - the cyclecounter structure | 110 | * @cc: the cyclecounter structure |
111 | * | 111 | * |
112 | * this function reads the cyclecounter registers and is called by the | 112 | * this function reads the cyclecounter registers and is called by the |
113 | * cyclecounter structure used to construct a ns counter from the | 113 | * cyclecounter structure used to construct a ns counter from the |
@@ -128,8 +128,8 @@ static cycle_t ixgbe_ptp_read(const struct cyclecounter *cc) | |||
128 | 128 | ||
129 | /** | 129 | /** |
130 | * ixgbe_ptp_adjfreq | 130 | * ixgbe_ptp_adjfreq |
131 | * @ptp - the ptp clock structure | 131 | * @ptp: the ptp clock structure |
132 | * @ppb - parts per billion adjustment from base | 132 | * @ppb: parts per billion adjustment from base |
133 | * | 133 | * |
134 | * adjust the frequency of the ptp cycle counter by the | 134 | * adjust the frequency of the ptp cycle counter by the |
135 | * indicated ppb from the base frequency. | 135 | * indicated ppb from the base frequency. |
@@ -175,8 +175,8 @@ static int ixgbe_ptp_adjfreq(struct ptp_clock_info *ptp, s32 ppb) | |||
175 | 175 | ||
176 | /** | 176 | /** |
177 | * ixgbe_ptp_adjtime | 177 | * ixgbe_ptp_adjtime |
178 | * @ptp - the ptp clock structure | 178 | * @ptp: the ptp clock structure |
179 | * @delta - offset to adjust the cycle counter by | 179 | * @delta: offset to adjust the cycle counter by |
180 | * | 180 | * |
181 | * adjust the timer by resetting the timecounter structure. | 181 | * adjust the timer by resetting the timecounter structure. |
182 | */ | 182 | */ |
@@ -203,8 +203,8 @@ static int ixgbe_ptp_adjtime(struct ptp_clock_info *ptp, s64 delta) | |||
203 | 203 | ||
204 | /** | 204 | /** |
205 | * ixgbe_ptp_gettime | 205 | * ixgbe_ptp_gettime |
206 | * @ptp - the ptp clock structure | 206 | * @ptp: the ptp clock structure |
207 | * @ts - timespec structure to hold the current time value | 207 | * @ts: timespec structure to hold the current time value |
208 | * | 208 | * |
209 | * read the timecounter and return the correct value on ns, | 209 | * read the timecounter and return the correct value on ns, |
210 | * after converting it into a struct timespec. | 210 | * after converting it into a struct timespec. |
@@ -229,8 +229,8 @@ static int ixgbe_ptp_gettime(struct ptp_clock_info *ptp, struct timespec *ts) | |||
229 | 229 | ||
230 | /** | 230 | /** |
231 | * ixgbe_ptp_settime | 231 | * ixgbe_ptp_settime |
232 | * @ptp - the ptp clock structure | 232 | * @ptp: the ptp clock structure |
233 | * @ts - the timespec containing the new time for the cycle counter | 233 | * @ts: the timespec containing the new time for the cycle counter |
234 | * | 234 | * |
235 | * reset the timecounter to use a new base value instead of the kernel | 235 | * reset the timecounter to use a new base value instead of the kernel |
236 | * wall timer value. | 236 | * wall timer value. |
@@ -256,9 +256,9 @@ static int ixgbe_ptp_settime(struct ptp_clock_info *ptp, | |||
256 | 256 | ||
257 | /** | 257 | /** |
258 | * ixgbe_ptp_enable | 258 | * ixgbe_ptp_enable |
259 | * @ptp - the ptp clock structure | 259 | * @ptp: the ptp clock structure |
260 | * @rq - the requested feature to change | 260 | * @rq: the requested feature to change |
261 | * @on - whether to enable or disable the feature | 261 | * @on: whether to enable or disable the feature |
262 | * | 262 | * |
263 | * enable (or disable) ancillary features of the phc subsystem. | 263 | * enable (or disable) ancillary features of the phc subsystem. |
264 | * our driver only supports the PPS feature on the X540 | 264 | * our driver only supports the PPS feature on the X540 |
@@ -294,8 +294,8 @@ static int ixgbe_ptp_enable(struct ptp_clock_info *ptp, | |||
294 | 294 | ||
295 | /** | 295 | /** |
296 | * ixgbe_ptp_check_pps_event | 296 | * ixgbe_ptp_check_pps_event |
297 | * @adapter - the private adapter structure | 297 | * @adapter: the private adapter structure |
298 | * @eicr - the interrupt cause register value | 298 | * @eicr: the interrupt cause register value |
299 | * | 299 | * |
300 | * This function is called by the interrupt routine when checking for | 300 | * This function is called by the interrupt routine when checking for |
301 | * interrupts. It will check and handle a pps event. | 301 | * interrupts. It will check and handle a pps event. |
@@ -325,8 +325,8 @@ void ixgbe_ptp_check_pps_event(struct ixgbe_adapter *adapter, u32 eicr) | |||
325 | 325 | ||
326 | /** | 326 | /** |
327 | * ixgbe_ptp_enable_sdp | 327 | * ixgbe_ptp_enable_sdp |
328 | * @hw - the hardware private structure | 328 | * @hw: the hardware private structure |
329 | * @shift - the clock shift for calculating nanoseconds | 329 | * @shift: the clock shift for calculating nanoseconds |
330 | * | 330 | * |
331 | * this function enables the clock out feature on the sdp0 for the | 331 | * this function enables the clock out feature on the sdp0 for the |
332 | * X540 device. It will create a 1second periodic output that can be | 332 | * X540 device. It will create a 1second periodic output that can be |
@@ -399,7 +399,7 @@ static void ixgbe_ptp_enable_sdp(struct ixgbe_hw *hw, int shift) | |||
399 | 399 | ||
400 | /** | 400 | /** |
401 | * ixgbe_ptp_disable_sdp | 401 | * ixgbe_ptp_disable_sdp |
402 | * @hw - the private hardware structure | 402 | * @hw: the private hardware structure |
403 | * | 403 | * |
404 | * this function disables the auxiliary SDP clock out feature | 404 | * this function disables the auxiliary SDP clock out feature |
405 | */ | 405 | */ |
@@ -769,7 +769,7 @@ int ixgbe_ptp_hwtstamp_ioctl(struct ixgbe_adapter *adapter, | |||
769 | 769 | ||
770 | /** | 770 | /** |
771 | * ixgbe_ptp_start_cyclecounter - create the cycle counter from hw | 771 | * ixgbe_ptp_start_cyclecounter - create the cycle counter from hw |
772 | * @adapter - pointer to the adapter structure | 772 | * @adapter: pointer to the adapter structure |
773 | * | 773 | * |
774 | * this function initializes the timecounter and cyclecounter | 774 | * this function initializes the timecounter and cyclecounter |
775 | * structures for use in generated a ns counter from the arbitrary | 775 | * structures for use in generated a ns counter from the arbitrary |
@@ -905,7 +905,7 @@ void ixgbe_ptp_start_cyclecounter(struct ixgbe_adapter *adapter) | |||
905 | 905 | ||
906 | /** | 906 | /** |
907 | * ixgbe_ptp_init | 907 | * ixgbe_ptp_init |
908 | * @adapter - the ixgbe private adapter structure | 908 | * @adapter: the ixgbe private adapter structure |
909 | * | 909 | * |
910 | * This function performs the required steps for enabling ptp | 910 | * This function performs the required steps for enabling ptp |
911 | * support. If ptp support has already been loaded it simply calls the | 911 | * support. If ptp support has already been loaded it simply calls the |