spelling fixes
[linux-3.10.git] / sound / core / seq / seq_memory.h
1 /*
2  *  ALSA sequencer Memory Manager
3  *  Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
4  *
5  *
6  *   This program is free software; you can redistribute it and/or modify
7  *   it under the terms of the GNU General Public License as published by
8  *   the Free Software Foundation; either version 2 of the License, or
9  *   (at your option) any later version.
10  *
11  *   This program is distributed in the hope that it will be useful,
12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *   GNU General Public License for more details.
15  *
16  *   You should have received a copy of the GNU General Public License
17  *   along with this program; if not, write to the Free Software
18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19  *
20  */
21 #ifndef __SND_SEQ_MEMORYMGR_H
22 #define __SND_SEQ_MEMORYMGR_H
23
24 #include <sound/seq_kernel.h>
25 #include <linux/poll.h>
26
27 /* container for sequencer event (internal use) */
28 struct snd_seq_event_cell {
29         struct snd_seq_event event;
30         struct snd_seq_pool *pool;                              /* used pool */
31         struct snd_seq_event_cell *next;        /* next cell */
32 };
33
34 /* design note: the pool is a contiguous block of memory, if we dynamicly
35    want to add additional cells to the pool be better store this in another
36    pool as we need to know the base address of the pool when releasing
37    memory. */
38
39 struct snd_seq_pool {
40         struct snd_seq_event_cell *ptr; /* pointer to first event chunk */
41         struct snd_seq_event_cell *free;        /* pointer to the head of the free list */
42
43         int total_elements;     /* pool size actually allocated */
44         atomic_t counter;       /* cells free */
45
46         int size;               /* pool size to be allocated */
47         int room;               /* watermark for sleep/wakeup */
48
49         int closing;
50
51         /* statistics */
52         int max_used;
53         int event_alloc_nopool;
54         int event_alloc_failures;
55         int event_alloc_success;
56
57         /* Write locking */
58         wait_queue_head_t output_sleep;
59
60         /* Pool lock */
61         spinlock_t lock;
62 };
63
64 void snd_seq_cell_free(struct snd_seq_event_cell *cell);
65
66 int snd_seq_event_dup(struct snd_seq_pool *pool, struct snd_seq_event *event,
67                       struct snd_seq_event_cell **cellp, int nonblock, struct file *file);
68
69 /* return number of unused (free) cells */
70 static inline int snd_seq_unused_cells(struct snd_seq_pool *pool)
71 {
72         return pool ? pool->total_elements - atomic_read(&pool->counter) : 0;
73 }
74
75 /* return total number of allocated cells */
76 static inline int snd_seq_total_cells(struct snd_seq_pool *pool)
77 {
78         return pool ? pool->total_elements : 0;
79 }
80
81 /* init pool - allocate events */
82 int snd_seq_pool_init(struct snd_seq_pool *pool);
83
84 /* done pool - free events */
85 int snd_seq_pool_done(struct snd_seq_pool *pool);
86
87 /* create pool */
88 struct snd_seq_pool *snd_seq_pool_new(int poolsize);
89
90 /* remove pool */
91 int snd_seq_pool_delete(struct snd_seq_pool **pool);
92
93 /* init memory */
94 int snd_sequencer_memory_init(void);
95             
96 /* release event memory */
97 void snd_sequencer_memory_done(void);
98
99 /* polling */
100 int snd_seq_pool_poll_wait(struct snd_seq_pool *pool, struct file *file, poll_table *wait);
101
102
103 #endif