1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * ALSA sequencer System services Client 4 * Copyright (c) 1998-1999 by Frank van de Pol <fvdpol@coil.demon.nl> 5 */ 6 7 #include <linux/init.h> 8 #include <linux/export.h> 9 #include <linux/slab.h> 10 #include <sound/core.h> 11 #include "seq_system.h" 12 #include "seq_timer.h" 13 #include "seq_queue.h" 14 15 /* internal client that provide system services, access to timer etc. */ 16 17 /* 18 * Port "Timer" 19 * - send tempo /start/stop etc. events to this port to manipulate the 20 * queue's timer. The queue address is specified in 21 * data.queue.queue. 22 * - this port supports subscription. The received timer events are 23 * broadcasted to all subscribed clients. The modified tempo 24 * value is stored on data.queue.value. 25 * The modifier client/port is not send. 26 * 27 * Port "Announce" 28 * - does not receive message 29 * - supports supscription. For each client or port attaching to or 30 * detaching from the system an announcement is send to the subscribed 31 * clients. 32 * 33 * Idea: the subscription mechanism might also work handy for distributing 34 * synchronisation and timing information. In this case we would ideally have 35 * a list of subscribers for each type of sync (time, tick), for each timing 36 * queue. 37 * 38 * NOTE: the queue to be started, stopped, etc. must be specified 39 * in data.queue.addr.queue field. queue is used only for 40 * scheduling, and no longer referred as affected queue. 41 * They are used only for timer broadcast (see above). 42 * -- iwai 43 */ 44 45 46 /* client id of our system client */ 47 static int sysclient = -1; 48 49 /* port id numbers for this client */ 50 static int announce_port = -1; 51 52 /* number of subscriptions to announce port */ 53 static int announce_subscribed; 54 55 56 /* fill standard header data, source port & channel are filled in */ 57 static int setheader(struct snd_seq_event * ev, int client, int port) 58 { 59 if (announce_port < 0 || !announce_subscribed) 60 return -ENODEV; 61 62 memset(ev, 0, sizeof(struct snd_seq_event)); 63 64 ev->flags &= ~SNDRV_SEQ_EVENT_LENGTH_MASK; 65 ev->flags |= SNDRV_SEQ_EVENT_LENGTH_FIXED; 66 67 ev->source.client = sysclient; 68 ev->source.port = announce_port; 69 ev->dest.client = SNDRV_SEQ_ADDRESS_SUBSCRIBERS; 70 71 /* fill data */ 72 /*ev->data.addr.queue = SNDRV_SEQ_ADDRESS_UNKNOWN;*/ 73 ev->data.addr.client = client; 74 ev->data.addr.port = port; 75 76 return 0; 77 } 78 79 80 /* entry points for broadcasting system events */ 81 void snd_seq_system_broadcast(int client, int port, int type) 82 { 83 struct snd_seq_event ev; 84 85 if (setheader(&ev, client, port) < 0) 86 return; 87 ev.type = type; 88 snd_seq_kernel_client_dispatch(sysclient, &ev, 0, 0); 89 } 90 EXPORT_SYMBOL_GPL(snd_seq_system_broadcast); 91 92 /* entry points for broadcasting system events */ 93 int snd_seq_system_notify(int client, int port, struct snd_seq_event *ev) 94 { 95 ev->flags = SNDRV_SEQ_EVENT_LENGTH_FIXED; 96 ev->source.client = sysclient; 97 ev->source.port = announce_port; 98 ev->dest.client = client; 99 ev->dest.port = port; 100 return snd_seq_kernel_client_dispatch(sysclient, ev, 0, 0); 101 } 102 103 /* call-back handler for timer events */ 104 static int event_input_timer(struct snd_seq_event * ev, int direct, void *private_data, int atomic, int hop) 105 { 106 return snd_seq_control_queue(ev, atomic, hop); 107 } 108 109 static int sys_announce_subscribe(void *private_data, 110 struct snd_seq_port_subscribe *info) 111 { 112 announce_subscribed++; 113 return 0; 114 } 115 116 static int sys_announce_unsubscribe(void *private_data, 117 struct snd_seq_port_subscribe *info) 118 { 119 if (snd_BUG_ON(!announce_subscribed)) 120 return 0; 121 announce_subscribed--; 122 return 0; 123 } 124 125 /* register our internal client */ 126 int __init snd_seq_system_client_init(void) 127 { 128 struct snd_seq_port_callback pcallbacks; 129 struct snd_seq_port_info *port; 130 int err; 131 132 port = kzalloc(sizeof(*port), GFP_KERNEL); 133 if (!port) 134 return -ENOMEM; 135 136 memset(&pcallbacks, 0, sizeof(pcallbacks)); 137 pcallbacks.owner = THIS_MODULE; 138 pcallbacks.event_input = event_input_timer; 139 140 /* register client */ 141 sysclient = snd_seq_create_kernel_client(NULL, 0, "System"); 142 if (sysclient < 0) { 143 kfree(port); 144 return sysclient; 145 } 146 147 /* register timer */ 148 strcpy(port->name, "Timer"); 149 port->capability = SNDRV_SEQ_PORT_CAP_WRITE; /* accept queue control */ 150 port->capability |= SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ; /* for broadcast */ 151 port->kernel = &pcallbacks; 152 port->type = 0; 153 port->flags = SNDRV_SEQ_PORT_FLG_GIVEN_PORT; 154 port->addr.client = sysclient; 155 port->addr.port = SNDRV_SEQ_PORT_SYSTEM_TIMER; 156 err = snd_seq_kernel_client_ctl(sysclient, SNDRV_SEQ_IOCTL_CREATE_PORT, 157 port); 158 if (err < 0) 159 goto error_port; 160 161 /* register announcement port */ 162 strcpy(port->name, "Announce"); 163 port->capability = SNDRV_SEQ_PORT_CAP_READ|SNDRV_SEQ_PORT_CAP_SUBS_READ; /* for broadcast only */ 164 pcallbacks.event_input = NULL; 165 pcallbacks.subscribe = sys_announce_subscribe; 166 pcallbacks.unsubscribe = sys_announce_unsubscribe; 167 port->kernel = &pcallbacks; 168 port->type = 0; 169 port->flags = SNDRV_SEQ_PORT_FLG_GIVEN_PORT; 170 port->addr.client = sysclient; 171 port->addr.port = SNDRV_SEQ_PORT_SYSTEM_ANNOUNCE; 172 err = snd_seq_kernel_client_ctl(sysclient, SNDRV_SEQ_IOCTL_CREATE_PORT, 173 port); 174 if (err < 0) 175 goto error_port; 176 announce_port = port->addr.port; 177 178 kfree(port); 179 return 0; 180 181 error_port: 182 snd_seq_system_client_done(); 183 kfree(port); 184 return err; 185 } 186 187 188 /* unregister our internal client */ 189 void snd_seq_system_client_done(void) 190 { 191 int oldsysclient = sysclient; 192 193 if (oldsysclient >= 0) { 194 sysclient = -1; 195 announce_port = -1; 196 snd_seq_delete_kernel_client(oldsysclient); 197 } 198 } 199