From 3d8e81862ce404d861b75bcb1e7d986e4febb025 Mon Sep 17 00:00:00 2001 From: Takashi Iwai Date: Thu, 10 Nov 2016 16:56:09 +0100 Subject: ALSA: doc: ReSTize MIXART.txt Another simple conversion from a plain text file. Put to cards directory. Signed-off-by: Takashi Iwai --- Documentation/sound/alsa/MIXART.txt | 100 ------------------------------- Documentation/sound/cards/index.rst | 1 + Documentation/sound/cards/mixart.rst | 110 +++++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+), 100 deletions(-) delete mode 100644 Documentation/sound/alsa/MIXART.txt create mode 100644 Documentation/sound/cards/mixart.rst (limited to 'Documentation/sound') diff --git a/Documentation/sound/alsa/MIXART.txt b/Documentation/sound/alsa/MIXART.txt deleted file mode 100644 index 4ee35b4fbe4a..000000000000 --- a/Documentation/sound/alsa/MIXART.txt +++ /dev/null @@ -1,100 +0,0 @@ - Alsa driver for Digigram miXart8 and miXart8AES/EBU soundcards - Digigram - - -GENERAL -======= - -The miXart8 is a multichannel audio processing and mixing soundcard -that has 4 stereo audio inputs and 4 stereo audio outputs. -The miXart8AES/EBU is the same with a add-on card that offers further -4 digital stereo audio inputs and outputs. -Furthermore the add-on card offers external clock synchronisation -(AES/EBU, Word Clock, Time Code and Video Synchro) - -The mainboard has a PowerPC that offers onboard mpeg encoding and -decoding, samplerate conversions and various effects. - -The driver don't work properly at all until the certain firmwares -are loaded, i.e. no PCM nor mixer devices will appear. -Use the mixartloader that can be found in the alsa-tools package. - - -VERSION 0.1.0 -============= - -One miXart8 board will be represented as 4 alsa cards, each with 1 -stereo analog capture 'pcm0c' and 1 stereo analog playback 'pcm0p' device. -With a miXart8AES/EBU there is in addition 1 stereo digital input -'pcm1c' and 1 stereo digital output 'pcm1p' per card. - -Formats -------- -U8, S16_LE, S16_BE, S24_3LE, S24_3BE, FLOAT_LE, FLOAT_BE -Sample rates : 8000 - 48000 Hz continuously - -Playback --------- -For instance the playback devices are configured to have max. 4 -substreams performing hardware mixing. This could be changed to a -maximum of 24 substreams if wished. -Mono files will be played on the left and right channel. Each channel -can be muted for each stream to use 8 analog/digital outputs separately. - -Capture -------- -There is one substream per capture device. For instance only stereo -formats are supported. - -Mixer ------ - and : analog volume control of playback and capture PCM. - and : digital volume control of each analog substream. - and : digital volume control of each AES/EBU substream. - : Loopback from 'pcm0c' to 'pcm0p' with digital volume -and mute control. - -Rem : for best audio quality try to keep a 0 attenuation on the PCM -and AES volume controls which is set by 219 in the range from 0 to 255 -(about 86% with alsamixer) - - -NOT YET IMPLEMENTED -=================== - -- external clock support (AES/EBU, Word Clock, Time Code, Video Sync) -- MPEG audio formats -- mono record -- on-board effects and samplerate conversions -- linked streams - - -FIRMWARE -======== - -[As of 2.6.11, the firmware can be loaded automatically with hotplug - when CONFIG_FW_LOADER is set. The mixartloader is necessary only - for older versions or when you build the driver into kernel.] - -For loading the firmware automatically after the module is loaded, use a -install command. For example, add the following entry to -/etc/modprobe.d/mixart.conf for miXart driver: - - install snd-mixart /sbin/modprobe --first-time -i snd-mixart && \ - /usr/bin/mixartloader -(for 2.2/2.4 kernels, add "post-install snd-mixart /usr/bin/vxloader" to - /etc/modules.conf, instead.) - -The firmware binaries are installed on /usr/share/alsa/firmware -(or /usr/local/share/alsa/firmware, depending to the prefix option of -configure). There will be a miXart.conf file, which define the dsp image -files. - -The firmware files are copyright by Digigram SA - - -COPYRIGHT -========= - -Copyright (c) 2003 Digigram SA -Distributable under GPL. diff --git a/Documentation/sound/cards/index.rst b/Documentation/sound/cards/index.rst index e92a4f7e86fc..0006bc547bb8 100644 --- a/Documentation/sound/cards/index.rst +++ b/Documentation/sound/cards/index.rst @@ -11,3 +11,4 @@ Card-Specific Information emu10k1-jack via82xx-mixer audiophile-usb + mixart diff --git a/Documentation/sound/cards/mixart.rst b/Documentation/sound/cards/mixart.rst new file mode 100644 index 000000000000..48aba98b088f --- /dev/null +++ b/Documentation/sound/cards/mixart.rst @@ -0,0 +1,110 @@ +============================================================== +Alsa driver for Digigram miXart8 and miXart8AES/EBU soundcards +============================================================== + +Digigram + + +GENERAL +======= + +The miXart8 is a multichannel audio processing and mixing soundcard +that has 4 stereo audio inputs and 4 stereo audio outputs. +The miXart8AES/EBU is the same with a add-on card that offers further +4 digital stereo audio inputs and outputs. +Furthermore the add-on card offers external clock synchronisation +(AES/EBU, Word Clock, Time Code and Video Synchro) + +The mainboard has a PowerPC that offers onboard mpeg encoding and +decoding, samplerate conversions and various effects. + +The driver don't work properly at all until the certain firmwares +are loaded, i.e. no PCM nor mixer devices will appear. +Use the mixartloader that can be found in the alsa-tools package. + + +VERSION 0.1.0 +============= + +One miXart8 board will be represented as 4 alsa cards, each with 1 +stereo analog capture 'pcm0c' and 1 stereo analog playback 'pcm0p' device. +With a miXart8AES/EBU there is in addition 1 stereo digital input +'pcm1c' and 1 stereo digital output 'pcm1p' per card. + +Formats +------- +U8, S16_LE, S16_BE, S24_3LE, S24_3BE, FLOAT_LE, FLOAT_BE +Sample rates : 8000 - 48000 Hz continuously + +Playback +-------- +For instance the playback devices are configured to have max. 4 +substreams performing hardware mixing. This could be changed to a +maximum of 24 substreams if wished. +Mono files will be played on the left and right channel. Each channel +can be muted for each stream to use 8 analog/digital outputs separately. + +Capture +------- +There is one substream per capture device. For instance only stereo +formats are supported. + +Mixer +----- + and + analog volume control of playback and capture PCM. + and + digital volume control of each analog substream. + and + digital volume control of each AES/EBU substream. + + Loopback from 'pcm0c' to 'pcm0p' with digital volume + and mute control. + +Rem : for best audio quality try to keep a 0 attenuation on the PCM +and AES volume controls which is set by 219 in the range from 0 to 255 +(about 86% with alsamixer) + + +NOT YET IMPLEMENTED +=================== + +- external clock support (AES/EBU, Word Clock, Time Code, Video Sync) +- MPEG audio formats +- mono record +- on-board effects and samplerate conversions +- linked streams + + +FIRMWARE +======== + +[As of 2.6.11, the firmware can be loaded automatically with hotplug + when CONFIG_FW_LOADER is set. The mixartloader is necessary only + for older versions or when you build the driver into kernel.] + +For loading the firmware automatically after the module is loaded, use a +install command. For example, add the following entry to +/etc/modprobe.d/mixart.conf for miXart driver: +:: + + install snd-mixart /sbin/modprobe --first-time -i snd-mixart && \ + /usr/bin/mixartloader + + +(for 2.2/2.4 kernels, add "post-install snd-mixart /usr/bin/vxloader" to +/etc/modules.conf, instead.) + +The firmware binaries are installed on /usr/share/alsa/firmware +(or /usr/local/share/alsa/firmware, depending to the prefix option of +configure). There will be a miXart.conf file, which define the dsp image +files. + +The firmware files are copyright by Digigram SA + + +COPYRIGHT +========= + +Copyright (c) 2003 Digigram SA +Distributable under GPL. -- cgit v1.2.3-55-g7522