sound/pci/pcxhr/pcxhr.h

   1 /*
   2  * Driver for Digigram pcxhr soundcards
   3  *
   4  * main header file
   5  *
   6  * Copyright (c) 2004 by Digigram <alsa@digigram.com>
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  */
  22
  23 #ifndef __SOUND_PCXHR_H
  24 #define __SOUND_PCXHR_H
  25
  26 #include <linux/interrupt.h>
  27 #include <linux/mutex.h>
  28 #include <sound/pcm.h>
  29
  30 #define PCXHR_DRIVER_VERSION            0x000804        /* 0.8.4 */
  31 #define PCXHR_DRIVER_VERSION_STRING     "0.8.4"         /* 0.8.4 */
  32
  33
  34 #define PCXHR_MAX_CARDS                 6
  35 #define PCXHR_PLAYBACK_STREAMS          4
  36
  37 #define PCXHR_GRANULARITY               96      /* transfer granularity (should be min 96 and multiple of 48) */
  38 #define PCXHR_GRANULARITY_MIN           96      /* transfer granularity of pipes and the dsp time (MBOX4) */
  39
  40 struct snd_pcxhr;
  41 struct pcxhr_mgr;
  42
  43 struct pcxhr_stream;
  44 struct pcxhr_pipe;
  45
  46 enum pcxhr_clock_type {
  47         PCXHR_CLOCK_TYPE_INTERNAL = 0,
  48         PCXHR_CLOCK_TYPE_WORD_CLOCK,
  49         PCXHR_CLOCK_TYPE_AES_SYNC,
  50         PCXHR_CLOCK_TYPE_AES_1,
  51         PCXHR_CLOCK_TYPE_AES_2,
  52         PCXHR_CLOCK_TYPE_AES_3,
  53         PCXHR_CLOCK_TYPE_AES_4,
  54 };
  55
  56 struct pcxhr_mgr {
  57         unsigned int num_cards;
  58         struct snd_pcxhr *chip[PCXHR_MAX_CARDS];
  59
  60         struct pci_dev *pci;
  61
  62         int irq;
  63
  64         /* card access with 1 mem bar and 2 io bar's */
  65         unsigned long port[3];
  66
  67         /* share the name */
  68         char shortname[32];             /* short name of this soundcard */
  69         char longname[96];              /* name of this soundcard */
  70
  71         /* message tasklet */
  72         struct tasklet_struct msg_taskq;
  73         struct pcxhr_rmh *prmh;
  74         /* trigger tasklet */
  75         struct tasklet_struct trigger_taskq;
  76
  77         spinlock_t lock;                /* interrupt spinlock */
  78         spinlock_t msg_lock;            /* message spinlock */
  79
  80         struct mutex setup_mutex;       /* mutex used in hw_params, open and close */
  81         struct mutex mixer_mutex;       /* mutex for mixer */
  82
  83         /* hardware interface */
  84         unsigned int dsp_loaded;        /* bit flags of loaded dsp indices */
  85         unsigned int dsp_version;       /* read from embedded once firmware is loaded */
  86         int board_has_analog;           /* if 0 the board is digital only */
  87         int mono_capture;               /* if 1 the board does mono capture */
  88         int playback_chips;             /* 4 or 6 */
  89         int capture_chips;              /* 4 or 1 */
  90         int firmware_num;               /* 41 or 42 */
  91
  92         struct snd_dma_buffer hostport;
  93
  94         enum pcxhr_clock_type use_clock_type;   /* clock type selected by mixer */
  95         enum pcxhr_clock_type cur_clock_type;   /* current clock type synced */
  96         int sample_rate;
  97         int ref_count_rate;
  98         int timer_toggle;               /* timer interrupt toggles between the two values 0x200 and 0x300 */
  99         int dsp_time_last;              /* the last dsp time (read by interrupt) */
 100         int dsp_time_err;               /* dsp time errors */
 101         unsigned int src_it_dsp;        /* dsp interrupt source */
 102         unsigned int io_num_reg_cont;   /* backup of IO_NUM_REG_CONT */
 103         unsigned int codec_speed;       /* speed mode of the codecs */
 104         unsigned int sample_rate_real;  /* current real sample rate */
 105         int last_reg_stat;
 106         int async_err_stream_xrun;
 107         int async_err_pipe_xrun;
 108         int async_err_other_last;
 109 };
 110
 111
 112 enum pcxhr_stream_status {
 113         PCXHR_STREAM_STATUS_FREE,
 114         PCXHR_STREAM_STATUS_OPEN,
 115         PCXHR_STREAM_STATUS_SCHEDULE_RUN,
 116         PCXHR_STREAM_STATUS_STARTED,
 117         PCXHR_STREAM_STATUS_RUNNING,
 118         PCXHR_STREAM_STATUS_SCHEDULE_STOP,
 119         PCXHR_STREAM_STATUS_STOPPED,
 120         PCXHR_STREAM_STATUS_PAUSED
 121 };
 122
 123 struct pcxhr_stream {
 124         struct snd_pcm_substream *substream;
 125         snd_pcm_format_t format;
 126         struct pcxhr_pipe *pipe;
 127
 128         enum pcxhr_stream_status status;        /* free, open, running, draining, pause */
 129
 130         u_int64_t timer_abs_periods;    /* timer: samples elapsed since TRIGGER_START (multiple of period_size) */
 131         u_int32_t timer_period_frag;    /* timer: samples elapsed since last call to snd_pcm_period_elapsed (0..period_size) */
 132         u_int32_t timer_buf_periods;    /* nb of periods in the buffer that have already elapsed */
 133         int timer_is_synced;            /* if(0) : timer needs to be resynced with real hardware pointer */
 134
 135         int channels;
 136 };
 137
 138
 139 enum pcxhr_pipe_status {
 140         PCXHR_PIPE_UNDEFINED,
 141         PCXHR_PIPE_DEFINED
 142 };
 143
 144 struct pcxhr_pipe {
 145         enum pcxhr_pipe_status status;
 146         int is_capture;         /* this is a capture pipe */
 147         int first_audio;        /* first audio num */
 148 };
 149
 150
 151 struct snd_pcxhr {
 152         struct snd_card *card;
 153         struct pcxhr_mgr *mgr;
 154         int chip_idx;           /* zero based */
 155
 156         struct snd_pcm *pcm;            /* PCM */
 157
 158         struct pcxhr_pipe playback_pipe;                /* 1 stereo pipe only */
 159         struct pcxhr_pipe capture_pipe[2];              /* 1 stereo pipe or 2 mono pipes */
 160
 161         struct pcxhr_stream playback_stream[PCXHR_PLAYBACK_STREAMS];
 162         struct pcxhr_stream capture_stream[2];  /* 1 stereo stream or 2 mono streams */
 163         int nb_streams_play;
 164         int nb_streams_capt;
 165
 166         int analog_playback_active[2];          /* Mixer : Master Playback active (!mute) */
 167         int analog_playback_volume[2];          /* Mixer : Master Playback Volume */
 168         int analog_capture_volume[2];           /* Mixer : Master Capture Volume */
 169         int digital_playback_active[PCXHR_PLAYBACK_STREAMS][2]; /* Mixer : Digital Playback Active [streams][stereo]*/
 170         int digital_playback_volume[PCXHR_PLAYBACK_STREAMS][2]; /* Mixer : Digital Playback Volume [streams][stereo]*/
 171         int digital_capture_volume[2];          /* Mixer : Digital Capture Volume [stereo] */
 172         int monitoring_active[2];               /* Mixer : Monitoring Active */
 173         int monitoring_volume[2];               /* Mixer : Monitoring Volume */
 174         int audio_capture_source;               /* Mixer : Audio Capture Source */
 175         unsigned char aes_bits[5];              /* Mixer : IEC958_AES bits */
 176 };
 177
 178 struct pcxhr_hostport
 179 {
 180         char purgebuffer[6];
 181         char reserved[2];
 182 };
 183
 184 /* exported */
 185 int pcxhr_create_pcm(struct snd_pcxhr *chip);
 186 int pcxhr_set_clock(struct pcxhr_mgr *mgr, unsigned int rate);
 187 int pcxhr_get_external_clock(struct pcxhr_mgr *mgr, enum pcxhr_clock_type clock_type, int *sample_rate);
 188
 189 #endif /* __SOUND_PCXHR_H */