sys/dev/sound/pci/hda/hdac_private.h

   1 /*-
   2  * Copyright (c) 2006 Stephane E. Potvin <sepotvin@videotron.ca>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/dev/sound/pci/hda/hdac_private.h,v 1.2 2006/10/06 18:59:27 ariff Exp $
  27  * $DragonFly: src/sys/dev/sound/pci/hda/hdac_private.h,v 1.1 2007/01/04 21:47:03 corecode Exp $
  28  */
  29
  30 #ifndef _HDAC_PRIVATE_H_
  31 #define _HDAC_PRIVATE_H_
  32
  33
  34 /****************************************************************************
  35  * Miscellanious defines
  36  ****************************************************************************/
  37 #define HDAC_DMA_ALIGNMENT      128
  38 #define HDAC_CODEC_MAX          16
  39
  40 #define HDAC_MTX_NAME           "hdac driver mutex"
  41
  42 /****************************************************************************
  43  * Helper Macros
  44  ****************************************************************************/
  45 #define HDAC_READ_1(mem, offset)                                        \
  46         bus_space_read_1((mem)->mem_tag, (mem)->mem_handle, (offset))
  47 #define HDAC_READ_2(mem, offset)                                        \
  48         bus_space_read_2((mem)->mem_tag, (mem)->mem_handle, (offset))
  49 #define HDAC_READ_4(mem, offset)                                        \
  50         bus_space_read_4((mem)->mem_tag, (mem)->mem_handle, (offset))
  51 #define HDAC_WRITE_1(mem, offset, value)                                \
  52         bus_space_write_1((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
  53 #define HDAC_WRITE_2(mem, offset, value)                                \
  54         bus_space_write_2((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
  55 #define HDAC_WRITE_4(mem, offset, value)                                \
  56         bus_space_write_4((mem)->mem_tag, (mem)->mem_handle, (offset), (value))
  57
  58 #define HDAC_ISDCTL(sc, n)      (_HDAC_ISDCTL((n), (sc)->num_iss, (sc)->num_oss))
  59 #define HDAC_ISDSTS(sc, n)      (_HDAC_ISDSTS((n), (sc)->num_iss, (sc)->num_oss))
  60 #define HDAC_ISDPICB(sc, n)     (_HDAC_ISDPICB((n), (sc)->num_iss, (sc)->num_oss))
  61 #define HDAC_ISDCBL(sc, n)      (_HDAC_ISDCBL((n), (sc)->num_iss, (sc)->num_oss))
  62 #define HDAC_ISDLVI(sc, n)      (_HDAC_ISDLVI((n), (sc)->num_iss, (sc)->num_oss))
  63 #define HDAC_ISDFIFOD(sc, n)    (_HDAC_ISDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
  64 #define HDAC_ISDFMT(sc, n)      (_HDAC_ISDFMT((n), (sc)->num_iss, (sc)->num_oss))
  65 #define HDAC_ISDBDPL(sc, n)     (_HDAC_ISDBDPL((n), (sc)->num_iss, (sc)->num_oss))
  66 #define HDAC_ISDBDPU(sc, n)     (_HDAC_ISDBDPU((n), (sc)->num_iss, (sc)->num_oss))
  67
  68 #define HDAC_OSDCTL(sc, n)      (_HDAC_OSDCTL((n), (sc)->num_iss, (sc)->num_oss))
  69 #define HDAC_OSDSTS(sc, n)      (_HDAC_OSDSTS((n), (sc)->num_iss, (sc)->num_oss))
  70 #define HDAC_OSDPICB(sc, n)     (_HDAC_OSDPICB((n), (sc)->num_iss, (sc)->num_oss))
  71 #define HDAC_OSDCBL(sc, n)      (_HDAC_OSDCBL((n), (sc)->num_iss, (sc)->num_oss))
  72 #define HDAC_OSDLVI(sc, n)      (_HDAC_OSDLVI((n), (sc)->num_iss, (sc)->num_oss))
  73 #define HDAC_OSDFIFOD(sc, n)    (_HDAC_OSDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
  74 #define HDAC_OSDBDPL(sc, n)     (_HDAC_OSDBDPL((n), (sc)->num_iss, (sc)->num_oss))
  75 #define HDAC_OSDBDPU(sc, n)     (_HDAC_OSDBDPU((n), (sc)->num_iss, (sc)->num_oss))
  76
  77 #define HDAC_BSDCTL(sc, n)      (_HDAC_BSDCTL((n), (sc)->num_iss, (sc)->num_oss))
  78 #define HDAC_BSDSTS(sc, n)      (_HDAC_BSDSTS((n), (sc)->num_iss, (sc)->num_oss))
  79 #define HDAC_BSDPICB(sc, n)     (_HDAC_BSDPICB((n), (sc)->num_iss, (sc)->num_oss))
  80 #define HDAC_BSDCBL(sc, n)      (_HDAC_BSDCBL((n), (sc)->num_iss, (sc)->num_oss))
  81 #define HDAC_BSDLVI(sc, n)      (_HDAC_BSDLVI((n), (sc)->num_iss, (sc)->num_oss))
  82 #define HDAC_BSDFIFOD(sc, n)    (_HDAC_BSDFIFOD((n), (sc)->num_iss, (sc)->num_oss))
  83 #define HDAC_BSDBDPL(sc, n)     (_HDAC_BSDBDPL((n), (sc)->num_iss, (sc)->num_oss))
  84 #define HDAC_BSDBDPU(sc, n)     (_HDAC_BSDBDPU((n), (sc)->num_iss, (sc)->num_oss))
  85
  86
  87 /****************************************************************************
  88  * Custom hdac malloc type
  89  ****************************************************************************/
  90 MALLOC_DECLARE(M_HDAC);
  91
  92 /****************************************************************************
  93  * struct hdac_mem
  94  *
  95  * Holds the resources necessary to describe the physical memory associated
  96  * with the device.
  97  ****************************************************************************/
  98 struct hdac_mem {
  99         struct resource         *mem_res;
 100         int                     mem_rid;
 101         bus_space_tag_t         mem_tag;
 102         bus_space_handle_t      mem_handle;
 103 };
 104
 105 /****************************************************************************
 106  * struct hdac_irq
 107  *
 108  * Holds the resources necessary to describe the irq associated with the
 109  * device.
 110  ****************************************************************************/
 111 struct hdac_irq {
 112         struct resource         *irq_res;
 113         int                     irq_rid;
 114         void                    *irq_handle;
 115 };
 116
 117 /****************************************************************************
 118  * struct hdac_dma
 119  *
 120  * This structure is used to hold all the information to manage the dma
 121  * states.
 122  ****************************************************************************/
 123 struct hdac_dma {
 124         bus_dma_tag_t   dma_tag;
 125         bus_dmamap_t    dma_map;
 126         bus_addr_t      dma_paddr;
 127         caddr_t         dma_vaddr;
 128 };
 129
 130 /****************************************************************************
 131  * struct hdac_rirb
 132  *
 133  * Hold a response from a verb sent to a codec received via the rirb.
 134  ****************************************************************************/
 135 struct hdac_rirb {
 136         uint32_t        response;
 137         uint32_t        response_ex;
 138 };
 139
 140 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK     0x0000000f
 141 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET   0
 142 #define HDAC_RIRB_RESPONSE_EX_UNSOLICITED       0x00000010
 143
 144 #define HDAC_RIRB_RESPONSE_EX_SDATA_IN(response_ex)                     \
 145     (((response_ex) & HDAC_RIRB_RESPONSE_EX_SDATA_IN_MASK) >>           \
 146     HDAC_RIRB_RESPONSE_EX_SDATA_IN_OFFSET)
 147
 148 /****************************************************************************
 149  * struct hdac_command_list
 150  *
 151  * This structure holds the list of verbs that are to be sent to the codec
 152  * via the corb and the responses received via the rirb. It's allocated by
 153  * the codec driver and is owned by it.
 154  ****************************************************************************/
 155 struct hdac_command_list {
 156         int             num_commands;
 157         uint32_t        *verbs;
 158         uint32_t        *responses;
 159 };
 160
 161 typedef int nid_t;
 162
 163 struct hdac_softc;
 164 /****************************************************************************
 165  * struct hdac_codec
 166  *
 167  ****************************************************************************/
 168 struct hdac_codec {
 169         int     verbs_sent;
 170         int     responses_received;
 171         nid_t   cad;
 172         struct hdac_command_list *commands;
 173         struct hdac_softc *sc;
 174 };
 175
 176 struct hdac_bdle {
 177         volatile uint32_t addrl;
 178         volatile uint32_t addrh;
 179         volatile uint32_t len;
 180         volatile uint32_t ioc;
 181 } __packed;
 182
 183 #define HDA_MAX_CONNS   32
 184 #define HDA_MAX_NAMELEN 32
 185
 186 struct hdac_devinfo;
 187
 188 struct hdac_widget {
 189         nid_t nid;
 190         int type;
 191         int enable;
 192         int nconns, selconn;
 193         uint32_t pflags, ctlflags;
 194         nid_t conns[HDA_MAX_CONNS];
 195         char name[HDA_MAX_NAMELEN];
 196         struct hdac_devinfo *devinfo;
 197         struct {
 198                 uint32_t widget_cap;
 199                 uint32_t outamp_cap;
 200                 uint32_t inamp_cap;
 201                 uint32_t supp_stream_formats;
 202                 uint32_t supp_pcm_size_rate;
 203                 uint32_t eapdbtl;
 204                 int outpath;
 205         } param;
 206         union {
 207                 struct {
 208                         uint32_t config;
 209                         uint32_t cap;
 210                         uint32_t ctrl;
 211                 } pin;
 212         } wclass;
 213 };
 214
 215 struct hdac_audio_ctl {
 216         struct hdac_widget *widget, *childwidget;
 217         int enable;
 218         int index;
 219         int mute, step, size, offset;
 220         int left, right;
 221         uint32_t muted;
 222         int ossdev;
 223         uint32_t dir, ossmask, ossval;
 224 };
 225
 226 /****************************************************************************
 227  * struct hdac_devinfo
 228  *
 229  * Holds all the parameters of a given codec function group. This is stored
 230  * in the ivar of each child of the hdac bus
 231  ****************************************************************************/
 232 struct hdac_devinfo {
 233         device_t dev;
 234         uint16_t vendor_id;
 235         uint16_t device_id;
 236         uint8_t revision_id;
 237         uint8_t stepping_id;
 238         uint8_t node_type;
 239         nid_t nid;
 240         nid_t startnode, endnode;
 241         int nodecnt;
 242         struct hdac_codec *codec;
 243         struct hdac_widget *widget;
 244         union {
 245                 struct {
 246                         uint32_t outamp_cap;
 247                         uint32_t inamp_cap;
 248                         uint32_t supp_stream_formats;
 249                         uint32_t supp_pcm_size_rate;
 250                         int ctlcnt, pcnt, rcnt;
 251                         struct hdac_audio_ctl *ctl;
 252                         uint32_t mvol;
 253                         uint32_t quirks;
 254                         int ossidx;
 255                         int playcnt, reccnt;
 256                         int parsing_strategy;
 257                 } audio;
 258                 /* XXX undefined: modem, hdmi. */
 259         } function;
 260 };
 261
 262 struct hdac_chan {
 263         struct snd_dbuf *b;
 264         struct pcm_channel *c;
 265         struct pcmchan_caps caps;
 266         struct hdac_devinfo *devinfo;
 267         struct hdac_dma bdl_dma;
 268         uint32_t spd, fmt, fmtlist[8], pcmrates[16];
 269         uint32_t supp_stream_formats, supp_pcm_size_rate;
 270         int ptr, prevptr, blkcnt, blksz;
 271         int dir;
 272         int off;
 273         int sid;
 274         int bit16, bit32;
 275         nid_t io[16];
 276 };
 277
 278 /****************************************************************************
 279  * struct hdac_softc
 280  *
 281  * This structure holds the current state of the hdac driver.
 282  ****************************************************************************/
 283 struct hdac_softc {
 284         device_t        dev;
 285         device_t        hdabus;
 286         struct spinlock *lock;
 287
 288         struct intr_config_hook intrhook;
 289
 290         struct hdac_mem mem;
 291         struct hdac_irq irq;
 292         uint32_t pci_subvendor;
 293
 294
 295         int             num_iss;
 296         int             num_oss;
 297         int             num_bss;
 298         int             support_64bit;
 299         int             streamcnt;
 300
 301         int             corb_size;
 302         struct hdac_dma corb_dma;
 303         int             corb_wp;
 304
 305         int             rirb_size;
 306         struct hdac_dma rirb_dma;
 307         int             rirb_rp;
 308
 309         struct hdac_chan        play, rec;
 310         bus_dma_tag_t           chan_dmat;
 311         int                     chan_size;
 312         int                     chan_blkcnt;
 313
 314 #define HDAC_UNSOLQ_MAX         64
 315 #define HDAC_UNSOLQ_READY       0
 316 #define HDAC_UNSOLQ_BUSY        1
 317         int             unsolq_rp;
 318         int             unsolq_wp;
 319         int             unsolq_st;
 320         uint32_t        unsolq[HDAC_UNSOLQ_MAX];
 321
 322         struct hdac_codec *codecs[HDAC_CODEC_MAX];
 323
 324         int             registered;
 325 };
 326
 327 /****************************************************************************
 328  * struct hdac_command flags
 329  ****************************************************************************/
 330 #define HDAC_COMMAND_FLAG_WAITOK        0x0000
 331 #define HDAC_COMMAND_FLAG_NOWAIT        0x0001
 332
 333 #endif