Staging: comedi: Fixed coding style issues in comedi.h
PATCH 1/1 Staging: comedi: Fixed coding style issues in comedi.h
This patch is to the comedi.h file that fixes up following type of 42 warning in the file:
-Blocking comments use a trailing */ on a separate line -Block comments use * on subsequent lines
--- drivers/staging/comedi/comedi.h | 183 +++++++++++++++++++++++----------------- 1 file changed, 107 insertions(+), 76 deletions(-)
drivers/staging/comedi/comedi.h +107 -76
@@ -1,20 +1,20 @@ -/* -include/comedi.h (installed as /usr/include/comedi.h) -header file for comedi - -COMEDI - Linux Control and Measurement Device Interface -Copyright (C) 1998-2001 David A. Schleef <[email protected]> - -This program is free software; you can redistribute it and/or modify -it under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. -*/ +/** +* include/comedi.h (installed as /usr/include/comedi.h) +* header file for comedi + +* COMEDI - Linux Control and Measurement Device Interface +* Copyright (C) 1998-2001 David A. Schleef <[email protected]> + +* This program is free software; you can redistribute it and/or modify +* it under the terms of the GNU Lesser General Public License as published by +* the Free Software Foundation; either version 2 of the License, or +* (at your option) any later version. + +* This program is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +*/ #ifndef _COMEDI_H#define _COMEDI_H
@@ -27,17 +27,17 @@/* comedi's major device number */ #define COMEDI_MAJOR 98 -/* -maximum number of minor devices. This can be increased, although -kernel structures are currently statically allocated, thus you -don't want this to be much more than you actually use. +/** +* maximum number of minor devices. This can be increased, although +* kernel structures are currently statically allocated, thus you +* don't want this to be much more than you actually use. */ #define COMEDI_NDEVICES 16/* number of config options in the config structure */ #define COMEDI_NDEVCONFOPTS 32 -/* +/** * NOTE: 'comedi_config --init-data' is deprecated * * The following indexes in the config options were used by
@@ -298,7 +298,7 @@ enum configuration_ids { INSN_CONFIG_PWM_GET_H_BRIDGE = 5004 }; -/* +/** * Settings for INSN_CONFIG_DIGITAL_TRIG: * data[0] = INSN_CONFIG_DIGITAL_TRIG * data[1] = trigger ID
@@ -520,24 +520,24 @@ struct comedi_bufinfo {/* everything after this line is ALPHA */ /**********************************************************/ -/* -8254 specific configuration. +/** +* 8254 specific configuration. -It supports two config commands: +* It supports two config commands: -0 ID: INSN_CONFIG_SET_COUNTER_MODE -1 8254 Mode -I8254_MODE0, I8254_MODE1, ..., I8254_MODE5 -OR'ed with: -I8254_BCD, I8254_BINARY +* 0 ID: INSN_CONFIG_SET_COUNTER_MODE +* 1 8254 Mode +* I8254_MODE0, I8254_MODE1, ..., I8254_MODE5 +* OR'ed with: +* I8254_BCD, I8254_BINARY -0 ID: INSN_CONFIG_8254_READ_STATUS -1 <-- Status byte returned here. -B7 = Output -B6 = NULL Count -B5 - B0 Current mode. - -*/ +* 0 ID: INSN_CONFIG_8254_READ_STATUS +* 1 <-- Status byte returned here. +* B7 = Output +* B6 = NULL Count +* B5 - B0 Current mode. +* +*/ enum i8254_mode {I8254_MODE0 = (0 <<1 ),/* Interrupt on terminal count */
@@ -555,8 +555,10 @@ enum i8254_mode {#define NI_USUAL_PFI_SELECT (x) (((x) < 10) ? (0x1 + (x)) : (0xb + (x)))#define NI_USUAL_RTSI_SELECT (x) (((x) < 7) ? (0xb + (x)) : 0x1b) -/* mode bits for NI general-purpose counters, set with -* INSN_CONFIG_SET_COUNTER_MODE */ +/** +* mode bits for NI general-purpose counters, set with +* INSN_CONFIG_SET_COUNTER_MODE +*/ #define NI_GPCT_COUNTING_MODE_SHIFT 16#define NI_GPCT_INDEX_PHASE_BITSHIFT 20#define NI_GPCT_COUNTING_DIRECTION_SHIFT 24
@@ -624,8 +626,10 @@ enum ni_gpct_mode_bits {NI_GPCT_INVERT_OUTPUT_BIT =0x20000000 }; -/* Bits for setting a clock source with -* INSN_CONFIG_SET_CLOCK_SRC when using NI general-purpose counters. */ +/** +* Bits for setting a clock source with +* INSN_CONFIG_SET_CLOCK_SRC when using NI general-purpose counters. +*/ enum ni_gpct_clock_source_bits {NI_GPCT_CLOCK_SRC_SELECT_MASK =0x3f ,NI_GPCT_TIMEBASE_1_CLOCK_SRC_BITS =0x0 ,
@@ -656,9 +660,11 @@ enum ni_gpct_clock_source_bits {/* no pfi on NI 660x */ #define NI_GPCT_PFI_CLOCK_SRC_BITS (x) (0x20 + (x)) -/* Possibilities for setting a gate source with -INSN_CONFIG_SET_GATE_SRC when using NI general-purpose counters. -May be bitwise-or'd with CR_EDGE or CR_INVERT. */ +/** +* Possibilities for setting a gate source with +* INSN_CONFIG_SET_GATE_SRC when using NI general-purpose counters. +* May be bitwise-or'd with CR_EDGE or CR_INVERT. +*/ enum ni_gpct_gate_select {/* m-series gates */ NI_GPCT_TIMESTAMP_MUX_GATE_SELECT =0x0 ,
@@ -686,8 +692,10 @@ enum ni_gpct_gate_select {#define NI_GPCT_PFI_GATE_SELECT (x) NI_USUAL_PFI_SELECT(x)#define NI_GPCT_UP_DOWN_PIN_GATE_SELECT (x) (0x202 + (x)) -/* Possibilities for setting a source with -INSN_CONFIG_SET_OTHER_SRC when using NI general-purpose counters. */ +/** +* Possibilities for setting a source with +* INSN_CONFIG_SET_OTHER_SRC when using NI general-purpose counters. +*/ enum ni_gpct_other_index {NI_GPCT_SOURCE_ENCODER_A ,NI_GPCT_SOURCE_ENCODER_B ,
@@ -702,8 +710,10 @@ enum ni_gpct_other_select {#define NI_GPCT_PFI_OTHER_SELECT (x) NI_USUAL_PFI_SELECT(x) -/* start sources for ni general-purpose counters for use with -INSN_CONFIG_ARM */ +/** +* start sources for ni general-purpose counters for use with +* INSN_CONFIG_ARM +*/ enum ni_gpct_arm_source {NI_GPCT_ARM_IMMEDIATE =0x0 ,NI_GPCT_ARM_PAIRED_IMMEDIATE =0x1 ,/* Start both the counter
@@ -728,8 +738,10 @@ enum ni_gpct_filter_select { NI_GPCT_FILTER_2x_TIMEBASE_3 =0x6 }; -/* PFI digital filtering options for ni m-series for use with -* INSN_CONFIG_FILTER. */ +/** +* PFI digital filtering options for ni m-series for use with +* INSN_CONFIG_FILTER. +*/ enum ni_pfi_filter_select {NI_PFI_FILTER_OFF =0x0 , NI_PFI_FILTER_125ns =0x1 ,
@@ -750,9 +762,11 @@ enum ni_mio_clock_source {#define NI_MIO_PLL_RTSI_CLOCK (x) (NI_MIO_PLL_RTSI0_CLOCK + (x)) -/* Signals which can be routed to an NI RTSI pin with INSN_CONFIG_SET_ROUTING. -The numbers assigned are not arbitrary, they correspond to the bits required -to program the board. */ +/** +* Signals which can be routed to an NI RTSI pin with INSN_CONFIG_SET_ROUTING. +* The numbers assigned are not arbitrary, they correspond to the bits required +* to program the board. +*/ enum ni_rtsi_routing {NI_RTSI_OUTPUT_ADR_START1 =0 ,NI_RTSI_OUTPUT_ADR_START2 =1 ,
@@ -769,11 +783,13 @@ enum ni_rtsi_routing {#define NI_RTSI_OUTPUT_RTSI_BRD (x) (NI_RTSI_OUTPUT_RTSI_BRD_0 + (x)) -/* Signals which can be routed to an NI PFI pin on an m-series board with +/** +* Signals which can be routed to an NI PFI pin on an m-series board with * INSN_CONFIG_SET_ROUTING. These numbers are also returned by * INSN_CONFIG_GET_ROUTING on pre-m-series boards, even though their routing * cannot be changed. The numbers assigned are not arbitrary, they correspond -* to the bits required to program the board. */ +* to the bits required to program the board. +*/ enum ni_pfi_routing {NI_PFI_OUTPUT_PFI_DEFAULT =0 ,NI_PFI_OUTPUT_AI_START1 =1 ,
@@ -804,19 +820,22 @@ enum ni_pfi_routing {#define NI_PFI_OUTPUT_RTSI (x) (NI_PFI_OUTPUT_RTSI0 + (x))/* Signals which can be routed to output on a NI PFI pin on a 660x board -with INSN_CONFIG_SET_ROUTING. The numbers assigned are -not arbitrary, they correspond to the bits required -to program the board. Lines 0 to 7 can only be set to -NI_660X_PFI_OUTPUT_DIO. Lines 32 to 39 can only be set to -NI_660X_PFI_OUTPUT_COUNTER. */ +* with INSN_CONFIG_SET_ROUTING. The numbers assigned are +* not arbitrary, they correspond to the bits required +* to program the board. Lines 0 to 7 can only be set to +* NI_660X_PFI_OUTPUT_DIO. Lines 32 to 39 can only be set to +* NI_660X_PFI_OUTPUT_COUNTER. +*/ enum ni_660x_pfi_routing {NI_660X_PFI_OUTPUT_COUNTER =1 ,/* counter */ NI_660X_PFI_OUTPUT_DIO =2 ,/* static digital output */ }; -/* NI External Trigger lines. These values are not arbitrary, but are related +/** +* NI External Trigger lines. These values are not arbitrary, but are related * to the bits required to program the board (offset by 1 for historical -* reasons). */ +* reasons). +*/ #define NI_EXT_PFI (x) (NI_USUAL_PFI_SELECT(x) - 1)#define NI_EXT_RTSI (x) (NI_USUAL_RTSI_SELECT(x) - 1)
@@ -827,9 +846,11 @@ enum comedi_counter_status_flags { COMEDI_COUNTER_TERMINAL_COUNT = 0x4, }; -/* Clock sources for CDIO subdevice on NI m-series boards. Used as the +/** +* Clock sources for CDIO subdevice on NI m-series boards. Used as the * scan_begin_arg for a comedi_command. These sources may also be bitwise-or'd -* with CR_INVERT to change polarity. */ +* with CR_INVERT to change polarity. +*/ enum ni_m_series_cdio_scan_begin_src {NI_CDIO_SCAN_BEGIN_SRC_GROUND =0 ,NI_CDIO_SCAN_BEGIN_SRC_AI_START =18 ,
@@ -846,21 +867,27 @@ enum ni_m_series_cdio_scan_begin_src {#define NI_CDIO_SCAN_BEGIN_SRC_PFI (x) NI_USUAL_PFI_SELECT(x)#define NI_CDIO_SCAN_BEGIN_SRC_RTSI (x) NI_USUAL_RTSI_SELECT(x) -/* scan_begin_src for scan_begin_arg==TRIG_EXT with analog output command on NI +/** +* scan_begin_src for scan_begin_arg==TRIG_EXT with analog output command on NI * boards. These scan begin sources can also be bitwise-or'd with CR_INVERT to -* change polarity. */ +* change polarity. +*/ #define NI_AO_SCAN_BEGIN_SRC_PFI (x) NI_USUAL_PFI_SELECT(x)#define NI_AO_SCAN_BEGIN_SRC_RTSI (x) NI_USUAL_RTSI_SELECT(x) -/* Bits for setting a clock source with -* INSN_CONFIG_SET_CLOCK_SRC when using NI frequency output subdevice. */ +/** +* Bits for setting a clock source with +* INSN_CONFIG_SET_CLOCK_SRC when using NI frequency output subdevice. +*/ enum ni_freq_out_clock_source_bits {NI_FREQ_OUT_TIMEBASE_1_DIV_2_CLOCK_SRC ,/* 10 MHz */ NI_FREQ_OUT_TIMEBASE_2_CLOCK_SRC /* 100 KHz */ }; -/* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for -* 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). */ +/** +* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for +* 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). +*/ enum amplc_dio_clock_source {AMPLC_DIO_CLK_CLKN ,/* per channel external clock input/output pin (pin is only an
@@ -886,16 +913,20 @@ enum amplc_dio_clock_source {AMPLC_DIO_CLK_20MHZ /* 20 MHz internal clock */ }; -/* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for -* timer subdevice on some Amplicon DIO PCIe boards (amplc_dio200 driver). */ +/* +* Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for +* timer subdevice on some Amplicon DIO PCIe boards (amplc_dio200 driver). +*/ enum amplc_dio_ts_clock_src {AMPLC_DIO_TS_CLK_1GHZ ,/* 1 ns period with 20 ns granularity */ AMPLC_DIO_TS_CLK_1MHZ ,/* 1 us period */ AMPLC_DIO_TS_CLK_1KHZ /* 1 ms period */ }; -/* Values for setting a gate source with INSN_CONFIG_SET_GATE_SRC for -* 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). */ +/** +* Values for setting a gate source with INSN_CONFIG_SET_GATE_SRC for +* 8254 counter subdevices on Amplicon DIO boards (amplc_dio200 driver). +*/ enum amplc_dio_gate_source {AMPLC_DIO_GAT_VCC ,/* internal high logic level */ AMPLC_DIO_GAT_GND ,/* internal low logic level */
@@ -923,7 +954,7 @@ enum amplc_dio_gate_source { AMPLC_DIO_GAT_NPAT_GONE /* negated "pattern gone away" */ }; -/* +/** * Values for setting a clock source with INSN_CONFIG_SET_CLOCK_SRC for * the counter subdevice on the Kolter Electronic PCI-Counter board * (ke_counter driver).
Signature · 1 line
2.5.2
Quoted 25 lines · Punit Vara
This patch is to the
comedi.hfile that fixes up following type of 42 warning in the file:-Blocking comments use a trailing */ on a separate line -Block comments use * on subsequent lines
Signed-off-by Punit Vara <[email protected]>--- drivers/staging/comedi/comedi.h | 183 +++++++++++++++++++++++----------------- 1 file changed, 107 insertions(+), 76 deletions(-)drivers/staging/comedi/comedi.h +0
-8@@ -1,20 +1,20 @@ -/* -include/comedi.h (installed as /usr/include/comedi.h) -header file for comedi - -COMEDI - Linux Control and Measurement Device Interface -Copyright (C) 1998-2001 David A. Schleef <[email protected]> - -This program is free software; you can redistribute it and/or modify
drivers/staging/comedi/comedi.h line 1
Quoted 10 lines
drivers/staging/comedi/comedi.h +1
-9-it under the terms of the GNU Lesser General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. -*/ +/**
That's the wrong sort of comment opening. It should be '/*'. The '/**' form is reserved for kernel-doc mark-up.
drivers/staging/comedi/comedi.h line 4
Quoted 3 lines
drivers/staging/comedi/comedi.h +3
-0+* include/comedi.h (installed as /usr/include/comedi.h) +* header file for comedi +
These blank lines in the block comment should be ' *'.
(The same applies to the other comments you changed in this patch.)
Signature · 2 lines
-=( Ian Abbott @ MEV Ltd. E-mail: <[email protected]> )=- -=( Web: http://www.mev.co.uk/ )=-