summaryrefslogtreecommitdiffstats
path: root/sys/arm/broadcom/bcm2835/vc_vchi_audioserv_defs.h
blob: 143c543859165171f467ba1b731454fc4997bf65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*
 * Copyright (c) 2012, Broadcom Europe Ltd
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the name of the copyright holder nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * $FreeBSD$
 */

#ifndef _VC_AUDIO_DEFS_H_
#define _VC_AUDIO_DEFS_H_

#define VC_AUDIOSERV_MIN_VER 1
#define VC_AUDIOSERV_VER 2

/* FourCC code used for VCHI connection */
#define VC_AUDIO_SERVER_NAME  MAKE_FOURCC("AUDS")

/* Maximum message length */
#define VC_AUDIO_MAX_MSG_LEN  (sizeof( VC_AUDIO_MSG_T ))

/* 
 * List of screens that are currently supported
 * All message types supported for HOST->VC direction
 */
typedef enum
{
	VC_AUDIO_MSG_TYPE_RESULT,	/* Generic result */
	VC_AUDIO_MSG_TYPE_COMPLETE,	/* playback of samples complete */
	VC_AUDIO_MSG_TYPE_CONFIG,	/* Configure */
	VC_AUDIO_MSG_TYPE_CONTROL,	/* control  */
	VC_AUDIO_MSG_TYPE_OPEN,		/*  open */
	VC_AUDIO_MSG_TYPE_CLOSE,	/* close/shutdown */
	VC_AUDIO_MSG_TYPE_START,	/* start output (i.e. resume) */
	VC_AUDIO_MSG_TYPE_STOP,		/* stop output (i.e. pause) */
	VC_AUDIO_MSG_TYPE_WRITE,	/* write samples */
	VC_AUDIO_MSG_TYPE_MAX

} VC_AUDIO_MSG_TYPE;

static const char *vc_audio_msg_type_names[] = {
	"VC_AUDIO_MSG_TYPE_RESULT",
	"VC_AUDIO_MSG_TYPE_COMPLETE",
	"VC_AUDIO_MSG_TYPE_CONFIG",
	"VC_AUDIO_MSG_TYPE_CONTROL",
	"VC_AUDIO_MSG_TYPE_OPEN",
	"VC_AUDIO_MSG_TYPE_CLOSE",
	"VC_AUDIO_MSG_TYPE_START",
	"VC_AUDIO_MSG_TYPE_STOP",
	"VC_AUDIO_MSG_TYPE_WRITE",
	"VC_AUDIO_MSG_TYPE_MAX"
};

/* configure the audio */
typedef struct
{
	uint32_t channels;
	uint32_t samplerate;
	uint32_t bps;

} VC_AUDIO_CONFIG_T;

typedef struct
{
	uint32_t volume;
	uint32_t dest;

} VC_AUDIO_CONTROL_T;

typedef struct
{
	uint32_t dummy;

} VC_AUDIO_OPEN_T;

typedef struct
{
	uint32_t dummy;

} VC_AUDIO_CLOSE_T;

typedef struct
{
	uint32_t dummy;

} VC_AUDIO_START_T;

typedef struct
{
	uint32_t draining;

} VC_AUDIO_STOP_T;

typedef struct
{
	uint32_t count; /* in bytes */
	void *callback;
	void *cookie;
	uint16_t silence;
	uint16_t max_packet;
} VC_AUDIO_WRITE_T;

/* Generic result for a request (VC->HOST) */
typedef struct
{
	int32_t success;  /* Success value */

} VC_AUDIO_RESULT_T;

/* Generic result for a request (VC->HOST) */
typedef struct
{
	int32_t count;  /* Success value */
	void *callback;
	void *cookie;
} VC_AUDIO_COMPLETE_T;

/* Message header for all messages in HOST->VC direction */
typedef struct
{
	int32_t type;     /* Message type (VC_AUDIO_MSG_TYPE) */
	union
	{
		VC_AUDIO_CONFIG_T	config;
		VC_AUDIO_CONTROL_T	control;
		VC_AUDIO_OPEN_T		open;
		VC_AUDIO_CLOSE_T	close;
		VC_AUDIO_START_T	start;
		VC_AUDIO_STOP_T		stop;
		VC_AUDIO_WRITE_T	write;
		VC_AUDIO_RESULT_T	result;
		VC_AUDIO_COMPLETE_T	complete;
	} u;
} VC_AUDIO_MSG_T;

#endif /* _VC_AUDIO_DEFS_H_ */
OpenPOWER on IntegriCloud