xref: /OK3568_Linux_fs/kernel/include/uapi/sound/sb16_csp.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *  Copyright (c) 1999 by Uros Bizjak <uros@kss-loka.si>
4*4882a593Smuzhiyun  *                        Takashi Iwai <tiwai@suse.de>
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  *  SB16ASP/AWE32 CSP control
7*4882a593Smuzhiyun  *
8*4882a593Smuzhiyun  *   This program is free software; you can redistribute it and/or modify
9*4882a593Smuzhiyun  *   it under the terms of the GNU General Public License as published by
10*4882a593Smuzhiyun  *   the Free Software Foundation; either version 2 of the License, or
11*4882a593Smuzhiyun  *   (at your option) any later version.
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  *   This program is distributed in the hope that it will be useful,
14*4882a593Smuzhiyun  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15*4882a593Smuzhiyun  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16*4882a593Smuzhiyun  *   GNU General Public License for more details.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  *   You should have received a copy of the GNU General Public License
19*4882a593Smuzhiyun  *   along with this program; if not, write to the Free Software
20*4882a593Smuzhiyun  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
21*4882a593Smuzhiyun  *
22*4882a593Smuzhiyun  */
23*4882a593Smuzhiyun #ifndef _UAPI__SOUND_SB16_CSP_H
24*4882a593Smuzhiyun #define _UAPI__SOUND_SB16_CSP_H
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun /* CSP modes */
28*4882a593Smuzhiyun #define SNDRV_SB_CSP_MODE_NONE		0x00
29*4882a593Smuzhiyun #define SNDRV_SB_CSP_MODE_DSP_READ	0x01	/* Record from DSP */
30*4882a593Smuzhiyun #define SNDRV_SB_CSP_MODE_DSP_WRITE	0x02	/* Play to DSP */
31*4882a593Smuzhiyun #define SNDRV_SB_CSP_MODE_QSOUND		0x04	/* QSound */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /* CSP load flags */
34*4882a593Smuzhiyun #define SNDRV_SB_CSP_LOAD_FROMUSER	0x01
35*4882a593Smuzhiyun #define SNDRV_SB_CSP_LOAD_INITBLOCK	0x02
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* CSP sample width */
38*4882a593Smuzhiyun #define SNDRV_SB_CSP_SAMPLE_8BIT		0x01
39*4882a593Smuzhiyun #define SNDRV_SB_CSP_SAMPLE_16BIT		0x02
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /* CSP channels */
42*4882a593Smuzhiyun #define SNDRV_SB_CSP_MONO			0x01
43*4882a593Smuzhiyun #define SNDRV_SB_CSP_STEREO		0x02
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun /* CSP rates */
46*4882a593Smuzhiyun #define SNDRV_SB_CSP_RATE_8000		0x01
47*4882a593Smuzhiyun #define SNDRV_SB_CSP_RATE_11025		0x02
48*4882a593Smuzhiyun #define SNDRV_SB_CSP_RATE_22050		0x04
49*4882a593Smuzhiyun #define SNDRV_SB_CSP_RATE_44100		0x08
50*4882a593Smuzhiyun #define SNDRV_SB_CSP_RATE_ALL		0x0f
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun /* CSP running state */
53*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_IDLE		0x00
54*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_LOADED		0x01
55*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_RUNNING		0x02
56*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_PAUSED		0x04
57*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_AUTO		0x08
58*4882a593Smuzhiyun #define SNDRV_SB_CSP_ST_QSOUND		0x10
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun /* maximum QSound value (180 degrees right) */
61*4882a593Smuzhiyun #define SNDRV_SB_CSP_QSOUND_MAX_RIGHT	0x20
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /* maximum microcode RIFF file size */
64*4882a593Smuzhiyun #define SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE	0x3000
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun /* microcode header */
67*4882a593Smuzhiyun struct snd_sb_csp_mc_header {
68*4882a593Smuzhiyun 	char codec_name[16];		/* id name of codec */
69*4882a593Smuzhiyun 	unsigned short func_req;	/* requested function */
70*4882a593Smuzhiyun };
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun /* microcode to be loaded */
73*4882a593Smuzhiyun struct snd_sb_csp_microcode {
74*4882a593Smuzhiyun 	struct snd_sb_csp_mc_header info;
75*4882a593Smuzhiyun 	unsigned char data[SNDRV_SB_CSP_MAX_MICROCODE_FILE_SIZE];
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun /* start CSP with sample_width in mono/stereo */
79*4882a593Smuzhiyun struct snd_sb_csp_start {
80*4882a593Smuzhiyun 	int sample_width;	/* sample width, look above */
81*4882a593Smuzhiyun 	int channels;		/* channels, look above */
82*4882a593Smuzhiyun };
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun /* CSP information */
85*4882a593Smuzhiyun struct snd_sb_csp_info {
86*4882a593Smuzhiyun 	char codec_name[16];		/* id name of codec */
87*4882a593Smuzhiyun 	unsigned short func_nr;		/* function number */
88*4882a593Smuzhiyun 	unsigned int acc_format;	/* accepted PCM formats */
89*4882a593Smuzhiyun 	unsigned short acc_channels;	/* accepted channels */
90*4882a593Smuzhiyun 	unsigned short acc_width;	/* accepted sample width */
91*4882a593Smuzhiyun 	unsigned short acc_rates;	/* accepted sample rates */
92*4882a593Smuzhiyun 	unsigned short csp_mode;	/* CSP mode, see above */
93*4882a593Smuzhiyun 	unsigned short run_channels;	/* current channels  */
94*4882a593Smuzhiyun 	unsigned short run_width;	/* current sample width */
95*4882a593Smuzhiyun 	unsigned short version;		/* version id: 0x10 - 0x1f */
96*4882a593Smuzhiyun 	unsigned short state;		/* state bits */
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun /* HWDEP controls */
100*4882a593Smuzhiyun /* get CSP information */
101*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_INFO		_IOR('H', 0x10, struct snd_sb_csp_info)
102*4882a593Smuzhiyun /* load microcode to CSP */
103*4882a593Smuzhiyun /* NOTE: struct snd_sb_csp_microcode overflows the max size (13 bits)
104*4882a593Smuzhiyun  * defined for some architectures like MIPS, and it leads to build errors.
105*4882a593Smuzhiyun  * (x86 and co have 14-bit size, thus it's valid, though.)
106*4882a593Smuzhiyun  * As a workaround for skipping the size-limit check, here we don't use the
107*4882a593Smuzhiyun  * normal _IOW() macro but _IOC() with the manual argument.
108*4882a593Smuzhiyun  */
109*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_LOAD_CODE	\
110*4882a593Smuzhiyun 	_IOC(_IOC_WRITE, 'H', 0x11, sizeof(struct snd_sb_csp_microcode))
111*4882a593Smuzhiyun /* unload microcode from CSP */
112*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_UNLOAD_CODE	_IO('H', 0x12)
113*4882a593Smuzhiyun /* start CSP */
114*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_START		_IOW('H', 0x13, struct snd_sb_csp_start)
115*4882a593Smuzhiyun /* stop CSP */
116*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_STOP		_IO('H', 0x14)
117*4882a593Smuzhiyun /* pause CSP and DMA transfer */
118*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_PAUSE		_IO('H', 0x15)
119*4882a593Smuzhiyun /* restart CSP and DMA transfer */
120*4882a593Smuzhiyun #define SNDRV_SB_CSP_IOCTL_RESTART	_IO('H', 0x16)
121*4882a593Smuzhiyun 
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun #endif /* _UAPI__SOUND_SB16_CSP_H */
124