Date: Fri, 23 Nov 2001 07:09:23 -0800 From: Murray Stokely <murray@FreeBSD.org> To: Jean-Francois Dockes <jean-francois.dockes@wanadoo.fr> Cc: freebsd-doc@FreeBSD.ORG Subject: Re: Sound subsystem chapter for the developers handbook Message-ID: <20011123070923.V27929@windriver.com> In-Reply-To: <15356.46562.665297.828958@hautmedoc.dockes.com>; from jean-francois.dockes@wanadoo.fr on Thu, Nov 22, 2001 at 09:22:58AM %2B0100 References: <15356.46562.665297.828958@hautmedoc.dockes.com>
next in thread | previous in thread | raw e-mail | index | archive | help
--gmhhrsDozM2n+uz5 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Nov 22, 2001 at 09:22:58AM +0100, Jean-Francois Dockes wrote: > I have written a 'Sound subsystem' chapter for the developers handbook. Excellent work. I'd like to get this committed to the Developers Handbook soon. I found a couple of minor grammar nits, and several instances where <literal> markup should be changed into something more descriptive. I started the diff here but didn't make a complete pass through the document because I think you can finish where I started. This uses <function>, <devicename>, <structname>, <varname>, etc in place of all the <literal> tags. Thanks, - Murray --- chapter.orig Fri Nov 23 06:53:35 2001 +++ chapter.sgml Fri Nov 23 07:04:45 2001 @@ -11,8 +11,8 @@ <title>Introduction</title> =20 <para>The FreeBSD sound subsystem cleanly separates generic - sound handling issues from device-specific ones. This eases - adding support for new hardware.</para> + sound handling issues from device-specific ones. This makes it + easier to add support for new hardware.</para> =20 <para>The &man.pcm.4; framework is the central piece of the sound subsystem. It mainly implements the following elements:</para> @@ -42,10 +42,10 @@ =20 <para>The support for specific sound cards is implemented by hardware-specific drivers, which provide channel and mixer interfaces - to plug into the generic <application>pcm</application> code.</para> + to plug into the generic <devicename>pcm</devicename> code.</para> =20 - <para>In the following of this document, the - <application>pcm</application> term will refer to the central, common + <para>In this chapter, the term + <devicename>pcm</devicename> will refer to the central, common part of the sound driver, as opposed to the hardware-specific modules.</para> =20 @@ -94,8 +94,8 @@ =20 <listitem> <para>They declare themselves as <literal>pcm</literal> - class devices, with a <literal>struct - snddev_info</literal> device private structure:</para> + class devices, with a <structname>struct + snddev_info</structname> device private structure:</para> <programlisting> static driver_t xxx_driver =3D { "pcm", @@ -110,8 +110,8 @@ private information about their device. A private data structure is usually allocated in the attach routine. Its address is passed to <application>pcm</application> by the - calls to <literal>pcm_register()</literal> and - <literal>mixer_init()</literal>. <application>pcm</application> + calls to <function>pcm_register()</function> and + <function>mixer_init()</function>. <application>pcm</applicatio= n> later passes back this address as a parameter in calls to the sound driver interfaces.</para> </listitem> @@ -119,10 +119,10 @@ <listitem> <para>The sound driver attach routine should declare its MIXER or AC97 interface to <application>pcm</application> by - calling <literal>mixer_init()</literal>. For a MIXER + calling <function>mixer_init()</function>. For a MIXER interface, this causes in turn a call to <link linkend=3D"xxxmixer-init"> - <literal>xxxmixer_init()</literal></link>.</para> + <function>xxxmixer_init()</function></link>.</para> =20 </listitem> =20 @@ -130,18 +130,18 @@ <para>The sound driver attach routine declares its general CHANNEL configuration to <application>pcm</application> by calling - <literal>pcm_register(dev, sc, nplay, nrec)</literal>, - where <literal>sc</literal> is the address for the device + <function>pcm_register(dev, sc, nplay, nrec)</function>, + where <varname>sc</varname> is the address for the device data structure, used in further calls from <application>pcm</application>, and - <literal>nplay</literal> and <literal>nrec</literal> are + <varname>nplay</varname> and <varname>nrec</varname> are the number of play and record channels.</para> </listitem> =20 <listitem> <para>The sound driver attach routine declares each of its channel objects by calls to - <literal>pcm_addchan()</literal>. This sets up the + <function>pcm_addchan()</function>. This sets up the channel glue in <application>pcm</application> and causes in turn a call to <link linkend=3D"xxxchannel-init"> @@ -150,7 +150,7 @@ =20 <listitem> <para>The sound driver detach routine should call - <literal>pcm_unregister()</literal> before releasing its + <function>pcm_unregister()</function> before releasing its resources.</para>=20 </listitem> </itemizedlist> @@ -174,7 +174,9 @@ =20 =20 <para><application>pcm</application> drivers should implement - device_suspend, device_resume and device_shutdown routines, so + <function>device_suspend</function>, + <function>device_resume</function> and + <function>device_shutdown</function> routines, so that power management and module unloading function correctly.</para> =20 --gmhhrsDozM2n+uz5 Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.0.6 (SunOS) Comment: For info see http://www.gnupg.org iD8DBQE7/maitNcQog5FH30RAhsVAJ0ZGw4RUiNBpaa2An4Um1Xgl7iZVgCgu3f6 VepQA3TSvlfwIwdeHy9D7oQ= =B6+Q -----END PGP SIGNATURE----- --gmhhrsDozM2n+uz5-- To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011123070923.V27929>