aboutsummaryrefslogtreecommitdiffstats
path: root/sound/usb
diff options
context:
space:
mode:
authorTakashi Iwai <tiwai@suse.de>2015-01-28 08:43:11 -0500
committerTakashi Iwai <tiwai@suse.de>2015-01-28 14:54:43 -0500
commitcddbd4f17078530b4914a42f6d7f3e543b5fad0e (patch)
treed7640e97a76003d1bc8b4dc0f80e5024efb0bb62 /sound/usb
parent0416980d0a2bc10acff1c2329159577036e5666b (diff)
ALSA: line6: Tidy up and typo fixes in comments
Just reformatting the comments and typos fixed, no functional changes. Particularly, - avoid the kerneldoc marker "/**", - reduce multiple comment lines into single lines, - corrected wrongly referred function names Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'sound/usb')
-rw-r--r--sound/usb/line6/driver.c2
-rw-r--r--sound/usb/line6/driver.h73
-rw-r--r--sound/usb/line6/midi.h32
-rw-r--r--sound/usb/line6/pcm.h52
-rw-r--r--sound/usb/line6/pod.c32
-rw-r--r--sound/usb/line6/podhd.c4
-rw-r--r--sound/usb/line6/toneport.c24
-rw-r--r--sound/usb/line6/variax.c20
8 files changed, 65 insertions, 174 deletions
diff --git a/sound/usb/line6/driver.c b/sound/usb/line6/driver.c
index a0436993a167..f46da99c44b3 100644
--- a/sound/usb/line6/driver.c
+++ b/sound/usb/line6/driver.c
@@ -44,7 +44,7 @@ static const char line6_request_version[] = {
44 0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7 44 0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7
45}; 45};
46 46
47/** 47/*
48 Class for asynchronous messages. 48 Class for asynchronous messages.
49*/ 49*/
50struct message { 50struct message {
diff --git a/sound/usb/line6/driver.h b/sound/usb/line6/driver.h
index fce10f12f0d3..80d42a0fd889 100644
--- a/sound/usb/line6/driver.h
+++ b/sound/usb/line6/driver.h
@@ -60,26 +60,20 @@ extern const unsigned char line6_midi_id[3];
60static const int SYSEX_DATA_OFS = sizeof(line6_midi_id) + 3; 60static const int SYSEX_DATA_OFS = sizeof(line6_midi_id) + 3;
61static const int SYSEX_EXTRA_SIZE = sizeof(line6_midi_id) + 4; 61static const int SYSEX_EXTRA_SIZE = sizeof(line6_midi_id) + 4;
62 62
63/** 63/*
64 Common properties of Line 6 devices. 64 Common properties of Line 6 devices.
65*/ 65*/
66struct line6_properties { 66struct line6_properties {
67 /** 67 /* Card id string (maximum 16 characters).
68 Card id string (maximum 16 characters). 68 * This can be used to address the device in ALSA programs as
69 This can be used to address the device in ALSA programs as 69 * "default:CARD=<id>"
70 "default:CARD=<id>" 70 */
71 */
72 const char *id; 71 const char *id;
73 72
74 /** 73 /* Card short name (maximum 32 characters) */
75 Card short name (maximum 32 characters).
76 */
77 const char *name; 74 const char *name;
78 75
79 /** 76 /* Bit vector defining this device's capabilities in line6usb driver */
80 Bit vector defining this device's capabilities in the
81 line6usb driver.
82 */
83 int capabilities; 77 int capabilities;
84 78
85 int altsetting; 79 int altsetting;
@@ -90,70 +84,47 @@ struct line6_properties {
90 unsigned ep_audio_w; 84 unsigned ep_audio_w;
91}; 85};
92 86
93/** 87/*
94 Common data shared by all Line 6 devices. 88 Common data shared by all Line 6 devices.
95 Corresponds to a pair of USB endpoints. 89 Corresponds to a pair of USB endpoints.
96*/ 90*/
97struct usb_line6 { 91struct usb_line6 {
98 /** 92 /* USB device */
99 USB device.
100 */
101 struct usb_device *usbdev; 93 struct usb_device *usbdev;
102 94
103 /** 95 /* Properties */
104 Properties.
105 */
106 const struct line6_properties *properties; 96 const struct line6_properties *properties;
107 97
108 /** 98 /* Interval (ms) */
109 Interval (ms).
110 */
111 int interval; 99 int interval;
112 100
113 /** 101 /* Maximum size of USB packet */
114 Maximum size of USB packet.
115 */
116 int max_packet_size; 102 int max_packet_size;
117 103
118 /** 104 /* Device representing the USB interface */
119 Device representing the USB interface.
120 */
121 struct device *ifcdev; 105 struct device *ifcdev;
122 106
123 /** 107 /* Line 6 sound card data structure.
124 Line 6 sound card data structure. 108 * Each device has at least MIDI or PCM.
125 Each device has at least MIDI or PCM. 109 */
126 */
127 struct snd_card *card; 110 struct snd_card *card;
128 111
129 /** 112 /* Line 6 PCM device data structure */
130 Line 6 PCM device data structure.
131 */
132 struct snd_line6_pcm *line6pcm; 113 struct snd_line6_pcm *line6pcm;
133 114
134 /** 115 /* Line 6 MIDI device data structure */
135 Line 6 MIDI device data structure.
136 */
137 struct snd_line6_midi *line6midi; 116 struct snd_line6_midi *line6midi;
138 117
139 /** 118 /* URB for listening to PODxt Pro control endpoint */
140 URB for listening to PODxt Pro control endpoint.
141 */
142 struct urb *urb_listen; 119 struct urb *urb_listen;
143 120
144 /** 121 /* Buffer for listening to PODxt Pro control endpoint */
145 Buffer for listening to PODxt Pro control endpoint.
146 */
147 unsigned char *buffer_listen; 122 unsigned char *buffer_listen;
148 123
149 /** 124 /* Buffer for message to be processed */
150 Buffer for message to be processed.
151 */
152 unsigned char *buffer_message; 125 unsigned char *buffer_message;
153 126
154 /** 127 /* Length of message to be processed */
155 Length of message to be processed.
156 */
157 int message_length; 128 int message_length;
158 129
159 void (*process_message)(struct usb_line6 *); 130 void (*process_message)(struct usb_line6 *);
diff --git a/sound/usb/line6/midi.h b/sound/usb/line6/midi.h
index 9d9467b2613c..cf82d69e2747 100644
--- a/sound/usb/line6/midi.h
+++ b/sound/usb/line6/midi.h
@@ -19,44 +19,28 @@
19#define MIDI_BUFFER_SIZE 1024 19#define MIDI_BUFFER_SIZE 1024
20 20
21struct snd_line6_midi { 21struct snd_line6_midi {
22 /** 22 /* Pointer back to the Line 6 driver data structure */
23 Pointer back to the Line 6 driver data structure.
24 */
25 struct usb_line6 *line6; 23 struct usb_line6 *line6;
26 24
27 /** 25 /* MIDI substream for receiving (or NULL if not active) */
28 MIDI substream for receiving (or NULL if not active).
29 */
30 struct snd_rawmidi_substream *substream_receive; 26 struct snd_rawmidi_substream *substream_receive;
31 27
32 /** 28 /* MIDI substream for transmitting (or NULL if not active) */
33 MIDI substream for transmitting (or NULL if not active).
34 */
35 struct snd_rawmidi_substream *substream_transmit; 29 struct snd_rawmidi_substream *substream_transmit;
36 30
37 /** 31 /* Number of currently active MIDI send URBs */
38 Number of currently active MIDI send URBs.
39 */
40 int num_active_send_urbs; 32 int num_active_send_urbs;
41 33
42 /** 34 /* Spin lock to protect MIDI buffer handling */
43 Spin lock to protect MIDI buffer handling.
44 */
45 spinlock_t lock; 35 spinlock_t lock;
46 36
47 /** 37 /* Wait queue for MIDI transmission */
48 Wait queue for MIDI transmission.
49 */
50 wait_queue_head_t send_wait; 38 wait_queue_head_t send_wait;
51 39
52 /** 40 /* Buffer for incoming MIDI stream */
53 Buffer for incoming MIDI stream.
54 */
55 struct midi_buffer midibuf_in; 41 struct midi_buffer midibuf_in;
56 42
57 /** 43 /* Buffer for outgoing MIDI stream */
58 Buffer for outgoing MIDI stream.
59 */
60 struct midi_buffer midibuf_out; 44 struct midi_buffer midibuf_out;
61}; 45};
62 46
diff --git a/sound/usb/line6/pcm.h b/sound/usb/line6/pcm.h
index 42d3e6fc2c61..19c12f0a9008 100644
--- a/sound/usb/line6/pcm.h
+++ b/sound/usb/line6/pcm.h
@@ -66,8 +66,8 @@
66 the running flag indicates whether the stream is running. 66 the running flag indicates whether the stream is running.
67 67
68 For monitor or impulse operations, the driver needs to call 68 For monitor or impulse operations, the driver needs to call
69 snd_line6_duplex_acquire() or snd_line6_duplex_release() with the 69 line6_pcm_acquire() or line6_pcm_release() with the appropriate
70 appropriate LINE6_STREAM_* flag. 70 LINE6_STREAM_* flag.
71*/ 71*/
72 72
73/* stream types */ 73/* stream types */
@@ -139,19 +139,13 @@ struct line6_pcm_stream {
139}; 139};
140 140
141struct snd_line6_pcm { 141struct snd_line6_pcm {
142 /** 142 /* Pointer back to the Line 6 driver data structure */
143 Pointer back to the Line 6 driver data structure.
144 */
145 struct usb_line6 *line6; 143 struct usb_line6 *line6;
146 144
147 /** 145 /* Properties. */
148 Properties.
149 */
150 struct line6_pcm_properties *properties; 146 struct line6_pcm_properties *properties;
151 147
152 /** 148 /* ALSA pcm stream */
153 ALSA pcm stream
154 */
155 struct snd_pcm *pcm; 149 struct snd_pcm *pcm;
156 150
157 /* protection to state changes of in/out streams */ 151 /* protection to state changes of in/out streams */
@@ -161,49 +155,31 @@ struct snd_line6_pcm {
161 struct line6_pcm_stream in; 155 struct line6_pcm_stream in;
162 struct line6_pcm_stream out; 156 struct line6_pcm_stream out;
163 157
164 /** 158 /* Previously captured frame (for software monitoring) */
165 Previously captured frame (for software monitoring).
166 */
167 unsigned char *prev_fbuf; 159 unsigned char *prev_fbuf;
168 160
169 /** 161 /* Size of previously captured frame (for software monitoring) */
170 Size of previously captured frame (for software monitoring).
171 */
172 int prev_fsize; 162 int prev_fsize;
173 163
174 /** 164 /* Maximum size of USB packet */
175 Maximum size of USB packet.
176 */
177 int max_packet_size; 165 int max_packet_size;
178 166
179 /** 167 /* PCM playback volume (left and right) */
180 PCM playback volume (left and right).
181 */
182 int volume_playback[2]; 168 int volume_playback[2];
183 169
184 /** 170 /* PCM monitor volume */
185 PCM monitor volume.
186 */
187 int volume_monitor; 171 int volume_monitor;
188 172
189 /** 173 /* Volume of impulse response test signal (if zero, test is disabled) */
190 Volume of impulse response test signal (if zero, test is disabled).
191 */
192 int impulse_volume; 174 int impulse_volume;
193 175
194 /** 176 /* Period of impulse response test signal */
195 Period of impulse response test signal.
196 */
197 int impulse_period; 177 int impulse_period;
198 178
199 /** 179 /* Counter for impulse response test signal */
200 Counter for impulse response test signal.
201 */
202 int impulse_count; 180 int impulse_count;
203 181
204 /** 182 /* Several status bits (see LINE6_FLAG_*) */
205 Several status bits (see LINE6_FLAG_*).
206 */
207 unsigned long flags; 183 unsigned long flags;
208}; 184};
209 185
diff --git a/sound/usb/line6/pod.c b/sound/usb/line6/pod.c
index 6f7cd585f2d8..bc20cf141719 100644
--- a/sound/usb/line6/pod.c
+++ b/sound/usb/line6/pod.c
@@ -58,44 +58,28 @@ enum {
58}; 58};
59 59
60struct usb_line6_pod { 60struct usb_line6_pod {
61 /** 61 /* Generic Line 6 USB data */
62 Generic Line 6 USB data.
63 */
64 struct usb_line6 line6; 62 struct usb_line6 line6;
65 63
66 /** 64 /* Instrument monitor level */
67 Instrument monitor level.
68 */
69 int monitor_level; 65 int monitor_level;
70 66
71 /** 67 /* Timer for device initialization */
72 Timer for device initializaton.
73 */
74 struct timer_list startup_timer; 68 struct timer_list startup_timer;
75 69
76 /** 70 /* Work handler for device initialization */
77 Work handler for device initializaton.
78 */
79 struct work_struct startup_work; 71 struct work_struct startup_work;
80 72
81 /** 73 /* Current progress in startup procedure */
82 Current progress in startup procedure.
83 */
84 int startup_progress; 74 int startup_progress;
85 75
86 /** 76 /* Serial number of device */
87 Serial number of device.
88 */
89 int serial_number; 77 int serial_number;
90 78
91 /** 79 /* Firmware version (x 100) */
92 Firmware version (x 100).
93 */
94 int firmware_version; 80 int firmware_version;
95 81
96 /** 82 /* Device ID */
97 Device ID.
98 */
99 int device_id; 83 int device_id;
100}; 84};
101 85
diff --git a/sound/usb/line6/podhd.c b/sound/usb/line6/podhd.c
index 43c39886597e..c4e83ab33a21 100644
--- a/sound/usb/line6/podhd.c
+++ b/sound/usb/line6/podhd.c
@@ -27,9 +27,7 @@ enum {
27}; 27};
28 28
29struct usb_line6_podhd { 29struct usb_line6_podhd {
30 /** 30 /* Generic Line 6 USB data */
31 Generic Line 6 USB data.
32 */
33 struct usb_line6 line6; 31 struct usb_line6 line6;
34}; 32};
35 33
diff --git a/sound/usb/line6/toneport.c b/sound/usb/line6/toneport.c
index 819e06b3f3db..9024acb2b850 100644
--- a/sound/usb/line6/toneport.c
+++ b/sound/usb/line6/toneport.c
@@ -43,34 +43,22 @@ struct toneport_led {
43}; 43};
44 44
45struct usb_line6_toneport { 45struct usb_line6_toneport {
46 /** 46 /* Generic Line 6 USB data */
47 Generic Line 6 USB data.
48 */
49 struct usb_line6 line6; 47 struct usb_line6 line6;
50 48
51 /** 49 /* Source selector */
52 Source selector.
53 */
54 int source; 50 int source;
55 51
56 /** 52 /* Serial number of device */
57 Serial number of device.
58 */
59 int serial_number; 53 int serial_number;
60 54
61 /** 55 /* Firmware version (x 100) */
62 Firmware version (x 100).
63 */
64 int firmware_version; 56 int firmware_version;
65 57
66 /** 58 /* Timer for delayed PCM startup */
67 Timer for delayed PCM startup.
68 */
69 struct timer_list timer; 59 struct timer_list timer;
70 60
71 /** 61 /* Device type */
72 Device type.
73 */
74 enum line6_device_type type; 62 enum line6_device_type type;
75 63
76 /* LED instances */ 64 /* LED instances */
diff --git a/sound/usb/line6/variax.c b/sound/usb/line6/variax.c
index 9701ffa61365..44042cbdef01 100644
--- a/sound/usb/line6/variax.c
+++ b/sound/usb/line6/variax.c
@@ -42,30 +42,20 @@ enum {
42}; 42};
43 43
44struct usb_line6_variax { 44struct usb_line6_variax {
45 /** 45 /* Generic Line 6 USB data */
46 Generic Line 6 USB data.
47 */
48 struct usb_line6 line6; 46 struct usb_line6 line6;
49 47
50 /** 48 /* Buffer for activation code */
51 Buffer for activation code.
52 */
53 unsigned char *buffer_activate; 49 unsigned char *buffer_activate;
54 50
55 /** 51 /* Handler for device initialization */
56 Handler for device initializaton.
57 */
58 struct work_struct startup_work; 52 struct work_struct startup_work;
59 53
60 /** 54 /* Timers for device initialization */
61 Timers for device initializaton.
62 */
63 struct timer_list startup_timer1; 55 struct timer_list startup_timer1;
64 struct timer_list startup_timer2; 56 struct timer_list startup_timer2;
65 57
66 /** 58 /* Current progress in startup procedure */
67 Current progress in startup procedure.
68 */
69 int startup_progress; 59 int startup_progress;
70}; 60};
71 61
generated by cgit v1.2.2 (git 2.25.0) at 2024-11-30 06:19:54 -0500