Alsa-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Takashi Sakamoto <o-takashi@sakamocchi.jp>
To: clemens@ladisch.de, tiwai@suse.de, perex@perex.cz
Cc: alsa-devel@alsa-project.org, ffado-devel@lists.sf.net
Subject: [PATCH 39/39] bebob: Send a cue to load firmware for M-Audio Firewire series
Date: Wed,  5 Mar 2014 19:48:27 +0900
Message-ID: <1394016507-15761-40-git-send-email-o-takashi@sakamocchi.jp> (raw)
In-Reply-To: <1394016507-15761-1-git-send-email-o-takashi@sakamocchi.jp>

Just powering on, these devices below wait to download firmware.
 - Firewire Audiophile
 - Firewire 410
 - Firewire 1814
 - ProjectMix I/O

But firmware version 5058 or later, flash memory in the device stores the
firmware. So this driver can enable these devices by sending a certain cue to
load the firmware.
---
 sound/firewire/bebob/bebob.c        | 23 ++++++++-----
 sound/firewire/bebob/bebob.h        |  1 +
 sound/firewire/bebob/bebob_maudio.c | 69 +++++++++++++++++++++++++++++++++++++
 3 files changed, 84 insertions(+), 9 deletions(-)

diff --git a/sound/firewire/bebob/bebob.c b/sound/firewire/bebob/bebob.c
index d6f245e..aa0a893 100644
--- a/sound/firewire/bebob/bebob.c
+++ b/sound/firewire/bebob/bebob.c
@@ -177,18 +177,21 @@ bebob_probe(struct fw_unit *unit,
 	}
 
 	if ((entry->vendor_id == VEN_FOCUSRITE) &&
-	    (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH)) {
+	    (entry->model_id == MODEL_FOCUSRITE_SAFFIRE_BOTH))
 		spec = get_saffire_spec(unit);
-	} else if ((entry->vendor_id == VEN_MAUDIO1) &&
-		   (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
-		   !check_audiophile_booted(unit)) {
-			err = 0;
-			goto end;
-	} else {
+	else if ((entry->vendor_id == VEN_MAUDIO1) &&
+		 (entry->model_id == MODEL_MAUDIO_AUDIOPHILE_BOTH) &&
+		 !check_audiophile_booted(unit))
+		spec = NULL;
+	else
 		spec = (const struct snd_bebob_spec *)entry->driver_data;
-	}
+
 	if (spec == NULL) {
-		err = -ENOSYS;
+		if ((entry->vendor_id == VEN_MAUDIO1) ||
+		    (entry->vendor_id == VEN_MAUDIO2))
+			err = snd_bebob_maudio_load_firmware(unit);
+		else
+			err = -ENOSYS;
 		goto end;
 	}
 
@@ -376,6 +379,7 @@ static const struct ieee1394_device_id bebob_id_table[] = {
 	SND_BEBOB_DEV_ENTRY(VEN_FOCUSRITE, MODEL_FOCUSRITE_SAFFIRE_BOTH,
 			    &saffire_spec),
 	/* M-Audio, Firewire 410 */
+	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010058, NULL),	/* bootloader */
 	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO2, 0x00010046, &maudio_fw410_spec),
 	/* M-Audio, Firewire Audiophile */
 	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_AUDIOPHILE_BOTH,
@@ -389,6 +393,7 @@ static const struct ieee1394_device_id bebob_id_table[] = {
 	/* M-Audio, ProFireLightbridge */
 	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x000100a1, &spec_normal),
 	/* Firewire 1814 */
+	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, 0x00010070, NULL),     /* bootloader */
 	SND_BEBOB_DEV_ENTRY(VEN_MAUDIO1, MODEL_MAUDIO_FW1814,
 			    &maudio_special_spec),
 	/* M-Audio ProjectMix */
diff --git a/sound/firewire/bebob/bebob.h b/sound/firewire/bebob/bebob.h
index ef74049..2226381 100644
--- a/sound/firewire/bebob/bebob.h
+++ b/sound/firewire/bebob/bebob.h
@@ -246,6 +246,7 @@ extern struct snd_bebob_spec maudio_ozonic_spec;
 extern struct snd_bebob_spec maudio_nrv10_spec;
 extern struct snd_bebob_spec maudio_special_spec;
 int snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814);
