1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 *   ALSA sequencer Client Manager
4 *   Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl>
5 */
6#ifndef __SND_SEQ_CLIENTMGR_H
7#define __SND_SEQ_CLIENTMGR_H
8
9#include <sound/seq_kernel.h>
10#include <linux/bitops.h>
11#include "seq_fifo.h"
12#include "seq_ports.h"
13#include "seq_lock.h"
14
15/* client manager */
16
17struct snd_seq_user_client {
18	struct file *file;	/* file struct of client */
19	/* ... */
20	struct pid *owner;
21
22	/* fifo */
23	struct snd_seq_fifo *fifo;	/* queue for incoming events */
24	int fifo_pool_size;
25};
26
27struct snd_seq_kernel_client {
28	/* ... */
29	struct snd_card *card;
30};
31
32
33struct snd_seq_client {
34	snd_seq_client_type_t type;
35	unsigned int accept_input: 1,
36		accept_output: 1;
37	unsigned int midi_version;
38	unsigned int user_pversion;
39	char name[64];		/* client name */
40	int number;		/* client number */
41	unsigned int filter;	/* filter flags */
42	DECLARE_BITMAP(event_filter, 256);
43	unsigned short group_filter;
44	snd_use_lock_t use_lock;
45	int event_lost;
46	/* ports */
47	int num_ports;		/* number of ports */
48	struct list_head ports_list_head;
49	rwlock_t ports_lock;
50	struct mutex ports_mutex;
51	struct mutex ioctl_mutex;
52	int convert32;		/* convert 32->64bit */
53	int ump_endpoint_port;
54
55	/* output pool */
56	struct snd_seq_pool *pool;		/* memory pool for this client */
57
58	union {
59		struct snd_seq_user_client user;
60		struct snd_seq_kernel_client kernel;
61	} data;
62
63	/* for UMP */
64	void **ump_info;
65};
66
67/* usage statistics */
68struct snd_seq_usage {
69	int cur;
70	int peak;
71};
72
73
74int client_init_data(void);
75int snd_sequencer_device_init(void);
76void snd_sequencer_device_done(void);
77
78/* get locked pointer to client */
79struct snd_seq_client *snd_seq_client_use_ptr(int clientid);
80
81/* unlock pointer to client */
82#define snd_seq_client_unlock(client) snd_use_lock_free(&(client)->use_lock)
83
84/* dispatch event to client(s) */
85int snd_seq_dispatch_event(struct snd_seq_event_cell *cell, int atomic, int hop);
86
87int snd_seq_kernel_client_write_poll(int clientid, struct file *file, poll_table *wait);
88int snd_seq_client_notify_subscription(int client, int port,
89				       struct snd_seq_port_subscribe *info, int evtype);
90
91int __snd_seq_deliver_single_event(struct snd_seq_client *dest,
92				   struct snd_seq_client_port *dest_port,
93				   struct snd_seq_event *event,
94				   int atomic, int hop);
95
96/* only for OSS sequencer */
97bool snd_seq_client_ioctl_lock(int clientid);
98void snd_seq_client_ioctl_unlock(int clientid);
99
100extern int seq_client_load[15];
101
102/* for internal use between kernel sequencer clients */
103struct snd_seq_client *snd_seq_kernel_client_get(int client);
104void snd_seq_kernel_client_put(struct snd_seq_client *cptr);
105
106static inline bool snd_seq_client_is_ump(struct snd_seq_client *c)
107{
108	return c->midi_version != SNDRV_SEQ_CLIENT_LEGACY_MIDI;
109}
110
111static inline bool snd_seq_client_is_midi2(struct snd_seq_client *c)
112{
113	return c->midi_version == SNDRV_SEQ_CLIENT_UMP_MIDI_2_0;
114}
115
116#endif
117