ALSA: snd-usb-caiaq: Add support for Traktor Kontrol S4

This patch adds support for the new Traktor Kontrol S4 by Native
Instruments. It features a new audio data streaming model, MIDI
in and out ports, a huge number of 174 dimmable LEDs, 96 buttons
and 46 absolute encoder axis, including some rotary encoders.

All features are supported by the driver now.

Did some code refactoring along the way.

Signed-off-by: Daniel Mack <daniel@caiaq.de>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

1 files changed, 222 insertions, 26 deletions

diff --git a/sound/usb/caiaq/input.c b/sound/usb/caiaq/input.c
index dcb620796d9e..4432ef7a70a9 100644
--- a/sound/usb/caiaq/input.c
+++ b/sound/usb/caiaq/input.c
@@ -67,7 +67,12 @@ static unsigned short keycode_kore[] = {
         KEY_BRL_DOT5
 };
 
-#define KONTROLX1_INPUTS 40
+#define KONTROLX1_INPUTS        (40)
+#define KONTROLS4_BUTTONS       (12 * 8)
+#define KONTROLS4_AXIS          (46)
+
+#define KONTROLS4_BUTTON(X)     ((X) + BTN_MISC)
+#define KONTROLS4_ABS(X)        ((X) + ABS_HAT0X)
 
 #define DEG90           (range / 2)
 #define DEG180          (range)
@@ -139,6 +144,13 @@ static unsigned int decode_erp(unsigned char a, unsigned char b)
 #undef HIGH_PEAK
 #undef LOW_PEAK
 
+static inline void snd_caiaq_input_report_abs(struct snd_usb_caiaqdev *dev,
+                                              int axis, const unsigned char *buf,
+                                              int offset)
+{
+        input_report_abs(dev->input_dev, axis,
+                         (buf[offset * 2] << 8) | buf[offset * 2 + 1]);
+}
 
 static void snd_caiaq_input_read_analog(struct snd_usb_caiaqdev *dev,
                                         const unsigned char *buf,
@@ -148,36 +160,30 @@ static void snd_caiaq_input_read_analog(struct snd_usb_caiaqdev *dev,
 
         switch (dev->chip.usb_id) {
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
-                input_report_abs(input_dev, ABS_X, (buf[4] << 8) | buf[5]);
-                input_report_abs(input_dev, ABS_Y, (buf[0] << 8) | buf[1]);
-                input_report_abs(input_dev, ABS_Z, (buf[2] << 8) | buf[3]);
-                input_sync(input_dev);
+                snd_caiaq_input_report_abs(dev, ABS_X, buf, 2);
+                snd_caiaq_input_report_abs(dev, ABS_Y, buf, 0);
+                snd_caiaq_input_report_abs(dev, ABS_Z, buf, 1);
                 break;
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
-                input_report_abs(input_dev, ABS_X, (buf[0] << 8) | buf[1]);
-                input_report_abs(input_dev, ABS_Y, (buf[2] << 8) | buf[3]);
-                input_report_abs(input_dev, ABS_Z, (buf[4] << 8) | buf[5]);
-                input_sync(input_dev);
-                break;
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_KORECONTROLLER):
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_KORECONTROLLER2):
-                input_report_abs(input_dev, ABS_X, (buf[0] << 8) | buf[1]);
-                input_report_abs(input_dev, ABS_Y, (buf[2] << 8) | buf[3]);
-                input_report_abs(input_dev, ABS_Z, (buf[4] << 8) | buf[5]);
-                input_sync(input_dev);
+                snd_caiaq_input_report_abs(dev, ABS_X, buf, 0);
+                snd_caiaq_input_report_abs(dev, ABS_Y, buf, 1);
+                snd_caiaq_input_report_abs(dev, ABS_Z, buf, 2);
                 break;
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLX1):
-                input_report_abs(input_dev, ABS_HAT0X, (buf[8] << 8)  | buf[9]);
-                input_report_abs(input_dev, ABS_HAT0Y, (buf[4] << 8)  | buf[5]);
-                input_report_abs(input_dev, ABS_HAT1X, (buf[12] << 8) | buf[13]);
-                input_report_abs(input_dev, ABS_HAT1Y, (buf[2] << 8)  | buf[3]);
-                input_report_abs(input_dev, ABS_HAT2X, (buf[14] << 8) | buf[15]);
-                input_report_abs(input_dev, ABS_HAT2Y, (buf[0] << 8)  | buf[1]);
-                input_report_abs(input_dev, ABS_HAT3X, (buf[10] << 8) | buf[11]);
-                input_report_abs(input_dev, ABS_HAT3Y, (buf[6] << 8)  | buf[7]);
-                input_sync(input_dev);
+                snd_caiaq_input_report_abs(dev, ABS_HAT0X, buf, 4);
+                snd_caiaq_input_report_abs(dev, ABS_HAT0Y, buf, 2);
+                snd_caiaq_input_report_abs(dev, ABS_HAT1X, buf, 6);
+                snd_caiaq_input_report_abs(dev, ABS_HAT1Y, buf, 1);
+                snd_caiaq_input_report_abs(dev, ABS_HAT2X, buf, 7);
+                snd_caiaq_input_report_abs(dev, ABS_HAT2Y, buf, 0);
+                snd_caiaq_input_report_abs(dev, ABS_HAT3X, buf, 5);
+                snd_caiaq_input_report_abs(dev, ABS_HAT3Y, buf, 3);
                 break;
         }
