[mirror_ubuntu-jammy-kernel.git] / include / sound / jack.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
#ifndef __SOUND_JACK_H
#define __SOUND_JACK_H

/*
 *  Jack abstraction layer
 *
 *  Copyright 2008 Wolfson Microelectronics plc
 */

#include <sound/core.h>

struct input_dev;

/**
 * enum snd_jack_types - Jack types which can be reported
 * @SND_JACK_HEADPHONE: Headphone
 * @SND_JACK_MICROPHONE: Microphone
 * @SND_JACK_HEADSET: Headset
 * @SND_JACK_LINEOUT: Line out
 * @SND_JACK_MECHANICAL: Mechanical switch
 * @SND_JACK_VIDEOOUT: Video out
 * @SND_JACK_AVOUT: AV (Audio Video) out
 * @SND_JACK_LINEIN:  Line in
 * @SND_JACK_BTN_0: Button 0
 * @SND_JACK_BTN_1: Button 1
 * @SND_JACK_BTN_2: Button 2
 * @SND_JACK_BTN_3: Button 3
 * @SND_JACK_BTN_4: Button 4
 * @SND_JACK_BTN_5: Button 5
 *
 * These values are used as a bitmask.
 *
 * Note that this must be kept in sync with the lookup table in
 * sound/core/jack.c.
 */
enum snd_jack_types {
	SND_JACK_HEADPHONE	= 0x0001,
	SND_JACK_MICROPHONE	= 0x0002,
	SND_JACK_HEADSET	= SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
	SND_JACK_LINEOUT	= 0x0004,
	SND_JACK_MECHANICAL	= 0x0008, /* If detected separately */
	SND_JACK_VIDEOOUT	= 0x0010,
	SND_JACK_AVOUT		= SND_JACK_LINEOUT | SND_JACK_VIDEOOUT,
	SND_JACK_LINEIN		= 0x0020,

	/* Kept separate from switches to facilitate implementation */
	SND_JACK_BTN_0		= 0x4000,
	SND_JACK_BTN_1		= 0x2000,
	SND_JACK_BTN_2		= 0x1000,
	SND_JACK_BTN_3		= 0x0800,
	SND_JACK_BTN_4		= 0x0400,
	SND_JACK_BTN_5		= 0x0200,
};

/* Keep in sync with definitions above */
#define SND_JACK_SWITCH_TYPES 6

struct snd_jack {
	struct list_head kctl_list;
	struct snd_card *card;
	const char *id;
#ifdef CONFIG_SND_JACK_INPUT_DEV
	struct input_dev *input_dev;
	int registered;
	int type;
	char name[100];
	unsigned int key[6];   /* Keep in sync with definitions above */
#endif /* CONFIG_SND_JACK_INPUT_DEV */
	int hw_status_cache;
	void *private_data;
	void (*private_free)(struct snd_jack *);
};

#ifdef CONFIG_SND_JACK

int snd_jack_new(struct snd_card *card, const char *id, int type,
		 struct snd_jack **jack, bool initial_kctl, bool phantom_jack);
int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask);
#ifdef CONFIG_SND_JACK_INPUT_DEV
void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
		     int keytype);
#endif
void snd_jack_report(struct snd_jack *jack, int status);

#else
static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
			       struct snd_jack **jack, bool initial_kctl, bool phantom_jack)
{
	return 0;
}

static inline int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
{
	return 0;
}

static inline void snd_jack_report(struct snd_jack *jack, int status)
{
}

#endif

#if !defined(CONFIG_SND_JACK) || !defined(CONFIG_SND_JACK_INPUT_DEV)
static inline void snd_jack_set_parent(struct snd_jack *jack,
				       struct device *parent)
{
}

static inline int snd_jack_set_key(struct snd_jack *jack,
				   enum snd_jack_types type,
				   int keytype)
{
	return 0;
}
#endif /* !CONFIG_SND_JACK || !CONFIG_SND_JACK_INPUT_DEV */

