Home | History | Annotate | Line # | Download | only in dev
midictl.c revision 1.6.32.2
      1  1.6.32.2       mrg /* $NetBSD: midictl.c,v 1.6.32.2 2011/11/22 06:11:12 mrg Exp $ */
      2       1.2      chap 
      3       1.2      chap /*-
      4  1.6.32.1  jmcneill  * Copyright (c) 2006, 2008 The NetBSD Foundation, Inc.
      5       1.2      chap  * All rights reserved.
      6       1.2      chap  *
      7       1.2      chap  * This code is derived from software contributed to The NetBSD Foundation
      8  1.6.32.1  jmcneill  * by Chapman Flack, and by Andrew Doran.
      9       1.2      chap  *
     10       1.2      chap  * Redistribution and use in source and binary forms, with or without
     11       1.2      chap  * modification, are permitted provided that the following conditions
     12       1.2      chap  * are met:
     13       1.2      chap  * 1. Redistributions of source code must retain the above copyright
     14       1.2      chap  *    notice, this list of conditions and the following disclaimer.
     15       1.2      chap  * 2. Redistributions in binary form must reproduce the above copyright
     16       1.2      chap  *    notice, this list of conditions and the following disclaimer in the
     17       1.2      chap  *    documentation and/or other materials provided with the distribution.
     18       1.2      chap  *
     19       1.2      chap  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20       1.2      chap  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21       1.2      chap  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22       1.2      chap  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23       1.2      chap  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24       1.2      chap  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25       1.2      chap  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26       1.2      chap  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27       1.2      chap  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28       1.2      chap  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29       1.2      chap  * POSSIBILITY OF SUCH DAMAGE.
     30       1.2      chap  */
     31       1.2      chap #include <sys/cdefs.h>
     32  1.6.32.2       mrg __KERNEL_RCSID(0, "$NetBSD: midictl.c,v 1.6.32.2 2011/11/22 06:11:12 mrg Exp $");
     33       1.2      chap 
     34       1.2      chap /*
     35       1.2      chap  * See midictl.h for an overview of the purpose and use of this module.
     36       1.2      chap  */
     37       1.2      chap 
     38       1.2      chap #include <sys/systm.h>
     39       1.2      chap #include <sys/types.h>
     40  1.6.32.1  jmcneill #include <sys/param.h>
     41  1.6.32.1  jmcneill #include <sys/kernel.h>
     42  1.6.32.1  jmcneill #include <sys/kthread.h>
     43  1.6.32.1  jmcneill #include <sys/kmem.h>
     44       1.2      chap 
     45       1.2      chap #include "midictl.h"
     46       1.2      chap 
     47       1.2      chap /*
     48       1.2      chap  * The upper part of this file is MIDI-aware, and deals with things like
     49       1.2      chap  * decoding MIDI Control Change messages, dealing with the ones that require
     50       1.2      chap  * special handling as mode messages or parameter updates, and so on.
     51       1.2      chap  *
     52       1.2      chap  * It relies on a "store" layer (implemented in the lower part of this file)
     53       1.2      chap  * that only must be able to stash away 2-, 8-, or 16-bit quantities (which
     54       1.2      chap  * it may pack into larger units as it sees fit) and find them again given
     55       1.2      chap  * a class, channel, and key (controller/parameter number).
     56       1.2      chap  *
     57       1.2      chap  * The MIDI controllers can have 1-, 7-, or 14-bit values; the parameters are
     58       1.2      chap  * also 14-bit. The 14-bit values have to be set in two MIDI messages, 7 bits
     59       1.2      chap  * at a time. The MIDI layer uses store-managed 2- or 8-bit slots for the
     60       1.2      chap  * smaller types, and uses the free high bit to indicate that it has explicitly
     61       1.2      chap  * set the value. (Because the store is allowed to pack things, it may 'find'
     62       1.2      chap  * a zero entry for a value we never set, because it shares a word with a
     63       1.2      chap  * different value that has been set. We know it is not a real value because
     64       1.2      chap  * the high bit is clear.)
     65       1.2      chap  *
     66       1.2      chap  * The 14-bit values are handled similarly: 16-bit store slots are used to hold
     67       1.2      chap  * them, with the two free high bits indicating independently whether the MSB
     68       1.2      chap  * and the LSB have been explicitly set--as two separate MIDI messages are
     69       1.2      chap  * required. If such a control is queried when only one half has been explicitly
     70       1.2      chap  * set, the result is as if it had been set to the specified default value
     71       1.2      chap  * before the explicit set.
     72       1.2      chap  */
     73       1.2      chap 
     74       1.2      chap typedef enum { CTL1, CTL7, CTL14, RPN, NRPN } class;
     75       1.2      chap 
     76       1.2      chap /*
     77       1.2      chap  * assert(does_not_apply(KNFNamespaceArgumentAgainstNamesInPrototypes,
     78       1.2      chap  *    PrototypesOfStaticFunctionsWithinNonIncludedFile));
     79       1.2      chap  */
     80       1.2      chap static void reset_all_controllers(midictl *mc, uint_fast8_t chan);
     81       1.2      chap static void enter14(midictl *mc, uint_fast8_t chan, class c,
     82       1.2      chap                     uint_fast16_t key, _Bool islsb, uint8_t val);
     83       1.2      chap static uint_fast16_t read14(midictl *mc, uint_fast8_t chan, class c,
     84       1.2      chap                             uint_fast16_t key, uint_fast16_t dflt);
     85       1.2      chap static class classify(uint_fast16_t *key, _Bool *islsb);
     86       1.2      chap static midictl_notify notify_no_one;
     87       1.2      chap 
     88       1.2      chap static _Bool store_locate(midictl_store *s, class c,
     89       1.2      chap                             uint_fast8_t chan, uint_fast16_t key);
     90       1.2      chap /*
     91       1.2      chap  * store_extract and store_update operate on the bucket most recently found
     92       1.2      chap  * by store_locate on this store. That works because reentrancy of midictl
     93       1.2      chap  * functions is limited: they /can/ be reentered during midictl_notify
     94       1.2      chap  * callbacks, but not at other arbitrary times. We never call notify /during/
     95       1.2      chap  * a locate/extract/update transaction.
     96       1.2      chap  */
     97       1.2      chap static uint16_t store_extract(midictl_store *s, class c,
     98       1.2      chap                               uint_fast8_t chan, uint_fast16_t key);
     99       1.2      chap static void store_update(midictl_store *s, class c,
    100       1.2      chap                          uint_fast8_t chan, uint_fast16_t key, uint16_t value);
    101       1.2      chap 
    102       1.2      chap #define PN_SET 0x8000  /* a parameter number has been explicitly set */
    103       1.2      chap #define C14MSET 0x8000 /* MSB of a 14-bit val has been set */
    104       1.2      chap #define C14LSET 0x4000 /* LSB of a 14-bit val has been set */
    105       1.2      chap #define C7_SET 0x80    /* a 7-bit ctl has been set */
    106       1.2      chap #define C1_SET 2       /* a 1-bit ctl has been set */
    107       1.2      chap 
    108  1.6.32.1  jmcneill /*
    109  1.6.32.1  jmcneill  *   I M P L E M E N T A T I O N     O F     T H E     S T O R E :
    110  1.6.32.1  jmcneill  *
    111  1.6.32.1  jmcneill  * MIDI defines a metric plethora of possible controllers, registered
    112  1.6.32.1  jmcneill  * parameters, and nonregistered parameters: a bit more than 32k possible words
    113  1.6.32.1  jmcneill  * to store. The saving grace is that only a handful are likely to appear in
    114  1.6.32.1  jmcneill  * typical MIDI data, and only a handful are likely implemented by or
    115  1.6.32.1  jmcneill  * interesting to a typical client. So the store implementation needs to be
    116  1.6.32.1  jmcneill  * suited to a largish but quite sparse data set.
    117  1.6.32.1  jmcneill  *
    118  1.6.32.1  jmcneill  * A double-hashed, open address table is used here. Each slot is a uint64
    119  1.6.32.1  jmcneill  * that contains the match key (control class|channel|ctl-or-PN-number) as
    120  1.6.32.1  jmcneill  * well as the values for two or more channels. CTL14s, RPNs, and NRPNs can
    121  1.6.32.1  jmcneill  * be packed two channels to the slot; CTL7s, six channels; and CTL1s get all
    122  1.6.32.1  jmcneill  * 16 channels into one slot. The channel value used in the key is the lowest
    123  1.6.32.1  jmcneill  * channel stored in the slot. Open addressing is appropriate here because the
    124  1.6.32.1  jmcneill  * link fields in a chained approach would be at least 100% overhead, and also,
    125  1.6.32.1  jmcneill  * we don't delete (MIDICTL_RESET is the only event that logically deletes
    126  1.6.32.1  jmcneill  * things, and at the moment it does not remove anything from the table, but
    127  1.6.32.1  jmcneill  * zeroes the stored value). If wanted, the deletion algorithm for open
    128  1.6.32.1  jmcneill  * addressing could be used, with shrinking/rehashing when the load factor
    129  1.6.32.1  jmcneill  * drops below 3/8 (1/2 is the current threshold for expansion), and the
    130  1.6.32.1  jmcneill  * rehashing would relieve the fills-with-DELETED problem in most cases. But
    131  1.6.32.1  jmcneill  * for now the table never shrinks while the device is open.
    132  1.6.32.1  jmcneill  */
    133  1.6.32.1  jmcneill 
    134  1.6.32.1  jmcneill struct midictl_store {
    135  1.6.32.1  jmcneill 	uint64_t *table;
    136  1.6.32.1  jmcneill 	uint64_t key;
    137  1.6.32.1  jmcneill 	uint32_t idx;
    138  1.6.32.1  jmcneill 	uint32_t lgcapacity;
    139  1.6.32.1  jmcneill 	uint32_t used;
    140  1.6.32.1  jmcneill 	kcondvar_t cv;
    141  1.6.32.1  jmcneill 	kmutex_t *lock;
    142  1.6.32.1  jmcneill 	bool destroy;
    143       1.2      chap };
    144       1.2      chap 
    145  1.6.32.1  jmcneill #define INITIALLGCAPACITY 6 /* initial capacity 1<<6 */
    146  1.6.32.1  jmcneill #define IS_USED 1<<15
    147  1.6.32.1  jmcneill #define IS_CTL7 1<<14
    148  1.6.32.1  jmcneill 
    149  1.6.32.1  jmcneill #define CTL1SHIFT(chan) (23+((chan)<<1))
    150  1.6.32.1  jmcneill #define CTL7SHIFT(chan) (16+((chan)<<3))
    151  1.6.32.1  jmcneill #define CTLESHIFT(chan) (23+((chan)<<4))
    152       1.2      chap 
    153  1.6.32.1  jmcneill #define	NEED_REHASH(s)	((s)->used * 2 >= 1 << (s)->lgcapacity)
    154  1.6.32.1  jmcneill 
    155  1.6.32.1  jmcneill static uint_fast8_t const packing[] = {
    156  1.6.32.1  jmcneill 	[CTL1 ] = 16, /* 16 * 2 bits ==> 32 bits, all chns in one bucket */
    157  1.6.32.1  jmcneill 	[CTL7 ] =  6, /*  6 * 8 bits ==> 48 bits, 6 chns in one bucket */
    158  1.6.32.1  jmcneill 	[CTL14] =  2, /*  2 *16 bits ==> 32 bits, 2 chns in one bucket */
    159  1.6.32.1  jmcneill 	[RPN  ] =  2,
    160  1.6.32.1  jmcneill 	[NRPN ] =  2
    161       1.2      chap };
    162       1.2      chap 
    163  1.6.32.1  jmcneill static uint32_t store_idx(uint32_t lgcapacity,
    164  1.6.32.1  jmcneill 			  uint64_t *table,
    165  1.6.32.1  jmcneill                           uint64_t key, uint64_t mask);
    166  1.6.32.1  jmcneill static void store_rehash(midictl_store *s);
    167  1.6.32.1  jmcneill static void store_thread(void *);
    168       1.2      chap 
    169  1.6.32.1  jmcneill int
    170       1.2      chap midictl_open(midictl *mc)
    171       1.2      chap {
    172  1.6.32.1  jmcneill 	midictl_store *s;
    173  1.6.32.1  jmcneill 	int error;
    174  1.6.32.1  jmcneill 
    175  1.6.32.1  jmcneill 	if (mc->lock == NULL)
    176  1.6.32.1  jmcneill 		panic("midictl_open: no lock");
    177  1.6.32.1  jmcneill 	if (NULL == mc->notify)
    178       1.2      chap 		mc->notify = notify_no_one;
    179  1.6.32.1  jmcneill 	s = kmem_zalloc(sizeof(*s), KM_SLEEP);
    180  1.6.32.1  jmcneill 	if (s == NULL) {
    181  1.6.32.1  jmcneill 		return ENOMEM;
    182  1.6.32.1  jmcneill 	}
    183  1.6.32.1  jmcneill 	s->lgcapacity = INITIALLGCAPACITY;
    184  1.6.32.1  jmcneill 	s->table = kmem_zalloc(sizeof(*s->table)<<s->lgcapacity, KM_SLEEP);
    185  1.6.32.1  jmcneill 	if (s->table == NULL) {
    186  1.6.32.1  jmcneill 		kmem_free(s->table, sizeof(*s->table)<<s->lgcapacity);
    187  1.6.32.1  jmcneill 		kmem_free(s, sizeof(*s));
    188  1.6.32.1  jmcneill 		return ENOMEM;
    189  1.6.32.1  jmcneill 	}
    190  1.6.32.1  jmcneill 	s->lock = mc->lock;
    191  1.6.32.1  jmcneill 	cv_init(&s->cv, "midictl");
    192  1.6.32.1  jmcneill 	error = kthread_create(PRI_NONE, KTHREAD_MPSAFE, NULL, store_thread,
    193  1.6.32.1  jmcneill 	    s, NULL, "midictl");
    194  1.6.32.1  jmcneill 	if (error != 0) {
    195  1.6.32.1  jmcneill 		printf("midictl: cannot create kthread, error = %d\n", error);
    196  1.6.32.1  jmcneill 		cv_destroy(&s->cv);
    197  1.6.32.1  jmcneill 		kmem_free(s->table, sizeof(*s->table)<<s->lgcapacity);
    198  1.6.32.1  jmcneill 		kmem_free(s, sizeof(*s));
    199  1.6.32.1  jmcneill 		return error;
    200  1.6.32.1  jmcneill 	}
    201  1.6.32.1  jmcneill 	mc->store = s;
    202  1.6.32.1  jmcneill 	return 0;
    203       1.2      chap }
    204       1.2      chap 
    205       1.2      chap void
    206       1.2      chap midictl_close(midictl *mc)
    207       1.2      chap {
    208  1.6.32.1  jmcneill 	midictl_store *s;
    209  1.6.32.2       mrg 	kmutex_t *lock;
    210  1.6.32.1  jmcneill 
    211  1.6.32.1  jmcneill 	s = mc->store;
    212  1.6.32.2       mrg 	lock = s->lock;
    213  1.6.32.1  jmcneill 
    214  1.6.32.2       mrg 	mutex_enter(lock);
    215  1.6.32.1  jmcneill 	s->destroy = true;
    216  1.6.32.1  jmcneill 	cv_broadcast(&s->cv);
    217  1.6.32.2       mrg 	mutex_exit(lock);
    218       1.2      chap }
    219       1.2      chap 
    220       1.2      chap void
    221       1.2      chap midictl_change(midictl *mc, uint_fast8_t chan, uint8_t *ctlval)
    222       1.2      chap {
    223       1.2      chap 	class c;
    224       1.2      chap 	uint_fast16_t key, val;
    225       1.2      chap 	_Bool islsb, present;
    226  1.6.32.1  jmcneill 
    227  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    228       1.2      chap 
    229       1.2      chap 	switch ( ctlval[0] ) {
    230       1.2      chap 	/*
    231       1.2      chap 	 * Channel mode messages:
    232       1.2      chap 	 */
    233       1.2      chap 	case MIDI_CTRL_OMNI_OFF:
    234       1.2      chap 	case MIDI_CTRL_OMNI_ON:
    235       1.2      chap 	case MIDI_CTRL_POLY_OFF:
    236       1.2      chap 	case MIDI_CTRL_POLY_ON:
    237       1.2      chap 		if ( chan != mc->base_channel )
    238       1.2      chap 			return; /* ignored - not on base channel */
    239       1.2      chap 		else
    240       1.2      chap 			return; /* XXX ignored anyway - not implemented yet */
    241       1.2      chap 	case MIDI_CTRL_NOTES_OFF:
    242       1.2      chap 		mc->notify(mc->cookie, MIDICTL_NOTES_OFF, chan, 0);
    243       1.2      chap 		return;
    244       1.2      chap 	case MIDI_CTRL_LOCAL:
    245       1.2      chap 		mc->notify(mc->cookie, MIDICTL_LOCAL, chan, ctlval[1]);
    246       1.2      chap 		return;
    247       1.2      chap 	case MIDI_CTRL_SOUND_OFF:
    248       1.2      chap 		mc->notify(mc->cookie, MIDICTL_SOUND_OFF, chan, 0);
    249       1.2      chap 		return;
    250       1.2      chap 	case MIDI_CTRL_RESET:
    251       1.2      chap 		reset_all_controllers(mc, chan);
    252       1.2      chap 		return;
    253       1.2      chap 	/*
    254       1.2      chap 	 * Control changes to be handled specially:
    255       1.2      chap 	 */
    256       1.2      chap 	case MIDI_CTRL_RPN_LSB:
    257       1.2      chap 		mc-> rpn &= ~0x7f;
    258       1.2      chap 		mc-> rpn |=  PN_SET | (0x7f & ctlval[1]);
    259       1.2      chap 		mc->nrpn &= ~PN_SET;
    260       1.2      chap 		return;
    261       1.2      chap 	case MIDI_CTRL_RPN_MSB:
    262       1.2      chap 		mc-> rpn &= ~0x7f<<7;
    263       1.2      chap 		mc-> rpn |=  PN_SET | (0x7f & ctlval[1])<<7;
    264       1.2      chap 		mc->nrpn &= ~PN_SET;
    265       1.2      chap 		return;
    266       1.2      chap 	case MIDI_CTRL_NRPN_LSB:
    267       1.2      chap 		mc->nrpn &= ~0x7f;
    268       1.2      chap 		mc->nrpn |=  PN_SET | (0x7f & ctlval[1]);
    269       1.2      chap 		mc-> rpn &= ~PN_SET;
    270       1.2      chap 		return;
    271       1.2      chap 	case MIDI_CTRL_NRPN_MSB:
    272       1.2      chap 		mc->nrpn &= ~0x7f<<7;
    273       1.2      chap 		mc->nrpn |=  PN_SET | (0x7f & ctlval[1])<<7;
    274       1.2      chap 		mc-> rpn &= ~PN_SET;
    275       1.2      chap 		return;
    276       1.2      chap 	case MIDI_CTRL_DATA_ENTRY_LSB:
    277       1.2      chap 		islsb = 1;
    278       1.2      chap 		goto whichparm;
    279       1.2      chap 	case MIDI_CTRL_DATA_ENTRY_MSB:
    280       1.2      chap 		islsb = 0;
    281       1.2      chap 	whichparm:
    282       1.2      chap 		if ( 0 == ( (mc->rpn ^ mc->nrpn) & PN_SET ) )
    283       1.2      chap 			return; /* exactly one must be current */
    284       1.2      chap 		if ( mc->rpn & PN_SET ) {
    285       1.2      chap 			key = mc->rpn;
    286       1.2      chap 			c = RPN;
    287       1.2      chap 		} else {
    288       1.2      chap 			key = mc->nrpn;
    289       1.2      chap 			c = NRPN;
    290       1.2      chap 		}
    291       1.2      chap 		key &= 0x3fff;
    292       1.2      chap 		if ( 0x3fff == key ) /* 'null' parm# to lock out changes */
    293       1.2      chap 			return;
    294       1.2      chap 		enter14(mc, chan, c, key, islsb, ctlval[1]);
    295       1.2      chap 		return;
    296       1.2      chap 	case MIDI_CTRL_RPN_INCREMENT: /* XXX for later - these are a PITA to */
    297       1.2      chap 	case MIDI_CTRL_RPN_DECREMENT: /* get right - 'right' varies by param */
    298       1.2      chap 			/* see http://www.midi.org/about-midi/rp18.shtml */
    299       1.2      chap 		return;
    300       1.2      chap 	}
    301       1.2      chap 
    302       1.2      chap 	/*
    303       1.2      chap 	 * Channel mode, RPN, and NRPN operations have been ruled out.
    304       1.2      chap 	 * This is an ordinary control change.
    305       1.2      chap 	 */
    306       1.2      chap 
    307       1.2      chap 	key = ctlval[0];
    308       1.2      chap 	c = classify(&key, &islsb);
    309       1.2      chap 
    310       1.2      chap 	switch ( c ) {
    311       1.2      chap 	case CTL14:
    312       1.2      chap 		enter14(mc, chan, c, key, islsb, ctlval[1]);
    313       1.2      chap 		return;
    314       1.2      chap 	case CTL7:
    315       1.2      chap 		present = store_locate(mc->store, c, chan, key);
    316       1.2      chap 		if ( !mc->accept_any_ctl_rpn ) {
    317       1.2      chap 			if ( !present )
    318       1.2      chap 				break;
    319       1.2      chap 			val = store_extract(mc->store, c, chan, key);
    320       1.2      chap 			if ( !(val&C7_SET) )
    321       1.2      chap 				break;
    322       1.2      chap 		}
    323       1.2      chap 		store_update(mc->store, c, chan, key,
    324       1.2      chap 		    C7_SET | (0x7f & ctlval[1]));
    325       1.2      chap 		mc->notify(mc->cookie, MIDICTL_CTLR, chan, key);
    326       1.2      chap 		return;
    327       1.2      chap 	case CTL1:
    328       1.2      chap 		present = store_locate(mc->store, c, chan, key);
    329       1.2      chap 		if ( !mc->accept_any_ctl_rpn ) {
    330       1.2      chap 			if ( !present )
    331       1.2      chap 				break;
    332       1.2      chap 			val = store_extract(mc->store, c, chan, key);
    333       1.2      chap 			if ( !(val&C1_SET) )
    334       1.2      chap 				break;
    335       1.2      chap 		}
    336       1.2      chap 		store_update(mc->store, c, chan, key,
    337       1.2      chap 		    C1_SET | (ctlval[1]>63));
    338       1.2      chap 		mc->notify(mc->cookie, MIDICTL_CTLR, chan, key);
    339       1.2      chap 		return;
    340       1.2      chap 	case RPN:
    341       1.2      chap 	case NRPN:
    342       1.2      chap 		return; /* won't see these - sop for gcc */
    343       1.2      chap 	}
    344       1.2      chap }
    345       1.2      chap 
    346       1.2      chap uint_fast16_t
    347       1.2      chap midictl_read(midictl *mc, uint_fast8_t chan, uint_fast8_t ctlr,
    348       1.2      chap              uint_fast16_t dflt)
    349       1.2      chap {
    350       1.2      chap 	uint_fast16_t key, val;
    351       1.2      chap 	class c;
    352       1.2      chap 	_Bool islsb, present;
    353  1.6.32.1  jmcneill 
    354  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    355       1.2      chap 
    356       1.2      chap 	key = ctlr;
    357       1.2      chap 	c = classify(&key, &islsb);
    358       1.2      chap 	switch ( c ) {
    359       1.2      chap 	case CTL1:
    360       1.2      chap 		present = store_locate(mc->store, c, chan, key);
    361       1.2      chap 		if ( !present ||
    362       1.2      chap 		    !(C1_SET&(val = store_extract(mc->store, c, chan, key))) ) {
    363       1.2      chap 			val = C1_SET | (dflt > 63); /* convert to boolean */
    364       1.2      chap 			store_update(mc->store, c, chan, key, val);
    365       1.2      chap 		}
    366       1.2      chap 		return (val & 1) ? 127 : 0;
    367       1.2      chap 	case CTL7:
    368       1.2      chap 		present = store_locate(mc->store, c, chan, key);
    369       1.2      chap 		if ( !present ||
    370       1.2      chap 		    !(C7_SET&(val = store_extract(mc->store, c, chan, key))) ) {
    371       1.2      chap 			val = C7_SET | (dflt & 0x7f);
    372       1.2      chap 			store_update(mc->store, c, chan, key, val);
    373       1.2      chap 		}
    374       1.2      chap 		return val & 0x7f;
    375       1.2      chap 	case CTL14:
    376  1.6.32.1  jmcneill 		KASSERT(!islsb);
    377       1.2      chap 		return read14(mc, chan, c, key, dflt);
    378       1.2      chap 	case RPN:
    379       1.2      chap 	case NRPN:
    380       1.2      chap 		break; /* sop for gcc */
    381       1.2      chap 	}
    382       1.2      chap 	return 0; /* sop for gcc */
    383       1.2      chap }
    384       1.2      chap 
    385       1.2      chap uint_fast16_t
    386       1.2      chap midictl_rpn_read(midictl *mc, uint_fast8_t chan, uint_fast16_t ctlr,
    387       1.2      chap                  uint_fast16_t dflt)
    388       1.2      chap {
    389  1.6.32.1  jmcneill 
    390  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    391  1.6.32.1  jmcneill 
    392       1.2      chap 	return read14(mc, chan, RPN, ctlr, dflt);
    393       1.2      chap }
    394       1.2      chap 
    395       1.2      chap uint_fast16_t
    396       1.2      chap midictl_nrpn_read(midictl *mc, uint_fast8_t chan, uint_fast16_t ctlr,
    397       1.2      chap                   uint_fast16_t dflt)
    398       1.2      chap {
    399  1.6.32.1  jmcneill 
    400  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    401  1.6.32.1  jmcneill 
    402       1.2      chap 	return read14(mc, chan, NRPN, ctlr, dflt);
    403       1.2      chap }
    404       1.2      chap 
    405       1.2      chap static void
    406       1.2      chap reset_all_controllers(midictl *mc, uint_fast8_t chan)
    407       1.2      chap {
    408       1.2      chap 	uint_fast16_t ctlr, key;
    409       1.2      chap 	class c;
    410       1.2      chap 	_Bool islsb, present;
    411  1.6.32.1  jmcneill 
    412  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    413       1.2      chap 
    414       1.2      chap 	for ( ctlr = 0 ; ; ++ ctlr ) {
    415       1.2      chap 		switch ( ctlr ) {
    416       1.2      chap 		/*
    417       1.2      chap 		 * exempt by http://www.midi.org/about-midi/rp15.shtml:
    418       1.2      chap 		 */
    419       1.2      chap 		case MIDI_CTRL_BANK_SELECT_MSB:		/* 0 */
    420       1.2      chap 		case MIDI_CTRL_CHANNEL_VOLUME_MSB:	/* 7 */
    421       1.2      chap 		case MIDI_CTRL_PAN_MSB:			/* 10 */
    422       1.2      chap 			continue;
    423       1.2      chap 		case MIDI_CTRL_BANK_SELECT_LSB:		/* 32 */
    424       1.2      chap 			ctlr += 31; /* skip all these LSBs anyway */
    425       1.2      chap 			continue;
    426       1.2      chap 		case MIDI_CTRL_SOUND_VARIATION:		/* 70 */
    427       1.2      chap 			ctlr += 9; /* skip all Sound Controllers */
    428       1.2      chap 			continue;
    429       1.2      chap 		case MIDI_CTRL_EFFECT_DEPTH_1:		/* 91 */
    430       1.2      chap 			goto loop_exit; /* nothing more gets reset */
    431       1.2      chap 		/*
    432       1.2      chap 		 * exempt for our own personal reasons:
    433       1.2      chap 		 */
    434       1.2      chap 		case MIDI_CTRL_DATA_ENTRY_MSB:		/* 6 */
    435       1.2      chap 			continue; /* doesn't go to the store */
    436       1.2      chap 		}
    437       1.2      chap 
    438       1.2      chap 		key = ctlr;
    439       1.2      chap 		c = classify(&key, &islsb);
    440       1.2      chap 
    441       1.2      chap 		present = store_locate(mc->store, c, chan, key);
    442       1.2      chap 		if ( !present )
    443       1.2      chap 			continue;
    444       1.2      chap 		store_update(mc->store, c, chan, key, 0); /* no C*SET */
    445       1.2      chap 	}
    446       1.2      chap loop_exit:
    447       1.2      chap 	mc->notify(mc->cookie, MIDICTL_RESET, chan, 0);
    448       1.2      chap }
    449       1.2      chap 
    450       1.2      chap static void
    451       1.2      chap enter14(midictl *mc, uint_fast8_t chan, class c, uint_fast16_t key,
    452       1.2      chap         _Bool islsb, uint8_t val)
    453       1.2      chap {
    454       1.2      chap 	uint16_t stval;
    455       1.2      chap 	_Bool present;
    456       1.2      chap 
    457  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    458  1.6.32.1  jmcneill 
    459       1.2      chap 	present = store_locate(mc->store, c, chan, key);
    460       1.2      chap 	stval = (present) ? store_extract(mc->store, c, chan, key) : 0;
    461       1.2      chap 	if ( !( stval & (C14MSET|C14LSET) ) ) {
    462       1.2      chap 		if ( !((NRPN==c)? mc->accept_any_nrpn: mc->accept_any_ctl_rpn) )
    463       1.2      chap 			return;
    464       1.2      chap 	}
    465       1.2      chap 	if ( islsb )
    466       1.2      chap 		stval = C14LSET | val | ( stval & ~0x7f );
    467       1.2      chap 	else
    468       1.2      chap 		stval = C14MSET | ( val << 7 ) | ( stval & ~0x3f80 );
    469       1.2      chap 	store_update(mc->store, c, chan, key, stval);
    470       1.2      chap 	mc->notify(mc->cookie, CTL14 == c ? MIDICTL_CTLR
    471       1.2      chap 		             : RPN   == c ? MIDICTL_RPN
    472       1.2      chap 			     : MIDICTL_NRPN, chan, key);
    473       1.2      chap }
    474       1.2      chap 
    475       1.2      chap static uint_fast16_t
    476       1.2      chap read14(midictl *mc, uint_fast8_t chan, class c, uint_fast16_t key,
    477       1.2      chap        uint_fast16_t dflt)
    478       1.2      chap {
    479       1.2      chap 	uint16_t val;
    480       1.2      chap 	_Bool present;
    481  1.6.32.1  jmcneill 
    482  1.6.32.1  jmcneill 	KASSERT(mutex_owned(mc->lock));
    483  1.6.32.1  jmcneill 
    484       1.2      chap 	present = store_locate(mc->store, c, chan, key);
    485       1.2      chap 	if ( !present )
    486       1.2      chap 		goto neitherset;
    487       1.2      chap 
    488       1.2      chap 	val = store_extract(mc->store, c, chan, key);
    489       1.2      chap 	switch ( val & (C14MSET|C14LSET) ) {
    490       1.2      chap 	case C14MSET|C14LSET:
    491       1.2      chap 		return val & 0x3fff;
    492       1.2      chap 	case C14MSET:
    493       1.2      chap 		val = C14LSET | (val & ~0x7f) | (dflt & 0x7f);
    494       1.2      chap 		break;
    495       1.2      chap 	case C14LSET:
    496       1.2      chap 		val = C14MSET | (val & ~0x3f8) | (dflt & 0x3f8);
    497       1.2      chap 		break;
    498       1.2      chap neitherset:
    499       1.2      chap 	case 0:
    500       1.2      chap 		val = C14MSET|C14LSET | (dflt & 0x3fff);
    501       1.2      chap 	}
    502       1.2      chap 	store_update(mc->store, c, chan, key, val);
    503       1.2      chap 	return val & 0x3fff;
    504       1.2      chap }
    505       1.2      chap 
    506       1.2      chap /*
    507       1.2      chap  * Determine the controller class; ranges based on
    508       1.2      chap  * http://www.midi.org/about-midi/table3.shtml dated 1995/1999/2002
    509       1.2      chap  * and viewed 2 June 2006.
    510       1.2      chap  */
    511       1.2      chap static class
    512       1.2      chap classify(uint_fast16_t *key, _Bool *islsb) {
    513       1.2      chap 	if ( *key < 32 ) {
    514       1.2      chap 		*islsb = 0;
    515       1.2      chap 		return CTL14;
    516       1.2      chap 	} else if ( *key < 64 ) {
    517       1.2      chap 		*islsb = 1;
    518       1.2      chap 		*key -= 32;
    519       1.2      chap 		return CTL14;
    520       1.2      chap 	} else if ( *key < 70 ) {
    521       1.2      chap 		return CTL1;
    522       1.2      chap 	}	  	/* 70-84 defined, 85-90 undef'd, 91-95 def'd */
    523       1.2      chap 	return CTL7;	/* 96-101,120- handled above, 102-119 all undef'd */
    524       1.2      chap 		  	/* treat them all as CTL7 */
    525       1.2      chap }
    526       1.2      chap 
    527       1.2      chap static void
    528       1.4  christos notify_no_one(void *cookie, midictl_evt evt,
    529       1.4  christos     uint_fast8_t chan, uint_fast16_t k)
    530       1.2      chap {
    531       1.2      chap }
    532       1.2      chap 
    533       1.2      chap #undef PN_SET
    534       1.2      chap #undef C14MSET
    535       1.2      chap #undef C14LSET
    536       1.2      chap #undef C7_SET
    537       1.2      chap #undef C1_SET
    538       1.2      chap 
    539  1.6.32.1  jmcneill static void
    540  1.6.32.1  jmcneill store_thread(void *arg)
    541       1.2      chap {
    542       1.2      chap 	midictl_store *s;
    543       1.2      chap 
    544  1.6.32.1  jmcneill 	s = arg;
    545  1.6.32.1  jmcneill 
    546  1.6.32.1  jmcneill 	mutex_enter(s->lock);
    547  1.6.32.1  jmcneill 	for (;;) {
    548  1.6.32.1  jmcneill 		if (s->destroy) {
    549  1.6.32.1  jmcneill 			mutex_exit(s->lock);
    550  1.6.32.1  jmcneill 			cv_destroy(&s->cv);
    551  1.6.32.1  jmcneill 			kmem_free(s->table, sizeof(*s->table)<<s->lgcapacity);
    552  1.6.32.1  jmcneill 			kmem_free(s, sizeof(*s));
    553  1.6.32.1  jmcneill 			return;
    554  1.6.32.1  jmcneill 		} else if (NEED_REHASH(s)) {
    555  1.6.32.1  jmcneill 			store_rehash(s);
    556  1.6.32.1  jmcneill 		} else {
    557  1.6.32.1  jmcneill 			cv_wait(&s->cv, s->lock);
    558  1.6.32.1  jmcneill 		}
    559  1.6.32.1  jmcneill 	}
    560       1.2      chap }
    561       1.2      chap 
    562       1.2      chap static _Bool
    563       1.2      chap store_locate(midictl_store *s, class c, uint_fast8_t chan, uint_fast16_t key)
    564       1.2      chap {
    565       1.2      chap 	uint64_t mask;
    566  1.6.32.1  jmcneill 
    567  1.6.32.1  jmcneill 	KASSERT(mutex_owned(s->lock));
    568       1.2      chap 
    569       1.2      chap 	if ( s->used >= 1 << s->lgcapacity )
    570  1.6.32.1  jmcneill 		panic("%s: repeated attempts to expand table failed", __func__);
    571       1.2      chap 
    572       1.2      chap 	chan = packing[c] * (chan/packing[c]);
    573       1.2      chap 
    574       1.2      chap 	if ( CTL7 == c ) {	/* only 16 bits here (key's only 7) */
    575       1.2      chap 		s->key = IS_USED | IS_CTL7 | (chan << 7) | key;
    576       1.2      chap 		mask = 0xffff;
    577       1.2      chap 	} else {		/* use 23 bits (key could be 14) */
    578       1.2      chap 		s->key = (c << 20) | (chan << 16) | IS_USED | key;
    579       1.2      chap 		mask = 0x7fffff;
    580       1.2      chap 	}
    581       1.2      chap 
    582       1.2      chap 	s->idx = store_idx(s->lgcapacity, s->table, s->key, mask);
    583       1.2      chap 
    584       1.2      chap 	if ( !(s->table[s->idx] & IS_USED) )
    585       1.2      chap 		return 0;
    586       1.2      chap 
    587       1.2      chap 	return 1;
    588       1.2      chap }
    589       1.2      chap 
    590       1.2      chap static uint16_t
    591       1.3  christos store_extract(midictl_store *s, class c, uint_fast8_t chan,
    592       1.4  christos     uint_fast16_t key)
    593       1.2      chap {
    594  1.6.32.1  jmcneill 
    595  1.6.32.1  jmcneill 	KASSERT(mutex_owned(s->lock));
    596  1.6.32.1  jmcneill 
    597       1.2      chap 	chan %= packing[c];
    598       1.2      chap 	switch ( c ) {
    599       1.2      chap 	case CTL1:
    600       1.2      chap 		return 3 & (s->table[s->idx]>>CTL1SHIFT(chan));
    601       1.2      chap 	case CTL7:
    602       1.2      chap 		return 0xff & (s->table[s->idx]>>CTL7SHIFT(chan));
    603       1.2      chap 	case CTL14:
    604       1.2      chap 	case RPN:
    605       1.2      chap 	case NRPN:
    606       1.2      chap 		break;
    607       1.2      chap 	}
    608       1.2      chap 	return 0xffff & (s->table[s->idx]>>CTLESHIFT(chan));
    609       1.2      chap }
    610       1.2      chap 
    611       1.2      chap static void
    612       1.2      chap store_update(midictl_store *s, class c, uint_fast8_t chan,
    613       1.4  christos     uint_fast16_t key, uint16_t value)
    614       1.2      chap {
    615       1.2      chap 	uint64_t orig;
    616  1.6.32.1  jmcneill 
    617  1.6.32.1  jmcneill 	KASSERT(mutex_owned(s->lock));
    618       1.2      chap 
    619       1.2      chap 	orig = s->table[s->idx];
    620       1.2      chap 	if ( !(orig & IS_USED) ) {
    621       1.2      chap 		orig = s->key;
    622       1.2      chap 		++ s->used;
    623       1.2      chap 	}
    624       1.2      chap 
    625       1.2      chap 	chan %= packing[c];
    626       1.2      chap 
    627       1.2      chap 	switch ( c ) {
    628       1.2      chap 	case CTL1:
    629       1.2      chap 		orig &= ~(((uint64_t)3)<<CTL1SHIFT(chan));
    630       1.2      chap 		orig |= ((uint64_t)(3 & value)) << CTL1SHIFT(chan);
    631       1.2      chap 		break;
    632       1.2      chap 	case CTL7:
    633       1.2      chap 		orig &= ~(((uint64_t)0xff)<<CTL7SHIFT(chan));
    634       1.2      chap 		orig |= ((uint64_t)(0xff & value)) << CTL7SHIFT(chan);
    635       1.2      chap 		break;
    636       1.2      chap 	case CTL14:
    637       1.2      chap 	case RPN:
    638       1.2      chap 	case NRPN:
    639       1.2      chap 		orig &= ~(((uint64_t)0xffff)<<CTLESHIFT(chan));
    640       1.2      chap 		orig |= ((uint64_t)value) << CTLESHIFT(chan);
    641       1.2      chap 		break;
    642       1.2      chap 	}
    643       1.2      chap 
    644       1.2      chap 	s->table[s->idx] = orig;
    645  1.6.32.1  jmcneill 	if (NEED_REHASH(s))
    646  1.6.32.1  jmcneill 		cv_broadcast(&s->cv);
    647       1.2      chap }
    648       1.2      chap 
    649       1.2      chap static uint32_t
    650       1.6  gmcgarry store_idx(uint32_t lgcapacity, uint64_t *table,
    651       1.2      chap           uint64_t key, uint64_t mask)
    652       1.2      chap {
    653       1.2      chap 	uint32_t val;
    654       1.2      chap 	uint32_t k, h1, h2;
    655       1.2      chap 	int32_t idx;
    656       1.2      chap 
    657       1.2      chap 	k = key;
    658       1.2      chap 
    659       1.2      chap 	h1 = ((k * 0x61c88646) >> (32-lgcapacity)) & ((1<<lgcapacity) - 1);
    660       1.2      chap 	h2 = ((k * 0x9e3779b9) >> (32-lgcapacity)) & ((1<<lgcapacity) - 1);
    661       1.2      chap 	h2 |= 1;
    662       1.2      chap 
    663       1.2      chap 	for ( idx = h1 ;; idx -= h2 ) {
    664       1.2      chap 		if ( idx < 0 )
    665       1.2      chap 			idx += 1<<lgcapacity;
    666       1.2      chap 		val = (uint32_t)(table[idx] & mask);
    667       1.2      chap 		if ( val == k )
    668       1.2      chap 			break;
    669       1.2      chap 		if ( !(val & IS_USED) )
    670       1.2      chap 			break;
    671       1.2      chap 	}
    672       1.2      chap 
    673       1.2      chap 	return idx;
    674       1.2      chap }
    675       1.2      chap 
    676       1.2      chap static void
    677       1.2      chap store_rehash(midictl_store *s)
    678       1.2      chap {
    679  1.6.32.1  jmcneill 	uint64_t *newtbl, *oldtbl, mask;
    680  1.6.32.1  jmcneill 	uint32_t oldlgcap, newlgcap, oidx, nidx;
    681       1.2      chap 
    682  1.6.32.1  jmcneill 	KASSERT(mutex_owned(s->lock));
    683  1.6.32.1  jmcneill 
    684  1.6.32.1  jmcneill 	oldlgcap = s->lgcapacity;
    685  1.6.32.1  jmcneill 	newlgcap = oldlgcap + s->lgcapacity;
    686  1.6.32.1  jmcneill 
    687  1.6.32.1  jmcneill 	mutex_exit(s->lock);
    688  1.6.32.1  jmcneill 	newtbl = kmem_zalloc(sizeof(*newtbl) << newlgcap, KM_SLEEP);
    689  1.6.32.1  jmcneill 	mutex_enter(s->lock);
    690  1.6.32.1  jmcneill 
    691  1.6.32.1  jmcneill 	if (newtbl == NULL) {
    692  1.6.32.1  jmcneill 		kpause("midictl", false, hz, s->lock);
    693  1.6.32.1  jmcneill 		return;
    694  1.6.32.1  jmcneill 	}
    695  1.6.32.1  jmcneill 	if (oldlgcap != s->lgcapacity) {
    696  1.6.32.1  jmcneill 		mutex_exit(s->lock);
    697  1.6.32.1  jmcneill 		kmem_free(newtbl, sizeof(*newtbl) << newlgcap);
    698  1.6.32.1  jmcneill 		mutex_enter(s->lock);
    699  1.6.32.1  jmcneill 		return;
    700  1.6.32.1  jmcneill 	}
    701  1.6.32.1  jmcneill 
    702       1.2      chap 	for ( oidx = 1<<s->lgcapacity ; oidx --> 0 ; ) {
    703  1.6.32.1  jmcneill 		if (!(s->table[oidx] & IS_USED) )
    704       1.2      chap 			continue;
    705       1.2      chap 		if ( s->table[oidx] & IS_CTL7 )
    706       1.2      chap 			mask = 0xffff;
    707       1.2      chap 		else
    708       1.2      chap 			mask = 0x3fffff;
    709  1.6.32.1  jmcneill 		nidx = store_idx(newlgcap, newtbl,
    710  1.6.32.1  jmcneill 		    s->table[oidx] & mask, mask);
    711       1.2      chap 		newtbl[nidx] = s->table[oidx];
    712       1.2      chap 	}
    713  1.6.32.1  jmcneill 	oldtbl = s->table;
    714       1.2      chap 	s->table = newtbl;
    715       1.2      chap 	s->lgcapacity = newlgcap;
    716       1.2      chap 
    717  1.6.32.1  jmcneill 	mutex_exit(s->lock);
    718  1.6.32.1  jmcneill 	kmem_free(oldtbl, sizeof(*oldtbl) << oldlgcap);
    719  1.6.32.1  jmcneill 	mutex_enter(s->lock);
    720       1.2      chap }
    721