/* SPDX-License-Identifier: GPL-2.0 */ /* * HD-audio core stuff */ #ifndef __SOUND_HDAUDIO_H #define __SOUND_HDAUDIO_H #include <linux/device.h> #include <linux/interrupt.h> #include <linux/io.h> #include <linux/io-64-nonatomic-lo-hi.h> #include <linux/iopoll.h> #include <linux/pci.h> #include <linux/pm_runtime.h> #include <linux/timecounter.h> #include <sound/core.h> #include <sound/pcm.h> #include <sound/memalloc.h> #include <sound/hda_verbs.h> #include <drm/intel/i915_component.h> /* codec node id */ hda_nid_t; struct hdac_bus; struct hdac_stream; struct hdac_device; struct hdac_driver; struct hdac_widget_tree; struct hda_device_id; /* * exported bus type */ extern const struct bus_type snd_hda_bus_type; /* * generic arrays */ struct snd_array { … }; /* * HD-audio codec base device */ struct hdac_device { … }; /* device/driver type used for matching */ enum { … }; enum { … }; /* direction */ enum { … }; #define dev_to_hdac_dev(_dev) … int snd_hdac_device_init(struct hdac_device *dev, struct hdac_bus *bus, const char *name, unsigned int addr); void snd_hdac_device_exit(struct hdac_device *dev); int snd_hdac_device_register(struct hdac_device *codec); void snd_hdac_device_unregister(struct hdac_device *codec); int snd_hdac_device_set_chip_name(struct hdac_device *codec, const char *name); int snd_hdac_codec_modalias(const struct hdac_device *hdac, char *buf, size_t size); int snd_hdac_refresh_widgets(struct hdac_device *codec); int snd_hdac_read(struct hdac_device *codec, hda_nid_t nid, unsigned int verb, unsigned int parm, unsigned int *res); int _snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm, unsigned int *res); int snd_hdac_read_parm_uncached(struct hdac_device *codec, hda_nid_t nid, int parm); int snd_hdac_override_parm(struct hdac_device *codec, hda_nid_t nid, unsigned int parm, unsigned int val); int snd_hdac_get_connections(struct hdac_device *codec, hda_nid_t nid, hda_nid_t *conn_list, int max_conns); int snd_hdac_get_sub_nodes(struct hdac_device *codec, hda_nid_t nid, hda_nid_t *start_id); unsigned int snd_hdac_stream_format_bits(snd_pcm_format_t format, snd_pcm_subformat_t subformat, unsigned int maxbits); unsigned int snd_hdac_stream_format(unsigned int channels, unsigned int bits, unsigned int rate); unsigned int snd_hdac_spdif_stream_format(unsigned int channels, unsigned int bits, unsigned int rate, unsigned short spdif_ctls); int snd_hdac_query_supported_pcm(struct hdac_device *codec, hda_nid_t nid, u32 *ratesp, u64 *formatsp, u32 *subformatsp, unsigned int *bpsp); bool snd_hdac_is_supported_format(struct hdac_device *codec, hda_nid_t nid, unsigned int format); int snd_hdac_codec_read(struct hdac_device *hdac, hda_nid_t nid, int flags, unsigned int verb, unsigned int parm); int snd_hdac_codec_write(struct hdac_device *hdac, hda_nid_t nid, int flags, unsigned int verb, unsigned int parm); bool snd_hdac_check_power_state(struct hdac_device *hdac, hda_nid_t nid, unsigned int target_state); unsigned int snd_hdac_sync_power_state(struct hdac_device *hdac, hda_nid_t nid, unsigned int target_state); /** * snd_hdac_read_parm - read a codec parameter * @codec: the codec object * @nid: NID to read a parameter * @parm: parameter to read * * Returns -1 for error. If you need to distinguish the error more * strictly, use _snd_hdac_read_parm() directly. */ static inline int snd_hdac_read_parm(struct hdac_device *codec, hda_nid_t nid, int parm) { … } #ifdef CONFIG_PM int snd_hdac_power_up(struct hdac_device *codec); int snd_hdac_power_down(struct hdac_device *codec); int snd_hdac_power_up_pm(struct hdac_device *codec); int snd_hdac_power_down_pm(struct hdac_device *codec); int snd_hdac_keep_power_up(struct hdac_device *codec); /* call this at entering into suspend/resume callbacks in codec driver */ static inline void snd_hdac_enter_pm(struct hdac_device *codec) { … } /* call this at leaving from suspend/resume callbacks in codec driver */ static inline void snd_hdac_leave_pm(struct hdac_device *codec) { … } static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { … } static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { … } #else static inline int snd_hdac_power_up(struct hdac_device *codec) { return 0; } static inline int snd_hdac_power_down(struct hdac_device *codec) { return 0; } static inline int snd_hdac_power_up_pm(struct hdac_device *codec) { return 0; } static inline int snd_hdac_power_down_pm(struct hdac_device *codec) { return 0; } static inline int snd_hdac_keep_power_up(struct hdac_device *codec) { return 0; } static inline void snd_hdac_enter_pm(struct hdac_device *codec) {} static inline void snd_hdac_leave_pm(struct hdac_device *codec) {} static inline bool snd_hdac_is_in_pm(struct hdac_device *codec) { return false; } static inline bool snd_hdac_is_power_on(struct hdac_device *codec) { return true; } #endif /* * HD-audio codec base driver */ struct hdac_driver { … }; #define drv_to_hdac_driver(_drv) … const struct hda_device_id * hdac_get_device_id(struct hdac_device *hdev, struct hdac_driver *drv); /* * Bus verb operators */ struct hdac_bus_ops { … }; /* * ops used for ASoC HDA codec drivers */ struct hdac_ext_bus_ops { … }; #define HDA_UNSOL_QUEUE_SIZE … #define HDA_MAX_CODECS … /* * CORB/RIRB * * Each CORB entry is 4byte, RIRB is 8byte */ struct hdac_rb { … }; /* * HD-audio bus base driver * * @ppcap: pp capabilities pointer * @spbcap: SPIB capabilities pointer * @mlcap: MultiLink capabilities pointer * @gtscap: gts capabilities pointer * @drsmcap: dma resume capabilities pointer * @num_streams: streams supported * @idx: HDA link index * @hlink_list: link list of HDA links * @lock: lock for link and display power mgmt * @cmd_dma_state: state of cmd DMAs: CORB and RIRB */ struct hdac_bus { … }; int snd_hdac_bus_init(struct hdac_bus *bus, struct device *dev, const struct hdac_bus_ops *ops); void snd_hdac_bus_exit(struct hdac_bus *bus); int snd_hdac_bus_exec_verb_unlocked(struct hdac_bus *bus, unsigned int addr, unsigned int cmd, unsigned int *res); void snd_hdac_codec_link_up(struct hdac_device *codec); void snd_hdac_codec_link_down(struct hdac_device *codec); int snd_hdac_bus_send_cmd(struct hdac_bus *bus, unsigned int val); int snd_hdac_bus_get_response(struct hdac_bus *bus, unsigned int addr, unsigned int *res); int snd_hdac_bus_parse_capabilities(struct hdac_bus *bus); bool snd_hdac_bus_init_chip(struct hdac_bus *bus, bool full_reset); void snd_hdac_bus_stop_chip(struct hdac_bus *bus); void snd_hdac_bus_init_cmd_io(struct hdac_bus *bus); void snd_hdac_bus_stop_cmd_io(struct hdac_bus *bus); void snd_hdac_bus_enter_link_reset(struct hdac_bus *bus); void snd_hdac_bus_exit_link_reset(struct hdac_bus *bus); int snd_hdac_bus_reset_link(struct hdac_bus *bus, bool full_reset); void snd_hdac_bus_link_power(struct hdac_device *hdev, bool enable); void snd_hdac_bus_update_rirb(struct hdac_bus *bus); int snd_hdac_bus_handle_stream_irq(struct hdac_bus *bus, unsigned int status, void (*ack)(struct hdac_bus *, struct hdac_stream *)); int snd_hdac_bus_alloc_stream_pages(struct hdac_bus *bus); void snd_hdac_bus_free_stream_pages(struct hdac_bus *bus); #ifdef CONFIG_SND_HDA_ALIGNED_MMIO unsigned int snd_hdac_aligned_read(void __iomem *addr, unsigned int mask); void snd_hdac_aligned_write(unsigned int val, void __iomem *addr, unsigned int mask); #define snd_hdac_aligned_mmio … #else #define snd_hdac_aligned_mmio(bus) … #define snd_hdac_aligned_read(addr, mask) … #define snd_hdac_aligned_write(val, addr, mask) … #endif static inline void snd_hdac_reg_writeb(struct hdac_bus *bus, void __iomem *addr, u8 val) { … } static inline void snd_hdac_reg_writew(struct hdac_bus *bus, void __iomem *addr, u16 val) { … } static inline u8 snd_hdac_reg_readb(struct hdac_bus *bus, void __iomem *addr) { … } static inline u16 snd_hdac_reg_readw(struct hdac_bus *bus, void __iomem *addr) { … } #define snd_hdac_reg_writel(bus, addr, val) … #define snd_hdac_reg_readl(bus, addr) … #define snd_hdac_reg_writeq(bus, addr, val) … #define snd_hdac_reg_readq(bus, addr) … /* * macros for easy use */ #define _snd_hdac_chip_writeb(chip, reg, value) … #define _snd_hdac_chip_readb(chip, reg) … #define _snd_hdac_chip_writew(chip, reg, value) … #define _snd_hdac_chip_readw(chip, reg) … #define _snd_hdac_chip_writel(chip, reg, value) … #define _snd_hdac_chip_readl(chip, reg) … /* read/write a register, pass without AZX_REG_ prefix */ #define snd_hdac_chip_writel(chip, reg, value) … #define snd_hdac_chip_writew(chip, reg, value) … #define snd_hdac_chip_writeb(chip, reg, value) … #define snd_hdac_chip_readl(chip, reg) … #define snd_hdac_chip_readw(chip, reg) … #define snd_hdac_chip_readb(chip, reg) … /* update a register, pass without AZX_REG_ prefix */ #define snd_hdac_chip_updatel(chip, reg, mask, val) … #define snd_hdac_chip_updatew(chip, reg, mask, val) … #define snd_hdac_chip_updateb(chip, reg, mask, val) … /* update register macro */ #define snd_hdac_updatel(addr, reg, mask, val) … #define snd_hdac_updatew(addr, reg, mask, val) … /* * HD-audio stream */ struct hdac_stream { … }; void snd_hdac_stream_init(struct hdac_bus *bus, struct hdac_stream *azx_dev, int idx, int direction, int tag); struct hdac_stream *snd_hdac_stream_assign(struct hdac_bus *bus, struct snd_pcm_substream *substream); void snd_hdac_stream_release_locked(struct hdac_stream *azx_dev); void snd_hdac_stream_release(struct hdac_stream *azx_dev); struct hdac_stream *snd_hdac_get_stream(struct hdac_bus *bus, int dir, int stream_tag); int snd_hdac_stream_setup(struct hdac_stream *azx_dev, bool code_loading); void snd_hdac_stream_cleanup(struct hdac_stream *azx_dev); int snd_hdac_stream_setup_periods(struct hdac_stream *azx_dev); int snd_hdac_stream_set_params(struct hdac_stream *azx_dev, unsigned int format_val); void snd_hdac_stream_start(struct hdac_stream *azx_dev); void snd_hdac_stream_stop(struct hdac_stream *azx_dev); void snd_hdac_stop_streams(struct hdac_bus *bus); void snd_hdac_stop_streams_and_chip(struct hdac_bus *bus); void snd_hdac_stream_reset(struct hdac_stream *azx_dev); void snd_hdac_stream_sync_trigger(struct hdac_stream *azx_dev, bool set, unsigned int streams, unsigned int reg); void snd_hdac_stream_sync(struct hdac_stream *azx_dev, bool start, unsigned int streams); void snd_hdac_stream_timecounter_init(struct hdac_stream *azx_dev, unsigned int streams, bool start); int snd_hdac_get_stream_stripe_ctl(struct hdac_bus *bus, struct snd_pcm_substream *substream); void snd_hdac_stream_spbcap_enable(struct hdac_bus *chip, bool enable, int index); int snd_hdac_stream_set_spib(struct hdac_bus *bus, struct hdac_stream *azx_dev, u32 value); int snd_hdac_stream_get_spbmaxfifo(struct hdac_bus *bus, struct hdac_stream *azx_dev); void snd_hdac_stream_drsm_enable(struct hdac_bus *bus, bool enable, int index); int snd_hdac_stream_wait_drsm(struct hdac_stream *azx_dev); int snd_hdac_stream_set_dpibr(struct hdac_bus *bus, struct hdac_stream *azx_dev, u32 value); int snd_hdac_stream_set_lpib(struct hdac_stream *azx_dev, u32 value); /* * macros for easy use */ /* read/write a register, pass without AZX_REG_ prefix */ #define snd_hdac_stream_writel(dev, reg, value) … #define snd_hdac_stream_writew(dev, reg, value) … #define snd_hdac_stream_writeb(dev, reg, value) … #define snd_hdac_stream_readl(dev, reg) … #define snd_hdac_stream_readw(dev, reg) … #define snd_hdac_stream_readb(dev, reg) … #define snd_hdac_stream_readb_poll(dev, reg, val, cond, delay_us, timeout_us) … #define snd_hdac_stream_readw_poll(dev, reg, val, cond, delay_us, timeout_us) … #define snd_hdac_stream_readl_poll(dev, reg, val, cond, delay_us, timeout_us) … /* update a register, pass without AZX_REG_ prefix */ #define snd_hdac_stream_updatel(dev, reg, mask, val) … #define snd_hdac_stream_updatew(dev, reg, mask, val) … #define snd_hdac_stream_updateb(dev, reg, mask, val) … #ifdef CONFIG_SND_HDA_DSP_LOADER /* DSP lock helpers */ #define snd_hdac_dsp_lock_init(dev) … #define snd_hdac_dsp_lock(dev) … #define snd_hdac_dsp_unlock(dev) … #define snd_hdac_stream_is_locked(dev) … /* DSP loader helpers */ int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format, unsigned int byte_size, struct snd_dma_buffer *bufp); void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start); void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev, struct snd_dma_buffer *dmab); #else /* CONFIG_SND_HDA_DSP_LOADER */ #define snd_hdac_dsp_lock_init … #define snd_hdac_dsp_lock … #define snd_hdac_dsp_unlock … #define snd_hdac_stream_is_locked … static inline int snd_hdac_dsp_prepare(struct hdac_stream *azx_dev, unsigned int format, unsigned int byte_size, struct snd_dma_buffer *bufp) { return 0; } static inline void snd_hdac_dsp_trigger(struct hdac_stream *azx_dev, bool start) { } static inline void snd_hdac_dsp_cleanup(struct hdac_stream *azx_dev, struct snd_dma_buffer *dmab) { } #endif /* CONFIG_SND_HDA_DSP_LOADER */ /* * generic array helpers */ void *snd_array_new(struct snd_array *array); void snd_array_free(struct snd_array *array); static inline void snd_array_init(struct snd_array *array, unsigned int size, unsigned int align) { … } static inline void *snd_array_elem(struct snd_array *array, unsigned int idx) { … } static inline unsigned int snd_array_index(struct snd_array *array, void *ptr) { … } /* a helper macro to iterate for each snd_array element */ #define snd_array_for_each(array, idx, ptr) … /* * Device matching */ #define HDA_CONTROLLER_IS_HSW(pci) … #define HDA_CONTROLLER_IS_APL(pci) … #define HDA_CONTROLLER_IN_GPU(pci) … #endif /* __SOUND_HDAUDIO_H */
Codebase Browser
linux