blob: 9eb2b5ec1ec4104199c5716e2875a90af5205d31 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Mark Browne76d8ce2008-07-28 19:05:35 +01002#ifndef __SOUND_JACK_H
3#define __SOUND_JACK_H
4
5/*
6 * Jack abstraction layer
7 *
8 * Copyright 2008 Wolfson Microelectronics plc
Mark Browne76d8ce2008-07-28 19:05:35 +01009 */
10
11#include <sound/core.h>
12
13struct input_dev;
14
15/**
Takashi Iwaie83280f2014-10-29 08:20:46 +010016 * 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
Takashi Iwai7b366d52014-10-28 15:30:00 +010031 *
32 * These values are used as a bitmask.
Mark Brownbd8a71a2009-01-03 16:56:56 +000033 *
34 * Note that this must be kept in sync with the lookup table in
35 * sound/core/jack.c.
Mark Browne76d8ce2008-07-28 19:05:35 +010036 */
37enum snd_jack_types {
38 SND_JACK_HEADPHONE = 0x0001,
39 SND_JACK_MICROPHONE = 0x0002,
40 SND_JACK_HEADSET = SND_JACK_HEADPHONE | SND_JACK_MICROPHONE,
Matthew Ranostaya53ccab2008-10-25 01:05:04 -040041 SND_JACK_LINEOUT = 0x0004,
Mark Browncdc69362008-12-10 13:55:49 +000042 SND_JACK_MECHANICAL = 0x0008, /* If detected separately */
Jani Nikulad506fc32009-01-07 11:54:25 +020043 SND_JACK_VIDEOOUT = 0x0010,
44 SND_JACK_AVOUT = SND_JACK_LINEOUT | SND_JACK_VIDEOOUT,
David Henningsson7c2f8e42011-10-05 15:53:25 +020045 SND_JACK_LINEIN = 0x0020,
Mark Brownebb812c2010-03-17 18:07:12 +000046
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,
Mark Brown831853c2010-09-06 16:08:56 +010051 SND_JACK_BTN_3 = 0x0800,
52 SND_JACK_BTN_4 = 0x0400,
53 SND_JACK_BTN_5 = 0x0200,
Mark Browne76d8ce2008-07-28 19:05:35 +010054};
55
Mark Brown53803ae2012-02-07 19:48:47 +000056/* Keep in sync with definitions above */
57#define SND_JACK_SWITCH_TYPES 6
58
Mark Browne76d8ce2008-07-28 19:05:35 +010059struct snd_jack {
Jie Yang9058cbe2015-04-27 21:20:56 +080060 struct list_head kctl_list;
61 struct snd_card *card;
Takashi Iwaife0d1282016-02-17 09:44:25 +010062 const char *id;
63#ifdef CONFIG_SND_JACK_INPUT_DEV
64 struct input_dev *input_dev;
Mark Browne76d8ce2008-07-28 19:05:35 +010065 int registered;
66 int type;
Mark Browne76d8ce2008-07-28 19:05:35 +010067 char name[100];
Mark Brown831853c2010-09-06 16:08:56 +010068 unsigned int key[6]; /* Keep in sync with definitions above */
Takashi Iwaife0d1282016-02-17 09:44:25 +010069#endif /* CONFIG_SND_JACK_INPUT_DEV */
Takashi Iwai9d590652009-04-14 16:13:58 +020070 void *private_data;
71 void (*private_free)(struct snd_jack *);
Mark Browne76d8ce2008-07-28 19:05:35 +010072};
73
74#ifdef CONFIG_SND_JACK
75
76int snd_jack_new(struct snd_card *card, const char *id, int type,
Jie Yang4e3f0dc2015-04-27 21:20:58 +080077 struct snd_jack **jack, bool initial_kctl, bool phantom_jack);
Jie Yang9058cbe2015-04-27 21:20:56 +080078int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask);
Takashi Iwaife0d1282016-02-17 09:44:25 +010079#ifdef CONFIG_SND_JACK_INPUT_DEV
Mark Browne76d8ce2008-07-28 19:05:35 +010080void snd_jack_set_parent(struct snd_jack *jack, struct device *parent);
Mark Brownebb812c2010-03-17 18:07:12 +000081int snd_jack_set_key(struct snd_jack *jack, enum snd_jack_types type,
82 int keytype);
Takashi Iwaife0d1282016-02-17 09:44:25 +010083#endif
Mark Browne76d8ce2008-07-28 19:05:35 +010084void snd_jack_report(struct snd_jack *jack, int status);
85
86#else
Mark Browne76d8ce2008-07-28 19:05:35 +010087static inline int snd_jack_new(struct snd_card *card, const char *id, int type,
Jie Yang4e3f0dc2015-04-27 21:20:58 +080088 struct snd_jack **jack, bool initial_kctl, bool phantom_jack)
Mark Browne76d8ce2008-07-28 19:05:35 +010089{
90 return 0;
91}
92
Jie Yang9058cbe2015-04-27 21:20:56 +080093static inline int snd_jack_add_new_kctl(struct snd_jack *jack, const char * name, int mask)
94{
95 return 0;
96}
97
Takashi Iwaife0d1282016-02-17 09:44:25 +010098static inline void snd_jack_report(struct snd_jack *jack, int status)
99{
100}
101
102#endif
103
104#if !defined(CONFIG_SND_JACK) || !defined(CONFIG_SND_JACK_INPUT_DEV)
Mark Browne76d8ce2008-07-28 19:05:35 +0100105static inline void snd_jack_set_parent(struct snd_jack *jack,
106 struct device *parent)
107{
108}
109
Takashi Iwaibf35df62014-12-08 15:44:47 +0100110static inline int snd_jack_set_key(struct snd_jack *jack,
111 enum snd_jack_types type,
112 int keytype)
113{
114 return 0;
115}
Takashi Iwaife0d1282016-02-17 09:44:25 +0100116#endif /* !CONFIG_SND_JACK || !CONFIG_SND_JACK_INPUT_DEV */
Mark Browne76d8ce2008-07-28 19:05:35 +0100117
118#endif