[linux-block.git] / sound / ppc / pmac.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Driver for PowerMac onboard soundchips
 * Copyright (c) 2001 by Takashi Iwai <tiwai@suse.de>
 *   based on dmasound.c.
 */


#ifndef __PMAC_H
#define __PMAC_H

#include <sound/control.h>
#include <sound/pcm.h>
#include "awacs.h"

#include <linux/adb.h>
#ifdef CONFIG_ADB_CUDA
#include <linux/cuda.h>
#endif
#ifdef CONFIG_ADB_PMU
#include <linux/pmu.h>
#endif
#include <linux/nvram.h>
#include <linux/tty.h>
#include <linux/vt_kern.h>
#include <asm/dbdma.h>
#include <asm/prom.h>
#include <asm/machdep.h>

/* maximum number of fragments */
#define PMAC_MAX_FRAGS		32


#define PMAC_SUPPORT_AUTOMUTE

/*
 * DBDMA space
 */
struct pmac_dbdma {
	dma_addr_t dma_base;
	dma_addr_t addr;
	struct dbdma_cmd __iomem *cmds;
	void *space;
	int size;
};

/*
 * playback/capture stream
 */
struct pmac_stream {
	int running;	/* boolean */

	int stream;	/* PLAYBACK/CAPTURE */

	int dma_size; /* in bytes */
	int period_size; /* in bytes */
	int buffer_size; /* in kbytes */
	int nperiods, cur_period;

	struct pmac_dbdma cmd;
	volatile struct dbdma_regs __iomem *dma;

	struct snd_pcm_substream *substream;

	unsigned int cur_freqs;		/* currently available frequencies */
	unsigned int cur_formats;	/* currently available formats */
};


/*
 */

enum snd_pmac_model {
	PMAC_AWACS, PMAC_SCREAMER, PMAC_BURGUNDY, PMAC_DACA, PMAC_TUMBLER,
	PMAC_SNAPPER
};

struct snd_pmac {
	struct snd_card *card;

	/* h/w info */
	struct device_node *node;
	struct pci_dev *pdev;
	unsigned int revision;
	unsigned int manufacturer;
	unsigned int subframe;
	unsigned int device_id;
	enum snd_pmac_model model;

	unsigned int has_iic : 1;
	unsigned int is_pbook_3400 : 1;
	unsigned int is_pbook_G3 : 1;
	unsigned int is_k2 : 1;

	unsigned int can_byte_swap : 1;
	unsigned int can_duplex : 1;
	unsigned int can_capture : 1;

	unsigned int auto_mute : 1;
	unsigned int initialized : 1;
	unsigned int feature_is_set : 1;

	unsigned int requested;
	struct resource rsrc[3];

	int num_freqs;
	const int *freq_table;
	unsigned int freqs_ok;		/* bit flags */
	unsigned int formats_ok;	/* pcm hwinfo */
	int active;
	int rate_index;
	int format;			/* current format */

	spinlock_t reg_lock;
	volatile struct awacs_regs __iomem *awacs;
	int awacs_reg[8]; /* register cache */
	unsigned int hp_stat_mask;

	unsigned char __iomem *latch_base;
	unsigned char __iomem *macio_base;

	struct pmac_stream playback;
	struct pmac_stream capture;

	struct pmac_dbdma extra_dma;

	int irq, tx_irq, rx_irq;

	struct snd_pcm *pcm;

	struct pmac_beep *beep;

	unsigned int control_mask;	/* control mask */

	/* mixer stuffs */
	void *mixer_data;
	void (*mixer_free)(struct snd_pmac *);
	struct snd_kcontrol *master_sw_ctl;
	struct snd_kcontrol *speaker_sw_ctl;
	struct snd_kcontrol *drc_sw_ctl;	/* only used for tumbler -ReneR */
	struct snd_kcontrol *hp_detect_ctl;
	struct snd_kcontrol *lineout_sw_ctl;

	/* lowlevel callbacks */
	void (*set_format)(struct snd_pmac *chip);
	void (*update_automute)(struct snd_pmac *chip, int do_notify);
	int (*detect_headphone)(struct snd_pmac *chip);
#ifdef CONFIG_PM
	void (*suspend)(struct snd_pmac *chip);
	void (*resume)(struct snd_pmac *chip);
#endif

};


/* exported functions */
int snd_pmac_new(struct snd_card *card, struct snd_pmac **chip_return);
int snd_pmac_pcm_new(struct snd_pmac *chip);
int snd_pmac_attach_beep(struct snd_pmac *chip);
void snd_pmac_detach_beep(struct snd_pmac *chip);
void snd_pmac_beep_stop(struct snd_pmac *chip);
unsigned int snd_pmac_rate_index(struct snd_pmac *chip, struct pmac_stream *rec, unsigned int rate);

