/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * BIOS auto-parser helper functions for HD-audio
 *
 * Copyright (c) 2012 Takashi Iwai <tiwai@suse.de>
 */

#ifndef __SOUND_HDA_AUTO_PARSER_H
#define __SOUND_HDA_AUTO_PARSER_H

#include "hda_local.h"

/*
 * Helper for automatic pin configuration
 */

enum {
        AUTO_PIN_MIC,
        AUTO_PIN_LINE_IN,
        AUTO_PIN_CD,
        AUTO_PIN_AUX,
        AUTO_PIN_LAST
};

enum {
        AUTO_PIN_LINE_OUT,
        AUTO_PIN_SPEAKER_OUT,
        AUTO_PIN_HP_OUT
};

#define AUTO_CFG_MAX_OUTS       HDA_MAX_OUTS
#define AUTO_CFG_MAX_INS        18

struct auto_pin_cfg_item {
        hda_nid_t pin;
        int type;
        unsigned int is_headset_mic:1;
        unsigned int is_headphone_mic:1; /* Mic-only in headphone jack */
        unsigned int has_boost_on_pin:1;
        int order;
};

struct auto_pin_cfg;
const char *hda_get_autocfg_input_label(struct hda_codec *codec,
                                        const struct auto_pin_cfg *cfg,
                                        int input);
int snd_hda_get_pin_label(struct hda_codec *codec, hda_nid_t nid,
                          const struct auto_pin_cfg *cfg,
                          char *label, int maxlen, int *indexp);

enum {
        INPUT_PIN_ATTR_UNUSED,  /* pin not connected */
        INPUT_PIN_ATTR_INT,     /* internal mic/line-in */
        INPUT_PIN_ATTR_DOCK,    /* docking mic/line-in */
        INPUT_PIN_ATTR_NORMAL,  /* mic/line-in jack */
        INPUT_PIN_ATTR_REAR,    /* mic/line-in jack in rear */
        INPUT_PIN_ATTR_FRONT,   /* mic/line-in jack in front */
        INPUT_PIN_ATTR_LAST = INPUT_PIN_ATTR_FRONT,
};

int snd_hda_get_input_pin_attr(unsigned int def_conf);

struct auto_pin_cfg {
        int line_outs;
        /* sorted in the order of Front/Surr/CLFE/Side */
        hda_nid_t line_out_pins[AUTO_CFG_MAX_OUTS];
        int speaker_outs;
        hda_nid_t speaker_pins[AUTO_CFG_MAX_OUTS];
        int hp_outs;
        int line_out_type;      /* AUTO_PIN_XXX_OUT */
        hda_nid_t hp_pins[AUTO_CFG_MAX_OUTS];
        int num_inputs;
        struct auto_pin_cfg_item inputs[AUTO_CFG_MAX_INS];
        int dig_outs;
        hda_nid_t dig_out_pins[2];
        hda_nid_t dig_in_pin;
        hda_nid_t mono_out_pin;
        int dig_out_type[2]; /* HDA_PCM_TYPE_XXX */
        int dig_in_type; /* HDA_PCM_TYPE_XXX */
};

/* bit-flags for snd_hda_parse_pin_def_config() behavior */
#define HDA_PINCFG_NO_HP_FIXUP   (1 << 0) /* no HP-split */
#define HDA_PINCFG_NO_LO_FIXUP   (1 << 1) /* don't take other outs as LO */
#define HDA_PINCFG_HEADSET_MIC   (1 << 2) /* Try to find headset mic; mark seq number as 0xc to trigger */
#define HDA_PINCFG_HEADPHONE_MIC (1 << 3) /* Try to find headphone mic; mark seq number as 0xd to trigger */

int snd_hda_parse_pin_defcfg(struct hda_codec *codec,
                             struct auto_pin_cfg *cfg,
                             const hda_nid_t *ignore_nids,
                             unsigned int cond_flags);

/* older function */
#define snd_hda_parse_pin_def_config(codec, cfg, ignore) \
        snd_hda_parse_pin_defcfg(codec, cfg, ignore, 0)

static inline int auto_cfg_hp_outs(const struct auto_pin_cfg *cfg)
{
        return (cfg->line_out_type == AUTO_PIN_HP_OUT) ?
               cfg->line_outs : cfg->hp_outs;
}
static inline const hda_nid_t *auto_cfg_hp_pins(const struct auto_pin_cfg *cfg)
{
        return (cfg->line_out_type == AUTO_PIN_HP_OUT) ?
               cfg->line_out_pins : cfg->hp_pins;
}
static inline int auto_cfg_speaker_outs(const struct auto_pin_cfg *cfg)
{
        return (cfg->line_out_type == AUTO_PIN_SPEAKER_OUT) ?
               cfg->line_outs : cfg->speaker_outs;
}
static inline const hda_nid_t *auto_cfg_speaker_pins(const struct auto_pin_cfg *cfg)
{
        return (cfg->line_out_type == AUTO_PIN_SPEAKER_OUT) ?
               cfg->line_out_pins : cfg->speaker_pins;
}

#endif /* __SOUND_HDA_AUTO_PARSER_H */