+int snd_bebob_maudio_load_firmware(struct fw_unit *unit);
 
 #define SND_BEBOB_DEV_ENTRY(vendor, model, data) \
 { \
diff --git a/sound/firewire/bebob/bebob_maudio.c b/sound/firewire/bebob/bebob_maudio.c
index e2a0a7f..d7681b1 100644
--- a/sound/firewire/bebob/bebob_maudio.c
+++ b/sound/firewire/bebob/bebob_maudio.c
@@ -16,6 +16,15 @@
  * settings when completing uploading. Then these devices generate bus reset
  * and are recognized as new devices with the firmware.
  *
+ * But with firmware version 5058 or later, the firmware is stored to flash
+ * memory in the device and drivers can tell DM1000 to load the firmware by
+ * sending a cue. This cue must be sent one time.
+ *
+ * If the firmware blobs are in alsa-firmware package, this driver can support
+ * these devices with any firmware versions. (Then this driver need codes to
+ * upload the firmware blob.) But for this, the license of firmware blob needs
+ * to be considered.
+ *
  * For streaming, both of output and input streams are needed for Firewire 410
  * and Ozonic. The single stream is OK for the other devices even if the clock
  * source is not SYT-Match (I note no devices use SYT-Match).
@@ -33,6 +42,20 @@
 
 #define MAX_TRIALS	3
 
+/* Offset from information register */
+#define INFO_OFFSET_SW_DATE	0x20
+
+/* Bootloader Protocol Version 1 */
+#define MAUDIO_BOOTLOADER_CUE1	0x00000001
+/*
+ * Initializing configuration to factory settings (= 0x1101), (swapped in line),
+ * Command code is zero (= 0x00),
+ * the number of operands is zero (= 0x00)(at least significant byte)
+ */
+#define MAUDIO_BOOTLOADER_CUE2	0x01110000
+/* padding */
+#define MAUDIO_BOOTLOADER_CUE3	0x00000000
+
 #define MAUDIO_SPECIFIC_ADDRESS	0xffc700000000
 
 #define METER_OFFSET		0x00600000
@@ -70,6 +93,52 @@ struct special_params {
 	struct snd_ctl_elem_id *ctl_id_sync;
 };
 
+/*
+ * For some M-Audio devices, this module just send cue to load firmware. After
+ * loading, the device generates bus reset and newly detected.
+ *
+ * If we make any transactions to load firmware, the operation may failed.
+ */
+int snd_bebob_maudio_load_firmware(struct fw_unit *unit)
+{
+	struct fw_device *device = fw_parent_device(unit);
+	int err, rcode;
+	u64 date;
+	__be32 cues[3] = {
+		MAUDIO_BOOTLOADER_CUE1,
+		MAUDIO_BOOTLOADER_CUE2,
+		MAUDIO_BOOTLOADER_CUE3
+	};
+
+	/* check date of software used to build */
+	err = snd_bebob_read_block(unit, INFO_OFFSET_SW_DATE,
+				   &date, sizeof(u64));
+	if (err < 0)
+		goto end;
+	/*
+	 * firmware version 5058 or later has date later than "20070401", but
+	 * 'date' is not null-terminated.
+	 */
+	if (date < 0x3230303730343031) {
+		dev_err(&unit->device,
+			"Use firmware version 5058 or later\n");
+		err = -ENOSYS;
+		goto end;
+	}
+
+	rcode = fw_run_transaction(device->card, TCODE_WRITE_BLOCK_REQUEST,
+				   device->node_id, device->generation,
+				   device->max_speed, BEBOB_ADDR_REG_REQ,
+				   cues, sizeof(cues));
+	if (rcode != RCODE_COMPLETE) {
+		dev_err(&unit->device,
+			"Failed to send a cue to load firmware\n");
+		err = -EIO;
+	}
+end:
+	return err;
+}
+
 static inline int
 get_meter(struct snd_bebob *bebob, void *buf, unsigned int size)
 {
-- 
1.8.3.2

  parent reply index

Thread overview: 75+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <5316963F.1000206@sakamocchi.jp>
2014-03-05  6:14 ` [GIT PULL v2] Enhancement of support for Firewire devices Takashi Iwai
2014-03-05 11:00   ` Takashi Sakamoto
2014-03-05 11:09     ` Takashi Iwai
2014-03-05 11:23       ` Takashi Sakamoto
2014-03-05 10:47 ` [GIT PULL][PATCH 00/39 " Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 01/39] firewire-lib: Rename functions, structure, member for AMDTP Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 02/39] firewire-lib: Add macros instead of fixed value " Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 03/39] firewire-lib: Add 'direction' member to 'amdtp_stream' structure Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 04/39] firewire-lib: Split some codes into functions to reuse for both streams Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 05/39] firewire-lib: Add support for AMDTP in-stream and PCM capture Takashi Sakamoto
2014-03-09 20:37     ` Clemens Ladisch
2014-03-10  3:55       ` Takashi Sakamoto
2014-03-12  2:00       ` Takashi Sakamoto
2014-03-14 13:50       ` Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 06/39] firewire-lib: Add support for MIDI capture/playback Takashi Sakamoto
2014-03-09 20:48     ` Clemens Ladisch
2014-03-10  4:13       ` Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 07/39] firewire-lib: Give syt value as parameter to handle_out_packet() Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 08/39] firewire-lib: Add support for duplex streams synchronization in blocking mode Takashi Sakamoto
2014-03-09 20:55     ` Clemens Ladisch
2014-03-10 12:21       ` Takashi Sakamoto
2014-03-05 10:47   ` [PATCH 09/39] firewire-lib: Add sort function for transmitted packet Takashi Sakamoto
2014-03-09 21:07     ` Clemens Ladisch
2014-03-10 13:29       ` Takashi Sakamoto
2014-03-11  8:11         ` Clemens Ladisch
2014-03-12  1:23           ` Takashi Sakamoto
2014-03-12  7:21             ` Takashi Iwai
2014-03-05 10:47   ` [PATCH 10/39] firewire-lib: Add transfer delay to synchronized duplex streams Takashi Sakamoto
2014-03-09 21:13     ` Clemens Ladisch
2014-03-10 13:43       ` Takashi Sakamoto
2014-03-11  8:13         ` Clemens Ladisch
2014-03-05 10:47   ` [PATCH 11/39] firewire-lib: Add support for channel mapping Takashi Sakamoto
2014-03-09 21:20     ` Clemens Ladisch
2014-03-10 12:28       ` Takashi Sakamoto
2014-03-10 12:58         ` Takashi Sakamoto
2014-03-11  8:23         ` Clemens Ladisch
2014-03-11 16:03           ` Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 12/39] firewire-lib: Rename macros, variables and functions for CMP Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 13/39] firewire-lib: Add 'direction' member to 'cmp_connection' structure Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 14/39] firewire-lib: Add handling output connection by CMP Takashi Sakamoto
2014-03-09 21:27     ` Clemens Ladisch
2014-03-10 12:30       ` Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 15/39] firewire-lib: Add a new function to check others' connection Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 16/39] firewire-lib: Add some AV/C general commands Takashi Sakamoto
2014-03-09 21:32     ` Clemens Ladisch
2014-03-10 12:46       ` Takashi Sakamoto
2014-03-14 14:10       ` Takashi Sakamoto
2014-03-14 22:18         ` Clemens Ladisch
2014-03-05 10:48   ` [PATCH 17/39] firewire-lib: Add quirks for Fireworks Takashi Sakamoto
2014-03-09 21:39     ` Clemens Ladisch
2014-03-10 12:40       ` Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 18/39] firewire-lib: Add a fallback at RCODE_CANCELLED Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 19/39] fireworks: Add skelton for Fireworks based devices Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 20/39] fireworks: Add transaction and some commands Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 21/39] fireworks: Add connection and stream management Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 22/39] fireworks: Add proc interface for debugging purpose Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 23/39] fireworks: Add MIDI interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 24/39] fireworks: Add PCM interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 25/39] fireworks: Add hwdep interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 26/39] fireworks: Add command/response functionality into " Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 27/39] bebob: Add skelton for BeBoB based devices Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 28/39] bebob: Add commands and connections/streams management Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 29/39] bebob: Add proc interface for debugging purpose Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 30/39] bebob: Add MIDI interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 31/39] bebob: Add PCM interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 32/39] bebob: Add hwdep interface Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 33/39] bebob: Prepare for device specific operations Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 34/39] bebob: Add support for Terratec PHASE, EWS series and Aureon Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 35/39] bebob: Add support for Yamaha GO series Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 36/39] bebob: Add support for Focusrite Saffire/SaffirePro series Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 37/39] bebob: Add support for M-Audio usual Firewire series Takashi Sakamoto
2014-03-05 10:48   ` [PATCH 38/39] bebob: Add support for M-Audio special " Takashi Sakamoto
2014-03-05 10:48   ` Takashi Sakamoto [this message]
2014-03-07 11:44 ` [GIT PULL v2] Enhancement of support for Firewire devices Takashi Iwai
2014-03-07 14:46   ` Clemens Ladisch

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1394016507-15761-40-git-send-email-o-takashi@sakamocchi.jp \
    --to=o-takashi@sakamocchi.jp \
    --cc=alsa-devel@alsa-project.org \
    --cc=clemens@ladisch.de \
    --cc=ffado-devel@lists.sf.net \
    --cc=perex@perex.cz \
    --cc=tiwai@suse.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Alsa-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/alsa-devel/0 alsa-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 alsa-devel alsa-devel/ https://lore.kernel.org/alsa-devel \
		alsa-devel@alsa-project.org
	public-inbox-index alsa-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.alsa-project.alsa-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git