/*      $NetBSD: audio_if.h,v 1.3 2020/09/13 04:14:48 isaki Exp $       */

/*
* Copyright (c) 1994 Havard Eidnes.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed by the Computer Systems
*      Engineering Group at Lawrence Berkeley Laboratory.
* 4. Neither the name of the University nor of the Laboratory may be used
*    to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/

#ifndef _SYS_DEV_AUDIO_AUDIO_IF_H_
#define _SYS_DEV_AUDIO_AUDIO_IF_H_

#include <sys/types.h>
#include <sys/audioio.h>
#include <sys/mutex.h>

/* check we have an audio(4) configured into kernel */
#if defined(_KERNEL_OPT)
#include "audio.h"

#if (NAUDIO == 0) && (NMIDI == 0) && (NMIDIBUS == 0)
#error "No 'audio* at audiobus?' or 'midi* at midibus?' or similar configured"
#endif

#endif /* _KERNEL_OPT */

/*
* Interfaces for hardware drivers and MI audio.
*/

struct audio_softc;

#if defined(_KERNEL)

/**
* audio stream format
*/
typedef struct audio_params {
       u_int   sample_rate;    /* sample rate */
       u_int   encoding;       /* e.g. mu-law, linear, etc */
       u_int   precision;      /* bits/subframe */
       u_int   validbits;      /* valid bits in a subframe */
       u_int   channels;       /* mono(1), stereo(2) */
} audio_params_t;

#define AUFMT_INVALIDATE(fmt)   (fmt)->mode |= 0x80000000
#define AUFMT_VALIDATE(fmt)     (fmt)->mode &= 0x7fffffff
#define AUFMT_IS_VALID(fmt)     (((fmt)->mode & 0x80000000) == 0)

#include <dev/audio/audiofil.h>

struct audio_hw_if {
       int     (*open)(void *, int);   /* open hardware */
       void    (*close)(void *);       /* close hardware */

       int     (*query_format)(void *, audio_format_query_t *);
       int     (*set_format)(void *, int,
                   const audio_params_t *, const audio_params_t *,
                   audio_filter_reg_t *, audio_filter_reg_t *);

       /* Hardware may have some say in the blocksize to choose */
       int     (*round_blocksize)(void *, int, int, const audio_params_t *);

       /*
        * Changing settings may require taking device out of "data mode",
        * which can be quite expensive.  Also, audiosetinfo() may
        * change several settings in quick succession.  To avoid
        * having to take the device in/out of "data mode", we provide
        * this function which indicates completion of settings
        * adjustment.
        */
       int     (*commit_settings)(void *);

       /* Start input/output routines. These usually control DMA. */
       int     (*init_output)(void *, void *, int);
       int     (*init_input)(void *, void *, int);
       int     (*start_output)(void *, void *, int,
                                   void (*)(void *), void *);
       int     (*start_input)(void *, void *, int,
                                  void (*)(void *), void *);
       int     (*halt_output)(void *);
       int     (*halt_input)(void *);

       int     (*speaker_ctl)(void *, int);
#define SPKR_ON         1
#define SPKR_OFF        0

       int     (*getdev)(void *, struct audio_device *);

       /* Mixer (in/out ports) */
       int     (*set_port)(void *, mixer_ctrl_t *);
       int     (*get_port)(void *, mixer_ctrl_t *);

       int     (*query_devinfo)(void *, mixer_devinfo_t *);

       /* Allocate/free memory for the ring buffer. Usually malloc/free. */
       void    *(*allocm)(void *, int, size_t);
       void    (*freem)(void *, void *, size_t);
       size_t  (*round_buffersize)(void *, int, size_t);

       int     (*get_props)(void *); /* device properties */

       int     (*trigger_output)(void *, void *, void *, int,
                   void (*)(void *), void *, const audio_params_t *);
       int     (*trigger_input)(void *, void *, void *, int,
                   void (*)(void *), void *, const audio_params_t *);
       int     (*dev_ioctl)(void *, u_long, void *, int, struct lwp *);
       void    (*get_locks)(void *, kmutex_t **, kmutex_t **);
};

struct audio_attach_args {
       int     type;
       const void *hwif;       /* either audio_hw_if * or midi_hw_if * */
       void    *hdl;
};
#define AUDIODEV_TYPE_AUDIO     0
#define AUDIODEV_TYPE_MIDI      1
#define AUDIODEV_TYPE_OPL       2
#define AUDIODEV_TYPE_MPU       3
#define AUDIODEV_TYPE_AUX       4

/* Attach the MI driver(s) to the MD driver. */
device_t audio_attach_mi(const struct audio_hw_if *, void *, device_t);
int     audioprint(void *, const char *);

extern int audio_query_format(const struct audio_format *, int,
       audio_format_query_t *);
extern int audio_indexof_format(const struct audio_format *, int, int,
       const audio_params_t *);
extern const char *audio_encoding_name(int);

#endif /* _KERNEL */

/* Device identity flags */
#define SOUND_DEVICE            0
#define AUDIO_DEVICE            0x80
#define AUDIOCTL_DEVICE         0xc0
#define MIXER_DEVICE            0x10

#define AUDIOUNIT(x)            (minor(x)&0x0f)
#define AUDIODEV(x)             (minor(x)&0xf0)

#define ISDEVSOUND(x)           (AUDIODEV((x)) == SOUND_DEVICE)
#define ISDEVAUDIO(x)           (AUDIODEV((x)) == AUDIO_DEVICE)
#define ISDEVAUDIOCTL(x)        (AUDIODEV((x)) == AUDIOCTL_DEVICE)
#define ISDEVMIXER(x)           (AUDIODEV((x)) == MIXER_DEVICE)

/*
* USB Audio specification defines 12 channels:
*      L R C LFE Ls Rs Lc Rc S Sl Sr T
*/
#define AUDIO_MAX_CHANNELS      12

#endif /* _SYS_DEV_AUDIO_AUDIO_IF_H_ */

You are viewing proxied material from ftp.icm.edu.pl. The copyright of proxied material belongs to its original authors. Any comments or complaints in relation to proxied material should be directed to the original authors of the content concerned. Please see the disclaimer for more details.