void snd_pmac_beep_dma_start(struct snd_pmac *chip, int bytes, unsigned long addr, int speed);
void snd_pmac_beep_dma_stop(struct snd_pmac *chip);

#ifdef CONFIG_PM
void snd_pmac_suspend(struct snd_pmac *chip);
void snd_pmac_resume(struct snd_pmac *chip);
#endif

/* initialize mixer */
int snd_pmac_awacs_init(struct snd_pmac *chip);
int snd_pmac_burgundy_init(struct snd_pmac *chip);
int snd_pmac_daca_init(struct snd_pmac *chip);
int snd_pmac_tumbler_init(struct snd_pmac *chip);
int snd_pmac_tumbler_post_init(void);

/* i2c functions */
struct pmac_keywest {
	int addr;
	struct i2c_client *client;
	int id;
	int (*init_client)(struct pmac_keywest *i2c);
	char *name;
};

int snd_pmac_keywest_init(struct pmac_keywest *i2c);
void snd_pmac_keywest_cleanup(struct pmac_keywest *i2c);

/* misc */
#define snd_pmac_boolean_stereo_info	snd_ctl_boolean_stereo_info
#define snd_pmac_boolean_mono_info	snd_ctl_boolean_mono_info

int snd_pmac_add_automute(struct snd_pmac *chip);

#endif /* __PMAC_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* Driver for PowerMac onboard soundchips
	4	* Copyright (c) 2001 by Takashi Iwai <tiwai@suse.de>
	5	* based on dmasound.c.
1da177e4 LT	6	*/
	7
	8
	9	#ifndef __PMAC_H
	10	#define __PMAC_H
	11
1da177e4 LT	12	#include <sound/control.h>
	13	#include <sound/pcm.h>
	14	#include "awacs.h"
	15
	16	#include <linux/adb.h>
	17	#ifdef CONFIG_ADB_CUDA
	18	#include <linux/cuda.h>
	19	#endif
	20	#ifdef CONFIG_ADB_PMU
	21	#include <linux/pmu.h>
	22	#endif
	23	#include <linux/nvram.h>
	24	#include <linux/tty.h>
	25	#include <linux/vt_kern.h>
	26	#include <asm/dbdma.h>
	27	#include <asm/prom.h>
	28	#include <asm/machdep.h>
	29
	30	/* maximum number of fragments */
	31	#define PMAC_MAX_FRAGS 32
	32
	33
	34	#define PMAC_SUPPORT_AUTOMUTE
	35
1da177e4 LT	36	/*
	37	* DBDMA space
	38	*/
65b29f50	39	struct pmac_dbdma {
7bbd8277 BH	40	dma_addr_t dma_base;
7bbd8277 BH	41	dma_addr_t addr;
1da177e4 LT	42	struct dbdma_cmd __iomem *cmds;
	43	void *space;
	44	int size;
	45	};
	46
	47	/*
	48	* playback/capture stream
	49	*/
