-
Notifications
You must be signed in to change notification settings - Fork 127
/
Copy pathump.c
1394 lines (1219 loc) · 39.2 KB
/
ump.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// SPDX-License-Identifier: GPL-2.0-or-later
/*
* Universal MIDI Packet (UMP) support
*/
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/export.h>
#include <linux/mm.h>
#include <sound/core.h>
#include <sound/rawmidi.h>
#include <sound/ump.h>
#include <sound/ump_convert.h>
#define ump_err(ump, fmt, args...) dev_err((ump)->core.dev, fmt, ##args)
#define ump_warn(ump, fmt, args...) dev_warn((ump)->core.dev, fmt, ##args)
#define ump_info(ump, fmt, args...) dev_info((ump)->core.dev, fmt, ##args)
#define ump_dbg(ump, fmt, args...) dev_dbg((ump)->core.dev, fmt, ##args)
static int snd_ump_dev_register(struct snd_rawmidi *rmidi);
static int snd_ump_dev_unregister(struct snd_rawmidi *rmidi);
static long snd_ump_ioctl(struct snd_rawmidi *rmidi, unsigned int cmd,
void __user *argp);
static void snd_ump_proc_read(struct snd_info_entry *entry,
struct snd_info_buffer *buffer);
static int snd_ump_rawmidi_open(struct snd_rawmidi_substream *substream);
static int snd_ump_rawmidi_close(struct snd_rawmidi_substream *substream);
static void snd_ump_rawmidi_trigger(struct snd_rawmidi_substream *substream,
int up);
static void snd_ump_rawmidi_drain(struct snd_rawmidi_substream *substream);
static void ump_handle_stream_msg(struct snd_ump_endpoint *ump,
const u32 *buf, int size);
#if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI)
static int process_legacy_output(struct snd_ump_endpoint *ump,
u32 *buffer, int count);
static void process_legacy_input(struct snd_ump_endpoint *ump, const u32 *src,
int words);
static void ump_legacy_set_rawmidi_name(struct snd_ump_endpoint *ump);
static void update_legacy_names(struct snd_ump_endpoint *ump);
#else
static inline int process_legacy_output(struct snd_ump_endpoint *ump,
u32 *buffer, int count)
{
return 0;
}
static inline void process_legacy_input(struct snd_ump_endpoint *ump,
const u32 *src, int words)
{
}
static inline void ump_legacy_set_rawmidi_name(struct snd_ump_endpoint *ump)
{
}
static inline void update_legacy_names(struct snd_ump_endpoint *ump)
{
}
#endif
/* copy a string safely with stripping non-printable letters */
static void safe_copy_string(void *dst, size_t max_dst_size,
const void *src, size_t max_src_size)
{
const unsigned char *s = src;
unsigned char *d = dst;
if (!max_dst_size--)
return;
for (s = src; max_dst_size && *s && max_src_size--; s++) {
if (!isascii(*s) || !isprint(*s))
continue;
*d++ = *s;
max_dst_size--;
}
*d = 0;
}
/* append a string safely with stripping non-printable letters */
static void safe_append_string(void *dst, size_t max_dst_size,
const void *src, size_t max_src_size)
{
unsigned char *d = dst;
size_t len = strlen(d);
safe_copy_string(d + len, max_dst_size - len, src, max_src_size);
}
static const struct snd_rawmidi_global_ops snd_ump_rawmidi_ops = {
.dev_register = snd_ump_dev_register,
.dev_unregister = snd_ump_dev_unregister,
.ioctl = snd_ump_ioctl,
.proc_read = snd_ump_proc_read,
};
static const struct snd_rawmidi_ops snd_ump_rawmidi_input_ops = {
.open = snd_ump_rawmidi_open,
.close = snd_ump_rawmidi_close,
.trigger = snd_ump_rawmidi_trigger,
};
static const struct snd_rawmidi_ops snd_ump_rawmidi_output_ops = {
.open = snd_ump_rawmidi_open,
.close = snd_ump_rawmidi_close,
.trigger = snd_ump_rawmidi_trigger,
.drain = snd_ump_rawmidi_drain,
};
static void snd_ump_endpoint_free(struct snd_rawmidi *rmidi)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(rmidi);
struct snd_ump_block *fb;
while (!list_empty(&ump->block_list)) {
fb = list_first_entry(&ump->block_list, struct snd_ump_block,
list);
list_del(&fb->list);
if (fb->private_free)
fb->private_free(fb);
kfree(fb);
}
if (ump->private_free)
ump->private_free(ump);
#if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI)
kfree(ump->out_cvts);
#endif
}
/**
* snd_ump_endpoint_new - create a UMP Endpoint object
* @card: the card instance
* @id: the id string for rawmidi
* @device: the device index for rawmidi
* @output: 1 for enabling output
* @input: 1 for enabling input
* @ump_ret: the pointer to store the new UMP instance
*
* Creates a new UMP Endpoint object. A UMP Endpoint is tied with one rawmidi
* instance with one input and/or one output rawmidi stream (either uni-
* or bi-directional). A UMP Endpoint may contain one or multiple UMP Blocks
* that consist of one or multiple UMP Groups.
*
* Use snd_rawmidi_set_ops() to set the operators to the new instance.
* Unlike snd_rawmidi_new(), this function sets up the info_flags by itself
* depending on the given @output and @input.
*
* The device has SNDRV_RAWMIDI_INFO_UMP flag set and a different device
* file ("umpCxDx") than a standard MIDI 1.x device ("midiCxDx") is
* created.
*
* Return: Zero if successful, or a negative error code on failure.
*/
int snd_ump_endpoint_new(struct snd_card *card, char *id, int device,
int output, int input,
struct snd_ump_endpoint **ump_ret)
{
unsigned int info_flags = SNDRV_RAWMIDI_INFO_UMP;
struct snd_ump_endpoint *ump;
int err;
if (input)
info_flags |= SNDRV_RAWMIDI_INFO_INPUT;
if (output)
info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT;
if (input && output)
info_flags |= SNDRV_RAWMIDI_INFO_DUPLEX;
ump = kzalloc(sizeof(*ump), GFP_KERNEL);
if (!ump)
return -ENOMEM;
INIT_LIST_HEAD(&ump->block_list);
mutex_init(&ump->open_mutex);
init_waitqueue_head(&ump->stream_wait);
#if IS_ENABLED(CONFIG_SND_UMP_LEGACY_RAWMIDI)
spin_lock_init(&ump->legacy_locks[0]);
spin_lock_init(&ump->legacy_locks[1]);
#endif
err = snd_rawmidi_init(&ump->core, card, id, device,
output, input, info_flags);
if (err < 0) {
snd_rawmidi_free(&ump->core);
return err;
}
ump->info.card = card->number;
ump->info.device = device;
ump->core.private_free = snd_ump_endpoint_free;
ump->core.ops = &snd_ump_rawmidi_ops;
if (input)
snd_rawmidi_set_ops(&ump->core, SNDRV_RAWMIDI_STREAM_INPUT,
&snd_ump_rawmidi_input_ops);
if (output)
snd_rawmidi_set_ops(&ump->core, SNDRV_RAWMIDI_STREAM_OUTPUT,
&snd_ump_rawmidi_output_ops);
ump_dbg(ump, "Created a UMP EP #%d (%s)\n", device, id);
*ump_ret = ump;
return 0;
}
EXPORT_SYMBOL_GPL(snd_ump_endpoint_new);
/*
* Device register / unregister hooks;
* do nothing, placeholders for avoiding the default rawmidi handling
*/
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
static void snd_ump_dev_seq_free(struct snd_seq_device *device)
{
struct snd_ump_endpoint *ump = device->private_data;
ump->seq_dev = NULL;
}
#endif
static int snd_ump_dev_register(struct snd_rawmidi *rmidi)
{
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
struct snd_ump_endpoint *ump = rawmidi_to_ump(rmidi);
int err;
err = snd_seq_device_new(ump->core.card, ump->core.device,
SNDRV_SEQ_DEV_ID_UMP, 0, &ump->seq_dev);
if (err < 0)
return err;
ump->seq_dev->private_data = ump;
ump->seq_dev->private_free = snd_ump_dev_seq_free;
snd_device_register(ump->core.card, ump->seq_dev);
#endif
return 0;
}
static int snd_ump_dev_unregister(struct snd_rawmidi *rmidi)
{
return 0;
}
static struct snd_ump_block *
snd_ump_get_block(struct snd_ump_endpoint *ump, unsigned char id)
{
struct snd_ump_block *fb;
list_for_each_entry(fb, &ump->block_list, list) {
if (fb->info.block_id == id)
return fb;
}
return NULL;
}
/*
* rawmidi ops for UMP endpoint
*/
static int snd_ump_rawmidi_open(struct snd_rawmidi_substream *substream)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(substream->rmidi);
int dir = substream->stream;
int err;
if (ump->substreams[dir])
return -EBUSY;
err = ump->ops->open(ump, dir);
if (err < 0)
return err;
ump->substreams[dir] = substream;
return 0;
}
static int snd_ump_rawmidi_close(struct snd_rawmidi_substream *substream)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(substream->rmidi);
int dir = substream->stream;
ump->substreams[dir] = NULL;
ump->ops->close(ump, dir);
return 0;
}
static void snd_ump_rawmidi_trigger(struct snd_rawmidi_substream *substream,
int up)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(substream->rmidi);
int dir = substream->stream;
ump->ops->trigger(ump, dir, up);
}
static void snd_ump_rawmidi_drain(struct snd_rawmidi_substream *substream)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(substream->rmidi);
if (ump->ops->drain)
ump->ops->drain(ump, SNDRV_RAWMIDI_STREAM_OUTPUT);
}
/* number of 32bit words per message type */
static unsigned char ump_packet_words[0x10] = {
1, 1, 1, 2, 2, 4, 1, 1, 2, 2, 2, 3, 3, 4, 4, 4
};
/**
* snd_ump_receive_ump_val - parse the UMP packet data
* @ump: UMP endpoint
* @val: UMP packet data
*
* The data is copied onto ump->input_buf[].
* When a full packet is completed, returns the number of words (from 1 to 4).
* OTOH, if the packet is incomplete, returns 0.
*/
int snd_ump_receive_ump_val(struct snd_ump_endpoint *ump, u32 val)
{
int words;
if (!ump->input_pending)
ump->input_pending = ump_packet_words[ump_message_type(val)];
ump->input_buf[ump->input_buf_head++] = val;
ump->input_pending--;
if (!ump->input_pending) {
words = ump->input_buf_head;
ump->input_buf_head = 0;
return words;
}
return 0;
}
EXPORT_SYMBOL_GPL(snd_ump_receive_ump_val);
/**
* snd_ump_receive - transfer UMP packets from the device
* @ump: the UMP endpoint
* @buffer: the buffer pointer to transfer
* @count: byte size to transfer
*
* Called from the driver to submit the received UMP packets from the device
* to user-space. It's essentially a wrapper of rawmidi_receive().
* The data to receive is in CPU-native endianness.
*/
int snd_ump_receive(struct snd_ump_endpoint *ump, const u32 *buffer, int count)
{
struct snd_rawmidi_substream *substream;
const u32 *p = buffer;
int n, words = count >> 2;
while (words--) {
n = snd_ump_receive_ump_val(ump, *p++);
if (!n)
continue;
ump_handle_stream_msg(ump, ump->input_buf, n);
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
if (ump->seq_ops)
ump->seq_ops->input_receive(ump, ump->input_buf, n);
#endif
process_legacy_input(ump, ump->input_buf, n);
}
substream = ump->substreams[SNDRV_RAWMIDI_STREAM_INPUT];
if (!substream)
return 0;
return snd_rawmidi_receive(substream, (const char *)buffer, count);
}
EXPORT_SYMBOL_GPL(snd_ump_receive);
/**
* snd_ump_transmit - transmit UMP packets
* @ump: the UMP endpoint
* @buffer: the buffer pointer to transfer
* @count: byte size to transfer
*
* Called from the driver to obtain the UMP packets from user-space to the
* device. It's essentially a wrapper of rawmidi_transmit().
* The data to transmit is in CPU-native endianness.
*/
int snd_ump_transmit(struct snd_ump_endpoint *ump, u32 *buffer, int count)
{
struct snd_rawmidi_substream *substream =
ump->substreams[SNDRV_RAWMIDI_STREAM_OUTPUT];
int err;
if (!substream)
return -ENODEV;
err = snd_rawmidi_transmit(substream, (char *)buffer, count);
/* received either data or an error? */
if (err)
return err;
return process_legacy_output(ump, buffer, count);
}
EXPORT_SYMBOL_GPL(snd_ump_transmit);
/**
* snd_ump_block_new - Create a UMP block
* @ump: UMP object
* @blk: block ID number to create
* @direction: direction (in/out/bidirection)
* @first_group: the first group ID (0-based)
* @num_groups: the number of groups in this block
* @blk_ret: the pointer to store the resultant block object
*/
int snd_ump_block_new(struct snd_ump_endpoint *ump, unsigned int blk,
unsigned int direction, unsigned int first_group,
unsigned int num_groups, struct snd_ump_block **blk_ret)
{
struct snd_ump_block *fb, *p;
if (blk >= SNDRV_UMP_MAX_BLOCKS)
return -EINVAL;
if (snd_ump_get_block(ump, blk))
return -EBUSY;
fb = kzalloc(sizeof(*fb), GFP_KERNEL);
if (!fb)
return -ENOMEM;
fb->ump = ump;
fb->info.card = ump->info.card;
fb->info.device = ump->info.device;
fb->info.block_id = blk;
if (blk >= ump->info.num_blocks)
ump->info.num_blocks = blk + 1;
fb->info.direction = direction;
fb->info.active = 1;
fb->info.first_group = first_group;
fb->info.num_groups = num_groups;
/* fill the default name, may be overwritten to a better name */
snprintf(fb->info.name, sizeof(fb->info.name), "Group %u-%u",
first_group + 1, first_group + num_groups);
/* put the entry in the ordered list */
list_for_each_entry(p, &ump->block_list, list) {
if (p->info.block_id > blk) {
list_add_tail(&fb->list, &p->list);
goto added;
}
}
list_add_tail(&fb->list, &ump->block_list);
added:
ump_dbg(ump, "Created a UMP Block #%d (%s)\n", blk, fb->info.name);
*blk_ret = fb;
return 0;
}
EXPORT_SYMBOL_GPL(snd_ump_block_new);
static int snd_ump_ioctl_block(struct snd_ump_endpoint *ump,
struct snd_ump_block_info __user *argp)
{
struct snd_ump_block *fb;
unsigned char id;
if (get_user(id, &argp->block_id))
return -EFAULT;
fb = snd_ump_get_block(ump, id);
if (!fb)
return -ENOENT;
if (copy_to_user(argp, &fb->info, sizeof(fb->info)))
return -EFAULT;
return 0;
}
/*
* Handle UMP-specific ioctls; called from snd_rawmidi_ioctl()
*/
static long snd_ump_ioctl(struct snd_rawmidi *rmidi, unsigned int cmd,
void __user *argp)
{
struct snd_ump_endpoint *ump = rawmidi_to_ump(rmidi);
switch (cmd) {
case SNDRV_UMP_IOCTL_ENDPOINT_INFO:
if (copy_to_user(argp, &ump->info, sizeof(ump->info)))
return -EFAULT;
return 0;
case SNDRV_UMP_IOCTL_BLOCK_INFO:
return snd_ump_ioctl_block(ump, argp);
default:
ump_dbg(ump, "rawmidi: unknown command = 0x%x\n", cmd);
return -ENOTTY;
}
}
static const char *ump_direction_string(int dir)
{
switch (dir) {
case SNDRV_UMP_DIR_INPUT:
return "input";
case SNDRV_UMP_DIR_OUTPUT:
return "output";
case SNDRV_UMP_DIR_BIDIRECTION:
return "bidirection";
default:
return "unknown";
}
}
static const char *ump_ui_hint_string(int dir)
{
switch (dir) {
case SNDRV_UMP_BLOCK_UI_HINT_RECEIVER:
return "receiver";
case SNDRV_UMP_BLOCK_UI_HINT_SENDER:
return "sender";
case SNDRV_UMP_BLOCK_UI_HINT_BOTH:
return "both";
default:
return "unknown";
}
}
/* Additional proc file output */
static void snd_ump_proc_read(struct snd_info_entry *entry,
struct snd_info_buffer *buffer)
{
struct snd_rawmidi *rmidi = entry->private_data;
struct snd_ump_endpoint *ump = rawmidi_to_ump(rmidi);
struct snd_ump_block *fb;
snd_iprintf(buffer, "EP Name: %s\n", ump->info.name);
snd_iprintf(buffer, "EP Product ID: %s\n", ump->info.product_id);
snd_iprintf(buffer, "UMP Version: 0x%04x\n", ump->info.version);
snd_iprintf(buffer, "Protocol Caps: 0x%08x\n", ump->info.protocol_caps);
snd_iprintf(buffer, "Protocol: 0x%08x\n", ump->info.protocol);
if (ump->info.version) {
snd_iprintf(buffer, "Manufacturer ID: 0x%08x\n",
ump->info.manufacturer_id);
snd_iprintf(buffer, "Family ID: 0x%04x\n", ump->info.family_id);
snd_iprintf(buffer, "Model ID: 0x%04x\n", ump->info.model_id);
snd_iprintf(buffer, "SW Revision: 0x%4phN\n", ump->info.sw_revision);
}
snd_iprintf(buffer, "Static Blocks: %s\n",
(ump->info.flags & SNDRV_UMP_EP_INFO_STATIC_BLOCKS) ? "Yes" : "No");
snd_iprintf(buffer, "Num Blocks: %d\n\n", ump->info.num_blocks);
list_for_each_entry(fb, &ump->block_list, list) {
snd_iprintf(buffer, "Block %d (%s)\n", fb->info.block_id,
fb->info.name);
snd_iprintf(buffer, " Direction: %s\n",
ump_direction_string(fb->info.direction));
snd_iprintf(buffer, " Active: %s\n",
fb->info.active ? "Yes" : "No");
snd_iprintf(buffer, " Groups: %d-%d\n",
fb->info.first_group + 1,
fb->info.first_group + fb->info.num_groups);
snd_iprintf(buffer, " Is MIDI1: %s%s\n",
(fb->info.flags & SNDRV_UMP_BLOCK_IS_MIDI1) ? "Yes" : "No",
(fb->info.flags & SNDRV_UMP_BLOCK_IS_LOWSPEED) ? " (Low Speed)" : "");
if (ump->info.version) {
snd_iprintf(buffer, " MIDI-CI Version: %d\n",
fb->info.midi_ci_version);
snd_iprintf(buffer, " Sysex8 Streams: %d\n",
fb->info.sysex8_streams);
snd_iprintf(buffer, " UI Hint: %s\n",
ump_ui_hint_string(fb->info.ui_hint));
}
snd_iprintf(buffer, "\n");
}
}
/* update dir_bits and active flag for all groups in the client */
void snd_ump_update_group_attrs(struct snd_ump_endpoint *ump)
{
struct snd_ump_block *fb;
struct snd_ump_group *group;
int i;
for (i = 0; i < SNDRV_UMP_MAX_GROUPS; i++) {
group = &ump->groups[i];
*group->name = 0;
group->dir_bits = 0;
group->active = 0;
group->group = i;
group->valid = false;
group->is_midi1 = false;
}
list_for_each_entry(fb, &ump->block_list, list) {
if (fb->info.first_group + fb->info.num_groups > SNDRV_UMP_MAX_GROUPS)
break;
group = &ump->groups[fb->info.first_group];
for (i = 0; i < fb->info.num_groups; i++, group++) {
group->valid = true;
if (fb->info.active)
group->active = 1;
if (fb->info.flags & SNDRV_UMP_BLOCK_IS_MIDI1)
group->is_midi1 = true;
switch (fb->info.direction) {
case SNDRV_UMP_DIR_INPUT:
group->dir_bits |= (1 << SNDRV_RAWMIDI_STREAM_INPUT);
break;
case SNDRV_UMP_DIR_OUTPUT:
group->dir_bits |= (1 << SNDRV_RAWMIDI_STREAM_OUTPUT);
break;
case SNDRV_UMP_DIR_BIDIRECTION:
group->dir_bits |= (1 << SNDRV_RAWMIDI_STREAM_INPUT) |
(1 << SNDRV_RAWMIDI_STREAM_OUTPUT);
break;
}
if (!*fb->info.name)
continue;
if (*group->name)
strlcat(group->name, ", ", sizeof(group->name));
safe_append_string(group->name, sizeof(group->name),
fb->info.name, sizeof(fb->info.name));
}
}
}
EXPORT_SYMBOL_GPL(snd_ump_update_group_attrs);
/*
* UMP endpoint and function block handling
*/
/* open / close UMP streams for the internal stream msg communication */
static int ump_request_open(struct snd_ump_endpoint *ump)
{
return snd_rawmidi_kernel_open(&ump->core, 0,
SNDRV_RAWMIDI_LFLG_OUTPUT,
&ump->stream_rfile);
}
static void ump_request_close(struct snd_ump_endpoint *ump)
{
snd_rawmidi_kernel_release(&ump->stream_rfile);
}
/* request a command and wait for the given response;
* @req1 and @req2 are u32 commands
* @reply is the expected UMP stream status
*/
static int ump_req_msg(struct snd_ump_endpoint *ump, u32 req1, u32 req2,
u32 reply)
{
u32 buf[4];
ump_dbg(ump, "%s: request %08x %08x, wait-for %08x\n",
__func__, req1, req2, reply);
memset(buf, 0, sizeof(buf));
buf[0] = req1;
buf[1] = req2;
ump->stream_finished = 0;
ump->stream_wait_for = reply;
snd_rawmidi_kernel_write(ump->stream_rfile.output,
(unsigned char *)&buf, 16);
wait_event_timeout(ump->stream_wait, ump->stream_finished,
msecs_to_jiffies(500));
if (!READ_ONCE(ump->stream_finished)) {
ump_dbg(ump, "%s: request timed out\n", __func__);
return -ETIMEDOUT;
}
ump->stream_finished = 0;
ump_dbg(ump, "%s: reply: %08x %08x %08x %08x\n",
__func__, buf[0], buf[1], buf[2], buf[3]);
return 0;
}
/* append the received letters via UMP packet to the given string buffer;
* return 1 if the full string is received or 0 to continue
*/
static int ump_append_string(struct snd_ump_endpoint *ump, char *dest,
int maxsize, const u32 *buf, int offset)
{
unsigned char format;
int c;
format = ump_stream_message_format(buf[0]);
if (format == UMP_STREAM_MSG_FORMAT_SINGLE ||
format == UMP_STREAM_MSG_FORMAT_START) {
c = 0;
} else {
c = strlen(dest);
if (c >= maxsize - 1)
return 1;
}
for (; offset < 16; offset++) {
dest[c] = buf[offset / 4] >> (3 - (offset % 4)) * 8;
if (!dest[c])
break;
if (++c >= maxsize - 1)
break;
}
dest[c] = 0;
return (format == UMP_STREAM_MSG_FORMAT_SINGLE ||
format == UMP_STREAM_MSG_FORMAT_END);
}
/* Choose the default protocol */
static void choose_default_protocol(struct snd_ump_endpoint *ump)
{
if (ump->info.protocol & SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK)
return;
if (ump->info.protocol_caps & SNDRV_UMP_EP_INFO_PROTO_MIDI2)
ump->info.protocol |= SNDRV_UMP_EP_INFO_PROTO_MIDI2;
else
ump->info.protocol |= SNDRV_UMP_EP_INFO_PROTO_MIDI1;
}
/* notify the EP info/name change to sequencer */
static void seq_notify_ep_change(struct snd_ump_endpoint *ump)
{
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
if (ump->parsed && ump->seq_ops && ump->seq_ops->notify_ep_change)
ump->seq_ops->notify_ep_change(ump);
#endif
}
/* handle EP info stream message; update the UMP attributes */
static int ump_handle_ep_info_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
ump->info.version = (buf->ep_info.ump_version_major << 8) |
buf->ep_info.ump_version_minor;
ump->info.num_blocks = buf->ep_info.num_function_blocks;
if (ump->info.num_blocks > SNDRV_UMP_MAX_BLOCKS) {
ump_info(ump, "Invalid function blocks %d, fallback to 1\n",
ump->info.num_blocks);
ump->info.num_blocks = 1;
}
if (buf->ep_info.static_function_block)
ump->info.flags |= SNDRV_UMP_EP_INFO_STATIC_BLOCKS;
ump->info.protocol_caps = (buf->ep_info.protocol << 8) |
buf->ep_info.jrts;
ump_dbg(ump, "EP info: version=%x, num_blocks=%x, proto_caps=%x\n",
ump->info.version, ump->info.num_blocks, ump->info.protocol_caps);
ump->info.protocol &= ump->info.protocol_caps;
choose_default_protocol(ump);
seq_notify_ep_change(ump);
return 1; /* finished */
}
/* handle EP device info stream message; update the UMP attributes */
static int ump_handle_device_info_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
ump->info.manufacturer_id = buf->device_info.manufacture_id & 0x7f7f7f;
ump->info.family_id = (buf->device_info.family_msb << 8) |
buf->device_info.family_lsb;
ump->info.model_id = (buf->device_info.model_msb << 8) |
buf->device_info.model_lsb;
ump->info.sw_revision[0] = (buf->device_info.sw_revision >> 24) & 0x7f;
ump->info.sw_revision[1] = (buf->device_info.sw_revision >> 16) & 0x7f;
ump->info.sw_revision[2] = (buf->device_info.sw_revision >> 8) & 0x7f;
ump->info.sw_revision[3] = buf->device_info.sw_revision & 0x7f;
ump_dbg(ump, "EP devinfo: manid=%08x, family=%04x, model=%04x, sw=%4phN\n",
ump->info.manufacturer_id,
ump->info.family_id,
ump->info.model_id,
ump->info.sw_revision);
seq_notify_ep_change(ump);
return 1; /* finished */
}
/* set up the core rawmidi name from UMP EP name string */
static void ump_set_rawmidi_name(struct snd_ump_endpoint *ump)
{
safe_copy_string(ump->core.name, sizeof(ump->core.name),
ump->info.name, sizeof(ump->info.name));
}
/* handle EP name stream message; update the UMP name string */
static int ump_handle_ep_name_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
int ret;
ret = ump_append_string(ump, ump->info.name, sizeof(ump->info.name),
buf->raw, 2);
if (ret && ump->parsed) {
ump_set_rawmidi_name(ump);
ump_legacy_set_rawmidi_name(ump);
seq_notify_ep_change(ump);
}
return ret;
}
/* handle EP product id stream message; update the UMP product_id string */
static int ump_handle_product_id_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
int ret;
ret = ump_append_string(ump, ump->info.product_id,
sizeof(ump->info.product_id),
buf->raw, 2);
if (ret)
seq_notify_ep_change(ump);
return ret;
}
/* notify the protocol change to sequencer */
static void seq_notify_protocol(struct snd_ump_endpoint *ump)
{
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
if (ump->seq_ops && ump->seq_ops->switch_protocol)
ump->seq_ops->switch_protocol(ump);
#endif /* CONFIG_SND_SEQUENCER */
}
/**
* snd_ump_switch_protocol - switch MIDI protocol
* @ump: UMP endpoint
* @protocol: protocol to switch to
*
* Returns 1 if the protocol is actually switched, 0 if unchanged
*/
int snd_ump_switch_protocol(struct snd_ump_endpoint *ump, unsigned int protocol)
{
unsigned int type;
protocol &= ump->info.protocol_caps;
if (protocol == ump->info.protocol)
return 0;
type = protocol & SNDRV_UMP_EP_INFO_PROTO_MIDI_MASK;
if (type != SNDRV_UMP_EP_INFO_PROTO_MIDI1 &&
type != SNDRV_UMP_EP_INFO_PROTO_MIDI2)
return 0;
ump->info.protocol = protocol;
ump_dbg(ump, "New protocol = %x (caps = %x)\n",
protocol, ump->info.protocol_caps);
seq_notify_protocol(ump);
return 1;
}
EXPORT_SYMBOL_GPL(snd_ump_switch_protocol);
/* handle EP stream config message; update the UMP protocol */
static int ump_handle_stream_cfg_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
unsigned int protocol =
(buf->stream_cfg.protocol << 8) | buf->stream_cfg.jrts;
snd_ump_switch_protocol(ump, protocol);
return 1; /* finished */
}
/* Extract Function Block info from UMP packet */
static void fill_fb_info(struct snd_ump_endpoint *ump,
struct snd_ump_block_info *info,
const union snd_ump_stream_msg *buf)
{
info->direction = buf->fb_info.direction;
info->ui_hint = buf->fb_info.ui_hint;
info->first_group = buf->fb_info.first_group;
info->num_groups = buf->fb_info.num_groups;
if (buf->fb_info.midi_10 < 2)
info->flags = buf->fb_info.midi_10;
else
info->flags = SNDRV_UMP_BLOCK_IS_MIDI1 | SNDRV_UMP_BLOCK_IS_LOWSPEED;
info->active = buf->fb_info.active;
info->midi_ci_version = buf->fb_info.midi_ci_version;
info->sysex8_streams = buf->fb_info.sysex8_streams;
ump_dbg(ump, "FB %d: dir=%d, active=%d, first_gp=%d, num_gp=%d, midici=%d, sysex8=%d, flags=0x%x\n",
info->block_id, info->direction, info->active,
info->first_group, info->num_groups, info->midi_ci_version,
info->sysex8_streams, info->flags);
if ((info->flags & SNDRV_UMP_BLOCK_IS_MIDI1) && info->num_groups != 1) {
info->num_groups = 1;
ump_dbg(ump, "FB %d: corrected groups to 1 for MIDI1\n",
info->block_id);
}
}
/* check whether the FB info gets updated by the current message */
static bool is_fb_info_updated(struct snd_ump_endpoint *ump,
struct snd_ump_block *fb,
const union snd_ump_stream_msg *buf)
{
char tmpbuf[offsetof(struct snd_ump_block_info, name)];
if (ump->info.flags & SNDRV_UMP_EP_INFO_STATIC_BLOCKS) {
ump_info(ump, "Skipping static FB info update (blk#%d)\n",
fb->info.block_id);
return 0;
}
memcpy(tmpbuf, &fb->info, sizeof(tmpbuf));
fill_fb_info(ump, (struct snd_ump_block_info *)tmpbuf, buf);
return memcmp(&fb->info, tmpbuf, sizeof(tmpbuf)) != 0;
}
/* notify the FB info/name change to sequencer */
static void seq_notify_fb_change(struct snd_ump_endpoint *ump,
struct snd_ump_block *fb)
{
#if IS_ENABLED(CONFIG_SND_SEQUENCER)
if (ump->seq_ops && ump->seq_ops->notify_fb_change)
ump->seq_ops->notify_fb_change(ump, fb);
#endif
}
/* handle FB info message; update FB info if the block is present */
static int ump_handle_fb_info_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
unsigned char blk;
struct snd_ump_block *fb;
blk = buf->fb_info.function_block_id;
fb = snd_ump_get_block(ump, blk);
/* complain only if updated after parsing */
if (!fb && ump->parsed) {
ump_info(ump, "Function Block Info Update for non-existing block %d\n",
blk);
return -ENODEV;
}
/* When updated after the initial parse, check the FB info update */
if (ump->parsed && !is_fb_info_updated(ump, fb, buf))
return 1; /* no content change */
if (fb) {
fill_fb_info(ump, &fb->info, buf);
if (ump->parsed) {
snd_ump_update_group_attrs(ump);
update_legacy_names(ump);
seq_notify_fb_change(ump, fb);
}
}
return 1; /* finished */
}
/* handle FB name message; update the FB name string */
static int ump_handle_fb_name_msg(struct snd_ump_endpoint *ump,
const union snd_ump_stream_msg *buf)
{
unsigned char blk;
struct snd_ump_block *fb;
int ret;
blk = buf->fb_name.function_block_id;
fb = snd_ump_get_block(ump, blk);
if (!fb)
return -ENODEV;
if (ump->parsed &&
(ump->info.flags & SNDRV_UMP_EP_INFO_STATIC_BLOCKS)) {
ump_dbg(ump, "Skipping static FB name update (blk#%d)\n",
fb->info.block_id);
return 0;
}
ret = ump_append_string(ump, fb->info.name, sizeof(fb->info.name),
buf->raw, 3);
/* notify the FB name update to sequencer, too */
if (ret > 0 && ump->parsed) {
snd_ump_update_group_attrs(ump);
update_legacy_names(ump);
seq_notify_fb_change(ump, fb);
}
return ret;
}
static int create_block_from_fb_info(struct snd_ump_endpoint *ump, int blk)
{
struct snd_ump_block *fb;
unsigned char direction, first_group, num_groups;
const union snd_ump_stream_msg *buf =
(const union snd_ump_stream_msg *)ump->input_buf;
u32 msg;
int err;
/* query the FB info once */
msg = ump_stream_compose(UMP_STREAM_MSG_STATUS_FB_DISCOVERY, 0) |
(blk << 8) | UMP_STREAM_MSG_REQUEST_FB_INFO;
err = ump_req_msg(ump, msg, 0, UMP_STREAM_MSG_STATUS_FB_INFO);
if (err < 0) {
ump_dbg(ump, "Unable to get FB info for block %d\n", blk);
return err;
}
/* the last input must be the FB info */
if (buf->fb_info.status != UMP_STREAM_MSG_STATUS_FB_INFO) {
ump_dbg(ump, "Inconsistent input: 0x%x\n", *buf->raw);
return -EINVAL;
}
direction = buf->fb_info.direction;
first_group = buf->fb_info.first_group;
num_groups = buf->fb_info.num_groups;
err = snd_ump_block_new(ump, blk, direction, first_group, num_groups,
&fb);
if (err < 0)
return err;
fill_fb_info(ump, &fb->info, buf);
msg = ump_stream_compose(UMP_STREAM_MSG_STATUS_FB_DISCOVERY, 0) |