Commit dc9786a0 authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: us144mkii: Drop kernel-doc markers

We don't process this driver code for kernel-doc, and the "/**" marker
leads to warnings with W=1 builds.  Drop the superfluous markers, and
also fix the invalid mark up, too.

Link: https://patch.msgid.link/20260226155456.1092186-1-tiwai@suse.de


Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 1d6452a0
Loading
Loading
Loading
Loading
+7 −7
Original line number Diff line number Diff line
@@ -10,8 +10,8 @@ MODULE_AUTHOR("Šerif Rami <ramiserifpersia@gmail.com>");
MODULE_DESCRIPTION("ALSA Driver for TASCAM US-144MKII");
MODULE_LICENSE("GPL");

/**
 * @brief Module parameters for ALSA card instantiation.
/*
 * Module parameters for ALSA card instantiation.
 *
 * These parameters allow users to configure how the ALSA sound card
 * for the TASCAM US-144MKII is instantiated.
@@ -269,7 +269,7 @@ void tascam_stop_work_handler(struct work_struct *work)
	atomic_set(&tascam->active_urbs, 0);
}

/**
/*
 * tascam_card_private_free() - Frees private data associated with the sound
 * card.
 * @card: Pointer to the ALSA sound card instance.
@@ -291,7 +291,7 @@ static void tascam_card_private_free(struct snd_card *card)
	}
}

/**
/*
 * tascam_suspend() - Handles device suspension.
 * @intf: The USB interface being suspended.
 * @message: Power management message.
@@ -332,7 +332,7 @@ static int tascam_suspend(struct usb_interface *intf, pm_message_t message)
	return 0;
}

/**
/*
 * tascam_resume() - Handles device resumption from suspend.
 * @intf: The USB interface being resumed.
 *
@@ -390,7 +390,7 @@ static void tascam_error_timer(struct timer_list *t)
		schedule_work(&tascam->midi_out_work);
}

/**
/*
 * tascam_probe() - Probes for the TASCAM US-144MKII device.
 * @intf: The USB interface being probed.
 * @usb_id: The USB device ID.
@@ -565,7 +565,7 @@ static int tascam_probe(struct usb_interface *intf,
	return err;
}

/**
/*
 * tascam_disconnect() - Disconnects the TASCAM US-144MKII device.
 * @intf: The USB interface being disconnected.
 *
+6 −6
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@

#include "us144mkii.h"

/**
/*
 * tascam_capture_open() - Opens the PCM capture substream.
 * @substream: The ALSA PCM substream to open.
 *
@@ -23,7 +23,7 @@ static int tascam_capture_open(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_capture_close() - Closes the PCM capture substream.
 * @substream: The ALSA PCM substream to close.
 *
@@ -41,7 +41,7 @@ static int tascam_capture_close(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_capture_prepare() - Prepares the PCM capture substream for use.
 * @substream: The ALSA PCM substream to prepare.
 *
@@ -62,7 +62,7 @@ static int tascam_capture_prepare(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_capture_pointer() - Returns the current capture pointer position.
 * @substream: The ALSA PCM substream.
 *
@@ -91,7 +91,7 @@ tascam_capture_pointer(struct snd_pcm_substream *substream)
	return do_div(pos, runtime->buffer_size);
}

/**
/*
 * tascam_capture_ops - ALSA PCM operations for capture.
 *
 * This structure defines the callback functions for capture stream operations,
@@ -109,7 +109,7 @@ const struct snd_pcm_ops tascam_capture_ops = {
	.pointer = tascam_capture_pointer,
};

/**
/*
 * decode_tascam_capture_block() - Decodes a raw 512-byte block from the device.
 * @src_block: Pointer to the 512-byte raw source block.
 * @dst_block: Pointer to the destination buffer for decoded audio frames.
+21 −21
Original line number Diff line number Diff line
@@ -3,8 +3,8 @@

#include "us144mkii.h"

/**
 * @brief Text descriptions for playback output source options.
/*
 * Text descriptions for playback output source options.
 *
 * Used by ALSA kcontrol elements to provide user-friendly names for
 * the playback routing options (e.g., "Playback 1-2", "Playback 3-4").
@@ -12,15 +12,15 @@
static const char *const playback_source_texts[] = { "Playback 1-2",
						     "Playback 3-4" };

/**
 * @brief Text descriptions for capture input source options.
/*
 * Text descriptions for capture input source options.
 *
 * Used by ALSA kcontrol elements to provide user-friendly names for
 * the capture routing options (e.g., "Analog In", "Digital In").
 */
