The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/audio_if.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $OpenBSD: audio_if.h,v 1.42 2022/11/02 10:41:34 kn Exp $        */
    2 /*      $NetBSD: audio_if.h,v 1.24 1998/01/10 14:07:25 tv Exp $ */
    3 
    4 /*
    5  * Copyright (c) 1994 Havard Eidnes.
    6  * All rights reserved.
    7  *
    8  * Redistribution and use in source and binary forms, with or without
    9  * modification, are permitted provided that the following conditions
   10  * are met:
   11  * 1. Redistributions of source code must retain the above copyright
   12  *    notice, this list of conditions and the following disclaimer.
   13  * 2. Redistributions in binary form must reproduce the above copyright
   14  *    notice, this list of conditions and the following disclaimer in the
   15  *    documentation and/or other materials provided with the distribution.
   16  * 3. All advertising materials mentioning features or use of this software
   17  *    must display the following acknowledgement:
   18  *      This product includes software developed by the Computer Systems
   19  *      Engineering Group at Lawrence Berkeley Laboratory.
   20  * 4. Neither the name of the University nor of the Laboratory may be used
   21  *    to endorse or promote products derived from this software without
   22  *    specific prior written permission.
   23  *
   24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
   25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
   28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   34  * SUCH DAMAGE.
   35  *
   36  */
   37 
   38 #ifndef _SYS_DEV_AUDIO_IF_H_
   39 #define _SYS_DEV_AUDIO_IF_H_
   40 
   41 #include <sys/mutex.h>
   42 
   43 #define AUDIO_BPS(bits)         (bits) <= 8 ? 1 : ((bits) <= 16 ? 2 : 4)
   44 
   45 /*
   46  * Generic interface to hardware driver.
   47  */
   48 
   49 struct mixer_devinfo;
   50 struct mixer_ctrl;
   51 
   52 struct audio_params {
   53         u_long  sample_rate;                    /* sample rate */
   54 #define AUDIO_ENCODING_NONE             0 /* no encoding assigned */
   55 #define AUDIO_ENCODING_ULAW             1 /* ITU G.711 mu-law */
   56 #define AUDIO_ENCODING_ALAW             2 /* ITU G.711 A-law */
   57 #define AUDIO_ENCODING_SLINEAR_LE       6
   58 #define AUDIO_ENCODING_SLINEAR_BE       7
   59 #define AUDIO_ENCODING_ULINEAR_LE       8
   60 #define AUDIO_ENCODING_ULINEAR_BE       9
   61         u_int   encoding;                       /* mu-law, linear, etc */
   62         u_int   precision;                      /* bits/sample */
   63         u_int   bps;                            /* bytes/sample */
   64         u_int   msb;                            /* data alignment */
   65         u_int   channels;                       /* mono(1), stereo(2) */
   66 };
   67 
   68 struct audio_hw_if {
   69         int     (*open)(void *, int);   /* open hardware */
   70         void    (*close)(void *);               /* close hardware */
   71 
   72         /* Set the audio encoding parameters (record and play).
   73          * Return 0 on success, or an error code if the
   74          * requested parameters are impossible.
   75          * The values in the params struct may be changed (e.g. rounding
   76          * to the nearest sample rate.)
   77          */
   78         int     (*set_params)(void *, int, int, struct audio_params *,
   79                     struct audio_params *);
   80 
   81         /* Hardware may have some say in the blocksize to choose */
   82         int     (*round_blocksize)(void *, int);
   83 
   84         /*
   85          * Changing settings may require taking device out of "data mode",
   86          * which can be quite expensive.  Also, audiosetinfo() may
   87          * change several settings in quick succession.  To avoid
   88          * having to take the device in/out of "data mode", we provide
   89          * this function which indicates completion of settings
   90          * adjustment.
   91          */
   92         int     (*commit_settings)(void *);
   93 
   94         /* Start input/output routines. These usually control DMA. */
   95         int     (*init_output)(void *, void *, int);
   96         int     (*init_input)(void *, void *, int);
   97         int     (*start_output)(void *, void *, int, void (*)(void *), void *);
   98         int     (*start_input)(void *, void *, int, void (*)(void *), void *);
   99         int     (*halt_output)(void *);
  100         int     (*halt_input)(void *);
  101 
  102 #define SPKR_ON         1
  103 #define SPKR_OFF        0
  104 
  105         /* Mixer (in/out ports) */
  106         int     (*set_port)(void *, struct mixer_ctrl *);
  107         int     (*get_port)(void *, struct mixer_ctrl *);
  108 
  109         int     (*query_devinfo)(void *, struct mixer_devinfo *);
  110 
  111         /* Allocate/free memory for the ring buffer. Usually malloc/free. */
  112         /* The _old interfaces have been deprecated and will not be
  113            called in newer kernels if the new interfaces are present */
  114         void    *(*allocm)(void *, int, size_t, int, int);
  115         void    (*freem)(void *, void *, int);
  116         size_t  (*round_buffersize)(void *, int, size_t);
  117 
  118         int     (*trigger_output)(void *, void *, void *, int,
  119                     void (*)(void *), void *, struct audio_params *);
  120         int     (*trigger_input)(void *, void *, void *, int,
  121                     void (*)(void *), void *, struct audio_params *);
  122         void    (*copy_output)(void *, size_t);
  123         void    (*underrun)(void *);
  124         unsigned int (*set_blksz)(void *, int,
  125             struct audio_params *, struct audio_params *, unsigned int);
  126         unsigned int (*set_nblks)(void *, int,
  127             struct audio_params *, unsigned int, unsigned int);
  128 };
  129 
  130 struct audio_attach_args {
  131         int     type;
  132         const void *hwif;               /* either audio_hw_if * or midi_hw_if * */
  133         void    *hdl;
  134         void    *cookie;
  135 };
  136 #define AUDIODEV_TYPE_AUDIO     0
  137 #define AUDIODEV_TYPE_MIDI      1
  138 #define AUDIODEV_TYPE_OPL       2
  139 #define AUDIODEV_TYPE_MPU       3
  140 #define AUDIODEV_TYPE_RADIO     4
  141 
  142 /* Attach the MI driver(s) to the MD driver. */
  143 struct device *audio_attach_mi(const struct audio_hw_if *, void *, void *,
  144                    struct device *);
  145 int            audioprint(void *, const char *);
  146 int            audio_blksz_bytes(int,
  147                    struct audio_params *, struct audio_params *, int);
  148 
  149 extern struct mutex audio_lock;
  150 
  151 #endif /* _SYS_DEV_AUDIO_IF_H_ */

Cache object: 8835db1cce02ebe56803482e41ad5a09


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.