ut.c

   1 #define LOCAL_DEBUG
   2
   3 #include <ucw/lib.h>
   4 #include <ucw/bitops.h>
   5 #include <ucw/gary.h>
   6 #include <ucw/mainloop.h>
   7 #include <ucw/string.h>
   8
   9 #include <stdio.h>
  10 #include <string.h>
  11 #include <stdlib.h>
  12 #include <sys/poll.h>
  13
  14 #include <libusb.h>
  15
  16 /*
  17  *  Interface to Novation Nocturn
  18  *
  19  *  Protocol reverse-engineered by De Wet van Niekerk <dewert@gmail.com>,
  20  *  see https://github.com/dewert/nocturn-linux-midi for inspiration.
  21  */
  22
  23 static libusb_context *usb_ctx;
  24 static libusb_device_handle *usb_dev;
  25
  26 static struct main_file **usb_fds;
  27
  28 static int usb_fd_ready(struct main_file *f UNUSED)
  29 {
  30   DBG("USB: Handling events (ready on fd %d)", f->fd);
  31   struct timeval tv = { 0, 0 };
  32   int comp = 0;
  33   int err = libusb_handle_events_timeout_completed(usb_ctx, &tv, &comp);
  34   if (err < 0)
  35     msg(L_ERROR, "libusb_handle_events: error %d", err);
  36   return HOOK_IDLE;
  37 }
  38
  39 static void usb_added_fd(int fd, short events, void *user_data UNUSED)
  40 {
  41   if (fd >= (int) GARY_SIZE(usb_fds))
  42     GARY_RESIZE(usb_fds, fd + 1);
  43
  44   struct main_file *f = usb_fds[fd];
  45   if (!f)
  46     {
  47       f = xmalloc_zero(sizeof(*f));
  48       usb_fds[fd] = f;
  49     }
  50   else if (file_is_active(f))
  51     {
  52       DBG("USB: Releasing fd %d", fd);
  53       file_del(f);
  54     }
  55
  56   DBG("USB: Adding fd %d with event mask %u", fd, events);
  57   f->fd = fd;
  58   f->read_handler = (events & POLLIN) ? usb_fd_ready : NULL;
  59   f->write_handler = (events & POLLOUT) ? usb_fd_ready : NULL;
  60   file_add(f);
  61 }
  62
  63 static void usb_removed_fd(int fd, void *user_data UNUSED)
  64 {
  65   DBG("USB: Releasing fd %d", fd);
  66   ASSERT(fd < (int) GARY_SIZE(usb_fds));
  67   struct main_file *f = usb_fds[fd];
  68   ASSERT(f);
  69   ASSERT(file_is_active(f));
  70   file_del(f);
  71 }
  72
  73 static const char noct_init[4][9] = {
  74   { 3, 0xb0, 0x00, 0x00 },
  75   { 8, 0x28, 0x00, 0x2b, 0x4a, 0x2c, 0x00, 0x2e, 0x35 },
  76   { 6, 0x2a, 0x02, 0x2c, 0x72, 0x2e, 0x30 },
  77   { 2, 0x7f, 0x00 },
  78 };
  79
  80 static void noct_read_done(struct libusb_transfer *xfer)
  81 {
  82   byte *pkt = xfer->buffer;
  83   int len = xfer->actual_length;
  84   DBG("USB: Read done: status %d, length %d", xfer->status, len);
  85
  86   if (xfer->status != LIBUSB_TRANSFER_COMPLETED)
  87     {
  88       msg(L_ERROR, "USB read failed with status %d, not submitting again", xfer->status);
  89       return;
  90     }
  91
  92 #ifdef LOCAL_DEBUG
  93   char buf[256];
  94   mem_to_hex(buf, pkt, len, ' ');
  95   DBG("USB: Read <%s>", buf);
  96 #endif
  97
  98   int i = 0;
  99   while (i < len)
 100     {
 101       if (i + 3 > len)
 102         {
 103           msg(L_ERROR, "Unknown USB packet: length %d not divisible by 3", len);
 104           break;
 105         }
 106       if (pkt[i] != 0xb0)
 107         {
 108           msg(L_ERROR, "Unknown USB packet: expected 0xb0 at position %d", i);
 109           break;
 110         }
 111       int cmd = pkt[i+1];
 112       int arg = pkt[i+2];
 113       i += 3;
 114       switch (cmd)
 115         {
 116         case 0x30:
 117           // Unknown packet sent during init
 118           continue;
 119         case 0x40 ... 0x47:
 120           if (arg < 0x80)
 121             {
 122               int r = cmd - 0x40;
 123               int delta = (arg < 0x40 ? arg : arg - 0x80);
 124               DBG("Noct: Rotary %d = %d", r, delta);
 125               continue;
 126             }
 127           break;
 128         case 0x48:
 129           if (arg < 0x80)
 130             {
 131               DBG("Noct: Slider value = %d", arg);
 132               continue;
 133             }
 134           break;
 135         case 0x49:
 136           // Unknown packet, maybe least significant bit of slider
 137           continue;
 138         case 0x4a:
 139           if (arg < 0x80)
 140             {
 141               int delta = (arg < 0x40 ? arg : arg - 0x80);
 142               DBG("Noct: Center = %d", delta);
 143               continue;
 144             }
 145           break;
 146         case 0x52:
 147           if (arg == 0x00 || arg == 0x7f)
 148             {
 149               int state = !!arg;
 150               DBG("Noct: Center touch = %d", state);
 151               continue;
 152             }
 153           break;
 154         case 0x53:
 155           if (arg == 0x00 || arg == 0x7f)
 156             {
 157               int state = !!arg;
 158               DBG("Noct: Slider touch = %d", state);
 159               continue;
 160             }
 161           break;
 162         case 0x60 ... 0x67:
 163           if (arg == 0x00 || arg == 0x7f)
 164             {
 165               int r = cmd - 0x60;
 166               int state = !!arg;
 167               DBG("Noct: Rotary %d touch = %d", r, state);
 168               continue;
 169             }
 170           break;
 171         case 0x70 ... 0x7f:
 172           if (arg == 0x00 || arg == 0x7f)
 173             {
 174               int b = cmd - 0x70;
 175               int state = !!arg;
 176               DBG("Noct: Button %d = %d", b, state);
 177               continue;
 178             }
 179           break;
 180         }
 181       msg(L_ERROR, "Unknown USB packet: unrecognized cmd=%02x arg=%02x", cmd, arg);
 182     }
 183
 184   int err;
 185   if ((err = libusb_submit_transfer(xfer)) < 0)
 186     die("Cannot submit transfer: error %d", err);
 187 }
 188
 189 static void noct_read_init(void)
 190 {
 191   DBG("Noct: Read init");
 192
 193   struct libusb_transfer *xfer = libusb_alloc_transfer(0);
 194   libusb_fill_interrupt_transfer(xfer, usb_dev, 0x81, xmalloc(8), 8, noct_read_done, NULL, 0);
 195
 196   int err;
 197   if ((err = libusb_submit_transfer(xfer)) < 0)
 198     die("Cannot submit transfer: error %d", err);
 199 }
 200
 201 static byte noct_button_state[16];
 202 static byte noct_ring_mode[8];          // 0=from-min, 1=from-max, 2=from-mid-right, 3=from-mid-both, 4=single-on, 5=single-off
 203 static byte noct_ring_val[9];
 204
 205 static uns noct_dirty_button;
 206 static uns noct_dirty_ring_mode;
 207 static uns noct_dirty_ring_val;
 208
 209 static struct libusb_transfer *noct_write_xfer;
 210 static uns noct_write_pending;
 211 static void noct_sched_write(void);
 212
 213 static void noct_write_done(struct libusb_transfer *xfer)
 214 {
 215   int len = xfer->actual_length;
 216   DBG("USB: Write done: status %d, length %d", xfer->status, len);
 217
 218   if (xfer->status != LIBUSB_TRANSFER_COMPLETED)
 219     {
 220       msg(L_ERROR, "USB write failed with status %d", xfer->status);
 221       return;
 222     }
 223
 224   noct_write_pending = 0;
 225   noct_sched_write();
 226 }
 227
 228 static void noct_do_write(uns cmd, uns arg)
 229 {
 230   DBG("USB: Submitting write %02x %02x", cmd, arg);
 231   ASSERT(!noct_write_pending);
 232   noct_write_pending = 1;
 233
 234   struct libusb_transfer *xfer = noct_write_xfer;
 235   byte *pkt = xfer->buffer;
 236   pkt[0] = cmd;
 237   pkt[1] = arg;
 238   xfer->length = 2;
 239
 240   int err;
 241   if ((err = libusb_submit_transfer(xfer)) < 0)
 242     die("Cannot submit transfer: error %d", err);
 243 }
 244
 245 static void noct_sched_write(void)
 246 {
 247   if (noct_write_pending)
 248     return;
 249
 250   if (noct_dirty_button)
 251     {
 252       int i = bit_fls(noct_dirty_button);
 253       noct_dirty_button ^= 1U << i;
 254       noct_do_write(0x70 + i, noct_button_state[i]);
 255     }
 256   else if (noct_dirty_ring_mode)
 257     {
 258       int i = bit_fls(noct_dirty_ring_mode);
 259       noct_dirty_ring_mode ^= 1U << i;
 260       noct_do_write(0x48 + i, noct_ring_mode[i] << 4);
 261     }
 262   else if (noct_dirty_ring_val)
 263     {
 264       int i = bit_fls(noct_dirty_ring_val);
 265       noct_dirty_ring_val ^= 1U << i;
 266       if (i == 8)
 267         noct_do_write(0x50 + i, noct_ring_val[i]);
 268       else
 269         noct_do_write(0x40 + i, noct_ring_val[i]);
 270     }
 271 }
 272
 273 static void noct_write_init(void)
 274 {
 275   DBG("Noct: Write init");
 276
 277   noct_write_xfer = libusb_alloc_transfer(0);
 278   libusb_fill_interrupt_transfer(noct_write_xfer, usb_dev, 0x02, xmalloc(8), 0, noct_write_done, NULL, 1000);
 279
 280 #if 0 // FIXME
 281   noct_button_state[2] = 1;
 282   noct_ring_mode[0] = 4;
 283   noct_ring_val[0] = 0x40;
 284 #endif
 285
 286   noct_dirty_button = 0xffff;
 287   noct_dirty_ring_mode = 0xff;
 288   noct_dirty_ring_val = 0x1ff;
 289   noct_sched_write();
 290 }
 291
 292 static void usb_init(void)
 293 {
 294   int err;
 295
 296   if ((err = libusb_init(&usb_ctx)) < 0)
 297     die("libusb_init failed: error %d", err);
 298   libusb_set_debug(usb_ctx, 3);
 299
 300   libusb_device **dev_list;
 301   libusb_device *found_dev = NULL;
 302   ssize_t len = libusb_get_device_list(usb_ctx, &dev_list);
 303   for (ssize_t i=0; i < len; i++)
 304     {
 305       libusb_device *dev = dev_list[i];
 306       struct libusb_device_descriptor desc;
 307       if (libusb_get_device_descriptor(dev, &desc) >= 0 &&
 308           desc.idVendor == 0x1235 &&
 309           desc.idProduct == 0x000a)
 310         {
 311           msg(L_DEBUG, "Found device: bus %d, addr %d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
 312           if (found_dev)
 313             die("Multiple Nocturn devices found. Please fix me to handle it.");
 314           found_dev = libusb_ref_device(dev);
 315         }
 316     }
 317   libusb_free_device_list(dev_list, 1);
 318
 319   if (!found_dev)
 320     die("No Nocturn device found");
 321
 322   msg(L_DEBUG, "Initializing device");
 323
 324   if ((err = libusb_open(found_dev, &usb_dev)) < 0)
 325     die("libusb_open failed: error %d", err);
 326
 327   // There exist configurations 1 (high brightness) and 2 (power-save)
 328   if ((err = libusb_set_configuration(usb_dev, 1)) < 0)
 329     die("libusb_set_configuration: error %d", err);
 330
 331   if ((err = libusb_claim_interface(usb_dev, 0)) < 0)
 332     die("libusb_claim_interface: error %d", err);
 333
 334   for (int i=0; i<4; i++)
 335     {
 336       int done;
 337       if ((err = libusb_interrupt_transfer(usb_dev, 0x02, (byte *) noct_init[i] + 1, noct_init[i][0], &done, 5000)) < 0)
 338         die("Cannot send init packets: error %d", err);
 339       if (done != noct_init[i][0])
 340         die("Partial send of init packet: %d < %d", done, noct_init[i][0]);
 341     }
 342
 343 #if 0
 344   byte xxx[] = { 0x7f, 0x01 };
 345   int done;
 346   libusb_interrupt_transfer(usb_dev, 0x02, xxx, 2, &done, 5000);
 347 #endif
 348
 349   DBG("USB: Connecting libusb to mainloop");
 350
 351   if (!libusb_pollfds_handle_timeouts(usb_ctx))
 352     die("Unsupported version of libusb, please fix me");
 353
 354   GARY_INIT_ZERO(usb_fds, 0);
 355   libusb_set_pollfd_notifiers(usb_ctx, usb_added_fd, usb_removed_fd, NULL);
 356
 357   const struct libusb_pollfd **fds = libusb_get_pollfds(usb_ctx);
 358   ASSERT(fds);
 359   for (int i=0; fds[i]; i++)
 360     usb_added_fd(fds[i]->fd, fds[i]->events, NULL);
 361   free(fds);
 362
 363   noct_read_init();
 364   noct_write_init();
 365 }
 366
 367 int main(int argc UNUSED, char **argv)
 368 {
 369   log_init(argv[0]);
 370   main_init();
 371
 372   msg(L_INFO, "Initializing USB");
 373   usb_init();
 374
 375   msg(L_INFO, "Entering main loop");
 376   main_loop();
 377
 378   return 0;
 379 }