Fedora kernel-2.6.17-1.2142_FC4 patched with stable patch-2.6.17.4-vs2.0.2-rc26.diff
[linux-2.6.git] / include / sound / ac97_codec.h
index 2be436e..b45a737 100644 (file)
@@ -26,6 +26,8 @@
  */
 
 #include <linux/bitops.h>
+#include <linux/device.h>
+#include "pcm.h"
 #include "control.h"
 #include "info.h"
 
@@ -51,7 +53,7 @@
 #define AC97_REC_GAIN_MIC      0x1e    /* Record Gain MIC (optional) */
 #define AC97_GENERAL_PURPOSE   0x20    /* General Purpose (optional) */
 #define AC97_3D_CONTROL                0x22    /* 3D Control (optional) */
-#define AC97_RESERVED          0x24    /* Reserved */
+#define AC97_INT_PAGING                0x24    /* Audio Interrupt & Paging (AC'97 2.3) */
 #define AC97_POWERDOWN         0x26    /* Powerdown control / status */
 /* range 0x28-0x3a - AUDIO AC'97 2.0 extensions */
 #define AC97_EXTENDED_ID       0x28    /* Extended Audio ID */
 /* range 0x5a-0x7b - Vendor Specific */
 #define AC97_VENDOR_ID1                0x7c    /* Vendor ID1 */
 #define AC97_VENDOR_ID2                0x7e    /* Vendor ID2 / revision */
+/* range 0x60-0x6f (page 1) - extended codec registers */
+#define AC97_CODEC_CLASS_REV   0x60    /* Codec Class/Revision */
+#define AC97_PCI_SVID          0x62    /* PCI Subsystem Vendor ID */
+#define AC97_PCI_SID           0x64    /* PCI Subsystem ID */
+#define AC97_FUNC_SELECT       0x66    /* Function Select */
+#define AC97_FUNC_INFO         0x68    /* Function Information */
+#define AC97_SENSE_INFO                0x6a    /* Sense Details */
 
 /* slot allocation */
 #define AC97_SLOT_TAG          0
 #define AC97_BC_20BIT_ADC      0x0200  /* 20-bit ADC resolution */
 #define AC97_BC_ADC_MASK       0x0300
 
+/* general purpose */
+#define AC97_GP_DRSS_MASK      0x0c00  /* double rate slot select */
+#define AC97_GP_DRSS_1011      0x0000  /* LR(C) 10+11(+12) */
+#define AC97_GP_DRSS_78                0x0400  /* LR 7+8 */
+
 /* extended audio ID bit defines */
 #define AC97_EI_VRA            0x0001  /* Variable bit rate supported */
 #define AC97_EI_DRA            0x0002  /* Double rate supported */
 #define AC97_EI_AMAP           0x0200  /* indicates optional slot/DAC mapping based on codec ID */
 #define AC97_EI_REV_MASK       0x0c00  /* AC'97 revision mask */
 #define AC97_EI_REV_22         0x0400  /* AC'97 revision 2.2 */
+#define AC97_EI_REV_23         0x0800  /* AC'97 revision 2.3 */
 #define AC97_EI_REV_SHIFT      10
 #define AC97_EI_ADDR_MASK      0xc000  /* physical codec ID (address) */
 #define AC97_EI_ADDR_SHIFT     14
 #define AC97_SC_DRS            0x4000  /* Double Rate S/PDIF */
 #define AC97_SC_V              0x8000  /* Validity status */
 
+/* Interrupt and Paging bit defines (AC'97 2.3) */
+#define AC97_PAGE_MASK         0x000f  /* Page Selector */
+#define AC97_PAGE_VENDOR       0       /* Vendor-specific registers */
+#define AC97_PAGE_1            1       /* Extended Codec Registers page 1 */
+#define AC97_INT_ENABLE                0x0800  /* Interrupt Enable */
+#define AC97_INT_SENSE         0x1000  /* Sense Cycle */
+#define AC97_INT_CAUSE_SENSE   0x2000  /* Sense Cycle Completed (RO) */
+#define AC97_INT_CAUSE_GPIO    0x4000  /* GPIO bits changed (RO) */
+#define AC97_INT_STATUS                0x8000  /* Interrupt Status */
+
 /* extended modem ID bit defines */
 #define AC97_MEI_LINE1         0x0001  /* Line1 present */
 #define AC97_MEI_LINE2         0x0002  /* Line2 present */
 #define AC97_SCAP_SKIP_AUDIO   (1<<4)  /* skip audio part of codec */
 #define AC97_SCAP_SKIP_MODEM   (1<<5)  /* skip modem part of codec */
 #define AC97_SCAP_INDEP_SDIN   (1<<6)  /* independent SDIN */
