ASoC: Add DAPM widget and path data to CODEC driver structure
[linux-2.6.git] / include / sound / rawmidi.h
1 #ifndef __SOUND_RAWMIDI_H
2 #define __SOUND_RAWMIDI_H
3
4 /*
5  *  Abstract layer for MIDI v1.0 stream
6  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24
25 #include <sound/asound.h>
26 #include <linux/interrupt.h>
27 #include <linux/spinlock.h>
28 #include <linux/wait.h>
29 #include <linux/mutex.h>
30
31 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
32 #include "seq_device.h"
33 #endif
34
35 /*
36  *  Raw MIDI interface
37  */
38
39 #define SNDRV_RAWMIDI_DEVICES           8
40
41 #define SNDRV_RAWMIDI_LFLG_OUTPUT       (1<<0)
42 #define SNDRV_RAWMIDI_LFLG_INPUT        (1<<1)
43 #define SNDRV_RAWMIDI_LFLG_OPEN         (3<<0)
44 #define SNDRV_RAWMIDI_LFLG_APPEND       (1<<2)
45
46 struct snd_rawmidi;
47 struct snd_rawmidi_substream;
48 struct snd_seq_port_info;
49 struct pid;
50
51 struct snd_rawmidi_ops {
52         int (*open) (struct snd_rawmidi_substream * substream);
53         int (*close) (struct snd_rawmidi_substream * substream);
54         void (*trigger) (struct snd_rawmidi_substream * substream, int up);
55         void (*drain) (struct snd_rawmidi_substream * substream);
56 };
57
58 struct snd_rawmidi_global_ops {
59         int (*dev_register) (struct snd_rawmidi * rmidi);
60         int (*dev_unregister) (struct snd_rawmidi * rmidi);
61         void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
62                               struct snd_seq_port_info *info);
63 };
64
65 struct snd_rawmidi_runtime {
66         unsigned int drain: 1,  /* drain stage */
67                      oss: 1;    /* OSS compatible mode */
68         /* midi stream buffer */
69         unsigned char *buffer;  /* buffer for MIDI data */
70         size_t buffer_size;     /* size of buffer */
71         size_t appl_ptr;        /* application pointer */
72         size_t hw_ptr;          /* hardware pointer */
73         size_t avail_min;       /* min avail for wakeup */
74         size_t avail;           /* max used buffer for wakeup */
75         size_t xruns;           /* over/underruns counter */
76         /* misc */
77         spinlock_t lock;
78         wait_queue_head_t sleep;
79         /* event handler (new bytes, input only) */
80         void (*event)(struct snd_rawmidi_substream *substream);
81         /* defers calls to event [input] or ops->trigger [output] */
82         struct tasklet_struct tasklet;
83         /* private data */
84         void *private_data;
85         void (*private_free)(struct snd_rawmidi_substream *substream);
86 };
87
88 struct snd_rawmidi_substream {
89         struct list_head list;          /* list of all substream for given stream */
90         int stream;                     /* direction */
91         int number;                     /* substream number */
92         unsigned int opened: 1,         /* open flag */
93                      append: 1,         /* append flag (merge more streams) */
94                      active_sensing: 1; /* send active sensing when close */
95         int use_count;                  /* use counter (for output) */
96         size_t bytes;
97         struct snd_rawmidi *rmidi;
98         struct snd_rawmidi_str *pstr;
99         char name[32];
100         struct snd_rawmidi_runtime *runtime;
101         struct pid *pid;
102         /* hardware layer */
103         struct snd_rawmidi_ops *ops;
104 };
105
106 struct snd_rawmidi_file {
107         struct snd_rawmidi *rmidi;
108         struct snd_rawmidi_substream *input;
109         struct snd_rawmidi_substream *output;
110 };
111
112 struct snd_rawmidi_str {
113         unsigned int substream_count;
114         unsigned int substream_opened;
115         struct list_head substreams;
116 };
117
118 struct snd_rawmidi {
119         struct snd_card *card;
120         struct list_head list;
121         unsigned int device;            /* device number */
122         unsigned int info_flags;        /* SNDRV_RAWMIDI_INFO_XXXX */
123         char id[64];
124         char name[80];
125
126 #ifdef CONFIG_SND_OSSEMUL
127         int ossreg;
128 #endif
129
130         struct snd_rawmidi_global_ops *ops;
131
132         struct snd_rawmidi_str streams[2];
133
134         void *private_data;
135         void (*private_free) (struct snd_rawmidi *rmidi);
136
137         struct mutex open_mutex;
138         wait_queue_head_t open_wait;
139
140         struct snd_info_entry *dev;
141         struct snd_info_entry *proc_entry;
142
143 #if defined(CONFIG_SND_SEQUENCER) || defined(CONFIG_SND_SEQUENCER_MODULE)
144         struct snd_seq_device *seq_dev;
145 #endif
146 };
147
148 /* main rawmidi functions */
149
150 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
151                     int output_count, int input_count,
152                     struct snd_rawmidi **rmidi);
153 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
154                          struct snd_rawmidi_ops *ops);
155
156 /* callbacks */
157
158 void snd_rawmidi_receive_reset(struct snd_rawmidi_substream *substream);
159 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
160                         const unsigned char *buffer, int count);
161 void snd_rawmidi_transmit_reset(struct snd_rawmidi_substream *substream);
162 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
163 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
164                               unsigned char *buffer, int count);
165 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
166 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
167                          unsigned char *buffer, int count);
168
169 /* main midi functions */
170
171 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
172 int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
173                             int mode, struct snd_rawmidi_file *rfile);
174 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
175 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
176                               struct snd_rawmidi_params *params);
177 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
178                              struct snd_rawmidi_params *params);
179 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
180 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
181 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
182 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
183                              unsigned char *buf, long count);
184 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
185                               const unsigned char *buf, long count);
186
187 #endif /* __SOUND_RAWMIDI_H */