#endif
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
e76d8cea MB	2	#ifndef __SOUND_JACK_H
	3	#define __SOUND_JACK_H
	4
	5	/*
	6	* Jack abstraction layer
	7	*
	8	* Copyright 2008 Wolfson Microelectronics plc
e76d8cea MB	9	*/
	10
	11	#include <sound/core.h>
	12
	13	struct input_dev;
	14
	15	/**
e83280f9 TI	16	* enum snd_jack_types - Jack types which can be reported
	17	* @SND_JACK_HEADPHONE: Headphone
	18	* @SND_JACK_MICROPHONE: Microphone
	19	* @SND_JACK_HEADSET: Headset
	20	* @SND_JACK_LINEOUT: Line out
	21	* @SND_JACK_MECHANICAL: Mechanical switch
	22	* @SND_JACK_VIDEOOUT: Video out
	23	* @SND_JACK_AVOUT: AV (Audio Video) out
	24	* @SND_JACK_LINEIN: Line in
	25	* @SND_JACK_BTN_0: Button 0
	26	* @SND_JACK_BTN_1: Button 1
	27	* @SND_JACK_BTN_2: Button 2
	28	* @SND_JACK_BTN_3: Button 3
	29	* @SND_JACK_BTN_4: Button 4
	30	* @SND_JACK_BTN_5: Button 5
7b366d5f TI	31	*
7b366d5f TI	32	* These values are used as a bitmask.
bd8a71a7 MB	33	*
	34	* Note that this must be kept in sync with the lookup table in
	35	* sound/core/jack.c.
e76d8cea MB	36	*/
	37	enum snd_jack_types {
	38	SND_JACK_HEADPHONE = 0x0001,
	39	SND_JACK_MICROPHONE = 0x0002,
	40	SND_JACK_HEADSET = SND_JACK_HEADPHONE \| SND_JACK_MICROPHONE,
a53ccab3	41	SND_JACK_LINEOUT = 0x0004,
cdc69364	42	SND_JACK_MECHANICAL = 0x0008, /* If detected separately */
d506fc32 JN	43	SND_JACK_VIDEOOUT = 0x0010,
d506fc32 JN	44	SND_JACK_AVOUT = SND_JACK_LINEOUT \| SND_JACK_VIDEOOUT,
7c2f8e40	45	SND_JACK_LINEIN = 0x0020,
ebb812cb MB	46
	47	/* Kept separate from switches to facilitate implementation */
	48	SND_JACK_BTN_0 = 0x4000,
	49	SND_JACK_BTN_1 = 0x2000,
	50	SND_JACK_BTN_2 = 0x1000,
831853c8 MB	51	SND_JACK_BTN_3 = 0x0800,
	52	SND_JACK_BTN_4 = 0x0400,
	53	SND_JACK_BTN_5 = 0x0200,
e76d8cea MB	54	};
e76d8cea MB	55
53803aea MB	56	/* Keep in sync with definitions above */
	57	#define SND_JACK_SWITCH_TYPES 6
	58
e76d8cea	59	struct snd_jack {
9058cbe1 JY	60	struct list_head kctl_list;
9058cbe1 JY	61	struct snd_card *card;
fe0d128c TI	62	const char *id;
	63	#ifdef CONFIG_SND_JACK_INPUT_DEV
	64	struct input_dev *input_dev;
e76d8cea MB	65	int registered;
e76d8cea MB	66	int type;
e76d8cea	67	char name[100];
831853c8	68	unsigned int key[6]; /* Keep in sync with definitions above */
fe0d128c	69	#endif /* CONFIG_SND_JACK_INPUT_DEV */
2d670ea2	70	int hw_status_cache;
9d59065c TI	71	void *private_data;
9d59065c TI	72	void (private_free)(struct snd_jack );
e76d8cea MB	73	};
	74
	75	#ifdef CONFIG_SND_JACK
	76
	77	int snd_jack_new(struct snd_card card, const char id, int type,
4e3f0dc6	78	struct snd_jack **jack, bool initial_kctl, bool phantom_jack);
9058cbe1	79	int snd_jack_add_new_kctl(struct snd_jack jack, const char name, int mask);
fe0d128c	80	#ifdef CONFIG_SND_JACK_INPUT_DEV
e76d8cea	81	void snd_jack_set_parent(struct snd_jack jack, struct device parent);
ebb812cb MB	82	int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
ebb812cb MB	83	int keytype);
fe0d128c	84	#endif
e76d8cea MB	85	void snd_jack_report(struct snd_jack *jack, int status);
	86
	87	#else
e76d8cea	88	static inline int snd_jack_new(struct snd_card card, const char id, int type,
4e3f0dc6	89	struct snd_jack **jack, bool initial_kctl, bool phantom_jack)
e76d8cea MB	90	{
	91	return 0;
	92	}
	93
9058cbe1 JY	94	static inline int snd_jack_add_new_kctl(struct snd_jack jack, const char name, int mask)
	95	{
	96	return 0;
	97	}
	98
fe0d128c TI	99	static inline void snd_jack_report(struct snd_jack *jack, int status)
	100	{
	101	}
	102
	103	#endif
	104
	105	#if !defined(CONFIG_SND_JACK) \|\| !defined(CONFIG_SND_JACK_INPUT_DEV)
e76d8cea MB	106	static inline void snd_jack_set_parent(struct snd_jack *jack,
	107	struct device *parent)
	108	{
	109	}
	110
bf35df66 TI	111	static inline int snd_jack_set_key(struct snd_jack *jack,
	112	enum snd_jack_types type,
	113	int keytype)
	114	{
	115	return 0;
	116	}
fe0d128c	117	#endif /* !CONFIG_SND_JACK \|\| !CONFIG_SND_JACK_INPUT_DEV */
e76d8cea MB	118
e76d8cea MB	119	#endif