/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * Universal Interface for Intel High Definition Audio Codec * * Local helper functions * * Copyright (c) 2004 Takashi Iwai <[email protected]> */ #ifndef __SOUND_HDA_LOCAL_H #define __SOUND_HDA_LOCAL_H /* We abuse kcontrol_new.subdev field to pass the NID corresponding to * the given new control. If id.subdev has a bit flag HDA_SUBDEV_NID_FLAG, * snd_hda_ctl_add() takes the lower-bit subdev value as a valid NID. * * Note that the subdevice field is cleared again before the real registration * in snd_hda_ctl_add(), so that this value won't appear in the outside. */ #define HDA_SUBDEV_NID_FLAG … #define HDA_SUBDEV_AMP_FLAG … /* * for mixer controls */ #define HDA_COMPOSE_AMP_VAL_OFS(nid,chs,idx,dir,ofs) … #define HDA_AMP_VAL_MIN_MUTE … #define HDA_COMPOSE_AMP_VAL(nid,chs,idx,dir) … /* mono volume with index (index=0,1,...) (channel=1,2) */ #define HDA_CODEC_VOLUME_MONO_IDX(xname, xcidx, nid, channel, xindex, dir, flags) … /* stereo volume with index */ #define HDA_CODEC_VOLUME_IDX(xname, xcidx, nid, xindex, direction) … /* mono volume */ #define HDA_CODEC_VOLUME_MONO(xname, nid, channel, xindex, direction) … /* stereo volume */ #define HDA_CODEC_VOLUME(xname, nid, xindex, direction) … /* stereo volume with min=mute */ #define HDA_CODEC_VOLUME_MIN_MUTE(xname, nid, xindex, direction) … /* mono mute switch with index (index=0,1,...) (channel=1,2) */ #define HDA_CODEC_MUTE_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) … /* stereo mute switch with index */ #define HDA_CODEC_MUTE_IDX(xname, xcidx, nid, xindex, direction) … /* mono mute switch */ #define HDA_CODEC_MUTE_MONO(xname, nid, channel, xindex, direction) … /* stereo mute switch */ #define HDA_CODEC_MUTE(xname, nid, xindex, direction) … #ifdef CONFIG_SND_HDA_INPUT_BEEP /* special beep mono mute switch with index (index=0,1,...) (channel=1,2) */ #define HDA_CODEC_MUTE_BEEP_MONO_IDX(xname, xcidx, nid, channel, xindex, direction) … #else /* no digital beep - just the standard one */ #define HDA_CODEC_MUTE_BEEP_MONO_IDX … #endif /* CONFIG_SND_HDA_INPUT_BEEP */ /* special beep mono mute switch */ #define HDA_CODEC_MUTE_BEEP_MONO(xname, nid, channel, xindex, direction) … /* special beep stereo mute switch */ #define HDA_CODEC_MUTE_BEEP(xname, nid, xindex, direction) … extern const char *snd_hda_pcm_type_name[]; int snd_hda_mixer_amp_volume_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo); int snd_hda_mixer_amp_volume_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); int snd_hda_mixer_amp_volume_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); int snd_hda_mixer_amp_tlv(struct snd_kcontrol *kcontrol, int op_flag, unsigned int size, unsigned int __user *_tlv); int snd_hda_mixer_amp_switch_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo); int snd_hda_mixer_amp_switch_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); int snd_hda_mixer_amp_switch_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); #ifdef CONFIG_SND_HDA_INPUT_BEEP int snd_hda_mixer_amp_switch_get_beep(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); int snd_hda_mixer_amp_switch_put_beep(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol); #endif /* lowlevel accessor with caching; use carefully */ #define snd_hda_codec_amp_read(codec, nid, ch, dir, idx) … int snd_hda_codec_amp_update(struct hda_codec *codec, hda_nid_t nid, int ch, int dir, int idx, int mask, int val); int snd_hda_codec_amp_stereo(struct hda_codec *codec, hda_nid_t nid, int direction, int idx, int mask, int val); int snd_hda_codec_amp_init(struct hda_codec *codec, hda_nid_t nid, int ch, int direction, int idx, int mask, int val); int snd_hda_codec_amp_init_stereo(struct hda_codec *codec, hda_nid_t nid, int dir, int idx, int mask, int val); void snd_hda_set_vmaster_tlv(struct hda_codec *codec, hda_nid_t nid, int dir, unsigned int *tlv); struct snd_kcontrol *snd_hda_find_mixer_ctl(struct hda_codec *codec, const char *name); int __snd_hda_add_vmaster(struct hda_codec *codec, char *name, unsigned int *tlv, const char * const *followers, const char *suffix, bool init_follower_vol, unsigned int access, struct snd_kcontrol **ctl_ret); #define snd_hda_add_vmaster(codec, name, tlv, followers, suffix, access) … int snd_hda_codec_reset(struct hda_codec *codec); void snd_hda_codec_disconnect_pcms(struct hda_codec *codec); #define snd_hda_regmap_sync(codec) … struct hda_vmaster_mute_hook { … }; int snd_hda_add_vmaster_hook(struct hda_codec *codec, struct hda_vmaster_mute_hook *hook); void snd_hda_sync_vmaster_hook(struct hda_vmaster_mute_hook *hook); /* amp value bits */ #define HDA_AMP_MUTE … #define HDA_AMP_UNMUTE … #define HDA_AMP_VOLMASK … /* * SPDIF I/O */ int snd_hda_create_dig_out_ctls(struct hda_codec *codec, hda_nid_t associated_nid, hda_nid_t cvt_nid, int type); #define snd_hda_create_spdif_out_ctls(codec, anid, cnid) … int snd_hda_create_spdif_in_ctls(struct hda_codec *codec, hda_nid_t nid); /* * input MUX helper */ #define HDA_MAX_NUM_INPUTS … struct hda_input_mux_item { … }; struct hda_input_mux { … }; int snd_hda_input_mux_info(const struct hda_input_mux *imux, struct snd_ctl_elem_info *uinfo); int snd_hda_input_mux_put(struct hda_codec *codec, const struct hda_input_mux *imux, struct snd_ctl_elem_value *ucontrol, hda_nid_t nid, unsigned int *cur_val); int snd_hda_add_imux_item(struct hda_codec *codec, struct hda_input_mux *imux, const char *label, int index, int *type_idx); /* * Multi-channel / digital-out PCM helper */ enum { … }; /* index for dac_nidx */ enum { … }; /* dig_out_used */ #define HDA_MAX_OUTS … struct hda_multi_out { … }; int snd_hda_create_spdif_share_sw(struct hda_codec *codec, struct hda_multi_out *mout); int snd_hda_multi_out_dig_open(struct hda_codec *codec, struct hda_multi_out *mout); int snd_hda_multi_out_dig_close(struct hda_codec *codec, struct hda_multi_out *mout); int snd_hda_multi_out_dig_prepare(struct hda_codec *codec, struct hda_multi_out *mout, unsigned int stream_tag, unsigned int format, struct snd_pcm_substream *substream); int snd_hda_multi_out_dig_cleanup(struct hda_codec *codec, struct hda_multi_out *mout); int snd_hda_multi_out_analog_open(struct hda_codec *codec, struct hda_multi_out *mout, struct snd_pcm_substream *substream, struct hda_pcm_stream *hinfo); int snd_hda_multi_out_analog_prepare(struct hda_codec *codec, struct hda_multi_out *mout, unsigned int stream_tag, unsigned int format, struct snd_pcm_substream *substream); int snd_hda_multi_out_analog_cleanup(struct hda_codec *codec, struct hda_multi_out *mout); /* * generic proc interface */ #ifdef CONFIG_SND_PROC_FS int snd_hda_codec_proc_new(struct hda_codec *codec); #else static inline int snd_hda_codec_proc_new(struct hda_codec *codec) { return 0; } #endif #define SND_PRINT_BITS_ADVISED_BUFSIZE … void snd_print_pcm_bits(int pcm, char *buf, int buflen); /* * Misc */ int snd_hda_add_new_ctls(struct hda_codec *codec, const struct snd_kcontrol_new *knew); /* * Fix-up pin default configurations and add default verbs */ struct hda_pintbl { … }; struct hda_model_fixup { … }; struct hda_fixup { … }; struct snd_hda_pin_quirk { … }; #ifdef CONFIG_SND_DEBUG_VERBOSE #define SND_HDA_PIN_QUIRK(_codec, _subvendor, _name, _value, _pins...) … #else #define SND_HDA_PIN_QUIRK … #endif #define HDA_FIXUP_ID_NOT_SET … #define HDA_FIXUP_ID_NO_FIXUP … /* fixup types */ enum { … }; /* fixup action definitions */ enum { … }; int snd_hda_add_verbs(struct hda_codec *codec, const struct hda_verb *list); void snd_hda_apply_verbs(struct hda_codec *codec); void snd_hda_apply_pincfgs(struct hda_codec *codec, const struct hda_pintbl *cfg); void snd_hda_apply_fixup(struct hda_codec *codec, int action); void __snd_hda_apply_fixup(struct hda_codec *codec, int id, int action, int depth); void snd_hda_pick_fixup(struct hda_codec *codec, const struct hda_model_fixup *models, const struct snd_pci_quirk *quirk, const struct hda_fixup *fixlist); void snd_hda_pick_pin_fixup(struct hda_codec *codec, const struct snd_hda_pin_quirk *pin_quirk, const struct hda_fixup *fixlist, bool match_all_pins); /* helper macros to retrieve pin default-config values */ #define get_defcfg_connect(cfg) … #define get_defcfg_association(cfg) … #define get_defcfg_location(cfg) … #define get_defcfg_sequence(cfg) … #define get_defcfg_device(cfg) … #define get_defcfg_misc(cfg) … /* amp values */ #define AMP_IN_MUTE(idx) … #define AMP_IN_UNMUTE(idx) … #define AMP_OUT_MUTE … #define AMP_OUT_UNMUTE … #define AMP_OUT_ZERO … /* pinctl values */ #define PIN_IN … #define PIN_VREFHIZ … #define PIN_VREF50 … #define PIN_VREFGRD … #define PIN_VREF80 … #define PIN_VREF100 … #define PIN_OUT … #define PIN_HP … #define PIN_HP_AMP … unsigned int snd_hda_get_default_vref(struct hda_codec *codec, hda_nid_t pin); unsigned int snd_hda_correct_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val); int _snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val, bool cached); /** * _snd_hda_set_pin_ctl - Set a pin-control value safely * @codec: the codec instance * @pin: the pin NID to set the control * @val: the pin-control value (AC_PINCTL_* bits) * * This function sets the pin-control value to the given pin, but * filters out the invalid pin-control bits when the pin has no such * capabilities. For example, when PIN_HP is passed but the pin has no * HP-drive capability, the HP bit is omitted. * * The function doesn't check the input VREF capability bits, though. * Use snd_hda_get_default_vref() to guess the right value. * Also, this function is only for analog pins, not for HDMI pins. */ static inline int snd_hda_set_pin_ctl(struct hda_codec *codec, hda_nid_t pin, unsigned int val) { … } /** * snd_hda_set_pin_ctl_cache - Set a pin-control value safely * @codec: the codec instance * @pin: the pin NID to set the control * @val: the pin-control value (AC_PINCTL_* bits) * * Just like snd_hda_set_pin_ctl() but write to cache as well. */ static inline int snd_hda_set_pin_ctl_cache(struct hda_codec *codec, hda_nid_t pin, unsigned int val) { … } int snd_hda_codec_get_pin_target(struct hda_codec *codec, hda_nid_t nid); int snd_hda_codec_set_pin_target(struct hda_codec *codec, hda_nid_t nid, unsigned int val); #define for_each_hda_codec_node(nid, codec) … /* Set the codec power_state flag to indicate to allow unsol event handling; * see hda_codec_unsol_event() in hda_bind.c. Calling this might confuse the * state tracking, so use with care. */ static inline void snd_hda_codec_allow_unsol_events(struct hda_codec *codec) { … } /* * get widget capabilities */ static inline u32 get_wcaps(struct hda_codec *codec, hda_nid_t nid) { … } /* get the widget type from widget capability bits */ static inline int get_wcaps_type(unsigned int wcaps) { … } static inline unsigned int get_wcaps_channels(u32 wcaps) { … } static inline void snd_hda_override_wcaps(struct hda_codec *codec, hda_nid_t nid, u32 val) { … } u32 query_amp_caps(struct hda_codec *codec, hda_nid_t nid, int direction); int snd_hda_override_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir, unsigned int caps); /** * snd_hda_query_pin_caps - Query PIN capabilities * @codec: the HD-auio codec * @nid: the NID to query * * Query PIN capabilities for the given widget. * Returns the obtained capability bits. * * When cap bits have been already read, this doesn't read again but * returns the cached value. */ static inline u32 snd_hda_query_pin_caps(struct hda_codec *codec, hda_nid_t nid) { … } /** * snd_hda_override_pin_caps - Override the pin capabilities * @codec: the CODEC * @nid: the NID to override * @caps: the capability bits to set * * Override the cached PIN capabilitiy bits value by the given one. * * Returns zero if successful or a negative error code. */ static inline int snd_hda_override_pin_caps(struct hda_codec *codec, hda_nid_t nid, unsigned int caps) { … } bool snd_hda_check_amp_caps(struct hda_codec *codec, hda_nid_t nid, int dir, unsigned int bits); #define nid_has_mute(codec, nid, dir) … #define nid_has_volume(codec, nid, dir) … /* flags for hda_nid_item */ #define HDA_NID_ITEM_AMP … struct hda_nid_item { … }; int snd_hda_ctl_add(struct hda_codec *codec, hda_nid_t nid, struct snd_kcontrol *kctl); int snd_hda_add_nid(struct hda_codec *codec, struct snd_kcontrol *kctl, unsigned int index, hda_nid_t nid); void snd_hda_ctls_clear(struct hda_codec *codec); /* * hwdep interface */ #ifdef CONFIG_SND_HDA_HWDEP int snd_hda_create_hwdep(struct hda_codec *codec); #else static inline int snd_hda_create_hwdep(struct hda_codec *codec) { return 0; } #endif void snd_hda_sysfs_init(struct hda_codec *codec); void snd_hda_sysfs_clear(struct hda_codec *codec); extern const struct attribute_group *snd_hda_dev_attr_groups[]; #ifdef CONFIG_SND_HDA_RECONFIG const char *snd_hda_get_hint(struct hda_codec *codec, const char *key); int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key); int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp); #else static inline const char *snd_hda_get_hint(struct hda_codec *codec, const char *key) { return NULL; } static inline int snd_hda_get_bool_hint(struct hda_codec *codec, const char *key) { return -ENOENT; } static inline int snd_hda_get_int_hint(struct hda_codec *codec, const char *key, int *valp) { return -ENOENT; } #endif /* * power-management */ void snd_hda_schedule_power_save(struct hda_codec *codec); struct hda_amp_list { … }; struct hda_loopback_check { … }; int snd_hda_check_amp_list_power(struct hda_codec *codec, struct hda_loopback_check *check, hda_nid_t nid); /* check whether the actual power state matches with the target state */ static inline bool snd_hda_check_power_state(struct hda_codec *codec, hda_nid_t nid, unsigned int target_state) { … } static inline unsigned int snd_hda_sync_power_state(struct hda_codec *codec, hda_nid_t nid, unsigned int target_state) { … } unsigned int snd_hda_codec_eapd_power_filter(struct hda_codec *codec, hda_nid_t nid, unsigned int power_state); void snd_hda_codec_shutdown(struct hda_codec *codec); /* * AMP control callbacks */ /* retrieve parameters from private_value */ #define get_amp_nid_(pv) … #define get_amp_nid(kc) … #define get_amp_channels(kc) … #define get_amp_direction_(pv) … #define get_amp_direction(kc) … #define get_amp_index_(pv) … #define get_amp_index(kc) … #define get_amp_offset(kc) … #define get_amp_min_mute(kc) … /* * enum control helper */ int snd_hda_enum_helper_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo, int num_items, const char * const *texts); #define snd_hda_enum_bool_helper_info(kcontrol, uinfo) … /* * CEA Short Audio Descriptor data */ struct cea_sad { … }; #define ELD_FIXED_BYTES … #define ELD_MAX_SIZE … #define ELD_MAX_MNL … #define ELD_MAX_SAD … /* * ELD: EDID Like Data */ struct parsed_hdmi_eld { … }; struct hdmi_eld { … }; int snd_hdmi_get_eld_size(struct hda_codec *codec, hda_nid_t nid); int snd_hdmi_get_eld(struct hda_codec *codec, hda_nid_t nid, unsigned char *buf, int *eld_size); int snd_hdmi_parse_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e, const unsigned char *buf, int size); void snd_hdmi_show_eld(struct hda_codec *codec, struct parsed_hdmi_eld *e); void snd_hdmi_eld_update_pcm_info(struct parsed_hdmi_eld *e, struct hda_pcm_stream *hinfo); int snd_hdmi_get_eld_ati(struct hda_codec *codec, hda_nid_t nid, unsigned char *buf, int *eld_size, bool rev3_or_later); #ifdef CONFIG_SND_PROC_FS void snd_hdmi_print_eld_info(struct hdmi_eld *eld, struct snd_info_buffer *buffer, hda_nid_t pin_nid, int dev_id, hda_nid_t cvt_nid); void snd_hdmi_write_eld_info(struct hdmi_eld *eld, struct snd_info_buffer *buffer); #endif #define SND_PRINT_CHANNEL_ALLOCATION_ADVISED_BUFSIZE … void snd_print_channel_allocation(int spk_alloc, char *buf, int buflen); void snd_hda_codec_display_power(struct hda_codec *codec, bool enable); /* */ #define codec_err(codec, fmt, args...) … #define codec_warn(codec, fmt, args...) … #define codec_info(codec, fmt, args...) … #define codec_dbg(codec, fmt, args...) … #endif /* __SOUND_HDA_LOCAL_H */
Codebase Browser
linux