2019-05-21 01:08:11 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
2011-10-28 04:12:46 +08:00
|
|
|
/*
|
|
|
|
* Jack-detection handling for HD-audio
|
|
|
|
*
|
|
|
|
* Copyright (c) 2011 Takashi Iwai <tiwai@suse.de>
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __SOUND_HDA_JACK_H
|
|
|
|
#define __SOUND_HDA_JACK_H
|
|
|
|
|
2014-09-23 15:04:49 +08:00
|
|
|
#include <linux/err.h>
|
2018-11-28 21:25:37 +08:00
|
|
|
#include <sound/jack.h>
|
2014-09-23 15:04:49 +08:00
|
|
|
|
2012-05-07 23:42:31 +08:00
|
|
|
struct auto_pin_cfg;
|
2012-09-25 17:30:59 +08:00
|
|
|
struct hda_jack_tbl;
|
2014-09-11 21:22:46 +08:00
|
|
|
struct hda_jack_callback;
|
2012-09-25 17:30:59 +08:00
|
|
|
|
2014-09-11 21:22:46 +08:00
|
|
|
typedef void (*hda_jack_callback_fn) (struct hda_codec *, struct hda_jack_callback *);
|
|
|
|
|
|
|
|
struct hda_jack_callback {
|
2016-02-09 17:23:52 +08:00
|
|
|
hda_nid_t nid;
|
2019-11-19 16:47:08 +08:00
|
|
|
int dev_id;
|
2014-09-11 21:22:46 +08:00
|
|
|
hda_jack_callback_fn func;
|
|
|
|
unsigned int private_data; /* arbitrary data */
|
2018-11-28 21:17:58 +08:00
|
|
|
unsigned int unsol_res; /* unsolicited event bits */
|
|
|
|
struct hda_jack_tbl *jack; /* associated jack entry */
|
2014-09-11 21:22:46 +08:00
|
|
|
struct hda_jack_callback *next;
|
|
|
|
};
|
2012-05-07 23:42:31 +08:00
|
|
|
|
2011-10-28 04:12:46 +08:00
|
|
|
struct hda_jack_tbl {
|
|
|
|
hda_nid_t nid;
|
2019-11-19 16:47:08 +08:00
|
|
|
int dev_id;
|
2011-10-28 07:16:55 +08:00
|
|
|
unsigned char tag; /* unsol event tag */
|
2014-09-11 21:22:46 +08:00
|
|
|
struct hda_jack_callback *callback;
|
2011-10-28 07:16:55 +08:00
|
|
|
/* jack-detection stuff */
|
2011-10-28 04:12:46 +08:00
|
|
|
unsigned int pin_sense; /* cached pin-sense value */
|
2011-10-28 07:16:55 +08:00
|
|
|
unsigned int jack_detect:1; /* capable of jack-detection? */
|
2011-10-28 04:12:46 +08:00
|
|
|
unsigned int jack_dirty:1; /* needs to update? */
|
2012-06-04 15:33:51 +08:00
|
|
|
unsigned int phantom_jack:1; /* a fixed, always present port? */
|
2013-11-07 20:38:24 +08:00
|
|
|
unsigned int block_report:1; /* in a transitional state - do not report to userspace */
|
2012-11-20 02:48:07 +08:00
|
|
|
hda_nid_t gating_jack; /* valid when gating jack plugged */
|
|
|
|
hda_nid_t gated_jack; /* gated is dependent on this jack */
|
2011-11-02 15:54:51 +08:00
|
|
|
int type;
|
2018-11-28 21:25:37 +08:00
|
|
|
int button_state;
|
2011-11-02 15:54:51 +08:00
|
|
|
struct snd_jack *jack;
|
2011-10-28 04:12:46 +08:00
|
|
|
};
|
|
|
|
|
2018-11-28 21:25:37 +08:00
|
|
|
struct hda_jack_keymap {
|
|
|
|
enum snd_jack_types type;
|
|
|
|
int key;
|
|
|
|
};
|
|
|
|
|
2011-10-28 04:12:46 +08:00
|
|
|
struct hda_jack_tbl *
|
2019-11-19 16:47:08 +08:00
|
|
|
snd_hda_jack_tbl_get_mst(struct hda_codec *codec, hda_nid_t nid, int dev_id);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_hda_jack_tbl_get - query the jack-table entry for the given NID
|
|
|
|
* @codec: the HDA codec
|
|
|
|
* @nid: pin NID to refer to
|
|
|
|
*/
|
|
|
|
static inline struct hda_jack_tbl *
|
|
|
|
snd_hda_jack_tbl_get(struct hda_codec *codec, hda_nid_t nid)
|
|
|
|
{
|
|
|
|
return snd_hda_jack_tbl_get_mst(codec, nid, 0);
|
|
|
|
}
|
|
|
|
|
2011-10-28 07:16:55 +08:00
|
|
|
struct hda_jack_tbl *
|
2019-11-19 16:47:08 +08:00
|
|
|
snd_hda_jack_tbl_get_from_tag(struct hda_codec *codec,
|
|
|
|
unsigned char tag, int dev_id);
|
2011-10-28 04:12:46 +08:00
|
|
|
|
|
|
|
void snd_hda_jack_tbl_clear(struct hda_codec *codec);
|
|
|
|
|
|
|
|
void snd_hda_jack_set_dirty_all(struct hda_codec *codec);
|
|
|
|
|
2019-11-19 16:47:08 +08:00
|
|
|
int snd_hda_jack_detect_enable(struct hda_codec *codec, hda_nid_t nid,
|
|
|
|
int dev_id);
|
|
|
|
|
2014-09-11 21:22:46 +08:00
|
|
|
struct hda_jack_callback *
|
2019-11-19 16:47:08 +08:00
|
|
|
snd_hda_jack_detect_enable_callback_mst(struct hda_codec *codec, hda_nid_t nid,
|
|
|
|
int dev_id, hda_jack_callback_fn cb);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_hda_jack_detect_enable - enable the jack-detection
|
|
|
|
* @codec: the HDA codec
|
|
|
|
* @nid: pin NID to enable
|
|
|
|
* @func: callback function to register
|
|
|
|
*
|
|
|
|
* In the case of error, the return value will be a pointer embedded with
|
|
|
|
* errno. Check and handle the return value appropriately with standard
|
|
|
|
* macros such as @IS_ERR() and @PTR_ERR().
|
|
|
|
*/
|
|
|
|
static inline struct hda_jack_callback *
|
2014-09-11 20:39:09 +08:00
|
|
|
snd_hda_jack_detect_enable_callback(struct hda_codec *codec, hda_nid_t nid,
|
2019-11-19 16:47:08 +08:00
|
|
|
hda_jack_callback_fn cb)
|
|
|
|
{
|
|
|
|
return snd_hda_jack_detect_enable_callback_mst(codec, nid, 0, cb);
|
|
|
|
}
|
2012-09-25 17:30:59 +08:00
|
|
|
|
2012-11-20 02:48:07 +08:00
|
|
|
int snd_hda_jack_set_gating_jack(struct hda_codec *codec, hda_nid_t gated_nid,
|
|
|
|
hda_nid_t gating_nid);
|
2011-10-28 04:12:46 +08:00
|
|
|
|
2019-11-19 16:47:08 +08:00
|
|
|
u32 snd_hda_jack_pin_sense(struct hda_codec *codec, hda_nid_t nid, int dev_id);
|
ALSA: hda - Add snd_hda_jack_detect_state() helper function
snd_hda_jack_detect() function returns a boolean value for a jack
plugged in or not, but it also returns always true when the
corresponding pin is phantom (i.e. fixed). This is OK in most cases,
but it makes the generic parser misbehaving about the auto-mute or
auto-mic switching, e.g. when one of headphone pins is a fixed.
Namely, the driver decides whether to mute the speaker or not, just
depending on the headphone plug state: if one of the headphone jacks
is seen as active, then the speaker is muted. Thus this will result
always in the muted speaker output.
So, the problem is the function returns a boolean, after all, although
we need to think of "phantom" jack. Now a new function,
snd_hda_jack_detect_state() is introduced to return these tristates.
The generic parser uses this function for checking the headphone or
mic jack states.
Meanwhile, the behavior of snd_hda_jack_detect() is kept as is, for
keeping compatibility in other driver codes.
Acked-by: David Henningsson <david.henningsson@canonical.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-07-19 22:59:46 +08:00
|
|
|
|
|
|
|
/* the jack state returned from snd_hda_jack_detect_state() */
|
|
|
|
enum {
|
|
|
|
HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT, HDA_JACK_PHANTOM,
|
|
|
|
};
|
|
|
|
|
2019-11-19 16:47:08 +08:00
|
|
|
int snd_hda_jack_detect_state_mst(struct hda_codec *codec, hda_nid_t nid,
|
|
|
|
int dev_id);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_hda_jack_detect_state - query pin Presence Detect status
|
|
|
|
* @codec: the CODEC to sense
|
|
|
|
* @nid: the pin NID to sense
|
|
|
|
*
|
|
|
|
* Query and return the pin's Presence Detect status, as either
|
|
|
|
* HDA_JACK_NOT_PRESENT, HDA_JACK_PRESENT or HDA_JACK_PHANTOM.
|
|
|
|
*/
|
|
|
|
static inline int
|
|
|
|
snd_hda_jack_detect_state(struct hda_codec *codec, hda_nid_t nid)
|
|
|
|
{
|
|
|
|
return snd_hda_jack_detect_state_mst(codec, nid, 0);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_hda_jack_detect_mst - Detect the jack
|
|
|
|
* @codec: the HDA codec
|
|
|
|
* @nid: pin NID to check jack detection
|
|
|
|
* @dev_id: pin device entry id
|
|
|
|
*/
|
|
|
|
static inline bool
|
|
|
|
snd_hda_jack_detect_mst(struct hda_codec *codec, hda_nid_t nid, int dev_id)
|
|
|
|
{
|
|
|
|
return snd_hda_jack_detect_state_mst(codec, nid, dev_id) !=
|
|
|
|
HDA_JACK_NOT_PRESENT;
|
|
|
|
}
|
ALSA: hda - Add snd_hda_jack_detect_state() helper function
snd_hda_jack_detect() function returns a boolean value for a jack
plugged in or not, but it also returns always true when the
corresponding pin is phantom (i.e. fixed). This is OK in most cases,
but it makes the generic parser misbehaving about the auto-mute or
auto-mic switching, e.g. when one of headphone pins is a fixed.
Namely, the driver decides whether to mute the speaker or not, just
depending on the headphone plug state: if one of the headphone jacks
is seen as active, then the speaker is muted. Thus this will result
always in the muted speaker output.
So, the problem is the function returns a boolean, after all, although
we need to think of "phantom" jack. Now a new function,
snd_hda_jack_detect_state() is introduced to return these tristates.
The generic parser uses this function for checking the headphone or
mic jack states.
Meanwhile, the behavior of snd_hda_jack_detect() is kept as is, for
keeping compatibility in other driver codes.
Acked-by: David Henningsson <david.henningsson@canonical.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-07-19 22:59:46 +08:00
|
|
|
|
2014-10-29 23:03:58 +08:00
|
|
|
/**
|
|
|
|
* snd_hda_jack_detect - Detect the jack
|
|
|
|
* @codec: the HDA codec
|
|
|
|
* @nid: pin NID to check jack detection
|
|
|
|
*/
|
2019-11-19 16:47:08 +08:00
|
|
|
static inline bool
|
|
|
|
snd_hda_jack_detect(struct hda_codec *codec, hda_nid_t nid)
|
ALSA: hda - Add snd_hda_jack_detect_state() helper function
snd_hda_jack_detect() function returns a boolean value for a jack
plugged in or not, but it also returns always true when the
corresponding pin is phantom (i.e. fixed). This is OK in most cases,
but it makes the generic parser misbehaving about the auto-mute or
auto-mic switching, e.g. when one of headphone pins is a fixed.
Namely, the driver decides whether to mute the speaker or not, just
depending on the headphone plug state: if one of the headphone jacks
is seen as active, then the speaker is muted. Thus this will result
always in the muted speaker output.
So, the problem is the function returns a boolean, after all, although
we need to think of "phantom" jack. Now a new function,
snd_hda_jack_detect_state() is introduced to return these tristates.
The generic parser uses this function for checking the headphone or
mic jack states.
Meanwhile, the behavior of snd_hda_jack_detect() is kept as is, for
keeping compatibility in other driver codes.
Acked-by: David Henningsson <david.henningsson@canonical.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-07-19 22:59:46 +08:00
|
|
|
{
|
2019-11-19 16:47:08 +08:00
|
|
|
return snd_hda_jack_detect_mst(codec, nid, 0);
|
ALSA: hda - Add snd_hda_jack_detect_state() helper function
snd_hda_jack_detect() function returns a boolean value for a jack
plugged in or not, but it also returns always true when the
corresponding pin is phantom (i.e. fixed). This is OK in most cases,
but it makes the generic parser misbehaving about the auto-mute or
auto-mic switching, e.g. when one of headphone pins is a fixed.
Namely, the driver decides whether to mute the speaker or not, just
depending on the headphone plug state: if one of the headphone jacks
is seen as active, then the speaker is muted. Thus this will result
always in the muted speaker output.
So, the problem is the function returns a boolean, after all, although
we need to think of "phantom" jack. Now a new function,
snd_hda_jack_detect_state() is introduced to return these tristates.
The generic parser uses this function for checking the headphone or
mic jack states.
Meanwhile, the behavior of snd_hda_jack_detect() is kept as is, for
keeping compatibility in other driver codes.
Acked-by: David Henningsson <david.henningsson@canonical.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2013-07-19 22:59:46 +08:00
|
|
|
}
|
2011-10-28 04:12:46 +08:00
|
|
|
|
2012-02-13 18:41:42 +08:00
|
|
|
bool is_jack_detectable(struct hda_codec *codec, hda_nid_t nid);
|
2011-10-28 04:12:46 +08:00
|
|
|
|
2019-11-19 16:47:08 +08:00
|
|
|
int snd_hda_jack_add_kctl_mst(struct hda_codec *codec, hda_nid_t nid,
|
|
|
|
int dev_id, const char *name, bool phantom_jack,
|
|
|
|
int type, const struct hda_jack_keymap *keymap);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* snd_hda_jack_add_kctl - Add a kctl for the given pin
|
|
|
|
* @codec: the HDA codec
|
|
|
|
* @nid: pin NID to assign
|
|
|
|
* @name: string name for the jack
|
|
|
|
* @phantom_jack: flag to deal as a phantom jack
|
|
|
|
* @type: jack type bits to be reported, 0 for guessing from pincfg
|
|
|
|
* @keymap: optional jack / key mapping
|
|
|
|
*
|
|
|
|
* This assigns a jack-detection kctl to the given pin. The kcontrol
|
|
|
|
* will have the given name and index.
|
|
|
|
*/
|
|
|
|
static inline int
|
|
|
|
snd_hda_jack_add_kctl(struct hda_codec *codec, hda_nid_t nid,
|
|
|
|
const char *name, bool phantom_jack,
|
|
|
|
int type, const struct hda_jack_keymap *keymap)
|
|
|
|
{
|
|
|
|
return snd_hda_jack_add_kctl_mst(codec, nid, 0,
|
|
|
|
name, phantom_jack, type, keymap);
|
|
|
|
}
|
|
|
|
|
2011-10-28 06:03:22 +08:00
|
|
|
int snd_hda_jack_add_kctls(struct hda_codec *codec,
|
|
|
|
const struct auto_pin_cfg *cfg);
|
|
|
|
|
|
|
|
void snd_hda_jack_report_sync(struct hda_codec *codec);
|
|
|
|
|
2012-09-25 17:30:59 +08:00
|
|
|
void snd_hda_jack_unsol_event(struct hda_codec *codec, unsigned int res);
|
2011-10-28 06:03:22 +08:00
|
|
|
|
2012-10-09 21:04:21 +08:00
|
|
|
void snd_hda_jack_poll_all(struct hda_codec *codec);
|
|
|
|
|
2011-10-28 04:12:46 +08:00
|
|
|
#endif /* __SOUND_HDA_JACK_H */
|