+#define AC97_SCAP_INV_EAPD     (1<<7)  /* inverted EAPD */
+#define AC97_SCAP_DETECT_BY_VENDOR (1<<8) /* use vendor registers for read tests */
+#define AC97_SCAP_NO_SPDIF     (1<<9)  /* don't build SPDIF controls */
 
 /* ac97->flags */
 #define AC97_HAS_PC_BEEP       (1<<0)  /* force PC Speaker usage */
 #define AC97_CS_SPDIF          (1<<2)  /* Cirrus Logic uses funky SPDIF */
 #define AC97_CX_SPDIF          (1<<3)  /* Conexant's spdif interface */
 #define AC97_STEREO_MUTES      (1<<4)  /* has stereo mute bits */
+#define AC97_DOUBLE_RATE       (1<<5)  /* supports double rate playback */
+#define AC97_HAS_NO_MASTER_VOL (1<<6)  /* no Master volume */
+#define AC97_HAS_NO_PCM_VOL    (1<<7)  /* no PCM volume */
+#define AC97_DEFAULT_POWER_OFF (1<<8)  /* no RESET write */
+#define AC97_MODEM_PATCH       (1<<9)  /* modem patch */
+#define AC97_HAS_NO_REC_GAIN   (1<<10) /* no Record gain */
+#define AC97_HAS_NO_PHONE      (1<<11) /* no PHONE volume */
+#define AC97_HAS_NO_PC_BEEP    (1<<12) /* no PC Beep volume */
+#define AC97_HAS_NO_VIDEO      (1<<13) /* no Video volume */
+#define AC97_HAS_NO_CD         (1<<14) /* no CD volume */
+#define AC97_HAS_NO_MIC        (1<<15) /* no MIC volume */
+#define AC97_HAS_NO_TONE       (1<<16) /* no Tone volume */
+#define AC97_HAS_NO_STD_PCM    (1<<17) /* no standard AC97 PCM volume and mute */
 
 /* rates indexes */
 #define AC97_RATES_FRONT_DAC   0
  *
  */
 
-typedef struct _snd_ac97_bus ac97_bus_t;
-typedef struct _snd_ac97 ac97_t;
+struct snd_ac97;
 
