sound/pci/pcxhr/pcxhr_core.h

   1 /*
   2  * Driver for Digigram pcxhr compatible soundcards
   3  *
   4  * low level interface with interrupt and message handling
   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_CORE_H
  24 #define __SOUND_PCXHR_CORE_H
  25
  26 struct firmware;
  27 struct pcxhr_mgr;
  28
  29 /* init and firmware download commands */
  30 void pcxhr_reset_xilinx_com(struct pcxhr_mgr *mgr);
  31 void pcxhr_reset_dsp(struct pcxhr_mgr *mgr);
  32 void pcxhr_enable_dsp(struct pcxhr_mgr *mgr);
  33 int pcxhr_load_xilinx_binary(struct pcxhr_mgr *mgr, const struct firmware *xilinx, int second);
  34 int pcxhr_load_eeprom_binary(struct pcxhr_mgr *mgr, const struct firmware *eeprom);
  35 int pcxhr_load_boot_binary(struct pcxhr_mgr *mgr, const struct firmware *boot);
  36 int pcxhr_load_dsp_binary(struct pcxhr_mgr *mgr, const struct firmware *dsp);
  37
  38 /* DSP time available on MailBox4 register : 24 bit time samples() */
  39 #define PCXHR_DSP_TIME_MASK             0x00ffffff
  40 #define PCXHR_DSP_TIME_INVALID          0x10000000
  41
  42
  43 #define PCXHR_SIZE_MAX_CMD              8
  44 #define PCXHR_SIZE_MAX_STATUS           16
  45 #define PCXHR_SIZE_MAX_LONG_STATUS      256
  46
  47 struct pcxhr_rmh {
  48         u16     cmd_len;                /* length of the command to send (WORDs) */
  49         u16     stat_len;               /* length of the status received (WORDs) */
  50         u16     dsp_stat;               /* status type, RMP_SSIZE_XXX */
  51         u16     cmd_idx;                /* index of the command */
  52         u32     cmd[PCXHR_SIZE_MAX_CMD];
  53         u32     stat[PCXHR_SIZE_MAX_STATUS];
  54 };
  55
  56 enum {
  57         CMD_VERSION,                    /* cmd_len = 2  stat_len = 1 */
  58         CMD_SUPPORTED,                  /* cmd_len = 1  stat_len = 4 */
  59         CMD_TEST_IT,                    /* cmd_len = 1  stat_len = 1 */
  60         CMD_SEND_IRQA,                  /* cmd_len = 1  stat_len = 0 */
  61         CMD_ACCESS_IO_WRITE,            /* cmd_len >= 1 stat_len >= 1 */
  62         CMD_ACCESS_IO_READ,             /* cmd_len >= 1 stat_len >= 1 */
  63         CMD_ASYNC,                      /* cmd_len = 1  stat_len = 1 */
  64         CMD_MODIFY_CLOCK,               /* cmd_len = 3  stat_len = 0 */
  65         CMD_RESYNC_AUDIO_INPUTS,        /* cmd_len = 1  stat_len = 0 */
  66         CMD_GET_DSP_RESOURCES,          /* cmd_len = 1  stat_len = 4 */
  67         CMD_SET_TIMER_INTERRUPT,        /* cmd_len = 1  stat_len = 0 */
  68         CMD_RES_PIPE,                   /* cmd_len >=2  stat_len = 0 */
  69         CMD_FREE_PIPE,                  /* cmd_len = 1  stat_len = 0 */
  70         CMD_CONF_PIPE,                  /* cmd_len = 2  stat_len = 0 */
  71         CMD_STOP_PIPE,                  /* cmd_len = 1  stat_len = 0 */
  72         CMD_PIPE_SAMPLE_COUNT,          /* cmd_len = 2  stat_len = 2 */
  73         CMD_CAN_START_PIPE,             /* cmd_len >= 1 stat_len = 1 */
  74         CMD_START_STREAM,               /* cmd_len = 2  stat_len = 0 */
  75         CMD_STREAM_OUT_LEVEL_ADJUST,    /* cmd_len >= 1 stat_len = 0 */
  76         CMD_STOP_STREAM,                /* cmd_len = 2  stat_len = 0 */
  77         CMD_UPDATE_R_BUFFERS,           /* cmd_len = 4  stat_len = 0 */
  78         CMD_FORMAT_STREAM_OUT,          /* cmd_len >= 2 stat_len = 0 */
  79         CMD_FORMAT_STREAM_IN,           /* cmd_len >= 4 stat_len = 0 */
  80         CMD_STREAM_SAMPLE_COUNT,        /* cmd_len = 2  stat_len = (2 * nb_stream) */
  81         CMD_AUDIO_LEVEL_ADJUST,         /* cmd_len = 3  stat_len = 0 */
  82         CMD_GET_TIME_CODE,              /* cmd_len = 1  stat_len = 5 */
  83         CMD_MANAGE_SIGNAL,              /* cmd_len = 1  stat_len = 0 */
  84         CMD_LAST_INDEX
  85 };
  86
  87 #define MASK_DSP_WORD           0x00ffffff
  88 #define MASK_ALL_STREAM         0x00ffffff
  89 #define MASK_DSP_WORD_LEVEL     0x000001ff
  90 #define MASK_FIRST_FIELD        0x0000001f
  91 #define FIELD_SIZE              5
  92
  93 /*
  94  init the rmh struct; by default cmd_len is set to 1
  95  */
  96 void pcxhr_init_rmh(struct pcxhr_rmh *rmh, int cmd);
  97
  98 void pcxhr_set_pipe_cmd_params(struct pcxhr_rmh* rmh, int capture, unsigned int param1,
  99                                unsigned int param2, unsigned int param3);
 100
 101 #define DSP_EXT_CMD_SET(x) (x->dsp_version > 0x012800)
 102
 103 /*
 104  send the rmh
 105  */
 106 int pcxhr_send_msg(struct pcxhr_mgr *mgr, struct pcxhr_rmh *rmh);
 107
 108
 109 /* values used for CMD_ACCESS_IO_WRITE and CMD_ACCESS_IO_READ */
 110 #define IO_NUM_REG_CONT                 0
 111 #define IO_NUM_REG_GENCLK               1
 112 #define IO_NUM_REG_MUTE_OUT             2
 113 #define IO_NUM_SPEED_RATIO              4
 114 #define IO_NUM_REG_STATUS               5
 115 #define IO_NUM_REG_CUER                 10
 116 #define IO_NUM_UER_CHIP_REG             11
 117 #define IO_NUM_REG_CONFIG_SRC           12
 118 #define IO_NUM_REG_OUT_ANA_LEVEL        20
 119 #define IO_NUM_REG_IN_ANA_LEVEL         21
 120
 121 #define REG_CONT_VALSMPTE               0x000800
 122 #define REG_CONT_UNMUTE_INPUTS          0x020000
 123
 124 /* parameters used with register IO_NUM_REG_STATUS */
 125 #define REG_STATUS_OPTIONS              0
 126 #define REG_STATUS_AES_SYNC             8
 127 #define REG_STATUS_AES_1                9
 128 #define REG_STATUS_AES_2                10
 129 #define REG_STATUS_AES_3                11
 130 #define REG_STATUS_AES_4                12
 131 #define REG_STATUS_WORD_CLOCK           13
 132 #define REG_STATUS_INTER_SYNC           14
 133 #define REG_STATUS_CURRENT              0x80
 134 /* results */
 135 #define REG_STATUS_OPT_NO_VIDEO_SIGNAL  0x01
 136 #define REG_STATUS_OPT_DAUGHTER_MASK    0x1c
 137 #define REG_STATUS_OPT_ANALOG_BOARD     0x00
 138 #define REG_STATUS_OPT_NO_DAUGHTER      0x1c
 139 #define REG_STATUS_OPT_COMPANION_MASK   0xe0
 140 #define REG_STATUS_OPT_NO_COMPANION     0xe0
 141 #define REG_STATUS_SYNC_32000           0x00
 142 #define REG_STATUS_SYNC_44100           0x01
 143 #define REG_STATUS_SYNC_48000           0x02
 144 #define REG_STATUS_SYNC_64000           0x03
 145 #define REG_STATUS_SYNC_88200           0x04
 146 #define REG_STATUS_SYNC_96000           0x05
 147 #define REG_STATUS_SYNC_128000          0x06
 148 #define REG_STATUS_SYNC_176400          0x07
 149 #define REG_STATUS_SYNC_192000          0x08
 150
 151 int pcxhr_set_pipe_state(struct pcxhr_mgr *mgr, int playback_mask, int capture_mask, int start);
 152
 153 int pcxhr_write_io_num_reg_cont(struct pcxhr_mgr *mgr, unsigned int mask,
 154                                 unsigned int value, int *changed);
 155
 156 /* codec parameters */
 157 #define CS8416_RUN              0x200401
 158 #define CS8416_FORMAT_DETECT    0x200b00
 159 #define CS8416_CSB0             0x201900
 160 #define CS8416_CSB1             0x201a00
 161 #define CS8416_CSB2             0x201b00
 162 #define CS8416_CSB3             0x201c00
 163 #define CS8416_CSB4             0x201d00
 164 #define CS8416_VERSION          0x207f00
 165
 166 #define CS8420_DATA_FLOW_CTL    0x200301
 167 #define CS8420_CLOCK_SRC_CTL    0x200401
 168 #define CS8420_RECEIVER_ERRORS  0x201000
 169 #define CS8420_SRC_RATIO        0x201e00
 170 #define CS8420_CSB0             0x202000
 171 #define CS8420_CSB1             0x202100
 172 #define CS8420_CSB2             0x202200
 173 #define CS8420_CSB3             0x202300
 174 #define CS8420_CSB4             0x202400
 175 #define CS8420_VERSION          0x207f00
 176
 177 #define CS4271_MODE_CTL_1       0x200101
 178 #define CS4271_DAC_CTL          0x200201
 179 #define CS4271_VOLMIX           0x200301
 180 #define CS4271_VOLMUTE_LEFT     0x200401
 181 #define CS4271_VOLMUTE_RIGHT    0x200501
 182 #define CS4271_ADC_CTL          0x200601
 183 #define CS4271_MODE_CTL_2       0x200701
 184
 185 #define CHIP_SIG_AND_MAP_SPI    0xff7f00
 186
 187 /* codec selection */
 188 #define CS4271_01_CS            0x160018
 189 #define CS4271_23_CS            0x160019
 190 #define CS4271_45_CS            0x16001a
 191 #define CS4271_67_CS            0x16001b
 192 #define CS4271_89_CS            0x16001c
 193 #define CS4271_AB_CS            0x16001d
 194 #define CS8420_01_CS            0x080090
 195 #define CS8420_23_CS            0x080092
 196 #define CS8420_45_CS            0x080094
 197 #define CS8420_67_CS            0x080096
 198 #define CS8416_01_CS            0x080098
 199
 200
 201 /* interrupt handling */
 202 irqreturn_t pcxhr_interrupt(int irq, void *dev_id);
 203 irqreturn_t pcxhr_threaded_irq(int irq, void *dev_id);
 204
 205 #endif /* __SOUND_PCXHR_CORE_H */