include/sound/hdaudio.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * HD-audio core stuff
   4  */
   5
   6 #ifndef __SOUND_HDAUDIO_H
   7 #define __SOUND_HDAUDIO_H
   8
   9 #include <linux/device.h>
  10 #include <linux/interrupt.h>
  11 #include <linux/pm_runtime.h>
  12 #include <linux/timecounter.h>
  13 #include <sound/core.h>
  14 #include <sound/pcm.h>
  15 #include <sound/memalloc.h>
  16 #include <sound/hda_verbs.h>
  17 #include <drm/i915_component.h>
  18
  19 /* codec node id */
  20 typedef u16 hda_nid_t;
  21
  22 struct hdac_bus;
  23 struct hdac_stream;
  24 struct hdac_device;
  25 struct hdac_driver;
  26 struct hdac_widget_tree;
  27 struct hda_device_id;
  28
  29 /*
  30  * exported bus type
  31  */
  32 extern struct bus_type snd_hda_bus_type;
  33
  34 /*
  35  * generic arrays
  36  */
  37 struct snd_array {
  38         unsigned int used;
  39         unsigned int alloced;
  40         unsigned int elem_size;
  41         unsigned int alloc_align;
  42         void *list;
  43 };
  44
  45 /*
  46  * HD-audio codec base device
  47  */
  48 struct hdac_device {
  49         struct device dev;
  50         int type;
  51         struct hdac_bus *bus;
  52         unsigned int addr;              /* codec address */
  53         struct list_head list;          /* list point for bus codec_list */
  54
  55         hda_nid_t afg;                  /* AFG node id */
  56         hda_nid_t mfg;                  /* MFG node id */
  57
  58         /* ids */
  59         unsigned int vendor_id;
  60         unsigned int subsystem_id;
  61         unsigned int revision_id;
  62         unsigned int afg_function_id;
  63         unsigned int mfg_function_id;
  64         unsigned int afg_unsol:1;
  65         unsigned int mfg_unsol:1;
  66
  67         unsigned int power_caps;        /* FG power caps */
  68
  69         const char *vendor_name;        /* codec vendor name */
  70         const char *chip_name;          /* codec chip name */
  71
  72         /* verb exec op override */
  73         int (*exec_verb)(struct hdac_device *dev, unsigned int cmd,
  74                          unsigned int flags, unsigned int *res);
  75
  76         /* widgets */
  77         unsigned int num_nodes;
  78         hda_nid_t start_nid, end_nid;
  79
  80         /* misc flags */
  81         atomic_t in_pm;         /* suspend/resume being performed */
  82
  83         /* sysfs */
  84         struct mutex widget_lock;
  85         struct hdac_widget_tree *widgets;
  86
  87         /* regmap */
  88         struct regmap *regmap;
  89         struct snd_array vendor_verbs;
  90         bool lazy_cache:1;      /* don't wake up for writes */
  91         bool caps_overwriting:1; /* caps overwrite being in process */
  92         bool cache_coef:1;      /* cache COEF read/write too */
  93 };
  94
  95 /* device/driver type used for matching */
  96 enum {
  97         HDA_DEV_CORE,
  98         HDA_DEV_LEGACY,
  99         HDA_DEV_ASOC,
 100 };
 101
 102 enum {
 103         SND_SKL_PCI_BIND_AUTO,  /* automatic selection based on pci class */
 104         SND_SKL_PCI_BIND_LEGACY,/* bind only with legacy driver */
 105         SND_SKL_PCI_BIND_ASOC   /* bind only with ASoC driver */
 106 };
 107
 108 /* direction */
 109 enum {
 110         HDA_INPUT, HDA_OUTPUT
 111 };
 112
 113 #define dev_to_hdac_dev(_dev)   container_of(_dev, struct hdac_device, dev)
 114
 115 int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus,
 116                          const char *name, unsigned int addr);
 117 void snd_hdac_device_exit(struct hdac_device *dev);
 118 int snd_hdac_device_register(struct hdac_device *codec);
 119 void snd_hdac_device_unregister(struct hdac_device *codec);
 120 int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name);
 121 int snd_hdac_codec_modalias(struct hdac_device *hdac, char *buf, size_t size);
 122
 123 int snd_hdac_refresh_widgets(struct hdac_device *codec);
 124
 125 unsigned int snd_hdac_make_cmd(struct hdac_device *codec, hda_nid_t nid,
 126                                unsigned int verb, unsigned int parm);
 127 int snd_hdac_exec_verb(struct hdac_device *codec, unsigned int cmd,
 128                        unsigned int flags, unsigned int *res);
 129 int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid,
 130                   unsigned int verb, unsigned int parm, unsigned int *res);
 131 int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm,
 132                         unsigned int *res);
 133 int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid,
 134                                 int parm);
 135 int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid,
 136                            unsigned int parm, unsigned int val);
 137 int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid,
 138                              hda_nid_t *conn_list, int max_conns);
 139 int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid,
 140                            hda_nid_t *start_id);
 141 unsigned int snd_hdac_calc_stream_format(unsigned int rate,
 142                                          unsigned int channels,
 143                                          snd_pcm_format_t format,
 144                                          unsigned int maxbps,
 145                                          unsigned short spdif_ctls);
 146 int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid,
 147                                 u32 *ratesp, u64 *formatsp, unsigned int *bpsp);
 148 bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid,
 149                                   unsigned int format);
 150
 151 int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid,
 152                         int flags, unsigned int verb, unsigned int parm);
 153 int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid,
 154                         int flags, unsigned int verb, unsigned int parm);
 155 bool snd_hdac_check_power_state(struct hdac_device *hdac,
 156                 hda_nid_t nid, unsigned int target_state);
 157 unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac,
 158                       hda_nid_t nid, unsigned int target_state);
 159 /**
 160  * snd_hdac_read_parm - read a codec parameter
 161  * @codec: the codec object
 162  * @nid: NID to read a parameter
 163  * @parm: parameter to read
 164  *
 165  * Returns -1 for error.  If you need to distinguish the error more
 166  * strictly, use _snd_hdac_read_parm() directly.
 167  */
 168 static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid,
 169                                      int parm)
 170 {
 171         unsigned int val;
 172
 173         return _snd_hdac_read_parm(codec, nid, parm, &val) < 0 ? -1 : val;
 174 }
 175
 176 #ifdef CONFIG_PM
 177 int snd_hdac_power_up(struct hdac_device *codec);
 178 int snd_hdac_power_down(struct hdac_device *codec);
 179 int snd_hdac_power_up_pm(struct hdac_device *codec);
 180 int snd_hdac_power_down_pm(struct hdac_device *codec);
 181 int snd_hdac_keep_power_up(struct hdac_device *codec);
 182
 183 /* call this at entering into suspend/resume callbacks in codec driver */
 184 static inline void snd_hdac_enter_pm(struct hdac_device *codec)
 185 {
 186         atomic_inc(&codec->in_pm);
 187 }
 188
 189 /* call this at leaving from suspend/resume callbacks in codec driver */
 190 static inline void snd_hdac_leave_pm(struct hdac_device *codec)
 191 {
 192         atomic_dec(&codec->in_pm);
 193 }
 194
 195 static inline bool snd_hdac_is_in_pm(struct hdac_device *codec)
 196 {
 197         return atomic_read(&codec->in_pm);
 198 }
 199
 200 static inline bool snd_hdac_is_power_on(struct hdac_device *codec)
 201 {
 202         return !pm_runtime_suspended(&codec->dev);
 203 }
 204 #else
 205 static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; }
 206 static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; }
 207 static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; }
 208 static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; }
 209 static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; }
 210 static inline void snd_hdac_enter_pm(struct hdac_device *codec) {}
 211 static inline void snd_hdac_leave_pm(struct hdac_device *codec) {}
 212 static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { return 0; }
 213 static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { return 1; }
 214 #endif
 215
 216 /*
 217  * HD-audio codec base driver
 218  */
 219 struct hdac_driver {
 220         struct device_driver driver;
 221         int type;
 222         const struct hda_device_id *id_table;
 223         int (*match)(struct hdac_device *dev, struct hdac_driver *drv);
 224         void (*unsol_event)(struct hdac_device *dev, unsigned int event);
 225
 226         /* fields used by ext bus APIs */
 227         int (*probe)(struct hdac_device *dev);
 228         int (*remove)(struct hdac_device *dev);
 229         void (*shutdown)(struct hdac_device *dev);
 230 };
 231
 232 #define drv_to_hdac_driver(_drv) container_of(_drv, struct hdac_driver, driver)
 233
 234 const struct hda_device_id *
 235 hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv);
 236
 237 /*
 238  * Bus verb operators
 239  */
 240 struct hdac_bus_ops {
 241         /* send a single command */
 242         int (*command)(struct hdac_bus *bus, unsigned int cmd);
 243         /* get a response from the last command */
 244         int (*get_response)(struct hdac_bus *bus, unsigned int addr,
 245                             unsigned int *res);
 246 };
 247
 248 /*
 249  * ops used for ASoC HDA codec drivers
 250  */
 251 struct hdac_ext_bus_ops {
 252         int (*hdev_attach)(struct hdac_device *hdev);
 253         int (*hdev_detach)(struct hdac_device *hdev);
 254 };
 255
 256 /*
 257  * Lowlevel I/O operators
 258  */
 259 struct hdac_io_ops {
 260         /* mapped register accesses */
 261         void (*reg_writel)(u32 value, u32 __iomem *addr);
 262         u32 (*reg_readl)(u32 __iomem *addr);
 263         void (*reg_writew)(u16 value, u16 __iomem *addr);
 264         u16 (*reg_readw)(u16 __iomem *addr);
 265         void (*reg_writeb)(u8 value, u8 __iomem *addr);
 266         u8 (*reg_readb)(u8 __iomem *addr);
 267         /* Allocation ops */
 268         int (*dma_alloc_pages)(struct hdac_bus *bus, int type, size_t size,
 269                                struct snd_dma_buffer *buf);
 270         void (*dma_free_pages)(struct hdac_bus *bus,
 271                                struct snd_dma_buffer *buf);
 272 };
 273
 274 #define HDA_UNSOL_QUEUE_SIZE    64
 275 #define HDA_MAX_CODECS          8       /* limit by controller side */
 276
 277 /*
 278  * CORB/RIRB
 279  *
 280  * Each CORB entry is 4byte, RIRB is 8byte
 281  */
 282 struct hdac_rb {
 283         __le32 *buf;            /* virtual address of CORB/RIRB buffer */
 284         dma_addr_t addr;        /* physical address of CORB/RIRB buffer */
 285         unsigned short rp, wp;  /* RIRB read/write pointers */
 286         int cmds[HDA_MAX_CODECS];       /* number of pending requests */
 287         u32 res[HDA_MAX_CODECS];        /* last read value */
 288 };
 289
 290 /*
 291  * HD-audio bus base driver
 292  *
 293  * @ppcap: pp capabilities pointer
 294  * @spbcap: SPIB capabilities pointer
 295  * @mlcap: MultiLink capabilities pointer
 296  * @gtscap: gts capabilities pointer
 297  * @drsmcap: dma resume capabilities pointer
 298  * @num_streams: streams supported
 299  * @idx: HDA link index
 300  * @hlink_list: link list of HDA links
 301  * @lock: lock for link and display power mgmt
 302  * @cmd_dma_state: state of cmd DMAs: CORB and RIRB
 303  */
 304 struct hdac_bus {
 305         struct device *dev;
 306         const struct hdac_bus_ops *ops;
 307         const struct hdac_io_ops *io_ops;
 308         const struct hdac_ext_bus_ops *ext_ops;
 309
 310         /* h/w resources */
 311         unsigned long addr;
 312         void __iomem *remap_addr;
 313         int irq;
 314
 315         void __iomem *ppcap;
 316         void __iomem *spbcap;
 317         void __iomem *mlcap;
 318         void __iomem *gtscap;
 319         void __iomem *drsmcap;
 320
 321         /* codec linked list */
 322         struct list_head codec_list;
 323         unsigned int num_codecs;
 324
 325         /* link caddr -> codec */
 326         struct hdac_device *caddr_tbl[HDA_MAX_CODEC_ADDRESS + 1];
 327
 328         /* unsolicited event queue */
 329         u32 unsol_queue[HDA_UNSOL_QUEUE_SIZE * 2]; /* ring buffer */
 330         unsigned int unsol_rp, unsol_wp;
 331         struct work_struct unsol_work;
 332
 333         /* bit flags of detected codecs */
 334         unsigned long codec_mask;
 335
 336         /* bit flags of powered codecs */
 337         unsigned long codec_powered;
 338
 339         /* CORB/RIRB */
 340         struct hdac_rb corb;
 341         struct hdac_rb rirb;
 342         unsigned int last_cmd[HDA_MAX_CODECS];  /* last sent command */
 343
 344         /* CORB/RIRB and position buffers */
 345         struct snd_dma_buffer rb;
 346         struct snd_dma_buffer posbuf;
 347
 348         /* hdac_stream linked list */
 349         struct list_head stream_list;
 350
 351         /* operation state */
 352         bool chip_init:1;               /* h/w initialized */
 353
 354         /* behavior flags */
 355         bool sync_write:1;              /* sync after verb write */
 356         bool use_posbuf:1;              /* use position buffer */
 357         bool snoop:1;                   /* enable snooping */
 358         bool align_bdle_4k:1;           /* BDLE align 4K boundary */
 359         bool reverse_assign:1;          /* assign devices in reverse order */
 360         bool corbrp_self_clear:1;       /* CORBRP clears itself after reset */
 361         bool polling_mode:1;
 362
 363         int poll_count;
 364
 365         int bdl_pos_adj;                /* BDL position adjustment */
 366
 367         /* locks */
 368         spinlock_t reg_lock;
 369         struct mutex cmd_mutex;
 370         struct mutex lock;
 371
 372         /* DRM component interface */
 373         struct drm_audio_component *audio_component;
 374         long display_power_status;
 375         unsigned long display_power_active;
 376
 377         /* parameters required for enhanced capabilities */
 378         int num_streams;
 379         int idx;
 380
 381         /* link management */
 382         struct list_head hlink_list;
 383         bool cmd_dma_state;
 384 };
 385
 386 int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev,
 387                       const struct hdac_bus_ops *ops,
 388                       const struct hdac_io_ops *io_ops);
 389 void snd_hdac_bus_exit(struct hdac_bus *bus);
 390 int snd_hdac_bus_exec_verb(struct hdac_bus *bus, unsigned int addr,
 391                            unsigned int cmd, unsigned int *res);
 392 int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr,
 393                                     unsigned int cmd, unsigned int *res);
 394 void snd_hdac_bus_queue_event(struct hdac_bus *bus, u32 res, u32 res_ex);
 395
 396 int snd_hdac_bus_add_device(struct hdac_bus *bus, struct hdac_device *codec);
 397 void snd_hdac_bus_remove_device(struct hdac_bus *bus,
 398                                 struct hdac_device *codec);
 399 void snd_hdac_bus_process_unsol_events(struct work_struct *work);
 400
 401 static inline void snd_hdac_codec_link_up(struct hdac_device *codec)
 402 {
 403         set_bit(codec->addr, &codec->bus->codec_powered);
 404 }
 405
 406 static inline void snd_hdac_codec_link_down(struct hdac_device *codec)
 407 {
 408         clear_bit(codec->addr, &codec->bus->codec_powered);
 409 }
 410
 411 int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val);
 412 int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr,
 413                               unsigned int *res);
 414 int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus);
 415
 416 bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset);
 417 void snd_hdac_bus_stop_chip(struct hdac_bus *bus);
 418 void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus);
 419 void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus);
 420 void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus);
 421 void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus);
 422 int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset);
 423
 424 void snd_hdac_bus_update_rirb(struct hdac_bus *bus);
 425 int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status,
 426                                     void (*ack)(struct hdac_bus *,
 427                                                 struct hdac_stream *));
 428
 429 int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus);
 430 void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus);
 431
 432 /*
 433  * macros for easy use
 434  */
 435 #define _snd_hdac_chip_writeb(chip, reg, value) \
 436         ((chip)->io_ops->reg_writeb(value, (chip)->remap_addr + (reg)))
 437 #define _snd_hdac_chip_readb(chip, reg) \
 438         ((chip)->io_ops->reg_readb((chip)->remap_addr + (reg)))
 439 #define _snd_hdac_chip_writew(chip, reg, value) \
 440         ((chip)->io_ops->reg_writew(value, (chip)->remap_addr + (reg)))
 441 #define _snd_hdac_chip_readw(chip, reg) \
 442         ((chip)->io_ops->reg_readw((chip)->remap_addr + (reg)))
 443 #define _snd_hdac_chip_writel(chip, reg, value) \
 444         ((chip)->io_ops->reg_writel(value, (chip)->remap_addr + (reg)))
 445 #define _snd_hdac_chip_readl(chip, reg) \
 446         ((chip)->io_ops->reg_readl((chip)->remap_addr + (reg)))
 447
 448 /* read/write a register, pass without AZX_REG_ prefix */
 449 #define snd_hdac_chip_writel(chip, reg, value) \
 450         _snd_hdac_chip_writel(chip, AZX_REG_ ## reg, value)
 451 #define snd_hdac_chip_writew(chip, reg, value) \
 452         _snd_hdac_chip_writew(chip, AZX_REG_ ## reg, value)
 453 #define snd_hdac_chip_writeb(chip, reg, value) \
 454         _snd_hdac_chip_writeb(chip, AZX_REG_ ## reg, value)
 455 #define snd_hdac_chip_readl(chip, reg) \
 456         _snd_hdac_chip_readl(chip, AZX_REG_ ## reg)
 457 #define snd_hdac_chip_readw(chip, reg) \
 458         _snd_hdac_chip_readw(chip, AZX_REG_ ## reg)
 459 #define snd_hdac_chip_readb(chip, reg) \
 460         _snd_hdac_chip_readb(chip, AZX_REG_ ## reg)
 461
 462 /* update a register, pass without AZX_REG_ prefix */
 463 #define snd_hdac_chip_updatel(chip, reg, mask, val) \
 464         snd_hdac_chip_writel(chip, reg, \
 465                              (snd_hdac_chip_readl(chip, reg) & ~(mask)) | (val))
 466 #define snd_hdac_chip_updatew(chip, reg, mask, val) \
 467         snd_hdac_chip_writew(chip, reg, \
 468                              (snd_hdac_chip_readw(chip, reg) & ~(mask)) | (val))
 469 #define snd_hdac_chip_updateb(chip, reg, mask, val) \
 470         snd_hdac_chip_writeb(chip, reg, \
 471                              (snd_hdac_chip_readb(chip, reg) & ~(mask)) | (val))
 472
 473 /*
 474  * HD-audio stream
 475  */
 476 struct hdac_stream {
 477         struct hdac_bus *bus;
 478         struct snd_dma_buffer bdl; /* BDL buffer */
 479         __le32 *posbuf;         /* position buffer pointer */
 480         int direction;          /* playback / capture (SNDRV_PCM_STREAM_*) */
 481
 482         unsigned int bufsize;   /* size of the play buffer in bytes */
 483         unsigned int period_bytes; /* size of the period in bytes */
 484         unsigned int frags;     /* number for period in the play buffer */
 485         unsigned int fifo_size; /* FIFO size */
 486
 487         void __iomem *sd_addr;  /* stream descriptor pointer */
 488
 489         u32 sd_int_sta_mask;    /* stream int status mask */
 490
 491         /* pcm support */
 492         struct snd_pcm_substream *substream;    /* assigned substream,
 493                                                  * set in PCM open
 494                                                  */
 495         unsigned int format_val;        /* format value to be set in the
 496                                          * controller and the codec
 497                                          */
 498         unsigned char stream_tag;       /* assigned stream */
 499         unsigned char index;            /* stream index */
 500         int assigned_key;               /* last device# key assigned to */
 501
 502         bool opened:1;
 503         bool running:1;
 504         bool prepared:1;
 505         bool no_period_wakeup:1;
 506         bool locked:1;
 507
 508         /* timestamp */
 509         unsigned long start_wallclk;    /* start + minimum wallclk */
 510         unsigned long period_wallclk;   /* wallclk for period */
 511         struct timecounter  tc;
 512         struct cyclecounter cc;
 513         int delay_negative_threshold;
 514
 515         struct list_head list;
 516 #ifdef CONFIG_SND_HDA_DSP_LOADER
 517         /* DSP access mutex */
 518         struct mutex dsp_mutex;
 519 #endif
 520 };
 521
 522 void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev,
 523                           int idx, int direction, int tag);
 524 struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus,
 525                                            struct snd_pcm_substream *substream);
 526 void snd_hdac_stream_release(struct hdac_stream *azx_dev);
 527 struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus,
 528                                         int dir, int stream_tag);
 529
 530 int snd_hdac_stream_setup(struct hdac_stream *azx_dev);
 531 void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev);
 532 int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev);
 533 int snd_hdac_stream_set_params(struct hdac_stream *azx_dev,
 534                                 unsigned int format_val);
 535 void snd_hdac_stream_start(struct hdac_stream *azx_dev, bool fresh_start);
 536 void snd_hdac_stream_clear(struct hdac_stream *azx_dev);
 537 void snd_hdac_stream_stop(struct hdac_stream *azx_dev);
 538 void snd_hdac_stream_reset(struct hdac_stream *azx_dev);
 539 void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set,
 540                                   unsigned int streams, unsigned int reg);
 541 void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start,
 542                           unsigned int streams);
 543 void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev,
 544                                       unsigned int streams);
 545 int snd_hdac_get_stream_stripe_ctl(struct hdac_bus *bus,
 546                                 struct snd_pcm_substream *substream);
 547
 548 /*
 549  * macros for easy use
 550  */
 551 #define _snd_hdac_stream_write(type, dev, reg, value)                   \
 552         ((dev)->bus->io_ops->reg_write ## type(value, (dev)->sd_addr + (reg)))
 553 #define _snd_hdac_stream_read(type, dev, reg)                           \
 554         ((dev)->bus->io_ops->reg_read ## type((dev)->sd_addr + (reg)))
 555
 556 /* read/write a register, pass without AZX_REG_ prefix */
 557 #define snd_hdac_stream_writel(dev, reg, value) \
 558         _snd_hdac_stream_write(l, dev, AZX_REG_ ## reg, value)
 559 #define snd_hdac_stream_writew(dev, reg, value) \
 560         _snd_hdac_stream_write(w, dev, AZX_REG_ ## reg, value)
 561 #define snd_hdac_stream_writeb(dev, reg, value) \
 562         _snd_hdac_stream_write(b, dev, AZX_REG_ ## reg, value)
 563 #define snd_hdac_stream_readl(dev, reg) \
 564         _snd_hdac_stream_read(l, dev, AZX_REG_ ## reg)
 565 #define snd_hdac_stream_readw(dev, reg) \
 566         _snd_hdac_stream_read(w, dev, AZX_REG_ ## reg)
 567 #define snd_hdac_stream_readb(dev, reg) \
 568         _snd_hdac_stream_read(b, dev, AZX_REG_ ## reg)
 569
 570 /* update a register, pass without AZX_REG_ prefix */
 571 #define snd_hdac_stream_updatel(dev, reg, mask, val) \
 572         snd_hdac_stream_writel(dev, reg, \
 573                                (snd_hdac_stream_readl(dev, reg) & \
 574                                 ~(mask)) | (val))
 575 #define snd_hdac_stream_updatew(dev, reg, mask, val) \
 576         snd_hdac_stream_writew(dev, reg, \
 577                                (snd_hdac_stream_readw(dev, reg) & \
 578                                 ~(mask)) | (val))
 579 #define snd_hdac_stream_updateb(dev, reg, mask, val) \
 580         snd_hdac_stream_writeb(dev, reg, \
 581                                (snd_hdac_stream_readb(dev, reg) & \
 582                                 ~(mask)) | (val))
 583
 584 #ifdef CONFIG_SND_HDA_DSP_LOADER
 585 /* DSP lock helpers */
 586 #define snd_hdac_dsp_lock_init(dev)     mutex_init(&(dev)->dsp_mutex)
 587 #define snd_hdac_dsp_lock(dev)          mutex_lock(&(dev)->dsp_mutex)
 588 #define snd_hdac_dsp_unlock(dev)        mutex_unlock(&(dev)->dsp_mutex)
 589 #define snd_hdac_stream_is_locked(dev)  ((dev)->locked)
 590 /* DSP loader helpers */
 591 int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
 592                          unsigned int byte_size, struct snd_dma_buffer *bufp);
 593 void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start);
 594 void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
 595                           struct snd_dma_buffer *dmab);
 596 #else /* CONFIG_SND_HDA_DSP_LOADER */
 597 #define snd_hdac_dsp_lock_init(dev)     do {} while (0)
 598 #define snd_hdac_dsp_lock(dev)          do {} while (0)
 599 #define snd_hdac_dsp_unlock(dev)        do {} while (0)
 600 #define snd_hdac_stream_is_locked(dev)  0
 601
 602 static inline int
 603 snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format,
 604                      unsigned int byte_size, struct snd_dma_buffer *bufp)
 605 {
 606         return 0;
 607 }
 608
 609 static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start)
 610 {
 611 }
 612
 613 static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev,
 614                                         struct snd_dma_buffer *dmab)
 615 {
 616 }
 617 #endif /* CONFIG_SND_HDA_DSP_LOADER */
 618
 619
 620 /*
 621  * generic array helpers
 622  */
 623 void *snd_array_new(struct snd_array *array);
 624 void snd_array_free(struct snd_array *array);
 625 static inline void snd_array_init(struct snd_array *array, unsigned int size,
 626                                   unsigned int align)
 627 {
 628         array->elem_size = size;
 629         array->alloc_align = align;
 630 }
 631
 632 static inline void *snd_array_elem(struct snd_array *array, unsigned int idx)
 633 {
 634         return array->list + idx * array->elem_size;
 635 }
 636
 637 static inline unsigned int snd_array_index(struct snd_array *array, void *ptr)
 638 {
 639         return (unsigned long)(ptr - array->list) / array->elem_size;
 640 }
 641
 642 /* a helper macro to iterate for each snd_array element */
 643 #define snd_array_for_each(array, idx, ptr) \
 644         for ((idx) = 0, (ptr) = (array)->list; (idx) < (array)->used; \
 645              (ptr) = snd_array_elem(array, ++(idx)))
 646
 647 #endif /* __SOUND_HDAUDIO_H */