4 #include <ucw/bitops.h>
6 #include <ucw/mainloop.h>
7 #include <ucw/string.h>
17 * Interface to Novation Nocturn
19 * Protocol reverse-engineered by De Wet van Niekerk <dewert@gmail.com>,
20 * see https://github.com/dewert/nocturn-linux-midi for inspiration.
23 static libusb_context *usb_ctx;
24 static libusb_device_handle *usb_dev;
26 static struct main_file **usb_fds;
28 static int usb_fd_ready(struct main_file *f UNUSED)
30 DBG("USB: Handling events (ready on fd %d)", f->fd);
31 struct timeval tv = { 0, 0 };
33 int err = libusb_handle_events_timeout_completed(usb_ctx, &tv, &comp);
35 msg(L_ERROR, "libusb_handle_events: error %d", err);
39 static void usb_added_fd(int fd, short events, void *user_data UNUSED)
41 if (fd >= (int) GARY_SIZE(usb_fds))
42 GARY_RESIZE(usb_fds, fd + 1);
44 struct main_file *f = usb_fds[fd];
47 f = xmalloc_zero(sizeof(*f));
50 else if (file_is_active(f))
52 DBG("USB: Releasing fd %d", fd);
56 DBG("USB: Adding fd %d with event mask %u", fd, events);
58 f->read_handler = (events & POLLIN) ? usb_fd_ready : NULL;
59 f->write_handler = (events & POLLOUT) ? usb_fd_ready : NULL;
63 static void usb_removed_fd(int fd, void *user_data UNUSED)
65 DBG("USB: Releasing fd %d", fd);
66 ASSERT(fd < (int) GARY_SIZE(usb_fds));
67 struct main_file *f = usb_fds[fd];
69 ASSERT(file_is_active(f));
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 },
80 static void noct_read_done(struct libusb_transfer *xfer)
82 byte *pkt = xfer->buffer;
83 int len = xfer->actual_length;
84 DBG("USB: Read done: status %d, length %d", xfer->status, len);
86 if (xfer->status != LIBUSB_TRANSFER_COMPLETED)
88 msg(L_ERROR, "USB read failed with status %d, not submitting again", xfer->status);
94 mem_to_hex(buf, pkt, len, ' ');
95 DBG("USB: Read <%s>", buf);
103 msg(L_ERROR, "Unknown USB packet: length %d not divisible by 3", len);
108 msg(L_ERROR, "Unknown USB packet: expected 0xb0 at position %d", i);
117 // Unknown packet sent during init
123 int delta = (arg < 0x40 ? arg : arg - 0x80);
124 DBG("Noct: Rotary %d = %d", r, delta);
131 DBG("Noct: Slider value = %d", arg);
136 // Unknown packet, maybe least significant bit of slider
141 int delta = (arg < 0x40 ? arg : arg - 0x80);
142 DBG("Noct: Center = %d", delta);
147 if (arg == 0x00 || arg == 0x7f)
150 DBG("Noct: Center touch = %d", state);
155 if (arg == 0x00 || arg == 0x7f)
158 DBG("Noct: Slider touch = %d", state);
163 if (arg == 0x00 || arg == 0x7f)
167 DBG("Noct: Rotary %d touch = %d", r, state);
172 if (arg == 0x00 || arg == 0x7f)
176 DBG("Noct: Button %d = %d", b, state);
181 msg(L_ERROR, "Unknown USB packet: unrecognized cmd=%02x arg=%02x", cmd, arg);
185 if ((err = libusb_submit_transfer(xfer)) < 0)
186 die("Cannot submit transfer: error %d", err);
189 static void noct_read_init(void)
191 DBG("Noct: Read init");
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);
197 if ((err = libusb_submit_transfer(xfer)) < 0)
198 die("Cannot submit transfer: error %d", err);
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];
205 static uns noct_dirty_button;
206 static uns noct_dirty_ring_mode;
207 static uns noct_dirty_ring_val;
209 static struct libusb_transfer *noct_write_xfer;
210 static uns noct_write_pending;
211 static void noct_sched_write(void);
213 static void noct_write_done(struct libusb_transfer *xfer)
215 int len = xfer->actual_length;
216 DBG("USB: Write done: status %d, length %d", xfer->status, len);
218 if (xfer->status != LIBUSB_TRANSFER_COMPLETED)
220 msg(L_ERROR, "USB write failed with status %d", xfer->status);
224 noct_write_pending = 0;
228 static void noct_do_write(uns cmd, uns arg)
230 DBG("USB: Submitting write %02x %02x", cmd, arg);
231 ASSERT(!noct_write_pending);
232 noct_write_pending = 1;
234 struct libusb_transfer *xfer = noct_write_xfer;
235 byte *pkt = xfer->buffer;
241 if ((err = libusb_submit_transfer(xfer)) < 0)
242 die("Cannot submit transfer: error %d", err);
245 static void noct_sched_write(void)
247 if (noct_write_pending)
250 if (noct_dirty_button)
252 int i = bit_fls(noct_dirty_button);
253 noct_dirty_button ^= 1U << i;
254 noct_do_write(0x70 + i, noct_button_state[i]);
256 else if (noct_dirty_ring_mode)
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);
262 else if (noct_dirty_ring_val)
264 int i = bit_fls(noct_dirty_ring_val);
265 noct_dirty_ring_val ^= 1U << i;
267 noct_do_write(0x50 + i, noct_ring_val[i]);
269 noct_do_write(0x40 + i, noct_ring_val[i]);
273 static void noct_write_init(void)
275 DBG("Noct: Write init");
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);
281 noct_button_state[2] = 1;
282 noct_ring_mode[0] = 4;
283 noct_ring_val[0] = 0x40;
286 noct_dirty_button = 0xffff;
287 noct_dirty_ring_mode = 0xff;
288 noct_dirty_ring_val = 0x1ff;
292 static void usb_init(void)
296 if ((err = libusb_init(&usb_ctx)) < 0)
297 die("libusb_init failed: error %d", err);
298 libusb_set_debug(usb_ctx, 3);
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++)
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)
311 msg(L_DEBUG, "Found device: bus %d, addr %d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
313 die("Multiple Nocturn devices found. Please fix me to handle it.");
314 found_dev = libusb_ref_device(dev);
317 libusb_free_device_list(dev_list, 1);
320 die("No Nocturn device found");
322 msg(L_DEBUG, "Initializing device");
324 if ((err = libusb_open(found_dev, &usb_dev)) < 0)
325 die("libusb_open failed: error %d", err);
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);
331 if ((err = libusb_claim_interface(usb_dev, 0)) < 0)
332 die("libusb_claim_interface: error %d", err);
334 for (int i=0; i<4; i++)
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]);
344 byte xxx[] = { 0x7f, 0x01 };
346 libusb_interrupt_transfer(usb_dev, 0x02, xxx, 2, &done, 5000);
349 DBG("USB: Connecting libusb to mainloop");
351 if (!libusb_pollfds_handle_timeouts(usb_ctx))
352 die("Unsupported version of libusb, please fix me");
354 GARY_INIT_ZERO(usb_fds, 0);
355 libusb_set_pollfd_notifiers(usb_ctx, usb_added_fd, usb_removed_fd, NULL);
357 const struct libusb_pollfd **fds = libusb_get_pollfds(usb_ctx);
359 for (int i=0; fds[i]; i++)
360 usb_added_fd(fds[i]->fd, fds[i]->events, NULL);
367 int main(int argc UNUSED, char **argv)
372 msg(L_INFO, "Initializing USB");
375 msg(L_INFO, "Entering main loop");