1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef __SOUND_EMU8000_H
3#define __SOUND_EMU8000_H
4/*
5 *  Defines for the emu8000 (AWE32/64)
6 *
7 *  Copyright (C) 1999 Steve Ratcliffe
8 *  Copyright (C) 1999-2000 Takashi Iwai <tiwai@suse.de>
9 */
10
11#include <sound/emux_synth.h>
12#include <sound/seq_kernel.h>
13
14/*
15 * Hardware parameters.
16 */
17#define EMU8000_MAX_DRAM (28 * 1024 * 1024) /* Max on-board mem is 28Mb ???*/
18#define EMU8000_DRAM_OFFSET 0x200000	/* Beginning of on board ram */
19#define EMU8000_CHANNELS   32	/* Number of hardware channels */
20#define EMU8000_DRAM_VOICES	30	/* number of normal voices */
21
22/* Flags to set a dma channel to read or write */
23#define EMU8000_RAM_READ   0
24#define EMU8000_RAM_WRITE  1
25#define EMU8000_RAM_CLOSE  2
26#define EMU8000_RAM_MODE_MASK	0x03
27#define EMU8000_RAM_RIGHT	0x10	/* use 'right' DMA channel */
28
29enum {
30	EMU8000_CONTROL_BASS = 0,
31	EMU8000_CONTROL_TREBLE,
32	EMU8000_CONTROL_CHORUS_MODE,
33	EMU8000_CONTROL_REVERB_MODE,
34	EMU8000_CONTROL_FM_CHORUS_DEPTH,
35	EMU8000_CONTROL_FM_REVERB_DEPTH,
36	EMU8000_NUM_CONTROLS,
37};
38
39/*
40 * Structure to hold all state information for the emu8000 driver.
41 *
42 * Note 1: The chip supports 32 channels in hardware this is max_channels
43 * some of the channels may be used for other things so max_channels is
44 * the number in use for wave voices.
45 */
46struct snd_emu8000 {
47
48	struct snd_emux *emu;
49
50	int index;		/* sequencer client index */
51	int seq_ports;		/* number of sequencer ports */
52	int fm_chorus_depth;	/* FM OPL3 chorus depth */
53	int fm_reverb_depth;	/* FM OPL3 reverb depth */
54
55	int mem_size;		/* memory size */
56	unsigned long port1;	/* Port usually base+0 */
57	unsigned long port2;	/* Port usually at base+0x400 */
58	unsigned long port3;	/* Port usually at base+0x800 */
59	struct resource *res_port1;
60	struct resource *res_port2;
61	struct resource *res_port3;
62	unsigned short last_reg;/* Last register command */
63	spinlock_t reg_lock;
64
65	int dram_checked;
66
67	struct snd_card *card;		/* The card that this belongs to */
68
69	int chorus_mode;
70	int reverb_mode;
71	int bass_level;
72	int treble_level;
73
74	struct snd_util_memhdr *memhdr;
75
76	spinlock_t control_lock;
77	struct snd_kcontrol *controls[EMU8000_NUM_CONTROLS];
78
79	struct snd_pcm *pcm; /* pcm on emu8000 wavetable */
80
81};
82
83/* sequencer device id */
84#define SNDRV_SEQ_DEV_ID_EMU8000	"emu8000-synth"
85
86
87/* exported functions */
88int snd_emu8000_new(struct snd_card *card, int device, long port, int seq_ports,
89		    struct snd_seq_device **ret);
90void snd_emu8000_poke(struct snd_emu8000 *emu, unsigned int port, unsigned int reg,
91		      unsigned int val);
92unsigned short snd_emu8000_peek(struct snd_emu8000 *emu, unsigned int port,
93				unsigned int reg);
94void snd_emu8000_poke_dw(struct snd_emu8000 *emu, unsigned int port, unsigned int reg,
95			 unsigned int val);
96unsigned int snd_emu8000_peek_dw(struct snd_emu8000 *emu, unsigned int port,
97				 unsigned int reg);
98void snd_emu8000_dma_chan(struct snd_emu8000 *emu, int ch, int mode);
99
100void snd_emu8000_init_fm(struct snd_emu8000 *emu);
101
102void snd_emu8000_update_chorus_mode(struct snd_emu8000 *emu);
103void snd_emu8000_update_reverb_mode(struct snd_emu8000 *emu);
104void snd_emu8000_update_equalizer(struct snd_emu8000 *emu);
105int snd_emu8000_load_chorus_fx(struct snd_emu8000 *emu, int mode, const void __user *buf, long len);
106int snd_emu8000_load_reverb_fx(struct snd_emu8000 *emu, int mode, const void __user *buf, long len);
107
108#endif /* __SOUND_EMU8000_H */
109