xref: /onnv-gate/usr/src/uts/common/sys/audio.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1999-2001 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_AUDIO_H
28*0Sstevel@tonic-gate #define	_SYS_AUDIO_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #include <sys/types.h>
37*0Sstevel@tonic-gate #include <sys/audioio.h>
38*0Sstevel@tonic-gate 
39*0Sstevel@tonic-gate #define	AUDIO_NAME		"audio support"	/* STREAMS module name */
40*0Sstevel@tonic-gate #define	AUDIO_VERSION		"Rev 1"		/* 1st version of audio arch. */
41*0Sstevel@tonic-gate #define	AUDIO_CONFIGURATION	"Config A"	/* 1st configuration */
42*0Sstevel@tonic-gate #define	AUDIO_MOD_NAME		"Audio Device Support"
43*0Sstevel@tonic-gate 						/* STREAMS modldrv name */
44*0Sstevel@tonic-gate 
45*0Sstevel@tonic-gate #define	AUDIO_PLAY			0x0001		/* output */
46*0Sstevel@tonic-gate #define	AUDIO_RECORD			0x0002		/* input */
47*0Sstevel@tonic-gate #define	AUDIO_BOTH			(AUDIO_PLAY|AUDIO_RECORD)
48*0Sstevel@tonic-gate #define	AUDIO_NO_SLEEP			0x0004
49*0Sstevel@tonic-gate #define	AUDIO_SLEEP			0x0008
50*0Sstevel@tonic-gate 
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate #define	AUDIO_INIT(I, S) {						\
53*0Sstevel@tonic-gate 		uint8_t *__x__;						\
54*0Sstevel@tonic-gate 		for (__x__ = (uint8_t *)(I);				\
55*0Sstevel@tonic-gate 			__x__ < (((uint8_t *)(I)) + (S));		\
56*0Sstevel@tonic-gate 				*__x__++ = (uint8_t)~0);		\
57*0Sstevel@tonic-gate 		}
58*0Sstevel@tonic-gate 
59*0Sstevel@tonic-gate /*
60*0Sstevel@tonic-gate  * Audio support ioctls.
61*0Sstevel@tonic-gate  */
62*0Sstevel@tonic-gate #define	AIOC				('A'<<8)
63*0Sstevel@tonic-gate #define	AUDIO_GET_CH_NUMBER		(AIOC|10)
64*0Sstevel@tonic-gate #define	AUDIO_GET_CH_TYPE		(AIOC|11)
65*0Sstevel@tonic-gate #define	AUDIO_GET_NUM_CHS		(AIOC|12)
66*0Sstevel@tonic-gate #define	AUDIO_GET_AD_DEV		(AIOC|13)
67*0Sstevel@tonic-gate #define	AUDIO_GET_APM_DEV		(AIOC|14)
68*0Sstevel@tonic-gate #define	AUDIO_GET_AS_DEV		(AIOC|15)
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate /*
71*0Sstevel@tonic-gate  * audio_device_type_e	- type of audio device the channel is associated with.
72*0Sstevel@tonic-gate  */
73*0Sstevel@tonic-gate enum audio_device_type {
74*0Sstevel@tonic-gate 	UNDEFINED = 0, AUDIO = 1, AUDIOCTL = 2, WTABLE = 3, MIDI = 4,
75*0Sstevel@tonic-gate 	ATIME = 5, USER1 = 9, USER2 = 10, USER3 = 11
76*0Sstevel@tonic-gate };
77*0Sstevel@tonic-gate typedef enum audio_device_type audio_device_type_e;
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate /*
80*0Sstevel@tonic-gate  * audio_channel_t	- structure holds info on individual channels
81*0Sstevel@tonic-gate  */
82*0Sstevel@tonic-gate struct audio_channel {
83*0Sstevel@tonic-gate 	/*
84*0Sstevel@tonic-gate 	 * Process ID of the process that has this channel open. If this is
85*0Sstevel@tonic-gate 	 * set to 0 then the channel isn't owned by any process and is free.
86*0Sstevel@tonic-gate 	 */
87*0Sstevel@tonic-gate 	pid_t			pid;
88*0Sstevel@tonic-gate 
89*0Sstevel@tonic-gate 	/*
90*0Sstevel@tonic-gate 	 * When a channel is opened it is a given a new minor number, we always
91*0Sstevel@tonic-gate 	 * clone the device. The ch_number is directly related to that new
92*0Sstevel@tonic-gate 	 * minor number. Each open gets a unique channel number.
93*0Sstevel@tonic-gate 	 */
94*0Sstevel@tonic-gate 	uint_t			ch_number;
95*0Sstevel@tonic-gate 
96*0Sstevel@tonic-gate 	/*
97*0Sstevel@tonic-gate 	 * Type of audio device opened. This cloned channel retains that
98*0Sstevel@tonic-gate 	 * type, which determines which Audio Personality Module to use.
99*0Sstevel@tonic-gate 	 */
100*0Sstevel@tonic-gate 	audio_device_type_e	dev_type;
101*0Sstevel@tonic-gate 
102*0Sstevel@tonic-gate 	/*
103*0Sstevel@tonic-gate 	 * Each device type has a state structure which describes the hardware.
104*0Sstevel@tonic-gate 	 * Because each state structure is different we need to know the size
105*0Sstevel@tonic-gate 	 * for apps to allocate the correct space.
106*0Sstevel@tonic-gate 	 */
107*0Sstevel@tonic-gate 	size_t			info_size;
108*0Sstevel@tonic-gate 
109*0Sstevel@tonic-gate 	/*
110*0Sstevel@tonic-gate 	 * The device type's state structure.
111*0Sstevel@tonic-gate 	 */
112*0Sstevel@tonic-gate 	void			*info;
113*0Sstevel@tonic-gate };
114*0Sstevel@tonic-gate typedef struct audio_channel audio_channel_t;
115*0Sstevel@tonic-gate 
116*0Sstevel@tonic-gate #ifdef	__cplusplus
117*0Sstevel@tonic-gate }
118*0Sstevel@tonic-gate #endif
119*0Sstevel@tonic-gate 
120*0Sstevel@tonic-gate #endif	/* _SYS_AUDIO_H */
121