xref: /openbmc/linux/sound/oss/dmasound/dmasound.h (revision 206204a1)
1 #ifndef _dmasound_h_
2 /*
3  *  linux/sound/oss/dmasound/dmasound.h
4  *
5  *
6  *  Minor numbers for the sound driver.
7  *
8  *  Unfortunately Creative called the codec chip of SB as a DSP. For this
9  *  reason the /dev/dsp is reserved for digitized audio use. There is a
10  *  device for true DSP processors but it will be called something else.
11  *  In v3.0 it's /dev/sndproc but this could be a temporary solution.
12  */
13 #define _dmasound_h_
14 
15 #include <linux/types.h>
16 
17 #define SND_NDEVS	256	/* Number of supported devices */
18 #define SND_DEV_CTL	0	/* Control port /dev/mixer */
19 #define SND_DEV_SEQ	1	/* Sequencer output /dev/sequencer (FM
20 				   synthesizer and MIDI output) */
21 #define SND_DEV_MIDIN	2	/* Raw midi access */
22 #define SND_DEV_DSP	3	/* Digitized voice /dev/dsp */
23 #define SND_DEV_AUDIO	4	/* Sparc compatible /dev/audio */
24 #define SND_DEV_DSP16	5	/* Like /dev/dsp but 16 bits/sample */
25 #define SND_DEV_STATUS	6	/* /dev/sndstat */
26 /* #7 not in use now. Was in 2.4. Free for use after v3.0. */
27 #define SND_DEV_SEQ2	8	/* /dev/sequencer, level 2 interface */
28 #define SND_DEV_SNDPROC 9	/* /dev/sndproc for programmable devices */
29 #define SND_DEV_PSS	SND_DEV_SNDPROC
30 
31 /* switch on various prinks */
32 #define DEBUG_DMASOUND 1
33 
34 #define MAX_AUDIO_DEV	5
35 #define MAX_MIXER_DEV	4
36 #define MAX_SYNTH_DEV	3
37 #define MAX_MIDI_DEV	6
38 #define MAX_TIMER_DEV	3
39 
40 #define MAX_CATCH_RADIUS	10
41 
42 #define le2be16(x)	(((x)<<8 & 0xff00) | ((x)>>8 & 0x00ff))
43 #define le2be16dbl(x)	(((x)<<8 & 0xff00ff00) | ((x)>>8 & 0x00ff00ff))
44 
45 #define IOCTL_IN(arg, ret) \
46 	do { int error = get_user(ret, (int __user *)(arg)); \
47 		if (error) return error; \
48 	} while (0)
49 #define IOCTL_OUT(arg, ret)	ioctl_return((int __user *)(arg), ret)
50 
51 static inline int ioctl_return(int __user *addr, int value)
52 {
53 	return value < 0 ? value : put_user(value, addr);
54 }
55 
56 
57     /*
58      *  Configuration
59      */
60 
61 #undef HAS_8BIT_TABLES
62 
63 #if defined(CONFIG_DMASOUND_ATARI) || defined(CONFIG_DMASOUND_ATARI_MODULE) ||\
64     defined(CONFIG_DMASOUND_PAULA) || defined(CONFIG_DMASOUND_PAULA_MODULE) ||\
65     defined(CONFIG_DMASOUND_Q40) || defined(CONFIG_DMASOUND_Q40_MODULE)
66 #define HAS_8BIT_TABLES
67 #define MIN_BUFFERS	4
68 #define MIN_BUFSIZE	(1<<12)	/* in bytes (- where does this come from ?) */
69 #define MIN_FRAG_SIZE	8	/* not 100% sure about this */
70 #define MAX_BUFSIZE	(1<<17)	/* Limit for Amiga is 128 kb */
71 #define MAX_FRAG_SIZE	15	/* allow *4 for mono-8 => stereo-16 (for multi) */
72 
73 #else /* is pmac and multi is off */
74 
75 #define MIN_BUFFERS	2
76 #define MIN_BUFSIZE	(1<<8)	/* in bytes */
77 #define MIN_FRAG_SIZE	8
78 #define MAX_BUFSIZE	(1<<18)	/* this is somewhat arbitrary for pmac */
79 #define MAX_FRAG_SIZE	16	/* need to allow *4 for mono-8 => stereo-16 */
80 #endif
81 
82 #define DEFAULT_N_BUFFERS 4
83 #define DEFAULT_BUFF_SIZE (1<<15)
84 
85     /*
86      *  Initialization
87      */
88 
89 extern int dmasound_init(void);
90 #ifdef MODULE
91 extern void dmasound_deinit(void);
92 #else
93 #define dmasound_deinit()	do { } while (0)
94 #endif
95 
96 /* description of the set-up applies to either hard or soft settings */
97 
98 typedef struct {
99     int format;		/* AFMT_* */
100     int stereo;		/* 0 = mono, 1 = stereo */
101     int size;		/* 8/16 bit*/
102     int speed;		/* speed */
103 } SETTINGS;
104 
105     /*
106      *  Machine definitions
107      */
108 
109 typedef struct {
110     const char *name;
111     const char *name2;
112     struct module *owner;
113     void *(*dma_alloc)(unsigned int, gfp_t);
114     void (*dma_free)(void *, unsigned int);
115     int (*irqinit)(void);
116 #ifdef MODULE
117     void (*irqcleanup)(void);
118 #endif
119     void (*init)(void);
120     void (*silence)(void);
121     int (*setFormat)(int);
122     int (*setVolume)(int);
123     int (*setBass)(int);
124     int (*setTreble)(int);
125     int (*setGain)(int);
126     void (*play)(void);
127     void (*record)(void);		/* optional */
128     void (*mixer_init)(void);		/* optional */
129     int (*mixer_ioctl)(u_int, u_long);	/* optional */
130     int (*write_sq_setup)(void);	/* optional */
131     int (*read_sq_setup)(void);		/* optional */
132     int (*sq_open)(fmode_t);		/* optional */
133     int (*state_info)(char *, size_t);	/* optional */
134     void (*abort_read)(void);		/* optional */
135     int min_dsp_speed;
136     int max_dsp_speed;
137     int version ;
138     int hardware_afmts ;		/* OSS says we only return h'ware info */
139 					/* when queried via SNDCTL_DSP_GETFMTS */
140     int capabilities ;		/* low-level reply to SNDCTL_DSP_GETCAPS */
141     SETTINGS default_hard ;	/* open() or init() should set something valid */
142     SETTINGS default_soft ;	/* you can make it look like old OSS, if you want to */
143 } MACHINE;
144 
145     /*
146      *  Low level stuff
147      */
148 
149 typedef struct {
150     ssize_t (*ct_ulaw)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
151     ssize_t (*ct_alaw)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
152     ssize_t (*ct_s8)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
153     ssize_t (*ct_u8)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
154     ssize_t (*ct_s16be)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
155     ssize_t (*ct_u16be)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
156     ssize_t (*ct_s16le)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
157     ssize_t (*ct_u16le)(const u_char __user *, size_t, u_char *, ssize_t *, ssize_t);
158 } TRANS;
159 
160 struct sound_settings {
161     MACHINE mach;	/* machine dependent things */
162     SETTINGS hard;	/* hardware settings */
163     SETTINGS soft;	/* software settings */
164     SETTINGS dsp;	/* /dev/dsp default settings */
165     TRANS *trans_write;	/* supported translations */
166     int volume_left;	/* volume (range is machine dependent) */
167     int volume_right;
168     int bass;		/* tone (range is machine dependent) */
169     int treble;
170     int gain;
171     int minDev;		/* minor device number currently open */
172     spinlock_t lock;
173 };
174 
175 extern struct sound_settings dmasound;
176 
177 #ifdef HAS_8BIT_TABLES
178 extern char dmasound_ulaw2dma8[];
179 extern char dmasound_alaw2dma8[];
180 #endif
181 
182     /*
183      *  Mid level stuff
184      */
185 
186 static inline int dmasound_set_volume(int volume)
187 {
188 	return dmasound.mach.setVolume(volume);
189 }
190 
191 static inline int dmasound_set_bass(int bass)
192 {
193 	return dmasound.mach.setBass ? dmasound.mach.setBass(bass) : 50;
194 }
195 
196 static inline int dmasound_set_treble(int treble)
197 {
198 	return dmasound.mach.setTreble ? dmasound.mach.setTreble(treble) : 50;
199 }
200 
201 static inline int dmasound_set_gain(int gain)
202 {
203 	return dmasound.mach.setGain ? dmasound.mach.setGain(gain) : 100;
204 }
205 
206 
207     /*
208      * Sound queue stuff, the heart of the driver
209      */
210 
211 struct sound_queue {
212     /* buffers allocated for this queue */
213     int numBufs;		/* real limits on what the user can have */
214     int bufSize;		/* in bytes */
215     char **buffers;
216 
217     /* current parameters */
218     int locked ;		/* params cannot be modified when != 0 */
219     int user_frags ;		/* user requests this many */
220     int user_frag_size ;	/* of this size */
221     int max_count;		/* actual # fragments <= numBufs */
222     int block_size;		/* internal block size in bytes */
223     int max_active;		/* in-use fragments <= max_count */
224 
225     /* it shouldn't be necessary to declare any of these volatile */
226     int front, rear, count;
227     int rear_size;
228     /*
229      *	The use of the playing field depends on the hardware
230      *
231      *	Atari, PMac: The number of frames that are loaded/playing
232      *
233      *	Amiga: Bit 0 is set: a frame is loaded
234      *	       Bit 1 is set: a frame is playing
235      */
236     int active;
237     wait_queue_head_t action_queue, open_queue, sync_queue;
238     int non_blocking;
239     int busy, syncing, xruns, died;
240 };
241 
242 #define WAKE_UP(queue)		(wake_up_interruptible(&queue))
243 
244 extern struct sound_queue dmasound_write_sq;
245 #define write_sq	dmasound_write_sq
246 
247 extern int dmasound_catchRadius;
248 #define catchRadius	dmasound_catchRadius
249 
250 /* define the value to be put in the byte-swap reg in mac-io
251    when we want it to swap for us.
252 */
253 #define BS_VAL 1
254 
255 #define SW_INPUT_VOLUME_SCALE	4
256 #define SW_INPUT_VOLUME_DEFAULT	(128 / SW_INPUT_VOLUME_SCALE)
257 
258 extern int expand_read_bal;	/* Balance factor for reading */
259 extern uint software_input_volume; /* software implemented recording volume! */
260 
261 #endif /* _dmasound_h_ */
262