+
+        input_sync(input_dev);
 }
 
 static void snd_caiaq_input_read_erp(struct snd_usb_caiaqdev *dev,
@@ -250,6 +256,150 @@ static void snd_caiaq_input_read_io(struct snd_usb_caiaqdev *dev,
         input_sync(input_dev);
 }
 
+#define TKS4_MSGBLOCK_SIZE      16
+
+static void snd_usb_caiaq_tks4_dispatch(struct snd_usb_caiaqdev *dev,
+                                        const unsigned char *buf,
+                                        unsigned int len)
+{
+        while (len) {
+                unsigned int i, block_id = (buf[0] << 8) | buf[1];
+
+                switch (block_id) {
+                case 0:
+                        /* buttons */
+                        for (i = 0; i < KONTROLS4_BUTTONS; i++)
+                                input_report_key(dev->input_dev, KONTROLS4_BUTTON(i),
+                                                 (buf[4 + (i / 8)] >> (i % 8)) & 1);
+                        break;
+
+                case 1:
+                        /* left wheel */
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(36), buf[9] | ((buf[8] & 0x3) << 8));
+                        /* right wheel */
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(37), buf[13] | ((buf[12] & 0x3) << 8));
+
+                        /* rotary encoders */
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(38), buf[3] & 0xf);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(39), buf[4] >> 4);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(40), buf[4] & 0xf);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(41), buf[5] >> 4);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(42), buf[5] & 0xf);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(43), buf[6] >> 4);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(44), buf[6] & 0xf);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(45), buf[7] >> 4);
+                        input_report_abs(dev->input_dev, KONTROLS4_ABS(46), buf[7] & 0xf);
+
+                        break;
+                case 2:
+                        /* Volume Fader Channel D */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(0), buf, 1);
+                        /* Volume Fader Channel B */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(1), buf, 2);
+                        /* Volume Fader Channel A */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(2), buf, 3);
+                        /* Volume Fader Channel C */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(3), buf, 4);
+                        /* Loop Volume */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(4), buf, 6);
+                        /* Crossfader */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(7), buf, 7);
+
+                        break;
+
+                case 3:
+                        /* Tempo Fader R */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(6), buf, 3);
+                        /* Tempo Fader L */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(5), buf, 4);
+                        /* Mic Volume */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(8), buf, 6);
+                        /* Cue Mix */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(9), buf, 7);
+
+                        break;
+
+                case 4:
+                        /* Wheel distance sensor L */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(10), buf, 1);
+                        /* Wheel distance sensor R */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(11), buf, 2);
+                        /* Channel D EQ - Filter */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(12), buf, 3);
+                        /* Channel D EQ - Low */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(13), buf, 4);
+                        /* Channel D EQ - Mid */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(14), buf, 5);
+                        /* Channel D EQ - Hi */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(15), buf, 6);
+                        /* FX2 - dry/wet */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(16), buf, 7);
+
+                        break;
+
+                case 5:
+                        /* FX2 - 1 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(17), buf, 1);
+                        /* FX2 - 2 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(18), buf, 2);
+                        /* FX2 - 3 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(19), buf, 3);
+                        /* Channel B EQ - Filter */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(20), buf, 4);
+                        /* Channel B EQ - Low */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(21), buf, 5);
+                        /* Channel B EQ - Mid */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(22), buf, 6);
+                        /* Channel B EQ - Hi */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(23), buf, 7);
+
+                        break;
+
+                case 6:
+                        /* Channel A EQ - Filter */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(24), buf, 1);
+                        /* Channel A EQ - Low */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(25), buf, 2);
+                        /* Channel A EQ - Mid */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(26), buf, 3);
+                        /* Channel A EQ - Hi */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(27), buf, 4);
+                        /* Channel C EQ - Filter */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(28), buf, 5);
+                        /* Channel C EQ - Low */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(29), buf, 6);
+                        /* Channel C EQ - Mid */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(30), buf, 7);
+
+                        break;
+
+                case 7:
+                        /* Channel C EQ - Hi */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(31), buf, 1);
+                        /* FX1 - wet/dry */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(32), buf, 2);
+                        /* FX1 - 1 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(33), buf, 3);
+                        /* FX1 - 2 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(34), buf, 4);
+                        /* FX1 - 3 */
+                        snd_caiaq_input_report_abs(dev, KONTROLS4_ABS(35), buf, 5);
+
+                        break;
+
+                default:
+                        debug("%s(): bogus block (id %d)\n",
+                                __func__, block_id);
+                        return;
+                }
+
+                len -= TKS4_MSGBLOCK_SIZE;
+                buf += TKS4_MSGBLOCK_SIZE;
+        }
+
+        input_sync(dev->input_dev);
+}
+
 static void snd_usb_caiaq_ep4_reply_dispatch(struct urb *urb)
 {
         struct snd_usb_caiaqdev *dev = urb->context;
@@ -259,11 +409,11 @@ static void snd_usb_caiaq_ep4_reply_dispatch(struct urb *urb)
         if (urb->status || !dev || urb != dev->ep4_in_urb)
                 return;
 
-        if (urb->actual_length < 24)
-                goto requeue;
-
         switch (dev->chip.usb_id) {
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLX1):
+                if (urb->actual_length < 24)
+                        goto requeue;
+
                 if (buf[0] & 0x3)
                         snd_caiaq_input_read_io(dev, buf + 1, 7);
 
@@ -271,6 +421,10 @@ static void snd_usb_caiaq_ep4_reply_dispatch(struct urb *urb)
                         snd_caiaq_input_read_analog(dev, buf + 8, 16);
 
                 break;
+
+        case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLS4):
+                snd_usb_caiaq_tks4_dispatch(dev, buf, urb->actual_length);
+                break;
         }
 
 requeue:
@@ -289,6 +443,7 @@ static int snd_usb_caiaq_input_open(struct input_dev *idev)
 
         switch (dev->chip.usb_id) {
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLX1):
+        case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLS4):
                 if (usb_submit_urb(dev->ep4_in_urb, GFP_KERNEL) != 0)
                         return -EIO;
                 break;
@@ -306,6 +461,7 @@ static void snd_usb_caiaq_input_close(struct input_dev *idev)
 
         switch (dev->chip.usb_id) {
         case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLX1):
+        case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLS4):
                 usb_kill_urb(dev->ep4_in_urb);
                 break;
         }
@@ -456,6 +612,46 @@ int snd_usb_caiaq_input_init(struct snd_usb_caiaqdev *dev)
                 snd_usb_caiaq_set_auto_msg(dev, 1, 10, 5);
 
                 break;
+
+        case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_TRAKTORKONTROLS4):
+                input->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
+                BUILD_BUG_ON(sizeof(dev->keycode) < KONTROLS4_BUTTONS);
+                for (i = 0; i < KONTROLS4_BUTTONS; i++)
+                        dev->keycode[i] = KONTROLS4_BUTTON(i);
+                input->keycodemax = KONTROLS4_BUTTONS;
+
+                for (i = 0; i < KONTROLS4_AXIS; i++) {
+                        int axis = KONTROLS4_ABS(i);
+                        input->absbit[BIT_WORD(axis)] |= BIT_MASK(axis);
+                }
+
+                /* 36 analog potentiometers and faders */
+                for (i = 0; i < 36; i++)
+                        input_set_abs_params(input, KONTROLS4_ABS(i), 0, 0xfff, 0, 10);
+
+                /* 2 encoder wheels */
+                input_set_abs_params(input, KONTROLS4_ABS(36), 0, 0x3ff, 0, 1);
+                input_set_abs_params(input, KONTROLS4_ABS(37), 0, 0x3ff, 0, 1);
+
+                /* 9 rotary encoders */
+                for (i = 0; i < 9; i++)
+                        input_set_abs_params(input, KONTROLS4_ABS(38+i), 0, 0xf, 0, 1);
+
+                dev->ep4_in_urb = usb_alloc_urb(0, GFP_KERNEL);
+                if (!dev->ep4_in_urb) {
+                        ret = -ENOMEM;
+                        goto exit_free_idev;
+                }
+
+                usb_fill_bulk_urb(dev->ep4_in_urb, usb_dev,
+                                  usb_rcvbulkpipe(usb_dev, 0x4),
+                                  dev->ep4_in_buf, EP4_BUFSIZE,
+                                  snd_usb_caiaq_ep4_reply_dispatch, dev);
+
+                snd_usb_caiaq_set_auto_msg(dev, 1, 10, 5);
+
+                break;
+
         default:
                 /* no input methods supported on this device */
                 goto exit_free_idev;