-enum ac97_pcm_cfg {
-       AC97_PCM_CFG_FRONT = 2,
-       AC97_PCM_CFG_REAR = 10,         /* alias surround */
-       AC97_PCM_CFG_LFE = 11,          /* center + lfe */
-       AC97_PCM_CFG_40 = 4,            /* front + rear */
-       AC97_PCM_CFG_51 = 6,            /* front + rear + center/lfe */
-       AC97_PCM_CFG_SPDIF = 20
-};
-
-/* PCM allocation */
-struct ac97_pcm {
-       ac97_bus_t *bus;
-       unsigned int stream: 1,            /* stream type: 1 = capture */
-                    exclusive: 1,         /* exclusive mode, don't override with other pcms */
-                    copy_flag: 1,         /* lowlevel driver must fill all entries */
-                    spdif: 1;             /* spdif pcm */
-       unsigned short aslots;             /* active slots */
-       unsigned int rates;                /* available rates */
-       struct {
-               unsigned short slots;      /* driver input: requested AC97 slot numbers */
-               unsigned short rslots[4];  /* allocated slots per codecs */
-               unsigned char rate_table[4];
-               ac97_t *codec[4];          /* allocated codecs */
-       } r[2];                            /* 0 = standard rates, 1 = double rates */
-       unsigned long private_value;       /* used by the hardware driver */
+struct snd_ac97_build_ops {
+       int (*build_3d) (struct snd_ac97 *ac97);
+       int (*build_specific) (struct snd_ac97 *ac97);
+       int (*build_spdif) (struct snd_ac97 *ac97);
+       int (*build_post_spdif) (struct snd_ac97 *ac97);
+#ifdef CONFIG_PM
+       void (*suspend) (struct snd_ac97 *ac97);
+       void (*resume) (struct snd_ac97 *ac97);
+#endif
+       void (*update_jacks) (struct snd_ac97 *ac97);   /* for jack-sharing */
 };
 
-struct snd_ac97_build_ops {
-       int (*build_3d) (ac97_t *ac97);
-       int (*build_specific) (ac97_t *ac97);
-       int (*build_spdif) (ac97_t *ac97);
-       int (*build_post_spdif) (ac97_t *ac97);
+struct snd_ac97_bus_ops {
+       void (*reset) (struct snd_ac97 *ac97);
+       void (*write) (struct snd_ac97 *ac97, unsigned short reg, unsigned short val);
+       unsigned short (*read) (struct snd_ac97 *ac97, unsigned short reg);
+       void (*wait) (struct snd_ac97 *ac97);
+       void (*init) (struct snd_ac97 *ac97);
 };
 
-struct _snd_ac97_bus {
+struct snd_ac97_bus {
        /* -- lowlevel (hardware) driver specific -- */
-       void (*reset) (ac97_t *ac97);
-       void (*write) (ac97_t *ac97, unsigned short reg, unsigned short val);
-       unsigned short (*read) (ac97_t *ac97, unsigned short reg);
-       void (*wait) (ac97_t *ac97);
-       void (*init) (ac97_t *ac97);
+       struct snd_ac97_bus_ops *ops;
        void *private_data;
-       void (*private_free) (ac97_bus_t *bus);
+       void (*private_free) (struct snd_ac97_bus *bus);
        /* --- */
-       snd_card_t *card;
+       struct snd_card *card;
        unsigned short num;     /* bus number */
-       unsigned short vra: 1,  /* bridge supports VRA */
+       unsigned short no_vra: 1, /* bridge doesn't support VRA */
+                      dra: 1,  /* bridge supports double rate */
                       isdin: 1;/* independent SDIN */
        unsigned int clock;     /* AC'97 base clock (usually 48000Hz) */
        spinlock_t bus_lock;    /* used mainly for slot allocation */
        unsigned short used_slots[2][4]; /* actually used PCM slots */
        unsigned short pcms_count; /* count of PCMs */
        struct ac97_pcm *pcms;
-       ac97_t *codec[4];
-       snd_info_entry_t *proc;
+       struct snd_ac97 *codec[4];
+       struct snd_info_entry *proc;
+};
+
+/* static resolution table */
+struct snd_ac97_res_table {
+       unsigned short reg;     /* register */
+       unsigned short bits;    /* resolution bitmask */
+};
+
+struct snd_ac97_template {
+       void *private_data;
+       void (*private_free) (struct snd_ac97 *ac97);
+       struct pci_dev *pci;    /* assigned PCI device - used for quirks */
+       unsigned short num;     /* number of codec: 0 = primary, 1 = secondary */
+       unsigned short addr;    /* physical address of codec [0-3] */
+       unsigned int scaps;     /* driver capabilities */
+       const struct snd_ac97_res_table *res_table;     /* static resolution */
 };
 
-struct _snd_ac97 {
+struct snd_ac97 {
        /* -- lowlevel (hardware) driver specific -- */
        struct snd_ac97_build_ops * build_ops;
        void *private_data;
-       void (*private_free) (ac97_t *ac97);
+       void (*private_free) (struct snd_ac97 *ac97);
        /* --- */
-       ac97_bus_t *bus;
+       struct snd_ac97_bus *bus;
        struct pci_dev *pci;    /* assigned PCI device - used for quirks */
-       snd_info_entry_t *proc;
-       snd_info_entry_t *proc_regs;
+       struct snd_info_entry *proc;
+       struct snd_info_entry *proc_regs;
        unsigned short subsystem_vendor;
        unsigned short subsystem_device;
-       spinlock_t reg_lock;
+       struct mutex reg_mutex;
+       struct mutex page_mutex;        /* mutex for AD18xx multi-codecs and paging (2.3) */
        unsigned short num;     /* number of codec: 0 = primary, 1 = secondary */
        unsigned short addr;    /* physical address of codec [0-3] */
        unsigned int id;        /* identification of codec */
        unsigned short caps;    /* capabilities (register 0) */
        unsigned short ext_id;  /* extended feature identification (register 28) */
        unsigned short ext_mid; /* extended modem ID (register 3C) */
+       const struct snd_ac97_res_table *res_table;     /* static resolution */
        unsigned int scaps;     /* driver capabilities */
        unsigned int flags;     /* specific code */
        unsigned int rates[6];  /* see AC97_RATES_* defines */
        unsigned int spdif_status;
        unsigned short regs[0x80]; /* register cache */
-       unsigned int limited_regs; /* allow limited registers only */
        DECLARE_BITMAP(reg_accessed, 0x80); /* bit flags */
        union {                 /* vendor specific code */
                struct {
@@ -443,42 +483,56 @@ struct _snd_ac97 {
                        unsigned short id[3];           // codec IDs (lower 16-bit word)
                        unsigned short pcmreg[3];       // PCM registers
                        unsigned short codec_cfg[3];    // CODEC_CFG bits
-                       struct semaphore mutex;
                } ad18xx;
                unsigned int dev_flags;         /* device specific */
        } spec;
+       /* jack-sharing info */
+       unsigned char indep_surround;
+       unsigned char channel_mode;
+       struct device dev;
 };
 
+#define to_ac97_t(d) container_of(d, struct snd_ac97, dev)
+
 /* conditions */
-static inline int ac97_is_audio(ac97_t * ac97)
+static inline int ac97_is_audio(struct snd_ac97 * ac97)
 {
        return (ac97->scaps & AC97_SCAP_AUDIO);
 }
-static inline int ac97_is_modem(ac97_t * ac97)
+static inline int ac97_is_modem(struct snd_ac97 * ac97)
 {
        return (ac97->scaps & AC97_SCAP_MODEM);
 }
-static inline int ac97_is_rev22(ac97_t * ac97)
+static inline int ac97_is_rev22(struct snd_ac97 * ac97)
 {
        return (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_22;
 }
-static inline int ac97_can_amap(ac97_t * ac97)
+static inline int ac97_can_amap(struct snd_ac97 * ac97)
 {
        return (ac97->ext_id & AC97_EI_AMAP) != 0;
 }
+static inline int ac97_can_spdif(struct snd_ac97 * ac97)
+{
+       return (ac97->ext_id & AC97_EI_SPDIF) != 0;
+}
 
 /* functions */
-int snd_ac97_bus(snd_card_t * card, ac97_bus_t * _bus, ac97_bus_t ** rbus); /* create new AC97 bus */
-int snd_ac97_mixer(ac97_bus_t * bus, ac97_t * _ac97, ac97_t ** rac97); /* create mixer controls */
-
-void snd_ac97_write(ac97_t *ac97, unsigned short reg, unsigned short value);
-unsigned short snd_ac97_read(ac97_t *ac97, unsigned short reg);
-void snd_ac97_write_cache(ac97_t *ac97, unsigned short reg, unsigned short value);
-int snd_ac97_update(ac97_t *ac97, unsigned short reg, unsigned short value);
-int snd_ac97_update_bits(ac97_t *ac97, unsigned short reg, unsigned short mask, unsigned short value);
+/* create new AC97 bus */
+int snd_ac97_bus(struct snd_card *card, int num, struct snd_ac97_bus_ops *ops,
+                void *private_data, struct snd_ac97_bus **rbus);
+/* create mixer controls */
+int snd_ac97_mixer(struct snd_ac97_bus *bus, struct snd_ac97_template *template,
+                  struct snd_ac97 **rac97);
+const char *snd_ac97_get_short_name(struct snd_ac97 *ac97);
+
+void snd_ac97_write(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
+unsigned short snd_ac97_read(struct snd_ac97 *ac97, unsigned short reg);
+void snd_ac97_write_cache(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
+int snd_ac97_update(struct snd_ac97 *ac97, unsigned short reg, unsigned short value);
+int snd_ac97_update_bits(struct snd_ac97 *ac97, unsigned short reg, unsigned short mask, unsigned short value);
 #ifdef CONFIG_PM
-void snd_ac97_suspend(ac97_t *ac97);
-void snd_ac97_resume(ac97_t *ac97);
+void snd_ac97_suspend(struct snd_ac97 *ac97);
+void snd_ac97_resume(struct snd_ac97 *ac97);
 #endif
 
 /* quirk types */
@@ -490,24 +544,62 @@ enum {
        AC97_TUNE_SWAP_SURROUND, /* swap master and surround controls */
        AC97_TUNE_AD_SHARING,   /* for AD1985, turn on OMS bit and use headphone */
        AC97_TUNE_ALC_JACK,     /* for Realtek, enable JACK detection */
+       AC97_TUNE_INV_EAPD,     /* inverted EAPD implementation */
+       AC97_TUNE_MUTE_LED,     /* EAPD bit works as mute LED */
+       AC97_TUNE_HP_MUTE_LED,  /* EAPD bit works as mute LED, use headphone control as master */
 };
 
 struct ac97_quirk {
-       unsigned short vendor;  /* PCI vendor id */
-       unsigned short device;  /* PCI device id */
+       unsigned short subvendor; /* PCI subsystem vendor id */
+       unsigned short subdevice; /* PCI sybsystem device id */
        unsigned short mask;    /* device id bit mask, 0 = accept all */
+       unsigned int codec_id;  /* codec id (if any), 0 = accept all */
        const char *name;       /* name shown as info */
        int type;               /* quirk type above */
 };
 
-int snd_ac97_tune_hardware(ac97_t *ac97, struct ac97_quirk *quirk, int override);
-int snd_ac97_set_rate(ac97_t *ac97, int reg, unsigned short rate);
+int snd_ac97_tune_hardware(struct snd_ac97 *ac97, struct ac97_quirk *quirk, const char *override);
+int snd_ac97_set_rate(struct snd_ac97 *ac97, int reg, unsigned int rate);
+
+/*
+ * PCM allocation
+ */
+
+enum ac97_pcm_cfg {
+       AC97_PCM_CFG_FRONT = 2,
+       AC97_PCM_CFG_REAR = 10,         /* alias surround */
+       AC97_PCM_CFG_LFE = 11,          /* center + lfe */
+       AC97_PCM_CFG_40 = 4,            /* front + rear */
+       AC97_PCM_CFG_51 = 6,            /* front + rear + center/lfe */
+       AC97_PCM_CFG_SPDIF = 20
+};
+
+struct ac97_pcm {
+       struct snd_ac97_bus *bus;
+       unsigned int stream: 1,            /* stream type: 1 = capture */
+                    exclusive: 1,         /* exclusive mode, don't override with other pcms */
+                    copy_flag: 1,         /* lowlevel driver must fill all entries */
+                    spdif: 1;             /* spdif pcm */
+       unsigned short aslots;             /* active slots */
+       unsigned int rates;                /* available rates */
+       struct {
+               unsigned short slots;      /* driver input: requested AC97 slot numbers */
+               unsigned short rslots[4];  /* allocated slots per codecs */
+               unsigned char rate_table[4];
+               struct snd_ac97 *codec[4];         /* allocated codecs */
+       } r[2];                            /* 0 = standard rates, 1 = double rates */
+       unsigned long private_value;       /* used by the hardware driver */
+};
 
-int snd_ac97_pcm_assign(ac97_bus_t *ac97,
+int snd_ac97_pcm_assign(struct snd_ac97_bus *ac97,
                        unsigned short pcms_count,
                        const struct ac97_pcm *pcms);
 int snd_ac97_pcm_open(struct ac97_pcm *pcm, unsigned int rate,
                      enum ac97_pcm_cfg cfg, unsigned short slots);
 int snd_ac97_pcm_close(struct ac97_pcm *pcm);
+int snd_ac97_pcm_double_rate_rules(struct snd_pcm_runtime *runtime);
+
+/* ad hoc AC97 device driver access */
+extern struct bus_type ac97_bus_type;
 
 #endif /* __SOUND_AC97_CODEC_H */