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 #include <linux/workqueue.h>
  31 #include <linux/device.h>
  32
  33 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
  34 #include <sound/seq_device.h>
  35 #endif
  36
  37 /*
  38  *  Raw MIDI interface
  39  */
  40
  41 #define SNDRV_RAWMIDI_DEVICES           8
  42
  43 #define SNDRV_RAWMIDI_LFLG_OUTPUT       (1<<0)
  44 #define SNDRV_RAWMIDI_LFLG_INPUT        (1<<1)
  45 #define SNDRV_RAWMIDI_LFLG_OPEN         (3<<0)
  46 #define SNDRV_RAWMIDI_LFLG_APPEND       (1<<2)
  47
  48 struct snd_rawmidi;
  49 struct snd_rawmidi_substream;
  50 struct snd_seq_port_info;
  51 struct pid;
  52
  53 struct snd_rawmidi_ops {
  54         int (*open) (struct snd_rawmidi_substream * substream);
  55         int (*close) (struct snd_rawmidi_substream * substream);
  56         void (*trigger) (struct snd_rawmidi_substream * substream, int up);
  57         void (*drain) (struct snd_rawmidi_substream * substream);
  58 };
  59
  60 struct snd_rawmidi_global_ops {
  61         int (*dev_register) (struct snd_rawmidi * rmidi);
  62         int (*dev_unregister) (struct snd_rawmidi * rmidi);
  63         void (*get_port_info)(struct snd_rawmidi *rmidi, int number,
  64                               struct snd_seq_port_info *info);
  65 };
  66
  67 struct snd_rawmidi_runtime {
  68         struct snd_rawmidi_substream *substream;
  69         unsigned int drain: 1,  /* drain stage */
  70                      oss: 1;    /* OSS compatible mode */
  71         /* midi stream buffer */
  72         unsigned char *buffer;  /* buffer for MIDI data */
  73         size_t buffer_size;     /* size of buffer */
  74         size_t appl_ptr;        /* application pointer */
  75         size_t hw_ptr;          /* hardware pointer */
  76         size_t avail_min;       /* min avail for wakeup */
  77         size_t avail;           /* max used buffer for wakeup */
  78         size_t xruns;           /* over/underruns counter */
  79         /* misc */
  80         spinlock_t lock;
  81         wait_queue_head_t sleep;
  82         /* event handler (new bytes, input only) */
  83         void (*event)(struct snd_rawmidi_substream *substream);
  84         /* defers calls to event [input] or ops->trigger [output] */
  85         struct work_struct event_work;
  86         /* private data */
  87         void *private_data;
  88         void (*private_free)(struct snd_rawmidi_substream *substream);
  89 };
  90
  91 struct snd_rawmidi_substream {
  92         struct list_head list;          /* list of all substream for given stream */
  93         int stream;                     /* direction */
  94         int number;                     /* substream number */
  95         unsigned int opened: 1,         /* open flag */
  96                      append: 1,         /* append flag (merge more streams) */
  97                      active_sensing: 1; /* send active sensing when close */
  98         int use_count;                  /* use counter (for output) */
  99         size_t bytes;
 100         struct snd_rawmidi *rmidi;
 101         struct snd_rawmidi_str *pstr;
 102         char name[32];
 103         struct snd_rawmidi_runtime *runtime;
 104         struct pid *pid;
 105         /* hardware layer */
 106         const struct snd_rawmidi_ops *ops;
 107 };
 108
 109 struct snd_rawmidi_file {
 110         struct snd_rawmidi *rmidi;
 111         struct snd_rawmidi_substream *input;
 112         struct snd_rawmidi_substream *output;
 113 };
 114
 115 struct snd_rawmidi_str {
 116         unsigned int substream_count;
 117         unsigned int substream_opened;
 118         struct list_head substreams;
 119 };
 120
 121 struct snd_rawmidi {
 122         struct snd_card *card;
 123         struct list_head list;
 124         unsigned int device;            /* device number */
 125         unsigned int info_flags;        /* SNDRV_RAWMIDI_INFO_XXXX */
 126         char id[64];
 127         char name[80];
 128
 129 #ifdef CONFIG_SND_OSSEMUL
 130         int ossreg;
 131 #endif
 132
 133         const struct snd_rawmidi_global_ops *ops;
 134
 135         struct snd_rawmidi_str streams[2];
 136
 137         void *private_data;
 138         void (*private_free) (struct snd_rawmidi *rmidi);
 139
 140         struct mutex open_mutex;
 141         wait_queue_head_t open_wait;
 142
 143         struct device dev;
 144
 145         struct snd_info_entry *proc_entry;
 146
 147 #if IS_ENABLED(CONFIG_SND_SEQUENCER)
 148         struct snd_seq_device *seq_dev;
 149 #endif
 150 };
 151
 152 /* main rawmidi functions */
 153
 154 int snd_rawmidi_new(struct snd_card *card, char *id, int device,
 155                     int output_count, int input_count,
 156                     struct snd_rawmidi **rmidi);
 157 void snd_rawmidi_set_ops(struct snd_rawmidi *rmidi, int stream,
 158                          const struct snd_rawmidi_ops *ops);
 159
 160 /* callbacks */
 161
 162 int snd_rawmidi_receive(struct snd_rawmidi_substream *substream,
 163                         const unsigned char *buffer, int count);
 164 int snd_rawmidi_transmit_empty(struct snd_rawmidi_substream *substream);
 165 int snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
 166                               unsigned char *buffer, int count);
 167 int snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream, int count);
 168 int snd_rawmidi_transmit(struct snd_rawmidi_substream *substream,
 169                          unsigned char *buffer, int count);
 170 int __snd_rawmidi_transmit_peek(struct snd_rawmidi_substream *substream,
 171                               unsigned char *buffer, int count);
 172 int __snd_rawmidi_transmit_ack(struct snd_rawmidi_substream *substream,
 173                                int count);
 174
 175 /* main midi functions */
 176
 177 int snd_rawmidi_info_select(struct snd_card *card, struct snd_rawmidi_info *info);
 178 int snd_rawmidi_kernel_open(struct snd_card *card, int device, int subdevice,
 179                             int mode, struct snd_rawmidi_file *rfile);
 180 int snd_rawmidi_kernel_release(struct snd_rawmidi_file *rfile);
 181 int snd_rawmidi_output_params(struct snd_rawmidi_substream *substream,
 182                               struct snd_rawmidi_params *params);
 183 int snd_rawmidi_input_params(struct snd_rawmidi_substream *substream,
 184                              struct snd_rawmidi_params *params);
 185 int snd_rawmidi_drop_output(struct snd_rawmidi_substream *substream);
 186 int snd_rawmidi_drain_output(struct snd_rawmidi_substream *substream);
 187 int snd_rawmidi_drain_input(struct snd_rawmidi_substream *substream);
 188 long snd_rawmidi_kernel_read(struct snd_rawmidi_substream *substream,
 189                              unsigned char *buf, long count);
 190 long snd_rawmidi_kernel_write(struct snd_rawmidi_substream *substream,
 191                               const unsigned char *buf, long count);
 192
 193 #endif /* __SOUND_RAWMIDI_H */