aboutsummaryrefslogtreecommitdiff
path: root/tmk_core/protocol
diff options
context:
space:
mode:
Diffstat (limited to 'tmk_core/protocol')
-rw-r--r--tmk_core/protocol/lufa.mk4
-rw-r--r--tmk_core/protocol/lufa/adafruit_ble.cpp805
-rw-r--r--tmk_core/protocol/lufa/adafruit_ble.h60
-rw-r--r--tmk_core/protocol/lufa/descriptor.c87
-rw-r--r--tmk_core/protocol/lufa/descriptor.h35
-rw-r--r--tmk_core/protocol/lufa/lufa.c235
-rw-r--r--tmk_core/protocol/lufa/lufa.h13
-rw-r--r--tmk_core/protocol/lufa/ringbuffer.hpp66
-rw-r--r--tmk_core/protocol/midi.mk1
-rw-r--r--tmk_core/protocol/ps2_mouse.c330
-rw-r--r--tmk_core/protocol/ps2_mouse.h131
11 files changed, 1573 insertions, 194 deletions
diff --git a/tmk_core/protocol/lufa.mk b/tmk_core/protocol/lufa.mk
index 5b1e3d19d..151d26cbc 100644
--- a/tmk_core/protocol/lufa.mk
+++ b/tmk_core/protocol/lufa.mk
@@ -21,6 +21,10 @@ ifeq ($(strip $(MIDI_ENABLE)), yes)
21 include $(TMK_PATH)/protocol/midi.mk 21 include $(TMK_PATH)/protocol/midi.mk
22endif 22endif
23 23
24ifeq ($(strip $(ADAFRUIT_BLE_ENABLE)), yes)
25 LUFA_SRC += $(LUFA_DIR)/adafruit_ble.cpp
26endif
27
24ifeq ($(strip $(BLUETOOTH_ENABLE)), yes) 28ifeq ($(strip $(BLUETOOTH_ENABLE)), yes)
25 LUFA_SRC += $(LUFA_DIR)/bluetooth.c \ 29 LUFA_SRC += $(LUFA_DIR)/bluetooth.c \
26 $(TMK_DIR)/protocol/serial_uart.c 30 $(TMK_DIR)/protocol/serial_uart.c
diff --git a/tmk_core/protocol/lufa/adafruit_ble.cpp b/tmk_core/protocol/lufa/adafruit_ble.cpp
new file mode 100644
index 000000000..37194e77a
--- /dev/null
+++ b/tmk_core/protocol/lufa/adafruit_ble.cpp
@@ -0,0 +1,805 @@
1#include "adafruit_ble.h"
2#include <stdio.h>
3#include <stdlib.h>
4#include <alloca.h>
5#include <util/delay.h>
6#include <util/atomic.h>
7#include "debug.h"
8#include "pincontrol.h"
9#include "timer.h"
10#include "action_util.h"
11#include "ringbuffer.hpp"
12#include <string.h>
13
14// These are the pin assignments for the 32u4 boards.
15// You may define them to something else in your config.h
16// if yours is wired up differently.
17#ifndef AdafruitBleResetPin
18#define AdafruitBleResetPin D4
19#endif
20
21#ifndef AdafruitBleCSPin
22#define AdafruitBleCSPin B4
23#endif
24
25#ifndef AdafruitBleIRQPin
26#define AdafruitBleIRQPin E6
27#endif
28
29
30#define SAMPLE_BATTERY
31#define ConnectionUpdateInterval 1000 /* milliseconds */
32
33static struct {
34 bool is_connected;
35 bool initialized;
36 bool configured;
37
38#define ProbedEvents 1
39#define UsingEvents 2
40 bool event_flags;
41
42#ifdef SAMPLE_BATTERY
43 uint16_t last_battery_update;
44 uint32_t vbat;
45#endif
46 uint16_t last_connection_update;
47} state;
48
49// Commands are encoded using SDEP and sent via SPI
50// https://github.com/adafruit/Adafruit_BluefruitLE_nRF51/blob/master/SDEP.md
51
52#define SdepMaxPayload 16
53struct sdep_msg {
54 uint8_t type;
55 uint8_t cmd_low;
56 uint8_t cmd_high;
57 struct __attribute__((packed)) {
58 uint8_t len:7;
59 uint8_t more:1;
60 };
61 uint8_t payload[SdepMaxPayload];
62} __attribute__((packed));
63
64// The recv latency is relatively high, so when we're hammering keys quickly,
65// we want to avoid waiting for the responses in the matrix loop. We maintain
66// a short queue for that. Since there is quite a lot of space overhead for
67// the AT command representation wrapped up in SDEP, we queue the minimal
68// information here.
69
70enum queue_type {
71 QTKeyReport, // 1-byte modifier + 6-byte key report
72 QTConsumer, // 16-bit key code
73#ifdef MOUSE_ENABLE
74 QTMouseMove, // 4-byte mouse report
75#endif
76};
77
78struct queue_item {
79 enum queue_type queue_type;
80 uint16_t added;
81 union __attribute__((packed)) {
82 struct __attribute__((packed)) {
83 uint8_t modifier;
84 uint8_t keys[6];
85 } key;
86
87 uint16_t consumer;
88 struct __attribute__((packed)) {
89 uint8_t x, y, scroll, pan;
90 } mousemove;
91 };
92};
93
94// Items that we wish to send
95static RingBuffer<queue_item, 40> send_buf;
96// Pending response; while pending, we can't send any more requests.
97// This records the time at which we sent the command for which we
98// are expecting a response.
99static RingBuffer<uint16_t, 2> resp_buf;
100
101static bool process_queue_item(struct queue_item *item, uint16_t timeout);
102
103enum sdep_type {
104 SdepCommand = 0x10,
105 SdepResponse = 0x20,
106 SdepAlert = 0x40,
107 SdepError = 0x80,
108 SdepSlaveNotReady = 0xfe, // Try again later
109 SdepSlaveOverflow = 0xff, // You read more data than is available
110};
111
112enum ble_cmd {
113 BleInitialize = 0xbeef,
114 BleAtWrapper = 0x0a00,
115 BleUartTx = 0x0a01,
116 BleUartRx = 0x0a02,
117};
118
119enum ble_system_event_bits {
120 BleSystemConnected = 0,
121 BleSystemDisconnected = 1,
122 BleSystemUartRx = 8,
123 BleSystemMidiRx = 10,
124};
125
126// The SDEP.md file says 2MHz but the web page and the sample driver
127// both use 4MHz
128#define SpiBusSpeed 4000000
129
130#define SdepTimeout 150 /* milliseconds */
131#define SdepShortTimeout 10 /* milliseconds */
132#define SdepBackOff 25 /* microseconds */
133#define BatteryUpdateInterval 10000 /* milliseconds */
134
135static bool at_command(const char *cmd, char *resp, uint16_t resplen,
136 bool verbose, uint16_t timeout = SdepTimeout);
137static bool at_command_P(const char *cmd, char *resp, uint16_t resplen,
138 bool verbose = false);
139
140struct SPI_Settings {
141 uint8_t spcr, spsr;
142};
143
144static struct SPI_Settings spi;
145
146// Initialize 4Mhz MSBFIRST MODE0
147void SPI_init(struct SPI_Settings *spi) {
148 spi->spcr = _BV(SPE) | _BV(MSTR);
149 spi->spsr = _BV(SPI2X);
150
151 static_assert(SpiBusSpeed == F_CPU / 2, "hard coded at 4Mhz");
152
153 ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {
154 // Ensure that SS is OUTPUT High
155 digitalWrite(B0, PinLevelHigh);
156 pinMode(B0, PinDirectionOutput);
157
158 SPCR |= _BV(MSTR);
159 SPCR |= _BV(SPE);
160 pinMode(B1 /* SCK */, PinDirectionOutput);
161 pinMode(B2 /* MOSI */, PinDirectionOutput);
162 }
163}
164
165static inline void SPI_begin(struct SPI_Settings*spi) {
166 SPCR = spi->spcr;
167 SPSR = spi->spsr;
168}
169
170static inline uint8_t SPI_TransferByte(uint8_t data) {
171 SPDR = data;
172 asm volatile("nop");
173 while (!(SPSR & _BV(SPIF))) {
174 ; // wait
175 }
176 return SPDR;
177}
178
179static inline void spi_send_bytes(const uint8_t *buf, uint8_t len) {
180 if (len == 0) return;
181 const uint8_t *end = buf + len;
182 while (buf < end) {
183 SPDR = *buf;
184 while (!(SPSR & _BV(SPIF))) {
185 ; // wait
186 }
187 ++buf;
188 }
189}
190
191static inline uint16_t spi_read_byte(void) {
192 return SPI_TransferByte(0x00 /* dummy */);
193}
194
195static inline void spi_recv_bytes(uint8_t *buf, uint8_t len) {
196 const uint8_t *end = buf + len;
197 if (len == 0) return;
198 while (buf < end) {
199 SPDR = 0; // write a dummy to initiate read
200 while (!(SPSR & _BV(SPIF))) {
201 ; // wait
202 }
203 *buf = SPDR;
204 ++buf;
205 }
206}
207
208#if 0
209static void dump_pkt(const struct sdep_msg *msg) {
210 print("pkt: type=");
211 print_hex8(msg->type);
212 print(" cmd=");
213 print_hex8(msg->cmd_high);
214 print_hex8(msg->cmd_low);
215 print(" len=");
216 print_hex8(msg->len);
217 print(" more=");
218 print_hex8(msg->more);
219 print("\n");
220}
221#endif
222
223// Send a single SDEP packet
224static bool sdep_send_pkt(const struct sdep_msg *msg, uint16_t timeout) {
225 SPI_begin(&spi);
226
227 digitalWrite(AdafruitBleCSPin, PinLevelLow);
228 uint16_t timerStart = timer_read();
229 bool success = false;
230 bool ready = false;
231
232 do {
233 ready = SPI_TransferByte(msg->type) != SdepSlaveNotReady;
234 if (ready) {
235 break;
236 }
237
238 // Release it and let it initialize
239 digitalWrite(AdafruitBleCSPin, PinLevelHigh);
240 _delay_us(SdepBackOff);
241 digitalWrite(AdafruitBleCSPin, PinLevelLow);
242 } while (timer_elapsed(timerStart) < timeout);
243
244 if (ready) {
245 // Slave is ready; send the rest of the packet
246 spi_send_bytes(&msg->cmd_low,
247 sizeof(*msg) - (1 + sizeof(msg->payload)) + msg->len);
248 success = true;
249 }
250
251 digitalWrite(AdafruitBleCSPin, PinLevelHigh);
252
253 return success;
254}
255
256static inline void sdep_build_pkt(struct sdep_msg *msg, uint16_t command,
257 const uint8_t *payload, uint8_t len,
258 bool moredata) {
259 msg->type = SdepCommand;
260 msg->cmd_low = command & 0xff;
261 msg->cmd_high = command >> 8;
262 msg->len = len;
263 msg->more = (moredata && len == SdepMaxPayload) ? 1 : 0;
264
265 static_assert(sizeof(*msg) == 20, "msg is correctly packed");
266
267 memcpy(msg->payload, payload, len);
268}
269
270// Read a single SDEP packet
271static bool sdep_recv_pkt(struct sdep_msg *msg, uint16_t timeout) {
272 bool success = false;
273 uint16_t timerStart = timer_read();
274 bool ready = false;
275
276 do {
277 ready = digitalRead(AdafruitBleIRQPin);
278 if (ready) {
279 break;
280 }
281 _delay_us(1);
282 } while (timer_elapsed(timerStart) < timeout);
283
284 if (ready) {
285 SPI_begin(&spi);
286
287 digitalWrite(AdafruitBleCSPin, PinLevelLow);
288
289 do {
290 // Read the command type, waiting for the data to be ready
291 msg->type = spi_read_byte();
292 if (msg->type == SdepSlaveNotReady || msg->type == SdepSlaveOverflow) {
293 // Release it and let it initialize
294 digitalWrite(AdafruitBleCSPin, PinLevelHigh);
295 _delay_us(SdepBackOff);
296 digitalWrite(AdafruitBleCSPin, PinLevelLow);
297 continue;
298 }
299
300 // Read the rest of the header
301 spi_recv_bytes(&msg->cmd_low, sizeof(*msg) - (1 + sizeof(msg->payload)));
302
303 // and get the payload if there is any
304 if (msg->len <= SdepMaxPayload) {
305 spi_recv_bytes(msg->payload, msg->len);
306 }
307 success = true;
308 break;
309 } while (timer_elapsed(timerStart) < timeout);
310
311 digitalWrite(AdafruitBleCSPin, PinLevelHigh);
312 }
313 return success;
314}
315
316static void resp_buf_read_one(bool greedy) {
317 uint16_t last_send;
318 if (!resp_buf.peek(last_send)) {
319 return;
320 }
321
322 if (digitalRead(AdafruitBleIRQPin)) {
323 struct sdep_msg msg;
324
325again:
326 if (sdep_recv_pkt(&msg, SdepTimeout)) {
327 if (!msg.more) {
328 // We got it; consume this entry
329 resp_buf.get(last_send);
330 dprintf("recv latency %dms\n", TIMER_DIFF_16(timer_read(), last_send));
331 }
332
333 if (greedy && resp_buf.peek(last_send) && digitalRead(AdafruitBleIRQPin)) {
334 goto again;
335 }
336 }
337
338 } else if (timer_elapsed(last_send) > SdepTimeout * 2) {
339 dprintf("waiting_for_result: timeout, resp_buf size %d\n",
340 (int)resp_buf.size());
341
342 // Timed out: consume this entry
343 resp_buf.get(last_send);
344 }
345}
346
347static void send_buf_send_one(uint16_t timeout = SdepTimeout) {
348 struct queue_item item;
349
350 // Don't send anything more until we get an ACK
351 if (!resp_buf.empty()) {
352 return;
353 }
354
355 if (!send_buf.peek(item)) {
356 return;
357 }
358 if (process_queue_item(&item, timeout)) {
359 // commit that peek
360 send_buf.get(item);
361 dprintf("send_buf_send_one: have %d remaining\n", (int)send_buf.size());
362 } else {
363 dprint("failed to send, will retry\n");
364 _delay_ms(SdepTimeout);
365 resp_buf_read_one(true);
366 }
367}
368
369static void resp_buf_wait(const char *cmd) {
370 bool didPrint = false;
371 while (!resp_buf.empty()) {
372 if (!didPrint) {
373 dprintf("wait on buf for %s\n", cmd);
374 didPrint = true;
375 }
376 resp_buf_read_one(true);
377 }
378}
379
380static bool ble_init(void) {
381 state.initialized = false;
382 state.configured = false;
383 state.is_connected = false;
384
385 pinMode(AdafruitBleIRQPin, PinDirectionInput);
386 pinMode(AdafruitBleCSPin, PinDirectionOutput);
387 digitalWrite(AdafruitBleCSPin, PinLevelHigh);
388
389 SPI_init(&spi);
390
391 // Perform a hardware reset
392 pinMode(AdafruitBleResetPin, PinDirectionOutput);
393 digitalWrite(AdafruitBleResetPin, PinLevelHigh);
394 digitalWrite(AdafruitBleResetPin, PinLevelLow);
395 _delay_ms(10);
396 digitalWrite(AdafruitBleResetPin, PinLevelHigh);
397
398 _delay_ms(1000); // Give it a second to initialize
399
400 state.initialized = true;
401 return state.initialized;
402}
403
404static inline uint8_t min(uint8_t a, uint8_t b) {
405 return a < b ? a : b;
406}
407
408static bool read_response(char *resp, uint16_t resplen, bool verbose) {
409 char *dest = resp;
410 char *end = dest + resplen;
411
412 while (true) {
413 struct sdep_msg msg;
414
415 if (!sdep_recv_pkt(&msg, 2 * SdepTimeout)) {
416 dprint("sdep_recv_pkt failed\n");
417 return false;
418 }
419
420 if (msg.type != SdepResponse) {
421 *resp = 0;
422 return false;
423 }
424
425 uint8_t len = min(msg.len, end - dest);
426 if (len > 0) {
427 memcpy(dest, msg.payload, len);
428 dest += len;
429 }
430
431 if (!msg.more) {
432 // No more data is expected!
433 break;
434 }
435 }
436
437 // Ensure the response is NUL terminated
438 *dest = 0;
439
440 // "Parse" the result text; we want to snip off the trailing OK or ERROR line
441 // Rewind past the possible trailing CRLF so that we can strip it
442 --dest;
443 while (dest > resp && (dest[0] == '\n' || dest[0] == '\r')) {
444 *dest = 0;
445 --dest;
446 }
447
448 // Look back for start of preceeding line
449 char *last_line = strrchr(resp, '\n');
450 if (last_line) {
451 ++last_line;
452 } else {
453 last_line = resp;
454 }
455
456 bool success = false;
457 static const char kOK[] PROGMEM = "OK";
458
459 success = !strcmp_P(last_line, kOK );
460
461 if (verbose || !success) {
462 dprintf("result: %s\n", resp);
463 }
464 return success;
465}
466
467static bool at_command(const char *cmd, char *resp, uint16_t resplen,
468 bool verbose, uint16_t timeout) {
469 const char *end = cmd + strlen(cmd);
470 struct sdep_msg msg;
471
472 if (verbose) {
473 dprintf("ble send: %s\n", cmd);
474 }
475
476 if (resp) {
477 // They want to decode the response, so we need to flush and wait
478 // for all pending I/O to finish before we start this one, so
479 // that we don't confuse the results
480 resp_buf_wait(cmd);
481 *resp = 0;
482 }
483
484 // Fragment the command into a series of SDEP packets
485 while (end - cmd > SdepMaxPayload) {
486 sdep_build_pkt(&msg, BleAtWrapper, (uint8_t *)cmd, SdepMaxPayload, true);
487 if (!sdep_send_pkt(&msg, timeout)) {
488 return false;
489 }
490 cmd += SdepMaxPayload;
491 }
492
493 sdep_build_pkt(&msg, BleAtWrapper, (uint8_t *)cmd, end - cmd, false);
494 if (!sdep_send_pkt(&msg, timeout)) {
495 return false;
496 }
497
498 if (resp == NULL) {
499 auto now = timer_read();
500 while (!resp_buf.enqueue(now)) {
501 resp_buf_read_one(false);
502 }
503 auto later = timer_read();
504 if (TIMER_DIFF_16(later, now) > 0) {
505 dprintf("waited %dms for resp_buf\n", TIMER_DIFF_16(later, now));
506 }
507 return true;
508 }
509
510 return read_response(resp, resplen, verbose);
511}
512
513bool at_command_P(const char *cmd, char *resp, uint16_t resplen, bool verbose) {
514 auto cmdbuf = (char *)alloca(strlen_P(cmd) + 1);
515 strcpy_P(cmdbuf, cmd);
516 return at_command(cmdbuf, resp, resplen, verbose);
517}
518
519bool adafruit_ble_is_connected(void) {
520 return state.is_connected;
521}
522
523bool adafruit_ble_enable_keyboard(void) {
524 char resbuf[128];
525
526 if (!state.initialized && !ble_init()) {
527 return false;
528 }
529
530 state.configured = false;
531
532 // Disable command echo
533 static const char kEcho[] PROGMEM = "ATE=0";
534 // Make the advertised name match the keyboard
535 static const char kGapDevName[] PROGMEM =
536 "AT+GAPDEVNAME=" STR(PRODUCT) " " STR(DESCRIPTION);
537 // Turn on keyboard support
538 static const char kHidEnOn[] PROGMEM = "AT+BLEHIDEN=1";
539
540 // Adjust intervals to improve latency. This causes the "central"
541 // system (computer/tablet) to poll us every 10-30 ms. We can't
542 // set a smaller value than 10ms, and 30ms seems to be the natural
543 // processing time on my macbook. Keeping it constrained to that
544 // feels reasonable to type to.
545 static const char kGapIntervals[] PROGMEM = "AT+GAPINTERVALS=10,30,,";
546
547 // Reset the device so that it picks up the above changes
548 static const char kATZ[] PROGMEM = "ATZ";
549
550 // Turn down the power level a bit
551 static const char kPower[] PROGMEM = "AT+BLEPOWERLEVEL=-12";
552 static PGM_P const configure_commands[] PROGMEM = {
553 kEcho,
554 kGapIntervals,
555 kGapDevName,
556 kHidEnOn,
557 kPower,
558 kATZ,
559 };
560
561 uint8_t i;
562 for (i = 0; i < sizeof(configure_commands) / sizeof(configure_commands[0]);
563 ++i) {
564 PGM_P cmd;
565 memcpy_P(&cmd, configure_commands + i, sizeof(cmd));
566
567 if (!at_command_P(cmd, resbuf, sizeof(resbuf))) {
568 dprintf("failed BLE command: %S: %s\n", cmd, resbuf);
569 goto fail;
570 }
571 }
572
573 state.configured = true;
574
575 // Check connection status in a little while; allow the ATZ time
576 // to kick in.
577 state.last_connection_update = timer_read();
578fail:
579 return state.configured;
580}
581
582static void set_connected(bool connected) {
583 if (connected != state.is_connected) {
584 if (connected) {
585 print("****** BLE CONNECT!!!!\n");
586 } else {
587 print("****** BLE DISCONNECT!!!!\n");
588 }
589 state.is_connected = connected;
590
591 // TODO: if modifiers are down on the USB interface and
592 // we cut over to BLE or vice versa, they will remain stuck.
593 // This feels like a good point to do something like clearing
594 // the keyboard and/or generating a fake all keys up message.
595 // However, I've noticed that it takes a couple of seconds
596 // for macOS to to start recognizing key presses after BLE
597 // is in the connected state, so I worry that doing that
598 // here may not be good enough.
599 }
600}
601
602void adafruit_ble_task(void) {
603 char resbuf[48];
604
605 if (!state.configured && !adafruit_ble_enable_keyboard()) {
606 return;
607 }
608 resp_buf_read_one(true);
609 send_buf_send_one(SdepShortTimeout);
610
611 if (resp_buf.empty() && (state.event_flags & UsingEvents) &&
612 digitalRead(AdafruitBleIRQPin)) {
613 // Must be an event update
614 if (at_command_P(PSTR("AT+EVENTSTATUS"), resbuf, sizeof(resbuf))) {
615 uint32_t mask = strtoul(resbuf, NULL, 16);
616
617 if (mask & BleSystemConnected) {
618 set_connected(true);
619 } else if (mask & BleSystemDisconnected) {
620 set_connected(false);
621 }
622 }
623 }
624
625 if (timer_elapsed(state.last_connection_update) > ConnectionUpdateInterval) {
626 bool shouldPoll = true;
627 if (!(state.event_flags & ProbedEvents)) {
628 // Request notifications about connection status changes.
629 // This only works in SPIFRIEND firmware > 0.6.7, which is why
630 // we check for this conditionally here.
631 // Note that at the time of writing, HID reports only work correctly
632 // with Apple products on firmware version 0.6.7!
633 // https://forums.adafruit.com/viewtopic.php?f=8&t=104052
634 if (at_command_P(PSTR("AT+EVENTENABLE=0x1"), resbuf, sizeof(resbuf))) {
635 at_command_P(PSTR("AT+EVENTENABLE=0x2"), resbuf, sizeof(resbuf));
636 state.event_flags |= UsingEvents;
637 }
638 state.event_flags |= ProbedEvents;
639
640 // leave shouldPoll == true so that we check at least once
641 // before relying solely on events
642 } else {
643 shouldPoll = false;
644 }
645
646 static const char kGetConn[] PROGMEM = "AT+GAPGETCONN";
647 state.last_connection_update = timer_read();
648
649 if (at_command_P(kGetConn, resbuf, sizeof(resbuf))) {
650 set_connected(atoi(resbuf));
651 }
652 }
653
654#ifdef SAMPLE_BATTERY
655 // I don't know if this really does anything useful yet; the reported
656 // voltage level always seems to be around 3200mV. We may want to just rip
657 // this code out.
658 if (timer_elapsed(state.last_battery_update) > BatteryUpdateInterval &&
659 resp_buf.empty()) {
660 state.last_battery_update = timer_read();
661
662 if (at_command_P(PSTR("AT+HWVBAT"), resbuf, sizeof(resbuf))) {
663 state.vbat = atoi(resbuf);
664 }
665 }
666#endif
667}
668
669static bool process_queue_item(struct queue_item *item, uint16_t timeout) {
670 char cmdbuf[48];
671 char fmtbuf[64];
672
673 // Arrange to re-check connection after keys have settled
674 state.last_connection_update = timer_read();
675
676#if 1
677 if (TIMER_DIFF_16(state.last_connection_update, item->added) > 0) {
678 dprintf("send latency %dms\n",
679 TIMER_DIFF_16(state.last_connection_update, item->added));
680 }
681#endif
682
683 switch (item->queue_type) {
684 case QTKeyReport:
685 strcpy_P(fmtbuf,
686 PSTR("AT+BLEKEYBOARDCODE=%02x-00-%02x-%02x-%02x-%02x-%02x-%02x"));
687 snprintf(cmdbuf, sizeof(cmdbuf), fmtbuf, item->key.modifier,
688 item->key.keys[0], item->key.keys[1], item->key.keys[2],
689 item->key.keys[3], item->key.keys[4], item->key.keys[5]);
690 return at_command(cmdbuf, NULL, 0, true, timeout);
691
692 case QTConsumer:
693 strcpy_P(fmtbuf, PSTR("AT+BLEHIDCONTROLKEY=0x%04x"));
694 snprintf(cmdbuf, sizeof(cmdbuf), fmtbuf, item->consumer);
695 return at_command(cmdbuf, NULL, 0, true, timeout);
696
697#ifdef MOUSE_ENABLE
698 case QTMouseMove:
699 strcpy_P(fmtbuf, PSTR("AT+BLEHIDMOUSEMOVE=%d,%d,%d,%d"));
700 snprintf(cmdbuf, sizeof(cmdbuf), fmtbuf, item->mousemove.x,
701 item->mousemove.y, item->mousemove.scroll, item->mousemove.pan);
702 return at_command(cmdbuf, NULL, 0, true, timeout);
703#endif
704 default:
705 return true;
706 }
707}
708
709bool adafruit_ble_send_keys(uint8_t hid_modifier_mask, uint8_t *keys,
710 uint8_t nkeys) {
711 struct queue_item item;
712 bool didWait = false;
713
714 item.queue_type = QTKeyReport;
715 item.key.modifier = hid_modifier_mask;
716 item.added = timer_read();
717
718 while (nkeys >= 0) {
719 item.key.keys[0] = keys[0];
720 item.key.keys[1] = nkeys >= 1 ? keys[1] : 0;
721 item.key.keys[2] = nkeys >= 2 ? keys[2] : 0;
722 item.key.keys[3] = nkeys >= 3 ? keys[3] : 0;
723 item.key.keys[4] = nkeys >= 4 ? keys[4] : 0;
724 item.key.keys[5] = nkeys >= 5 ? keys[5] : 0;
725
726 if (!send_buf.enqueue(item)) {
727 if (!didWait) {
728 dprint("wait for buf space\n");
729 didWait = true;
730 }
731 send_buf_send_one();
732 continue;
733 }
734
735 if (nkeys <= 6) {
736 return true;
737 }
738
739 nkeys -= 6;
740 keys += 6;
741 }
742
743 return true;
744}
745
746bool adafruit_ble_send_consumer_key(uint16_t keycode, int hold_duration) {
747 struct queue_item item;
748
749 item.queue_type = QTConsumer;
750 item.consumer = keycode;
751
752 while (!send_buf.enqueue(item)) {
753 send_buf_send_one();
754 }
755 return true;
756}
757
758#ifdef MOUSE_ENABLE
759bool adafruit_ble_send_mouse_move(int8_t x, int8_t y, int8_t scroll,
760 int8_t pan) {
761 struct queue_item item;
762
763 item.queue_type = QTMouseMove;
764 item.mousemove.x = x;
765 item.mousemove.y = y;
766 item.mousemove.scroll = scroll;
767 item.mousemove.pan = pan;
768
769 while (!send_buf.enqueue(item)) {
770 send_buf_send_one();
771 }
772 return true;
773}
774#endif
775
776uint32_t adafruit_ble_read_battery_voltage(void) {
777 return state.vbat;
778}
779
780bool adafruit_ble_set_mode_leds(bool on) {
781 if (!state.configured) {
782 return false;
783 }
784
785 // The "mode" led is the red blinky one
786 at_command_P(on ? PSTR("AT+HWMODELED=1") : PSTR("AT+HWMODELED=0"), NULL, 0);
787
788 // Pin 19 is the blue "connected" LED; turn that off too.
789 // When turning LEDs back on, don't turn that LED on if we're
790 // not connected, as that would be confusing.
791 at_command_P(on && state.is_connected ? PSTR("AT+HWGPIO=19,1")
792 : PSTR("AT+HWGPIO=19,0"),
793 NULL, 0);
794 return true;
795}
796
797// https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le/ble-generic#at-plus-blepowerlevel
798bool adafruit_ble_set_power_level(int8_t level) {
799 char cmd[46];
800 if (!state.configured) {
801 return false;
802 }
803 snprintf(cmd, sizeof(cmd), "AT+BLEPOWERLEVEL=%d", level);
804 return at_command(cmd, NULL, 0, false);
805}
diff --git a/tmk_core/protocol/lufa/adafruit_ble.h b/tmk_core/protocol/lufa/adafruit_ble.h
new file mode 100644
index 000000000..351fd55ae
--- /dev/null
+++ b/tmk_core/protocol/lufa/adafruit_ble.h
@@ -0,0 +1,60 @@
1/* Bluetooth Low Energy Protocol for QMK.
2 * Author: Wez Furlong, 2016
3 * Supports the Adafruit BLE board built around the nRF51822 chip.
4 */
5#pragma once
6#ifdef ADAFRUIT_BLE_ENABLE
7#include <stdbool.h>
8#include <stdint.h>
9#include <string.h>
10
11#ifdef __cplusplus
12extern "C" {
13#endif
14
15/* Instruct the module to enable HID keyboard support and reset */
16extern bool adafruit_ble_enable_keyboard(void);
17
18/* Query to see if the BLE module is connected */
19extern bool adafruit_ble_query_is_connected(void);
20
21/* Returns true if we believe that the BLE module is connected.
22 * This uses our cached understanding that is maintained by
23 * calling ble_task() periodically. */
24extern bool adafruit_ble_is_connected(void);
25
26/* Call this periodically to process BLE-originated things */
27extern void adafruit_ble_task(void);
28
29/* Generates keypress events for a set of keys.
30 * The hid modifier mask specifies the state of the modifier keys for
31 * this set of keys.
32 * Also sends a key release indicator, so that the keys do not remain
33 * held down. */
34extern bool adafruit_ble_send_keys(uint8_t hid_modifier_mask, uint8_t *keys,
35 uint8_t nkeys);
36
37/* Send a consumer keycode, holding it down for the specified duration
38 * (milliseconds) */
39extern bool adafruit_ble_send_consumer_key(uint16_t keycode, int hold_duration);
40
41#ifdef MOUSE_ENABLE
42/* Send a mouse/wheel movement report.
43 * The parameters are signed and indicate positive of negative direction
44 * change. */
45extern bool adafruit_ble_send_mouse_move(int8_t x, int8_t y, int8_t scroll,
46 int8_t pan);
47#endif
48
49/* Compute battery voltage by reading an analog pin.
50 * Returns the integer number of millivolts */
51extern uint32_t adafruit_ble_read_battery_voltage(void);
52
53extern bool adafruit_ble_set_mode_leds(bool on);
54extern bool adafruit_ble_set_power_level(int8_t level);
55
56#ifdef __cplusplus
57}
58#endif
59
60#endif // ADAFRUIT_BLE_ENABLE
diff --git a/tmk_core/protocol/lufa/descriptor.c b/tmk_core/protocol/lufa/descriptor.c
index 6f2407f58..bf47787d2 100644
--- a/tmk_core/protocol/lufa/descriptor.c
+++ b/tmk_core/protocol/lufa/descriptor.c
@@ -164,6 +164,28 @@ const USB_Descriptor_HIDReport_Datatype_t PROGMEM ExtrakeyReport[] =
164}; 164};
165#endif 165#endif
166 166
167#ifdef RAW_ENABLE
168const USB_Descriptor_HIDReport_Datatype_t PROGMEM RawReport[] =
169{
170 HID_RI_USAGE_PAGE(16, 0xFF60), /* Vendor Page 0xFF60 */
171 HID_RI_USAGE(8, 0x61), /* Vendor Usage 0x61 */
172 HID_RI_COLLECTION(8, 0x01), /* Application */
173 HID_RI_USAGE(8, 0x62), /* Vendor Usage 0x62 */
174 HID_RI_LOGICAL_MINIMUM(8, 0x00),
175 HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
176 HID_RI_REPORT_COUNT(8, RAW_EPSIZE),
177 HID_RI_REPORT_SIZE(8, 0x08),
178 HID_RI_INPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE),
179 HID_RI_USAGE(8, 0x63), /* Vendor Usage 0x63 */
180 HID_RI_LOGICAL_MINIMUM(8, 0x00),
181 HID_RI_LOGICAL_MAXIMUM(16, 0x00FF),
182 HID_RI_REPORT_COUNT(8, RAW_EPSIZE),
183 HID_RI_REPORT_SIZE(8, 0x08),
184 HID_RI_OUTPUT(8, HID_IOF_DATA | HID_IOF_VARIABLE | HID_IOF_ABSOLUTE | HID_IOF_NON_VOLATILE),
185 HID_RI_END_COLLECTION(0),
186};
187#endif
188
167#ifdef CONSOLE_ENABLE 189#ifdef CONSOLE_ENABLE
168const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] = 190const USB_Descriptor_HIDReport_Datatype_t PROGMEM ConsoleReport[] =
169{ 191{
@@ -399,6 +421,58 @@ const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
399 }, 421 },
400#endif 422#endif
401 423
424 /*
425 * Raw
426 */
427 #ifdef RAW_ENABLE
428 .Raw_Interface =
429 {
430 .Header = {.Size = sizeof(USB_Descriptor_Interface_t), .Type = DTYPE_Interface},
431
432 .InterfaceNumber = RAW_INTERFACE,
433 .AlternateSetting = 0x00,
434
435 .TotalEndpoints = 2,
436
437 .Class = HID_CSCP_HIDClass,
438 .SubClass = HID_CSCP_NonBootSubclass,
439 .Protocol = HID_CSCP_NonBootProtocol,
440
441 .InterfaceStrIndex = NO_DESCRIPTOR
442 },
443
444 .Raw_HID =
445 {
446 .Header = {.Size = sizeof(USB_HID_Descriptor_HID_t), .Type = HID_DTYPE_HID},
447
448 .HIDSpec = VERSION_BCD(1,1,1),
449 .CountryCode = 0x00,
450 .TotalReportDescriptors = 1,
451 .HIDReportType = HID_DTYPE_Report,
452 .HIDReportLength = sizeof(RawReport)
453 },
454
455 .Raw_INEndpoint =
456 {
457 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
458
459 .EndpointAddress = (ENDPOINT_DIR_IN | RAW_IN_EPNUM),
460 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
461 .EndpointSize = RAW_EPSIZE,
462 .PollingIntervalMS = 0x01
463 },
464
465 .Raw_OUTEndpoint =
466 {
467 .Header = {.Size = sizeof(USB_Descriptor_Endpoint_t), .Type = DTYPE_Endpoint},
468
469 .EndpointAddress = (ENDPOINT_DIR_OUT | RAW_OUT_EPNUM),
470 .Attributes = (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC | ENDPOINT_USAGE_DATA),
471 .EndpointSize = RAW_EPSIZE,
472 .PollingIntervalMS = 0x01
473 },
474 #endif
475
402 /* 476 /*
403 * Console 477 * Console
404 */ 478 */
@@ -754,7 +828,6 @@ const USB_Descriptor_Configuration_t PROGMEM ConfigurationDescriptor =
754 .PollingIntervalMS = 0x05 828 .PollingIntervalMS = 0x05
755 }, 829 },
756#endif 830#endif
757
758}; 831};
759 832
760 833
@@ -846,6 +919,12 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
846 Size = sizeof(USB_HID_Descriptor_HID_t); 919 Size = sizeof(USB_HID_Descriptor_HID_t);
847 break; 920 break;
848#endif 921#endif
922#ifdef RAW_ENABLE
923 case RAW_INTERFACE:
924 Address = &ConfigurationDescriptor.Raw_HID;
925 Size = sizeof(USB_HID_Descriptor_HID_t);
926 break;
927#endif
849#ifdef CONSOLE_ENABLE 928#ifdef CONSOLE_ENABLE
850 case CONSOLE_INTERFACE: 929 case CONSOLE_INTERFACE:
851 Address = &ConfigurationDescriptor.Console_HID; 930 Address = &ConfigurationDescriptor.Console_HID;
@@ -878,6 +957,12 @@ uint16_t CALLBACK_USB_GetDescriptor(const uint16_t wValue,
878 Size = sizeof(ExtrakeyReport); 957 Size = sizeof(ExtrakeyReport);
879 break; 958 break;
880#endif 959#endif
960#ifdef RAW_ENABLE
961 case RAW_INTERFACE:
962 Address = &RawReport;
963 Size = sizeof(RawReport);
964 break;
965#endif
881#ifdef CONSOLE_ENABLE 966#ifdef CONSOLE_ENABLE
882 case CONSOLE_INTERFACE: 967 case CONSOLE_INTERFACE:
883 Address = &ConsoleReport; 968 Address = &ConsoleReport;
diff --git a/tmk_core/protocol/lufa/descriptor.h b/tmk_core/protocol/lufa/descriptor.h
index c6c94e361..24ce420e6 100644
--- a/tmk_core/protocol/lufa/descriptor.h
+++ b/tmk_core/protocol/lufa/descriptor.h
@@ -71,6 +71,14 @@ typedef struct
71 USB_Descriptor_Endpoint_t Extrakey_INEndpoint; 71 USB_Descriptor_Endpoint_t Extrakey_INEndpoint;
72#endif 72#endif
73 73
74#ifdef RAW_ENABLE
75 // Raw HID Interface
76 USB_Descriptor_Interface_t Raw_Interface;
77 USB_HID_Descriptor_HID_t Raw_HID;
78 USB_Descriptor_Endpoint_t Raw_INEndpoint;
79 USB_Descriptor_Endpoint_t Raw_OUTEndpoint;
80#endif
81
74#ifdef CONSOLE_ENABLE 82#ifdef CONSOLE_ENABLE
75 // Console HID Interface 83 // Console HID Interface
76 USB_Descriptor_Interface_t Console_Interface; 84 USB_Descriptor_Interface_t Console_Interface;
@@ -137,10 +145,16 @@ typedef struct
137# define EXTRAKEY_INTERFACE MOUSE_INTERFACE 145# define EXTRAKEY_INTERFACE MOUSE_INTERFACE
138#endif 146#endif
139 147
148#ifdef RAW_ENABLE
149# define RAW_INTERFACE (EXTRAKEY_INTERFACE + 1)
150#else
151# define RAW_INTERFACE EXTRAKEY_INTERFACE
152#endif
153
140#ifdef CONSOLE_ENABLE 154#ifdef CONSOLE_ENABLE
141# define CONSOLE_INTERFACE (EXTRAKEY_INTERFACE + 1) 155# define CONSOLE_INTERFACE (RAW_INTERFACE + 1)
142#else 156#else
143# define CONSOLE_INTERFACE EXTRAKEY_INTERFACE 157# define CONSOLE_INTERFACE RAW_INTERFACE
144#endif 158#endif
145 159
146#ifdef NKRO_ENABLE 160#ifdef NKRO_ENABLE
@@ -182,12 +196,19 @@ typedef struct
182# define EXTRAKEY_IN_EPNUM MOUSE_IN_EPNUM 196# define EXTRAKEY_IN_EPNUM MOUSE_IN_EPNUM
183#endif 197#endif
184 198
199#ifdef RAW_ENABLE
200# define RAW_IN_EPNUM (EXTRAKEY_IN_EPNUM + 1)
201# define RAW_OUT_EPNUM (EXTRAKEY_IN_EPNUM + 2)
202#else
203# define RAW_OUT_EPNUM EXTRAKEY_IN_EPNUM
204#endif
205
185#ifdef CONSOLE_ENABLE 206#ifdef CONSOLE_ENABLE
186# define CONSOLE_IN_EPNUM (EXTRAKEY_IN_EPNUM + 1) 207# define CONSOLE_IN_EPNUM (RAW_OUT_EPNUM + 1)
187# define CONSOLE_OUT_EPNUM (EXTRAKEY_IN_EPNUM + 1) 208//# define CONSOLE_OUT_EPNUM (RAW_OUT_EPNUM + 2)
188//# define CONSOLE_OUT_EPNUM (EXTRAKEY_IN_EPNUM + 2) 209# define CONSOLE_OUT_EPNUM (RAW_OUT_EPNUM + 1)
189#else 210#else
190# define CONSOLE_OUT_EPNUM EXTRAKEY_IN_EPNUM 211# define CONSOLE_OUT_EPNUM RAW_OUT_EPNUM
191#endif 212#endif
192 213
193#ifdef NKRO_ENABLE 214#ifdef NKRO_ENABLE
@@ -217,7 +238,6 @@ typedef struct
217# define CDC_OUT_EPNUM MIDI_STREAM_OUT_EPNUM 238# define CDC_OUT_EPNUM MIDI_STREAM_OUT_EPNUM
218#endif 239#endif
219 240
220
221#if defined(__AVR_ATmega32U2__) && CDC_OUT_EPNUM > 4 241#if defined(__AVR_ATmega32U2__) && CDC_OUT_EPNUM > 4
222# error "Endpoints are not available enough to support all functions. Remove some in Makefile.(MOUSEKEY, EXTRAKEY, CONSOLE, NKRO, MIDI, SERIAL)" 242# error "Endpoints are not available enough to support all functions. Remove some in Makefile.(MOUSEKEY, EXTRAKEY, CONSOLE, NKRO, MIDI, SERIAL)"
223#endif 243#endif
@@ -225,6 +245,7 @@ typedef struct
225#define KEYBOARD_EPSIZE 8 245#define KEYBOARD_EPSIZE 8
226#define MOUSE_EPSIZE 8 246#define MOUSE_EPSIZE 8
227#define EXTRAKEY_EPSIZE 8 247#define EXTRAKEY_EPSIZE 8
248#define RAW_EPSIZE 32
228#define CONSOLE_EPSIZE 32 249#define CONSOLE_EPSIZE 32
229#define NKRO_EPSIZE 32 250#define NKRO_EPSIZE 32
230#define MIDI_STREAM_EPSIZE 64 251#define MIDI_STREAM_EPSIZE 64
diff --git a/tmk_core/protocol/lufa/lufa.c b/tmk_core/protocol/lufa/lufa.c
index 01c0e45b0..dd78fe621 100644
--- a/tmk_core/protocol/lufa/lufa.c
+++ b/tmk_core/protocol/lufa/lufa.c
@@ -51,6 +51,8 @@
51 51
52#include "descriptor.h" 52#include "descriptor.h"
53#include "lufa.h" 53#include "lufa.h"
54#include "quantum.h"
55#include <util/atomic.h>
54 56
55#ifdef NKRO_ENABLE 57#ifdef NKRO_ENABLE
56 #include "keycode_config.h" 58 #include "keycode_config.h"
@@ -66,11 +68,26 @@
66#ifdef BLUETOOTH_ENABLE 68#ifdef BLUETOOTH_ENABLE
67 #include "bluetooth.h" 69 #include "bluetooth.h"
68#endif 70#endif
71#ifdef ADAFRUIT_BLE_ENABLE
72 #include "adafruit_ble.h"
73#endif
69 74
70#ifdef VIRTSER_ENABLE 75#ifdef VIRTSER_ENABLE
71 #include "virtser.h" 76 #include "virtser.h"
72#endif 77#endif
73 78
79#if (defined(RGB_MIDI) | defined(RGBLIGHT_ANIMATIONS)) & defined(RGBLIGHT_ENABLE)
80 #include "rgblight.h"
81#endif
82
83#ifdef MIDI_ENABLE
84 #include "sysex_tools.h"
85#endif
86
87#ifdef RAW_ENABLE
88 #include "raw_hid.h"
89#endif
90
74uint8_t keyboard_idle = 0; 91uint8_t keyboard_idle = 0;
75/* 0: Boot Protocol, 1: Report Protocol(default) */ 92/* 0: Boot Protocol, 1: Report Protocol(default) */
76uint8_t keyboard_protocol = 1; 93uint8_t keyboard_protocol = 1;
@@ -79,9 +96,9 @@ static uint8_t keyboard_led_stats = 0;
79static report_keyboard_t keyboard_report_sent; 96static report_keyboard_t keyboard_report_sent;
80 97
81#ifdef MIDI_ENABLE 98#ifdef MIDI_ENABLE
82void usb_send_func(MidiDevice * device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2); 99static void usb_send_func(MidiDevice * device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2);
83void usb_get_midi(MidiDevice * device); 100static void usb_get_midi(MidiDevice * device);
84void midi_usb_init(MidiDevice * device); 101static void midi_usb_init(MidiDevice * device);
85#endif 102#endif
86 103
87/* Host driver */ 104/* Host driver */
@@ -166,6 +183,80 @@ USB_ClassInfo_CDC_Device_t cdc_device =
166}; 183};
167#endif 184#endif
168 185
186#ifdef RAW_ENABLE
187
188void raw_hid_send( uint8_t *data, uint8_t length )
189{
190 // TODO: implement variable size packet
191 if ( length != RAW_EPSIZE )
192 {
193 return;
194 }
195
196 if (USB_DeviceState != DEVICE_STATE_Configured)
197 {
198 return;
199 }
200
201 // TODO: decide if we allow calls to raw_hid_send() in the middle
202 // of other endpoint usage.
203 uint8_t ep = Endpoint_GetCurrentEndpoint();
204
205 Endpoint_SelectEndpoint(RAW_IN_EPNUM);
206
207 // Check to see if the host is ready to accept another packet
208 if (Endpoint_IsINReady())
209 {
210 // Write data
211 Endpoint_Write_Stream_LE(data, RAW_EPSIZE, NULL);
212 // Finalize the stream transfer to send the last packet
213 Endpoint_ClearIN();
214 }
215
216 Endpoint_SelectEndpoint(ep);
217}
218
219__attribute__ ((weak))
220void raw_hid_receive( uint8_t *data, uint8_t length )
221{
222 // Users should #include "raw_hid.h" in their own code
223 // and implement this function there. Leave this as weak linkage
224 // so users can opt to not handle data coming in.
225}
226
227static void raw_hid_task(void)
228{
229 // Create a temporary buffer to hold the read in data from the host
230 uint8_t data[RAW_EPSIZE];
231 bool data_read = false;
232
233 // Device must be connected and configured for the task to run
234 if (USB_DeviceState != DEVICE_STATE_Configured)
235 return;
236
237 Endpoint_SelectEndpoint(RAW_OUT_EPNUM);
238
239 // Check to see if a packet has been sent from the host
240 if (Endpoint_IsOUTReceived())
241 {
242 // Check to see if the packet contains data
243 if (Endpoint_IsReadWriteAllowed())
244 {
245 /* Read data */
246 Endpoint_Read_Stream_LE(data, sizeof(data), NULL);
247 data_read = true;
248 }
249
250 // Finalize the stream transfer to receive the last packet
251 Endpoint_ClearOUT();
252
253 if ( data_read )
254 {
255 raw_hid_receive( data, sizeof(data) );
256 }
257 }
258}
259#endif
169 260
170/******************************************************************************* 261/*******************************************************************************
171 * Console 262 * Console
@@ -285,10 +376,14 @@ void EVENT_USB_Device_WakeUp()
285#endif 376#endif
286} 377}
287 378
379
380
288#ifdef CONSOLE_ENABLE 381#ifdef CONSOLE_ENABLE
289static bool console_flush = false; 382static bool console_flush = false;
290#define CONSOLE_FLUSH_SET(b) do { \ 383#define CONSOLE_FLUSH_SET(b) do { \
291 uint8_t sreg = SREG; cli(); console_flush = b; SREG = sreg; \ 384 ATOMIC_BLOCK(ATOMIC_RESTORESTATE) {\
385 console_flush = b; \
386 } \
292} while (0) 387} while (0)
293 388
294// called every 1ms 389// called every 1ms
@@ -302,6 +397,7 @@ void EVENT_USB_Device_StartOfFrame(void)
302 Console_Task(); 397 Console_Task();
303 console_flush = false; 398 console_flush = false;
304} 399}
400
305#endif 401#endif
306 402
307/** Event handler for the USB_ConfigurationChanged event. 403/** Event handler for the USB_ConfigurationChanged event.
@@ -330,6 +426,14 @@ void EVENT_USB_Device_ConfigurationChanged(void)
330 EXTRAKEY_EPSIZE, ENDPOINT_BANK_SINGLE); 426 EXTRAKEY_EPSIZE, ENDPOINT_BANK_SINGLE);
331#endif 427#endif
332 428
429#ifdef RAW_ENABLE
430 /* Setup Raw HID Report Endpoints */
431 ConfigSuccess &= ENDPOINT_CONFIG(RAW_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
432 RAW_EPSIZE, ENDPOINT_BANK_SINGLE);
433 ConfigSuccess &= ENDPOINT_CONFIG(RAW_OUT_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_OUT,
434 RAW_EPSIZE, ENDPOINT_BANK_SINGLE);
435#endif
436
333#ifdef CONSOLE_ENABLE 437#ifdef CONSOLE_ENABLE
334 /* Setup Console HID Report Endpoints */ 438 /* Setup Console HID Report Endpoints */
335 ConfigSuccess &= ENDPOINT_CONFIG(CONSOLE_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN, 439 ConfigSuccess &= ENDPOINT_CONFIG(CONSOLE_IN_EPNUM, EP_TYPE_INTERRUPT, ENDPOINT_DIR_IN,
@@ -492,9 +596,35 @@ static uint8_t keyboard_leds(void)
492 return keyboard_led_stats; 596 return keyboard_led_stats;
493} 597}
494 598
599#define SendToUSB 1
600#define SendToBT 2
601#define SendToBLE 4
602
603static inline uint8_t where_to_send(void) {
604#ifdef ADAFRUIT_BLE_ENABLE
605#if 0
606 if (adafruit_ble_is_connected()) {
607 // For testing, send to BLE as a priority
608 return SendToBLE;
609 }
610#endif
611
612 // This is the real policy
613 if (USB_DeviceState != DEVICE_STATE_Configured) {
614 if (adafruit_ble_is_connected()) {
615 return SendToBLE;
616 }
617 }
618#endif
619 return ((USB_DeviceState == DEVICE_STATE_Configured) ? SendToUSB : 0)
620#ifdef BLUETOOTH_ENABLE
621 || SendToBT
622#endif
623 ;
624}
625
495static void send_keyboard(report_keyboard_t *report) 626static void send_keyboard(report_keyboard_t *report)
496{ 627{
497
498#ifdef BLUETOOTH_ENABLE 628#ifdef BLUETOOTH_ENABLE
499 bluefruit_serial_send(0xFD); 629 bluefruit_serial_send(0xFD);
500 for (uint8_t i = 0; i < KEYBOARD_EPSIZE; i++) { 630 for (uint8_t i = 0; i < KEYBOARD_EPSIZE; i++) {
@@ -503,9 +633,17 @@ static void send_keyboard(report_keyboard_t *report)
503#endif 633#endif
504 634
505 uint8_t timeout = 255; 635 uint8_t timeout = 255;
636 uint8_t where = where_to_send();
506 637
507 if (USB_DeviceState != DEVICE_STATE_Configured) 638#ifdef ADAFRUIT_BLE_ENABLE
508 return; 639 if (where & SendToBLE) {
640 adafruit_ble_send_keys(report->mods, report->keys, sizeof(report->keys));
641 }
642#endif
643
644 if (!(where & SendToUSB)) {
645 return;
646 }
509 647
510 /* Select the Keyboard Report Endpoint */ 648 /* Select the Keyboard Report Endpoint */
511#ifdef NKRO_ENABLE 649#ifdef NKRO_ENABLE
@@ -558,8 +696,17 @@ static void send_mouse(report_mouse_t *report)
558 696
559 uint8_t timeout = 255; 697 uint8_t timeout = 255;
560 698
561 if (USB_DeviceState != DEVICE_STATE_Configured) 699 uint8_t where = where_to_send();
562 return; 700
701#ifdef ADAFRUIT_BLE_ENABLE
702 if (where & SendToBLE) {
703 // FIXME: mouse buttons
704 adafruit_ble_send_mouse_move(report->x, report->y, report->v, report->h);
705 }
706#endif
707 if (!(where & SendToUSB)) {
708 return;
709 }
563 710
564 /* Select the Mouse Report Endpoint */ 711 /* Select the Mouse Report Endpoint */
565 Endpoint_SelectEndpoint(MOUSE_IN_EPNUM); 712 Endpoint_SelectEndpoint(MOUSE_IN_EPNUM);
@@ -617,9 +764,16 @@ static void send_consumer(uint16_t data)
617#endif 764#endif
618 765
619 uint8_t timeout = 255; 766 uint8_t timeout = 255;
767 uint8_t where = where_to_send();
620 768
621 if (USB_DeviceState != DEVICE_STATE_Configured) 769#ifdef ADAFRUIT_BLE_ENABLE
622 return; 770 if (where & SendToBLE) {
771 adafruit_ble_send_consumer_key(data, 0);
772 }
773#endif
774 if (!(where & SendToUSB)) {
775 return;
776 }
623 777
624 report_extra_t r = { 778 report_extra_t r = {
625 .report_id = REPORT_ID_CONSUMER, 779 .report_id = REPORT_ID_CONSUMER,
@@ -709,7 +863,7 @@ int8_t sendchar(uint8_t c)
709 ******************************************************************************/ 863 ******************************************************************************/
710 864
711#ifdef MIDI_ENABLE 865#ifdef MIDI_ENABLE
712void usb_send_func(MidiDevice * device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2) { 866static void usb_send_func(MidiDevice * device, uint16_t cnt, uint8_t byte0, uint8_t byte1, uint8_t byte2) {
713 MIDI_EventPacket_t event; 867 MIDI_EventPacket_t event;
714 event.Data1 = byte0; 868 event.Data1 = byte0;
715 event.Data2 = byte1; 869 event.Data2 = byte1;
@@ -769,7 +923,7 @@ void usb_send_func(MidiDevice * device, uint16_t cnt, uint8_t byte0, uint8_t byt
769 USB_USBTask(); 923 USB_USBTask();
770} 924}
771 925
772void usb_get_midi(MidiDevice * device) { 926static void usb_get_midi(MidiDevice * device) {
773 MIDI_EventPacket_t event; 927 MIDI_EventPacket_t event;
774 while (MIDI_Device_ReceiveEventPacket(&USB_MIDI_Interface, &event)) { 928 while (MIDI_Device_ReceiveEventPacket(&USB_MIDI_Interface, &event)) {
775 929
@@ -799,12 +953,12 @@ void usb_get_midi(MidiDevice * device) {
799 USB_USBTask(); 953 USB_USBTask();
800} 954}
801 955
802void midi_usb_init(MidiDevice * device){ 956static void midi_usb_init(MidiDevice * device){
803 midi_device_init(device); 957 midi_device_init(device);
804 midi_device_set_send_func(device, usb_send_func); 958 midi_device_set_send_func(device, usb_send_func);
805 midi_device_set_pre_input_process_func(device, usb_get_midi); 959 midi_device_set_pre_input_process_func(device, usb_get_midi);
806 960
807 SetupHardware(); 961 // SetupHardware();
808 sei(); 962 sei();
809} 963}
810 964
@@ -1029,7 +1183,7 @@ int main(void)
1029 1183
1030 print("Keyboard start.\n"); 1184 print("Keyboard start.\n");
1031 while (1) { 1185 while (1) {
1032 #ifndef BLUETOOTH_ENABLE 1186 #if !defined(BLUETOOTH_ENABLE) && !defined(ADAFRUIT_BLE_ENABLE)
1033 while (USB_DeviceState == DEVICE_STATE_Suspended) { 1187 while (USB_DeviceState == DEVICE_STATE_Suspended) {
1034 print("[s]"); 1188 print("[s]");
1035 suspend_power_down(); 1189 suspend_power_down();
@@ -1039,20 +1193,34 @@ int main(void)
1039 } 1193 }
1040 #endif 1194 #endif
1041 1195
1196 keyboard_task();
1197
1042#ifdef MIDI_ENABLE 1198#ifdef MIDI_ENABLE
1043 midi_device_process(&midi_device); 1199 midi_device_process(&midi_device);
1044 // MIDI_Task(); 1200 // MIDI_Task();
1045#endif 1201#endif
1046 keyboard_task(); 1202
1203#if defined(RGBLIGHT_ANIMATIONS) & defined(RGBLIGHT_ENABLE)
1204 rgblight_task();
1205#endif
1206
1207#ifdef ADAFRUIT_BLE_ENABLE
1208 adafruit_ble_task();
1209#endif
1047 1210
1048#ifdef VIRTSER_ENABLE 1211#ifdef VIRTSER_ENABLE
1049 virtser_task(); 1212 virtser_task();
1050 CDC_Device_USBTask(&cdc_device); 1213 CDC_Device_USBTask(&cdc_device);
1051#endif 1214#endif
1052 1215
1216#ifdef RAW_ENABLE
1217 raw_hid_task();
1218#endif
1219
1053#if !defined(INTERRUPT_CONTROL_ENDPOINT) 1220#if !defined(INTERRUPT_CONTROL_ENDPOINT)
1054 USB_USBTask(); 1221 USB_USBTask();
1055#endif 1222#endif
1223
1056 } 1224 }
1057} 1225}
1058 1226
@@ -1077,15 +1245,38 @@ void fallthrough_callback(MidiDevice * device,
1077#endif 1245#endif
1078} 1246}
1079 1247
1248
1080void cc_callback(MidiDevice * device, 1249void cc_callback(MidiDevice * device,
1081 uint8_t chan, uint8_t num, uint8_t val) { 1250 uint8_t chan, uint8_t num, uint8_t val) {
1082 //sending it back on the next channel 1251 //sending it back on the next channel
1083 midi_send_cc(device, (chan + 1) % 16, num, val); 1252 // midi_send_cc(device, (chan + 1) % 16, num, val);
1084} 1253}
1085 1254
1086void sysex_callback(MidiDevice * device, 1255uint8_t midi_buffer[MIDI_SYSEX_BUFFER] = {0};
1087 uint16_t start, uint8_t length, uint8_t * data) { 1256
1088 for (int i = 0; i < length; i++) 1257void sysex_callback(MidiDevice * device, uint16_t start, uint8_t length, uint8_t * data) {
1089 midi_send_cc(device, 15, 0x7F & data[i], 0x7F & (start + i)); 1258 #ifdef API_SYSEX_ENABLE
1259 // SEND_STRING("\n");
1260 // send_word(start);
1261 // SEND_STRING(": ");
1262 for (uint8_t place = 0; place < length; place++) {
1263 // send_byte(*data);
1264 midi_buffer[start + place] = *data;
1265 if (*data == 0xF7) {
1266 // SEND_STRING("\nRD: ");
1267 // for (uint8_t i = 0; i < start + place + 1; i++){
1268 // send_byte(midi_buffer[i]);
1269 // SEND_STRING(" ");
1270 // }
1271 uint8_t * decoded = malloc(sizeof(uint8_t) * (sysex_decoded_length(start + place - 4)));
1272 uint16_t decode_length = sysex_decode(decoded, midi_buffer + 4, start + place - 4);
1273 process_api(decode_length, decoded);
1274 }
1275 // SEND_STRING(" ");
1276 data++;
1277 }
1278 #endif
1090} 1279}
1280
1281
1091#endif 1282#endif
diff --git a/tmk_core/protocol/lufa/lufa.h b/tmk_core/protocol/lufa/lufa.h
index aad08d640..b11854101 100644
--- a/tmk_core/protocol/lufa/lufa.h
+++ b/tmk_core/protocol/lufa/lufa.h
@@ -68,8 +68,17 @@ typedef struct {
68} __attribute__ ((packed)) report_extra_t; 68} __attribute__ ((packed)) report_extra_t;
69 69
70#ifdef MIDI_ENABLE 70#ifdef MIDI_ENABLE
71void MIDI_Task(void); 71 void MIDI_Task(void);
72MidiDevice midi_device; 72 MidiDevice midi_device;
73 #define MIDI_SYSEX_BUFFER 32
74#endif
75
76#ifdef API_ENABLE
77 #include "api.h"
78#endif
79
80#ifdef API_SYSEX_ENABLE
81 #include "api_sysex.h"
73#endif 82#endif
74 83
75// #if LUFA_VERSION_INTEGER < 0x120730 84// #if LUFA_VERSION_INTEGER < 0x120730
diff --git a/tmk_core/protocol/lufa/ringbuffer.hpp b/tmk_core/protocol/lufa/ringbuffer.hpp
new file mode 100644
index 000000000..70a3c4881
--- /dev/null
+++ b/tmk_core/protocol/lufa/ringbuffer.hpp
@@ -0,0 +1,66 @@
1#pragma once
2// A simple ringbuffer holding Size elements of type T
3template <typename T, uint8_t Size>
4class RingBuffer {
5 protected:
6 T buf_[Size];
7 uint8_t head_{0}, tail_{0};
8 public:
9 inline uint8_t nextPosition(uint8_t position) {
10 return (position + 1) % Size;
11 }
12
13 inline uint8_t prevPosition(uint8_t position) {
14 if (position == 0) {
15 return Size - 1;
16 }
17 return position - 1;
18 }
19
20 inline bool enqueue(const T &item) {
21 static_assert(Size > 1, "RingBuffer size must be > 1");
22 uint8_t next = nextPosition(head_);
23 if (next == tail_) {
24 // Full
25 return false;
26 }
27
28 buf_[head_] = item;
29 head_ = next;
30 return true;
31 }
32
33 inline bool get(T &dest, bool commit = true) {
34 auto tail = tail_;
35 if (tail == head_) {
36 // No more data
37 return false;
38 }
39
40 dest = buf_[tail];
41 tail = nextPosition(tail);
42
43 if (commit) {
44 tail_ = tail;
45 }
46 return true;
47 }
48
49 inline bool empty() const { return head_ == tail_; }
50
51 inline uint8_t size() const {
52 int diff = head_ - tail_;
53 if (diff >= 0) {
54 return diff;
55 }
56 return Size + diff;
57 }
58
59 inline T& front() {
60 return buf_[tail_];
61 }
62
63 inline bool peek(T &item) {
64 return get(item, false);
65 }
66};
diff --git a/tmk_core/protocol/midi.mk b/tmk_core/protocol/midi.mk
index c85ae42ff..4855b23d3 100644
--- a/tmk_core/protocol/midi.mk
+++ b/tmk_core/protocol/midi.mk
@@ -4,6 +4,7 @@ SRC += midi.c \
4 midi_device.c \ 4 midi_device.c \
5 bytequeue/bytequeue.c \ 5 bytequeue/bytequeue.c \
6 bytequeue/interrupt_setting.c \ 6 bytequeue/interrupt_setting.c \
7 sysex_tools.c \
7 $(LUFA_SRC_USBCLASS) 8 $(LUFA_SRC_USBCLASS)
8 9
9VPATH += $(TMK_PATH)/$(MIDI_DIR) \ No newline at end of file 10VPATH += $(TMK_PATH)/$(MIDI_DIR) \ No newline at end of file
diff --git a/tmk_core/protocol/ps2_mouse.c b/tmk_core/protocol/ps2_mouse.c
index c3e8b3c1c..d9ccbecb4 100644
--- a/tmk_core/protocol/ps2_mouse.c
+++ b/tmk_core/protocol/ps2_mouse.c
@@ -18,60 +18,59 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
18#include <stdbool.h> 18#include <stdbool.h>
19#include<avr/io.h> 19#include<avr/io.h>
20#include<util/delay.h> 20#include<util/delay.h>
21#include "ps2.h"
22#include "ps2_mouse.h" 21#include "ps2_mouse.h"
23#include "report.h"
24#include "host.h" 22#include "host.h"
25#include "timer.h" 23#include "timer.h"
26#include "print.h" 24#include "print.h"
25#include "report.h"
27#include "debug.h" 26#include "debug.h"
27#include "ps2.h"
28 28
29/* ============================= MACROS ============================ */
29 30
30static report_mouse_t mouse_report = {}; 31static report_mouse_t mouse_report = {};
31 32
33static inline void ps2_mouse_print_report(report_mouse_t *mouse_report);
34static inline void ps2_mouse_convert_report_to_hid(report_mouse_t *mouse_report);
35static inline void ps2_mouse_clear_report(report_mouse_t *mouse_report);
36static inline void ps2_mouse_enable_scrolling(void);
37static inline void ps2_mouse_scroll_button_task(report_mouse_t *mouse_report);
32 38
33static void print_usb_data(void); 39/* ============================= IMPLEMENTATION ============================ */
34
35 40
36/* supports only 3 button mouse at this time */ 41/* supports only 3 button mouse at this time */
37uint8_t ps2_mouse_init(void) { 42void ps2_mouse_init(void) {
38 uint8_t rcv;
39
40 ps2_host_init(); 43 ps2_host_init();
41 44
42 _delay_ms(1000); // wait for powering up 45 _delay_ms(PS2_MOUSE_INIT_DELAY); // wait for powering up
43 46
44 // send Reset 47 PS2_MOUSE_SEND(PS2_MOUSE_RESET, "ps2_mouse_init: sending reset");
45 rcv = ps2_host_send(0xFF);
46 print("ps2_mouse_init: send Reset: ");
47 phex(rcv); phex(ps2_error); print("\n");
48 48
49 // read completion code of BAT 49 PS2_MOUSE_RECEIVE("ps2_mouse_init: read BAT");
50 rcv = ps2_host_recv_response(); 50 PS2_MOUSE_RECEIVE("ps2_mouse_init: read DevID");
51 print("ps2_mouse_init: read BAT: ");
52 phex(rcv); phex(ps2_error); print("\n");
53 51
54 // read Device ID 52#ifdef PS2_MOUSE_USE_REMOTE_MODE
55 rcv = ps2_host_recv_response(); 53 ps2_mouse_set_remote_mode();
56 print("ps2_mouse_init: read DevID: "); 54#else
57 phex(rcv); phex(ps2_error); print("\n"); 55 ps2_mouse_enable_data_reporting();
56#endif
57
58#ifdef PS2_MOUSE_ENABLE_SCROLLING
59 ps2_mouse_enable_scrolling();
60#endif
58 61
59 // send Set Remote mode 62#ifdef PS2_MOUSE_USE_2_1_SCALING
60 rcv = ps2_host_send(0xF0); 63 ps2_mouse_set_scaling_2_1();
61 print("ps2_mouse_init: send 0xF0: "); 64#endif
62 phex(rcv); phex(ps2_error); print("\n");
63 65
64 return 0; 66 ps2_mouse_init_user();
65} 67}
66 68
67#define X_IS_NEG (mouse_report.buttons & (1<<PS2_MOUSE_X_SIGN)) 69__attribute__((weak))
68#define Y_IS_NEG (mouse_report.buttons & (1<<PS2_MOUSE_Y_SIGN)) 70void ps2_mouse_init_user(void) {
69#define X_IS_OVF (mouse_report.buttons & (1<<PS2_MOUSE_X_OVFLW)) 71}
70#define Y_IS_OVF (mouse_report.buttons & (1<<PS2_MOUSE_Y_OVFLW)) 72
71void ps2_mouse_task(void) 73void ps2_mouse_task(void) {
72{
73 enum { SCROLL_NONE, SCROLL_BTN, SCROLL_SENT };
74 static uint8_t scroll_state = SCROLL_NONE;
75 static uint8_t buttons_prev = 0; 74 static uint8_t buttons_prev = 0;
76 75
77 /* receives packet from mouse */ 76 /* receives packet from mouse */
@@ -79,142 +78,169 @@ void ps2_mouse_task(void)
79 rcv = ps2_host_send(PS2_MOUSE_READ_DATA); 78 rcv = ps2_host_send(PS2_MOUSE_READ_DATA);
80 if (rcv == PS2_ACK) { 79 if (rcv == PS2_ACK) {
81 mouse_report.buttons = ps2_host_recv_response(); 80 mouse_report.buttons = ps2_host_recv_response();
82 mouse_report.x = ps2_host_recv_response(); 81 mouse_report.x = ps2_host_recv_response() * PS2_MOUSE_X_MULTIPLIER;
83 mouse_report.y = ps2_host_recv_response(); 82 mouse_report.y = ps2_host_recv_response() * PS2_MOUSE_Y_MULTIPLIER;
83#ifdef PS2_MOUSE_ENABLE_SCROLLING
84 mouse_report.v = -(ps2_host_recv_response() & PS2_MOUSE_SCROLL_MASK) * PS2_MOUSE_V_MULTIPLIER;
85#endif
84 } else { 86 } else {
85 if (debug_mouse) print("ps2_mouse: fail to get mouse packet\n"); 87 if (debug_mouse) print("ps2_mouse: fail to get mouse packet\n");
86 return; 88 return;
87 } 89 }
88 xprintf("%ud ", timer_read());
89 print("ps2_mouse raw: [");
90 phex(mouse_report.buttons); print("|");
91 print_hex8((uint8_t)mouse_report.x); print(" ");
92 print_hex8((uint8_t)mouse_report.y); print("]\n");
93 90
94 /* if mouse moves or buttons state changes */ 91 /* if mouse moves or buttons state changes */
95 if (mouse_report.x || mouse_report.y || 92 if (mouse_report.x || mouse_report.y || mouse_report.v ||
96 ((mouse_report.buttons ^ buttons_prev) & PS2_MOUSE_BTN_MASK)) { 93 ((mouse_report.buttons ^ buttons_prev) & PS2_MOUSE_BTN_MASK)) {
97 94#ifdef PS2_MOUSE_DEBUG_RAW
98#ifdef PS2_MOUSE_DEBUG 95 // Used to debug raw ps2 bytes from mouse
99 print("ps2_mouse raw: ["); 96 ps2_mouse_print_report(&mouse_report);
100 phex(mouse_report.buttons); print("|");
101 print_hex8((uint8_t)mouse_report.x); print(" ");
102 print_hex8((uint8_t)mouse_report.y); print("]\n");
103#endif 97#endif
104
105 buttons_prev = mouse_report.buttons; 98 buttons_prev = mouse_report.buttons;
99 ps2_mouse_convert_report_to_hid(&mouse_report);
100#if PS2_MOUSE_SCROLL_BTN_MASK
101 ps2_mouse_scroll_button_task(&mouse_report);
102#endif
103#ifdef PS2_MOUSE_DEBUG_HID
104 // Used to debug the bytes sent to the host
105 ps2_mouse_print_report(&mouse_report);
106#endif
107 host_mouse_send(&mouse_report);
108 }
109
110 ps2_mouse_clear_report(&mouse_report);
111}
106 112
107 // PS/2 mouse data is '9-bit integer'(-256 to 255) which is comprised of sign-bit and 8-bit value. 113void ps2_mouse_disable_data_reporting(void) {
108 // bit: 8 7 ... 0 114 PS2_MOUSE_SEND(PS2_MOUSE_DISABLE_DATA_REPORTING, "ps2 mouse disable data reporting");
109 // sign \8-bit/ 115}
110 //
111 // Meanwhile USB HID mouse indicates 8bit data(-127 to 127), note that -128 is not used.
112 //
113 // This converts PS/2 data into HID value. Use only -127-127 out of PS/2 9-bit.
114 mouse_report.x = X_IS_NEG ?
115 ((!X_IS_OVF && -127 <= mouse_report.x && mouse_report.x <= -1) ? mouse_report.x : -127) :
116 ((!X_IS_OVF && 0 <= mouse_report.x && mouse_report.x <= 127) ? mouse_report.x : 127);
117 mouse_report.y = Y_IS_NEG ?
118 ((!Y_IS_OVF && -127 <= mouse_report.y && mouse_report.y <= -1) ? mouse_report.y : -127) :
119 ((!Y_IS_OVF && 0 <= mouse_report.y && mouse_report.y <= 127) ? mouse_report.y : 127);
120 116
121 // remove sign and overflow flags 117void ps2_mouse_enable_data_reporting(void) {
122 mouse_report.buttons &= PS2_MOUSE_BTN_MASK; 118 PS2_MOUSE_SEND(PS2_MOUSE_ENABLE_DATA_REPORTING, "ps2 mouse enable data reporting");
119}
123 120
124 // invert coordinate of y to conform to USB HID mouse 121void ps2_mouse_set_remote_mode(void) {
125 mouse_report.y = -mouse_report.y; 122 PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_REMOTE_MODE, "ps2 mouse set remote mode");
123 ps2_mouse_mode = PS2_MOUSE_REMOTE_MODE;
124}
126 125
126void ps2_mouse_set_stream_mode(void) {
127 PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_STREAM_MODE, "ps2 mouse set stream mode");
128 ps2_mouse_mode = PS2_MOUSE_STREAM_MODE;
129}
127 130
128#if PS2_MOUSE_SCROLL_BTN_MASK 131void ps2_mouse_set_scaling_2_1(void) {
129 static uint16_t scroll_button_time = 0; 132 PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_SCALING_2_1, "ps2 mouse set scaling 2:1");
130 if ((mouse_report.buttons & (PS2_MOUSE_SCROLL_BTN_MASK)) == (PS2_MOUSE_SCROLL_BTN_MASK)) { 133}
131 if (scroll_state == SCROLL_NONE) { 134
132 scroll_button_time = timer_read(); 135void ps2_mouse_set_scaling_1_1(void) {
133 scroll_state = SCROLL_BTN; 136 PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_SCALING_1_1, "ps2 mouse set scaling 1:1");
134 } 137}
135 138
136 // doesn't send Scroll Button 139void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution) {
137 //mouse_report.buttons &= ~(PS2_MOUSE_SCROLL_BTN_MASK); 140 PS2_MOUSE_SET_SAFE(PS2_MOUSE_SET_RESOLUTION, resolution, "ps2 mouse set resolution");
138 141}
139 if (mouse_report.x || mouse_report.y) { 142
140 scroll_state = SCROLL_SENT; 143void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate) {
141 144 PS2_MOUSE_SET_SAFE(PS2_MOUSE_SET_SAMPLE_RATE, sample_rate, "ps2 mouse set sample rate");
142 mouse_report.v = -mouse_report.y/(PS2_MOUSE_SCROLL_DIVISOR_V); 145}
143 mouse_report.h = mouse_report.x/(PS2_MOUSE_SCROLL_DIVISOR_H); 146
144 mouse_report.x = 0; 147/* ============================= HELPERS ============================ */
145 mouse_report.y = 0; 148
146 //host_mouse_send(&mouse_report); 149#define X_IS_NEG (mouse_report->buttons & (1<<PS2_MOUSE_X_SIGN))
147 } 150#define Y_IS_NEG (mouse_report->buttons & (1<<PS2_MOUSE_Y_SIGN))
151#define X_IS_OVF (mouse_report->buttons & (1<<PS2_MOUSE_X_OVFLW))
152#define Y_IS_OVF (mouse_report->buttons & (1<<PS2_MOUSE_Y_OVFLW))
153static inline void ps2_mouse_convert_report_to_hid(report_mouse_t *mouse_report) {
154 // PS/2 mouse data is '9-bit integer'(-256 to 255) which is comprised of sign-bit and 8-bit value.
155 // bit: 8 7 ... 0
156 // sign \8-bit/
157 //
158 // Meanwhile USB HID mouse indicates 8bit data(-127 to 127), note that -128 is not used.
159 //
160 // This converts PS/2 data into HID value. Use only -127-127 out of PS/2 9-bit.
161 mouse_report->x = X_IS_NEG ?
162 ((!X_IS_OVF && -127 <= mouse_report->x && mouse_report->x <= -1) ? mouse_report->x : -127) :
163 ((!X_IS_OVF && 0 <= mouse_report->x && mouse_report->x <= 127) ? mouse_report->x : 127);
164 mouse_report->y = Y_IS_NEG ?
165 ((!Y_IS_OVF && -127 <= mouse_report->y && mouse_report->y <= -1) ? mouse_report->y : -127) :
166 ((!Y_IS_OVF && 0 <= mouse_report->y && mouse_report->y <= 127) ? mouse_report->y : 127);
167
168 // remove sign and overflow flags
169 mouse_report->buttons &= PS2_MOUSE_BTN_MASK;
170
171 // invert coordinate of y to conform to USB HID mouse
172 mouse_report->y = -mouse_report->y;
173}
174
175static inline void ps2_mouse_clear_report(report_mouse_t *mouse_report) {
176 mouse_report->x = 0;
177 mouse_report->y = 0;
178 mouse_report->v = 0;
179 mouse_report->h = 0;
180 mouse_report->buttons = 0;
181}
182
183static inline void ps2_mouse_print_report(report_mouse_t *mouse_report) {
184 if (!debug_mouse) return;
185 print("ps2_mouse: [");
186 phex(mouse_report->buttons); print("|");
187 print_hex8((uint8_t)mouse_report->x); print(" ");
188 print_hex8((uint8_t)mouse_report->y); print(" ");
189 print_hex8((uint8_t)mouse_report->v); print(" ");
190 print_hex8((uint8_t)mouse_report->h); print("]\n");
191}
192
193static inline void ps2_mouse_enable_scrolling(void) {
194 PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Initiaing scroll wheel enable: Set sample rate");
195 PS2_MOUSE_SEND(200, "200");
196 PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Set sample rate");
197 PS2_MOUSE_SEND(100, "100");
198 PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Set sample rate");
199 PS2_MOUSE_SEND(80, "80");
200 PS2_MOUSE_SEND(PS2_MOUSE_GET_DEVICE_ID, "Finished enabling scroll wheel");
201 _delay_ms(20);
202}
203
204#define PRESS_SCROLL_BUTTONS mouse_report->buttons |= (PS2_MOUSE_SCROLL_BTN_MASK)
205#define RELEASE_SCROLL_BUTTONS mouse_report->buttons &= ~(PS2_MOUSE_SCROLL_BTN_MASK)
206static inline void ps2_mouse_scroll_button_task(report_mouse_t *mouse_report) {
207 static enum {
208 SCROLL_NONE,
209 SCROLL_BTN,
210 SCROLL_SENT,
211 } scroll_state = SCROLL_NONE;
212 static uint16_t scroll_button_time = 0;
213
214 if (PS2_MOUSE_SCROLL_BTN_MASK == (mouse_report->buttons & (PS2_MOUSE_SCROLL_BTN_MASK))) {
215 // All scroll buttons are pressed
216
217 if (scroll_state == SCROLL_NONE) {
218 scroll_button_time = timer_read();
219 scroll_state = SCROLL_BTN;
148 } 220 }
149 else if ((mouse_report.buttons & (PS2_MOUSE_SCROLL_BTN_MASK)) == 0) { 221
222 // If the mouse has moved, update the report to scroll instead of move the mouse
223 if (mouse_report->x || mouse_report->y) {
224 scroll_state = SCROLL_SENT;
225 mouse_report->v = -mouse_report->y/(PS2_MOUSE_SCROLL_DIVISOR_V);
226 mouse_report->h = mouse_report->x/(PS2_MOUSE_SCROLL_DIVISOR_H);
227 mouse_report->x = 0;
228 mouse_report->y = 0;
229 }
230 } else if (0 == (PS2_MOUSE_SCROLL_BTN_MASK & mouse_report->buttons)) {
231 // None of the scroll buttons are pressed
232
150#if PS2_MOUSE_SCROLL_BTN_SEND 233#if PS2_MOUSE_SCROLL_BTN_SEND
151 if (scroll_state == SCROLL_BTN && 234 if (scroll_state == SCROLL_BTN
152 TIMER_DIFF_16(timer_read(), scroll_button_time) < PS2_MOUSE_SCROLL_BTN_SEND) { 235 && timer_elapsed(scroll_button_time) < PS2_MOUSE_SCROLL_BTN_SEND) {
153 // send Scroll Button(down and up at once) when not scrolled 236 PRESS_SCROLL_BUTTONS;
154 mouse_report.buttons |= (PS2_MOUSE_SCROLL_BTN_MASK); 237 host_mouse_send(mouse_report);
155 host_mouse_send(&mouse_report); 238 _delay_ms(100);
156 _delay_ms(100); 239 RELEASE_SCROLL_BUTTONS;
157 mouse_report.buttons &= ~(PS2_MOUSE_SCROLL_BTN_MASK);
158 }
159#endif
160 scroll_state = SCROLL_NONE;
161 } 240 }
162 // doesn't send Scroll Button
163 mouse_report.buttons &= ~(PS2_MOUSE_SCROLL_BTN_MASK);
164#endif 241#endif
165 242 scroll_state = SCROLL_NONE;
166
167 host_mouse_send(&mouse_report);
168 print_usb_data();
169 } 243 }
170 // clear report
171 mouse_report.x = 0;
172 mouse_report.y = 0;
173 mouse_report.v = 0;
174 mouse_report.h = 0;
175 mouse_report.buttons = 0;
176}
177 244
178static void print_usb_data(void) 245 RELEASE_SCROLL_BUTTONS;
179{ 246}
180 if (!debug_mouse) return;
181 print("ps2_mouse usb: [");
182 phex(mouse_report.buttons); print("|");
183 print_hex8((uint8_t)mouse_report.x); print(" ");
184 print_hex8((uint8_t)mouse_report.y); print(" ");
185 print_hex8((uint8_t)mouse_report.v); print(" ");
186 print_hex8((uint8_t)mouse_report.h); print("]\n");
187}
188
189
190/* PS/2 Mouse Synopsis
191 * http://www.computer-engineering.org/ps2mouse/
192 *
193 * Command:
194 * 0xFF: Reset
195 * 0xF6: Set Defaults Sampling; rate=100, resolution=4cnt/mm, scaling=1:1, reporting=disabled
196 * 0xF5: Disable Data Reporting
197 * 0xF4: Enable Data Reporting
198 * 0xF3: Set Sample Rate
199 * 0xF2: Get Device ID
200 * 0xF0: Set Remote Mode
201 * 0xEB: Read Data
202 * 0xEA: Set Stream Mode
203 * 0xE9: Status Request
204 * 0xE8: Set Resolution
205 * 0xE7: Set Scaling 2:1
206 * 0xE6: Set Scaling 1:1
207 *
208 * Mode:
209 * Stream Mode: devices sends the data when it changs its state
210 * Remote Mode: host polls the data periodically
211 *
212 * This code uses Remote Mode and polls the data with Read Data(0xEB).
213 *
214 * Data format:
215 * byte|7 6 5 4 3 2 1 0
216 * ----+--------------------------------------------------------------
217 * 0|Yovflw Xovflw Ysign Xsign 1 Middle Right Left
218 * 1| X movement
219 * 2| Y movement
220 */
diff --git a/tmk_core/protocol/ps2_mouse.h b/tmk_core/protocol/ps2_mouse.h
index 27d9790d4..3c93a4634 100644
--- a/tmk_core/protocol/ps2_mouse.h
+++ b/tmk_core/protocol/ps2_mouse.h
@@ -19,16 +19,61 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
19#define PS2_MOUSE_H 19#define PS2_MOUSE_H
20 20
21#include <stdbool.h> 21#include <stdbool.h>
22#include "debug.h"
22 23
23#define PS2_MOUSE_READ_DATA 0xEB 24#define PS2_MOUSE_SEND(command, message) \
25do { \
26 uint8_t rcv = ps2_host_send(command); \
27 if (debug_mouse) { \
28 print((message)); \
29 xprintf(" command: %X, result: %X, error: %X \n", command, rcv, ps2_error); \
30 } \
31} while(0)
32
33#define PS2_MOUSE_SEND_SAFE(command, message) \
34do { \
35 if (PS2_MOUSE_STREAM_MODE == ps2_mouse_mode) { \
36 ps2_mouse_disable_data_reporting(); \
37 } \
38 PS2_MOUSE_SEND(command, message); \
39 if (PS2_MOUSE_STREAM_MODE == ps2_mouse_mode) { \
40 ps2_mouse_enable_data_reporting(); \
41 } \
42} while(0)
43
44#define PS2_MOUSE_SET_SAFE(command, value, message) \
45do { \
46 if (PS2_MOUSE_STREAM_MODE == ps2_mouse_mode) { \
47 ps2_mouse_disable_data_reporting(); \
48 } \
49 PS2_MOUSE_SEND(command, message); \
50 PS2_MOUSE_SEND(value, "Sending value"); \
51 if (PS2_MOUSE_STREAM_MODE == ps2_mouse_mode) { \
52 ps2_mouse_enable_data_reporting(); \
53 } \
54} while(0)
55
56#define PS2_MOUSE_RECEIVE(message) \
57do { \
58 uint8_t rcv = ps2_host_recv_response(); \
59 if (debug_mouse) { \
60 print((message)); \
61 xprintf(" result: %X, error: %X \n", rcv, ps2_error); \
62 } \
63} while(0)
64
65static enum ps2_mouse_mode_e {
66 PS2_MOUSE_STREAM_MODE,
67 PS2_MOUSE_REMOTE_MODE,
68} ps2_mouse_mode = PS2_MOUSE_STREAM_MODE;
24 69
25/* 70/*
26 * Data format: 71 * Data format:
27 * byte|7 6 5 4 3 2 1 0 72 * byte|7 6 5 4 3 2 1 0
28 * ----+-------------------------------------------------------------- 73 * ----+----------------------------------------------------------------
29 * 0|Yovflw Xovflw Ysign Xsign 1 Middle Right Left 74 * 0|[Yovflw][Xovflw][Ysign ][Xsign ][ 1 ][Middle][Right ][Left ]
30 * 1| X movement(0-255) 75 * 1|[ X movement(0-255) ]
31 * 2| Y movement(0-255) 76 * 2|[ Y movement(0-255) ]
32 */ 77 */
33#define PS2_MOUSE_BTN_MASK 0x07 78#define PS2_MOUSE_BTN_MASK 0x07
34#define PS2_MOUSE_BTN_LEFT 0 79#define PS2_MOUSE_BTN_LEFT 0
@@ -39,10 +84,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
39#define PS2_MOUSE_X_OVFLW 6 84#define PS2_MOUSE_X_OVFLW 6
40#define PS2_MOUSE_Y_OVFLW 7 85#define PS2_MOUSE_Y_OVFLW 7
41 86
42
43/*
44 * Scroll by mouse move with pressing button
45 */
46/* mouse button to start scrolling; set 0 to disable scroll */ 87/* mouse button to start scrolling; set 0 to disable scroll */
47#ifndef PS2_MOUSE_SCROLL_BTN_MASK 88#ifndef PS2_MOUSE_SCROLL_BTN_MASK
48#define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BTN_MIDDLE) 89#define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BTN_MIDDLE)
@@ -58,9 +99,79 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
58#ifndef PS2_MOUSE_SCROLL_DIVISOR_H 99#ifndef PS2_MOUSE_SCROLL_DIVISOR_H
59#define PS2_MOUSE_SCROLL_DIVISOR_H 2 100#define PS2_MOUSE_SCROLL_DIVISOR_H 2
60#endif 101#endif
102/* multiply reported mouse values by these */
103#ifndef PS2_MOUSE_X_MULTIPLIER
104#define PS2_MOUSE_X_MULTIPLIER 1
105#endif
106#ifndef PS2_MOUSE_Y_MULTIPLIER
107#define PS2_MOUSE_Y_MULTIPLIER 1
108#endif
109#ifndef PS2_MOUSE_V_MULTIPLIER
110#define PS2_MOUSE_V_MULTIPLIER 1
111#endif
112/* For some mice this will need to be 0x0F */
113#ifndef PS2_MOUSE_SCROLL_MASK
114#define PS2_MOUSE_SCROLL_MASK 0xFF
115#endif
116#ifndef PS2_MOUSE_INIT_DELAY
117#define PS2_MOUSE_INIT_DELAY 1000
118#endif
61 119
120enum ps2_mouse_command_e {
121 PS2_MOUSE_RESET = 0xFF,
122 PS2_MOUSE_RESEND = 0xFE,
123 PS2_MOSUE_SET_DEFAULTS = 0xF6,
124 PS2_MOUSE_DISABLE_DATA_REPORTING = 0xF5,
125 PS2_MOUSE_ENABLE_DATA_REPORTING = 0xF4,
126 PS2_MOUSE_SET_SAMPLE_RATE = 0xF3,
127 PS2_MOUSE_GET_DEVICE_ID = 0xF2,
128 PS2_MOUSE_SET_REMOTE_MODE = 0xF0,
129 PS2_MOUSE_SET_WRAP_MODE = 0xEC,
130 PS2_MOUSE_READ_DATA = 0xEB,
131 PS2_MOUSE_SET_STREAM_MODE = 0xEA,
132 PS2_MOUSE_STATUS_REQUEST = 0xE9,
133 PS2_MOUSE_SET_RESOLUTION = 0xE8,
134 PS2_MOUSE_SET_SCALING_2_1 = 0xE7,
135 PS2_MOUSE_SET_SCALING_1_1 = 0xE6,
136};
137
138typedef enum ps2_mouse_resolution_e {
139 PS2_MOUSE_1_COUNT_MM,
140 PS2_MOUSE_2_COUNT_MM,
141 PS2_MOUSE_4_COUNT_MM,
142 PS2_MOUSE_8_COUNT_MM,
143} ps2_mouse_resolution_t;
144
145typedef enum ps2_mouse_sample_rate_e {
146 PS2_MOUSE_10_SAMPLES_SEC = 10,
147 PS2_MOUSE_20_SAMPLES_SEC = 20,
148 PS2_MOUSE_40_SAMPLES_SEC = 40,
149 PS2_MOUSE_60_SAMPLES_SEC = 60,
150 PS2_MOUSE_80_SAMPLES_SEC = 80,
151 PS2_MOUSE_100_SAMPLES_SEC = 100,
152 PS2_MOUSE_200_SAMPLES_SEC = 200,
153} ps2_mouse_sample_rate_t;
154
155void ps2_mouse_init(void);
156
157void ps2_mouse_init_user(void);
62 158
63uint8_t ps2_mouse_init(void);
64void ps2_mouse_task(void); 159void ps2_mouse_task(void);
65 160
161void ps2_mouse_disable_data_reporting(void);
162
163void ps2_mouse_enable_data_reporting(void);
164
165void ps2_mouse_set_remote_mode(void);
166
167void ps2_mouse_set_stream_mode(void);
168
169void ps2_mouse_set_scaling_2_1(void);
170
171void ps2_mouse_set_scaling_1_1(void);
172
173void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
174
175void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
176
66#endif 177#endif