65b29f50	50	struct pmac_stream {
1da177e4 LT	51	int running; /* boolean */
	52
	53	int stream; /* PLAYBACK/CAPTURE */
	54
	55	int dma_size; /* in bytes */
	56	int period_size; /* in bytes */
	57	int buffer_size; /* in kbytes */
	58	int nperiods, cur_period;
	59
65b29f50	60	struct pmac_dbdma cmd;
1da177e4 LT	61	volatile struct dbdma_regs __iomem *dma;
1da177e4 LT	62
65b29f50	63	struct snd_pcm_substream *substream;
1da177e4 LT	64
	65	unsigned int cur_freqs; /* currently available frequencies */
	66	unsigned int cur_formats; /* currently available formats */
	67	};
	68
	69
	70	/*
	71	*/
	72
	73	enum snd_pmac_model {
1f7b49d0	74	PMAC_AWACS, PMAC_SCREAMER, PMAC_BURGUNDY, PMAC_DACA, PMAC_TUMBLER,
55c385ad	75	PMAC_SNAPPER
1da177e4 LT	76	};
	77
	78	struct snd_pmac {
65b29f50	79	struct snd_card *card;
1da177e4 LT	80
	81	/* h/w info */
	82	struct device_node *node;
7bbd8277	83	struct pci_dev *pdev;
1da177e4 LT	84	unsigned int revision;
	85	unsigned int manufacturer;
	86	unsigned int subframe;
	87	unsigned int device_id;
	88	enum snd_pmac_model model;
	89
	90	unsigned int has_iic : 1;
	91	unsigned int is_pbook_3400 : 1;
	92	unsigned int is_pbook_G3 : 1;
7bbd8277	93	unsigned int is_k2 : 1;
1da177e4 LT	94
	95	unsigned int can_byte_swap : 1;
	96	unsigned int can_duplex : 1;
	97	unsigned int can_capture : 1;
	98
	99	unsigned int auto_mute : 1;
	100	unsigned int initialized : 1;
	101	unsigned int feature_is_set : 1;
	102
cc5d0189 BH	103	unsigned int requested;
cc5d0189 BH	104	struct resource rsrc[3];
1da177e4 LT	105
1da177e4 LT	106	int num_freqs;
6e9ef32f	107	const int *freq_table;
1da177e4 LT	108	unsigned int freqs_ok; /* bit flags */
	109	unsigned int formats_ok; /* pcm hwinfo */
	110	int active;
	111	int rate_index;
	112	int format; /* current format */
	113
	114	spinlock_t reg_lock;
	115	volatile struct awacs_regs __iomem *awacs;
	116	int awacs_reg[8]; /* register cache */
	117	unsigned int hp_stat_mask;
	118
	119	unsigned char __iomem *latch_base;
	120	unsigned char __iomem *macio_base;
	121
65b29f50 TI	122	struct pmac_stream playback;
65b29f50 TI	123	struct pmac_stream capture;
1da177e4	124
65b29f50	125	struct pmac_dbdma extra_dma;
1da177e4 LT	126
	127	int irq, tx_irq, rx_irq;
	128
65b29f50	129	struct snd_pcm *pcm;
1da177e4	130
65b29f50	131	struct pmac_beep *beep;
1da177e4 LT	132
	133	unsigned int control_mask; /* control mask */
	134
	135	/* mixer stuffs */
	136	void *mixer_data;
65b29f50 TI	137	void (mixer_free)(struct snd_pmac );
	138	struct snd_kcontrol *master_sw_ctl;
	139	struct snd_kcontrol *speaker_sw_ctl;
	140	struct snd_kcontrol drc_sw_ctl; / only used for tumbler -ReneR */
	141	struct snd_kcontrol *hp_detect_ctl;
	142	struct snd_kcontrol *lineout_sw_ctl;
1da177e4 LT	143
1da177e4 LT	144	/* lowlevel callbacks */
65b29f50 TI	145	void (set_format)(struct snd_pmac chip);
	146	void (update_automute)(struct snd_pmac chip, int do_notify);
	147	int (detect_headphone)(struct snd_pmac chip);
8c870933	148	#ifdef CONFIG_PM
65b29f50 TI	149	void (suspend)(struct snd_pmac chip);
65b29f50 TI	150	void (resume)(struct snd_pmac chip);
1da177e4 LT	151	#endif
	152
	153	};
	154
	155
	156	/* exported functions */
65b29f50 TI	157	int snd_pmac_new(struct snd_card card, struct snd_pmac *chip_return);
	158	int snd_pmac_pcm_new(struct snd_pmac *chip);
	159	int snd_pmac_attach_beep(struct snd_pmac *chip);
	160	void snd_pmac_detach_beep(struct snd_pmac *chip);
	161	void snd_pmac_beep_stop(struct snd_pmac *chip);
	162	unsigned int snd_pmac_rate_index(struct snd_pmac chip, struct pmac_stream rec, unsigned int rate);
1da177e4	163
65b29f50 TI	164	void snd_pmac_beep_dma_start(struct snd_pmac *chip, int bytes, unsigned long addr, int speed);
65b29f50 TI	165	void snd_pmac_beep_dma_stop(struct snd_pmac *chip);
1da177e4	166
5e12bea0 TI	167	#ifdef CONFIG_PM
	168	void snd_pmac_suspend(struct snd_pmac *chip);
	169	void snd_pmac_resume(struct snd_pmac *chip);
	170	#endif
	171
1da177e4	172	/* initialize mixer */
65b29f50 TI	173	int snd_pmac_awacs_init(struct snd_pmac *chip);
	174	int snd_pmac_burgundy_init(struct snd_pmac *chip);
	175	int snd_pmac_daca_init(struct snd_pmac *chip);
	176	int snd_pmac_tumbler_init(struct snd_pmac *chip);
1da177e4 LT	177	int snd_pmac_tumbler_post_init(void);
	178
	179	/* i2c functions */
65b29f50	180	struct pmac_keywest {
1da177e4 LT	181	int addr;
	182	struct i2c_client *client;
	183	int id;
65b29f50	184	int (init_client)(struct pmac_keywest i2c);
1da177e4	185	char *name;
65b29f50	186	};
1da177e4	187
65b29f50 TI	188	int snd_pmac_keywest_init(struct pmac_keywest *i2c);
65b29f50 TI	189	void snd_pmac_keywest_cleanup(struct pmac_keywest *i2c);
1da177e4 LT	190
1da177e4 LT	191	/* misc */
a5ce8890 TI	192	#define snd_pmac_boolean_stereo_info snd_ctl_boolean_stereo_info
a5ce8890 TI	193	#define snd_pmac_boolean_mono_info snd_ctl_boolean_mono_info
1da177e4	194
65b29f50	195	int snd_pmac_add_automute(struct snd_pmac *chip);
1da177e4	196
1da177e4	197	#endif /* __PMAC_H */