static const char *const capture_source_texts[] = { "Analog In", "Digital In" };

/**
/*
 * tascam_playback_source_info() - ALSA control info callback for playback
 * source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -38,7 +38,7 @@ static int tascam_playback_source_info(struct snd_kcontrol *kcontrol,
	return snd_ctl_enum_info(uinfo, 1, 2, playback_source_texts);
}

/**
/*
 * tascam_line_out_get() - ALSA control get callback for Line Outputs Source.
 * @kcontrol: The ALSA kcontrol instance.
 * @ucontrol: The ALSA control element value structure to fill.
@@ -60,7 +60,7 @@ static int tascam_line_out_get(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_line_out_put() - ALSA control put callback for Line Outputs Source.
 * @kcontrol: The ALSA kcontrol instance.
 * @ucontrol: The ALSA control element value structure containing the new value.
@@ -89,7 +89,7 @@ static int tascam_line_out_put(struct snd_kcontrol *kcontrol,
	return changed;
}

/**
/*
 * tascam_line_out_control - ALSA kcontrol definition for Line Outputs Source.
 *
 * This defines a new ALSA mixer control named "Line OUTPUTS Source" that allows
@@ -106,7 +106,7 @@ static const struct snd_kcontrol_new tascam_line_out_control = {
	.put = tascam_line_out_put,
};

/**
/*
 * tascam_digital_out_get() - ALSA control get callback for Digital Outputs
 * Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -129,7 +129,7 @@ static int tascam_digital_out_get(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_digital_out_put() - ALSA control put callback for Digital Outputs
 * Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -159,7 +159,7 @@ static int tascam_digital_out_put(struct snd_kcontrol *kcontrol,
	return changed;
}

/**
/*
 * tascam_digital_out_control - ALSA kcontrol definition for Digital Outputs
 * Source.
 *
@@ -177,7 +177,7 @@ static const struct snd_kcontrol_new tascam_digital_out_control = {
	.put = tascam_digital_out_put,
};

/**
/*
 * tascam_capture_source_info() - ALSA control info callback for capture source.
 * @kcontrol: The ALSA kcontrol instance.
 * @uinfo: The ALSA control element info structure to fill.
@@ -194,7 +194,7 @@ static int tascam_capture_source_info(struct snd_kcontrol *kcontrol,
	return snd_ctl_enum_info(uinfo, 1, 2, capture_source_texts);
}

/**
/*
 * tascam_capture_12_get() - ALSA control get callback for Capture channels 1
 * and 2 Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -217,7 +217,7 @@ static int tascam_capture_12_get(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_capture_12_put() - ALSA control put callback for Capture channels 1
 * and 2 Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -247,7 +247,7 @@ static int tascam_capture_12_put(struct snd_kcontrol *kcontrol,
	return changed;
}

/**
/*
 * tascam_capture_12_control - ALSA kcontrol definition for Capture channels 1
 * and 2 Source.
 *
@@ -265,7 +265,7 @@ static const struct snd_kcontrol_new tascam_capture_12_control = {
	.put = tascam_capture_12_put,
};

/**
/*
 * tascam_capture_34_get() - ALSA control get callback for Capture channels 3
 * and 4 Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -288,7 +288,7 @@ static int tascam_capture_34_get(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_capture_34_put() - ALSA control put callback for Capture channels 3
 * and 4 Source.
 * @kcontrol: The ALSA kcontrol instance.
@@ -318,7 +318,7 @@ static int tascam_capture_34_put(struct snd_kcontrol *kcontrol,
	return changed;
}

/**
/*
 * tascam_capture_34_control - ALSA kcontrol definition for Capture channels 3
 * and 4 Source.
 *
@@ -336,7 +336,7 @@ static const struct snd_kcontrol_new tascam_capture_34_control = {
	.put = tascam_capture_34_put,
};

/**
/*
 * tascam_samplerate_info() - ALSA control info callback for Sample Rate.
 * @kcontrol: The ALSA kcontrol instance.
 * @uinfo: The ALSA control element info structure to fill.
@@ -356,7 +356,7 @@ static int tascam_samplerate_info(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_samplerate_get() - ALSA control get callback for Sample Rate.
 * @kcontrol: The ALSA kcontrol instance.
 * @ucontrol: The ALSA control element value structure to fill.
@@ -400,7 +400,7 @@ static int tascam_samplerate_get(struct snd_kcontrol *kcontrol,
	return 0;
}

/**
/*
 * tascam_samplerate_control - ALSA kcontrol definition for Sample Rate.
 *
 * This defines a new ALSA mixer control named "Sample Rate" that displays
+11 −11
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@

#include "us144mkii.h"

/**
/*
 * tascam_midi_in_work_handler() - Deferred work for processing MIDI input.
 * @work: The work_struct instance.
 *
@@ -75,7 +75,7 @@ void tascam_midi_in_urb_complete(struct urb *urb)
	usb_put_urb(urb);
}

/**
/*
 * tascam_midi_in_open() - Opens the MIDI input substream.
 * @substream: The ALSA rawmidi substream to open.
 *
@@ -92,7 +92,7 @@ static int tascam_midi_in_open(struct snd_rawmidi_substream *substream)
	return 0;
}

/**
/*
 * tascam_midi_in_close() - Closes the MIDI input substream.
 * @substream: The ALSA rawmidi substream to close.
 *
@@ -103,7 +103,7 @@ static int tascam_midi_in_close(struct snd_rawmidi_substream *substream)
	return 0;
}

/**
/*
 * tascam_midi_in_trigger() - Triggers MIDI input stream activity.
 * @substream: The ALSA rawmidi substream.
 * @up: Boolean indicating whether to start (1) or stop (0) the stream.
@@ -150,7 +150,7 @@ static void tascam_midi_in_trigger(struct snd_rawmidi_substream *substream,
	}
}

/**
/*
 * tascam_midi_in_ops - ALSA rawmidi operations for MIDI input.
 *
 * This structure defines the callback functions for MIDI input stream
@@ -205,7 +205,7 @@ void tascam_midi_out_urb_complete(struct urb *urb)
	usb_put_urb(urb);
}

/**
/*
 * tascam_midi_out_work_handler() - Deferred work for sending MIDI data
 * @work: The work_struct instance.
 *
@@ -282,7 +282,7 @@ static void tascam_midi_out_work_handler(struct work_struct *work)
	}
}

/**
/*
 * tascam_midi_out_open() - Opens the MIDI output substream.
 * @substream: The ALSA rawmidi substream to open.
 *
@@ -301,7 +301,7 @@ static int tascam_midi_out_open(struct snd_rawmidi_substream *substream)
	return 0;
}

/**
/*
 * tascam_midi_out_close() - Closes the MIDI output substream.
 * @substream: The ALSA rawmidi substream to close.
 *
@@ -312,7 +312,7 @@ static int tascam_midi_out_close(struct snd_rawmidi_substream *substream)
	return 0;
}

/**
/*
 * tascam_midi_out_drain() - Drains the MIDI output stream.
 * @substream: The ALSA rawmidi substream.
 *
@@ -340,7 +340,7 @@ static void tascam_midi_out_drain(struct snd_rawmidi_substream *substream)
	usb_kill_anchored_urbs(&tascam->midi_out_anchor);
}

/**
/*
 * tascam_midi_out_trigger() - Triggers MIDI output stream activity.
 * @substream: The ALSA rawmidi substream.
 * @up: Boolean indicating whether to start (1) or stop (0) the stream.
@@ -361,7 +361,7 @@ static void tascam_midi_out_trigger(struct snd_rawmidi_substream *substream,
	}
}

/**
/*
 * tascam_midi_out_ops - ALSA rawmidi operations for MIDI output.
 *
 * This structure defines the callback functions for MIDI output stream
+5 −5
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@

#include "us144mkii.h"

/**
/*
 * tascam_playback_open() - Opens the PCM playback substream.
 * @substream: The ALSA PCM substream to open.
 *
@@ -23,7 +23,7 @@ static int tascam_playback_open(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_playback_close() - Closes the PCM playback substream.
 * @substream: The ALSA PCM substream to close.
 *
@@ -41,7 +41,7 @@ static int tascam_playback_close(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_playback_prepare() - Prepares the PCM playback substream for use.
 * @substream: The ALSA PCM substream to prepare.
 *
@@ -108,7 +108,7 @@ static int tascam_playback_prepare(struct snd_pcm_substream *substream)
	return 0;
}

/**
/*
 * tascam_playback_pointer() - Returns the current playback pointer position.
 * @substream: The ALSA PCM substream.
 *
@@ -137,7 +137,7 @@ tascam_playback_pointer(struct snd_pcm_substream *substream)
	return do_div(pos, runtime->buffer_size);
}

/**
/*
 * tascam_playback_ops - ALSA PCM operations for playback.
 *
 * This structure defines the callback functions for playback stream operations,