sound/core/seq/seq_queue.h

   1 /*
   2  *   ALSA sequencer Queue handling
   3  *   Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
   4  *
   5  *   This program is free software; you can redistribute it and/or modify
   6  *   it under the terms of the GNU General Public License as published by
   7  *   the Free Software Foundation; either version 2 of the License, or
   8  *   (at your option) any later version.
   9  *
  10  *   This program is distributed in the hope that it will be useful,
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *   GNU General Public License for more details.
  14  *
  15  *   You should have received a copy of the GNU General Public License
  16  *   along with this program; if not, write to the Free Software
  17  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18  *
  19  */
  20 #ifndef __SND_SEQ_QUEUE_H
  21 #define __SND_SEQ_QUEUE_H
  22
  23 #include "seq_memory.h"
  24 #include "seq_prioq.h"
  25 #include "seq_timer.h"
  26 #include "seq_lock.h"
  27 #include <linux/interrupt.h>
  28 #include <linux/list.h>
  29 #include <linux/bitops.h>
  30
  31 #define SEQ_QUEUE_NO_OWNER (-1)
  32
  33 struct snd_seq_queue {
  34         int queue;              /* queue number */
  35
  36         char name[64];          /* name of this queue */
  37
  38         struct snd_seq_prioq    *tickq;         /* midi tick event queue */
  39         struct snd_seq_prioq    *timeq;         /* real-time event queue */
  40
  41         struct snd_seq_timer *timer;    /* time keeper for this queue */
  42         int     owner;          /* client that 'owns' the timer */
  43         bool    locked;         /* timer is only accesibble by owner if set */
  44         bool    klocked;        /* kernel lock (after START) */
  45         bool    check_again;    /* concurrent access happened during check */
  46         bool    check_blocked;  /* queue being checked */
  47
  48         unsigned int flags;             /* status flags */
  49         unsigned int info_flags;        /* info for sync */
  50
  51         spinlock_t owner_lock;
  52         spinlock_t check_lock;
  53
  54         /* clients which uses this queue (bitmap) */
  55         DECLARE_BITMAP(clients_bitmap, SNDRV_SEQ_MAX_CLIENTS);
  56         unsigned int clients;   /* users of this queue */
  57         struct mutex timer_mutex;
  58
  59         snd_use_lock_t use_lock;
  60 };
  61
  62
  63 /* get the number of current queues */
  64 int snd_seq_queue_get_cur_queues(void);
  65
  66 /* delete queues */
  67 void snd_seq_queues_delete(void);
  68
  69
  70 /* create new queue (constructor) */
  71 struct snd_seq_queue *snd_seq_queue_alloc(int client, int locked, unsigned int flags);
  72
  73 /* delete queue (destructor) */
  74 int snd_seq_queue_delete(int client, int queueid);
  75
  76 /* notification that client has left the system */
  77 void snd_seq_queue_client_termination(int client);
  78
  79 /* final stage */
  80 void snd_seq_queue_client_leave(int client);
  81
  82 /* enqueue a event received from one the clients */
  83 int snd_seq_enqueue_event(struct snd_seq_event_cell *cell, int atomic, int hop);
  84
  85 /* Remove events */
  86 void snd_seq_queue_client_leave_cells(int client);
  87 void snd_seq_queue_remove_cells(int client, struct snd_seq_remove_events *info);
  88
  89 /* return pointer to queue structure for specified id */
  90 struct snd_seq_queue *queueptr(int queueid);
  91 /* unlock */
  92 #define queuefree(q) snd_use_lock_free(&(q)->use_lock)
  93
  94 /* return the (first) queue matching with the specified name */
  95 struct snd_seq_queue *snd_seq_queue_find_name(char *name);
  96
  97 /* check single queue and dispatch events */
  98 void snd_seq_check_queue(struct snd_seq_queue *q, int atomic, int hop);
  99
 100 /* access to queue's parameters */
 101 int snd_seq_queue_check_access(int queueid, int client);
 102 int snd_seq_queue_timer_set_tempo(int queueid, int client, struct snd_seq_queue_tempo *info);
 103 int snd_seq_queue_set_owner(int queueid, int client, int locked);
 104 int snd_seq_queue_set_locked(int queueid, int client, int locked);
 105 int snd_seq_queue_timer_open(int queueid);
 106 int snd_seq_queue_timer_close(int queueid);
 107 int snd_seq_queue_use(int queueid, int client, int use);
 108 int snd_seq_queue_is_used(int queueid, int client);
 109
 110 int snd_seq_control_queue(struct snd_seq_event *ev, int atomic, int hop);
 111
 112 #endif